Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Get eSIM checkout options

GET
/v1/esim/offers/{offer_id}/checkout
bird esim offers checkout-options <offer-id>
Response200
{
  "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "one_time": {
    "price": {
      "amount": "0.00995",
      "currency_code": "USD"
    }
  },
  "recurrence": {
    "available": true,
    "quote": {
      "delivery_mode": "exact_period",
      "price": {
        "amount": "0.00995",
        "currency_code": "USD"
      },
      "model": "calendar_month"
    }
  }
}

Returns published one-time terms and automatic renewal availability for a new eSIM. Automatic renewal includes its own price and cadence when an eligible mobile network is available. Availability is checked again when purchasing; this read does not reserve a package.

Parameters

offer_idstring

The offer.

Response Payload

offer_id
string
required
one_time
object
required

Published one-time purchase terms before tax.

Show child attributes
recurrence
object
required

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.

Show child attributes
recurrence.available
boolean
required

Whether automatic renewal is currently available for a new eSIM.

recurrence.quote
nullable object
required
Show child attributes
recurrence.quote.delivery_mode
string
required

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
required

The offer revision to accept when purchasing.

recurrence.quote.recurrence_revision
integer
required

The recurring configuration revision to accept when purchasing.

recurrence.quote.price
object
required
Show child attributes
recurrence.quote.price.amount
string
required

Decimal amount as a string, in major currency units.

recurrence.quote.price.currency_code
string
required

ISO 4217 currency code.

recurrence.quote.model
string
required

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
required

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

recurrence.unavailable_reason
nullable string
required

Related resources

Continue with the documentation, guides and examples for this topic.

Get an implementation brief