Skip to main content
GET
/
api
/
v1
/
sub-entitlement
/
{subscriptionId}
/
{entitlementCode}
/
status
Get status of an entitlement
curl --request GET \
  --url https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/sub-entitlement/{subscriptionId}/{entitlementCode}/status \
  --header 'x-admin-api-key: <x-admin-api-key>'
{
  "usage": 123,
  "quota": 123,
  "isUnlimited": true,
  "remainingQuota": 123,
  "percentageUsed": 123,
  "isEntitled": true
}

Headers

​
x-admin-api-key
string
required

The API key to access the admin API

Path Parameters

​
subscriptionId
string
required

ID of the subscription

​
entitlementCode
string
required

Code of the entitlement

Response

Successfully retrieved entitlement status

​
usage
number
​
quota
number
​
isUnlimited
boolean
​
remainingQuota
number
​
percentageUsed
number
​
isEntitled
boolean