Zuora Documentation

Re: API Changelog

2018-05-23

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • In the Zuora Object Model section, added links to the Advanced AR Settlement object model and the Orders object model.
  • Made the following updates to the request body of “Preview subscription” and “Create subscription” operations:
    • Corrected the subscribeToRatePlans > chargeOverrides > quantity field from required to optional, and clarified in the description that this field is not required for the flat fee pricing charge model.
  • Made the following updates to the “Create subscription” operation:
    • Removed the minor version controlled fields collect, targetDate, and runBilling from the request sample.
    • Corrected the value of the subscribeToRatePlans > chargeOverrides > triggerEvent field from SpecificDate to USD in the request sample.

 

2018-05-17

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 225, May 2018.

 

  • Orders - Made the following updates:
    • Added support for the usage charge type in the orders > subscriptions > orderActions > orderItems field in the response body of the following operations:
      • Get orders by invoice owner
      • Get all orders
      • Get orders by subscription owner
      • Get orders by subscription number
    • Added support for the usage charge type in the order > subscriptions > orderActions > orderItems field in the response body of the “Get an order” operation.
    • Added support for the usage charge type in the previewResult > orderMetrics > orderActions > orderItems field in the response body of the “Preview order” operation.

The following items are API updates specific to the change in the behavior of the memo item amount in some REST API operations. For tax-inclusive memo items, the amount indicates the memo item amount including tax. For tax-exclusive memo items, the amount indicates the memo item amount excluding tax.

 

  • Credit Memos - Made the following updates:

    • Added the amountWithoutTax field to the response body of the following operations:
      • Get credit memo items: in the items field
      • Get credit memo item
    • Changed the name of the charges > memoItemAmount field to charges > amount in the request body of the “Create credit memo from charge” operation.
    • Changed the behavior of the items > amount field in the request body of the “Update credit memo” operation.
    • Changed the behavior of the amount field in the response body of the following operations:
      • Get credit memo items: in the items field
      • Get credit memo item
  • Debit Memos - Made the following updates:

    • Added the amountWithoutTax field to the response body of the following operations:
      • Get debit memo items: in the items field
      • Get debit memo item
    • Changed the name of the charges > memoItemAmount field to charges > amount in the request body of the “Create debit memo from charge” operation.
    • Changed the behavior of the items > amount field in the request body of the “Update credit memo” operation.
    • Changed the behavior of the amount field in the response body of the following operations:
      • Get debit memo items: in the items field
      • Get debit memo item
  • Operations - Made the following updates in the response body of the “Create billing preview” operation:

    • Added the nested amountWithoutTax field to the creditMemoItems field.
    • Changed the behavior of the creditMemoItems > amount field.
  • Subscriptions - Made the following updates in the response body of the “Preview subscription” operation:

    • Added the nested amountWithoutTax field to the creditMemo > creditMemoItems field.
    • Changed the behavior of the creditMemo > creditMemoItems > chargeAmount field.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Specified that the response bodies of the “Describe object” operation have type string. Previously, no type was specified for the response bodies of the “Describe object” operation.

  • In the source YAML file, added the missing operationId property to the following operations:

    • Write off invoice
    • Get invoice files
    • Get invoice items