Zuora Documentation

Re: API Changelog

2018-02-27

 

Doc Updates

 

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

 

  • Changed the name of the "Usage (with Real-Time Rating)" section. This section was originally called Usage Rating.

 

2018-02-23

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the February 2018 production release, R221.

 

  • Usage (with Real-Time Rating) - Added operations provided by the new Real-Time Usage Rating service.
  • Subscriptions - Made the following updates:
    • Added a value ByGroupId to the ratingGroup field in the request body of the following operations:
      • Create subscription: subscribeToRatePlans > chargeOverrides > ratingGroup
      • Preview subscription: subscribeToRatePlans > chargeOverrides > ratingGroup
      • Update subscription: add > chargeOverrides > ratingGroup
    • Added a value ByGroupId to the ratingGroup field in the response body of the following operations:
      • Get subscriptions by account: subscriptions > ratePlans > ratePlanCharges > ratingGroup
      • Get subscriptions by key: ratePlans > ratePlanCharges > ratingGroup
      • Get subscriptions by key and version: ratePlans > ratePlanCharges > ratingGroup
  • Accounts - In the “Create account” operation, added a value ByGroupId to the subscriptions > subscribeToRatePlans > chargeOverrides > ratingGroup field in the request body.
  • Catalog - In the “Get product catalog” operation, added a value ByGroupId to the products > productRatePlans > productRatePlanCharges > ratingGroup field in the response body.
  • Custom Fields - Added operations provided by the new Custom Fields service.
  • Actions and CRUD operations - Added the WWW-Authenticate header to the 401 response of each operation. This update is available in the Zuora API Sandbox environment. As of 2018-02-23, this update is not yet available in the Zuora Production environment.

Doc Updates

 

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

 

  • In the “Create and activate order” operation, added links to tutorials that demonstrate how to use the operation.
  • In the “Get account summary” operation, added a note to the usage field in the response body, noting that usage data is not returned if the Real-Time Usage Rating feature is enabled.
  • Set "example.com" as the domain in all sample email addresses.
  • In the "Orders" section, removed the unnecessary regular expressions from the communicationProfileId, hpmCreditCardPaymentMethodId, and invoiceTemplateId fields.
  • In the “CRUD: Create Bill Run” operation, corrected ChargeTypeToExclued to ChargeTypeToExclude in code samples.