List Item Entitlements For An Item

List item entitlements for an item

GET/items/{item-id}/item_entitlements

Use it in a workflow

Add a step and choose the Chargebee connector.
Pick the List Item Entitlements For An Item action (under Chargebee API).
Fill in the fields below, then reference the result from later steps as {{listItemEntitlementsForAnItem.response.data}}.

Request

Path parameters

item-idstringrequired

Query parameters

limitinteger (int32)

The number of resources to be returned.

Default 10

offsetstring

<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>

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

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

chargebee-request-origin-user-encodedstring (email)

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.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-business-entity-idstring

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.

Response

Returns 200 with an object. Read it in later steps with {{listItemEntitlementsForAnItem.response.data.<field>}}.

listarray<object>

item_entitlementobjectrequired7 fields

**Deprecated** The Item Entitlements API is deprecated and no longer maintained. Migrate your integration to [Entitlements API](/docs/api/entitlements). **Warning** API operations listed on this page are not supported when [grandfathering](/docs/api/entitlements) is enabled. [Items](/docs/api/items) represent the products or services that you offer to your customers. Items often differ from each other in the product [features](/docs/api/features) that are available in them. An item entitlement object represents the entitlement an item has towards a feature. An item can have multiple such entitlements, each corresponding to a unique feature it is entitled to. Item entitlements can be created while [creating a feature](/docs/api/features/create-a-feature). All subscriptions containing an item also [inherit](/docs/api/subscription_entitlements) its entitlements.

next_offsetstring

<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>

json

{
  "list": null,
  "next_offset": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.

Was this page helpful?