Skip to main content
A partner here is a reseller on the Discounted licence contract: a business that resells Allo inside its own product or service. The Partner API lets a reseller create and manage its customers’ Allo accounts from its own software. The Partner API is optional. The partner portal creates and sets up accounts without code.

Getting partner access

The PARTNER scope is granted manually to approved resellers, and it cannot be self-issued. To become a reseller and receive a PARTNER-scoped key, see the Partner Program or write to [email protected]. Only Discounted licence (reseller) partners can create, price and deactivate accounts. Any other partner gets PARTNER_CONTRACT_CANNOT_PROVISION (or PARTNER_CANNOT_DEACTIVATE on deactivation). An account that is not an enabled partner gets PARTNER_ACCESS_REQUIRED.

Billing

Each account you create gets its own Business plan subscription, billed to your payment method at the interval you choose (MONTHLY or YEARLY). Allo charges the full period when the account is created, with your partner discount applied. There is no proration. Allo never charges your customer: you bill your customers yourself. Call Get account price to see what a new account will cost before you create it.

How to give an account an eSIM

An eSIM puts the account’s Allo number in your client’s phone, like a second SIM. Calls reach the phone over the French mobile network. eSIMs are available in France only, on numbers created for them.
1

Create the account with an eSIM number

Call Create account with number_preference: {"country": "FR", "esim": true}. Add a prefix, for example "7", to choose how the number starts. The account gets a French mobile number that can carry an eSIM.
2

Get the offer

Call Get eSIM offer to read the setup fee and the data tiers. The prices follow the subscription you pay for that account: its currency, its billing interval and your partner discount.
3

Order the eSIM

Call Order eSIM with the number, a tier and the identity of the business the line is registered to. Allo charges your payment method on file and returns the eSIM with status PROVISIONING. Send an Idempotency-Key header so a retry never charges you twice.
4

Wait for the eSIM to be ready

The eSIM is usually ready 5 to 15 minutes later. Allo then sends partner.esim.ready to your own webhook endpoint, not to the account’s. From that moment, calls to the number ring the eSIM. If the order fails, you receive partner.esim.failed instead. Without a webhook endpoint, poll Get eSIM.
5

Get the activation code

Call Get eSIM activation code. It returns a QR code, the values for manual entry, and the code to build a one-tap install link for iPhone.
6

Deliver the eSIM to your client

Send the QR code or the install link to your client, under your own brand. Your client installs the eSIM on their phone.
Allo never emails your client about the eSIM. You deliver the activation code yourself. Allo does not detect when your client installs the eSIM.

Endpoints