billing_subscriptions

Cancel subscription

Cancel at the end of the current period (terminal): the workspaces drawing from it lose their coverage then, are suspended and their data retention clock arms; no immediate charge or refund. DANGEROUS. There is no delete verb; cancel is the termination, undo_cancel_billing_subscription takes it back before the period ends. Owner only.

Contract:

  • MCP tool cancel_billing_subscription, registry package mcp.id/billing_subscriptions, mount id.billing.
  • Operation action, response envelope action.
  • Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.
post/api/billing-subscriptions/{sid}/cancel

Request

  • Base URL
    https://beta.getsales.io/id/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

Billing subscription sid (bl_sb_...).

Response

action success envelope.

successtrue required
operation'action' required
actionstring required

kebab-case verb; matches the route segment.

resultobject required

Changes

No recorded changes to this operation across all 1 revision of this API.