Renew a Subscription

Knowledge Center > Subscriptions > Orders > Orders Tutorials > Renew a Subscription

Renew a Subscription

This feature is only available if you have the Orders feature enabled. We are actively soliciting feedback from a small set of early adopters. If you wish to have access to the feature, 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 the CreateOrderIcon.png icon at the top right:

    Orders_Create_Button_Location.png

    The Create New Order page opens.

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

  4. Click Modify Existing Subscription.

  5. In the Select an Existing Subscription area, search for the subscription you are to renew, then click Select to select the subscription.

    SelectExistingSubscription.png

  6. In the Associated Subscriptions area, click the OptionIcon.png icon to display the operation options you can perform on the selected subscription, then click Renew Subscription.

    SubscriptionOperations.png

    The Renew Subscription page opens.

  7. Specify Contract Effective DateService Activation Date, and Customer Acceptance Date for the operation. See Billing Trigger Dates for more information. 

  8. Click Continue.

    Zuora displays an overview of the order.

  9. Click Activate to activate the order.

Use the REST API

You can use the "Create and activate order" operation to renew a subscription.

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

Last modified

Tags

This page has no custom tags.

Classifications

(not set)