Sign inGet Started
Jetzt starten
Anleitungen
API-Referenz
SDKs
CLI
Wissensdatenbank
Changelog

Get an eSIM offer

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

Parameter

offer_idstring

Offer ID.

Antwort-Payload

id
string
erforderlich
name
string
erforderlich

Display name of the offer.

revision
integer
erforderlich

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

zone_id
string
erforderlich

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

zone
object
erforderlich

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

Untergeordnete Attribute anzeigen
speed
string
erforderlich

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

Possible values: full, reduced

stackable
boolean
erforderlich

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
erforderlich

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.

Untergeordnete Attribute anzeigen
pricing
object
erforderlich

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.

Untergeordnete Attribute anzeigen
pricing.type
string
erforderlich

Pricing type.

Value: bundle

pricing.data
object
erforderlich

Data allowance of a bundle.

Untergeordnete Attribute anzeigen
pricing.validity
object
erforderlich

Validity of packages created from this offer. The period starts at activation, which happens on first use in the coverage zone. The effective validity is capped by the eSIM's service period: see the package's expires_at for the real expiry.

Untergeordnete Attribute anzeigen
pricing.validity.type
string
erforderlich

How the validity period behaves. one_time runs once and expires; recurring renews for a further period each time it lapses.

Possible values: one_time, recurring

pricing.validity.unit
string
erforderlich

Unit of the validity period.

Possible values: day, month

pricing.validity.value
integer
erforderlich

Number of units per period.

pricing.validity.minimum_periods
nullable integer

For recurring offers, the minimum number of periods committed. Null when there is no minimum, and for one_time offers.

pricing.price
object
erforderlich

What your workspace is billed per package provisioned from this offer.

Untergeordnete Attribute anzeigen
product
string
erforderlich

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

status
string
erforderlich

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.

Possible values: draft, active, retired

created_at
string
erforderlich

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Implementierungs-Briefing erhalten