Get a data package
/v1/esim/sims/{esim_id}/packages/{package_id}bird esim packages get <esim-id> <package-id>curl -X GET "https://us1.platform.bird.com/v1/esim/sims/{esim_id}/packages/{package_id}" \
-H "Authorization: Bearer $TOKEN"{
"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_idstringeSIM ID.
package_idstringData package ID.
Response Payload
idorder_idThe order that purchased this package.
offer_idOffer this package was purchased from.
zone_idCoverage zone the package draws on. The name and countries below are captured at purchase time; the zone resource carries the live footprint.
zone_nameCoverage zone name, from the offer.
countriesCountries the package's zone covers, captured at purchase time so the package is meaningful without fetching the offer.
statusspeedSpeed class, from the offer.
balanceactivated_atWhen the package started consuming data (first use in its zone). Null until then.
expires_atWhen 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.
priceWhat your workspace was billed for this package.
Show child attributes
price.amountDecimal amount as a string, in major currency units.
price.currency_codeISO 4217 currency code.
created_atRelated resources
Continue with the documentation, guides and examples for this topic.