Skip to main content
GET
/
user
/
balance
Retrieve the user’s current balance
curl --request GET \
  --url https://api.paywalls.ai/v1/user/balance \
  --header 'Authorization: Bearer <token>'
{
  "balance": "<string>",
  "balanceFormatted": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.paywalls.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Paywall-User
string

Optional user identifier provided by the developer. Can be used instead of the user property in the request body to associate the API call with a specific end user.

Query Parameters

​
user
string

The unique identifier of the user to get balance information for.

Response

200 - application/json

successful operation

​
balance
string

The current balance of the user, in wei

​
balanceFormatted
string

The current balance of the user, formatted for display.