Sign inGet Started
शुरू करें
गाइड
API Reference
SDKs
CLI
Knowledge Base
Changelog

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.

Response Payload

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.

चाइल्ड एट्रिब्यूट दिखाएँ
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.

चाइल्ड एट्रिब्यूट दिखाएँ
pricing.type
string
आवश्यक

Pricing type.

Value: bundle

pricing.data
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
pricing.validity
object
आवश्यक

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.

चाइल्ड एट्रिब्यूट दिखाएँ
pricing.price
object
आवश्यक

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

चाइल्ड एट्रिब्यूट दिखाएँ
product
string
आवश्यक

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

status
string
आवश्यक
created_at
string
आवश्यक

संबंधित संसाधन

इस विषय के लिए दस्तावेज़, गाइड और उदाहरणों के साथ आगे बढ़ें।

इम्प्लीमेंटेशन ब्रीफ़ पाएँ