Skip to main content
GET
https://discover.veritus.ai/api
/
v1
/
user
/
getCredits
Get User Credits
curl --request GET \
  --url https://discover.veritus.ai/api/v1/user/getCredits \
  --header 'Authorization: Bearer <token>'
{
  "proTierCreditsBalance": 123,
  "proTierCreditsTotal": 123,
  "freeTierCreditsBalance": 123,
  "freeTierCreditsTotal": 123,
  "plan": "<string>"
}
Check your current credit balance and plan information. This endpoint helps you monitor your available credits before creating jobs.

​
Response

Returns credit information including:
​
proTierCreditsBalance
number
Current balance of Pro Tier credits (used when enrich=true)
​
proTierCreditsTotal
number
Total Pro Tier credits ever allocated
​
freeTierCreditsBalance
number
Current balance of Free Tier credits (used when enrich=false)
​
freeTierCreditsTotal
number
Total Free Tier credits ever allocated
​
plan
string
Your current plan (e.g., “free”, “pro”)

​
Credits System

  • Pro Tier Credits: Used when creating jobs with enrich=true
  • Free Tier Credits: Used when creating jobs with enrich=false
  • Credit Deduction: Credits are deducted immediately when a job is created
  • Credit Calculation: Credits = Math.ceil(limit / 100)
Always check your credits before creating jobs to ensure you have sufficient balance.