Sign inGet Started
立即开始
指南
API 参考
SDK
CLI
知识库
更新日志

Get an eSIM offer

GET
/v1/esim/offers/{offer_id}
bird esim offers get <offer-id>
响应200
{
  "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.

参数

offer_idstring

Offer ID.

响应载荷

id
string
必填
name
string
必填

Display name of the offer.

revision
integer
必填

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

zone_id
string
必填

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

zone
object
必填

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

显示子属性
speed
string
必填

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

stackable
boolean
必填

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
必填

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.

显示子属性
phone.included
string
必填

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
必填

The eSIM can receive calls on its phone number.

phone.voice_outbound
boolean
必填

The eSIM can place calls.

phone.sms_inbound
boolean
必填

The eSIM can receive text messages on its phone number.

phone.sms_outbound
boolean
必填

The eSIM can send text messages.

pricing
object
必填

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.

显示子属性
product
string
必填

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

status
string
必填
created_at
string
必填

相关资源

继续查看此主题的文档、指南和示例。

获取实施简报