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!

 

2018-12-14

 

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 - Made the following updates:
    • In the request body of the “Create order” operation:
      • Added nested fields called suspend and resume to the subscriptions > orderActions field.
      • Added possible values Suspend and Resume to the subscriptions > orderActions > type field.
    • In the response body of the “Create order” operation, added a possible value Suspended to the subscriptions > status field.
    • In the request body of the “Preview order” operation:
      • Added nested fields called suspend and resume to the subscriptions > orderActions field.
      • Added possible values Suspend and Resume to the subscriptions > orderActions > type field.
    • In the following operations, added nested fields called suspend and resume to the order > subscriptions > orderActions field of the response body:
      • Get an order
      • Get order metrics for evergreen subscription
    • In the following operations, added possible values Suspend and Resumeto the subscriptions > orderActions > type field of the response body:
      • Get an order
      • Get order metrics for evergreen subscription
    • In the following operations, added nested fields called suspend and resume to the orders > subscriptions > orderActions field of the response body:
      • Get all orders
      • Get orders by subscription owner
      • Get orders by subscription number
      • Get orders by invoice owner
    • In the following operations, added possible values Suspend and Resumeto the orders > subscriptions > orderActions > type field of the response body:
      • 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 Zuora Object Model section, added the following objects to the table of API names:
    • Feature
    • Product Feature
    • Subscription Product Feature
  • In the “Create order” operation, added a note about the Suspend and Resume feature.
  • In the following operations, updated the note about the Orders feature:
    • Preview order
    • Preview order asynchronously
    • Create order
    • Create order asynchronously
    • Delete order
    • Get job status and response
    • Update subscription custom fields
    • Update order action trigger dates
  • In the following operations, updated the note about the Order Metrics feature:
    • Get all orders
    • Get an order
    • Get billing information for order
    • Get term information for subscription
    • Get order metrics for evergreen subscription
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner
    • Get breakdown of invoice by order
    • Request breakdown of invoice items by order
    • Get rated result for order
    • Update order custom fields

 

2018-12-07

 

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, changed the behavior of the creditCard and hpmCreditCardPaymentMethodId fields. If autoPay is set to false, you do not need to specify creditCard or hpmCreditCardPaymentMethodId.
    • 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.