SubscriptionUpdatePreview

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

type SubscriptionUpdatePreview {
  amountDueNow: Int
  currency: String
  prorationDate: Int
  requiresCheckout: Boolean!
  effectiveDate: Int
  endsTrial: Boolean!
  nextAmount: Int
}

Fields

SubscriptionUpdatePreview.amountDueNow ● Int scalar

Amount due now in minor units of currency, such as cents; null when checkout must supply the price.

SubscriptionUpdatePreview.currency ● String scalar

Lowercase ISO 4217 code of the previewed charge, such as usd; null when nothing was priced.

SubscriptionUpdatePreview.prorationDate ● Int scalar

Proration calculation time in Unix seconds; pass it to updateSubscriptionItems.prorationDate when present.

SubscriptionUpdatePreview.requiresCheckout ● Boolean! non-null scalar

SubscriptionUpdatePreview.effectiveDate ● Int scalar

When the change takes effect, in Unix seconds: now for immediate changes, the period end or held renewal date for deferred ones, and null for checkout-required previews and reactivations.

SubscriptionUpdatePreview.endsTrial ● Boolean! non-null scalar

True when confirming ends the customer's trial now and charges them immediately.

SubscriptionUpdatePreview.nextAmount ● Int scalar

Next amount in minor units of currency; populated for trial-change previews and otherwise null.

Returned By

previewSubscriptionUpdate query