Skip to main content

Cancel an active subscription with pending charges

Zuora

Cancel an active subscription with pending charges

  1. Last updated
  2. Save as PDF

This tutorial demonstrates how to cancel an active subscription with pending charges from the Zuora UI or through the REST API.

Note that if the charge is not active before the cancellation, the charge will be shrunk to the duration of the estimated start date. The effective start date and end date are still blank.

Cancel an active subscription with pending charges from the Zuora UI

To cancel 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 cancel 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 Cancel Subscription.
  5. In the dialog that appears, perform the following:
    1. Specify appropriate dates in the Contract effective, Service activation, and Customer acceptance fields
    2. Select the cancellation effective date from the Cancellation Policy field.
    3. If Specific Date is selected for Cancellation Policy, enter a date in the Cancellation effective field.
    4. Click Continue.
  6. On the Review Order page, click Activate.

Cancel an active subscription with pending charges through the REST API

To cancel an active subscription with pending charges, use the Create an order operation to perform a Cancel Subscription order action 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 cancel an active subscription:
    Request POST /v1/orders/
    Request Body 
    {
   "orderNumber": null,
   "orderDate": "2024-03-01",
   "existingAccountNumber": "A00000001",
   "subscriptions": [
       {
           "subscriptionNumber": "A-S00000016",
           "orderActions": [
               {
                   "type": "CancelSubscription",
                   "triggerDates": [
                       {
                           "triggerDate": "2024-08-29",
                           "name": "ContractEffective"
                       },
                       {
                           "name": "ServiceActivation",
                           "triggerDate": "2024-08-29"
                       },
                       {
                           "name": "CustomerAcceptance",
                           "triggerDate": "2024-08-29"
                       }
                   ],
                   "cancelSubscription": {
                       "cancellationPolicy": "SpecificDate",
                       "cancellationEffectiveDate": "2024-03-01"
                   }
               }
           ]
       }
   ]
}