Sign inGet Started

Get a data package

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

Paramètres

esim_idstring

eSIM ID.

package_idstring

Data package ID.

Contenu de la réponse

id
string
obligatoire
order_id
string
obligatoire

The order that purchased this package.

offer_id
string
obligatoire

Offer this package was purchased from.

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.

zone_name
string
obligatoire

Coverage zone name, from the offer.

countries
array of string
obligatoire

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

status
string
obligatoire
speed
string
obligatoire

Speed class, from the offer.

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

What your workspace was billed for this package.

Afficher les attributs enfants
price.amount
string
obligatoire

Decimal amount as a string, in major currency units.

price.currency_code
string
obligatoire

ISO 4217 currency code.

created_at
string
obligatoire

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