esims

List an eSIM's data packages

Returns the eSIM's data packages with per-zone balances, validity, and status, newest first and in full: an eSIM holds at most package_limit concurrent packages. Balances update as mobile networks report usage; balance.as_of tells you how fresh they are.

get/v1/esim/sims/{esim_id}/packages

Request

Base URL: https://us1.platform.bird.com
URL: https://us1.platform.bird.com/v1/esim/sims/{esim_id}/packages
Auth: one of:
- HTTP bearer
- API key in cookie bird_session

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

The eSIM's packages.

Example response

{
  "data": [
    {
      "id": "epk_01krdgeqcxet5s7t44vh8rt9mg",
      "order_id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
      "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
      "zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
      "zone_name": "Europe",
      "countries": [
        "US"
      ],
      "price": {
        "amount": "0.00995",
        "currency_code": "EUR"
      }
    }
  ]
}

Changes

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