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-10-10
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 258, October 2019.
Custom Object Definitions - Added a resource called "Custom Object Definitions", with the following operations :
Get all namespaces
Get namespace
Get all custom object definitions in namespace
Create custom object definition
Get custom object definition
Delete custom object definition
Update custom object definition
Custom Object Records - Added a resource called "Custom Object Records", with the following operations :
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
Settings - Added a resource called "Settings", with the following operations :
List all settings
Submit multiple settings requests as a batch
Data Queries - In the request body of the "Submit data query" operation, changed the JSON value of the outputFormat field to JSONL .
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
In the request body of the "Preview order" operation, added descriptions for the subscriptions > orderActions > updateProduct > chargeUpdates field.
In the request body of the "Amend" action, updated the description of the requests > Amendments > Type field.
In the request body of the "Subscribe" action, updated the description of the subscribes > Account > DefaultPaymentMethodId field.
In the "Create order" operation, added the missing query parameter returnIds and the following missing response fields:
orderId
accountId
subscriptionIds
subscriptions > subscriptionId
invoiceIds
creditMemoIds
paymentId
In the following operations, corrected the data type to number for all fields that previously had the string <decimal> data type.
Preview subscription
Create subscription
Get subscriptions by account
Update subscription
Get subscriptions by key
Get subscriptions by key and version
Renew subscription
Cancel subscription
Resume subscription
Suspend subscription
In the "Create revenue schedule on subscription charge" operation, updated the description to clarify that a maximum of 3,000 revenue schedules can be created for one subscription charge.
In the "Get custom foreign currency exchange rates" operation, updated the request sample and the response sample.
In the description of the "Generate an OAuth token" operation, added more details about the rate limit of the operation.
In the Introduction section, added links to Zuora Collect API Reference and RevPro API Reference.
Added a section called Usage (With Active Rating), containing the following operations. Previously, these operations were documented on a separate page.
Create usage records
Update usage record
Get usage record
Delete usage record
Query usage records
Query usage records in stream
Import usage file
Get usage imports
Get details of usage import
Get status of usage import
Download usage import file
Download usage import failure file
Download usage file template
Get rating results by account
Get rating results by subscription
Get rating results by charge
Get rated usage by account
Get rated usage by subscription
Get rated usage by charge
Get Usage custom field definition
Set schema of Usage custom field definition
Delete schema of Usage custom field definition
... View more