previewSubscriptionUpdate

Prices a prospective mid-cycle subscription change without applying it. Returns the credit, charge and net that a prorated update would settle. It accepts the same changes and fails with the same errors as updateSubscription with prorate: true. Only an ACTIVE subscription settles money: a TRIALING one returns zeros, and other statuses fail. Arguments: - input: The change to price.

previewSubscriptionUpdate(
  input: PreviewSubscriptionUpdateInput!
): SubscriptionUpdatePreview

Arguments

previewSubscriptionUpdate.input ● PreviewSubscriptionUpdateInput! non-null input

Type

SubscriptionUpdatePreview object

What a prorated mid-cycle change would settle, computed without changing anything. Nothing is persisted or reserved: executing the change recomputes the figures, so a preview taken long before the change may differ. For a TRIALING subscription, all amounts are 0: a change during the trial moves no money.