Skip to main content
Truscan runs on prepaid credits. Each request debits your balance; when the balance cannot cover a request, the request is refused rather than silently queued.

The free grant

Every account receives $10.00 in credits each month, applied automatically on your first request in a new billing period. Unused grant credits do not roll over. At instant rates, $10.00 covers roughly 1,400 searches before extraction costs.

Checking your balance

Topping up

POST /api/billing/checkout returns a hosted payment page. Send the amount in cents, minimum 5.00,maximum5.00, maximum 5,000.00:
Send the user to checkout_url. Credits are applied when the payment provider confirms the charge, not when the page is opened.
Credits are applied asynchronously. Poll GET /api/billing/account or GET /api/billing/payments to confirm a top-up landed.

Usage

GET /api/billing/usage breaks spending down by operation:
integer
default:"30"
Look-back window. Maximum 365.
integer
default:"100"
Individual entries to return. Maximum 500.

The ledger

GET /api/billing/ledger is the audit trail, every movement of credit, newest first, each with the balance it produced:
kind is one of grant (the monthly free credits), topup (a payment), or usage (a charge).

Running out

When the balance cannot cover a request, the API returns 402:
Top up, or wait for the next monthly grant.