Skip to main content

Replace a Product in a Subscription

Zuora

Replace a Product in a Subscription

Orders is now generally available as of Zuora Billing Release 284 (August 2019). You can access all the new capabilities in the Sandbox environment starting August 31, 2020. The Production deployment is September 10, 2020.

If you are an existing Zuora Subscribe and Amend customer and want to adopt Orders, see What is Orders Harmonization and join the Orders Harmonization community group for more information. If you want to enable Orders, submit a request at Zuora Global Support.

This tutorial demonstrates how to replace a product in a subscription by creating an order. You will remove a product from the subscription and add a different product to the subscription.

In this tutorial, you will set the following dates to today's date:

  • The date when the order is signed
  • The contract effective date of the product removal
  • The service activation date of the product removal
  • The customer acceptance date of the product removal

You will set the following dates to tomorrow's date:

  • The contract effective date of the product addition
  • The service activation date of the product addition
  • The customer acceptance date of the product addition

Use the Zuora application

To replace a product in a subscription:

  1. Navigate to Customers > Orders. The Orders page opens.

  2. Click Create New Order at the top right. The Create New Order page opens.

  3. In the Account field, enter the name of the account that owns the subscription. 

    You can enter the account by clicking either Account Name or Account Number.

    • If you click Account Name, type part of the account name in the Account field and the filtered accounts can be dynamically listed for your selection.
    • If you click Account Number, type the exact account number.
  4. Choose what you want to do by clicking Amend an Existing Subscription.

  5. In the Select an existing subscription area, locate the target subscription to which you are to add products by using the Search field.

  6. On the target subscription line, click Select in the Action column. 

    select-subscriptions.png

  7. To remove the product, complete the following steps:

    1. In the Included Products tab of the Associated subscriptions area, find the target product, and click Remove below the rate plan name. The Remove rate plan charge window opens.

      remove-product.png

    2. Specify appropriate dates in the Contract effectiveService activation, and Customer acceptance fields.

    3. Click Continue. The window is closed.

  8. To add another product, complete the following steps:

    1. At the top of the Associated subscriptions area, click Add Product, which is displayed to the right of the subscription number. 

    2. Scroll up to the top of the page, and select appropriate dates in the Contract EffectiveService Activation, and Customer Acceptance fields.

    3. In the Products and charges area, search and locate the product to be added. You can choose to search by product name or by product SKU by using the drop-down list. The displayed products will dynamically change as you type in the Search field.

      SearchProduct.png

    4. To add a rate plan, click the right arrow ( > ) next to the product name to expand all its rate plans, and then select the checkbox in front of the rate plan.

      SelectRatePlan.png

      You can select more than one rate plan in multiple products. To remove a rate plan from your selection, clear the checkbox in front of the rate plan. The number of the selected rate plan is also indicated in the UI.

    5. Click Add Product in the bottom right corner to continue. 

  9. (Optional): Update the charges for the selected rate plan if necessary.

  10. Click Review Order to continue. The included products are all displayed for the selected subscription.

    At this point, you can still click Add Product to add more rate plans to this subscription.

  11. (Optional): To preview billing information for the subscription, click Preview Billing. Specify the preview settings and click Update Preview to see the preview invoices. After you are finished, click Done to return to the previous page.

  12. For the new order to take effect, click Activate.

Use the REST API

You can use the "Create order" operation to replace a product in a subscription. Before the Orders feature is enabled, you have to use the "Update subscription", "Amend", or "CRUD: Create amendment" operation.

To replace a product in a subscription by creating an order:

  1. Determine the values of the following variables:

    Variable Description
    $SubscriptionNum The number of the subscription to update. For example, A-S00000001.
    $AccountNum The number of the account that will own the order. For example, A00000001.
    $RPIdRemove The ID of the rate plan to remove from the subscription. For example, 8a8081085e0d4b70015e4b844495058d.
    $ProductRPId The ID of the product rate plan to add to the subscription. For example, 8a8081085d834928015d9ce60ef41acf.
    $ProductRPChargeId The ID of the product rate plan charge to use when adding the product rate plan. For example, 8a8081085d834928015d9ce6ae821ad1.
    $Today Today's date. For example, 2017-09-30.
    $Tomorrow Tomorrow's date. For example, 2017-10-01.
  2. Use the "Create order" operation to create an order under an existing account:

    Request POST /v1/orders/
    Request Body
    {
      "orderDate": $Today,
      "existingAccountNumber": $AccountNum,
      "subscriptions": [
        {
          "subscriptionNumber": $SubscriptionNum,
          "orderActions": [
            {
              "type": "RemoveProduct",
              "triggerDates": [
                {
                  "name": "ContractEffective",
                  "triggerDate": $Today
                },
                {
                  "name": "ServiceActivation",
                  "triggerDate": $Today
                },
                {
                  "name": "CustomerAcceptance",
                  "triggerDate": $Today
                }
              ],
              "removeProduct": {
                "ratePlanId": $RPIdRemove
              }
            },
            {
              "type": "AddProduct",
              "triggerDates": [
                {
                  "name": "ContractEffective",
                  "triggerDate": $Tomorrow
                },
                {
                  "name": "ServiceActivation",
                  "triggerDate": $Tomorrow
                },
                {
                  "name": "CustomerAcceptance",
                  "triggerDate": $Tomorrow
                }
              ],
              "addProduct": {
                "productRatePlanId": $ProductRPId,
                "chargeOverrides": [
                  {
                    "productRatePlanChargeId": $ProductRPChargeId,
                    "pricing": {
                      "recurringVolume": {
                        "quantity": 20
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      ],
      "processingOptions": {
        "runBilling": false,
        "collectPayment": false
      }
    }
    

    To create the order under a new account instead of an existing account, specify the newAccount field instead of the existingAccountNumber field.

To preview invoices for the updated subscription, use the "Preview order" operation.