API reference
Cancel portal subscription
Cancel a subscription through its StableOps Portal session, choosing immediate or period-end cancellation and checking the state before updating access.
POST
/v1/merchant/portal/subscription/cancelRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/merchant/portal/subscription/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
Get portal invoice payment status GET
Check a StableOps Portal invoice payment status within the customer’s session to refresh billing progress and avoid treating browser redirects as payment proof.
Resume portal subscription POST
Resume a non-terminal StableOps Portal subscription by clearing scheduled cancellation, without paying unpaid invoices or reactivating an expired subscription.