Skip to main content
GET
/
api
/
v1
/
workspaces
/
{workspace_id}
/
billing
/
change-plan
/
preview
Preview Change Plan
curl --request GET \
  --url https://api.example.com/api/v1/workspaces/{workspace_id}/billing/change-plan/preview \
  --header 'X-API-Key: <api-key>'
{
  "currency": "<string>",
  "next_invoice_amount": 123,
  "next_invoice_date": "2023-11-07T05:31:56Z",
  "next_invoice_proration": 123,
  "next_invoice_recurring": 123,
  "promotion_code_applied": "<string>",
  "prorated_today": 123,
  "target_plan": "<string>",
  "warnings": [
    {
      "current_count": 123,
      "new_limit": 123,
      "overflow": 123,
      "type": "org_disconnect_required"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.riftmap.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

Headers

X-Workspace-Id
string | null

Path Parameters

workspace_id
string<uuid>
required

Query Parameters

target_plan
enum<string>
required
Available options:
team,
business
promotion_code
string | null

Cookies

riftmap_access
string | null

Response

Successful Response

currency
string
required
next_invoice_amount
integer
required
next_invoice_date
string<date-time> | null
required
next_invoice_proration
integer
required
next_invoice_recurring
integer
required
promotion_code_applied
string | null
required
prorated_today
integer
required
target_plan
string
required
warnings
ChangePlanPreviewWarning · object[]
required