esims

Get recurring eSIM offer terms

Returns the published whole-package recurring price and calendar-month or fixed-day cadence. Enrollment additionally checks that the assigned eSIM mobile network supports these terms.

get/v1/esim/offers/{offer_id}/recurrence

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/esim/offers/{offer_id}/recurrence
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The requested resource.

delivery_mode'exact_period' | 'recurring_top_up' 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.
offer_idstring required
model'calendar_month' | 'fixed_days' 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.
interval_countinteger required

The number of calendar months or fixed days in each period.

revisioninteger required

The recurring configuration revision to accept.

Example response

{
  "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "price": {
    "amount": "0.00995",
    "currency_code": "EUR"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.