Skip to main content
POST
Cancel Subscription

Authorizations

Authorization
string
header
required

Bearer API Key authentication. Format: Authorization: Bearer {your_api_key}

Headers

Request-Id
string
default:008e3967-a1b5-48bb-be14-d5bff5092e61
required

The unique identifier of the request

Path Parameters

subscription_id
string
required

Subscription ID

Body

application/json

Cancel subscription request

cancel_type
string
required

Cancel subscription type:

  • end_of_period: Terminate at end of period
  • immediate: Terminate immediately
refund_type
string
required

Required, refund type: none-no refund, full-full refund, partial-prorated refund based on usage time, required only when terminating immediately

merchant_id
string

Merchant unique identifier

cancel_reason
string

Cancel subscription reason

Response

OK

Cancel subscription response

code
string

error code

message
string

error message

data
object

Cancel subscription response