Buying credits

Credits are the consumption unit of the vario Scoring API. When you register you receive 250 welcome credits. When those run out, you can top up by choosing the USD amount you want to load.

ℹ

vario does not store or retain the analyzed text. Each call to the analysis endpoint is stateless and independent.

Pricing and equivalences

$0.150 USD per credit.

Mode	Credits per call	Cost per call
`screening`	1 credit	$0.150
`fast`	2 credits	$0.300
`full`	3 credits	$0.450

Top-up options (amount-based)

Choose how much you want to load; credits are calculated automatically.

Option ID	USD amount	Credits	`screening` calls	`fast` calls	`full` calls
`top75`	$75	500	500	250	166
`top150`	$150	1,000	1,000	500	333
`top300`	$300	2,000	2,000	1,000	666
`top1000`	$1,000	6,666	6,666	3,333	2,222
`custom`	free	calculated	—	—	—

For custom, the minimum amount is $10 and the maximum is $5,000.

1. View available options

GET /api/public/checkout/credits/preview

Public endpoint, no authentication required. Returns the available top-up options.

curl https://api.vario.lat/api/public/checkout/credits/preview

Response 200:

{
  "options": [
    { "id": "top75",   "label": "$75",    "amount_usd": 75.0,    "credits_preview": 500,   "status": "available" },
    { "id": "top150",  "label": "$150",   "amount_usd": 150.0,   "credits_preview": 1000,  "status": "available" },
    { "id": "top300",  "label": "$300",   "amount_usd": 300.0,   "credits_preview": 2000,  "status": "available" },
    { "id": "top1000", "label": "$1,000", "amount_usd": 1000.0,  "credits_preview": 6666,  "status": "available" },
    { "id": "custom",  "label": "other",  "amount_usd": null,    "credits_preview": null,  "status": "available" }
  ],
  "current_balance": null,
  "pricing_note": "$0.150 per credit."
}

ℹ

The current_balance field is null on this public endpoint. To view your current balance, use GET /api/v1/api-keys/credits with authentication.

2. Initiate a top-up

POST /api/public/checkout/credits

Initiates the payment process for the selected amount. The endpoint returns a transaction_id used to open the Paddle payment overlay.

Auth: none (public). The tenant_id identifies the buyer.

Request parameters:

Field	Type	Required	Description
`top_up_id`	`string`	Yes	Option to purchase: `"top75"`, `"top150"`, `"top300"`, `"top1000"`, or `"custom"`.
`tenant_id`	`string (uuid)`	Yes	Identifier of the tenant that will receive the credits.
`custom_amount_usd`	`float`	Only if `top_up_id == "custom"`	Amount in USD (min $10, max $5,000).

Example — fixed option:

curl -X POST https://api.vario.lat/api/public/checkout/credits \
  -H "Content-Type: application/json" \
  -d '{
    "top_up_id": "top300",
    "tenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'

Response 200:

{
  "transaction_id": "txn_01jxabc123def456",
  "top_up_id": "top300",
  "credits": 2000,
  "amount_usd": 300.0
}

Open the payment overlay with the returned transaction_id:

Paddle.Checkout.open({ transactionId: response.transaction_id });

When payment is complete, credits are immediately available in the tenant's balance.

Possible errors:

HTTP	Description
`400`	Invalid `top_up_id`.
`422`	`custom_amount_usd` missing, below $10, or above $5,000.
`402`	The tenant does not have a registered payment method.
`404`	Tenant not found.
`502`	Payment provider error.

3. Check current balance

GET /api/v1/api-keys/credits

Returns the available credit balance for the authenticated tenant.

curl https://api.vario.lat/api/v1/api-keys/credits \
  -H "Authorization: Bearer vario_YOUR_API_KEY"

Response 200:

{
  "balance": 2000,
  "call_cost_screening": 1,
  "call_cost_fast": 2,
  "call_cost_full": 3,
  "estimated_calls_remaining_screening": 2000,
  "estimated_calls_remaining_fast": 1000,
  "estimated_calls_remaining_full": 666,
  "pricing_note": "$0.150 per credit."
}

4. Usage history

GET /api/v1/api-portal/usage

Returns the tenant's credit consumption broken down by day.

curl "https://api.vario.lat/api/v1/api-portal/usage?from=2026-06-01&to=2026-06-30" \
  -H "Authorization: Bearer vario_YOUR_API_KEY"

Response 200:

{
  "period": { "from": "2026-06-01", "to": "2026-06-30" },
  "total_credits_used": 1250,
  "total_calls": 520,
  "daily": [
    { "date": "2026-06-01", "credits_used": 45, "calls": 18 },
    { "date": "2026-06-02", "credits_used": 60, "calls": 24 }
  ]
}

Complete flow — top up and verify credits

# 1. View available options
curl https://api.vario.lat/api/public/checkout/credits/preview

# 2. Initiate $300 top-up (2,000 credits)
curl -X POST https://api.vario.lat/api/public/checkout/credits \
  -H "Content-Type: application/json" \
  -d '{"top_up_id": "top300", "tenant_id": "YOUR-TENANT-UUID"}'

# → Open Paddle overlay with the returned transaction_id
# → Complete payment in the overlay

# 3. Verify that credits were credited
curl https://api.vario.lat/api/v1/api-keys/credits \
  -H "Authorization: Bearer vario_YOUR_API_KEY"