bird esim orders list
Usage
Code example
bird esim orders list [flags]Description
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.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Code example
bird esim orders list
bird esim orders list | jq -r '.data[].id'
bird esim orders list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
--completed-after | Keep 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-before | Keep 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. |
--created-after | Limits 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-before | Limits 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. |
--esim-id | Keep only orders for this eSIM. |
--mode | Keep only orders created in this mode. Without it, both live and test orders are returned. Possible values: live, test. |
--response-schema | Print the fields this command returns, then exit |
--status <value>… | Keep only orders whose status matches; repeat the parameter to match any of several. Possible values: scheduled, charging, provisioning, pending, completed, failed, canceled. |
Pagination
| Name | Description |
|---|---|
--ending-before | Cursor 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. |
--limit <n> | Maximum number of items to return per page. Allowed range: 1 to 100. |
--starting-after | Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order. |
Related
| Name | Description |
|---|---|
bird esim orders cancel | Cancel an unfunded order |
bird esim orders create | Order a data package |
bird esim orders get | Get an order |
Related resources
Continue with the documentation, guides and examples for this topic.