Get Wallet Balance
Get comprehensive wallet balance and tier information
/members/me/wallet/balanceOverview
Returns comprehensive wallet balance including valid points, credit points, pending points, outstanding debt, net balance, total available points, debt status, and tier information with points to next tier.
This is the primary endpoint for displaying wallet status in member-facing applications.
Authentication
Requires a valid Clerk JWT token in the Authorization header.
Request
curl -X GET "http://localhost:3000/v1/members/me/wallet/balance" \
-H "Authorization: Bearer YOUR_CLERK_JWT"Response
validBalancenumberrequiredVALID asset balance (net of earnings minus spend)
Points earned from stays that can be used for redemptions
creditBalancenumberrequiredCREDIT asset balance (promotional/early-access points)
Promotional points that can be spent but don't count toward tier progression
pendingPointsnumberrequiredPoints currently in escrow waiting for reservation completion
outstandingDebtnumberrequiredOutstanding debt amount (negative balance)
netBalancenumberrequiredNet spendable balance (validBalance + creditBalance - outstandingDebt)
totalAvailablePointsnumberrequiredTotal points available for spending (convenience aggregate)
Same as netBalance when positive, 0 when negative
hasDebtbooleanrequiredWhether the member has outstanding debt
tierEligiblePointsnumberrequiredPoints earned this calendar year that count toward tier qualification
tierLevelnumberrequiredCurrent tier level (1 = Traveler/base tier)
tierNamestringrequiredCurrent tier name
pointsToNextTiernumber | nullrequiredPoints needed to reach the next tier
null if already at the highest tier
nextTierNamestring | nullrequiredName of the next tier
null if already at the highest tier
Response
{
"validBalance": 12500,
"creditBalance": 2000,
"pendingPoints": 1800,
"outstandingDebt": 0,
"netBalance": 14500,
"totalAvailablePoints": 14500,
"hasDebt": false,
"tierEligiblePoints": 8500,
"tierLevel": 2,
"tierName": "Explorer",
"pointsToNextTier": 11500,
"nextTierName": "Voyager"
}Balance Types
Valid Balance
- Source: Points earned from completed stays
- Usage: Can be spent on redemptions
- Tier Impact: Counts toward tier qualification
- Expiration: Typically 2 years from earn date
Credit Balance
- Source: Promotional points, bonuses, adjustments
- Usage: Can be spent on redemptions
- Tier Impact: Does NOT count toward tier qualification
- Expiration: Varies by promotion terms
Pending Points
- Source: Points in escrow for future/recent stays
- Usage: Cannot be spent until converted to Valid
- Conversion: Happens after checkout completion
- Display: Usually shown as "Points Pending"
Debt Handling
When hasDebt: true:
- Member cannot make new redemptions until debt is cleared
totalAvailablePointswill be 0 regardless of credit/valid balances- Debt typically occurs from:
- Redemption refunds/adjustments
- Booking cancellations after point spend
- Administrative corrections
Tier Information
The tier fields provide context for member progression:
- Current Status:
tierLevelandtierName - Progression:
pointsToNextTierandnextTierName - Annual Progress:
tierEligiblePoints(current year)
When at the highest tier:
pointsToNextTierandnextTierNamearenull- Show celebration UI instead of progression
Related Endpoints
- Get Wallet - Full wallet details
- Get Activity - Recent transactions
- Get Transactions - Transaction history