List entitlements

Retrieves a list of all the entitlements associated with the specified feature.

Sample Request

Sample Result[JSON]

URL Format

GET https://[site].chargebee.com/api/v2/entitlements

Input Parameters

limit

optional, integer, default=10, min=1, max=100

The number of resources to be returned.

offset

optional, string, max chars=1000

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.

Filter Params

For operator usages, see the Pagination and Filtering section.

feature_id[<operator>]

optional, string filter

The id of the feature associated with this entitlement. Supported operators : is, is_not, starts_with, in, not_in

Example → feature_id[is] = "user-licenses"

Supported operators: in, is

Example → user-licenses

entity_type[<operator>]

optional, enumerated string filter

The type of the entity to which this entitlement belongs. Possible values are : plan, addon, charge, plan_price, addon_price.

Supported operators : is, is_not, in, not_in, in, not_in

Example → entity_type[in] = "plan_price"

Supported operators: in, is

Example → plan_price

entity_id[<operator>]

optional, string filter

The id of the entity to which this entitlement belongs. . Supported operators : is, is_not, starts_with, in, not_in

Example → entity_id[in] = "usd-professional-monthly"

Supported operators: in, is

Example → usd-professional-monthly

Returns

next_offset

optional, string, max chars=1000

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.

entitlement

Entitlement object

Resource object representing entitlement