Settings
API Version
Product Catalog
Library

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:

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 subscription [ JSON ]

{ "count": 2, "subscription_ids": [ "__dev__KyVn90T9Ur1MOR", "__dev__KyVn90T9Z2NUC1w" ], "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

Model Class

 

      Impacted subscription 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
 Show attributes [+]
 
 optional, 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.
 
 
 
Event types
 

      This is a list of the event types we currently support. We will continue
      to add more events moving forward. All events follow a uniform pattern -
      <resource>_<event_name>. The resources that will be
      present in the event content are provided beneath each event type's
      description.
    
 
Note: If consolidated invoicing is enabled, the
      attributes invoice.subscription_id and
      credit_note.subscription_id should not be used
      (as it will not be present if the invoice / credit note has lines from
      multiple subscriptions). Instead to know the related subscriptions,
      their line_items' subscription_id attribute should be referred.
    
 
 
count count
 

          optional, integer
 The total count of affected subscriptions. 
 
subscription_ids 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 
 

          optional, 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.
 
 
 
 
Consent Fields for Impacted subscription
 
 
Custom Fields for Impacted subscription