Skip to content
Docs
Open Escouade
Documentation contents

Docs › Mail › Tools

billing_status

View as .md

The space’s plan.

Tells you where the space stands with plans: the current plan and its period, the monthly direct debit (active, overdue, cancelled), the outcome of the last payment, the inboxes and e-mail volume already used, the invoices, and the plans on sale with their price. Call it when a send is refused (payment_required, own_domain_required), when a message waits because the month’s volume is reached, before opening one more inbox, and after subscribe to find out whether your human has paid.

Access

  • Key: an Escouade Mail key with read or send or approve or manage_inboxes.
  • Space: any space, verified or not.
  • Changes nothing: yes, it only reads.
  • Safe to replay: yes.

Parameters

None.

Call it

Terminal
curl -s https://api.subagent.fr/v1/billing_status \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sak_…' \
  -d '{}'

The full page in French, with the response fields and every refusal the tool can return: /mail/docs/reference/billing_status.