- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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-02-13
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 268, February 2020.
-
Subscriptions - Added a new operation called "Update subscription custom fields of a specified subscription version".
-
Orders - Made the following updates:
-
In the request body of the following operations, added the
description
field:- Preview order
- Preview order asynchronously
- Create order
- Create order asynchronously
-
In the response body of the following operations, added the
description
field to theorders
field:- Get all orders
- Get orders by subscription owner
- Get orders by subscription number
- Get orders by invoice owner
-
In the response body of the following operations, added the
description
field to theorder
field:- Get an order
- Get order metrics for evergreen subscription
-
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the description of the "CRUD: Delete account" operation, added a note about deleting an account when the Orders feature is enabled.
-
Removed the operations specific to the Active Rating feature.
-
Removed the links to Active Rating from all related operations.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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-02-19
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
-
In the request body of the "Create payment method" operation, added the missing
checkDuplicated
field.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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-02-27
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: Create payment method" operation, removed the following unsupported enum values from the
Type
field.Cash
Check
ApplePay
WireTransfer
Other
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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-03-05
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 270, March 2020.
-
Accounts - Added the
paymentMethod
field to the request body of the "Create account" operation. -
Payment Methods - In the "Create payment method" operation, made the following updates:
- Added the following fields to the request body:
IBAN
businessIdentificationCode
accountNumber
identityNumber
bankCode
branchCode
- Added the following enum values to the
type
field:SEPA
Betalingsservice
Autogiro
Bacs
- Updated the description of the operation based on the preceding field changes.
- Added the following fields to the request body:
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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-03-12
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 271, March 2020.
-
Custom Object Records - Added the
ids
query parameter to the "Query custom object records" operation. -
Orders - Made the following updates:
-
In the request bodies of the "Create order" and "Create order asynchronously" operations, added the
paymentMethod
nested field to the following fields:newAccount
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
-
In the request bodies of the following operations, added the
paymentMethod
nested field to thesubscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
field:- Preview order
- Preview order asynchronously
-
In the response bodies of the following operations, added the
paymentMethod
nested field to theorder
>subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
field:- Get an order
- Get order metrics for evergreen subscription
-
In the response bodies of the following operations, added the
paymentMethod
nested field to theorders
>subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
field:- Get all orders
- Get orders by subscription owner
- Get orders by subscription number
- Get orders by invoice owner
-
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:
- In the description of the action, clarified that the action cannot modify the custom fields on the Subscription object.
- In the request body, corrected the possible value of the
requests
>Amendments
>Code
field.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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-03-19
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 272, March 2020.
-
Invoices - In the request body of the “Update invoices” operation, added the
invoiceDate
nested field to theinvoices
field. -
Bill Runs - In the request body of the “CRUD: Post or Cancel bill run” operation, added the
InvoiceDate
field. -
Sequence Sets - Made the following updates:
- Added support for configuring and managing prefixes and starting numbers for payments and refunds in sequence sets.
- In the request body of the "Create sequence set" operation, added the following nested fields to the
sequenceSets
field:payment
and its nested fieldsrefund
and its nested fields
- In the request body of the "Update sequence set" operation, added the following fields:
payment
and its nested fieldsrefund
and its nested fields
- In the response body of the “Create sequence set” operation and the response body of the “Get sequence sets” operation, added the following nested fields to the
sequenceSets
field:payment
and its nested fieldsrefund
and its nested fields
- In the response body of the "Get sequence set" operation, added the following fields:
payment
and its nested fieldsrefund
and its nested fields
-
Orders - Removed the "Get rated result for order" operation.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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-03-27
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- Clarified the limitations in the description of the “Write off invoice” operation.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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-02
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- In the description of the following operations, noted that it is best practice to set the
zuora-version
parameter to211.0
or later if you have Invoice Settlement enabled; otherwise, an error occurs.- Create subscription
- Update subscription
- Renew subscription
- Cancel subscription
- Resume subscription
- Suspend subscription
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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
- In the request and response bodies of the “Update custom object definition” operation, added the
-
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
- In the “Query custom object records” operation, added the following query parameters:
-
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.
- Mark as New
- Permalink
- Email to a Friend
- Report Inappropriate Content
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-17
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 274, April 2020.
- Data Queries - In the response body of each of the following operations, added the
createdBy
nested field to thedata
field:
- Submit data query
- Get data query jobs
- Get data query job
- Cancel data query job
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- In the "Settings" section, removed all the "In Development" notes.