v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Subscriptions API

Cancel subscription

Cancel an existing subscription. Canceling a subscription has no effect on the mandates of the customer.

🔑 Access with

API key

Advanced access token with subscriptions.write

OAuth access with subscriptions.write

delete/customers/{customerId}/subscriptions/{subscriptionId}

Request body

testmodeboolean nullable

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

The updated subscription object with status canceled. For a complete reference of the subscription object, refer to the Get subscription endpoint documentation.