Docs
Dashboard Get an API key

Objects

The account object

The account an API key belongs to: its plan, the documents it can still send, and its verified custom domains.

Returned by Get account and the get_account MCP tool.

Attributes

emailstring
The account's email address.
planstring
The membership.
One of free starter pro business
member_levelinteger
The membership as a number: 0 Free, 1 Starter, 2 Pro, 3 Business.
documentsobject
What you can still send. See Documents and plans.
ShowHide child attributes
availableinteger | null
Documents you can use now: this month's remaining allowance plus pack documents. null when unmetered.
unmeteredboolean
true for an account that is never charged documents.
monthlyobject | null
This month's allowance. null when unmetered.
ShowHide child attributes
grantedinteger
This month's allowance.
usedinteger
Used from it so far.
remaininginteger
Left in it.
period_startstring (date-time)
The start of the month (UTC).
resetsstring (date-time)
When the next allowance starts. Unused documents do not roll over.
packsinteger
Documents left in purchased packs. Packs never expire.
signers_per_documentinteger
Signers one document covers (3).
domainsarray of strings
Your verified custom domains, usable as domain_host when creating a pact.