Preview the Stripe subscription change

Request

Generates a preview of the invoice that Stripe will create for the customer if their subscription is changed to a new plan. The invoice will be a prorated invoice for the price difference between current and new subscription plans for the remainder of the current billing period. The invoice will be billed immediately upon changing subscription. The invoice amount may be negative if the customer is changing to a lower-priced plan.

Note: This method does not modify the user's subscription.

Security

CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie

Path

subscriptionIdstringrequired

The ID of the Stripe subscription to change.

Bodyapplication/json

plan_idstringrequired

The new Stripe price plan ID.

Example:"price_H8eIeMFwMawg6w"

{
  "plan_id": "price_H8eIeMFwMawg6w"
}

Responses

OK

Headers

any

Body*/*

totalnumber

The total amount of the prorate invoice in the relevant currency's lowest denomination (e.g. pence).

Example:5000

sub_totalnumber

The total amount of the prorate invoice minus tax in the relevant currency's lowest denomination (e.g. pence).

Example:4500

Response

{
  "total": 5000,
  "sub_total": 4500
}