SubscriptionUpdatePreview
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.
type SubscriptionUpdatePreview {
credit: Int!
charge: Int!
net: Int!
direction: ProrationDirection!
refundCapped: Boolean!
effectiveAt: AWSTimestamp!
currentPeriodEnd: AWSTimestamp!
newPeriodEnd: AWSTimestamp
nextPaymentAt: AWSTimestamp
}
Fields
SubscriptionUpdatePreview.credit ● Int! non-null scalar
Unused time that would be credited at the current amount, in the smallest currency unit.
SubscriptionUpdatePreview.charge ● Int! non-null scalar
Time that would be charged at the new amount, in the smallest currency unit. An interval change charges the full new amount. A moved nextPaymentAt charges the time from now to the new date.
SubscriptionUpdatePreview.net ● Int! non-null scalar
Net that would be settled, charge - credit. Positive means a charge, negative a refund.
SubscriptionUpdatePreview.direction ● ProrationDirection! non-null enum
Whether the net would be charged, refunded, or neither.
SubscriptionUpdatePreview.refundCapped ● Boolean! non-null scalar
Always false. A refund is covered in full by the payments of the current billing period, or the preview fails.
SubscriptionUpdatePreview.effectiveAt ● AWSTimestamp! non-null scalar
Time the change would take effect. Measured in seconds since the Unix epoch.
SubscriptionUpdatePreview.currentPeriodEnd ● AWSTimestamp! non-null scalar
End of the current billing period. Measured in seconds since the Unix epoch.
SubscriptionUpdatePreview.newPeriodEnd ● AWSTimestamp scalar
End of the billing period the change would start; only present when the change resets the period, i.e. an interval change or a moved anchor. Measured in seconds since the Unix epoch.
SubscriptionUpdatePreview.nextPaymentAt ● AWSTimestamp scalar
When the next payment would be taken; present on the same changes as newPeriodEnd. Measured in seconds since the Unix epoch.