Sign in
Object Queries

Retrieve a usage record

Retrieve the details of a specific Usage Record object.

get/object-query/usages/{key}

Path parameters

keystring required

Object ID or Number.

Query parameters

pageSizeinteger

The maximum number of results to return in a single page. If the specified pageSize is less than 1 or greater than 99, Zuora will return a 400 error.

cursorstring

A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

sort[]string[]

A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. accountnumber.ASC) or descending (e.g. accountnumber.DESC). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.

expand[]string[]

Allows you to expand responses by including related object information in a single call.

filter[]string[]

A case-insensitive filter on the list.

fields[]string[]

A case-insensitive query parameter that allows you to specify which fields are returned in the response.

includeNullFieldsboolean

Specifies whether to include fields with the null value in the response.

  • If set to true, all fields will be returned in the response, including those with the null value.
  • If set to false, only fields with non-null values will be returned.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

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-Encodingstring

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.

Zuora-Track-Idstring

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-Idsstring

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 should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

idstring

The unique identifier of the usage.

createdByIdstring

The unique identifier of the user who created the usage.

createdDatestring date-time

The date and time when the usage was created.

updatedByIdstring

The unique identifier of the user who last updated the usage.

updatedDatestring date-time

The date and time when the usage was last updated.

accountIdstring

The ID of the customer account associated with the usage.

accountNumberstring

The number of the customer account associated with the usage.

ratePlanChargeIdstring

ID of the rate plan charge that pays for this usage.

endDateTimestring date-time

End date of the time period in which usage is tracked. Zuora uses this field value to determine the usage date.

productRatePlanChargeIdstring

The product rate plan charge number that you use for a dynamic usage charge.

quantitynumber

Number of units used.

rbeStatus'Importing' | 'Pending' | 'Processed'

Indicates if the rating and billing engine (RBE) processed usage data for an invoice.

sourceType'API' | 'Import'

Indicates if the usage records were imported from the web-based UI or the API.

startDateTimestring date-time

Start date of the time period in which usage is tracked. Zuora uses this field value to determine the usage date.

subscriptionIdstring

The original ID of the subscription that contains the fees related to the usage data.

submissionDateTimestring date-time

The date and time when the usage was submitted.

uOMstring

The units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in Billing Settings.

descriptionstring

A description of the usage record.

importIdstring

The unique identifier of the import.

uniqueKeystring

a customer-defined specific identifier of a usage record.

Note: This field is only available if you have the Prepaid with Drawdown feature or the <a href="https://docs.zuora.com?resourceId=billing-unbilled-usage" target="_blank">Unbilled Usage</a> feature enabled. See Upload usage record with unique key for more information.

fileIdstring

File ID of the uploaded usage records file. You can use this file ID with Get files to download the file.

fileNamestring

The name of the import file when the usage record is imported from the file.

Changes