Partners
Cancel Accounts
Cancel the subscription for a customer, cancelling all accounts associated with it at the end of the billing period
POST
Request Body
string
required
The Stripe subscription ID to cancel. Since a subscription covers multiple accounts, this cancels all accounts associated with it. Retrieve the subscription ID from the Get Accounts endpoint.
Response
boolean
Returns
true if the subscription was successfully queued for cancellation.Cancellation Details
- The subscription is set to cancel at the end of the current billing period — the customer keeps access until then
- All accounts under the subscription are updated to
pending_cancellation - When the billing period ends, accounts are automatically moved to
cancelledand removed from Infinipost - Cancelled accounts cannot be reactivated — a new checkout session must be created to purchase replacement accounts
Error Responses
Invalid API Key
Missing Required Fields