Skip to main content

Remove a Product from a Subscription

Zuora

Remove a Product from 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 remove a product from a subscription by creating an order.

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

Use the Zuora application

To remove a product from a subscription:

  1. Navigate to Customers > Orders.

  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. In the Subscriptions details area, click the menu icon in front of the product to be removed, and then click Remove Product. The Remove product window opens.

    remove-product.png

  8. In the Remove product window, specify appropriate dates in the Contract effectiveService activation, and Customer acceptance fields for the operation. For more information, see Billing Trigger Dates.

  9. Click Continue. An order overview is displayed.

  10. Click Activate to activate the order.

Use the REST API

You can use the "Create and activate order" operation to remove a product from a subscription.

Prior to the Orders feature being enabled, you would have used the "Update subscription", "Amend", or "CRUD: Create amendment" operation.

To remove a product from 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.
    $RPId The ID of the rate plan to remove from the subscription. For example, 402892c42ce80787012ce80ea2310019.
    $Today Today's date. For example, 2017-09-30.
  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": "$RPId"
              }
            }
          ]
        }
      ],
      "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.