Change eSIM tier
curl --request PUT \
--url https://api.withallo.com/v2/api/partner/esims/{id}/tier \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"tier": "ESIM_20GB"
}
'import requests
url = "https://api.withallo.com/v2/api/partner/esims/{id}/tier"
payload = { "tier": "ESIM_20GB" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({tier: 'ESIM_20GB'})
};
fetch('https://api.withallo.com/v2/api/partner/esims/{id}/tier', 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}/tier",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'tier' => 'ESIM_20GB'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withallo.com/v2/api/partner/esims/{id}/tier"
payload := strings.NewReader("{\n \"tier\": \"ESIM_20GB\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.withallo.com/v2/api/partner/esims/{id}/tier")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tier\": \"ESIM_20GB\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/esims/{id}/tier")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tier\": \"ESIM_20GB\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"esim_id": "eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"tier": "ESIM_20GB",
"status": "PENDING",
"effective_at": null
}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}{
"error": {}
}{
"error": {}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}eSIM
Changer le palier d'une eSIM
Moves an eSIM to another data tier. An upgrade is charged now, prorated for the rest of the billing period: Allo draws on your prepaid credit first, then charges your card on file. The extra data is added within about a minute once the payment is confirmed. A downgrade is scheduled for the end of the period already paid, and nothing is refunded. A card that requires 3D Secure is refused with ESIM_PAYMENT_FAILED and the attempt is cancelled. Only the number’s latest eSIM can change tier. Requires the PARTNER scope.
PUT
/
v2
/
api
/
partner
/
esims
/
{id}
/
tier
Change eSIM tier
curl --request PUT \
--url https://api.withallo.com/v2/api/partner/esims/{id}/tier \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"tier": "ESIM_20GB"
}
'import requests
url = "https://api.withallo.com/v2/api/partner/esims/{id}/tier"
payload = { "tier": "ESIM_20GB" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({tier: 'ESIM_20GB'})
};
fetch('https://api.withallo.com/v2/api/partner/esims/{id}/tier', 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}/tier",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'tier' => 'ESIM_20GB'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withallo.com/v2/api/partner/esims/{id}/tier"
payload := strings.NewReader("{\n \"tier\": \"ESIM_20GB\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.withallo.com/v2/api/partner/esims/{id}/tier")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tier\": \"ESIM_20GB\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/esims/{id}/tier")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tier\": \"ESIM_20GB\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"esim_id": "eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"tier": "ESIM_20GB",
"status": "PENDING",
"effective_at": null
}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}{
"error": {}
}{
"error": {}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}Scope requis :
PARTNERRequête
tierest requis : untiers[].coderenvoyé par Obtenir l’offre eSIM, par exempleESIM_20GB.ESIMest le palier sans données mobiles. Un code inconnu échoue avecINVALID_ESIM_TIER.- L’eSIM doit être
ACTIVE. Tant qu’elle est en cours de provisionnement, la requête échoue avecESIM_NOT_READY.
Réponse
status | Signification |
|---|---|
ACTIVE | L’eSIM est déjà sur ce palier. Rien n’est débité. |
PENDING | Montée de palier. Allo la débite tout de suite, et les données en plus sont ajoutées en une minute environ, une fois le paiement confirmé. |
SCHEDULED | Baisse de palier. L’eSIM garde son palier actuel jusqu’à effective_at, la fin de la période déjà payée, puis passe au nouveau palier. Rien n’est remboursé. |
effective_at vaut null sauf si status vaut SCHEDULED. Obtenir une eSIM renvoie le tier actuel, la baisse prévue dans scheduled_tier et scheduled_tier_at, et le quota du mois dans data.allowance_mb.
Une montée de palier relève le quota : partner.esim.data_low et partner.esim.data_exhausted peuvent alors être envoyés à nouveau quand l’eSIM approche du nouveau quota.
Facturation
- Une montée de palier est facturée sur l’abonnement que vous payez pour le compte, au prorata du reste de la période de facturation en cours, avec votre remise partenaire appliquée. L’abonnement se renouvelle ensuite au prix du nouveau palier.
- Allo prélève d’abord votre crédit prépayé, puis débite le reste sur votre carte enregistrée. Allo ne facture jamais votre client.
- Si votre crédit prépayé ne couvre pas la montée de palier et qu’aucune carte n’est enregistrée, la requête échoue avec
402 PARTNER_CREDIT_INSUFFICIENT. - Une carte refusée, ou une carte qui exige 3D Secure, échoue avec
402 ESIM_PAYMENT_FAILED. Une validation 3D Secure est impossible via l’API : Allo annule la tentative et rien ne reste en attente. Réessayez avec une autre carte, mise à jour dans le portail partenaire, ou après avoir rechargé votre crédit prépayé. - Une baisse de palier ne débite rien et ne rembourse rien.
Nouvelles tentatives
Envoyez un en-têteIdempotency-Key (8 à 100 lettres, chiffres, - ou _, par exemple un UUID) et réutilisez-le pour réessayer le même changement. Une nouvelle tentative avec la même clé ne vous débite pas deux fois. Une clé dans un autre format échoue avec INVALID_IDEMPOTENCY_KEY.
Erreurs propres à l’eSIM
| Code | Signification |
|---|---|
ESIM_NOT_READY | L’eSIM est encore en cours de provisionnement. Attendez partner.esim.ready, puis réessayez. |
ESIM_NOT_ACTIVE | L’eSIM a été supprimée, ou le numéro a une commande d’eSIM plus récente. Seule la dernière eSIM du numéro peut être modifiée : utilisez son id, ou commandez une nouvelle eSIM avec Commander une eSIM. |
ESIM_TIER_CHANGE_CONFLICT | Une baisse de palier est déjà prévue pour cette eSIM. Elle ne peut pas être remplacée avant de s’appliquer, à scheduled_tier_at. |
ESIM_SUBSCRIPTION_CONFLICT | L’abonnement que vous payez pour le compte ne peut pas être débité pour des eSIM pour le moment. Si l’erreur indique retryable: true, réessayez dans quelques minutes. |
En-têtes
Corps
application/json
Cette page vous a-t-elle été utile ?