billing_status · Documentation d’Escouade Mail

Dit où en est l’espace vis-à-vis des forfaits : le forfait en cours et sa période, le prélèvement mensuel (en cours, en retard, résilié), l’issue du dernier paiement, les boîtes et le volume d’e-mails déjà utilisés, les factures, et les forfaits en vente avec leur prix.

En bref

Propriété	Valeur
Titre	Forfait de l’espace
Outil MCP	`billing_status`, sur `https://api.subagent.fr/mcp`
Appelé par	l’assistant et la vue
Appel HTTP	`POST https://api.subagent.fr/v1/billing_status`
Accès	toute clé
État de l’espace	vérifié ou non
Effet	lecture seule
Vue dans l’assistant	non

Ce que fait l’outil

Le serveur décrit l’outil ainsi à l’agent qui se branche :

Dit où en est l’espace vis-à-vis des forfaits : le forfait en cours et sa période, le prélèvement mensuel (en cours, en retard, résilié), l’issue du dernier paiement, les boîtes et le volume d’e-mails déjà utilisés, les factures, et les forfaits en vente avec leur prix. À appeler quand un envoi est refusé (payment_required, own_domain_required), quand un message attend parce que le volume du mois est atteint, avant d’ouvrir une boîte de plus, et après subscribe pour savoir si votre humain a payé.

Paramètres

billing_status ne prend aucun paramètre.

Résultat

L’outil rend un texte lisible en français et un objet structuré (structuredContent). En HTTP, la réponse est cet objet.

Champ	Type	Contenu
`invoices`	liste	Les factures, de la plus récente à la plus ancienne : number, `issued_on`, `amount_cents`, amount, url.
`last_payment`	texte	L’issue du dernier paiement ouvert par `subscribe`. Valeurs : `none`, `pending`, `paid`, `failed`.
`period`	objet ou `null`	La période payée : start, until (ISO 8601).
`plan`	objet ou `null`	Le forfait en cours : code, `price_cents`, price, inboxes, `monthly_emails`.
`plans`	liste	Les forfaits en vente.
`standing`	texte	exempt : aucun forfait ne s’applique à cet espace ; unpaid : aucun forfait en cours ; paid : forfait en cours.
`subscription`	objet	Le prélèvement mensuel : status (none, pending, active, `past_due`, canceled), renews, `next_charge_on` (date du prochain prélèvement, ou `null`), `ends_at` (fin du forfait quand rien ne le renouvelle, ou `null`).
`usage`	objet	inboxes et `inboxes_max` ; emails (partis depuis le début du mois en cours de la période, `emails_since`) et `emails_max` ; `emails_reset_at` : quand le volume repart.

Exemple d’appel

Les valeurs sont fictives.

HTTP

curl -X POST https://api.subagent.fr/v1/billing_status \
  -H "Authorization: Bearer $SUBAGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

MCP · tools/call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "billing_status",
    "arguments": {}
  }
}

Refus possibles

Aucun refus propre à cet outil. Restent les refus communs à tous les outils (unauthorized, forbidden, invalid_argument, rate_limited, internal) : voir Erreurs.

`billing_status`