Billing dashboard

Partner-side billing UI feed.

Partner-side billing UI feed. The "dashboard" endpoint is the heavy one (KPIs, accounts, overage breakdown). "overview" is the same shape minus the trend + overage data; account/store endpoints drill into per-location and per-feature detail.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
GETPartner billing dashboard (full UI payload)Get the full partner billing dashboard payload: period overview (total billed, billing/contract model, active stores) plus enriched per-account rows, a summary KPI block (incl.
GETPartner billing overview (lightweight summary)Get a lightweight billing summary for the authenticated partner for the given period: headline totals plus a flat per-account cost breakdown and active store count.
GETGet billing detail for an accountGet per-store billing detail for one account under the authenticated partner.
GETGet billing detail for a storeGet per-feature usage and cost breakdown for a single store under the authenticated partner: each enabled plan feature with its usage count, limit, percentage consumed, status, and period cost.