Sign inGet Started

List an eSIM's data packages

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

参数

esim_idstring

eSIM ID.

响应载荷

data
array of object
必填

Packages, newest first.

显示子属性
data.id
string
必填
data.order_id
string
必填

The order that purchased this package.

data.offer_id
string
必填

Offer this package was purchased from.

data.zone_id
string
必填

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
必填

Coverage zone name, from the offer.

data.countries
array of string
必填

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

data.status
string
必填
data.speed
string
必填

Speed class, from the offer.

data.balance
object
必填
显示子属性
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
必填

What your workspace was billed for this package.

显示子属性
data.price.amount
string
必填

Decimal amount as a string, in major currency units.

data.price.currency_code
string
必填

ISO 4217 currency code.

data.created_at
string
必填