get_credits¶
Check the user's credit balance and pricing information.
Overview¶
| Property | Value |
|---|---|
| Cost | Free |
| Scope | credits_read |
Arguments¶
None required.
Response¶
{
"balance_dollars": "5.34",
"balance_cents": 534,
"pricing": {
"analyze_job": 2,
"generate_cv": 20
},
"free_trial": {
"analyses_remaining": 3,
"cv_generations_remaining": 1
}
}
Fields¶
| Field | Type | Description |
|---|---|---|
balance_dollars |
string | Balance formatted as dollars |
balance_cents |
integer | Balance in cents |
pricing.analyze_job |
integer | Cost per job analysis (cents) |
pricing.generate_cv |
integer | Cost per CV generation (cents) |
free_trial.analyses_remaining |
integer | Free analyses left |
free_trial.cv_generations_remaining |
integer | Free CV generations left |
Example¶
Use Cases¶
- Check balance before making paid API calls
- Display remaining credits to user
- Warn when balance is low