Sign inGet Started

List an eSIM's data packages

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

Paramètres

esim_idstring

eSIM ID.

Contenu de la réponse

data
array of object
obligatoire

Packages, newest first.

Afficher les attributs enfants
data.id
string
obligatoire
data.order_id
string
obligatoire

The order that purchased this package.

data.offer_id
string
obligatoire

Offer this package was purchased from.

data.zone_id
string
obligatoire

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
obligatoire

Coverage zone name, from the offer.

data.countries
array of string
obligatoire

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

data.status
string
obligatoire

Lifecycle state of a data package.

  • provisioning: being applied to the eSIM.
  • pending_first_use: confirmed; activates on first use in its coverage zone.
  • active: consuming data; validity is running.
  • depleted: balance fully used.
  • expired: validity ended; unused balance is gone.
  • removing: a removal was requested and is being applied. On definitive rejection the package returns to its prior status, reported by esim.operation_failed.
  • removed: taken off the eSIM at your request; remaining balance forfeited.
  • failed: could not be applied; any charge is credited back automatically through the owning order, which reports this through its failed status and the esim.order.failed event.

Possible values: provisioning, pending_first_use, active, depleted, expired, removing, removed, failed

data.speed
string
obligatoire

Speed class, from the offer.

Possible values: full, reduced

data.balance
object
obligatoire

Package allowance and reported consumption. total_bytes is the purchased allowance. used_bytes, remaining_bytes, and used_percent are null until usage is reported. Reports can lag device usage; use as_of to show when the balance was updated.

Afficher les attributs enfants
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
obligatoire

What your workspace was billed for this package.

Afficher les attributs enfants
data.price.amount
string
obligatoire

Decimal amount as a string, in major currency units.

data.price.currency_code
string
obligatoire

ISO 4217 currency code.

data.created_at
string
obligatoire

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.