> ## Documentation Index
> Fetch the complete documentation index at: https://docs.veritus.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get User Credits

> Get your current credit balance and plan information

Check your current credit balance and plan information. This endpoint helps you monitor your available credits before creating jobs.

## Response

Returns credit information including:

<ResponseField name="proCreditsBalance" type="number">
  Current balance of Pro credits (used when enrich=true)
</ResponseField>

<ResponseField name="proCreditsTotal" type="number">
  Total Pro credits ever allocated
</ResponseField>

<ResponseField name="basicCreditsBalance" type="number">
  Current balance of Basic credits (used when enrich=false)
</ResponseField>

<ResponseField name="basicCreditsTotal" type="number">
  Total Basic credits ever allocated
</ResponseField>

<ResponseField name="privateKeyCreditsBalance" type="number">
  Current balance of Private Key credits (used when `scraperKey` is provided)
</ResponseField>

<ResponseField name="privateKeyCreditsTotal" type="number">
  Total Private Key credits ever allocated
</ResponseField>

<ResponseField name="plan" type="string">
  Your current plan (e.g., "free", "pro")
</ResponseField>

## Credits System

* **Pro Credits**: Used when creating jobs with `enrich=true`
* **Basic Credits**: Used when creating jobs with `enrich=false`
* **Private Key Credits**: Used when creating jobs with `scraperKey`
* **Credit Deduction**: Credits are deducted immediately when a job is created
* **Credit Calculation**: 1 credit per 100 results requested

<Note>
  Always check your credits before creating jobs to ensure you have sufficient balance.
</Note>

## Example Response

```
{
  "basicCreditsBalance": 4992,
  "basicCreditsTotal": 5000,
  "plan": "free",
  "proCreditsBalance": 1,
  "proCreditsTotal": 5,
  "privateKeyCreditsBalance": 9981,
  "privateKeyCreditsTotal": 10000
}
```