---
title: "bird esim orders list"
description: "List orders"
canonical: "https://bird.com/docs/cli/reference/esim-orders-list"
---

# `bird esim orders list`

## Usage

```bash
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

```bash
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`](/docs/cli/reference/esim-orders-cancel) | Cancel an unfunded order |
| [`bird esim orders create`](/docs/cli/reference/esim-orders-create) | Order a data package     |
| [`bird esim orders get`](/docs/cli/reference/esim-orders-get)       | Get an order             |

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)