Skip to main content
GET
/
v1
/
users
/
{userId}
/
balance
Get user balance
curl --request GET \
  --url https://api.ledger.so/v1/users/{userId}/balance \
  --header 'Api-Key: <api-key>'
{
  "userId": "<string>",
  "creditLimit": 123,
  "pendingCharges": 123,
  "postedCharges": 123,
  "balanceDue": 123,
  "spendingPower": 123
}

Authorizations

Api-Key
string
header
required

API key for authentication. Get your key from the Dashboard.

Path Parameters

userId
string
required

The user ID

Response

User balance

userId
string
required
creditLimit
integer
required

Total credit limit in cents

pendingCharges
integer
required

Authorized but unsettled charges in cents

postedCharges
integer
required

Settled charges in cents

balanceDue
integer
required

Amount due in cents

spendingPower
integer
required

Available spending power in cents