---
title: "CRUD: Retrieve a usage record"
method: GET
path: "/v1/object/usage/{id}"
tags: ["Usage"]
---

# CRUD: Retrieve a usage record

`GET /v1/object/usage/{id}`

Retrieve a usage record.

## Path parameters

- `id` string, required

## Query parameters

- `fields` string

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string
- `Zuora-Version` string

## Response `200`

OK

- ProxyGetUsage — Container for custom fields of a Usage object.
  - `AccountId` string — 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
  - `AccountNumber` string — 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
  - `ChargeId` string — 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
  - `CreatedById` string — The user ID of the person who uploaded the usage records. **Character limit**: 32 **Values**: automatically generated
  - `CreatedDate` string, date-time — The date when the usage was generated. **Character limit**: 29 **Values**: automatically generated
  - `Description` string — A description of the usage record.
  - `EndDateTime` string, 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
  - `Id` string — Object identifier.
  - `ProductRatePlanChargeNumber` string — 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.
  - `Quantity` number, double — Indicates the number of units used. **Character limit**: 16 **Values**: A valid decimal amount.
  - `RbeStatus` string — 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`
  - `SourceType` string — 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`
  - `StartDateTime` string, 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
  - `SubscriptionId` string — The original ID of the subscription that contains the fees related to the usage data. **Character limit**: 32 **Values**: a valid subscription ID
  - `SubscriptionNumber` string — The unique identifier number of the subscription that contains the fees related to the usage data.
  - `UOM` string — 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
  - `UpdatedById` string — The ID of the user who last updated the usage upload. **Character limit**: 32 **Values**: automatically generated
  - `UpdatedDate` string, date-time — The date when the usage upload was last updated. **Character limit**: 29 **Values**: automatically generated

## Other responses

- `401` — Unauthorized
- `404`

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)