Skip to main content

Revert orders

Zuora

Revert orders

  1. Last updated
  2. Save as PDF

Revert is an order action to offsite a previous order. You can revert orders for single version subscriptions after turning on the Single Version Subscription feature. 

If you revert an order through the Revert an order API operation, specify an order date.

For example, if you revert an order (O-00000637) and this order includes an Update Product order action of updating the product price from $10 to $20, after reversion, a revert order (O-00000638) is automatically created including another Update Product order action of updating the price back to $10. See the reverted order O-00000637 and revert order O-00000638 in View details of single version subscriptions.

Only subscriptions created through orders can be single version subscriptions. The Single Version Subscription feature is in the Early Adopter phase. We are actively soliciting feedback from a small group of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.

Prerequisites 

Before reverting an order, you need to note the following:

  • You can only revert an order containing one single version subscription; An order cannot be reverted in any of the following situations:
    • An order contains multiple single version subscriptions.
    • An order contains order line items, no matter whether the order also contains subscriptions.
  • You can revert an order only when the order and subscription are in the following statuses, and a Revert Order (See example in Change History) cannot be reverted. 
    • Order status is Completed
    • Subscription is in one of the following statuses:
      • Active
      • Suspended
      • Cancelled
  • You cannot cancel or delete a reverted order. 
  • You cannot revert an order that includes the Create Subscription order action.
  • You cannot revert an order with a prepayment or drawdown charge.

Revert an order using the Zuora UI

To revert orders, complete the following steps:

  1. Navigate to Customers > Orders. The Orders page opens.
  2. Search or filter a revertable order. Revertable orders are indicated by the Revert icon. 
  3. Click the order number to open the order details page. 
  4. Click Revert on the top right. 
  5. Read the warning message, and click Revert Order to revert the order. 

After the order is reverted, 

  • The Reverted status appears next to the order number. 
  • If you click the subscription number in the Associated Subscriptions section to open the subscription details page, you can view the record of this Revert Order order action displayed in Change History, see Change History. You can also retrieve the change history of single version subscriptions through API.

Revert an order using the REST API 

  1. Determine the values of the following variables:

Variable

Description

$OrderNumber

The order number of the order to revert. For example, O-00000003.
$OrderDate The order date when order is booked in YYYY-MM-DD format.
  1. Use the Revert an order operation to revert the order that is in the completed status:

Request

PUT/v1/orders/{orderNumber}/revert
Request Body

{

"orderDate": "2000-01-23"

}

The status of the order in the response of this operation is still Completed. However, if you retrieve the order through the following order operations, the status is Reverted.

  • Retrieve an order
  • List orders
  • List orders of a subscription owner
  • List orders by subscription number
  • List orders of an invoice owner
  • List pending orders by subscription number