Get billing detail for a store

Get 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.

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 {storeId} store (404 if missing) and ownership 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.

Response{ data. } envelope.

  • store_id (int).
  • store_name (string|null).
  • period (string) — YYYY-MM.
  • features (array) — one row per enabled plan feature: feature_name (string), usage (int), limit (int|null — service_limit for usage-based, included_units for plan-based), percentage (number|null), status (string: within_limits / approaching / overage / hard_stop_over_limit / halted), cost (number — period sum of client_amount for that store+feature).

Path params

ParameterTypeRequiredNotes
storeIdintegerRequiredDigits only.

Errors: 422 on validation failure.

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