previewSubscriptionUpdate

Previews a plan change through Stripe without applying it. A trial change can end the trial and charge immediately; lower-price changes or delayed renewals can defer billing. When requiresCheckout is true, amounts are null; otherwise pass the returned prorationDate to updateSubscriptionItems when present. Requires authentication.

previewSubscriptionUpdate(
  planPriceId: String!
): SubscriptionUpdatePreview!

Arguments

previewSubscriptionUpdate.planPriceId ● String! non-null scalar

Stripe price ID from pricingGrid or a tier stripeId from tieredPricingPlans; not the numeric payment plan ID.

Type

SubscriptionUpdatePreview object

Cost and timing preview returned by previewSubscriptionUpdate before a plan change is applied.