organizations

Return settled, pending, and effective balance for the organization.

Read-only — does not create or modify any billing state.

get/v1/organizations/billing/summary/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token
    • API key in header Authorization

Headers

Vellum-Organization-Idstring uuid

Required if using Cookie-based or X-Session-Token authentication methods.

Response

settled_balancestring required

Settled (on-ledger) credit balance as a decimal string.

minimum_top_upstring required

Minimum allowed top-up amount as a decimal string.

maximum_top_upstring required

Maximum allowed top-up amount as a decimal string.

maximum_balancestring required

Maximum allowed account credit balance as a decimal string.

allowed_top_up_amountsstring[] required

Ordered list of allowed top-up amounts in USD as decimal strings.

settled_balance_usdstring required

Settled (on-ledger) balance in USD as a decimal string.

minimum_top_up_usdstring required

Minimum allowed top-up amount in USD as a decimal string.

maximum_top_up_usdstring required

Maximum allowed top-up amount in USD as a decimal string.

maximum_balance_usdstring required

Maximum allowed account balance in USD as a decimal string.

pending_computestring required

Estimated pending compute charges not yet settled, as a decimal string.

pending_compute_usdstring required

Estimated pending compute charges not yet settled, as a decimal string.

effective_balancestring required

Effective credit balance (settled minus pending) as a decimal string.

effective_balance_usdstring required

Effective balance (settled minus pending) in USD as a decimal string.

is_degradedboolean required

True when pending-compute data may be stale or unavailable.

daily_credit_limit_usdstring nullable required

Per-org daily credit spend limit as a decimal string, or null when no daily limit is set.

daily_spend_usdstring required

Today's (UTC) credit spend counted against the daily limit, as a decimal string. Spend covered by plan-included credits (initial credit, Pro credit bundle) is excluded. Reported as "0.00" when the stored counter is from a prior UTC day.

daily_limit_reachedboolean required

True when a daily limit is set, today's spend has reached it, and the limit is being enforced. False while the limit is skipped for the day (see daily_limit_snoozed) or while plan-included credits (initial credit, Pro credit bundle) still hold unexpired balance. Drives the in-app daily-limit banner.

daily_limit_snoozedboolean required

True when the daily limit has been skipped for the current UTC day, so it is not enforced until the next reset. Auto top-up is unaffected and keeps charging.

free_tier_daily_limit_enrolledboolean required

True when the organization was enrolled at signup in the free-tier daily usage-credit limit cohort.

free_tier_daily_limit_enforcedboolean required

True when the free-tier daily limit currently applies: enrolled, no active Pro subscription, and the platform kill switch is on.

free_tier_daily_limit_usdstring required

Per-UTC-day cap on usage-credit spend (initial credit, Pro bundle, conversion incentive) as a decimal string. Only meaningful when free_tier_daily_limit_enforced.

free_tier_daily_spend_usdstring required

Today's (UTC) spend drawn from usage-credit grants as a decimal string. Reported as "0.00" when the stored counter is from a prior UTC day. Purchased/extra credit spend is never included.

free_tier_daily_limit_reachedboolean required

True when the free-tier daily limit is enforced and today's usage-credit spend has reached it, so usage credit is unspendable until the next UTC day while purchased/extra credit remains spendable. Drives the in-app free-tier banner.

low_balance_threshold_usdstring required

Effective low-balance alert threshold in USD as a decimal string (per-org override when set, else the global default). Same threshold that gates the low-balance warning email.

low_balance_warningboolean required

True when the balance is above zero but below the low-balance threshold and auto-top-up is not enabled. Drives the in-app low-credits banner.

credits_expiring_soon_usdstring required

Unexpired remaining credit (USD, decimal string) from grants whose expiry falls within the next 30 days. Already-expired remainders are excluded.

next_credit_expiry_atstring date-time nullable required

Earliest upcoming expiry across grants that still hold credit, or null when no unexpired credit remains.

available_usage_balancestring

Unused credit (USD, decimal string) remaining on unexpired initial-credit and subscription (Pro bundle) grants.

total_usage_balancestring

Total granted credit (USD, decimal string) across unexpired initial-credit and subscription (Pro bundle) grants, including amounts already used but net of refunded credit.

Changes

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status