ChargebeeAPI

Upsert or remove item entitlements for an item

Idempotency Supported
Try in API Explorer

Deprecated This operation is deprecated and no longer maintained. Migrate your integration to Manage entitlements.

Warning This operation is not supported when grandfathering is enabled.

Upserts or removes a set of item_entitlements for an item depending on the action specified. The API returns the upserted or deleted item_entitlements after successfully completing the operation. The operation returns an error when the first item_entitlement fails to be processed. Either all the item_entitlements provided in the request are processed or none.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/items/{item-id}/item_entitlements

Input Parameters

action
required, enumerated string

The specific action to be performed for each item_entitlement specified.

Possible Enum Values
upsert

If the item_entitlement already exists for the feature_id and item_id combination, the value of the item_entitlement is updated. If it doesn't exist, a new item_entitelment is created.

remove

Deletes the item_entitlement for the feature_id and item_id combination, if it exists.

item_entitlements[0..n]
Parameters for item_entitlements. Multiple item_entitlements can be passed by specifying unique indices.
pass parameters as item_entitlements[<param name>][<idx:0..n>]

Returns

item_entitlementItem entitlement object
Resource object representing item_entitlement