Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

Get an eSIM offer

GET
/v1/esim/offers/{offer_id}
bird esim offers get <offer-id>
Réponse200
{
  "id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Europe 10 GB / 30 days",
  "zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
  "zone": {
    "id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
    "name": "Europe",
    "type": "local",
    "countries": [
      "US"
    ]
  },
  "speed": "full",
  "phone": {
    "included": "always",
    "voice_inbound": false,
    "voice_outbound": false,
    "sms_inbound": true,
    "sms_outbound": false
  },
  "pricing": {
    "data": {
      "amount_bytes": 10737418240
    },
    "validity": {
      "type": "one_time",
      "unit": "day",
      "value": 30
    },
    "price": {
      "amount": "0.00995",
      "currency_code": "USD"
    }
  },
  "product": "email_sends",
  "status": "draft"
}

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

Paramètres

offer_idstring

Offer ID.

Contenu de la réponse

id
string
obligatoire
name
string
obligatoire

Display name of the offer.

revision
integer
obligatoire

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

zone_id
string
obligatoire

Coverage zone the offer sells. Offers for the same footprint share one zone.

zone
object
obligatoire

The offer's coverage zone, embedded so one read answers "where does this work". The zone resource is authoritative.

Afficher les attributs enfants
speed
string
obligatoire

Speed class. For reduced-speed offers, the bundle's data.throttled_after_bytes carries the full-speed allowance.

stackable
boolean
obligatoire

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

phone
nullable object
obligatoire

Phone service that comes with the plan, or null when the plan includes no phone number. When present, included says how the number is provided and the flags state which call and text directions work.

Afficher les attributs enfants
phone.included
string
obligatoire

How the plan provides a phone number.

  • always: a phone number is included with each eSIM purchased from the offer.
  • on_request: reserved for offers with an optional phone number; currently unavailable.

Possible values: always, on_request

phone.voice_inbound
boolean
obligatoire

The eSIM can receive calls on its phone number.

phone.voice_outbound
boolean
obligatoire

The eSIM can place calls.

phone.sms_inbound
boolean
obligatoire

The eSIM can receive text messages on its phone number.

phone.sms_outbound
boolean
obligatoire

The eSIM can send text messages.

pricing
object
obligatoire

Commercial terms of the offer. Every offer in the current catalog is a bundle: a fixed allowance with a validity period for a fixed price. Match on the pricing type; treat an unrecognized type as an offer your integration cannot order yet.

Afficher les attributs enfants
product
string
obligatoire

Billing product the offer's charges post under, as it appears on your invoice line items.

status
string
obligatoire
created_at
string
obligatoire

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation