List Events
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Lists events for a site.
Advanced Billing 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 Advanced Billing UI, "Events" are referred to as "Site Activity". See the Site Activity article in the product documentation for details on how to record view Events / Site Activty in the Advanced Billing UI.
If you’re using the enhanced Catalog experience, you’ll see updated naming in webhook events and messages.
Event name changes:
Message updates:
This method will retrieve a list of events for a site. Use query string filters to narrow down results. You may use the key filter as part of your query string to narrow down results.
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)The event type is identified by the key property. You can check supported keys here.
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.
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" } }The username is a Maxio Chargify API key and the password is x. Basic authentication works only with the US and EU environments, which connect to chargify.com directly. The Maxio API Gateway environment does not accept Basic authentication.
In: header
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
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
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.
curl -X GET -G \ --url 'https://subdomain.chargify.com/events.json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN'