Skip to main content
POST
Change plan

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 move to, from price_ids in List plans.

Response

The plan change, applied now or scheduled.

The outcome of a plan change.

success
boolean
required

true when the change is complete. false when an upgrade is already applied but its charge needs the payer to act, for example to confirm the payment with their bank.

Example:

true

payment_action_url
string | null
required

Stripe page where the payer completes the charge when success is false. null when no action is needed. It can also be null when success is false. Then find the open invoice with Get billing info.

Example:

"https://invoice.stripe.com/i/acct_1N3XrmDr56L89dkK/live_YWNjdF8xTjNYcm1EcjU2TDg5ZGtL"

subscription
PlanChangeSubscription · object
required

The subscription after the change.