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 its customers' Allo accounts from its own software, check their price and deactivate them.
Once an account exists, its members, numbers and settings are managed in the Allo app, like for any Allo customer, not through the Partner API.
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.
Authentication
Send your PARTNER key in the Authorization header as Api-Key <your-key>, or as the raw key on its own. Do not use Bearer <your-key>: Allo reads a Bearer value as a user session token, so an API key sent that way returns 401.
curl https://api.withallo.com/v2/api/partner/credit \
-H "Authorization: Api-Key ak_live_your_key_here"
See Authentication for the header format and the scopes.
Billing
Each account you create gets its own Business plan subscription, billed to you 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.
Every partner charge is paid the same way: new accounts, their renewals, extra numbers, member seats and eSIMs.
- Allo draws on your prepaid credit first.
- If the credit does not cover the whole charge, Allo charges the rest to the card on your billing account.
- If the credit does not cover the charge and you have no card on file, the request fails with
402 PARTNER_CREDIT_INSUFFICIENT, and nothing is created.
Call Get account price to see what a new account will cost before you create it, and Get prepaid credit to check your balance.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /v2/api/partner/accounts/price | Get the price Allo will charge you for a new account |
POST | /v2/api/partner/accounts | Create an account, provision a number, return a scoped key |
GET | /v2/api/partner/accounts/{id} | Get an account's status and activation state |
DELETE | /v2/api/partner/accounts/{id} | Deactivate an account (cancels its subscription, the account works until the end of the paid period) |
GET | /v2/api/partner/credit | Get your prepaid credit balance and recent top-ups |