Skip to main content
GET
Preview proration for a plan change (nothing is applied)
Returns the proration breakdown for switching a subscription to another plan before anything is charged or persisted. It runs the exact function PUT /v1/subscriptions/{id} uses, so the preview matches the invoice or credit note the real change would post. The plan must exist in your tenant — see Get Plan. All amounts are minor units in the subscription’s currency.

Query Parameters

Example Request

Response

Fields

Read-only and side-effect free — no invoice, credit note, or ledger entry is created. Apply the change with Update Subscription.

Errors

Errors use the standard envelope — see Errors.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Query Parameters

plan_id
string<uuid>
required

The plan to preview switching to.

Response

Proration breakdown.

data
object

Read-only proration breakdown for a subscription plan change. Monetary fields are in the currency's smallest unit (e.g. paise/cents).