Change Product

History will be preserved: it will not affect past items (shipments).

This request must meet two conditions:

1. The product ID that you are swapping to must already exist in Ordergroove.
2. The subscription must be active (live) in order to swap it to a new product.

Additional Validations for Prepaid Subscriptions:

• For prepaid subscriptions that have prepaid orders remaining, the product you are swapping to needs to have the same price as the current product. This ensures that the value and terms of the prepaid subscription are maintained without discrepancies.
• If you want to allow customers to sku swap for products of lesser value you can contact Ordergroove support to enable it.

Response Body Definitions

Bundle Components Example

New Bundle components structure:

[
  {
    "public_id": "79d2dc76245111eeb185acde48001122",
    "quantity": 1,
    "product": "0070067690"
  },
  {
    "public_id": "7eeaa504245111eeb185acde48001122",
    "quantity": 3,
    "product": "0070067691"
  }
]

Component object properties:

• public_id (string): Component public ID
• quantity (integer): Quantity of the component
• product (string): Product ID

Extra Data Example

Raw JSON string that should be JSON.parse() as key/value store for any extra information:

{
  "some": "extra",
  "fields": "here"
}

Prepaid Context Example

Prepaid subscription information:

{
  "prepaid_orders_remaining": 0,
  "prepaid_orders_per_billing": 3,
  "renewal_behavior": "autorenew",
  "last_renewal_revenue": 100.8,
  "prepaid_origin_merchant_order_id": "#3082"
}

For more details, see Prepaid Subscriptions Data.