Skip to main content

Resume a subscription

Zuora

Resume 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 resume 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 transfer
  • The service activation date of the transfer
  • The customer acceptance date of the transfer

Use the Zuora application

To suspend 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 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-suspended-sub-2020.png

  7. In the Associated subscriptions area, the operations that you can perform on the selected subscription are listed to the right of the subscription number. Click More Order Actions to expand the list and then click Resume. The Resume Subscription window is displayed.

    resume-subscription-2020.png

  8. In the Trigger Dates section, specify the trigger dates for the operation. For more information, see Billing Trigger Dates.

  9. In the Resume Policy field, select the appropriate policy for the subscription to be resumed. For more information, see Resume Date.

  10. (Optional): To extend the subscription term by the length of time the suspension is in effect, select the Extend the current term by the number of days suspended checkbox. 

  11. Click Continue. The Resume Subscription window is closed.

  12. Click Activate to activate the order.

Use the REST API

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

To suspend 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, 2019-01-01.
  2. Use the "Create order" operation to resume a subscription:

    Request POST /v1/orders/
    Request Body
    {
      "orderDate": "$Today",
      "existingAccountNumber": "AccountNum",
      "subscriptions": [
        {
          "subscriptionNumber": "$SubscriptionNum",
          "orderActions": [
            {
              "type": "Resume",
              "triggerDates": [
                {
                  "name": "ContractEffective",
                  "triggerDate": "$Today"
                },
                {
                  "name": "ServiceActivation",
                  "triggerDate": "$Today"
                },
                {
                  "name": "CustomerAcceptance",
                  "triggerDate": "$Today"
                }
              ],
              "resume": {
                "resumePolicy": "FixedPeriodsFromSuspendDate",
                "resumePeriods": 2,
                "resumePeriodsType": "Month",
                "extendsTerm": true
              }
            }
          ]
        }
      ],
      "processingOptions": {
        "runBilling": false,
        "collectPayment": false
      }
    } 
    

To preview invoices for a subscription to resume, use the "Preview order" operation.