Skip to main content
POST
Cancel a subscription
Ends a subscription. By default the merchant keeps access until the end of the period they paid for.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side, never send a shop id.

Path Parameters

id
string
required

The subscription id.

Body

application/json
immediately
boolean
default:false
reason
string
Maximum string length: 200

Response

The subscription, now cancelled or scheduled to end.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object

A recurring charge. The merchant approves once and picks a wallet, then each period is taken from that wallet automatically.