Cancel a subscription

This REST API reference describes how to cancel an active subscription.

Note: If you have the Invoice Settlement feature enabled, it is best practice to set the zuora-version parameter to 211.0 or later available versions. Otherwise, an error occurs.

Request
path Parameters
subscription-key
required
string

Subscription number or ID. Subscription status must be Active.

header Parameters
Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

zuora-version
string

The minor API version. For a list of available minor versions, see API upgrades.

Request Body schema: application/json
required
applicationOrder
Array of strings

The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: CreditMemo, UnappliedPayment.

Note:

  • This field is valid only if the applyCredit field is set to true.
  • If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
  • If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is ["CreditMemo"], only credit memos are used to apply to invoices.
applyCredit
boolean

If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.

Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

applyCreditBalance
boolean

Whether to automatically apply a credit balance to an invoice.

If the value is true, the credit balance is applied to the invoice. If the value is false, no action is taken.

To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.

Prerequisite: invoice must be true.

Note:

  • If you are using the field invoiceCollect rather than the field invoice, the invoiceCollect value must be true.
  • This field is deprecated if you have the Invoice Settlement feature enabled.
bookingDate
string <date>

The booking date that you want to set for the amendment contract when you cancel the subscription. The default value is the current date when you make the API call.

cancellationEffectiveDate
string <date>

Date the cancellation takes effect, in the format yyyy-mm-dd. Use only if cancellationPolicy is SpecificDate. Should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced.

cancellationPolicy
required
string

Cancellation method. Possible values are: EndOfCurrentTerm, EndOfLastInvoicePeriod, SpecificDate. If using SpecificDate, the cancellationEffectiveDate field is required.

collect
boolean
Default: false

Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.

If the value is true, the automatic payment is collected. If the value is false, no action is taken.

Prerequisite: The invoice or runBilling field must be true.

Note: This field is available only if you are on the latest Zuora API version, or you set the zuora-version request header to 196.0 or a later available version.

contractEffectiveDate
string <date>

The date when the customer notifies you that they want to cancel their subscription.

creditMemoReasonCode
string

A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.

documentDate
string <date>

The date of the billing document, in yyyy-mm-dd format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.

  • If this field is specified, the specified date is used as the billing document date.
  • If this field is not specified, the date specified in the targetDate is used as the billing document date.
orderDate
string <date>

The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date. This field must be in the yyyy-mm-dd format. This field is required for Orders customers only, not applicable to Orders Harmonization customers.

runBilling
boolean
Default: false

Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the invoice and credit memo generation rule.

The billing documents generated in this operation is only for this subscription, not for the entire customer account.

Possible values:

  • true: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.

  • false: No invoice is created.

Note: This field is available only if you are on the latest Zuora API version, or you set the zuora-version request header to 211.0 or a later available version.

targetDate
string <date>

Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date. Note:

  • This field is available only if you are on the latest Zuora API version, or you set the zuora-version request header to 211.0 or a later available version.
  • The credit memo is only available if you have the Invoice Settlement feature enabled.
Responses
200
500

Internal Server Error

4XX

Request Errors

put/v1/subscriptions/{subscription-key}/cancel
Request samples
application/json
{
  • "cancellationPolicy": "EndOfCurrentTerm"
}
Response samples
application/json
{
  • "cancelledDate": "2019-05-31",
  • "invoiceId": "8a8082c453cd2a620153e426c7eb78b3",
  • "subscriptionId": "8a8082c453cd2a620154efc7bba0350e",
  • "success": true,
  • "totalDeltaMrr": 0,
  • "totalDeltaTcv": -703.2258065
}