Get an eSIM offer · API reference — Bird
Get an eSIM offer
GET
/v1/esim/offers/{offer_id}
CLIcURL
bird esim offers get <offer-id>
curl -X GET "https://us1.platform.bird.com/v1/esim/offers/{offer_id}" \
-H "Authorization: Bearer $TOKEN"
Response 200
{
"id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
"name": "Europe 10 GB / 30 days",
"zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
"zone": {
"id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
"name": "Europe",
"type": "local",
"countries": [
"US"
]
},
"speed": "full",
"phone": {
"included": "always",
"voice_inbound": false,
"voice_outbound": false,
"sms_inbound": true,
"sms_outbound": false
},
"pricing": {
"data": {
"amount_bytes": 10737418240
},
"validity": {
"type": "one_time",
"unit": "day",
"value": 30
},
"price": {
"amount": "0.00995",
"currency_code": "USD"
}
},
"product": "email_sends",
"status": "draft"
}
Returns one eSIM offer with its pricing and embedded coverage zone.
Parameters
offer_id string
Offer ID.
Response Payload
id
string
required
name
string
required
Display name of the offer.
revision
integer
required
Increments whenever the offer's terms change. Orders lock the revision they were quoted at.
zone_id
string
required
Coverage zone the offer sells. Offers for the same footprint share one zone.
zone
object
required
The offer's coverage zone, embedded so one read answers "where does this work". The zone resource is authoritative.
speed
string
required
Speed class. For reduced-speed offers, the bundle's data.throttled_after_bytes carries the full-speed allowance.
Possible values: full, reduced
stackable
boolean
required
Whether packages from this offer can be held alongside packages from other zones on the same eSIM, subject to the eSIM's package_limit.
phone
nullable object
required
Phone service that comes with the plan, or null when the plan includes no phone number. When present, included says how the number is provided and the flags state which call and text directions work.
pricing
object
required
Commercial terms of the offer. Every offer in the current catalog is a bundle: a fixed allowance with a validity period for a fixed price. Match on the pricing type; treat an unrecognized type as an offer your integration cannot order yet.
product
string
required
Billing product the offer's charges post under, as it appears on your invoice line items.
status
string
required
Availability of an offer.
draft: being curated; never returned on the customer surface and not purchasable.active: purchasable.retired: no longer purchasable; packages already sold are unaffected.
Possible values: draft, active, retired
created_at
string
required