Skip to main content
GET
/
credits
Get credits
curl --request GET \
  --url https://api.example.com/credits \
  --header 'x-api-key: <x-api-key>'
Free — does not consume credits
curl https://xquik.com/api/v1/credits \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq

​
Headers

​
x-api-key
string
required
Your API key. Session cookie authentication is also supported.

​
Response

​
auto_topup_enabled
boolean
Whether automatic top-up is enabled.
​
balance
number
Current credit balance.
​
lifetime_purchased
number
Total credits purchased.
​
lifetime_used
number
Total credits consumed.
{
  "auto_topup_enabled": false,
  "balance": 450,
  "lifetime_purchased": 1000,
  "lifetime_used": 550
}
Related: Top Up Credits · Quick Top-Up · Billing Guide