Get the fee estimates of a household
GET/v1/billing/fee-estimates/:householdId
Returns the estimated annual fee and the estimated effective fee rate of the household with the given ID, from its fee settings and current balances. The rate is the household's rate on your firm's newest billing report with the status complete or finalized. When that billing report has no rate for the household, or a rate of 0, the rate is the estimated annual fee divided by the household's balance. If your firm has no household with that ID, or the household has no accounts that are not archived and its fee structure is not a Flat Group Fee, the response is 404.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 429
The fee estimates of the household.
householdId is not a whole number.
The access token is missing, invalid, or expired.
The access token does not have the read:billing scope.
Your firm has no household with that ID, or the household has no accounts that are not archived and its fee structure is not a Flat Group Fee.
The household, or another member household of one of its household groups, is a member of two or more household groups today. This read returns no fee estimates until you correct the membership. message names each such household and its household groups, and details.householdsInTwoGroups lists them.
Too many requests. Wait the number of seconds in the Retry-After-per-person header (script-audience tokens) or the Retry-After header (other requests) before you retry. See Rate limit.