Sign in
organizations

Changed on

Return enrollment, enforcement, and today's usage-credit spend.

get/v1/organizations/billing/free-tier-daily-limit/

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

enrolledboolean required

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

enforcedboolean required

True when the limit currently applies: enrolled, no active Pro subscription, and the platform kill switch is on. False for every non-enrolled organization.

daily_limit_usdstring required

Per-UTC-day cap on usage-credit spend as a decimal string. Reported for every organization; only meaningful when enforced.

current_day_spent_usdstring required

Today's (UTC) spend drawn from usage-credit grants (initial credit, Pro bundle, conversion incentive) 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.

day_bucketstring nullable required

The UTC day the stored counter belongs to ('YYYY-MM-DD'), or null when no usage-credit spend has been recorded yet.

limit_reachedboolean required

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

Changes