Cancel My Subscription

POST

/api/account/subscriptions/{subscriptionId}/cancel

curl --request POST \
  --url https://example.com/api/account/subscriptions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example" }'

Cancels one of the customer’s subscriptions. Enforces the merchant’s minimum term and any early-cancellation fee; if that fee is declined nothing changes (400). Cancelling a subscription that is already cancelled changes nothing and charges no fee (204).

Authorizations

• Bearer

Parameters

Path Parameters

subscriptionId

required

string format: uuid

Request Body

Optional reason for a customer-initiated subscription cancellation.

object

reason

string

nullable

Example ^generated

{
  "reason": "example"
}

Optional reason for a customer-initiated subscription cancellation.

object

reason

string

nullable

Example ^generated

{
  "reason": "example"
}

Optional reason for a customer-initiated subscription cancellation.

object

reason

string

nullable

Example ^generated

{
  "reason": "example"
}

Responses

204

No Content

400

Bad Request

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}