Stripe Subscriptions

Cancel the plan change waiting for payment

Void the invoice of the held change, so it can no longer be paid, and keep the workspace as it is (cancelled). When the invoice was paid already, the change is applied instead (landed). Both are false when nothing was held.

post/workspaces/{workspace_id}/subscription/held-change/cancel

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/subscription/held-change/cancel
  • 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

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4

Response

Request fulfilled, document follows

cancelledboolean required
landedboolean required

Changes

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