Change Variant/Price

Commits a variant/price change for a subscription line item. The change must be
configured as an allowed upgrade or downgrade option on the source variant. By default,
upgrades take effect immediately and are prorated; downgrades take effect at the next
renewal and are not prorated. Both behaviours can be overridden via prorate and
effective_time.

Source allowed products_price_id targets from GET /products/prices/{price_id}/change_options,
and preview the impact via POST /orders/line_items/{line_item_id}/changes before
committing here. The response envelope is the same as preview, with preview: false
the amount fields and next_invoice_date carry the upstream invoice quote snapshotted
just before the commit was applied.

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

Target variant and price plus optional proration and timing overrides

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