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 narrowstores[].features/per_location_drilldown;allor omit for every enabled feature. An unknown/disabled feature key returns a 422 validation error onfeature.
Response — { data. } envelope.
account_id(int),account_name(string|null),period(stringYYYY-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_nameplus the feature fields below (andflat_chargefor 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 includeflat_charge(number) andfeatures_enabled(string[]); their feature rows carryoverage_rate=null,cost=0,overage_cost=0,row_statusofon_track/warning/halted.
Path params
| Parameter | Type | Required | Notes |
|---|---|---|---|
brandId | integer | Required | Digits only. |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
