Welcome to Zuora Product Documentation

Explore our rich library of product information

Cancel a draft order using the REST API

Learn how to cancel a draft order using the REST API by determining necessary variables and executing the cancel operation.

  1. Determine the value of the following variables:

    Variable

    Description

    $OrderNumber

    The order number of the order to cancel. For example, O-00000003 .

    $CancelReason

    The reason to cancel the draft order, for example, test cancel.

  2. Use the Cancel an order operation to cancel the order that is in the Draft status:

Request

PUT/v1/orders/{orderNumber}/cancel

Request Body

{
   "cancelReason": "$CancelReason"
}