Customer entitlements

The customer_entitlement resource can be viewed as a subset of the subscription_entitlement resource enhanced with the customer's ID. It is introduced to help retrieve all subscription entitlements for a specific customer.

Sample Customer entitlementJSON

API Index URL

https://[site].chargebee.com/api/v2/customer_entitlements

Customer entitlements attributes

customer_id

required, string, max chars=50

The unique identifier of the customer to which this entitlement belongs.

subscription_id

optional, string, max chars=50

The unique identifier of the subscription to which this entitlement belongs.

feature_id

optional, string, max chars=50

The unique identifier of the feature towards which this subscription entitlement has been granted.

value

optional, string, max chars=50

The value denoting the effective entitlement level that the subscription has towards the feature.

name

optional, string, max chars=50

The display name for the entitlement level. The value is automatically generated based on feature.type:

When feature.type is range or quantity: the name is the space-separated concatenation of value and the pluralized form of feature.unit. For example, if value is 20 and feature.unit is user, then name becomes 20 users.
When feature.type is custom, the name is the same as value.
When feature.type is switch: name is set to Available when value is true; it's set to Not Available when value is false.

is_enabled

required, boolean

When true , indicates that the subscription_entitlement is enabled.