Skip to main content

SubscriptionUpgradePreview

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.

type SubscriptionUpgradePreview {
  currencyCode: String
  dueToday: SubscriptionUpgradeInvoice
  invoiceAt: ISO8601DateTime
  nextInvoice: SubscriptionUpgradeInvoice!
  plan: BillingProduct
}

Fields​

SubscriptionUpgradePreview.currencyCode ● String scalar common​

Currency the figures are quoted in.

SubscriptionUpgradePreview.dueToday ● SubscriptionUpgradeInvoice object billing​

What is charged to the card on file when the upgrade goes through. Null for a trialing subscription, which is not charged until its trial ends.

SubscriptionUpgradePreview.invoiceAt ● ISO8601DateTime scalar common​

When the next invoice is due: the end of the trial for a trialing subscription, otherwise the end of the current billing period, which an upgrade does not move.

SubscriptionUpgradePreview.nextInvoice ● SubscriptionUpgradeInvoice! non-null object billing​

The next regular invoice after the upgrade.

SubscriptionUpgradePreview.plan ● BillingProduct object billing​

The plan after the upgrade: the new plan, or the current one if it stays.

Returned By​

subscriptionUpgradePreview query