Active Entitlements

An active entitlement describes access to a feature for a customer.

Was this section helpful? Yes No

Retrieve an active entitlement

GET / v1 / entitlements / active_entitlements /:id

List all active entitlements

GET / v1 / entitlements / active_entitlements

The Active Entitlement object

Attributes

id string Unique identifier for the object.
feature string Expandable The Feature that the customer is entitled to.
lookup _ key string A unique key you provide as your own system identifier. This may be up to 80 characters.

More attributes

object string, value is "entitlements.active_entitlement"
livemode boolean

The Active Entitlement object

{ "id": "ent_test_61QG5x2cU1GluFTYs41JqiESbLiX8C8O", "object": "entitlements.active_entitlement", "feature": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu", "lookup_key": "seats-feature", "livemode": false}

Retrieve an active entitlement

GET / v1 / entitlements / active_entitlements /:id

Retrieve an active entitlement

Parameters

id string Required The ID of the entitlement.

Returns

Returns an active entitlement

Response

{ "id": "ent_test_61QG5x2cU1GluFTYs41JqiESbLiX8C8O", "object": "entitlements.active_entitlement", "feature": "feat_test_61QGU1MWyFMSP9YBZ41ClCIKljWvsTgu", "lookup_key": "seats-feature", "livemode": false}