Buvei
API ReferenceeSIM

Get eSIM Usage

Near-real-time data usage for one eSIM.

GET/open-api/v1/esim/esims/{esimNo}/usage

Returns the data usage of one of your eSIMs. Usage is synced from the network at most once per minute per eSIM; calls inside the cooldown return the latest snapshot — check lastSyncAt for freshness. Polling faster than once a minute therefore adds no information.

Path parameters

esimNostringpathrequired

eSIM id (esim_...).

Response

esimNostring
planNostring
Current plan.
iccidstring
statusstring
e.g. ACTIVE · EXPIRED · DEPLETED.
dataTotalMbinteger
null for unlimited plans.
dataUsedMbinteger
dataLeftMbinteger
null for unlimited plans.
expireAtinteger
Epoch ms, null until first activation.
lastSyncAtinteger
When this snapshot was synced from the network (epoch ms).
Response
{
  "code": 0,
  "message": "SUCCESS",
  "data": {
    "esimNo": "esim_6ba300976dbb48b8a1",
    "planNo": "epln_b312537653c3a51f00",
    "iccid": "8948010010043989416",
    "status": "ACTIVE",
    "dataTotalMb": 1004,
    "dataUsedMb": 0,
    "dataLeftMb": 1004,
    "expireAt": null,
    "lastSyncAt": 1783869530718
  }
}

On this page

Path parameters
Response