Command Palette

Search for a command to run...

IntelliPortalDOCS

Start here

  • Overview
  • Quickstart
  • Test in the sandbox

Build

  • Authentication
  • Clients
  • Hosted onboarding
  • Webhooks

API reference

  • Messages
  • Usage
  • Status & observability

Reliability

  • WhatsApp limits
  • Errors & debugging

Resources

  • Changelog
  • OpenAPI 3.1
  • Postman collection
Developer support
IntelliPortalDOCS
Developer documentation/API v1

© 2026 Intelli Holdings Inc.

PrivacyContact

Need a hand?

Share a request ID when you contact us so we can trace the call quickly.

Open developer support
  1. Docs
  2. Usage

API reference

GET /usage

Usage

Read the current month and recent closed-month message totals so your product can meter consumption, forecast overages, and surface billing context.

GET/usage

Retrieve usage rollups

Authenticate with any valid partner API key. The response returns the month in progress as current and recent finalized months in history.

cURL
curl https://api.intelliconcierge.dev/v1/usage \
  -H "Authorization: Bearer $INTELLI_API_KEY"
JSON · 200
{
  "current": {
    "period": "2026-07",
    "inbound_messages": 412,
    "outbound_messages": 388,
    "outbound_template_messages": 120,
    "total_messages": 800
  },
  "history": [
    {
      "period": "2026-06",
      "inbound_messages": 301,
      "outbound_messages": 344,
      "outbound_template_messages": 96,
      "total_messages": 645
    }
  ]
}
PropertyTypeDescription
periodYYYY-MMUTC calendar month represented by this rollup.
inbound_messagesintegerBillable messages received from end users.
outbound_messagesintegerBillable free-form and template messages sent.
outbound_template_messagesintegerSubset of outbound messages that also carry the published template price.
total_messagesintegerInbound plus outbound messages counted toward the plan bundle.

What counts toward usage

Both directions
Inbound and outbound messages both consume the monthly bundle.
Tests are excluded
Test-key and explicit dry-run sends are never included.
UTC months
Periods roll over on calendar-month boundaries in UTC.

Webhook delivery is free

Webhook attempts and redeliveries do not consume message usage. Outbound template messages count once toward the bundle and also carry the published template price.

Current plan catalogue

The included bundle combines inbound and outbound messages. Overage pricing is per additional message; template pricing is added separately for outbound template messages.

PlanMonthlyIncludedOverage / message
Free / Dev$01,000$0.005
Growth$4910,000$0.004
Scale$19950,000$0.003

Trial and grace behavior

The 7-day trial starts when your first client is connected. Live sends continue through a 3-day grace period. When grace ends, live message endpoints return 402 trial_expired until a plan is active.

Development stays available

Client reads, health checks, test-key sends, and explicit dry-runs remain usable after the live-send gate closes.
Open billing & usage
PreviousMessages
NextStatus & observability