Purge Subscription
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Purges an individual subscription for sites in test mode.
Provide the subscription ID in the url. To confirm, supply the customer ID in the query string ack parameter. You may also delete the customer record and/or payment profiles by passing cascade parameters. For example, to delete just the customer record, the query params would be: ?ack={customer_id}&cascade[]=customer
If you need to remove subscriptions from a live site, contact support to discuss your use case.
The query params will be: ?ack={customer_id}&cascade[]=customer&cascade[]=payment_profile
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.
id of the customer.
Options are "customer" or "payment_profile".
Use in query: cascade[]=customer&cascade[]=payment_profile.
application/json
application/json
curl -X POST -G \ --url 'https://subdomain.chargify.com/subscriptions/1/purge.json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -d 'ack=1'