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-02-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 238, February 2019.

 

  • Orders - Made the following updates:
    • In both the “Create order” and “Preview order” operations, added the priceChangeOption field to the following fields in the request body:
      • subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount
      • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount
      • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount

 

Doc Updates

 

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

 

  • In the request body of the “Update payment” operation, removed the referenceId field.
  • In the source YAML file, duplicated the DiscountPricingOverride reference object as a new reference object called PostOrderDiscountPricingOverride that is used in the request body of the following operations:
    • Create order
    • Preview order
  • In the source YAML file, duplicated the DiscountPricingUpdate reference object as a new reference object called PostOrderDiscountPricingUpdate that is used in the request body of the following operations:
    • Create order
    • Preview order

 

2019-02-12

 

API Updates

 

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

 

  • Accounts - Made the following updates:

    • In the request body of the “Generate billing documents by amount” operation, added the following fields:
      • autoRenew
      • chargeTypeToExclude
    • In the response body of the “Create account” operation, added the following fields:
      • billToContactId
      • soldToContactId

 

Doc Updates

 

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

 

  • In the response body of the “Get account” operation, corrected the descriptions of the following fields:

    • billToContact > country
    • billToContact > state
    • soldToContact > country
    • soldToContact > state
  • In the response body of the “Get account summary” operation, corrected the descriptions of the following fields:

    • billToContact > country
    • billToContact > state
    • soldToContact > country
    • soldToContact > state
  • In the request body of the “Create credit card payment method” operation, removed “required” from the following nested fields of the cardHolderInfo field. However, if you do not specify the accountKey field in the request body, the cardHolderName field is still required.

    • cardHolderName
    • City
    • State
    • zipCode
    • country
  • Changed the URL of the source YAML file. See this post for more information.

  • In the request body of the “Update payment” operation, added the referenceId field. However, as of Zuora Release 238, this field is not available.