Skip to main content
POST
Preview plan change

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

price_id
string
required

Price ID of the plan to preview, from price_ids in List plans.

Response

What the upgrade costs now and at renewal.

What an upgrade costs now and at renewal.

prorated_amount_due
number
required

Amount Change plan charges now for this upgrade, in major units of currency (dollars, not cents). When full_diff is true, this is the full price difference rather than a prorated amount.

Example:

12.5

currency
string
required

Lowercase three-letter currency code of both amounts.

Example:

"usd"

next_billing_date
integer
required

When the new plan next renews, as a Unix timestamp in seconds.

Example:

1767225600

recurring_amount
number
required

What the new plan costs at each renewal, in major units of currency.

Example:

50

billing_interval
string
required

How often the new plan renews: month or year.

Example:

"month"

full_diff
boolean
required

true when prorated_amount_due is the full price difference between the plans, not a prorated share of it.

Example:

false