account/credits
Tool: read
Get the available sending-credit balance for this account. Each email sent draws from it; when it
runs out, sends fail with InsufficientCredit. Check before starting a large campaign.
Workspaces and clientspaces draw from their parent organization's shared pool — the balance a delegated key reads is the pool it actually spends from.
Response
200 — Sending credit balance.
| field | type | description |
|---|---|---|
| balance | integer | Effective available sending credits, including shared or allocated credits for sub-accounts. |
Errors: 400, 401, 403, 406, 422, 429, 500 — shared schema: schemas/errors.
Invoke
Call read with name: "account/credits".