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.
参数
esim_idstringeSIM ID.
package_idstringData package ID.
响应载荷
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.
balance显示子属性
balance.total_bytesTotal data in bytes, as purchased. Known from the order, so never null.
balance.used_bytesData used in bytes, or null while no network has reported on this package.
balance.remaining_bytesData remaining in bytes, or null while no network has reported on this package.
balance.used_percentShare of the total data already used, as a percentage. Null while no network has reported on this package.
balance.as_ofWhen 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_atMeasurement time supplied by the mobile network. Null when no measurement or measurement time is available. Use as_of for the balance update time.
activated_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.
created_at