Skip to main content
PATCH
/
user
/
patient
/
{patient_id}
/
credit
/
{credit_id}
Update Patient Credit
curl --request PATCH \
  --url https://api.decodahealth.com/user/patient/{patient_id}/credit/{credit_id} \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "comment": "<string>",
  "expiryDate": "2023-11-07T05:31:56Z",
  "amount": 123,
  "amountRemaining": 123
}
'
{
  "id": "<string>",
  "patientId": "<string>",
  "amount": 123,
  "amountRemaining": 123,
  "createdDate": "2023-11-07T05:31:56Z",
  "comment": "<string>",
  "expiryDate": "2023-11-07T05:31:56Z",
  "memberId": "<string>",
  "updatedDate": "2023-11-07T05:31:56Z",
  "creator": {
    "id": "<string>",
    "type": "PROVIDER",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>"
  }
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

patient_id
string
required
credit_id
string
required

Body

application/json
comment
string | null
expiryDate
string<date-time> | null
amount
integer | null

Update the total credit amount in cents

amountRemaining
integer | null

Update the remaining credit amount in cents

Response

Successful Response

id
string
required
patientId
string
required
amount
integer
required
amountRemaining
integer
required
createdDate
string<date-time>
required
comment
string | null
expiryDate
string<date-time> | null
memberId
string | null
updatedDate
string<date-time> | null
creator
UserTiny · object