GET
/v1/entitlements/active_entitlementsList active entitlements
Lists active entitlements for a customer. Supply the customer identifier and use cursor parameters to page through the customer's active feature access.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
customerstringrequired
The identifier of the customer whose active entitlements to retrieve.
ending_beforestringoptional
Object ID cursor for retrieving the previous page of results.
expandarray<string>optional
Fields to expand in the response; each value is a string of no more than 5,000 characters.
limitintegeroptional
Maximum number of entitlements to return, from 1 to 100. Defaults to 10 when omitted.
starting_afterstringoptional
Object ID cursor for retrieving the next page of results.
200Returns a list of active entitlement objects in `data`, including each entitlement's feature, identifier, lookup key, livemode, and object type, with pagination metadata.
dataarray<ActiveEntitlement>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired
Error handling
customer is required and must identify the customer whose entitlements you want to list. Use limit between 1 and 100; it defaults to 10 when omitted, and cursor values must be valid object identifiers.