Skip to main content
GET
Get current usage and serving state

Authorizations

Authorization
string
header
required

Your project's secret key (pk_…, without the pub segment). Server-side only — never ship it to a browser. Get it from Settings → Projects in the dashboard.

Response

Current-period usage for the owning organization.

serving
enum<string>
required

ok means web in-app messages are being served. payment_required means billing must be restored before either channel can deliver. cap_reached means usage reached the organization's spend cap for this period.

Available options:
ok,
payment_required,
cap_reached
emailServing
enum<string>
required

Campaign-email serving state. It is paused whenever serving is not ok, and while billing is past_due even though web in-app keeps serving.

Available options:
ok,
paused
billable
boolean
required

Whether a payment method is on file.

period
object
required
activeUsers
integer
required

Monthly active users across the organization in this period. An end user counts once per period in each project when identified, tracked, shown a web in-app message, or accepted for campaign email.

Example:

12480

frequencyCapped
integer
required

Campaign-email deliveries skipped by the recipient frequency limit during the current period, across the organization.

Example:

12

estimatedSpendUsd
number
required

Usage cost so far in USD, before tax.

Example:

229.76

spendCapUsd
number | null
required

The organization's spend cap in USD, or null when no cap is set.

Example:

250

projects
object[]
required

Monthly active users and frequency-capped campaign-email deliveries per project in this period.