Get House Account Balance
GET/api/customers/:customer/house-account
Return the customer's house-account balance owed, credit limit, and remaining headroom.
customers:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (PAT).
Response fields (under data):
customer_id(integer) — the customer.house_account_enabled(boolean) — whether on-account charging is enabled for this customer.balance(float) — the current balance owed on the account.credit_limit(float | null) — the customer's credit limit, or null when uncapped.available_credit(float | null) — remaining headroom (credit_limit − balance), or null when there is no limit.
Returns 200 with { data: { ... } }.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.