List Events
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.
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_recreatedpayment_success_recreatedrenewal_failure_recreatedrenewal_success_recreatedzferral_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, 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”
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
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.
The type of filter you would like to apply to your search.
Value in
- "created_at"
The start date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified.
The end date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified.
The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of start_date.
The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of end_date.
Response Body
curl -X GET "https://example.com/events.json"[ { "event": { "id": 343087780, "key": "subscription_state_change", "message": "State changed on Test subscription to Monthly Product from active to past_due", "subscription_id": 14950962, "customer_id": 12345678, "created_at": "2016-10-27T16:42:22-04:00", "event_specific_data": { "previous_subscription_state": "active", "new_subscription_state": "past_due" } } }, { "event": { "id": 343087742, "key": "billing_date_change", "message": "Billing date changed on Test's subscription to Monthly Product from 11/27/2016 to 10/27/2016", "subscription_id": 14950962, "customer_id": 12345678, "created_at": "2016-10-27T16:42:19-04:00", "event_specific_data": null } }, { "event": { "id": 343085267, "key": "statement_closed", "message": "Statement 79401838 closed (but not settled) for Test's subscription to ANNUAL product", "subscription_id": 14950975, "customer_id": 87654321, "created_at": "2016-10-27T16:40:40-04:00", "event_specific_data": null } }, { "event": { "id": 4481, "key": "custom_field_value_change", "message": "Custom field (Extra support included) changed for Subscription 117 from 'Yes' to 'No'.", "subscription_id": 117, "customer_id": 22334455, "created_at": "2022-03-24T07:55:06-04:00", "event_specific_data": { "event_type": "updated", "metafield_name": "Extra support included", "metafield_id": 2, "old_value": "Yes", "new_value": "No", "resource_type": "Subscription", "resource_id": 117 } } }]Delete Coupon Subcode DELETE
Deletes a specific subcode from a coupon. ## Example Given a coupon with an ID of 567, and a coupon subcode of 20OFF, the URL to `DELETE` this coupon subcode would be: ``` http://subdomain.chargify.com/coupons/567/codes/20OFF.<format> ``` Note: If you are using any of the allowed special characters (“%”, “@”, “+”, “-”, “_”, and “.”), you must encode them for use in the URL. | Special character | Encoding | |-------------------|----------| | % | %25 | | @ | %40 | | + | %2B | | – | %2D | | _ | %5F | | . | %2E | ## Percent Encoding Example Or if the coupon subcode is 20%OFF, the URL to delete this coupon subcode would be: @https://<subdomain>.chargify.com/coupons/567/codes/20%25OFF.<format>.
List Events for Subscription GET
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](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”