Skip to main content
DELETE
Cancel the plan

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization-code flow with PKCE.

Scopes

streamloop:billing

Move money: top up, start, change or cancel a plan, set the spend cap

Headers

X-Workspace-Id
string

Workspace this request operates in — the workspace id (wksp_…) or the organization id, from GET /workspaces. Required with an API key, which carries no workspace (400 WORKSPACE_REQUIRED without it). With an OAuth token it defaults to the workspace the token was issued for. Responds 403 WORKSPACE_FORBIDDEN when the caller is not a current member, rather than falling back to another workspace.

Query Parameters

atPeriodEnd
enum<string>
default:true

false cancels now instead of at the end of the period.

Available options:
true,
false

Response

Successful response.

userErrors
object[]
required
account
object | null
plan
object | null