List usage records

Read immutable usage charges and correcting reversals. Usage records exist only for actual deductions or their corrections; unfinished work is represented by its processing resource, not a pending credit category. Order by selected time_basis then id. No customer endpoint creates charges. Cancellation stops all further deductions.

Required scope: billing:read. The API key is bound to exactly one workspace, institution and environment. There is no workspace override; this binding applies to every read and export.

GET /v1/billing/usage

cURL

cURL

curl --request GET --fail-with-body --max-time 30 \
  "${AMLOK_API_BASE_URL}/v1/billing/usage?from=2026-10-01T00%3A00%3A00Z&to=2026-11-01T00%3A00%3A00Z&time_basis=posted_at&snapshot_id=billing_snapshot_example&limit=100" \
  --header "Authorization: Bearer ${AMLOK_API_KEY}" \
  --header "Accept: application/json"

200

synthetic

{
  "data": [
    {
      "id": "billing_usage_signal",
      "object": "billing_usage",
      "record_version": 1,
      "created_at": "2026-10-01T00:00:00Z",
      "updated_at": "2026-10-01T00:00:00Z",
      "workspace_id": "wsp_example",
      "billing_account_id": "billing_account_example",
      "product": "signal",
      "tier": "standard",
      "source_resource_id": "biz_example",
      "unit": "active_account_month",
      "quantity": "1",
      "unit_rate": "3.00",
      "currency": "CAD",
      "amount": "3.00",
      "entry_type": "charge",
      "reverses_usage_id": null,
      "status": "posted",
      "subject_id": "biz_example",
      "workflow_run_id": null,
      "application_id": null,
      "input_manifest_id": "manifest_example",
      "risk_snapshot_id": "rsk_baseline",
      "monitoring_period_id": "monitoring_period_example",
      "occurred_at": "2026-10-01T00:00:00Z",
      "posted_at": "2026-10-01T00:00:00Z",
      "billing_period_start": "2026-10-01T00:00:00Z",
      "billing_period_end": "2026-11-01T00:00:00Z",
      "rate_card_id": "billing_rate_card_example",
      "ledger_entry_id": "ledger_signal_example",
      "snapshot_id": "billing_snapshot_example"
    },
    {
      "id": "billing_usage_example",
      "object": "billing_usage",
      "record_version": 1,
      "created_at": "2026-10-23T14:00:00Z",
      "updated_at": "2026-10-23T14:00:00Z",
      "workspace_id": "wsp_example",
      "billing_account_id": "billing_account_example",
      "product": "insights",
      "tier": "standard",
      "source_resource_id": "wfr_example",
      "unit": "completed_underwriting",
      "quantity": "1",
      "unit_rate": "5.00",
      "currency": "CAD",
      "amount": "5.00",
      "entry_type": "charge",
      "reverses_usage_id": null,
      "status": "posted",
      "subject_id": "biz_example",
      "workflow_run_id": "wfr_example",
      "application_id": "app_example",
      "input_manifest_id": "manifest_example",
      "risk_snapshot_id": "risk_snapshot_example",
      "monitoring_period_id": null,
      "occurred_at": "2026-10-23T14:00:00Z",
      "posted_at": "2026-10-23T14:00:00Z",
      "billing_period_start": "2026-10-01T00:00:00Z",
      "billing_period_end": "2026-11-01T00:00:00Z",
      "rate_card_id": "billing_rate_card_example",
      "ledger_entry_id": "billing_credit_entry_example",
      "snapshot_id": "billing_snapshot_example"
    }
  ],
  "page": {
    "has_more": false,
    "next_cursor": null,
    "limit": 100
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "complete"
  }
}

Required scope: billing:read

Read immutable usage charges and correcting reversals. Usage records exist only for actual deductions or their corrections; unfinished work is represented by its processing resource, not a pending credit category. Order by selected time_basis then id. No customer endpoint creates charges. Cancellation stops all further deductions.

Required scope: billing:read. The API key is bound to exactly one workspace, institution and environment. There is no workspace override; this binding applies to every read and export.

Product scope · Processing lifecycle · Errors

Authorizations

Authorization · string · header · required

Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.

Query Parameters

from · string<date-time> · required

Inclusive UTC boundary. Must precede to.

to · string<date-time> · required

Exclusive UTC boundary.

time_basis · enum<string>

Choose event or posting time; defaults to posted_at.

Available options: occurred_at, posted_at

status · enum<string>

Usage is recorded only after an actual debit or correcting reversal.

Available options: posted

entry_type · enum<string>

Charge or compensating reversal.

Available options: charge, reversal

product · enum<string>

Product filter.

Available options: insights, signal

tier · enum<string>

Complexity filter.

Available options: standard, advanced, complex

source_resource_id · string

Workflow-run ID for Insights or borrower/business ID for Signal.

rate_card_id · string

Filter to an immutable rate-card version.

snapshot_id · string

Reuse an immutable snapshot from this workspace. Omit to use a current snapshot. Cursors bind this value; unknown snapshots return 404 and conflicting cursor parameters return 400.

limit · integer

Page size; default 100, maximum 200.

Required range: 1 <= x <= 200

cursor · string

Opaque cursor bound to filters and a stable snapshot.

Response

200

application/json

Successful response.

data · object[] · required

Show child attributes

page · object · required

Show child attributes

meta · object · required

Show child attributes