Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.


For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!




API Updates


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


  • Subscriptions - In the following operations, added the documentDate field to the request body:

    • creditMemo > creditMemoItems
    • invoicceItems
  • Product Rate Plans - In the response body of the “Get product rate plans” operation, added the following nested fields to the productRatePlans > productRatePlanCharges > financeInformation field:

    • revRecCode
    • revRecTriggerCondition
  • Catalog - Made the following updates:

    • In the response body of the “Get catalog” operation, changed the behavior of the products > productRatePlans field.
    • In the response body of the “Get product” operation, changed the behavior of the productRatePlans field.

    This behavior change is available only when you set the zuora-versionrequest header to 230.0 or later. See the descriptions of the productRatePlans fields to find out details about the latest behavior.


Doc Updates


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


  • In the request body of the “Create debit memo from charge” operation, added the following missing fields to the charges field:

    • serviceStartDate
    • serviceEndDate
  • In the “Preview order” operation, added the missing description for the previewOptions > previewTypes field in the request body.

  • In the “Create order” operation, corrected a possible value of the subscriptions > orderActions > type field in the request body.

    Previously, the value Suspend was incorrectly listed as Subspend.