Allo

Obtenir l'offre eSIM

Renvoie les frais de mise en service d'une eSIM, les paliers de données et les recharges de données que vous pouvez acheter pour l'un de vos comptes…

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

Renvoie les frais de mise en service d'une eSIM, les paliers de données et les recharges de données que vous pouvez acheter pour l'un de vos comptes. Appelez-le avant Commander une eSIM, Changer le palier d'une eSIM ou Acheter une recharge de données eSIM pour afficher ou vérifier le prix.

  • Les prix suivent l'abonnement que vous payez pour ce compte : sa devise, sa périodicité de facturation et votre remise partenaire. Deux comptes sur des périodicités différentes ont des offres différentes.
  • Les montants sont exprimés hors taxes, dans la plus petite unité de la devise (centimes pour l'EUR).
  • Les montants de l'exemple de réponse sont fictifs : les prix réels sont ceux que cet endpoint renvoie pour le compte.
  • setup_price_cents correspond à des frais uniques par eSIM. Ils sont débités avec la première période du palier.
  • tiers[].price_cents est le prix du palier par période de facturation (interval). Passez un tiers[].code comme tier à la commande ou au changement de palier.
  • tiers[].data_mb est la quantité de données mobiles incluse dans le palier chaque mois civil, en Mo (1 Go = 1024 Mo).
  • top_ups[] liste les recharges que vous pouvez acheter pour une eSIM de ce compte : TOPUP_5GB (5120 Mo), TOPUP_10GB (10240 Mo) et TOPUP_20GB (20480 Mo). Passez un top_ups[].code comme code à Acheter une recharge de données eSIM.
  • top_ups[].price_cents est un prix unique, dans la même devise que les paliers. Une recharge ajoute ses data_mb à l'eSIM pour le mois civil en cours (heure de Paris). Les données de recharge non utilisées sont perdues à la fin de ce mois.
  • Vous ne pouvez consulter l'offre que des comptes créés par votre propre clé API. Tout autre id échoue avec PARTNER_ACCOUNT_NOT_FOUND.
  • Si les eSIM ne peuvent pas être commandées pour ce compte pour le moment, la requête échoue avec ESIM_UNAVAILABLE.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

account_idstringrequis

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

Réponses

200eSIM offer for the account
dataobject
5 champs
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 champs
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 champs
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