Zuora Documentation

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!




API Updates


This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 235, December 2018.


  • Orders - Added the following new operations:
    • Preview order asynchronously
    • Create order asynchronously
    • Get job status and response
  • Accounts - Made the following updates:
    • In the request body of the “Create account” operation:
      • Added the soldToSameAsBillTo field.
      • Changed the behavior of the autoPay, creditCard, and hpmCreditCardPaymentMethodId fields. If autoPay is set to false, you do not need to specify creditCard or hpmCreditCardPaymentMethodId. Previously, creditCard and hpmCreditCardPaymentMethodId did not depend on autoPay.
    • Changed the behavior of the “CRUD: Delete account” operation to delete accounts asynchronously. Previously, accounts were deleted synchronously when this operation is used.


Doc Updates


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


  • In the “Multi-entity: Disconnect connection” operation, updated the description to clarify that if you have shared objects from a global entity to a target entity, disconnecting the connection will break the mapping relationship between these entities and cannot be recovered later.

  • In the “How this REST API Call Works” section of the “Post usage” operation, updated the description about the method for downloading the usage file template. Previously a file download link was provided in this section. Now users need to go to their tenants and download for themselves.

  • In the “Create order” operation, corrected the maximum length of the following fields in the request body:

    • newAccount > name
    • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > name
  • In the “Preview order” operation, corrected the maximum length of the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > name field in the request body.