Allo

Obtenir le crédit prépayé

Renvoie le crédit prépayé qu'il vous reste et vos derniers rechargements. Allo paie chaque montant partenaire sur ce crédit en priorité.

GET/v2/api/partner/credit

Renvoie le crédit prépayé qu'il vous reste et vos derniers rechargements. Allo paie chaque montant partenaire sur ce crédit en priorité.

Comment les montants partenaires sont payés

Tout ce que vous achetez pour vos comptes se paie de la même façon : nouveaux comptes, renouvellements, numéros supplémentaires, sièges des membres et eSIM.

  1. Allo prélève d'abord votre crédit prépayé.
  2. Si le crédit ne couvre pas tout le montant, Allo débite le reste sur la carte de votre compte de facturation.
  3. Si le crédit ne couvre pas le montant et qu'aucune carte n'est enregistrée, la requête échoue avec 402 PARTNER_CREDIT_INSUFFICIENT. Rien n'est créé ni débité.

Quand vous réglez une facture de crédit prépayé, son montant hors taxes s'ajoute à votre solde. Pour recharger votre crédit, écrivez à [email protected].

Réponse

  • balance_cents est le crédit restant, dans la plus petite unité de currency (centimes pour EUR et USD). Il vaut 0 avant votre premier rechargement.
  • currency est en minuscules, par exemple eur. Il est absent avant votre premier rechargement.
  • prepaid vaut true dès qu'au moins un rechargement a été ajouté à votre crédit.
  • last_top_up est votre dernier rechargement : amount_cents, currency et at. Il est absent si vous n'en avez aucun.
  • top_ups liste vos 20 derniers rechargements, du plus récent au plus ancien. Chacun porte amount_cents (hors taxes), currency, invoice_id et at.

Seuls les partenaires Licence à prix réduit (revendeurs) peuvent lire ce crédit. Tout autre partenaire reçoit PARTNER_CONTRACT_CANNOT_PROVISION, et un compte qui n'est pas un partenaire activé reçoit PARTNER_ACCESS_REQUIRED.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Réponses

200Your prepaid credit
dataobject
5 champs
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 champs
amount_centsinteger<int64>
currencystring
atstring<date-time>
top_upsobject[]

Your 20 most recent top-ups, newest first.

4 champs
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