Get an order
/v1/esim/orders/{order_id}bird esim orders get <order-id>curl -X GET "https://us1.platform.bird.com/v1/esim/orders/{order_id}" \
-H "Authorization: Bearer $TOKEN"{
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z",
"id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
"status": "scheduled",
"mode": "live",
"offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
"zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
"esim_id": "esm_01krdgeqcxet5s7t44vh8rt9mg",
"subscriber_id": "esub_01krdgeqcxet5s7t44vh8rt9mg",
"recurring_subscription_id": "ers_01krdgeqcxet5s7t44vh8rt9mg",
"package_id": "epk_01krdgeqcxet5s7t44vh8rt9mg",
"price": {
"amount": "0.00995",
"currency_code": "USD"
},
"wallet_transaction_id": "wtx_01krdgeqcxet5s7t44vh8rt9mg",
"refund_transaction_id": "wtx_01krdgeqcxet5s7t44vh8rt9mg",
"delivery": {
"to": "traveler@example.com",
"channel": "email",
"locale": "pt-BR"
},
"funding": {
"required_amount": {
"amount": "0.00995",
"currency_code": "USD"
},
"lapses_at": "2026-09-08T14:51:01Z"
},
"failure_code": "insufficient_balance"
}
Returns one order. Poll until status is completed or failed; a completed order names the eSIM and package it produced.
Parameters
order_idstringOrder ID.
Response Payload
created_atupdated_atidstatusmodeoffer_idOffer purchased.
offer_revisionRevision of the offer this order locked at creation. The quoted price stays that of this revision even if the offer changes later. The produced package snapshots its coverage at purchase; the zone's live country list governs new sales only.
zone_idCoverage zone of the purchased offer, captured at creation.
esim_idThe eSIM the package lands on. Set at creation when adding to an existing eSIM; set when provisioning starts for a new-eSIM order; null before that.
subscriber_idSubscriber to assign when the new eSIM is delivered. Null when none was requested, including top-up orders, which retain the existing assignment.
recurring_subscription_idThe recurring service associated with this purchase. Absent for one-time orders.
package_idThe purchased data package, set when the order completes; null before that.
priceThe quoted price, locked at creation in your billing currency. A mode: test order quotes this price and is never charged it, so its wallet_transaction_id stays null.
wallet_transaction_idThe wallet transaction that paid for this order, for reconciling against your billing transactions. Null until the charge lands, and always null for a mode: test order, which is never charged.
refund_transaction_idThe wallet transaction that credited the charge back after a failure. Null unless the order failed after charging.
deliveryWhere install credentials are delivered once available. Present when requested at creation.
fundingDetails of an insufficient-funds attempt while the order is in charging. May be null even while the order is awaiting funds; a null value does not confirm payment. Check the order status and your wallet balance.
failure_codeReason the order failed. Null unless status is failed. Handle unrecognized codes without assuming the purchase succeeded.
canceled: canceled while awaiting funds.resolved_by_support: support closed an unresolved order as failed.esim_released: the target profile became unavailable before delivery.mode_mismatch: the purchase could not be fulfilled in its original live or test mode.
Any charge is credited automatically. Check refund_transaction_id to confirm an issued credit.
Possible values (may grow over time): insufficient_balance, carrier_error, capacity_exhausted, offer_unavailable, internal_error, canceled, resolved_by_support, esim_released, mode_mismatch
failure_reasonWhy the order failed, in plain terms. Null unless status is failed.
completed_atWhen the order reached completed. Null before that.
Gerelateerde bronnen
Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.