Guide
Usage
Every ORN API call is recorded: usage records with pricing detail, request records with latency, and the x-request-id that ties it all together.
What is recorded
Every API request — successful or failed — leaves two records, both keyed by the same request id that is returned in the x-request-id response header:
| Record | Captures |
|---|---|
| Usage record | Organization, application, credential, capability, operation, pricing version, tier, price, charged amount, billing classification, resource touched, result (success/failed). |
| Request record | Credential, request id, method, path, HTTP status, error code (if any), duration in milliseconds. |
Recording is best-effort and never alters the API response — a bookkeeping failure is logged server-side and does not break your call.
Reading your usage
The Developer Console (Developer → API) shows your recent calls and a usage summary: total calls and total amount charged, followed by the most recent usage and request records with their billing classifications and status codes.
- charged — the register price was debited for a successful call.
- free_allowance — the call consumed the free allowance; ₦0.00.
- no_charge — the call failed server-side and any debit was reversed; ₦0.00.
Correlating with support
Every response carries an x-request-id header, and every error body repeats it as request_id. Quote that value when contacting the support desk: it locates the exact request record, usage record, wallet movement and any event the call produced.