Skip to content

Usage Ledger

Use this page to inspect row-level usage entries for metered activity.

Who This Is For

  • operators who need detailed usage evidence
  • developers building drill-down usage views
  • teams reconciling grouped totals back to individual rows

When To Use This

Use usage ledger when you need row-level history rather than grouped totals.

If you only need totals by customer, product, or feature, use Usage Summary.

How It Works

GET /api/v1/reports/usage-ledger uses report:read.

Important filters:

  • cursor
  • limit
  • from
  • to
  • action
  • product_id
  • customer_id
  • license_id
  • order_id
  • subscription_id
  • feature_code

Response shape:

  • data: ledger rows
  • page_info.next_cursor
  • meta

Use the read API for interactive drill-down and the export API for frozen usage evidence.

Example

bash
curl "https://api.licensekit.dev/api/v1/reports/usage-ledger?license_id=lic_123&feature_code=api_calls&limit=100" \
  -H "Authorization: Bearer $LICENSEKIT_TOKEN"

Common Mistakes

  • using the ledger endpoint when a grouped summary would be easier to consume
  • expecting cursor pagination on summary-style endpoints the same way it works on ledger feeds
  • treating the live ledger as a frozen export artifact

Prototype docs shell for the rewrite workspace.