Sign inGet Started
Rozpocznij
Przewodniki
Referencja API
SDK
CLI
Baza wiedzy
Changelog

List an eSIM's data packages

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

Parametry

esim_idstring

eSIM ID.

Treść odpowiedzi

data
array of object
wymagane

Packages, newest first.

Pokaż atrybuty podrzędne
data.id
string
wymagane
data.order_id
string
wymagane

The order that purchased this package.

data.offer_id
string
wymagane

Offer this package was purchased from.

data.zone_id
string
wymagane

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
wymagane

Coverage zone name, from the offer.

data.countries
array of string
wymagane

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

data.status
string
wymagane
data.speed
string
wymagane

Speed class, from the offer.

data.balance
object
wymagane
Pokaż atrybuty podrzędne
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
wymagane

What your workspace was billed for this package.

Pokaż atrybuty podrzędne
data.created_at
string
wymagane

Powiązane zasoby

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.

Uzyskaj brief wdrożeniowy