Welcome to Zuora Product Documentation

Explore our rich library of product information

Amendments: Cancel

The cancel task cancels an active subscription. The task provides two groups of options based on the set of Zuora APIs being used (SOAP or REST).

For details about canceling a subscription, see Cancellations. To learn more about specific data fields, see Amendment object for SOAP and API Reference for REST.

If Invoice Settlement is enabled, this task can support to generate credit memos and apply outstanding credit memos and unapplied payments.

Note:

Zuora recommends not using the Cancel Task in a workflow if your tenant has the Orders feature enabled. The Cancel Task only works when your tenant is on the Subscription model.

For example, While creating a Cancel Task, you fill in the subscription information, date type of information etc. and it would generate an API call to cancel a subscription. In cases where “Orders” is enabled, the Cancel Task will fail with the message "Order Date is required" while there is no option to enter an Order Date.

If the Orders feature is enabled in your tenant, use a callout with a PUT method. See Notifications: Callout for more information.