Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

 

2019-07-11

 

API Updates

 

This section lists operations and fields that were added, changed, or removed.

The following API updates are available as of Zuora Release 250, July 2019.

 

  • Invoices - In the request body of the "CRUD: Update invoice" operation, changed the behavior of the RegenerateInvoicePDF field by adding a limit that you can use this field to regenerate PDF files for the same invoice for at most 100 times.

 

Doc Updates

 

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

 

  • In the request body of the "CRUD: Update invoice" operation, added the missing RegenerateInvoicePDF field.

  • In the description of the "Create authorization" operation, made the following updates:

    • Clarified the subsequent operations as part of the Delayed Capture feature.
    • Added a known limitation of the Delayed Capture feature.
  • In the description of the "CRUD: Create payment" operation, clarified that this operation cannot work if the Invoice Settlement feature is enabled.

  • In the request body of the "CRUD: Create payment method" operation, removed the MitProfileAgreedOn field. The details of this field are moved to the PaymentMethod article in Zuora's Knowledge Center.

  • In the request body of the "Amend" action, updated the description of the requests > Amendments > ServiceActivationDate field to add more information about how to use this field.

  • In the request body of the "CRUD: Update amendment" operation, updated the description of the ServiceActivationDate field to add more information about how to use this field.

  • In the response body of the "CRUD: Get amendment" operation, updated the description of the ServiceActivationDate field to add more information about how to use this field.

  • Corrected the endpoints of the following asynchronous Orders operations:

    • Preview order asynchronously
    • Create order asynchronously
    • Get job status and response