Skip to main content

Suspend a Subscription

Zuora

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

Use the Zuora application

To suspend a subscription, complete the following steps:

  1. Navigate to Customers > Orders. The Orders page opens.

  2. Click the Create New Order iconCreateOrderIcon.pngat 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 Associated subscriptions area, click the menu icon in front of the subscription to display the operations you can perform, and then click Suspend.

    suspend-subscription.png

  8. In the Suspend Subscription window, complete the following steps:

    1. Specify trigger dates for the operation. For more information, see Billing Trigger Dates.

    2. In the Suspend Policy field, select the appropriate policy for the subscription to suspend. For more information, see Suspend Date.

    3. Click Continue.

  9. Click Activate to activate the order.

Use the REST API

You can use the "Create order" operation to suspend a subscription.

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