Happy Business Starts Here

Highlighted
Zuora Documentation

Active Rating API Changelog

This changelog outlines the latest REST API updates and documentation updates in the Active Rating API and Custom Fields API. The Active Rating API and Custom Fields API are both in Limited Availability.

 

2018-12-20

 

Doc Updates

 

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

 

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

 

 

2018-08-10

 

Doc Updates

 

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

 

  • In the “Create usage records” operation, made the following updates:
    • In the operation description, added a link to the aritcle Usage Data Import in Knowledge Center.
    • In the request body, added more usage data verification information to the descriptions of the following fields:
      • data > accountNumber
      • data > tag
      • data > unitOfMeasure

 

2018-07-11

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed in this version of the API Reference.

 

  • Usage (with Real-Time Rating) - In the response body of the following operations, added a value IMPORTED_WITH_ERRORS to the status field and changed the COMPLETED_WITH_ERRORS value to VALIDATION_FAILED for this field:
    • Import usage file
    • Get usage imports
    • Get details of usage import
    • Get status of usage import

 

Doc Updates

 

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

 

  • In the “Download usage import failure file” operation, updated the description of this operation to indicate that usage import failure files are only available for usage import files in VALIDATED_FAILED status.

  • In the response body of the following operations, added detailed descriptions to each value of the status field:

    • Import usage file
    • Get usage imports
    • Get details of usage import
    • Get status of usage import
  • In the description of the Custom Fields section, noted that custom field names are case sensitive.

 

2018-05-08

 

Doc Updates

 

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

 

  • In the description of the “Query usage records in stream” operation, added the standard restriction on the value of the filters parameter in the endpoint URL.

 

2018-04-22

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed in this version of the API Reference.

 

  • Made the following updates to all operations:
    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Removed the Zuora-Request-Id request header, which means that you now cannot control the value of the Zuora-Request-Id response header. You should use the new Zuora-Track-Id request and response headers instead.

 

Doc Updates

 

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

 

  • Escaped single quotes in the Curl and PHP request samples for the “Set schema of custom fields definition in namespace” operation.

 

2018-04-16

 

Doc Updates

 

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

 

  • Added placeholders to represent custom fields in the request bodies of the following operations:

    • Create usage records
    • Update usage record
  • Added placeholders to represent custom fields in the response bodies of the following operations:

    • Get usage record
    • Query usage records
    • Query usage records in stream
  • Changed the request sample of the “Set schema of custom fields definition in namespace” operation to only show custom fields of type string. Custom fields of core Zuora objects should only have type string.

  • In the following operations, changed the response samples to only show custom fields of type string:

    • Get all custom fields definitions in namespace
    • Get custom fields definition in namespace

    Custom fields of core Zuora objects should only have type string.

 

2018-03-21

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed in this version of the API Reference.

 

 

Doc Updates

 

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

 

  • In the “Import usage file” operation, updated the operation description to list Microsoft Excel (.xls) as a supported file format for usage files.