Cancel Subscription

POST

/api/Subscriptions/{id}/cancel

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

Cancels a subscription permanently. This cannot be undone. To re-enrol the member, create a new subscription. The matching subscription at the payment gateway is archived.

Authorizations

• Bearer

Parameters

Path Parameters

id

required

string format: uuid

The subscription’s unique identifier.

Request Body

Optional cancellation reason.

object

id

string format: uuid

reason

string

nullable <= 500 characters

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "reason": "example"
}

object

id

string format: uuid

reason

string

nullable <= 500 characters

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "reason": "example"
}

object

id

string format: uuid

reason

string

nullable <= 500 characters

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "reason": "example"
}

Responses

200

Subscription cancelled.

Media type application/json

object

id

string format: uuid

merchantId

string format: uuid

memberId

string format: uuid

memberName

string

nullable

planId

string format: uuid

planName

string

nullable

planFrequency

string

Allowed values: OneOff Daily Weekly Fortnightly Monthly Quarterly Yearly

planPrice

number format: double

paymentMethodId

string format: uuid

nullable

status

string

Allowed values: Trial Active PastDue Paused Cancelled

startDate

string format: date-time

trialEndsAt

string format: date-time

nullable

nextBillingDate

string format: date-time

nullable

nextBillingAmount

number format: double

nullable

pausedAt

string format: date-time

nullable

cancelledAt

string format: date-time

nullable

cancellationReason

string

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

Example

{
  "planFrequency": "OneOff",
  "status": "Trial"
}

404

No subscription with the given ID exists.

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"
}