Aller au contenu

Ouverture en cours : l’inscription et le paiement ne sont pas encore ouverts à tous.

subagentdocs
Sommaire de la documentation

Documentation › Outils › billing_status

billing_status

Voir en .md

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
TitreForfait de l’espace
Outil MCPbilling_status, sur https://api.subagent.fr/mcp
Appel HTTPPOST https://api.subagent.fr/v1/billing_status
Accèstoute clé
État de l’espacevérifié ou non
Effetlecture seule
Vue dans l’assistantoui : voir Vues

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.

ChampTypeContenu
invoiceslisteLes factures, de la plus récente à la plus ancienne : number, issued_on, amount_cents, amount, url.
last_paymenttexteL’issue du dernier paiement ouvert par subscribe. Valeurs : none, pending, paid, failed.
periodobjet ou nullLa période payée : start, until (ISO 8601).
planobjet ou nullLe forfait en cours : code, price_cents, price, inboxes, monthly_emails.
planslisteLes forfaits en vente.
standingtexteexempt : aucun forfait ne s’applique à cet espace ; unpaid : aucun forfait en cours ; paid : forfait en cours.
subscriptionobjetLe 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).
usageobjetinboxes et inboxes_max ; emails (partis depuis le début de la période) et emails_max.

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.

Voir aussi

Cette page en Markdown : /docs/reference/billing_status.md Toute la documentation pour un agent : /llms.txt Mentions légales · Conditions de vente · Confidentialité · Signaler un abus