Skip to main content
GET
Customer Credit Balances
Base URL: https://api.nozle.app/engine/api/v1. Auth: secret key only. The key requires credit_system:read. Publishable keys are rejected. List the customer’s Credit System balances and their active or scheduled sources:
The response is { "customer_id", "as_of", "balances": [...] }. Each item of balances has the shape shown below. The list holds every active Credit System of the organization, including systems where the customer has no credit: those have "available": "0" and "sources": []. A Credit System that is no longer active appears only when the customer has sources or operations in it. Items are ordered by credit_system code. Read one system:
This returns one balance object, for a system of any status. An unknown code returns 404 credit_system_not_found, and an unknown customer returns 404 customer_not_found.
Decimal amounts are strings without trailing zeros: "500", not "500.000000000000", and "625.5", not "625.500000000000".

Balance fields

Source fields

available on the balance includes only currently active, valid sources. The source list can also include scheduled sources whose valid_from is in the future; their available is false and they do not count. Expired, exhausted, and revoked sources are omitted.