Passer au contenu principal
POST
Order eSIM
Scope requis : PARTNER
Commande une eSIM pour l’un des numéros du compte et la débite sur votre crédit prépayé en priorité, puis sur votre carte enregistrée. La réponse renvoie l’eSIM avec le statut PROVISIONING. L’eSIM est en général prête 5 à 15 minutes plus tard, et Allo vous envoie alors le webhook partner.esim.ready.

Requête

  • phone_number est requis. Ce doit être l’un des numéros du compte ou de ses membres, créé avec number_preference.esim à true (voir Créer un compte, Ajouter un numéro et Ajouter un membre). Tout autre numéro échoue avec PARTNER_ESIM_NUMBER_NOT_FOUND ou ESIM_NOT_ELIGIBLE.
  • tier est requis : un code renvoyé par Obtenir l’offre eSIM, par exemple ESIM_20GB. Un code inconnu échoue avec INVALID_ESIM_TIER.
  • holder_id est optionnel : l’utilisateur Allo auquel l’eSIM est rattachée. Omettez-le pour que le compte lui-même en soit le titulaire. Pour le numéro d’un membre, envoyez l’id du membre renvoyé par Ajouter un membre ou Lister les membres. Cela vaut aussi pour un numéro que le membre a repris avec phone_number.
  • identity est requis : l’entreprise à laquelle la ligne est enregistrée. corporate_name, postal_address, postal_code (5 chiffres) et city sont requis. first_name, last_name, company_name, siret, naf et email sont optionnels. Un champ requis manquant échoue avec ESIM_IDENTITY_INCOMPLETE.

Facturation

  • Les frais de mise en service et la première période du palier sont facturés sur l’abonnement que vous payez pour le compte, avec votre remise partenaire appliquée. 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 commande et qu’aucune carte n’est enregistrée, la requête échoue avec 402 PARTNER_CREDIT_INSUFFICIENT. Rechargez votre crédit ou ajoutez une carte, puis réessayez avec une nouvelle Idempotency-Key.
  • Une carte qui exige 3D Secure est refusée avec 402 ESIM_PAYMENT_FAILED. Une carte refusée échoue de la même façon. Rien ne reste en attente : mettez à jour votre carte dans le portail partenaire, puis réessayez.
  • Un numéro dont l’eSIM a été révoquée peut recevoir une nouvelle eSIM. La nouvelle commande facture à nouveau les frais de mise en service. Si vous la passez juste après la révocation, elle reste PROVISIONING jusqu’à ce que le réseau mobile ait confirmé la révocation.
  • Si l’abonnement que vous payez pour le compte ne peut pas recevoir d’eSIM pour le moment, la requête échoue avec ESIM_SUBSCRIPTION_CONFLICT. Si l’erreur indique retryable: true, réessayez dans quelques minutes.

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 la même commande. 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 au numéro

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

account_id
string
requis

The account id returned by Create account (usr-*).

Corps

application/json
phone_number
string
requis

One of the account's numbers that can carry an eSIM: created, added or given to a member with number_preference.esim set to true.

Exemple:

"+33745805999"

tier
string
requis

A tier code from Get eSIM offer.

Exemple:

"ESIM_20GB"

identity
object
requis

The business the line is registered to.

holder_id
string | null

Optional. The Allo user the eSIM is registered to: the account itself by default, or the id of a member returned by Add member for the member's own number, including a number the member took over with phone_number.

Exemple:

null

Réponse

eSIM ordered

data
object