List charge metrics by time range

Retrieves key charge metrics about rate plan charges that have changes in a specified time range.

The purpose of fromTimestamp and toTimestamp is to synchronize charge metrics data incrementally.

Request
query Parameters
fromTimestamp
required
string <date-time>

The starting date and time of a time range when changes are made to charge metrics, in yyyy-mm-ddThh:mm:ssZ format. For example, 2020-08-18T09:01:11Z. The timestamp maps to the UpdatedOn timestamp of the to-be-exported object.

toTimestamp
required
string <date-time>

The end date and time of a time range when changes are made to charge metrics, in yyyy-mm-ddThh:mm:ssZ format. For example, 2020-08-20T09:01:11Z. The timestamp maps to the UpdatedOn timestamp of the to-be-exported object.

header Parameters
Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
required
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Accept
string

Expressed as MIME types that the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. The possible response MIME types are application/json-seq compatible with http://jsonlines.org/, and text/csv compatible with RFC 4180. application/json-seq is the default response MIME type. If the Accept header is not sepecified, or set /, the response body is returned in application/json-seq MIME type.

Responses
200
400

Invalid Parameters

429

Rate limited

500

Internal Error

get/charge-metrics/data/charge-metrics
Request samples 
Response samples 
{
  • "amendmentId": "string",
  • "amendmentType": "string",
  • "chargeNumber": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "deleted": true,
  • "endDate": "2019-08-24",
  • "id": "string",
  • "invoiceOwnerAccountNumber": "string",
  • "mrrDiscountAmount": 0,
  • "mrrGrossAmount": 0,
  • "mrrNetAmount": 0,
  • "productId": "string",
  • "productRatePlanChargeId": "string",
  • "productRatePlanId": "string",
  • "ratePlanChargeId": "string",
  • "startDate": "2019-08-24",
  • "subscriptionName": "string",
  • "subscriptionOwnerAccountNumber": "string",
  • "tcvDiscountAmount": 0,
  • "tcvGrossAmount": 0,
  • "tcvNetAmount": 0,
  • "updatedOn": "2019-08-24T14:15:22Z"
}