esim-offers

List eSIM offers

Returns the eSIM offers your workspace can order as a cursor-paginated list. Filter by country to find offers covering a destination (the zone's country list is the guarantee), or by zone_id for one coverage footprint. Retired offers are excluded unless requested via status.

get/v1/esim/offers

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/esim/offers
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

sort'created_at'

Field to sort offers by. Only created_at is supported.

Field to sort by. Possible values: created_at.

order'asc' | 'desc'

Sort direction, ascending or descending.

Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

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_totalboolean

When true, the response includes a total field with the total number of items matching the request's filters across all pages.

countrystring

ISO 3166-1 alpha-2 country code.

Example:US

Keep only offers whose coverage zone includes this country (ISO 3166-1 alpha-2).

zone_idstring
Example:ezn_01krdgeqcxet5s7t44vh8rt9mg

Keep only offers selling this coverage zone.

status'draft' | 'active' | 'retired'

Availability of an offer.

  • draft: being curated; never returned on the customer surface and not purchasable.
  • active: purchasable.
  • retired: no longer purchasable; packages already sold are unaffected.

Filter by offer availability. Omitted, only active offers are returned.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Paginated list of offers.

next_cursorstring nullable required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursorstring nullable required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursorstring nullable required

Refresh 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.

totalinteger nullable

Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.

Example response

{
  "data": [
    {
      "id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
      "name": "Europe 10 GB / 30 days",
      "zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
      "phone": {
        "included": "always",
        "voice_inbound": false,
        "voice_outbound": false,
        "sms_inbound": true,
        "sms_outbound": false
      },
      "pricing": {
        "data": {
          "amount_bytes": 10737418240
        },
        "validity": {
          "value": 30
        },
        "price": {
          "amount": "0.00995",
          "currency_code": "EUR"
        }
      },
      "product": "email_sends"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.