Skip to main content

Cancel a Subscription


Cancel 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 cancel 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 cancellation
  • The service activation date of the cancellation
  • The customer acceptance date of the cancellation
  • The effective date of the cancellation policy

Use the Zuora Application

To cancel a subscription by creating an order in the Zuora application:

  1. Navigate to Customers > Orders.

    The Orders page opens.

  2. Click the CreateOrderIcon.png icon 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.

  4. Click Modify Existing Subscription.

  5. In the Select an Existing Subscription area, search for the subscription you are to cancel, then click Select to select a subscription.


  6. In the Associated Subscriptions area, click the OptionIcon.png icon to display the operation options you can perform on the selected subscription, then click Cancel Subscription.


    The Cancel Subscription page opens.

  7. Specify Contract Effective Date, Service Activation Date, and Customer Acceptance Date for the cancellation operation. Contract Effective Date is the date the customer provided notice of cancellation. See Billing Trigger Dates for more information.


  8. Select Cancellation Policy - the cancellation effective date from the list: End of Current Term, End of Last Invoice Period, or Specific Date. See Cancellation Effective Dates.

  9. Click Continue.

    Zuora displays an overview of the order.

  10. Click Activate to activate the order.

Use the REST API

You can use the "Create and activate order" operation to cancel a subscription.

Prior to the Orders feature being enabled, you would have used the "Cancel subscription", "Amend", or "CRUD: Create amendment" operation.

To cancel 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, 2017-09-30.
  2. Use the "Create and activate order" operation to create an order under an existing account:

    Request POST /v1/orders/
    Request Body
      "orderDate": "$Today",
      "existingAccountNumber": "$AccountNum",
      "subscriptions": [
          "subscriptionNumber": "$SubscriptionNum",
          "orderActions": [
              "type": "CancelSubscription",
              "triggerDates": [
                  "name": "ContractEffective",
                  "triggerDate": "$Today"
                  "name": "ServiceActivation",
                  "triggerDate": "$Today"
                  "name": "CustomerAcceptance",
                  "triggerDate": "$Today"
              "cancelSubscription": {
                "cancellationPolicy": "SpecificDate",
                "cancellationEffectiveDate": "$Today"
      "processingOptions": {
        "runBilling": false,
        "collectPayment": false

    To create the order under a new account instead of an existing account, specify the newAccount field instead of the existingAccountNumber field.

To preview invoices for the updated subscription, use the "Preview order" operation.

SOAP Migration Guidance

When the Orders feature is enabled in your Zuora tenant, the SOAP API is not available. You must migrate any SOAP integrations to use the REST API instead. See Migrating From the SOAP API for the SOAP equivalent of this tutorial.