Billing Actions Support

Cancel a workspace's subscription (or its deal), now or at period end

now: billing stops today, the unused time becomes credit on the customer (no refund) and the workspace lands on Free. period_end: the workspace keeps its plan until the paid period ends. A live deal is cancelled instead (a partner deal: now only). Refused when there is nothing to cancel, for a Chargebee workspace, and when a cancellation at period end is already scheduled.

post/support/billing/{workspace_id}/cancel-subscription

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/support/billing/{workspace_id}/cancel-subscription
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Request body

when'now' | 'period_end' required

Response

Request fulfilled, document follows

messagestring required
whenstring required
effective_atstring nullable
deal_idinteger nullable

Changes

No recorded changes to this operation across all 3 revisions of this API.