Cancel Grouped Subscriptions
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Cancels all subscriptions within the specified group immediately. The group is identified by the uid that is passed in the URL. To successfully cancel the group, the primary subscription must be on automatic billing. The group members must be on automatic billing or prepaid.
To cancel a subscription group while also charging for any unbilled usage on metered or prepaid components, the charge_unbilled_usage=true parameter must be included in the request.
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 uid of the subscription group
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
curl -X POST \ --url 'https://subdomain.chargify.com/subscription_groups/uid/cancel.json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "charge_unbilled_usage": true}'