List an eSIM's data packages

GET

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

bird esim packages list <esim-id>

curl -X GET "https://us1.platform.bird.com/v1/esim/sims/{esim_id}/packages" \
  -H "Authorization: Bearer $TOKEN"

Response200

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

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.

Parameters

esim_idstring

eSIM ID.

Response Payload

data

array of object

required

Packages, newest first.

Show child attributes

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

bird esim packages list <esim-id>

curl -X GET "https://us1.platform.bird.com/v1/esim/sims/{esim_id}/packages" \
  -H "Authorization: Bearer $TOKEN"

Response200

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

List an eSIM's data packages

Parameters

Response Payload

Related resources