Impacted subscriptions

When certain events in Chargebee cause changes to subscription entitlements, the impacted_subscriptions resource indicates the affected subscriptions. This resource is part of the content attribute of the triggered webhook for the following events:

When a feature is created, activated, or deleted.
When an item_entitlement is updated or removed.
When an entitlement_override is updated, removed, or auto-removed.

Note

Only a maximum of 100,000 subscription IDs are reported. Contact Support to increase this limit for your Chargebee site.
You can't retrieve impacted_subscriptions through the API. Only webhooks send you this resource.

Sample Impacted subscriptionJSON

API Index URL

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

Impacted subscriptions attributes

count

optional, integer

The total count of affected subscriptions.

subscription_ids

optional

The impacted subscription IDs. This list contains up to 1,000 IDs. The complete list of subscription IDs is in the download resource, which can store up to 100,000 IDs.

download

This download resource contains the impacted subscription IDs. These IDs are in a JSON array in the file at download.url until download.valid_till. The file at this URL stores up to 100,000 subscription IDs. Contact Support to increase this limit for your Chargebee site.