---
title: "Get live data usage for an eSIM"
method: GET
path: "/esims/{id}/usage"
tags: ["eSIM"]
---

# Get live data usage for an eSIM

`GET /esims/{id}/usage`

## Request

- Base URL: `https://dashboard.voidmob.com/api/v1`
- URL: `https://dashboard.voidmob.com/api/v1/esims/{id}/usage`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

Live usage data for the eSIM.

- EsimUsageEnvelope
  - `success` true, required
  - `data` object, required
    - `usage` object, required
      - `esim_id` string, required: Public eSIM order id (prefixed `esim_`).
      - `esim_status` 'processing' | 'completed' | 'cancelled' | 'refunded' | 'expired', required: Current status of the eSIM order at time of query.
      - `packages` EsimUsagePackage[], required: Per-bundle usage breakdown. One entry per data bundle on this eSIM (including topups).
        - `name` string, required: Data package name.
        - `total_mb` number, required: Total data allocation in megabytes.
        - `total_gb` number, required: Total data allocation in gigabytes.
        - `used_mb` number, required: Data consumed in megabytes.
        - `used_gb` number, required: Data consumed in gigabytes.
        - `remaining_mb` number, required: Remaining data in megabytes.
        - `remaining_gb` number, required: Remaining data in gigabytes.
        - `percent_used` number, required: Percentage of allocation consumed (0-100).
        - `activation_date` string, date-time, nullable, required: ISO 8601 timestamp when the package was activated. Null if not yet activated.
        - `expiration_date` string, date-time, nullable, required: ISO 8601 timestamp when the package expires. Null if not yet activated.

## Other responses

- `401`: 401 - Authentication required.
- `404`: 404 - eSIM not found.
- `410`: 410 - This eSIM has been cancelled or refunded.
- `422`: 422 - eSIM is not in an active state.
- `429`: 429 - Rate limit exceeded. Retry after the indicated interval.
- `500`: 500 - An unexpected error occurred. Please try again.
- `502`: 502 - Service error. Please retry shortly.
- `503`: 503 - Usage data is not currently available. Please try again later.

---

[API](https://skmtc.dev/voidmob/apis/voidmob-public-api.md) · [All operations](https://skmtc.dev/voidmob/apis/voidmob-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/voidmob/apis/voidmob-public-api/revisions/066023313ebe?raw)