Platform API

Account usage and invoices

Query organization usage, time series, metering status, and final account invoices.

GEThttps://app.mindbill.org/partner/v2/developer/account/usage

Reconcile bill activity by customer and compare it with the partner account invoice.

AuthenticationBearer server API key

Permissions by credentialAccount-scoped key: account:read

IdempotencyNot required

This endpoint requires a server API key and is unavailable to browser sessions. See the component API inventory for exact paths and SDK methods.

Query parameters

FieldTypeDescription

from

string

First date in UTC, inclusive (YYYY-MM-DD). Defaults to the first day of this month.

to

string

Last date in UTC, inclusive (YYYY-MM-DD). Maximum range: 366 days.

interval

"day" | "week" | "month"

Time series bucket size.

organizationId

string

Filter gross usage to one customer organization. Invoice amounts remain account-wide.

Examples

curl 'https://app.mindbill.org/partner/v2/developer/account/usage?from=2026-10-01&to=2026-10-31&interval=day' \
  --header "Authorization: Bearer $MINDBILL_ACCOUNT_KEY"

Response

200 OK

{ "periodStart": "2026-10-01", "periodEnd": "2026-11-01", "interval": "day", "organizationId": null, "currency": "usd", "submittedBills": 3, "usageAmountCents": 300, "organizationBreakdown": [{ "organizationId": "org_example", "organizationName": "Example Practice", "submittedBills": 3, "usageAmountCents": 300 }], "series": [], "metering": { "pending": 0, "delivering": 0, "delivered": 3, "retry": 0, "dead": 0, "skipped": 0 }, "billing": { "status": "available", "scope": "account", "invoices": [], "totals": { "subtotalCents": 0, "totalCents": 0, "creditAppliedCents": 0, "amountDueCents": 0, "amountPaidCents": 0, "amountRemainingCents": 0 } } }

FieldTypeDescription

periodStartRequired

string

Inclusive UTC report start.

periodEndRequired

string

Exclusive UTC report end.

organizationBreakdown[]Required

object[]

Submitted bill counts and gross usage cents by organization.

series[]Required

object[]

Submitted bill counts and gross usage cents by selected interval.

meteringRequired

object

Pending, delivering, delivered, retry, dead, and skipped usage event counts.

billing.statusRequired

"available" | "no_billing_account" | "not_configured" | "unavailable"

Whether Stripe invoice details are available.

billing.invoices[]Required

object[]

Finalized account invoices overlapping the report period, with subtotal, total, credit, due, paid, and remaining amounts in cents.

billing.totalsRequired

object | null

Account invoice amount totals in cents, including credits and payments when available.