Skip to main content
GET
Get live usage
Prefer this over the list when showing one eSIM to the person using it. A network that cannot be reached degrades to the stored figure rather than failing the read. Usage is also pushed as esim.usage.low and esim.expiry.near, so you need not poll to warn someone.

Error codes

Authorizations

Authorization
string
header
required

A secret API key, sent as Authorization: Bearer sk_test_… in sandbox or Bearer sk_live_… in live.

Path Parameters

profileId
string
required

eSIM ULID. A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

Response

Successful response.

id
string
required

A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

orderId
string
required

A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

status
enum<string>
required

ready means installable; in_use means the traveller has installed it.

Available options:
pending,
ready,
in_use,
depleted,
expired,
suspended,
revoked,
cancelled
iccid
string | null
required

The SIM identifier, once the network has allocated one.

customerId
string | null
required

A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

package
object | null
required
data
object
required
validity
object
required
smdpStatus
string | null
required
createdAt
string<date-time>
required
Example:

"2026-08-14T09:00:00.000Z"

updatedAt
string<date-time>
required
Example:

"2026-08-14T09:00:00.000Z"