Skip to main content

View the Details of an Order

Zuora

View the Details of an Order

Orders is now generally available as of Zuora Billing Release 284 (August 2019). You can access all the new capabilities in the Sandbox environment starting August 31, 2020. The Production deployment is September 10, 2020.

If you are an existing Zuora Subscribe and Amend customer and want to adopt Orders, see What is Orders Harmonization and join the Orders Harmonization community group for more information. If you want to enable Orders, submit a request at Zuora Global Support.

Use the Zuora application

To view an order in the Zuora application, complete the following steps:

  1. Navigate to Customers > Orders. The Orders page opens and lists the orders in your tenant. 

  2. To quickly search for an order, use the following techniques:

    • Specify a time range for the order creation date to filter the displayed orders. To do this, click the Search orders icon  at the top right and then specify the dates in the displayed filter. 

      search-order-filter.png

    • Search the order by using the account number, order number, or subscription number. To do this, click the down arrow to select which number to search for and then type the number in the search field. The result will dynamically change as you type.

      search-order.png

      If you want to search for an order by using the subscription number, you must enter the complete subscription number to get the result.

  3. To view the summary of an order, click the right arrow ( > ) next to the order number.

  4. To view the details of an order, click the order number in blue. The Order details page is displayed including the information about order metrics, associated subscriptions, and included products, order actions, and terms for each subscription.

    When you are viewing a Suspend or Resume order action, some fields are not applicable if the order action is auto-created by the Order Metrics migration, such as Resume Policy and Suspend Policy. For more information, see the suspend or resume order action in the "Get an order" operation.

Use the REST API

You can use the "Get an order" operation to view an order.

To view an order:

  1. Determine the value of the following variable:

    Variable Description
    $OrderNumber The order number of the order to view. For example, O-00000003.
  2. Use the "Get an order" operation to view an order of a specific order number:

    Request GET /v1/orders/{$OrderNumber}