Impacted subscriptions

Subscription entitlements can change due to certain events in Chargebee. The impacted_subscriptions represents the subscriptions whose entitlements have changed owing to an event. It is returned as part of the content attribute of the webhook triggered by the event. The following events can contain the impacted_subscriptions resource:

A feature is created, activated, or deleted.
An item_entitlement is updated or removed.
An entitlement_override is updated, removed, or auto-removed.

Note
impacted_subscriptions cannot be retrieved via API; the resource is sent to you only via webhooks.

Sample impacted subscription [ JSON ]

{
    "count": 2,
    "subscription_ids": [
        "__dev__KyVn90T9Ur1MOR",
        {..}
    ],
    "download": {
        "download_url": "https://cb-staging-us-e1-ems-downloads.s3.amazonaws.com/entitlements-stage-test/ems/ems_events_16563355236948074631900111819685.json.json?response-content-disposition=attachment%3Bfilename%3Dentitlements-stage-test%2Fems%2Fems_events_16563355236948074631900111819685.json.json&X-Amz-Security-Token=IQoJb3JpZ2luX2VjELz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIC%2FthqzoH4Zwo5DMIAJOuWE9WQ9%2FdKBEZRJu1ZmbPh6rAiEA7%2FSU8iRJl%2F%2BN8eEPXkaIg%2F%2FZN0pfZajrILWyqEWJR5kq2wQI1f%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw1MzkwMjEzNjYzNzYiDF3ISdVC9ez1XOuyniqvBEiFFpSFOAaK9UHuuxFSZLe4kCUC53BKinBHxDN48ig6H7yf%2FagOUJ89fSQJL6PqRdMU0p5xeY0NLvn0D3G2IaXSHobws8tfAlUxDKv4oszPwb6utN%2F5WES1gAhmql6NCw8dyB3CcRfAx0J1GQYInCDACAfQJ%2BpTMnMpKH2Rm8B7cWFIetAOT3sN24KHu1HyKyqxzj8dPFzwu%2BacnPdt7pJBQ0mVzUW6AYqAxQeaSvb2oIT5hQfCbiGWK%2BdbPxGBXUySAnyq7rRoUS%2Bwuj9Lmf%2Fy9JriemN4zeCMef8CyvPEJVKCm4TvjRYLqyhyUijp3dBOi1rHjloD6%2F%2F935%2BWR%2FjrUOP6J2nTbUN%2B9kGllWYImHO%2F7iUNPBqSvwibJD69b%2F%2F7IohboAH27fdjFuCtlKQuyeUjYox%2FvjeqnPxBmsAWR9VtYVSjh4Y0tg8AXW62AdeoGQm9UqlI0uTXrfM5T8n%2FSIn18kULYOQ4NeQI%2BTHynQwn3ocrWjHykewqruFp6N1UPn7ZQJ80l5WKKXrz27rb4fO%2BR5K6KVOsj4KAHrix7ajtRru%2FAiYULTUNB9mIaKjkvSvl%2BfkBaF8Y9ONWU3agydXzRy06O64%2BC%2FjpjLdssUENtxX%2FKkQq7besp3yqW7oPb0hG2gEuj5r4zet2MwJnftEy5QDqccmYbovF5%2BE2zVMAn5VYVpC42fypxaY8cZiHfK4XlgiGBCSgVl2ToQhpnOheCvYDcAj86p%2BlX4cwiLDmlQY6qQFSAZfGUF4kzhon36kkrhDju1cHjm7Spv6AGElFp0be0jWrC610IshBCUGejS6NZ3GC4DPvlyJVmxcpT%2FV4sJEyy4PQCcLGL%2BvNwamIAUFVBspBiwetOFJVpVcK56MpsJt8ml%2Fpc4qEffA%2FTUiyUfxErCP7sq4QD6v5Do6gVVpWq9T3YHGBcrKZufFYZKmqUXZCLNgUOj5flmIFEJzXGOJwi9KYf2bz08kl&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T131203Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAX3ABNKRUFHRDAJHU%2F20220627%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=d3978cb08e5673499c1938e2e8128309106113f1c87de7520b3097722aebf4f5",
        "valid_till": 1655969881,
        "object": "download"
    },
    "object": "impacted_subscription"
}

API Index URL GET

https://{site}.chargebee.com/api/v2/impacted_subscriptions

count

optional, integer
The total number of subscriptions that have been impacted.

subscription_ids

optional, jsonarray
The list of IDs of the subscriptions that have been impacted. This list can contain a maximum of 1,000 IDs. The full list of subscription IDs is available in download.

download
Show attributes[+]

optional, download

The download resource containing all the impacted subscription IDs. The list of IDs is available as a JSON array in the file at download.url until download.valid_till.

Download attributes

download_url

string, max chars=3500
The URL at which the file is available for download.

valid_till

timestamp(UTC) in seconds
The time until which the download_url is valid.

mime_type

optional, string, max chars=100
The media type of the file.

Sample impacted subscription [ JSON ]

API Index URL GET

Impacted subscription attributes