Skip to main content

Get Usage Stats

GET /usage Aggregate usage across all sub-accounts for the billing period.
period
string
default:"current"
current, previous, or YYYY-MM
account_id
string
Filter to a specific sub-account
group_by
string
account for per-account breakdown
curl https://api.recoverbiz.com/v1/usage?period=current&group_by=account \
  -H "X-Partner-Key: pk_live_abc123def456..."
Response: 200 OK
{
  "period": "2026-02",
  "totals": {
    "conversations": 4820,
    "messages_sent": 28400,
    "messages_received": 22100,
    "leads_imported": 3200,
    "documents_collected": 890,
    "sequences_completed": 1540,
    "active_accounts": 47
  },
  "by_account": [
    {
      "account_id": "acc_8f3a1b2c",
      "account_name": "Acme Lending",
      "conversations": 289,
      "messages_sent": 1720,
      "messages_received": 1340,
      "leads_imported": 180,
      "documents_collected": 45
    }
  ]
}

Billing Models

The Usage API gives you the data to implement any billing model:
ModelHow It Works
Per conversationCharge based on conversations count
Per messageCharge based on messages_sent + messages_received
Flat feeFixed monthly rate per active account
BundledInclude in your existing SaaS pricing
Usage data is updated in real-time. Pull stats at any frequency to power your billing system.