Skip to main content
POST
Check if an entitlement is entitled to a given usage

Headers

x-admin-api-key
string
required

The API key to access the admin API

Body

application/json
subscriptionId
string
required

The ID of the subscription

Example:

"123e4567-e89b-12d3-a456-426614174000"

entitlementCode
string
required

The code of the entitlement

Example:

"storage_quota"

usage
number
default:1

The usage amount to report (defaults to 1 if not provided)

Example:

100

Response

200 - application/json

Returns the current status of the entitlement

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