Skip to main content
GET
/
user
/
patient
/
{patient_id}
/
credit
/
available
Get Available Credit
curl --request GET \
  --url https://api.decodahealth.com/user/patient/{patient_id}/credit/available \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "totalAvailable": 123,
  "credits": [
    {
      "creditId": "<string>",
      "remainingAmount": 123,
      "totalAmount": 123,
      "createdDate": "2023-11-07T05:31:56Z",
      "comment": "<string>",
      "expiryDate": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123
}

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

Response

Successful Response

Response for available credit endpoint

totalAvailable
integer
required
credits
AvailableCredit · object[]
required
count
integer
required