cancelSubscription

Cancel a subscription. 🔐 This method requires authorization.

Description

This method cancels the current user's subscription identified by its marker. It returns a Promise that resolves to true if the subscription was cancelled, or an IError object if there was an issue.

⚠️ With the default errors.isShell: true setting, a rejected request is returned rather than thrown: this method resolves to an IError object, never to false. Check result === true - an error object is truthy, so if (result) would treat a failure as success.

Subscriptions.cancelSubscription(

body*

);

Parameters schema

Schema

body(required): ICancelSubscription
Subscription body
example:

{ marker: "premium" }

body.marker(required): string
Subscription marker.
example: "premium"

Examples

Minimal example

const response = await Subscriptions.cancelSubscription({ marker: 'premium' });

Example response

{
  "statusCode": 404,
  "timestamp": "2026-08-14T13:04:36.941Z",
  "message": "No subscription found"
}

Response schema

Details

Schema: boolean

boolean: boolean
Returns true if the subscription was cancelled.
example: true

---