Error reference / envelope-allowance-exhausted
Document allowance used up
The workspace sent every signature request its plan allows this month.
| Problem type | /problems/envelope-allowance-exhausted |
|---|---|
| HTTP status | 402 |
| Emitted by | REST API (/v1) |
| Title values | Envelope allowance exhausted |
| Extra members | upgrade_url |
| Trigger | REST API (/v1): send at monthly cap (D38, ES-20; carries `upgrade_url`) |
What happened
A send was refused because the monthly allowance is used. The response is HTTP 402 and carries upgrade_url, a link that moves the workspace to the next band.
What it means
Only new sends are affected. Documents already in flight continue to be signed, sealed, and downloadable; reads and downloads are never allowance-gated. The X-SignEnvoy-Envelopes-Remaining header reads 0, and GET /v1/me shows resets_on, the UTC date the allowance returns. Test keys never count and are never blocked.
What to do next
Open upgrade_url to move up a band, or wait for resets_on. There is no overage billing: nothing is charged for the refused send.
Problem body
Every error is an RFC 9457 problem document with media type
application/problem+json. The type member is the
stable identifier to switch on; docs_url is this page.
{
"type": "/problems/envelope-allowance-exhausted",
"title": "Envelope allowance exhausted",
"status": 402,
"instance": "/v1/...",
"docs_url": "https://docs.signenvoy.com/errors/envelope-allowance-exhausted",
"upgrade_url": "..."
}