API reference

Cancel a merchant subscription

Cancel a StableOps merchant subscription immediately or schedule period-end cancellation, and inspect subscription and invoice state before removing access.

POST/v1/merchant/subscriptions/{id}/cancel

Authorization

bearerAuth

AuthorizationBearer <token>

Paste your API key from the dashboard.

In: header

Path Parameters

id*unknown

Merchant subscription id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

immediate?boolean

Response Body

`application/json`

curl -X POST "https://example.com/v1/merchant/subscriptions/{id}/cancel" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "merchant_user_id": "string",
  "plan_id": "string",
  "status": "incomplete",
  "current_period_start": "2019-08-24T14:15:22Z",
  "current_period_end": "2019-08-24T14:15:22Z",
  "cancel_at_period_end": true,
  "pending_plan_id": "string",
  "pending_plan_change_at": "2019-08-24T14:15:22Z",
  "trial_ends_at": "2019-08-24T14:15:22Z",
  "canceled_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

How is this guide?

Last updated

Change a merchant subscription plan POST

Change a StableOps merchant subscription plan, inspect upgrade difference invoices or scheduled renewal changes, and wait for settlement before changing access.

Resume a merchant subscription POST

Clear scheduled period-end cancellation on a non-terminal StableOps merchant subscription without paying outstanding invoices or reviving an expired record.