← API referenceUsage & billing · API access unavailable
API REFERENCE / BILLING
GET /v1/billing/summary
Show the account owner what is owed, what is merely estimated, and how usage maps to charges. Billing scope is separate from file-read scope: access to a folder must not reveal an account’s invoices.
Request fields
| Location | Field | Type | Required | Description |
|---|---|---|---|---|
| Header | Authorization | string | Yes | Account owner or billing-admin credential. |
| Query | period | string | No | Billing period; defaults to current period. |
Request example
Example request
GET /v1/billing/summary
Authorization: Bearer <billing-admin token>HTTP status codes
| Status | Meaning |
|---|---|
200 OK | Success response shown below. |
400 Bad Request | Invalid billing period. |
401 Unauthorized | Missing, expired, or invalid credential. |
403 Forbidden | Credential is valid but lacks the required scope or role. |
429 Too Many Requests | Rate limit reached; honor Retry-After when provided. |
503 Service Unavailable | Service temporarily unavailable; retry safely. |
Response fields
| Field | Type | Example |
|---|---|---|
currency | string | CAD |
period | object | {…} |
period.from | string (date) | 2026-10-01 |
period.to | string (date) | 2026-11-01 |
status | string | estimated |
estimated_total_minor | integer | 1299 |
observed_through | string (date-time) | 2026-10-20T18:00:00Z |
Response example
Example response
200 OK
Content-Type: application/json
{
"currency": "CAD",
"period": {
"from": "2026-10-01",
"to": "2026-11-01"
},
"status": "estimated",
"estimated_total_minor": 1299,
"observed_through": "2026-10-20T18:00:00Z"
}How it works
Current periodEstimated charges, credits, currency, period, and last aggregation time.
FinalizedSettled invoice totals are distinct from in-progress estimates.
Payment controlsOpen a hosted billing portal; do not put card details into the file API.
No price, free allowance, or charging rule is committed by this reference.