Cancel a subscription

This endpoint cancels a specific subscription using its subscription_id. The subscription moves to canceled status immediately, at the end of the current billing cycle, or on a specific date, depending on cancel_policy. Once that time is reached, the subscription moves to expired status. Business rules: - The subscription must be active.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Business Rules:

  • The subscription must be active.
  • The merchant will be given the option to cancel the subscription at the next renewal cycle or at the end of the subscription contract.
  • After the renewal cycle time, the subscription is set to expired.
Path Params
string
required

Unique ID of the subscription to cancel.

Body Params
date-time

Date on which the cancellation will take effect. Required only when cancel_policy is cancel_at.

string
enum
required

Indicates when the cancellation should take effect.

Allowed:
string

Reason for the cancellation, for auditing purposes.

Headers
string
required

Authentication key used to access the API.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json