SaaS SDKSaaS APIsubscriptions

Cancel subscription

以 Markdown 格式查看

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

请求头

Authorizationstring必需

Bearer {access_token}

X-Workspace-Idstring必需
Workspace UUID
Idempotency-Keystring可选
Client UUID for idempotent request

请求

atPeriodEnd (default true), reason (optional)

atPeriodEndboolean可选
default true
reasonstring可选

响应

data: status, cancelAtPeriodEnd, currentPeriodEnd, message

错误

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