Sign in
Usage

CRUD: Retrieve a usage record

Retrieve a usage record.

get/v1/object/usage/{id}

Path parameters

idstring required

Object id

Query parameters

fieldsstring

Object fields to return

Headers

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

The minor API version.

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

Response

OK

AccountIdstring

The ID of the account associated with the usage data. This field is required if no value is specified for the AccountNumber field. Character limit: 32 Values: a valid account ID

AccountNumberstring

The number of the account associated with the usage data. This field is required if no value is specified for the AccountId field. Character limit: 50 Values: a valid account number

ChargeIdstring

The OrginalId of the rate plan charge related to the usage record, e.g., 2c9081a03c63c94c013c6873357a0117 Character limit: 32 Values: a valid rate plan charge OriginalID

CreatedByIdstring

The user ID of the person who uploaded the usage records. Character limit: 32 Values: automatically generated

CreatedDatestring date-time

The date when the usage was generated. Character limit: 29 Values: automatically generated

Descriptionstring

A description of the usage record.

EndDateTimestring date-time

The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation. Character limit: 29 Values: a valid date and time value

Idstring

Object identifier.

ProductRatePlanChargeNumberstring

Specify a product rate plan charge number so that you can charge your customer with a dynamic usage charge for the corresponding uploaded usage record.

To use this field, you must set the X-Zuora-WSDL-Version request header to 146 or higher. Otherwise, an error occurs.

Note: This field is only available if you have the <a href="https://docs.zuora.com?resourceId=billing-dynamic-usage-charges" target="_blank">Dynamic Usage Charges</a> feature enabled.

Quantitynumber double

Indicates the number of units used.

Character limit: 16

Values: A valid decimal amount.

RbeStatusstring

Indicates if the rating and billing engine (RBE) processed usage data for an invoice. Character limit: 9 Values: automatically generated to be one of the following values: Importing, Pending, Processed

SourceTypestring

Indicates if the usage records were imported from the web-based UI or the API. Character limit: 6 Values: automatically generated to be one of the following values: API, Import

StartDateTimestring date-time

The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the EndDateTime, the StartDateTime field does affect usage calculation. Character limit: 29 Values: a valid date and time value

SubscriptionIdstring

The original ID of the subscription that contains the fees related to the usage data. Character limit: 32 Values: a valid subscription ID

SubscriptionNumberstring

The unique identifier number of the subscription that contains the fees related to the usage data.

UOMstring

Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in Billing Settings. Character limit: Values: a valid unit of measure

UpdatedByIdstring

The ID of the user who last updated the usage upload. Character limit: 32 Values: automatically generated

UpdatedDatestring date-time

The date when the usage upload was last updated. Character limit: 29 Values: automatically generated

Changes