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-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 the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount field:

      • Preview order
      • Preview order asynchronously
    • In the response bodies of the following operations, added the paymentMethod nested field to the order > 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 the orders > 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.