List Customer Entitlements

<p class="mb-2">The number of features for which to return <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_entitlement</code> objects.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">See also</strong> <a href="/docs/api/customer_entitlements">Pagination for List customer entitlements</a>.</p></div>

Default 10

<p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code> to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code> obtained in the previous iteration of the API call.</p>

<p class="mb-2">When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> , 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&#x27;s subscriptions. In this mode, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_id</code> field is omitted from the response objects. The consolidated entitlement value is derived using the same logic described in the <a href="/docs/api/subscription_entitlements">Subscription Entitlements documentation</a> , based on the feature type.</p>

Default false

The device from which the customer has made the request

The email address of your customer/user. Use this when the email address has only ASCII characters.

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

The IP address of the customer where the request originated

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

<div class="api-description"><span featureId="cb-entitlements"></span><p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer_entitlement</code> resource can be viewed as a subset of the <code><a href="/docs/api/subscription_entitlements">subscription_entitlement</a></code> resource enhanced with the customer&#x27;s ID. It is introduced to help <a href="/docs/api/customer_entitlements/list-customer-entitlements">retrieve</a> all subscription entitlements for a specific customer.</p></div>

<p class="mb-2">This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>.</p>