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!

 

2019-01-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 236, January 2019.

 

  • Accounts - In the “Create account” operation, added the documentDate field to the request body.

  • Subscriptions - In the following operations, added the documentDate field to the request body:

    • Create subscription
    • Update subscription
    • Renew subscription
    • Cancel subscription
    • Resume subscription
    • Suspend subscription
  • Invoices - In the request body of the “Write off invoice” operation, added the following fields and support for custom fields:

    • comment
    • items and its nested fields
    • reasonCode
  • Product Rate Plans - In the response body of the “Get product rate plans” operation, added the following nested fields to the productRatePlans > productRatePlanCharges > financeInformation field:

    • contractAssetAccountingCode
    • contractAssetAccountingCodeType
    • contractLiabilityAccountingCode
    • contractLiabilityAccountingCodeType
    • adjustmentLiabilityAccountingCode
    • adjustmentLiabilityAccountingCodeType
    • unbilledReceivablesAccountingCode
    • unbilledReceivablesAccountingCodeType
    • adjustmentRevenueAccountingCode
    • adjustmentRevenueAccountingCodeType
    • contractRecognizedRevenueAccountingCode
    • contractRecognizedRevenueAccountingCodeType
  • Catalog - Made the following updates:

    • In the “Get catalog” operation, changed the behavior of the products > productRatePlans field in the response body.
    • In the “Get product” operation, changed the behavior of the productRatePlans field in the response body.

    This behavior change is available only when you set the zuora-versionrequest header to 230.0 or later. See the descriptions of the productRatePlans fields to find out details about the latest behavior.

  • Bill Run - Changed the behavior of the “CRUD: Create bill run” operation. If more than 500 bill runs created by using this operation are in Pending status, no more bill runs can be created by using this operation.

  • Payments - Changed the behavior of the following operations. If you have the Invoice Settlement feature enabled, payments applied to credit balance cannot be canceled or deleted.

    • Cancel payment
    • Delete payment
  • Refunds - Changed the behavior of the following operations. If you have the Invoice Settlement feature enabled, refunds applied to credit balance cannot be canceled or deleted.

    • Cancel refund
    • Delete refund

 

Doc Updates

 

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

 

  • In the “Amend” action, corrected the descriptions of the DestinationInvoiceOwnerId and DestinationAccountId fields in the request body.

  • In the "Suspend subscription” and “Resume subscription” operations, removed the notes about the limitation on using these operations with Order Metrics.

  • In the “Preview order” operation, added the missing taxInfo nested field to the previewAccountInfo field in the request body.

  • In the response bodies of the following operations, noted when certain fields are not applicable in the order > subscriptions > orderActions > suspend field:

    • Get an order
    • Get order metrics for evergreen subscription

    Those fields include:

    • suspendPolicy
    • suspendPeriods
    • suspendPeriodsType
    • suspendSpecificDate
  • In the response bodies of the following operations, noted when certain fields are not applicable in the order > subscriptions > orderActions > resume field:

    • Get an order
    • Get order metrics for evergreen subscription

    Those fields include:

    • resumePolicy
    • resumePeriods
    • resumePeriodsType
    • resumeSpecificDate
    • extendsTerm
  • In the response bodies of the following operations, noted when certain fields are not applicable in the orders > subscriptions > orderActions > suspend field:

    • Get all orders
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner

    Those fields include:

    • suspendPolicy
    • suspendPeriods
    • suspendPeriodsType
    • suspendSpecificDate
  • In the response bodies of the following operations, noted when certain fields are not applicable in the orders > subscriptions > orderActions > resume field:

    • Get all orders
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner

    Those fields include:

    • resumePolicy
    • resumePeriods
    • resumePeriodsType
    • resumeSpecificDate
    • extendsTerm
  • In all relevant operations, changed the name of the Real-Time Usage Rating feature to Active Rating, and updated all related reference links.