Sign inGet Started
Jetzt starten
Anleitungen
API-Referenz
SDKs
CLI
Wissensdatenbank
Changelog

List an eSIM's data packages

GET
/v1/esim/sims/{esim_id}/packages
bird esim packages list <esim-id>
Antwort200
{
  "data": [
    {
      "id": "epk_01krdgeqcxet5s7t44vh8rt9mg",
      "order_id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
      "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
      "zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
      "zone_name": "Europe",
      "countries": [
        "US"
      ],
      "status": "provisioning",
      "speed": "full",
      "price": {
        "amount": "0.00995",
        "currency_code": "USD"
      }
    }
  ]
}

Returns the eSIM's data packages with per-zone balances, validity, and status, newest first and in full: an eSIM holds at most package_limit concurrent packages. Balances update as mobile networks report usage; balance.as_of tells you how fresh they are.

Parameter

esim_idstring

eSIM ID.

Antwort-Payload

data
array of object
erforderlich

Packages, newest first.

Untergeordnete Attribute anzeigen
data.id
string
erforderlich
data.order_id
string
erforderlich

The order that purchased this package.

data.offer_id
string
erforderlich

Offer this package was purchased from.

data.zone_id
string
erforderlich

Coverage zone the package draws on. The name and countries below are captured at purchase time; the zone resource carries the live footprint.

data.zone_name
string
erforderlich

Coverage zone name, from the offer.

data.countries
array of string
erforderlich

Countries the package's zone covers, captured at purchase time so the package is meaningful without fetching the offer.

data.status
string
erforderlich
data.speed
string
erforderlich

Speed class, from the offer.

data.balance
object
erforderlich
Untergeordnete Attribute anzeigen
data.activated_at
nullable string

When the package started consuming data (first use in its zone). Null until then.

data.expires_at
nullable string

When the package's validity ends and unused balance expires. Already capped by the eSIM's service period, so this is always the effective expiry. Null until the package activates.

data.price
object
erforderlich

What your workspace was billed for this package.

Untergeordnete Attribute anzeigen
data.created_at
string
erforderlich

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Implementierungs-Briefing erhalten