bird esim offers list
Usage
代码示例
bird esim offers list [flags]Description
List the prepaid travel eSIM offers available to this workspace as a cursor page ({data, next_cursor, ...}). Filter by country (ISO 3166-1 alpha-2) to find offers that cover a destination, or by zone_id for one coverage footprint. Each row carries the offer's pricing (data allowance, validity, and the price billed per provisioned package) and its zone_id; fetch the offer or the zone for the country list.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Procedure
Step 2 of 8 of "Buy and install an eSIM data package". Previous: bird esim zones list. Next: bird esim offers checkout-options.
Examples
代码示例
bird esim offers list
bird esim offers list | jq -r '.data[].id'
bird esim offers list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
--country | Keep only offers whose coverage zone includes this country (ISO 3166-1 alpha-2). |
--response-schema | Print the fields this command returns, then exit |
--status | Filter by offer availability. Omitted, only active offers are returned. Possible values: draft, active, retired. |
--zone-id | Keep only offers selling this coverage zone. |
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. |
--include-total | When true, the response includes a total field with the total number of items matching the request's filters across all pages. |
--limit <n> | Maximum number of items to return per page. Allowed range: 1 to 100. |
--order | Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc. |
--sort | Field to sort by. Possible values: created_at. Possible values: created_at. |
--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 offers checkout-options | Get eSIM checkout options |
bird esim offers get | Get an eSIM offer |
bird esim offers recurrence | Get recurring eSIM offer terms |
bird esim offers requirements | Get country identification requirements for an eSIM offer |