Cancel a Subscription

POST 
/v1/subscriptions/:id/cancel

Schedules a Subscription cancellation for the end of the current billing cycle (the default), for the end of the next one, or applies it immediately

Request

Responses

200

OK

202

The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway.

400

The request failed validation. errors lists every problem found; an entry attributable to a specific field is prefixed with that field’s path.

401

No API key was supplied, or the key is not valid.

403

The API key is valid but lacks the permission this operation requires.

404

No resource exists with the requested identifier.

409

The supplied X-Idempotency-Key was already used with a different request body, or the resource is being modified by another in-flight request.

429

Too many requests. The rate limit is applied per client across all operations.

500

The request could not be completed because of an unexpected error.

504

The request exceeded the processing time limit and was abandoned.