Aller au contenu

Suivre

Compte et consommation

Votre forfait, votre solde et votre consommation du cycle en cours, par l'API.

Consulter son compte

GET /v1/account

cURL
curl https://flare.zola-labs.com/v1/account \
  -H "Authorization: Bearer flr_live_VOTRE_CLE"
JSON
{
  "name": "Boutique Kribi SARL",
  "brand_name": "Boutique Kribi",
  "status": "active",
  "sender_mode": "shared",
  "plan": {
    "name": "Pro",
    "included_messages": 6000
  },
  "balance": 15000,
  "currency": "XAF",
  "usage": {
    "period": "2026-11-03",
    "messages": 1284,
    "included_remaining": 4716,
    "spent": 0
  }
}
Champ Description
brand_name Le nom affiché dans vos codes OTP.
sender_mode Votre expéditeur par défaut : shared, dedicated ou dedicated_then_shared. Voir Numéros.
balance Votre solde prépayé, en francs CFA.
usage.period Date de début du cycle de facturation en cours.
usage.messages Messages facturés depuis le début du cycle.
usage.included_remaining Messages encore inclus dans votre forfait pour ce cycle.
usage.spent Montant débité de votre solde pour des messages, depuis le début du cycle.

Comment la facturation fonctionne

  • Votre forfait inclut un nombre de messages par cycle. Le cycle commence à la date de souscription d'un forfait payant, et le 1er du mois pour le forfait gratuit.
  • Chaque message parti consomme d'abord un message inclus, puis, une fois les messages inclus épuisés, est débité de votre solde au prix de votre forfait.
  • Un message qui ne part pas (failed) n'est pas facturé, et un renvoi automatique d'OTP non plus.
  • Un forfait payant est débité de votre solde à chaque date anniversaire. Si le solde ne suffit pas, le compte repasse au forfait gratuit, et vous êtes prévenu dans l'espace client.

Quand vos messages inclus sont épuisés et que votre solde ne couvre plus un message, l'API répond 402 avec le code insufficient_balance : rien n'est envoyé. Rechargez votre solde depuis Compte › Facturation.

Note : surveillez included_remaining et balance depuis votre application pour recharger avant d'en arriver là.