ZUzuora
Stripe Payments

Preview the Stripe subscription change

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.

post/zephr/payment/stripe/subscription/{subscriptionId}/change-previews

Request

  • Base URL
    https://demo-site
  • URL
    https://demo-site/zephr/payment/stripe/subscription/{subscriptionId}/change-previews
  • Auth
    • API key in cookie blaize_session
    • or API key in query parameter jwt
    • or API key in header x-blaize-jwt
    • or API key in header x-zephr-jwt
    • or HTTP bearer
    • or API key in cookie blaize_jwt

Path parameters

subscriptionIdstring required

The ID of the Stripe subscription to change.

Request body

plan_idstring required

The new Stripe price plan ID.

Example request

{
  "plan_id": "price_H8eIeMFwMawg6w"
}

Response

OK

totalnumber

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

sub_totalnumber

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

Example response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.