Usage and Credits

Usage is measured in credits.

Each original bank-statement PDF can consume at most one credit. Multiple processor result rows for the same original PDF do not create additional credits. Merchant application PDFs do not consume statement-processing credits.

View Usage

curl https://api.b2systems.io/v1/usage \
  -H "Authorization: Bearer $B2_API_KEY"

The response shows read-only usage for the current billing period.

This endpoint returns a billing-period aggregate. It does not return the historical, per-document credit ledger shown on the dashboard billing page.

{
  "period_start": 1781913600,
  "period_end": 1784505600,
  "credits_used": 317,
  "included_credits": 1000,
  "billing_status": "active"
}

Usage cannot be changed through the API.

Duplicate PDF Counting

If the exact same PDF bytes are processed again by the same organization within 30 days, it is not counted again. The filename does not affect duplicate detection.

If any bytes in the PDF change, it is treated as a different document and consumes a new credit. The same exact PDF processed after 30 days also consumes a new credit.

If the same PDF is processed by a different organization, it counts for that other organization.

This matches the dashboard behavior.

When Credit Usage Is Recorded

Credit usage is recorded for InFlow PDF processing.

A bank statement that reaches a terminal failed or unreconciled result consumes one credit and is returned for review. A vendor or system failure before a terminal document result does not consume a credit.

TrueSight matching from CRM-supplied data does not process PDFs, so it does not record PDF processing credits.

Billing Access

The API requires organization API access and billing status that allows API usage.

If billing is canceled or missing, new API requests return billing_inactive until billing is restored.

Overage is handled through billing. The API does not block processing just because the organization has used all included credits.

Webhook

When credit usage is recorded, B2 Systems can send:

usage.credits_consumed

Use this event to update your CRM or internal reporting, but use GET /v1/usage as the source of truth for current usage.