Sign inGet Started

Get a data package

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

Parametri

esim_idstring

eSIM ID.

package_idstring

Data package ID.

Payload di risposta

id
string
obbligatorio
order_id
string
obbligatorio

The order that purchased this package.

offer_id
string
obbligatorio

Offer this package was purchased from.

zone_id
string
obbligatorio

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
obbligatorio

Coverage zone name, from the offer.

countries
array of string
obbligatorio

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

status
string
obbligatorio
speed
string
obbligatorio

Speed class, from the offer.

balance
object
obbligatorio
Mostra attributi secondari
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
obbligatorio

What your workspace was billed for this package.

Mostra attributi secondari
price.amount
string
obbligatorio

Decimal amount as a string, in major currency units.

price.currency_code
string
obbligatorio

ISO 4217 currency code.

created_at
string
obbligatorio

Continua con la documentazione, le guide e gli esempi per questo argomento.