User Balance

Read a user’s credit limit, pending and posted charges, balance due, and spending power. Use these metrics for managing user accounts and tracking spending.

Call Get a user’s credit balances to read the balance metrics for one user. All amounts are integers in cents.

How balances are calculated

The response provides these fields:

Field	Description
creditLimit	The maximum credit assigned to the user.
pendingCharges	Transactions that are authorized but not yet finalized.
postedCharges	Transactions that have been finalized or settled.
balanceDue	The total amount the user owes.
spendingPower	The remaining credit available to the user: the credit limit minus everything outstanding (pending, posted, due, and any in-flight transfer or bill-pay holds).
currency	The balance currency, when set for your program.
timelockedWithdrawals	Informational: the total of the user’s initiated time-locked withdrawals. Not subtracted from spendingPower.
spendingPowerWithWallet	Only on programs that pull funds from customer wallets at authorization time: spendingPower plus what Rain can currently pull from the user’s wallet allowance.

A pending refund doesn’t raise spendingPower. Refund value lands only when the refund settles.