Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. 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-11-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 288, November 2020.

  •  
    • Orders - Made the following updates:

      • In the request body of each of the following operations, added the quote field and its nested fields to the subscriptions field:

        • Create order
        • Create order asynchronously
        • Preview order
        • Preview order asynchronously
      • In the response body of each of the following operations, added the quote field and its nested fields to the order > subscriptions field:

        • Get an order
        • Get order metrics for evergreen subscription
      • In the response body of each of the following operations, added the quote field and its nested fields to the orders > subscriptions field:

        • Get all orders
        • Get orders by subscription owner
        • Get orders by subscription number
        • Get orders by invoice owner
      • In the request body of the "Update order custom fields" operation, added the orderActionId nested field to the subscriptions > orderActions field.

      • In the response body of each of the following operations, added the id nested field to the order > subscriptions > orderActions field:

        • Get an order
        • Get order metrics for evergreen subscription
      • In the response body of each of the following operations, added the id nested field to the orders > subscriptions > orderActions field:

        • Get all orders
        • Get orders by subscription owner
        • Get orders by subscription number
        • Get orders by invoice owner
    • Invoices - Made the following updates:

      • In the response body of the "Get invoice items" operation, added the unitPrice nested field to the invoiceItems field.
      • In the request body of the following operations, added a limit to the items field:
        • Create credit memo from invoice
        • Create debit memo from invoice
    • Credit Memos - In the request body of the "Create credit memo from charge" operation, added a limit to the charges field.

    • Debit Memos - In the request body of the "Create debit memo from charge" operation, added a limit to the charges field.

    • Billing Preview Runs - In the response body of the "Get billing preview run" operation, changed the value of the resultFileUrl field and updated the response sample correspondingly.

    • Mass Updater - In the response body of the "Get mass action result" operation, changed the value of the outputURL field and updated the response sample correspondingly.

    • Credit Balance Adjustments - In the request body of the "CRUD: Create credit balance adjustment" operation, added the AdjustmentDate field.

    • Refunds - In the request body of the "CRUD: Create refund" operation, changed the behavior of the RefundDate field.

     

  • Doc Updates

     

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

  •  

    • In the source YAML file, added the QuoteObjectFields reference object. This change affects the following operations:
      • Create order
      • Create order asynchronously
      • Preview order
      • Preview order asynchronously
      • Get an order
      • Get order metrics for evergreen subscription
      • Get all orders
      • Get orders by subscription owner
      • Get orders by subscription number
      • Get orders by invoice owner
      •