Skip to content

docs: document GET /v1/usage #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
armandokun wants to merge 1 commit into
base: feat/per-inbox-webhooks
Choose a base branch
from
+295 −1
Open

docs: document GET /v1/usage #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 137 additions & 0 deletions api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,71 @@
}
}
},
"/v1/usage": {
"get": {
"summary": "Get usage",
"description": "Per-inbox usage for metering and pass-through billing. Counts and attachment bytes are scoped to the [from, to) window; storedBytes is the current point-in-time storage for the inbox. Defaults to the last 30 days. Max window is 92 days.",
"operationId": "getUsage",
"parameters": [
{
"name": "from",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
},
"description": "ISO 8601 start (inclusive). Defaults to 30 days ago."
},
{
"name": "to",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
},
"description": "ISO 8601 end (exclusive). Defaults to now."
},
{
"name": "group_by",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"inbox",
"account"
],
"default": "inbox"
},
"description": "`inbox` (default) returns a per-inbox breakdown plus totals; `account` returns totals only."
}
],
"responses": {
"200": {
"description": "Usage report",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageReport"
}
}
}
},
"400": {
"description": "Invalid or too-large date range",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/inboxes/{id}/send": {
"post": {
"summary": "Send email",
Expand Down Expand Up @@ -999,6 +1064,78 @@
}
}
},
"InboxUsage": {
"type": "object",
"properties": {
"inboxId": {
"type": "string"
},
"address": {
"type": "string",
"format": "email"
},
"inbound": {
"type": "integer",
"description": "Inbound messages received in the window"
},
"outbound": {
"type": "integer",
"description": "Outbound messages sent in the window"
},
"attachmentBytes": {
"type": "integer",
"description": "Sum of attachment bytes across messages in the window"
},
"storedBytes": {
"type": "integer",
"description": "Current stored bytes for the inbox (point-in-time)"
}
}
},
"UsageReport": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
},
"groupBy": {
"type": "string",
"enum": [
"inbox",
"account"
]
},
"inboxes": {
"type": "array",
"description": "Per-inbox breakdown. Empty when group_by=account.",
"items": {
"$ref": "#/components/schemas/InboxUsage"
}
},
"totals": {
"type": "object",
"properties": {
"inbound": {
"type": "integer"
},
"outbound": {
"type": "integer"
},
"attachmentBytes": {
"type": "integer"
},
"storedBytes": {
"type": "integer"
}
}
}
}
},
"Message": {
"type": "object",
"properties": {
Expand Down
73 changes: 73 additions & 0 deletions concepts/usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: "Usage"
description: "Per-inbox metering for pass-through and pay-as-you-go billing"
icon: gauge
---

OpenMail exposes granular usage so you can meter cost per inbox. If you treat each agent as its own inbox, this gives you per-agent metering out of the box — useful for passing cost through to your own users.

## The usage endpoint

`GET /v1/usage` returns a per-inbox breakdown plus account totals.

```bash
curl "https://api.openmail.sh/v1/usage?from=2026-05-01T00:00:00Z&to=2026-06-01T00:00:00Z" \
-H "Authorization: Bearer $OPENMAIL_API_KEY"
```

```json
{
"from": "2026-05-01T00:00:00.000Z",
"to": "2026-06-01T00:00:00.000Z",
"groupBy": "inbox",
"inboxes": [
{
"inboxId": "inb_abc",
"address": "agent-1@yourco.com",
"inbound": 128,
"outbound": 64,
"attachmentBytes": 5242880,
"storedBytes": 7340032
}
],
"totals": {
"inbound": 128,
"outbound": 64,
"attachmentBytes": 5242880,
"storedBytes": 7340032
}
}
```

## Query parameters

| Parameter | Description |
|-----------|-------------|
| `from` | ISO 8601 start (inclusive). Defaults to 30 days ago. |
| `to` | ISO 8601 end (exclusive). Defaults to now. |
| `group_by` | `inbox` (default) returns the per-inbox breakdown plus totals. `account` returns totals only. |

The maximum window is 92 days.

## Metrics

| Field | Meaning |
|-------|---------|
| `inbound` | Inbound messages received in the window. |
| `outbound` | Outbound messages sent in the window. |
| `attachmentBytes` | Sum of attachment bytes across messages in the window (transferred volume). |
| `storedBytes` | Current stored bytes for the inbox right now (point-in-time), not bound to the window. |

<Note>
`inbound`, `outbound`, and `attachmentBytes` are **windowed** — they reflect activity in `[from, to)`. `storedBytes` is **point-in-time** — it reflects what is occupying storage now, which is the right basis for storage billing.
</Note>

## Metering pattern

For pay-as-you-go pass-through:

- Bill **per email** from `inbound + outbound` over a billing window.
- Bill **per attachment volume** from `attachmentBytes` over the window.
- Bill **per storage** from the latest `storedBytes` (snapshot it at the end of each period).

Poll `GET /v1/usage` on your billing cadence (for example daily or hourly) and store the deltas. Inboxes with no activity still appear with zeroed counts, so you always get a complete per-agent list.
3 changes: 2 additions & 1 deletion docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@
"concepts/attachments",
"concepts/suppressions",
"concepts/sender-rules",
"concepts/rate-limits"
"concepts/rate-limits",
"concepts/usage"
]
},
{
Expand Down
83 changes: 83 additions & 0 deletions scripts/generate-openapi.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,50 @@ const spec = {
},
},
},
"/v1/usage": {
get: {
summary: "Get usage",
description:
"Per-inbox usage for metering and pass-through billing. Counts and attachment bytes are scoped to the [from, to) window; storedBytes is the current point-in-time storage for the inbox. Defaults to the last 30 days. Max window is 92 days.",
operationId: "getUsage",
parameters: [
{
name: "from",
in: "query",
required: false,
schema: { type: "string", format: "date-time" },
description: "ISO 8601 start (inclusive). Defaults to 30 days ago.",
},
{
name: "to",
in: "query",
required: false,
schema: { type: "string", format: "date-time" },
description: "ISO 8601 end (exclusive). Defaults to now.",
},
{
name: "group_by",
in: "query",
required: false,
schema: { type: "string", enum: ["inbox", "account"], default: "inbox" },
description:
"`inbox` (default) returns a per-inbox breakdown plus totals; `account` returns totals only.",
},
],
responses: {
"200": {
description: "Usage report",
content: {
"application/json": { schema: { $ref: "#/components/schemas/UsageReport" } },
},
},
"400": {
description: "Invalid or too-large date range",
content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } },
},
},
},
},
"/v1/inboxes/{id}/send": {
post: {
summary: "Send email",
Expand Down Expand Up @@ -570,6 +614,45 @@ const spec = {
createdAt: { type: "string", format: "date-time" },
},
},
InboxUsage: {
type: "object",
properties: {
inboxId: { type: "string" },
address: { type: "string", format: "email" },
inbound: { type: "integer", description: "Inbound messages received in the window" },
outbound: { type: "integer", description: "Outbound messages sent in the window" },
attachmentBytes: {
type: "integer",
description: "Sum of attachment bytes across messages in the window",
},
storedBytes: {
type: "integer",
description: "Current stored bytes for the inbox (point-in-time)",
},
},
},
UsageReport: {
type: "object",
properties: {
from: { type: "string", format: "date-time" },
to: { type: "string", format: "date-time" },
groupBy: { type: "string", enum: ["inbox", "account"] },
inboxes: {
type: "array",
description: "Per-inbox breakdown. Empty when group_by=account.",
items: { $ref: "#/components/schemas/InboxUsage" },
},
totals: {
type: "object",
properties: {
inbound: { type: "integer" },
outbound: { type: "integer" },
attachmentBytes: { type: "integer" },
storedBytes: { type: "integer" },
},
},
},
},
Message: {
type: "object",
properties: {
Expand Down