Fait passer une eSIM à un autre palier de données. Une montée de palier est débitée tout de suite et ajoute les données en plus en une minute environ. Une baisse de palier s'applique à la fin de la période déjà payée.
Requê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ête Idempotency-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. |