Skip to main content

Suspend and resume a subscription with pending charges

Zuora

Suspend and resume a subscription with pending charges

  1. Last updated
  2. Save as PDF

This tutorial demonstrates how to suspend and resume a subscription with pending charges from the Zuora UI or through the REST API.

Suspend an active subscription with pending charges from the Zuora UI

To suspend an active subscription with pending charges, perform the following steps:

  1. Navigate to Customers > Subscriptions in the left navigation menu.
  2. Locate the subscription you want to suspend and click the subscription number. The subscription detail page opens.
  3. Click Create Order. The Review Order page opens.
  4. In the upper right of the Associated Subscriptions section, click More Order Actions and then click Suspend.
  5. In the dialog that appears, perform the following:
    1. In the Trigger Dates section, specify appropriate dates in the Contract effective, Service activation, and Customer acceptance fields
    2. In the Suspend On section, specify when the subscription is to be suspended.
    3. Click Continue.
  6. On the Review Order page, click Activate.

Resume a suspended subscription with pending charges from the Zuora UI

To resume a suspended subscription with pending charges, perform the following steps:

  1. Navigate to Customers > Subscriptions in the left navigation menu.
  2. Locate the subscription you want to resume and click the subscription number. The subscription detail page opens.
  3. Click Create Order. The Review Order page opens.
  4. In the upper right of the Associated Subscriptions section, click Resume.
  5. In the dialog that appears, perform the following:
    1. Specify appropriate dates in the Contract effective, Service activation, and Customer acceptance fields
    2. In the Resume Policy field, select the appropriate policy for the subscription to be resumed.
    3. Specify other required fields that depend on the selected option for the Resume Policy field.
    4. Click Continue.
  6. On the Review Order page, click Activate.

Suspend and resume a subscription with pending charges through the REST API

To suspend an active subscription with pending charges, use the Create an order operation to perform a Suspend order action. To resume a suspended subscription with pending charges, use the same operation to perform a Resume order action. See tutorials as follows:

  1. Determine the values of the following fields:
    Variable Description
    ContractEffective The date of the contract that governs the subscription. To create an active subscription with pending charges, you must specify this field.
    ServiceActivation The date on which the services or products within a subscription have been activated and access has been provided to the customer. To create an active subscription with pending charges, you must specify this field.
    CustomerAcceptance The date on which the services or products within a subscription have been accepted by the customer. To create an active subscription with pending charges, you must specify this field.
  2. Use the "Create an order" operation to suspend an active subscription with pending charges:
    Request POST /v1/orders/
    Request Body 
    {
   "orderNumber": null,
   "orderDate": "2024-08-20",
   "existingAccountNumber": "A00000001",
   "subscriptions": [
       {
           "subscriptionNumber": "A-S00000001",
           "orderActions": [
               {
                   "type": "Suspend",
                   "triggerDates": [
                       {
                           "triggerDate": "2024-08-29",
                           "name": "ContractEffective"
                       },
                       {
                           "name": "ServiceActivation",
                           "triggerDate": "2024-08-29"
                       },
                       {
                           "name": "CustomerAcceptance",
                           "triggerDate": "2024-08-29"
                       }
                   ],
                   "suspend": {
                       "suspendPolicy": "SpecificDate",
                       "suspendSpecificDate": "2024-10-20"
                   }
               }
           ]
       }
   ]
}
  3. Use the "Create an order" operation to resume a suspended subscription:
    Request POST /v1/orders/
    Request Body 
    {
   "orderNumber": null,
   "orderDate": "2024-09-20",
   "status":"Completed",
   "existingAccountNumber": "A00000001",
   "subscriptions": [
       {
           "subscriptionNumber": "A-S00000001",
           "orderActions": [
               {
                   "type": "Resume",
                   "triggerDates": [
                     {
                           "triggerDate": "2024-08-29",
                           "name": "ContractEffective"
                       },
                       {
                           "name": "ServiceActivation",
                           "triggerDate": "2024-08-29"
                       },
                       {
                           "name": "CustomerAcceptance",
                           "triggerDate": "2024-08-29"
                       }
                   ],
                   "resume":{
                       "resumePolicy":"SpecificDate",
                       "resumeSpecificDate":"2024-11-20"
                   }
               }
           ]
       }
   ]
}