curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.edi.stateset.com/v1/usage' \
--header "Authorization: Bearer $EDI_API_TOKEN"
{
"success": true,
"data": {
"by_kind": {},
"by_partner": {},
"by_transaction_set": {},
"tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"total": 102
},
"period": {
"from": "2026-08-31T14:22:05Z",
"to": "2026-08-31T14:22:05Z"
}
}
The tenant's consumption ledger rollup — documents processed and generated,…
Aggregated consumption for the period (defaults to the last 30 days when from/to are omitted)
GET
/
v1
/
usage
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.edi.stateset.com/v1/usage' \
--header "Authorization: Bearer $EDI_API_TOKEN"
{
"success": true,
"data": {
"by_kind": {},
"by_partner": {},
"by_transaction_set": {},
"tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"total": 102
},
"period": {
"from": "2026-08-31T14:22:05Z",
"to": "2026-08-31T14:22:05Z"
}
}
Query parameters
string,null (date-time)
Period start (RFC 3339). Defaults to 30 days ago.
string,null (date-time)
Period end, exclusive (RFC 3339). Defaults to now.
Response
object
boolean
required
UsageSummary
required
Aggregated consumption for a tenant over a period.
Show UsageSummary
Show UsageSummary
object
required
Totals per action kind. Additional keys map to values of type
integer (int64).object
required
Totals per partner. Additional keys map to values of type
integer (int64).object
required
Totals per transaction set (documents only). Additional keys map to values of type
integer (int64).string
required
integer (int64)
required
object
required
Status codes
| Code | Meaning |
|---|---|
200 | Aggregated consumption for the period (defaults to the last 30 days when from/to are omitted) |
403 | Admin or tenant credential required |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.edi.stateset.com/v1/usage' \
--header "Authorization: Bearer $EDI_API_TOKEN"
{
"success": true,
"data": {
"by_kind": {},
"by_partner": {},
"by_transaction_set": {},
"tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"total": 102
},
"period": {
"from": "2026-08-31T14:22:05Z",
"to": "2026-08-31T14:22:05Z"
}
}
Last modified on October 20, 2026