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 230, August 2018.


  • Notifications - Removed the “Get callout options” and “Update callout options” operations. Previously, these operations caused inconsistency between API and UI. Hence, we have disabled these operations to avoid confusion.

  • Payment Runs - Made the following updates:

    • In the following operations, added the collectPayment field to the request body:
      • Create payment run
      • Update payment run
    • In the following operations, added the collectPayment field to the response body:
      • Create payment run
      • Update payment run
      • Ger payment run
    • In the “Get payment runs” operation, added the collectPayment nested field to the paymentRuns field in the response body.
  • Catalog - In the “Get product catalog” operation, made the following updates:

    • Added the zuora-version parameter to header parameters.
    • In the response body, updated the description of the productRatePlans field by adding version control information.


Doc Updates


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


  • Corrected the URL paths of the following operations:

    • CRUD: Get amendment
    • CRUD: Update amendment
    • CRUD: Delete amendment

    The URL paths of the operations were documented as /v1/object/amendmexnt/{id} in versions 2018-07-18 and 2018-07-30 of the API Reference.

  • In the “Get payment runs” operation, added /v1 to examples in the fieldsFilterable and sort query parameters.

  • In the “Create order” operation, corrected the names of the following request body fields:

    • processingOptions > electronicPaymentOptions
    • processingOptions > electronicPaymentOptions > paymentMethodId

    Previously, the field names were documented as ElectronicPaymentOptions and PaymentMethodId.