Skip to content
academi.cx

Popular resources

API

Your first API check

Go from an API key to a document check in a few steps.

Help

A check is stuck or failed

Check what is still processing and give support the details needed to investigate.

Help

Plans, payments & cancellations

Find your plan, manage renewal, and get help with a payment.

Learn

Uploading your first document

Take a document from your computer to a readable report. Here is what to expect at each step.

Use Tab to choose a result and Enter to open it.
Sign in
Browse API documentation

API / Billing

List usage

Read every charge, refund, and top-up on your API account, newest first.

GET/api/v1/usage

Query parameters

limitintegerOptional

Entries per page, from 1 to 100. Default: 50.

beforestring · ISO 8601 timestampOptional

Pass next_before from the previous response to fetch older entries.

Usage entries

Each entry includes id, kind, product, amount_cents, balance_after_cents, check_id, words, note, and created_at. The check_id may be null, for example after a check is deleted. Continue with next_before while has_more is true. The example shows an empty ledger.

Example request · cURL
curl "https://academi.cx/api/v1/usage?limit=50" \
  -H "Authorization: Bearer $ACADEMICX_KEY"
Example response · 200 · OK
{
  "object": "list",
  "data": [],
  "has_more": false,
  "next_before": null
}

Base URL: https://academi.cx/api/v1

← Previous

Get balance

Next →

Webhooks

Still have a question? We’re here to help.