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 API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 231, August 2018.


  • Catalog - Added a new operation called “Get product”.
  • Credit Memos - Added a new operation called “Unpost credit memo”.
  • Debit Memos - Added a new operation called “Unpost debit memo”.


Doc Updates


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


  • In the request body of the “Update order action trigger dates” operation, made the following updates:

    • Corrected the subscriptions > subscriptionNumber field from optional to required.
    • Corrected the subscriptions > orderActions > sequence field from optional to required and clarified the description of the field.
  • In the description of the processPayment request field of the “Create Apple Pay payment method” operation, clarified that if you set this field to true, you must specify the paymentGateway request field with the gateway instance name.

  • In the following operations, added /v1 to examples in the fieldsFilterable and sort query parameters.

    • Get credit memos
    • Get credit memo items
    • Get debit memos
    • Get debit memo items