Skip to main content

Renew a Subscription

Zuora

Renew 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 renew a 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 renewal
  • The service activation date of the renewal
  • The customer acceptance date of the renewal

Use the Zuora application

To renew a subscription by creating an order in the Zuora application:

  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. By default, the account that owns the order will also own 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 complete 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. In the Associated subscriptions area, click Renew Subscription, which is displayed to the right of the subscription number.

    renew-subscription.png

    The Renew Subscription option is not available for an evergreen subscription or if the renewal term is set to 0. 

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

  9. Click Continue to close the window and review the order. 

  10. Click Activate to activate the order.

Use the REST API

You can use the "Create order" operation to renew a subscription. Before the Orders feature is enabled, you have to use the "Renew subscription" operation.

To renew 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.
    $Today Today's date. For example, 2017-09-30.
  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": "RenewSubscription",
              "triggerDates": [
                {
                  "name": "ContractEffective",
                  "triggerDate": "$Today"
                },
                {
                  "name": "ServiceActivation",
                  "triggerDate": "$Today"
                },
                {
                  "name": "CustomerAcceptance",
                  "triggerDate": "$Today"
                }
              ]
            }
          ]
        }
      ],
      "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.