Skip to main content
GET
Preview Change Plan

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:
pro,
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
coupon_applies_to_target
boolean
default:true
coupon_id
string | null
coupon_name
string | null