WIwithallo
Partner

Order eSIM

Changed on

Orders an eSIM for one of the account's numbers. The setup fee and the first period of the tier are charged on the subscription you pay for the account: Allo draws on your prepaid credit first, then charges your card on file for the rest. The eSIM is returned with status PROVISIONING and is usually ready 5 to 15 minutes later: Allo then sends the partner.esim.ready webhook. A card that requires 3D Secure is refused with ESIM_PAYMENT_FAILED. Requires the PARTNER scope.

post/v2/api/partner/accounts/{account_id}/esims

Request

  • Base URL
    https://api.withallo.com
  • URL
    https://api.withallo.com/v2/api/partner/accounts/{account_id}/esims
  • Auth
    API key in header Authorization

Path parameters

account_idstring required

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

Headers

Idempotency-Keystring

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

Request body

phone_numberstring required

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.

tierstring required

A tier code from Get eSIM offer.

holder_idstring nullable

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.

Example request

{
  "phone_number": "+33745805999",
  "tier": "ESIM_20GB",
  "identity": {
    "corporate_name": "Plomberie Martin",
    "postal_address": "12 rue de la Paix",
    "postal_code": "75001",
    "city": "Paris",
    "first_name": "Jean",
    "last_name": "Martin",
    "company_name": "Plomberie Martin",
    "siret": "12345678900012",
    "naf": "4322A",
    "email": "jean@plomberie-martin.fr"
  }
}

Response

eSIM ordered

Example response

{
  "data": {
    "id": "eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
    "account_id": "usr-575966AF3661061265263C58882BC409D2A427B8",
    "partner_client_ref": "crm-12345",
    "phone_number": "+33745805999",
    "tier": "ESIM_20GB",
    "status": "PROVISIONING",
    "created_at": "2026-10-14T10:05:00"
  }
}

Changes