Skip to main content

Suspend subscriptions


Suspend subscriptions

This tutorial demonstrates how to suspend 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 suspension
  • The service activation date of the suspension
  • The customer acceptance date of the suspension

Use the Zuora UI

To suspend a subscription, complete the following steps:

  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 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. 

  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 Suspend. The Suspend subscription window is displayed.


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

  9. In the Suspend On section, specify when the subscription is to be suspended. For more information, see Suspend Date.

  10. (Optional): In the Additional Information section, specify the order field values as necessary. For example, enter the reason for suspending the subscription in the Change Reason field.

  11. For the suspended subscription to be automatically resumed later, toggle the Auto Resume Enabled switch to display the area for you to specify the resume information. 

    • In the Resume On section, specify when the subscription is to be resumed. For more information, see Resume Date.

    • 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 in the Additional Information section. Optionally, enter the reason for resuming the subscription in the Change Reason field.

  12. Click Continue. The Suspend subscription window is closed.

  13. Click Activate to activate the order.

Use the REST API

You can use the "Create order" operation to suspend a subscription. Before the Orders feature is enabled, you have to use the "Suspend 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 suspend a subscription:

    Request POST /v1/orders/
    Request Body
      "orderDate": "$Today",
      "existingAccountNumber": "AccountNum",
      "subscriptions": [
          "subscriptionNumber": "$SubscriptionNum",
          "orderActions": [
              "type": "Suspend",
              "triggerDates": [
                  "name": "ContractEffective",
                  "triggerDate": "$Today"
                  "name": "ServiceActivation",
                  "triggerDate": "$Today"
                  "name": "CustomerAcceptance",
                  "triggerDate": "$Today"
              "suspend": {
                "suspendPolicy": "FixedPeriodsFromToday",
                "suspendPeriods": 2,
                "suspendPeriodsType": "Month"
      "processingOptions": {
        "runBilling": false,
        "collectPayment": false

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