API v1API reference
Read credits and allocations
Return total, reserved and spendable credits together with a bounded page of allocations, expiration dates and funding provenance.
GET
/v1/balanceAuthorization
bearerKey AuthorizationBearer <token>
A scoped automation key authorized for the REST API.
In: header
Query Parameters
limit?integer
Range
1 <= value <= 100Default
25cursor?string
Length
length <= 200Header Parameters
X-Ndnci-Workspace*string
Select a workspace explicitly included in this access grant.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/balance" \ -H "X-Ndnci-Workspace: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Authorization: Bearer <NDNCI_API_KEY>"{ "success": true, "code": "PUBLIC_BALANCE_GET", "message": "Successful response", "data": { "workspaceId": "123e4567-e89b-42d3-a456-426614174001", "totalMillicents": 100000, "reservedMillicents": 1000, "spendableMillicents": 99000, "allocations": [ { "id": "123e4567-e89b-42d3-a456-426614174003", "remainingMillicents": 100000, "expiresAt": "2027-10-01T12:00:00Z", "provenance": "purchase", "createdAt": "2026-10-01T12:00:00Z" } ], "nextCursor": null }}Required scope: billing:read · Usage points: 2
Credits are charged separately for work that consumes paid services.