Sign inGet Started
Inizia ora
Guide
Riferimento API
SDK
CLI
Knowledge Base
Changelog

List an eSIM's data packages

GET
/v1/esim/sims/{esim_id}/packages
bird esim packages list <esim-id>
Risposta200
{
  "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.

Parametri

esim_idstring

eSIM ID.

Payload di risposta

data
array of object
obbligatorio

Packages, newest first.

Mostra attributi secondari
data.id
string
obbligatorio
data.order_id
string
obbligatorio

The order that purchased this package.

data.offer_id
string
obbligatorio

Offer this package was purchased from.

data.zone_id
string
obbligatorio

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
obbligatorio

Coverage zone name, from the offer.

data.countries
array of string
obbligatorio

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

data.status
string
obbligatorio
data.speed
string
obbligatorio

Speed class, from the offer.

data.balance
object
obbligatorio
Mostra attributi secondari
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
obbligatorio

What your workspace was billed for this package.

Mostra attributi secondari
data.created_at
string
obbligatorio

Risorse correlate

Continua con la documentazione, le guide e gli esempi per questo argomento.

Ottieni un brief di implementazione