Usage and billing
Every completed claim writes one billing event; composite claims (healthcare_screen) bill once at the bundle price, never their parts. Monitors bill once per calendar month at their first check of the month. Sandbox and test-mode runs never bill. Claims that end cancelled, no_coverage or source_not_built are not billed.
GET /v1/usage
curl -X GET https://api.primarycheck.com/v1/usage?from=2026-10-01&to=2026-10-31&groupBy=day \ -H "Authorization: Bearer pc_live_…"
{
"from": "2026-10-01T00:00:00Z", "to": "2026-11-01T00:00:00Z", "groupBy": "day",
"counts": { "license": 412, "healthcare_screen": 96, "exclusion_screen": 130, "employment": 18, "monitor": 240 },
"spendCents": 196050,
"byChannel": { "api": { "count": 801, "spendCents": 181250 }, "dashboard": { "count": 95, "spendCents": 14800 } },
"series": [ { "date": "2026-10-01", "count": 31, "spendCents": 7450 }, … ]
}| Parameter | Meaning |
|---|---|
from | YYYY-MM-DD or ISO-8601 timestamp. Default: 30 days before to. |
to | YYYY-MM-DD (inclusive) or ISO-8601 timestamp. Default: now. |
groupBy | day (default) gives one series row per day; type gives one row per claim type with a type key instead of date. |
Dashboard versus API
Orders placed from the dashboard under a signed-in session are recorded with channel: dashboard; orders placed with an API key are channel: api. byChannel reports both separately so an integration's spend is never mixed with what a recruiter ordered by hand. The usage page in the dashboard shows the same numbers.
List prices
Per completed claim, no minimums, no platform fee. Volume tiers are agreed per account; FCRA access requires vetting, not a plan.
| Claim type | SKU | List price |
|---|---|---|
| License (state board) | license | $2.50 |
| Healthcare screen (license + NPI + every exclusion list) | healthcare_screen | $4.00 |
| NPI | npi | $0.00 (included) |
| Exclusion screen | exclusion_screen | $1.00 |
| Certification | certification | $2.00 |
| Education | education | $8.00 + National Student Clearinghouse pass-through when used |
| Employment | employment | $9.00 + The Work Number pass-through when allowPaidThirdParty routes there |
| Monitor, license claim | monitor_license_month | $1.00 per license per month |
| Monitor, any other claim | monitor_person_month | $3.00 per person per month |
Amounts in the API are integer cents (spendCents). Invoices are issued monthly from the same billing events; the pricing page carries the current public list.