Skip to main content

Replace a Product in a Subscription

Zuora

Replace a Product in a Subscription

The migration to full Orders is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available.

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 the Create New Order icon CreateOrderIcon.png 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 Search by Account Name or Specify complete Account Number.

    • If you click Search by 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 Specify complete Account Number, type the exact account number.
  4. Click Modify 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 Subscriptions details area, locate the product to be removed, click the menu icon  menu-icon.png  next to the product name, and then click Remove Product. The Remove rate plan charge window opens.

      remove-product.png

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

    3. Click Continue. The window is closed.

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

    1. In the Associated Subscriptions area, click the menu icon menu-icon.png in front of the subscription, and then click Add Product.

    2. In the Order Overview area, select appropriate dates in the Contract effectiveService activation, and Customer acceptance fields for the operation.

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

      products-and-charges.png

    4. To display the product rate plans, click the right arrow ( > ) next to the product, and then click Add to select a rate plan.

    5. Click Continue. An order overview is displayed.

  9. Click Activate to activate the order.

Use the REST API

You can use the "Create and activate order" operation to replace a product in a subscription.

Prior to the Orders feature being enabled, you would have used 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 and activate 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.

SOAP Migration Guidance

When the Orders feature is enabled in your Zuora tenant, the SOAP API is not available. You must migrate any SOAP integrations to use the REST API instead. See Migrating From the SOAP API for the SOAP equivalent of this tutorial.