# Retrieve usage records

Retrieves a list of usage records.

Endpoint: GET /usages
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `filter` (string)
    Criteria for filtering collection items.
This field requires a special format.
Use , to specify multiple allowed values.
Use ; to specify multiple fields.

For more information, see Search filters.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with -. Multiple fields can be sorted by separating each with ,.

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `q` (string)
    Use this field to perform a partial search of text fields.

## Response 200 fields (application/json):

  - `id` (string)
    ID of the usage record.
    Example: "sub_usg_0YVJ636B95DNA9M3B1638HXBCQ"

  - `subscriptionId` (string, required)
    Subscription ID for which the usage is reported.
    Example: "sub_01HRF27SATGE4Z6PBJE6PD8328"

  - `invoiceId` (string,null)
    ID of the invoice to which usage is applied.
This value is populated when the invoice is issued.
    Example: "in_0YVF9605RKC62BP14NE2R7V2XT"

  - `invoiceItemId` (string,null)
    ID of the invoice item to which usage is applied.
This value is populated when the invoice is issued.
    Example: "ii_0YVFDEQS2KCFTBN9HXWJFY55GV"

  - `quantity` (number, required)
    Quantity of consumed units for a subscription plan product.
Represents the actual usage of a billable product or service by the customer.
Accepts both integer and decimal values with a precision of up to 3 decimal places.
The minimum billable unit is 0.001.
    Example: 5.125

  - `usageTime` (string)
    Date and time, in ISO 8601 format, when a usage occurred.
If this value is not provided or is empty, the date and time of the request is used.

  - `createdTime` (string)
    Date and time when the resource is created.
This value is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self"

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.