---
title: "GET /v1/UsageRecords"
method: GET
path: "/v1/UsageRecords"
tags: ["SupersimV1UsageRecord"]
---

# GET /v1/UsageRecords

`GET /v1/UsageRecords`

List UsageRecords

## Query parameters

- `Sim` string
- `Fleet` string
- `Network` string
- `IsoCountry` string, iso-country-code
- `Group` 'sim' | 'fleet' | 'network' | 'isoCountry'
- `Granularity` 'hour' | 'day' | 'all'
- `StartTime` string, date-time
- `EndTime` string, date-time
- `PageSize` integer
- `Page` integer
- `PageToken` string

## Response `200`

OK

- object
  - `usage_records` SupersimV1UsageRecord[]
    - `account_sid` string, nullable — The SID of the [Account](https://docs.korewireless.com/en-us/v/api/global-resources/iam/account) that incurred the usage.
    - `sim_sid` string, nullable — SID of a Sim resource to which the UsageRecord belongs. Value will only be present when either a value for the `Sim` query parameter is provided or when UsageRecords are grouped by `sim`. Otherwise, the value will be `null`.
    - `network_sid` string, nullable — SID of the Network resource the usage occurred on. Value will only be present when either a value for the `Network` query parameter is provided or when UsageRecords are grouped by `network`. Otherwise, the value will be `null`.
    - `fleet_sid` string, nullable — SID of the Fleet resource the usage occurred on. Value will only be present when either a value for the `Fleet` query parameter is provided or when UsageRecords are grouped by `fleet`. Otherwise, the value will be `null`.
    - `iso_country` string, iso-country-code, nullable — Alpha-2 ISO Country Code that the usage occurred in. Value will only be present when either a value for the `IsoCountry` query parameter is provided or when UsageRecords are grouped by `isoCountry`. Otherwise, the value will be `null`.
    - `period` unknown
    - `data_upload` integer, nullable — Total data uploaded in bytes, aggregated by the query parameters.
    - `data_download` integer, nullable — Total data downloaded in bytes, aggregated by the query parameters.
    - `data_total` integer, nullable — Total of data_upload and data_download.
    - `data_total_billed` number, nullable — Total amount in the `billed_unit` that was charged for the data uploaded or downloaded. Will return 0 for usage prior to February 1, 2022. Value may be 0 despite `data_total` being greater than 0 if the data usage is still being processed by KORE's billing system. Refer to [Data Usage Processing](https://docs.korewireless.com/en-us/v/api/products/supersim/usage-record-resource#data-usage-processing) for more details.
    - `billed_unit` string, currency, nullable — The currency in which the billed amounts are measured, specified in the 3 letter ISO 4127 format (e.g. `USD`, `EUR`, `JPY`). This can be null when data_toal_billed is 0 and we do not yet have billing information for the corresponding data usage. Refer to [Data Usage Processing](https://docs.korewireless.com/en-us/v/api/products/supersim/usage-record-resource#data-usage-processing) for more details.
  - `meta` object
    - `first_page_url` string, uri
    - `key` string
    - `next_page_url` string, uri, nullable
    - `page` integer
    - `page_size` integer
    - `previous_page_url` string, uri, nullable
    - `url` string, uri

---

[API](https://skmtc.dev/korewireless/apis/kore-supersim.md) · [All operations](https://skmtc.dev/korewireless/apis/kore-supersim/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/korewireless/kore-supersim/revisions/b9771e13e814/schema)