Skip to main content
Accurate reporting of customer usage is crucial for revenue generation in payroll businesses. It ensures proper billing, minimizes revenue leakage, and provides insights into customer behavior and profitability, enabling smarter pricing, better product decisions, and sustainable growth. The Nmbr API allows you to query monthly usage data, categorized by billable event types, and provides access to underlying records for detailed review and reconciliation.

​
Usage Summary

Provides high-level usage statistics including counts of billable activity and fee-generating events like wires. Example UsageSummary: 
{
  "company": "cmp_hdjsudJHGU9hH89h",
  "event": "employee_paid",
  "count": 2,
  "period_start": "2025-01-01",
  "period_end": "2025-01-31"
}

​
Usage Records

Offers detailed usage data for specific categories (e.g. paid employees), allowing a breakdown of usage events. Example UsageRecord: 
{
  "company": "cmp_hdjsudJHGU9hH89h",
  "event": "employee_paid",
  "record": { "id":"pay_hdjsudJHGU9hH89h", "type":"pay_stub" },
  "recorded_at": "2025-01-01 16:00:00",
}

​
Getting a usage summary

It’s May, and the company cmp_hdjsudJHGU9hH89h just wrapped up paying 15 employees and 8 contractors for April. GET /usage_summaries?company_id=cmp_hdjsudJHGU9hH89h&period_start=2025-04-01&period_end=2025-04-30 
{
  "data": [
    {
      "id": "sum_jh9jh7g7HVG",
      "type": "usage_summary",
      "data": {
        "company": "cmp_hdjsudJHGU9hH89h",
        "event": "employee_paid",
        "count": 15,
        "period_start": "2025-04-01",
        "period_end": "2025-04-30"
      }
    },
    {
      "id": "sum_jh9jh7g7HVG",
      "type": "usage_summary",
      "data": {
        "company": "cmp_hdjsudJHGU9hH89h",
        "event": "contractor_paid",
        "count": 8,
        "period_start": "2025-04-01",
        "period_end": "2025-04-30"
      }
    }
  ]
}
With this data, you can generate the total invoice for this given company.