- 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. 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-11
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 228, July 2018.
-
Catalog - In the “Get catalog” operation, changed the behavior of the
productRatePlans
field in the response body. When you call this operation, a URL is returned as the value of theproductRatePlans
field, instead of product rate plan details. The URLs correspond to the new “Get product rate plans” call. See the descriptions of theproductRatePlans
fields to find out how to enable the latest behavior in your tenant. -
Product Rate Plans - Added a new operation called “Get product rate plans”.
Doc Updates
- In the “Amend” action, made the following updates:
- Updated the description of the operation to clarify that the operation cannot be used to amend multiple subscriptions.
- Added a description for the
requests
field in the request body. - Correctly documented which Amendment object fields are required. Previously, the operation description and the request body listed different Amendment object fields as required.
2018-07-05
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 228, July 2018.
-
Payment Methods - Made the following updates to the "Create payment method" operation:
-
In the operation description, updated the different fields specific to each payment method type.
-
In the
type
field, added the support for thePayPalNativeEC
andPayPalAdaptive
values. -
Changed the
BAID
andemail
fields from required to optional because these fields are conditionally required, and updated the corresponding description. -
Added the
preapprovalKey
field for the PayPal Adaptive payment method.
-
-
Transactions - In the “Get invoices” operation, changed the behavior of the
invoiceItems
andinvoiceFiles
fields in the response body. When you call this operation, URLs are returned as the values of theinvoiceItems
andinvoiceFiles
fields, instead of invoice item details and invoice file details. The URLs correspond to the “Get invoice items” and “Get invoice files” operations. See the descriptions of theinvoiceItems
andinvoiceFiles
fields to find out how to enable the latest behavior in your tenant.
-
Orders - In the request body of the “Create order” operation, added the
customFields
container to the following fields:newAccount
>billToContact
newAccount
>soldToContact
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>billToContact
subscriptions
>orderActions
>createSubscription
>newSubscriptionOwnerAccount
>soldToContact
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
- In the “Create order” operation, added a note about payment processing failures.
- In all relevant operations, changed the name of the Advanced AR Settlement feature to Invoice Settlement, and updated all related reference links.