Allo

Get eSIM offer

Returns the eSIM setup fee, the data tiers you can order and the data top-ups you can buy for an account you provisioned, priced on the subscription you pay…

GET/v2/api/partner/accounts/{account_id}/esims/offer

Returns the eSIM setup fee, the data tiers and the data top-ups you can buy for one of your accounts. Call it before Order eSIM, Change eSIM tier or Buy eSIM top-up to show or check the price.

  • Prices come from the subscription you pay for that account: its currency, its billing interval and your partner discount. Two accounts on different intervals get different offers.
  • Amounts are in the smallest unit of the currency (cents for EUR), before tax.
  • The amounts in the example response are placeholders: the real prices are the ones this endpoint returns for the account.
  • setup_price_cents is a one-off fee per eSIM. It is charged with the first period of the tier.
  • tiers[].price_cents is the price of the tier per billing interval. Pass a tiers[].code as tier when you order or change the tier.
  • tiers[].data_mb is the mobile data the tier includes each calendar month, in MB (1 GB = 1024 MB).
  • top_ups[] lists the top-ups you can buy for an eSIM of this account: TOPUP_5GB (5120 MB), TOPUP_10GB (10240 MB) and TOPUP_20GB (20480 MB). Pass a top_ups[].code as code to Buy eSIM top-up.
  • top_ups[].price_cents is a one-off price, in the same currency as the tiers. A top-up adds its data_mb to the eSIM for the current calendar month (Paris time). Unused top-up data lapses at the end of that month.
  • You can only read the offer for accounts your own API key created. Any other id fails with PARTNER_ACCOUNT_NOT_FOUND.
  • If eSIMs cannot be ordered for this account right now, the request fails with ESIM_UNAVAILABLE.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

account_idstringrequired

The account id returned by Create account (usr-*).

Responses

200eSIM offer for the account
dataobject
5 fields
currencystring

Currency of the subscription you pay for the account.

intervalenum<string>

Billing interval of the tiers, the same as the account's subscription.

MONTHLYYEARLY

setup_price_centsinteger<int64>

One-off setup fee per eSIM, charged with the first tier period.

tiersobject[]
3 fields
codestring

Pass it as tier when you order or change the tier.

data_mbinteger<int64>

Mobile data included in the tier, in MB (1 GB = 1024 MB).

price_centsinteger<int64>

Price of the tier per billing interval.

top_upsobject[]

Data top-ups you can buy for an eSIM of this account. A top-up is charged once and adds data for the current calendar month (Paris time) only.

3 fields
codeenum<string>

Pass it as code when you buy a top-up.

TOPUP_5GBTOPUP_10GBTOPUP_20GB

data_mbinteger<int64>

Mobile data the top-up adds, in MB (1 GB = 1024 MB).

price_centsinteger<int64>

One-off price of the top-up, before tax.

401
403The API key lacks the PARTNER scope.
errorobject
404No account with this id was provisioned by your API key (PARTNER_ACCOUNT_NOT_FOUND).
errorobject
429
500eSIMs cannot be ordered for this account right now (ESIM_UNAVAILABLE).
errorobject