---
title: "List billing usage records"
method: GET
path: "/usage/data/billing"
tags: ["SIMs (Devices)"]
---

# List billing usage records

`GET /usage/data/billing`

## Request

- Base URL: `https://dashboard.hologram.io/api/1`
- URL: `https://dashboard.hologram.io/api/1/usage/data/billing`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/usage/data/billing/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns total data usage for each SIM summarized by the SIM's unique 30-day billing period. Records are returned per link (profile) ID by billing period, within the date range specified. Monthly Recurring Charges are billed every 30 days beginning at the time the device was activated. Data is available for the last three months.

## Query parameters

- `limit` integer
- `before` integer
- `after` integer
- `linkid` integer
- `linkids` string
- `deviceids` string
- `tagids` string
- `timestart` integer
- `timeend` integer
- `islive` boolean
- `startat` string
- `maxperiodsback` integer
- `tagid` integer
- `tagname` string

## Response `200`

OK

- UsageBillingListResponse
  - `success` boolean: Indicates whether the request was successful.
  - `limit` integer: Maximum number of records returned per page
  - `size` integer: Number of records in this response
  - `continues` boolean: True if more records are available
  - `lastid` string: record_id of the last record returned; pass as startat to fetch the next page
  - `links` PaginationLinks
    - `path` string: The API endpoint path
    - `base` string: The API base URL
    - `next` string: URL to retrieve the next page of results
  - `data` UsageBillingRecord[]
    - `linkid` integer: Cellular link (SIM) ID
    - `cur_period_end` string: End timestamp of this 30-day billing period (UTC)
    - `periods_back` string: 0 = current period, 1 = one period ago, etc.
    - `record_id` string: Unique record identifier (linkid concatenated with periods_back)
    - `bytes` integer: Total bytes used in this billing period

## Other responses

- `401`: Unauthorized
- `403`: Forbidden — billing_visible permission required

---

[API](https://skmtc.dev/hologram/apis/hologram-rest-api-v1.md) - [All operations](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/revisions/1bc07dcd1631?raw)