Get eSIM
curl --request GET \
--url https://api.withallo.com/v2/api/partner/esims/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.withallo.com/v2/api/partner/esims/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.withallo.com/v2/api/partner/esims/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withallo.com/v2/api/partner/esims/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.withallo.com/v2/api/partner/esims/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.withallo.com/v2/api/partner/esims/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/esims/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-575966AF3661061265263C58882BC409D2A427B8",
"partner_client_ref": "crm-12345",
"phone_number": "+33745805999",
"tier": "ESIM_20GB",
"scheduled_tier": null,
"scheduled_tier_at": null,
"status": "ACTIVE",
"failure_code": null,
"data": {
"used_mb": 3172,
"allowance_mb": 25600,
"remaining_mb": 22428,
"cycle_started_at": "2026-10-31T23:00:00",
"cycle_ends_at": "2026-11-30T23:00:00"
},
"created_at": "2026-10-14T10:05:00"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}eSIM
Obtenir une eSIM
Returns the status of an eSIM you ordered, its current tier and, once it is ACTIVE, its mobile data use this month. Use it to poll for readiness if you do not receive webhooks. Requires the PARTNER scope.
GET
/
v2
/
api
/
partner
/
esims
/
{id}
Get eSIM
curl --request GET \
--url https://api.withallo.com/v2/api/partner/esims/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.withallo.com/v2/api/partner/esims/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.withallo.com/v2/api/partner/esims/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withallo.com/v2/api/partner/esims/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.withallo.com/v2/api/partner/esims/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.withallo.com/v2/api/partner/esims/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/esims/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-575966AF3661061265263C58882BC409D2A427B8",
"partner_client_ref": "crm-12345",
"phone_number": "+33745805999",
"tier": "ESIM_20GB",
"scheduled_tier": null,
"scheduled_tier_at": null,
"status": "ACTIVE",
"failure_code": null,
"data": {
"used_mb": 3172,
"allowance_mb": 25600,
"remaining_mb": 22428,
"cycle_started_at": "2026-10-31T23:00:00",
"cycle_ends_at": "2026-11-30T23:00:00"
},
"created_at": "2026-10-14T10:05:00"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Scope requis :
PARTNERpartner.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é.
status | Signification |
|---|---|
PROVISIONING | L’eSIM est commandée mais pas encore prête. Cela prend en général 5 à 15 minutes. |
ACTIVE | L’eSIM est prête. Les appels vers le numéro sonnent sur l’eSIM. Obtenez le code d’activation pour la remettre à votre client. |
FAILED | La commande n’a pas abouti. failure_code en donne la raison. |
REVOKED | L’eSIM a été révoquée, ou remplacée par une eSIM plus récente sur le même numéro. Elle ne fonctionne plus sur son téléphone, et les appels vers le numéro sonnent sur les apps Allo. |
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
tierest 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_tierest le palier vers lequel une baisse prévue fera passer l’eSIM, etscheduled_tier_atla date à laquelle elle s’applique, à la fin de la période déjà payée. Les deux valentnullquand 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.
| Champ | Signification |
|---|---|
used_mb | Données mobiles utilisées ce mois-ci, en Mo. null tant que le réseau ne l’a pas encore remontée. |
allowance_mb | Données mobiles dont l’eSIM dispose ce mois-ci, en Mo : les données du palier plus les recharges achetées ce mois-ci. |
remaining_mb | allowance_mb moins used_mb, en Mo, jamais en dessous de 0. null quand used_mb vaut null. |
cycle_started_at | Début du mois en cours, en UTC. |
cycle_ends_at | Fin du mois en cours, en UTC. Le mois suivant commence à cette heure-là. |
- 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_lowquand l’eSIM a utilisé 80 % de son quota, etpartner.esim.data_exhaustedquand elle l’a utilisé en entier. Inutile d’interroger cet endpoint pour surveiller les données.
Cette page vous a-t-elle été utile ?