List Events for Subscription
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Lists events for a subscription.
The event type is identified by the key property. You can check supported keys here.
If you’re using the enhanced Catalog experience, you’ll see updated naming in webhook events and messages.
Event name changes:
Message updates:
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.
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
The Chargify id of the subscription.
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.
application/json
curl -X GET -G \ --url 'https://subdomain.chargify.com/subscriptions/1/events.json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN'