PreviewSubscriptionUpdateInput

Prospective mid-cycle change to price a proration for.

input PreviewSubscriptionUpdateInput {
  subscriptionId: ID!
  amount: Int
  interval: IntervalInput
  intervalCount: Int
  nextPaymentAt: AWSTimestamp
}

Fields

PreviewSubscriptionUpdateInput.subscriptionId ● ID! non-null scalar

ID of the subscription the change would apply to.

PreviewSubscriptionUpdateInput.amount ● Int scalar

The new amount, as a positive integer in the smallest currency unit.

PreviewSubscriptionUpdateInput.interval ● IntervalInput enum

The new subscription interval. Changing it resets the billing period.

PreviewSubscriptionUpdateInput.intervalCount ● Int scalar

The new number of intervals between payments. Changing it resets the billing period.

PreviewSubscriptionUpdateInput.nextPaymentAt ● AWSTimestamp scalar

The new billing anchor. Moving it resets the billing period and settles the difference: an earlier anchor refunds the time given back, a later one charges for the extra. Only an ACTIVE subscription accepts it. Cannot be combined with an interval change, and cannot charge for more than 24 billing periods. Measured in seconds since the Unix epoch.

Member Of

previewSubscriptionUpdate query