Skip to main content
POST
/
api
/
v1
/
entitlements
/
status
Check user entitlement status
curl --request POST \
  --url https://dev-billing-api.iqraa.ai/api/v1/api/v1/entitlements/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriptionId": "0c7b0eb6-3411-4dd3-9e24-d2a8edbb504a",
  "entitlementCode": "STARTER",
  "usage": 100,
  "customerSubscribedId": "247"
}
'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
subscriptionId
string
required

The unique identifier of the subscription

Example:

"0c7b0eb6-3411-4dd3-9e24-d2a8edbb504a"

​
entitlementCode
string
required

The unique identifier of the entitlement

Example:

"STARTER"

​
usage
number
required

The usage amount to be reported

Example:

100

​
customerSubscribedId
string

The unique identifier of the customer who is subscribed (external customer id)

Example:

"247"

Response

Entitlement status retrieved successfully