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!  

 

2020-04-08

 

API Updates

 

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

 

The following API updates are available as of Zuora Billing Release 273, April 2020.

 

  • Custom Object Definitions - Made the following updates:

    • In the request and response bodies of the “Update custom object definition” operation, added the actions > field > required field.
    • In the response body of the “Get all custom object definitions” operation, added the definitions > property name * > schema > filterable field.
    • In the request body of the “Create custom object definition” operation, added the filterable field.
    • In the response bodies of the “Create custom object definition” and “Get custom object definition” operations, added the schema > filterable field.
    • In the following operations, added the Zuora-Version request header parameter :
      • Get all custom object definitions
      • Create custom object definition
      • Get custom object definition
      • Delete custom object definition
      • Update custom object definition
  • Custom Object Records - Made the following updates:

    • In the “Query custom object records” operation, added the following query parameters:
      • pageSize
      • cursor
    • In the following operations, added the Zuora-Version request header parameter :
      • Create custom object records
      • Query custom object records
      • Get custom object record
      • Update custom object record
      • Update individual fields in a custom object record
      • Delete custom object record
      • Update or delete custom object records as a batch
  • Invoices - In the request body of the “Update invoice” operation, added the invoiceDate field.

 

Doc Updates

 

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

 

  • Updated the limitations in the description of the “Update custom object definition” operation.

  • In the “Custom Object Definitions” and “Custom Object Records” sections, replaced all the “In Development” notes with the “Early Adopter” notes.

  • In the request body of the “Amend” action, added the missing descriptions for the following fields:

    • requests > AmendOptions > GenerateInvoice
    • requests > AmendOptions > ProcessPayments
  • In the request body of the “CRUD: Update amendment” operation, updated the descriptions for the following fields:

    • AutoRenew
    • CurrentTermPeriodType
    • Description
    • Name
    • SubscriptionId
    • TermType
    • Type
  • In the description of the “Create an event trigger” operation, removed a note about the edition of the Zuora Central Platform.