Skip to main content

subscriptionUpgradePreview

Quotes what a subscription upgrade would cost for the current company: what is charged today, and the next invoice after it. Lets the confirm step show real figures before anything changes.

Business Rules​

  • Applies the same rules as upgradeSubscription, so an upgrade this quotes is one the mutation will accept
  • A trialing subscription is charged nothing today; its next invoice is quoted as if the trial had ended, so the figures are the first bill after it
  • Nothing is changed at the billing provider

Error Scenarios​

  • Choose a plan or add-ons to upgrade when nothing would change
  • X is not an upgrade from Y when the plan is not priced higher
  • To remove X, contact us when an add-on quantity goes down
  • Contact us to have more than 20 X when an add-on quantity is over the limit

Permissions Required​

  • billing:read_subscription on the company
subscriptionUpgradePreview(
  upgrade: SubscriptionUpgradeInput!
): SubscriptionUpgradePreview!

Arguments​

subscriptionUpgradePreview.upgrade ● SubscriptionUpgradeInput! non-null input common​

The upgrade to quote.

Type​

SubscriptionUpgradePreview object billing​

What a subscription upgrade would cost, quoted from the billing provider: the prorated difference charged today, and the next regular invoice. Figures are estimates, because the provider prorates to the second.