Returns a preview of what a subscription adjustment would look like, including proration amount, payment method, and whether the adjustment can be made. This endpoint does not make any changes to the subscription. Use this to show users what will happen before they commit to an adjustment.
Successful response
Whether the adjustment can be made. If false, the reason field will contain the explanation.
Epoch milliseconds when this preview was generated. Useful for staleness detection.
-9007199254740991 <= x <= 9007199254740991The reason the adjustment cannot be made, if canAdjust is false.
The proration amount that will be charged, if applicable.
The total price of the current plan (sum of unitPrice * quantity for all items).
The total price of the new plan (sum of unitPrice * quantity for all items).
The resolved timing for the adjustment. When auto timing is requested, this indicates whether it resolved to immediate or end-of-period.
immediately, at_end_of_current_billing_period Epoch milliseconds when the adjustment will take effect.
-9007199254740991 <= x <= 9007199254740991Whether this adjustment is an upgrade (true) or downgrade/lateral move (false).
The percentage through the current billing period (0-1).
Epoch milliseconds when the current billing period ends.
-9007199254740991 <= x <= 9007199254740991The payment method that will be charged for immediate adjustments with proration.
The current subscription items.
The new subscription items that will be applied.