get
https://production-api.shoutaboutus.com/api/v1/partner/billing/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_limitfor usage-based,included_unitsfor plan-based),percentage(number|null),status(string:within_limits/approaching/overage/hard_stop_over_limit/halted),cost(number — period sum ofclient_amountfor that store+feature).
Path params
| Parameter | Type | Required | Notes |
|---|---|---|---|
storeId | integer | Required | Digits only. |
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
