Sign inGet Started
Mulai sekarang
Panduan
Referensi API
SDK
CLI
Basis Pengetahuan
Changelog

Get a data package

GET
/v1/esim/sims/{esim_id}/packages/{package_id}
bird esim packages get <esim-id> <package-id>
Respons200
{
  "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.

Parameter

esim_idstring

eSIM ID.

package_idstring

Data package ID.

Payload Respons

id
string
wajib
order_id
string
wajib

The order that purchased this package.

offer_id
string
wajib

Offer this package was purchased from.

zone_id
string
wajib

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
wajib

Coverage zone name, from the offer.

countries
array of string
wajib

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

status
string
wajib
speed
string
wajib

Speed class, from the offer.

balance
object
wajib
Tampilkan atribut turunan
balance.total_bytes
integer
wajib

Total data in bytes, as purchased. Known from the order, so never null.

balance.used_bytes
nullable integer
wajib

Data used in bytes, or null while no network has reported on this package.

balance.remaining_bytes
nullable integer
wajib

Data remaining in bytes, or null while no network has reported on this package.

balance.used_percent
nullable number
wajib

Share of the total data already used, as a percentage. Null while no network has reported on this package.

balance.as_of
string
wajib

When the balance was last established. Before consumption is reported, this is the package delivery time. Check whether the consumption fields are null before treating this timestamp as a usage update.

balance.observed_at
nullable string
wajib

Measurement time supplied by the mobile network. Null when no measurement or measurement time is available. Use as_of for the balance update time.

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
wajib

What your workspace was billed for this package.

Tampilkan atribut turunan
created_at
string
wajib

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini.

Dapatkan ringkasan implementasi