Disabled by default
This endpoint is disabled by default. To enable it, contact Chargebee Support.
Tip
To retrieve subscription entitlements for a specific subscription, use the List subscription entitlements API.
Returns a list of customer_entitlement objects for the specified customer. The entitlements returned are for active subscriptions only. Specifically, these are subscriptions with a status of active or non_renewing.
Sample Request
URL Format
Input Parameters
The number of features for which to return customer_entitlement
objects.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset
to the value of next_offset
obtained in the previous iteration of the API call.
When set to true
, the response returns a unified view of entitlement values for each feature across the customer. This includes entitlements assigned directly to the customer as well as those inherited from any of the customer's subscriptions. In this mode, the subscription_id
field is omitted from the response objects. The consolidated entitlement value is derived using the same logic described in the Subscription Entitlements documentation
, based on the feature type.
Returns
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter offset.