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

List offers an eSIM can take

GET
/v1/esim/sims/{esim_id}/compatible-offers
bird esim compatible-offers <esim-id>
Antwort200
{
  "data": [
    {
      "id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
      "name": "Europe 10 GB / 30 days",
      "zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
      "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 offers currently compatible with this eSIM’s network, package capacity, and existing packages. Use these offers for top-ups. Availability can change before purchase; refresh the list before ordering. An incompatible top-up returns 409.

Parameter

esim_idstring

Identifier of the eSIM.

Abfrageparameter

recurring_onlyboolean

Keep only offers with recurring service configured. Enrollment still checks supplier support and the published recurring price.

Antwort-Payload

data
array of object
erforderlich

Orderable top-up offers for this eSIM.

Untergeordnete Attribute anzeigen
data.id
string
erforderlich
data.name
string
erforderlich

Display name of the offer.

data.revision
integer
erforderlich

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

data.zone_id
string
erforderlich

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

data.speed
string
erforderlich

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

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

data.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
data.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
data.product
string
erforderlich

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

data.status
string
erforderlich
data.created_at
string
erforderlich
as_of
string
erforderlich

When this answer was computed.

Verwandte Ressourcen

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

Implementierungs-Briefing erhalten