Get recurring invoice stats
How many recurring schedules this company has alive, what they add up to per month, and how much invoicing is stopped because the unattended generation broke.
It is the whole company, and it takes no filters. It is an anchor, not a summary of whatever the list is showing: narrowing the list by customer or by status does not move these figures. Pagination does not apply either — the numbers cover every schedule of the company, not a page of them.
The two amounts are never added together. active.monthly_amount is a forecast of what is going to be invoiced; stopped.monthly_amount is invoicing that should be happening and is not. There is deliberately no grand total in the response.
The per-schedule figures behind them are the same ones GET /v1/companies/{company_id}/recurring-invoices publishes as amount, so the rows and this header cannot drift: adding the amount of every active row by hand gives active.monthly_amount exactly, to the cent.
Filters of the list are rejected, not ignored: sending status, customer_id or any other unknown parameter answers 400 naming it. Asking for a filtered header and getting whole-company figures back with a 200 would be worse than being told no.
Request
- Base URL: https://app.beel.es/api
- URL: https://app.beel.es/api/v1/companies/{company_id}/recurring-invoices/stats
- Auth: HTTP bearer
Response
Recurring invoice stats retrieved successfully
Example response
{
"success": true,
"data": {
"active": {
"count": 7,
"monthly_amount": 2140
},
"stopped": {
"count": 7,
"monthly_amount": 2140
}
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.