Cancel subscription

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

Access with

API key

Organization access token with subscriptions.write

OAuth access with subscriptions.write

Path Params
string
required

Provide the ID of the related customer.

string
required

Provide the ID of the related subscription.

Body Params
boolean | null

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.

Responses

Language
Credentials
Request
Response
Choose an example:
application/hal+json