Skip to main content
GET
/
v1
/
credits
/
balance
Get API key credit balance
curl --request GET \
  --url https://api.httpayer.com/v1/credits/balance \
  --header 'x-api-key: <api-key>'
{
  "key_prefix": "sk-live-abcd1234",
  "daily_cap": 50,
  "daily_spent": 12,
  "daily_remaining": 38,
  "effective_available": 38
}

Authorizations

ā€‹
x-api-key
string
header
required

API key for authentication

Response

API key balance information

ā€‹
key_prefix
string

The API key prefix

Example:

"sk-live-abcd1234"

ā€‹
daily_cap
integer

Maximum credits this key can spend per day

Example:

50

ā€‹
daily_spent
integer

Credits spent by this key today

Example:

12

ā€‹
daily_remaining
integer

Credits remaining for today (daily_cap - daily_spent)

Example:

38

ā€‹
effective_available
integer

Actual available credits (org credit balance)

Example:

38