Stripe Subscriptions

Change the purchased storage allocation

Set the workspace's TOTAL storage allocation on an inline-pricing plan. The plan's subscription item is re-priced and the difference invoiced immediately. When the card payment fails, the storage stays as it was, checkout_url is the Stripe page that pays the invoice and next_action is payment_pending. While a change is waiting for payment, the request is refused with 409.

put/workspaces/{workspace_id}/subscription/storage

Request

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

Request body

storage_gbinteger required

Chosen TOTAL storage allocation in GB; the plan's included storage or one of its storage options

Response

Request fulfilled, document follows

storage_gbinteger required
messagestring required
checkout_urlstring nullable
next_actionstring nullable

Changes

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