Retrieve consumption summary

Aggregate posted usage and reversals at a consistent as_of snapshot. Unfinished processing is not spent credit. Product and tier remain distinct even when grouping by day or month.

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/consumption

cURL

cURL

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

200

synthetic

{
  "data": {
    "id": "billing_consumption_example",
    "object": "billing_consumption",
    "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",
    "currency": "CAD",
    "from": "2026-10-01T00:00:00Z",
    "to": "2026-11-01T00:00:00Z",
    "as_of": "2026-10-23T14:00:00Z",
    "time_basis": "posted_at",
    "group_by": "product_tier",
    "rows": [
      {
        "product": "insights",
        "tier": "standard",
        "bucket_start": "2026-10-01T00:00:00Z",
        "bucket_end": "2026-11-01T00:00:00Z",
        "quantity": "1",
        "unit": "completed_underwriting",
        "gross_amount": "5.00",
        "adjustment_amount": "0.00",
        "net_amount": "5.00"
      },
      {
        "product": "signal",
        "tier": "standard",
        "bucket_start": "2026-10-01T00:00:00Z",
        "bucket_end": "2026-11-01T00:00:00Z",
        "quantity": "1",
        "unit": "active_account_month",
        "gross_amount": "3.00",
        "adjustment_amount": "0.00",
        "net_amount": "3.00"
      }
    ],
    "total_net_amount": "8.00",
    "provisional": true,
    "snapshot_id": "billing_snapshot_example"
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "complete"
  }
}

Required scope: billing:read

Aggregate posted usage and reversals at a consistent as_of snapshot. Unfinished processing is not spent credit. Product and tier remain distinct even when grouping by day or month.

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> · required

Basis for selecting charges.

Available options: occurred_at, posted_at

group_by · enum<string> · required

Grouping.

Available options: product_tier, day, month

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.

Response

200

application/json

Successful response.

data · object · required

Show child attributes

meta · object · required

Show child attributes