REFERENCE

Account reference

Read the workspace, its plan, the mode your key is in, and current API usage for the billing period.

All documentation

One endpoint, and the cheapest way to confirm that a key works, that the plan allows API access, and which mode you are operating in.

GET/v1/account

Requires account:read

bash

curl https://api.documentesign.com/v1/account \
  -H "Authorization: Bearer $ESIGN_API_KEY"

200 OK

{
  "organization": { "id": "org_...", "name": "Acme Inc" },
  "plan": { "code": "business", "trialing": false },
  "mode": "TEST",
  "usage": {
    "documents_used": 12,
    "documents_included": 40,
    "documents_billable": 0,
    "overage_amount_cents": 0,
    "period_start": "2026-09-01T00:00:00.000Z",
    "period_end": "2026-10-01T00:00:00.000Z"
  }
}

Response

Field	Type	Notes
`organization`	object	The workspace this key belongs to: id and name.
`plan.code`	string	business or ultimate for any workspace that can reach the API.
`plan.trialing`	boolean	True during a Business trial. Trials have full API access.
`mode`	"LIVE" \| "TEST"	Which world this key operates in. The most useful line in the response.
`usage.documents_used`	number	API documents sent in the current period.
`usage.documents_included`	number \| null	Free threshold for the period. null means unlimited.
`usage.documents_billable`	number	Documents beyond the included threshold.
`usage.overage_amount_cents`	number	What those billable documents come to, at $0.40 each.
`usage.period_start / period_end`	string \| null	The billing period. Falls back to the calendar month when there is no subscription.

Usage counts API sends only

Documents created in the web app do not appear here. They still draw on the workspace allowance, and a live API send draws on both.

PreviousErrors, rate limits and quotas NextDocuments reference