v1

latestOpenAPI 3.0.02026-08-0610682246.0 KB
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

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