List Events for Subscription
Lists events for a subscription.
Event Key
The event type is identified by the key property. See Event Key for a complete list of supported keys.
Event Specific Data
Different event types may include additional data in event_specific_data property.
While some events share the same schema for event_specific_data, others may not include it at all.
For precise mappings from key to event_specific_data, refer to Event.
Enhanced Catalog Experience
If you’re using the enhanced Catalog experience, you’ll see updated naming in webhook events and messages.
Event name changes:
- subscription_product_change → subscription_plan_change
- component_allocation_change → allocation_change
- component_billing_date_change → product_billing_date_change
Message updates:
- “Successful payment for allocation changes to Product on Subscription”
- “Failed payment for allocation changes to Product on Subscription”
- “Plan changed on Subscription from previous plan to new plan”
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The Chargify id of the subscription.
Query Parameters
Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query page=1.
1 <= value1This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query per_page=200.
value <= 20020Returns events with an id greater than or equal to the one specified.
int64Returns events with an id less than or equal to the one specified.
int64The sort direction of the returned events.
"desc"Value in
- "asc"
- "desc"
You can pass multiple event keys after comma.
Use in query filter=signup_success,payment_success.
Response Body
application/json
curl -X GET "https://example.com/subscriptions/0/events.json"[ { "event": { "id": 344799837, "key": "statement_settled", "message": "Statement 79702531 settled successfully for Amelia Example's subscription to Basic Plan", "subscription_id": 14900541, "customer_id": 77223344, "created_at": "2016-11-01T12:41:29-04:00", "event_specific_data": null } }, { "event": { "id": 344799815, "key": "renewal_success", "message": "Successful renewal for Amelia Example's subscription to Basic Plan", "subscription_id": 14900541, "customer_id": 77223344, "created_at": "2016-11-01T12:41:28-04:00", "event_specific_data": { "product_id": 3792003, "account_transaction_id": 7590246 } } }, { "event": { "id": 344799705, "key": "billing_date_change", "message": "Billing date changed on Amelia Example's subscription to Basic Plan from 11/26/2016 to 11/01/2016", "subscription_id": 14900541, "customer_id": 77223344, "created_at": "2016-11-01T12:41:25-04:00", "event_specific_data": null } }]List Events GET
Lists events for a site. Events include various activity that happens around a Site. This information is **especially** useful to track down issues that arise when subscriptions are not created due to errors. Within the UI, Events are referred to as Site Activity. For more information, see [Site Activity](https://maxio.zendesk.com/hc/en-us/articles/24250671733517-Site-Activity). Use query string filters to narrow down results. You can use the `filter` parameter to filter by event key. ### Legacy Filters The following keys are no longer supported. + `payment_failure_recreated` + `payment_success_recreated` + `renewal_failure_recreated` + `renewal_success_recreated` + `zferral_revenue_post_failure` - (Specific to the deprecated Zferral integration) + `zferral_revenue_post_success` - (Specific to the deprecated Zferral integration) ## Event Key The event type is identified by the key property. See Event Key for a complete list of supported keys. ## Event Specific Data Different event types may include additional data in `event_specific_data` property. While some events share the same schema for `event_specific_data`, others may not include it at all. For precise mappings from key to event_specific_data, refer to Event. ### Example Here’s an example event for the `subscription_product_change` event: ``` { "event": { "id": 351, "key": "subscription_product_change", "message": "Product changed on Mark Alan's subscription from 'Basic' to 'Pro'", "subscription_id": 205, "event_specific_data": { "new_product_id": 3, "previous_product_id": 2 }, "created_at": "2012-01-30T10:43:31-05:00" } } ``` Here’s an example event for the `subscription_state_change` event: ``` { "event": { "id": 353, "key": "subscription_state_change", "message": "State changed on Mark Alan's subscription to Pro from trialing to active", "subscription_id": 205, "event_specific_data": { "new_subscription_state": "active", "previous_subscription_state": "trialing" }, "created_at": "2012-01-30T10:43:33-05:00" } } ``` ## Enhanced Catalog Experience If you’re using the [enhanced Catalog experience](https://maxio-test-wp.pages.dev/support/announcements/2026-announcements#new-catalog-experience-and-terminology), you’ll see updated naming in webhook events and messages. Event name changes: - subscription_product_change → subscription_plan_change - component_allocation_change → allocation_change - component_billing_date_change → product_billing_date_change Message updates: - “Plan changed on Subscription from previous plan to new plan” - “Successful payment for allocation changes to Product on Subscription” - “Failed payment for allocation changes to Product on Subscription”
Read Total Event Count GET
Returns the total count of events for a given site. If you’re using the [enhanced Catalog experience](https://maxio-test-wp.pages.dev/support/announcements/2026-announcements#new-catalog-experience-and-terminology), you’ll see updated naming in webhook events and messages. Event name changes: - subscription_product_change → subscription_plan_change - component_allocation_change → allocation_change - component_billing_date_change → product_billing_date_change Message updates: - “Successful payment for allocation changes to Product on Subscription” - “Failed payment for allocation changes to Product on Subscription” - “Plan changed on Subscription from previous plan to new plan”