Get billing detail for an account

Get per-store billing detail for one account under the authenticated partner. For model-a each store lists per-feature usage/limit/cost/overage rows; for model-b each store shows a flat charge plus an enabled-feature list. Also returns feature_options (with an All entry) and a flattened per_location_drilldown; an optional feature query narrows the rows to one metered feature.

Auth: Partner — authentication; under the partner/billing route group. The endpoint resolves the caller's partner by getAuthPartner (403 if none). The endpoint loads the {brandId} account (404 if missing) and its partner is verified, and the endpoint returns 403 unless that partner equals the caller's partner.

Rate limit: No rate limit.

Request

  • Query: year (integer, optional) — 2000–2100; defaults to current year.
  • Query: month (integer, optional) — 1–12; defaults to current month.
  • Query: feature (string, optional, max 128) — metered feature key to narrow stores[].features / per_location_drilldown; all or omit for every enabled feature. An unknown/disabled feature key returns a 422 validation error on feature.

Response{ data. } envelope.

  • account_id (int), account_name (string|null), period (string YYYY-MM), billing_model (string|null), contract_model (string|null), plan_subtitle (string|null).
  • feature_options (array) — { value, label } pairs (first entry is { "value": "all", "label": "All" }).
  • per_location_drilldown (array) — flattened store×feature rows: store_id, store_name plus the feature fields below (and flat_charge for model-b).
  • stores (array) — per store: store_id, store_name, features[]. Model-a feature row: feature_name, feature_label, units_consumed, limit (int|null), units_over, overage_rate (number|null), hard_stop (bool), cost, overage_cost, percentage (number|null), row_status (on_track/approaching/overage_billing/hard_stop_over_limit/halted). Model-b stores additionally include flat_charge (number) and features_enabled (string[]); their feature rows carry overage_rate=null, cost=0, overage_cost=0, row_status of on_track/warning/halted.

Path params

ParameterTypeRequiredNotes
brandIdintegerRequiredDigits only.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json