Allo

Get prepaid credit

Returns the prepaid credit you have left and your recent top-ups. Allo pays what you buy through the Partner API from this credit first, then charges your…

GET/v2/api/partner/credit

Returns the prepaid credit you have left and your recent top-ups. Allo pays every partner charge from this credit first.

How partner charges are paid

Everything you buy for your accounts is paid the same way: new accounts, their renewals, extra numbers, member seats and eSIMs.

  1. Allo draws on your prepaid credit first.
  2. If the credit does not cover the whole charge, Allo charges the rest to the card on your billing account.
  3. If the credit does not cover the charge and you have no card on file, the request fails with 402 PARTNER_CREDIT_INSUFFICIENT. Nothing is created and nothing is charged.

When you pay a prepaid credit invoice, its amount before tax is added to your balance. To top up your credit, write to [email protected].

Response

  • balance_cents is the credit left, in the smallest unit of currency (cents for EUR and USD). It is 0 before your first top-up.
  • currency is lowercase, for example eur. It is absent before your first top-up.
  • prepaid is true once at least one top-up was added to your credit.
  • last_top_up is your most recent top-up: amount_cents, currency and at. It is absent when you have none.
  • top_ups lists your 20 most recent top-ups, newest first. Each one has amount_cents (before tax), currency, invoice_id and at.

Only Discounted licence (reseller) partners can read the credit. Any other partner gets PARTNER_CONTRACT_CANNOT_PROVISION, and an account that is not an enabled partner gets PARTNER_ACCESS_REQUIRED.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Responses

200Your prepaid credit
dataobject
5 fields
balance_centsinteger<int64>

Credit left, in the smallest unit of currency. 0 before your first top-up.

currencystring

Lowercase ISO 4217 code of your billing account. Omitted before your first top-up.

prepaidboolean

true once at least one top-up was added to your credit.

last_top_upobject

Your most recent top-up. Omitted when there is none.

3 fields
amount_centsinteger<int64>
currencystring
atstring<date-time>
top_upsobject[]

Your 20 most recent top-ups, newest first.

4 fields
amount_centsinteger<int64>

Amount added to your credit, excluding tax.

currencystring
invoice_idstring

The invoice the top-up was paid with.

atstring<date-time>
401
403The API key lacks the PARTNER scope, your account is not an enabled partner (PARTNER_ACCESS_REQUIRED), or your partner contract cannot create accounts (PARTNER_CONTRACT_CANNOT_PROVISION).
errorobject
429