List orders
/v1/esim/ordersbird esim orders listcurl -X GET "https://us1.platform.bird.com/v1/esim/orders" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"{
"data": [
{
"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"
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns the workspace's orders as a cursor-paginated list, newest first. Filter by status to find in-flight or failed purchases, by esim_id for one eSIM's purchase history, or by mode to separate test purchases from real ones. Test orders are listed alongside real ones by default, each carrying its own mode.
Query Parameters
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
created_afterstringLimits the response to resources created at or after this timestamp. Combine it with created_before to select a time window. Use an RFC 3339 timestamp with a timezone offset.
created_beforestringLimits the response to resources created before this timestamp. Combine it with created_after to select a time window. Use an RFC 3339 timestamp with a timezone offset.
statusarrayKeep only orders whose status matches; repeat the parameter to match any of several.
esim_idstringKeep only orders for this eSIM.
modestringKeep only orders created in this mode. Without it, both live and test orders are returned.
Possible values: live, test
completed_afterstringKeep only orders completed at or after this timestamp. Combine it with completed_before to select a completion window, which is what the analytics spend and completion figures are counted by; created_after selects when an order was placed instead. Orders that never completed are excluded. Use an RFC 3339 timestamp with a timezone offset.
completed_beforestringKeep only orders completed before this timestamp. Combine it with completed_after to select a completion window. Orders that never completed are excluded. Use an RFC 3339 timestamp with a timezone offset.
Response Payload
next_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
Related resources
Continue with the documentation, guides and examples for this topic.