Passer au contenu principal
GET
Get eSIM
Scope requis : PARTNER
Renvoie le statut d’une eSIM que vous avez commandée, son palier et sa consommation de données mobiles ce mois-ci. Les webhooks partner.esim.ready et partner.esim.failed vous préviennent quand le statut change. Sans endpoint webhook, interrogez cet endpoint à la place, dans la limite de 20 requêtes de lecture par seconde et par clé. failure_code vaut null sauf si status vaut FAILED. Vous ne pouvez consulter que les eSIM commandées sur des comptes créés par votre propre clé API. Tout autre id échoue avec PARTNER_ESIM_NOT_FOUND.

Palier

  • tier est le palier actuel de l’eSIM. Il change quand une montée de palier demandée avec Changer le palier d’une eSIM est payée, ou quand une baisse prévue s’applique. D’ici là, c’est le palier commandé.
  • scheduled_tier est le palier vers lequel une baisse prévue fera passer l’eSIM, et scheduled_tier_at la date à laquelle elle s’applique, à la fin de la période déjà payée. Les deux valent null quand aucune baisse n’est prévue.

Consommation de données

data donne la consommation de données mobiles de l’eSIM pour le mois en cours. Il vaut null sauf si status vaut ACTIVE.
  • Le cycle est le mois civil, à l’heure de Paris. Les dates sont en UTC : en novembre 2026, le cycle va de 2026-10-31T23:00:00 à 2026-11-30T23:00:00.
  • Allo lit la consommation en direct sur le réseau à chaque appel. Elle peut avoir quelques minutes de retard sur l’usage réel.
  • Quand l’eSIM atteint son quota, les données mobiles s’arrêtent jusqu’au mois suivant ou jusqu’à l’achat d’une recharge. Les appels et les SMS continuent de fonctionner. La ligne n’est jamais facturée pour des données au-delà du quota.
  • Allo envoie partner.esim.data_low quand l’eSIM a utilisé 80 % de son quota, et partner.esim.data_exhausted quand elle l’a utilisé en entier. Inutile d’interroger cet endpoint pour surveiller les données.

Autorisations

Authorization
string
header
requis

Paramètres de chemin

id
string
requis

The eSIM id returned by Order eSIM (eso-*).

Réponse

eSIM

data
object