Sign in
Entitlements
Customers

Get customer entitlement value

Checks customer access to a given feature (by key). All entitlement types share the hasAccess property in their value response, but multiple other properties are returned based on the entitlement type.

get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value

Path parameters

string required

ULID (Universally Unique Lexicographically Sortable Identifier).

OR
string required

ExternalKey is a looser version of key.

Example:01G65Z755AFWAKHE12NY0CQ9FH
entitlementIdOrFeatureKeystring required

Query parameters

timestring date-time
Example:2023-01-01T01:01:01.001Z

Response

The request has succeeded.

balancenumber double

Only available for metered entitlements. Metered entitlements are built around a balance calculation where feature usage is deducted from the issued grants. Balance represents the remaining balance of the entitlement, it's value never turns negative.

configstring

Only available for static entitlements. The JSON parsable config of the entitlement.

grantBalancesobject

Only available for metered entitlements. The closing balance of each active grant at query time. The key is the grant ID and the value is the remaining balance.

hasAccessboolean required

Whether the subject has access to the feature. Shared accross all entitlement types.

overagenumber double

Only available for metered entitlements. Overage represents the usage that wasn't covered by grants, e.g. if the subject had a total feature usage of 100 in the period but they were only granted 80, there would be 20 overage.

totalAvailableGrantAmountnumber double

Only available for metered entitlements. The summed amount of all grant active at query time PLUS the used amount of since inactive grants.

usagenumber double

Only available for metered entitlements. Returns the total feature usage in the current period.

Example response

{
  "balance": 100,
  "config": "{ key: \"value\" }",
  "hasAccess": true,
  "totalAvailableGrantAmount": 100,
  "usage": 50
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.