SaaS APIsubscriptions

Cancel subscription

View as Markdown

Cancel subscription. Owner/billing_admin only. atPeriodEnd true (default) = cancel at period end; false = cancel immediately. Supports Idempotency-Key.

Headers

AuthorizationstringRequired

Bearer {access_token}

X-Workspace-IdstringRequired
Workspace UUID
Idempotency-KeystringOptional
Client UUID for idempotent request

Request

atPeriodEnd (default true), reason (optional)

atPeriodEndbooleanOptional
default true
reasonstringOptional

Response

data: status, cancelAtPeriodEnd, currentPeriodEnd, message

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error