Skip to main content
GET
Get an organization's billing summary

Authorizations

Authorization
string
header
required

A personal access token (POST /v1/auth/tokens) or a machine identity token (POST /v1/projects/{project_id}/identities/{identity_id}/tokens), both prefixed qumo_pat_. A token's scopes cap what it can do; see Scopes and permissions. A personal token names no organization: on a route whose path names no project or organization, pass ?organization_id=.

Path Parameters

id
string<uuid>
required

The organization ID.

Response

The billing summary.

The current billing period's plan, subscription and usage-based cost for an organization. Byte totals are organization-wide; only usage.project_bytes depends on the project named in the path.

plan
object
required
has_live_subscription
boolean
required

Whether the organization has a Stripe subscription that has not ended. Checkout refuses a second subscription.

Example:

true

period
object
required

The billing period: the Stripe subscription's current period, or the calendar month (UTC) without one.

computed_at
string<date-time>
required

When the server read the usage figures, not the time the data is as of. The figures come from the usage rollups, up to one usage-worker tick (about 5 minutes) older than this.

Example:

"2026-11-03T09:15:42Z"

usage
object
required
cost
object
required
subscription_status
string

The Stripe subscription's status (for example active, past_due, canceled); omitted when the organization has no subscription.

Example:

"active"

cancel_at
string<date-time>

When the live subscription ends, set once its cancellation is scheduled; the organization returns to Free then. Omitted while it renews.

Example:

"2026-12-03T21:08:26Z"

publishing_paused_until
string<date-time>

Set while the organization's budget has paused new publishing for reaching its monthly limit (stop at limit): when the pause ends, the end of the billing period. Omitted otherwise.

Example:

"2026-11-20T08:30:00Z"

products
object

Usage, included quota and overage per active product, keyed by SKU key.