Sample - Stripe API
GET/v1/entitlements/active_entitlements/{id}

Retrieve an active entitlement

Retrieves a specific active entitlement. Provide the entitlement identifier to return the feature access granted to the associated customer.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
idstringrequired
The identifier of the active entitlement, limited to 5,000 characters.
expandarray<string>optional
Fields to expand in the response; each value is a string of no more than 5,000 characters.

2 status codes
200Returns the active entitlement with its feature reference, identifier, lookup key, livemode, and object type.
featurestringrequired
The [Feature](https://docs.stripe.com/api/entitlements/feature) that the customer is entitled to.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
lookup_keystringrequired
A unique key you provide as your own system identifier. This may be up to 80 characters.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:entitlements.active_entitlement
defaultError response.
errorobjectrequired

Error handling

id must identify the active entitlement to retrieve. Each expand entry must be a string of no more than 5,000 characters.