Get client payment status - HelpYouSponsor Docs

GET

client

{id}

payment-status

Get client payment status

curl --request GET \
  --url https://api.helpyousponsor.com/v1/client/{id}/payment-status \
  --header 'X-HYS-API-Key: <api-key>'

{
  "paid": true,
  "total": 0
}

X-HYS-API-Key

string

header

required

API key generated from Developer Settings. Format: hys_...

integer

required

The id of the client

Successful operation

paid

boolean

Example:

true

total

number

Example:

0

Get client payment status

curl --request GET \
  --url https://api.helpyousponsor.com/v1/client/{id}/payment-status \
  --header 'X-HYS-API-Key: <api-key>'

{
  "paid": true,
  "total": 0
}