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

Get eSIM checkout options

GET
/v1/esim/offers/{offer_id}/checkout
bird esim offers checkout-options <offer-id>
Antwort200
{
  "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "one_time": {
    "offer_revision": 1,
    "price": {
      "amount": "1.00",
      "currency_code": "EUR"
    },
    "funding": {
      "tax_amount": {
        "amount": "0.21",
        "currency_code": "EUR"
      },
      "total": {
        "amount": "1.21",
        "currency_code": "EUR"
      },
      "covered": true,
      "shortfall": {
        "amount": "0",
        "currency_code": "EUR"
      }
    }
  },
  "recurrence": {
    "available": true,
    "quote": {
      "delivery_mode": "exact_period",
      "offer_revision": 1,
      "recurrence_revision": 2,
      "price": {
        "amount": "2.00",
        "currency_code": "EUR"
      },
      "model": "calendar_month",
      "interval_count": 1,
      "funding": {
        "tax_amount": {
          "amount": "0.42",
          "currency_code": "EUR"
        },
        "total": {
          "amount": "2.42",
          "currency_code": "EUR"
        },
        "covered": false,
        "shortfall": {
          "amount": "1.21",
          "currency_code": "EUR"
        }
      }
    },
    "unavailable_reason": null
  }
}

Returns published one-time terms and automatic renewal availability for a new eSIM, including tax-inclusive totals and current funding shortfalls. Automatic renewal includes its own price and cadence when an eligible mobile network is available. Availability and funding are checked again when purchasing; this read reserves no funds or package.

Parameter

offer_idstring

The offer.

Antwort-Payload

offer_id
string
erforderlich
one_time
object
erforderlich

Published one-time price and current funding requirement. The price excludes tax; funding.total includes tax.

Untergeordnete Attribute anzeigen
recurrence
object
erforderlich

When available is true, quote contains the recurring terms and unavailable_reason is null. Otherwise quote is null and unavailable_reason explains why renewal is unavailable.

Untergeordnete Attribute anzeigen
recurrence.available
boolean
erforderlich

Whether automatic renewal is currently available for a new eSIM.

recurrence.quote
nullable object
erforderlich
Untergeordnete Attribute anzeigen
recurrence.quote.funding
object
erforderlich

Current funding needed for this purchase, including tax and approved credit. The quoted price excludes tax; total includes tax for this purchase. This read reserves no funds; payment checks funding again. Test purchases have zero tax and total and are always covered.

Untergeordnete Attribute anzeigen
recurrence.quote.funding.tax_amount
object
erforderlich

Tax included in the purchase total.

Untergeordnete Attribute anzeigen
recurrence.quote.funding.tax_amount.amount
string
erforderlich

Decimal amount as a string, in major currency units.

recurrence.quote.funding.tax_amount.currency_code
string
erforderlich

ISO 4217 currency code.

recurrence.quote.funding.total
object
erforderlich

Total wallet charge for this purchase, including tax.

Untergeordnete Attribute anzeigen
recurrence.quote.funding.covered
boolean
erforderlich

Whether the wallet can currently cover this purchase after reservations and approved credit.

recurrence.quote.funding.shortfall
nullable object
erforderlich

Additional funds needed to cover this purchase, or null without organization billing read permission. Zero when covered is true.

Untergeordnete Attribute anzeigen
recurrence.quote.delivery_mode
string
erforderlich

Relationship between the paid period and package delivery.

  • exact_period: the package covers the accepted paid interval.
  • recurring_top_up: each funded period purchases a standard package. Activation, expiry, and accumulation follow that package’s terms.

Possible values: exact_period, recurring_top_up

recurrence.quote.offer_revision
integer
erforderlich

The offer revision to accept when purchasing.

recurrence.quote.recurrence_revision
integer
erforderlich

The recurring configuration revision to accept when purchasing.

recurrence.quote.price
object
erforderlich

Price before tax for the first period and each renewal.

Untergeordnete Attribute anzeigen
recurrence.quote.model
string
erforderlich

Billing cadence for recurring packages.

  • calendar_month: periods follow calendar months from the billing anchor.
  • fixed_days: each period lasts the stated number of 24-hour days.

Possible values: calendar_month, fixed_days

recurrence.quote.interval_count
integer
erforderlich

The number of calendar months or fixed 24-hour days per period.

recurrence.unavailable_reason
nullable string
erforderlich

Verwandte Ressourcen

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

Implementierungs-Briefing erhalten