Passer au contenu principal
PUT
Change eSIM tier
Scope requis : PARTNER
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

  • tier est requis : un tiers[].code renvoyé par Obtenir l’offre eSIM, par exemple ESIM_20GB. ESIM est le palier sans données mobiles. Un code inconnu échoue avec INVALID_ESIM_TIER.
  • L’eSIM doit être ACTIVE. Tant qu’elle est en cours de provisionnement, la requête échoue avec ESIM_NOT_READY.

Réponse

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

Autorisations

Authorization
string
header
requis

En-têtes

Idempotency-Key
string

Optional. 8 to 100 letters, digits, - or _, for example a UUID. Retrying with the same key does not charge you twice.

Pattern: ^[A-Za-z0-9_-]{8,100}$

Paramètres de chemin

id
string
requis

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

Corps

application/json
tier
string
requis

A tier code from Get eSIM offer. ESIM is the tier with no mobile data.

Exemple:

"ESIM_20GB"

Réponse

Tier change accepted

data
object