ChargebeeAPI

Upsert or remove entitlement overrides for a subscription

Idempotency Supported
Try in API Explorer

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

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/subscriptions/{subscription-id}/entitlement_overrides

Input Parameters

action
optional, enumerated string

The action to perform for each entitlement_override specified in the entitlement_overrides array.

Possible Enum Values
upsert

If the entitlement_override for the subscription_id, feature_id, and entity_id combination already exists, the value of the entitlement_override is updated. If it doesn't exist, a new entitlement_override is created.

remove

Deletes the entitlement_override for the subscription_id, feature_id, and entity_id combination, if it exists.

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

Returns

entitlement_overrideEntitlement override object
Resource object representing entitlement_override