Skip to main content
GET
Get an organization's budget

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 organization's budget.

organization_id
string<uuid>
required
Example:

"3f8c2a1e-7b4d-4e9a-9c61-2d5e8f0a1b7c"

monthly_limit
number
required

Monthly limit in USD; 0 means no budget.

Example:

100

alert_threshold_percent
integer
required

Percentage of monthly_limit at which the first alert is sent; the limit itself always alerts too.

Required range: 1 <= x <= 100
Example:

80

stop_at_limit
boolean
required

Whether reaching the limit pauses new publishing until the billing period ends.

Example:

false

currency
enum<string>
required
Available options:
USD
Example:

"USD"

period
object
required

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

cost_usd
number
required

The period's cost so far, in USD before tax, priced as Stripe bills it.

Example:

42.18

publishing_paused_until
string<date-time> | null
required

While the budget pauses publishing, when the pause ends (the end of the billing period); null otherwise.

Example:

null

alerts
object[]
required

The alerts sent this billing period, newest first.

updated_at
string<date-time>

When the budget was last changed; omitted when none has been set.

Example:

"2026-10-28T14:02:11Z"