Preview Variant/Price Change

Returns a non-destructive preview of changing the variant and price of a subscription line item, including proration math, the next charge amount, and the effective date. Follows the same upgrade/downgrade rules as the in-app self-serve flow.

Source allowed products_price_id targets from GET /products/prices/{price_id}/change_options. After previewing, call POST /orders/line_items/{line_item_id}/changes/perform with the same body to commit. The response envelope is identical between preview and commit and only the preview flag flips.

On commit, the previous_line_item block reflects the line item's pre-change state for products_price, products_variant, original_product, and prorated. Other scalar attributes (created_at, updated_at, quantity) reflect the post-commit state on the underlying record.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
required

The id of the subscription line item. Accepts either the integer database id or the obfuscated public_id string returned by line-item endpoints.

Body Params

Variant and price target for the preview

Parameters to preview or commit a subscription line item variant/price change

orders_line_items_change
object
required
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json