Get plan and usage snapshot (plan, limits, payment status)

The plan / quota / payment-status snapshot: current plan name, billing period, plan limits, usage counts, and access state. Identical to a bare GET /v1/usage call (this path is its deprecated alias). For billed spend by product, call GET /v1/usage with range / granularity params. The statement view (balance, credits, caps, payment status) lives at GET /v1/billing.

The response shape depends on the account's billingSystem:

Stripe users: per-period usage.uploads / usage.profiles counters.
Metronome (usage-based) users: usage.connectedAccounts, usage.xApiCallsByOperation (per-operation X API call counts — resolve keys via GET /v1/billing/x-pricing), plus a spend block with currentPeriodCents, xSpendCents, and xSpendLimitCents. The legacy usage.xApiCalls 3-tier aggregate is still emitted for back-compat but excludes the $0.200 URL tier and any future tiers — new clients should consume xApiCallsByOperation only.

reconcileboolean

For Stripe subscription users, true forces a subscription reconciliation pass even when cached plan data looks complete. Omit the parameter, or pass false, to use the default first-time-only reconciliation behavior. Invalid boolean values are rejected.

Response

Usage stats

billingSystem'stripe' | 'metronome'

Which billing system the account is on. Shape of usage/spend differs.

planNamestring

billingPeriod'monthly' | 'yearly'

signupDatestring date-time

billingAnchorDayinteger

Day of month (1-31) when the billing cycle resets

hasAccessboolean

True if the account is in good standing. False for past-due/unpaid/paused subscriptions.

customerIdstring nullable

Stripe customer ID, when present.

isInvitedUserboolean

True if this is a team member; limits/usage reflect the account owner.

autoUpgradeEnabledboolean

Stripe-only. Always false for Metronome users.

Example response

{
  "usage": {
    "xApiCallsByOperation": {
      "posts_read": 42,
      "content_create": 7,
      "content_create_with_url": 3,
      "dm_interaction_create": 1
    }
  }
}

v2

Get plan and usage snapshot (plan, limits, payment status)

Query parameters

Response

Example response