Core concepts / Usage & billing

Usage & billing

Extractions are metered per processed page and debited from your organization’s prepaid balance. Top up with Mobile Money.

Credits & pricing

Each completed extraction and template field detection debits credits at your organization’s customer page rates:

NAMETYPEDESCRIPTION
Extraction pagesrateDefault 199 RWF per processed page for structured extraction.
Template OCR pagesrateDefault 199 RWF per template page during field detection.
Prepaid, no surprisesBalances are prepaid. New extractions and template detections require a positive balance, then DocMind debits the completed call using internal metering and your customer rate. If the balance reaches zero or below, new paid calls are rejected until you top up.
Starter balanceNew organizations receive a small starter balance for testing. Admins can adjust organization rates and grant additional credits from the admin console/API.

Usage endpoint

GET/v1/usage?days=30

Returns aggregate usage and a daily page series for the window. Add template_id to filter usage to a specific template. /v1/billing additionally returns your balance, recent transactions, and current customer page rates.

200 OK
GET /v1/usage?days=30

{
  "usage": {
    "input_tokens": 1840002,
    "output_tokens": 96120,
    "pages_processed": 412,
    "cost_cents": 5592,
    "documents": 412,
    "api_calls": 412
  },
  "daily_pages": [ { "day": "2026-06-01", "pages": 32, "tokens": 41980 }, ... ]
}

Balance & top-ups

POST/v1/billing/topup

Creates a Mobile Money payment request. The transaction is recorded as pending and becomes completed — crediting your balance — once the provider confirms the payment. DocMind routes the request from the phone number, so callers do not choose MTN or Airtel manually.

cURL · POST /v1/billing/topup
POST /v1/billing/topup
{ "amount_cents": 2500, "phone": "+250 788 123 456" }

HTTP/1.1 202 Accepted
{
  "status": "pending",
  "transaction": { "type": "top_up", "amount_cents": 2500, "status": "pending" },
  "message": "Top-up created. Awaiting Mobile Money confirmation."
}