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!

 

2018-07-18

 

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 229, July 2018.

 

  • Accounts - Added the following new operations:

    • Create job to hard delete billing document files
    • Get job of hard deleting billing document files
  • Catalog - In the “Multi-entity: Share a Product with an Entity” operation, made the following updates:

    • Changed the HTTP method from “PUT” to “POST” in order to eliminate misunderstanding.
    • In the source file, changed the value of the operationId field from PUT_Catalog to POST_Catalog, and renamed the PUTCatalogType reference object to POSTCatalogType.
  • Credit Memos - The “Create credit memo PDF” operation now depends on the Billing user permission “Regenerate PDF”. The operation description explains more details.

  • Debit Memos - The “Create debit memo PDF” operation now depends on the Billing user permission “Regenerate PDF”. The operation description explains more details.

 

Doc Updates

 

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

 

  • In the “Amend” action, made the following updates:

    • Updated the description of the action to clarify the order in which Zuora modifies the subscription.
    • Improved the JSON request sample.
  • Removed the “CRUD: Create amendment” operation. This operation has significant limitations and Zuora recommends that you use the “Update subscription” operation or the “Amend” action instead.

  • In the response body of the following operations, corrected the format of the order > createdDate and order > updatedDate fields to datetime:

    • Get an order
    • Get order metrics for evergreen subscription
  • In the response body of the following operations, corrected the format of the orders > createdDate and orders > updatedDate fields to datetime:

    • Get all orders
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner