Skip to main content
GET
Entity Credit Balances
Base URL: https://api.nozle.app/engine/api/v1. Auth: secret key only. The key requires entity:read. Publishable keys are rejected. List all relevant Credit Systems:
Read one system:
The list endpoint returns { "customer_id", "entity_id", "entity_status", "as_of", "balances": [...] }, with one object of this shape per item. Source fields have the same meaning as in Customer Credit Balances. pool_policy is null when no policy applies. An unknown customer returns 404 customer_not_found, an unknown Entity returns 404 entity_not_found, and an unknown Credit System code returns 404 credit_system_not_found. A retryable read failure returns 503 credit_read_temporarily_unavailable with Retry-After. All amounts are strings. entity_available and shared_available expose separate source pools. effective_available applies the current plan policy and becomes zero when the Entity is inactive or no unambiguous policy exists. The source list contains active or scheduled, non-exhausted sources. Expired and exhausted sources remain in immutable history but are not returned by this balance endpoint.