Get Firm Client Usage

GET/api/v1/billing/firm/client-usage

Return the firm's active client count, tier cap, and remaining seats.

For non-advisory businesses (self-directed/managed) this returns is_advisory_firm: false with no limit so callers can hide the client/upgrade UI.

Operation ID: get_firm_client_usage_api_v1_billing_firm_client_usage_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Responses

200Successful Response

Schema: SuccessEnvelope_GetFirmClientUsageResponse_

successboolean
messagestring
codestring
dataGetFirmClientUsageResponse

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/billing/firm/client-usage

bash

curl -X GET 'https://api.ondayzero.com/api/v1/billing/firm/client-usage' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'