Skip to main content
GET
/
account
/
credits
Get credit balance
curl --request GET \
  --url https://api.budgetpixel.com/v1/account/credits \
  --header 'Authorization: Bearer <token>'
{
  "extra_credits": 123,
  "monthly_limit": 123,
  "monthly_remaining": 123,
  "monthly_used": 123,
  "total_available": 123
}

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Response

Current credit balance for the account.

extra_credits
integer

Purchased credits that don't reset monthly.

monthly_limit
integer
monthly_remaining
integer
monthly_used
integer
total_available
integer

Total spendable credits (monthly remaining + extra).