Cancel Grouped Subscriptions
Cancels 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.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The uid of the subscription group
Request Body
application/json
Response Body
application/json
curl -X POST "https://example.com/subscription_groups/string/cancel.json" \ -H "Content-Type: application/json" \ -d '{ "charge_unbilled_usage": true }'Remove Subscription from Group DELETE
Removes an existing subscription from a subscription group. For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays#customer-hierarchies) features, it is possible to remove an existing subscription from a subscription group.
Initiate Delayed Group Cancellation POST
Schedules all subscriptions within the specified group to be canceled at the end of their billing period. The group is identified by its uid passed in the URL. All subscriptions in the group must be on automatic billing in order to successfully cancel them, and the group must not be in a "past_due" state.