Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Get a data package

GET
/v1/esim/sims/{esim_id}/packages/{package_id}
bird esim packages get <esim-id> <package-id>
Response200
{
  "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 one data package with its balance, validity, speed class, and status.

Parameters

esim_idstring

eSIM ID.

package_idstring

Data package ID.

Response Payload

id
string
required
order_id
string
required

The order that purchased this package.

offer_id
string
required

Offer this package was purchased from.

zone_id
string
required

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

zone_name
string
required

Coverage zone name, from the offer.

countries
array of string
required

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

status
string
required

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

speed
string
required

Speed class, from the offer.

Possible values: full, reduced

balance
object
required

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.

Show child attributes
activated_at
nullable string

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

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.

price
object
required

What your workspace was billed for this package.

Show child attributes
created_at
string
required

Related resources

Continue with the documentation, guides and examples for this topic.

Get an implementation brief