Billing overview

GET /v1/admin/billing/overview

• Operation ID: getBillingOverview
• Tags: Billing overview
• Base URL: http://localhost:8787

Latest daily revenue rollup per currency, active subscribers per product, MRR per plan and whether the API talks to Stripe live or test mode.

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission billing.read.

Authentication

• Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
• Required permissions: billing.read

Responses

200

Overview.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (BillingOverview)

Field	Type	Required	Description
revenue	object[]	yes	Latest daily revenue rollup, one row per currency.
revenue[].day	string<date-time>	yes	Latest rollup day.
revenue[].currency	string	yes	-
revenue[].mrr	string	yes	Minor currency units, as a decimal string.
revenue[].new_mrr	string	yes	-
revenue[].churned_mrr	string	yes	-
revenue[].gross	string	yes	-
revenue[].refunds	string	yes	-
revenue[].active_subscriptions	integer	yes	-
byProduct	object[]	yes	-
byProduct[].product_key	string | null	yes	-
byProduct[].product_name	string | null	yes	-
byProduct[].subscribers	integer	yes	-
revenueByPlan	object[]	yes	Empty until the Stripe sync tables exist.
revenueByPlan[].product_key	string	yes	-
revenueByPlan[].product_name	string	yes	-
revenueByPlan[].currency	string | null	yes	-
revenueByPlan[].subscribers	integer	yes	-
revenueByPlan[].mrr	string	yes	Monthly-normalised MRR in minor units, as a decimal string.
stripeMode	string	yes	One of: "live", "test"

Errors

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

403

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "forbidden",
  "details": {
    "perm": "billing.read"
  }
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

Examples

curl

curl -X GET 'http://localhost:8787/v1/admin/billing/overview' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/billing/overview", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();