COcollectwise

Get Billing Usage Summary

Changed on

Returns a complete billing breakdown with usage counts and costs across all channels for a given date range.

get/billing/usage-summary

Request

  • Base URL
    https://collectwiseapi.com
  • URL
    https://collectwiseapi.com/billing/usage-summary
  • Auth
    API key in header collectwise_key

Query parameters

start_datestring required

Start of date range. Accepts YYYY-MM-DD (defaults to 00:00:00 UTC) or a full ISO 8601 UTC timestamp like 2025-02-01T05:00:00Z

end_datestring required

End of date range. Accepts YYYY-MM-DD (defaults to 23:59:59 UTC) or a full ISO 8601 UTC timestamp like 2025-02-28T04:59:59Z

Headers

x-cw-timestampstring

Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.

x-cw-signaturestring

CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.

Response

Usage summary retrieved successfully

objectstring

Object type identifier

organizationstring

Your organization name

total_costnumber

Total cost across all channels in USD

currencystring

Currency code

Example response

{
  "object": "billing.usage_summary",
  "organization": "Acme Collections",
  "period": {
    "start_date": "2025-02-01",
    "end_date": "2025-02-28"
  },
  "sms": {
    "count": 185040,
    "cost": 5551.2,
    "unit_cost": 0.03,
    "unit": "segments"
  },
  "mms": {
    "count": 4000,
    "cost": 120,
    "unit_cost": 0.03,
    "unit": "segments"
  },
  "email": {
    "count": 15000,
    "cost": 0,
    "unit_cost": 0,
    "unit": "messages"
  },
  "rvm": {
    "drops": 50000,
    "drop_cost": 700,
    "drop_unit_cost": 0.014,
    "duration_seconds": 150000,
    "duration_hours": 41.67,
    "duration_cost": 137.5,
    "duration_unit_cost_per_hour": 3.3,
    "total_cost": 837.5
  },
  "calls_outbound": {
    "minutes": 10000,
    "cost": 1080,
    "unit_cost": 0.108,
    "unit": "minutes"
  },
  "calls_inbound": {
    "minutes": 5100,
    "cost": 1190,
    "unit": "minutes"
  },
  "total_cost": 8778.7,
  "currency": "usd"
}

Changes

  • 95fad0d2f369Revision changes
    • info

      added the new optional header request parameter x-cw-signature

    • info

      added the new optional header request parameter x-cw-timestamp

    • info

      added the non-success response with the status