Customer Summary

Use this page to retrieve a customer-centered reporting object for rollups and account review.

Who This Is For

• operators reviewing one customer’s licenses and activity
• account and support teams working customer-by-customer
• developers building account-level reporting views

When To Use This

Use customer summary when the reporting question is centered on one customer rather than one license or one usage ledger.

How It Works

GET /api/v1/reports/customer-summary uses report:read.

Required query parameter:

• customer_id

Optional filters:

• from
• to
• limit

Response shape:

• data: a customer summary object
• meta

OpenAPI models the response body as a report-specific object rather than a tighter named schema. Treat the endpoint output as the canonical field-level contract.

Example

curl "https://api.licensekit.dev/api/v1/reports/customer-summary?customer_id=cust_123" \
  -H "Authorization: Bearer $LICENSEKIT_TOKEN"

Common Mistakes

• trying to reconstruct a customer summary by hand from many live license calls when this route already exists
• expecting customer-summary to be a ledger endpoint with cursor pagination
• confusing customer summaries with settlement summaries

Related Pages

• Subscription Settlement
• License Audit
• Reporting Exports