Skip to main content

billing

MethodPathScopeSummary
GET/billing/planbearerGet Plan
GET/billing/statementbearerGet Statement

Try it

curl -sf "$VIGIL_URL/health"

Routes

GET /billing/plan

Get Plan. Scope: bearer.

Response 200:

{
"org": "string",
"plan": "string",
"limits": {},
"billing_email": "string | null",
"plan_price": "string | null",
"currency": "string",
"upgrade": "string"
}

GET /billing/statement

Get Statement. Scope: bearer.

What the meter recorded for one month, with overage lines against the plan in force now.

ParameterInRequiredTypeNotes
monthqueryyesstringUTC calendar month, YYYY-MM

Response 200:

{
"org": "string",
"month": "string",
"plan": "string",
"limits": {},
"usage": {},
"plan_price": "string | null",
"overage": [
{
"item": "string",
"quantity": 0,
"unit": "string",
"unit_price": "string | null",
"amount": "string | null"
}
],
"total": "string | null",
"currency": "string",
"upgrade": "string"
}

Generated from openapi.json (VIGIL 0.2.0). Scopes follow the router dependencies in VIGIL_SPEC.md section 4.2.