esim-offers

Get an eSIM offer

Returns one eSIM offer with its pricing and embedded coverage zone.

get/v1/esim/offers/{offer_id}

Request

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

Path parameters

offer_idstring required
Example:eof_01krdgeqcxet5s7t44vh8rt9mg

Offer ID.

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

idstring required
namestring required

Display name of the offer.

revisioninteger required

Increments whenever the offer's terms change. Orders lock the revision they were quoted at.

zone_idstring required
speed'full' | 'reduced' required

Speed class. full: data flows at full network speed until the allowance is used; reduced: speed is limited, typically after the full-speed allowance. Full-speed and reduced-speed packages cannot be combined on one eSIM.

stackableboolean required

Whether packages from this offer can be held alongside packages from other zones on the same eSIM, subject to the eSIM's package_limit.

productstring required

URL-safe identifier for a billing product. Lowercase letters and digits, separated by underscores. Must start with a letter.

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

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.
created_atstring date-time required

Example response

{
  "id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Europe 10 GB / 30 days",
  "zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
  "zone": {
    "id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
    "name": "Europe",
    "countries": [
      "US"
    ]
  },
  "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"
}

Changes

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