Buvei
API ReferenceWebhook Events

ESIM_EXPIRED

An eSIM's plan expired (or its data is fully depleted).

Delivered when an eSIM's plan has expired or its data allowance is fully used up. The eSIM can be revived with a recharge of its current plan.

We verify against the live network state before sending — if the user already recharged by the time the expiry was detected, this event is not sent (no false alarms).

Headers

Standard webhook headers — see Webhook security.

Payload

eventIdstring
eventTypestring
Always "ESIM_EXPIRED".
timestampinteger
Epoch milliseconds.
dataobject
Response
{
  "eventId": "e_xxxxxxxxxxxxxxxxxxxx",
  "eventType": "ESIM_EXPIRED",
  "timestamp": 1784000000000,
  "data": {
    "esimNo": "esim_6ba300976dbb48b8a1",
    "iccid": "8948010010043989416",
    "status": "EXPIRED"
  }
}

On this page