Skip to main content
POST

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password. Use your client_id as the username and your secret as the password value.

Path Parameters

id
string
required

The subscription ID from the subscription object.

Example:

"ka8sdf0asdfm10as0a0sdfja7ssa8"

Body

application/json

Optional parameters for cancelling a subscription or bill.

simulate
enum<string>

Simulate a failure in the development environment and trigger the CANCELLATION_FAILED webhook.

Available options:
failed
Example:

"failed"

Response

Cancellation request accepted.

message
string
Example:

"Success"