Suspend a Subscription

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

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 feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support

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:

  1. Navigate to Customers > Orders.

    The Orders page opens.

  2. Click theCreateOrderIcon.pngicon 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 owns the subscription.

  4. Click Modify Existing Subscription.

  5. In the Associated Subscriptions area, click the OptionIcon.png icon next to the subscription you selected, then click Suspend. The suspend window opens. 

    Supspend.png

  6. In the suspend window:

    1. Specify trigger dates for the operation. See Billing Trigger Dates for more information.

    2. Select the Suspend Policy for the subscription to suspend. See Suspend Date for more information.

      SuspendWindow.png

  7. Click Continue.

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

Last modified

Tags

This page has no custom tags.

Classifications

(not set)