Skip to main content

updateSubscriptionItems

Changes the plan through Stripe; picking the current price again reactivates a subscription that is set to cancel. Downgrades are scheduled for the period end; other changes can charge a prorated amount now or end a trial immediately. Returns a checkout URL when there is no paid subscription to change. Call previewSubscriptionUpdate first and confirm any returned client secret. Requires billing change plan access.

updateSubscriptionItems(
  planPriceId: String!
  prorationDate: Int
): UpdateSubscriptionResult

Arguments​

updateSubscriptionItems.planPriceId ● String! non-null scalar​

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

updateSubscriptionItems.prorationDate ● Int scalar​

Proration time in Unix seconds from previewSubscriptionUpdate.prorationDate; omit when the preview returns null.

Type​

UpdateSubscriptionResult object​

Plan change response from updateSubscriptionItems; kind is always UPDATED, including deferred changes and checkout redirects. Confirm clientSecret when present, otherwise follow url.