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

# Credits

> Check your available credits and where they were spent, before and after you start a campaign.

Each candidate you add to an enrichment campaign costs credits. These two calls only **read** your credits: they never change a balance. They need the `enrichment:credits` scope, which is separate from the other enrichment scopes, so a key that reads results cannot see your balance.

## Which wallet you see

The key's mode picks the wallet. A `VFN_TEST_` key sees the test wallet and a `VFN_LIVE_` key the live one. Both are priced the same.

## Check what you have

[`GET /enrichment-credits`](https://docs.userecord.io/api-reference/enrichment-credits/your-available-credits) returns the wallet, the price of one candidate and how many more candidates the balance covers.

```json theme={null}
{
  "success": true,
  "data": {
    "mode": "live",
    "currency": "INR",
    "billing_configured": true,
    "wallet_configured": true,
    "wallet": { "granted": 1000, "consumed": 500, "balance": 500 },
    "unit_price": 8,
    "candidates_affordable": 62
  }
}
```

Read it before you start a campaign. A campaign that costs more than the balance is refused with `402 INSUFFICIENT_CREDITS` and nothing is created: the whole batch is checked first.

> [!NOTE]
>
> Missing data is a normal answer, not an error. With no billing account you get `200` with `billing_configured: false`. A test wallet that was never set up gives `wallet_configured: false` and `wallet: null`: nothing can be spent from it, and it is not unlimited. A service with no price gives `unit_price: null`, never zero.

## See where credits went

[`GET /enrichment-credits/usage`](https://docs.userecord.io/api-reference/enrichment-credits/where-your-enrichment-credits-were-used) lists one row for every candidate added to a campaign, newest first. `credits` is negative when credits were spent and positive when they were given back.

| Filter | Meaning |
| - | - |
| `enrichment_id`, `campaign_id`, `candidate_id` | Only credits spent in that enrichment, campaign or on that candidate. |
| `from`, `to` | A date range. `from` is included and `to` is not, so two ranges next to each other never count a row twice. |
| `limit`, `cursor` | Paging, the same as every list. |

`summary.net_credits` adds up every row that matches your filters, not only the page you are on. An id from another organisation returns an empty list, not an error.

```json theme={null}
{
  "success": true,
  "data": {
    "items": [
      {
        "usage_id": "LGR_0f1c2d3e4a5b6c7d",
        "type": "debit",
        "description": "Enrichment assigned",
        "credits": -8,
        "quantity": 1,
        "unit_price": 8,
        "balance_after": 492,
        "enrichment_id": "WF_EN_…",
        "campaign_id": "EC_…",
        "candidate_id": "…",
        "mode": "live",
        "created_at": "2026-11-18T05:00:30.358Z",
        "effective_at": "2026-11-18T05:00:30.358Z"
      }
    ],
    "count": 1,
    "total": 1,
    "next_cursor": null,
    "has_more": false,
    "summary": { "net_credits": -8 }
  }
}
```

The charge is made in the background right after the campaign is created, so the usage rows can take a moment to appear.

## Endpoints

| Step | Endpoint | Scope |
| - | - | - |
| Check your credits | [`GET /enrichment-credits`](https://docs.userecord.io/api-reference/enrichment-credits/your-available-credits) | `enrichment:credits` |
| See where they went | [`GET /enrichment-credits/usage`](https://docs.userecord.io/api-reference/enrichment-credits/where-your-enrichment-credits-were-used) | `enrichment:credits` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.