Sign in

v2

latestOpenAPI 3.1.02026-08-05267431678.1 KB
billing

Update team overage settings

Update overage billing configuration. Requires MANAGE_BILLING.

patch/billing/team/{team_id}/overage-settings

Path parameters

team_idstring required

Request body

overage_enabledboolean nullable
topup_amountnumber nullable

Credits per top-up (100 = $1)

topup_modestring nullable

Top-up mode: 'by' or 'to'

charge_thresholdnumber nullable

Remaining credits trigger

max_monthly_spendnumber nullable

Monthly cap (null to remove)

usage_reset_hourinteger nullable

Local hour for daily reset. Must be between 0 and 23.

usage_reset_timezonestring nullable

IANA timezone used to interpret usage_reset_hour.

Response

Successful Response

overage_enabledboolean required
topup_amountnumber required

Credits added per top-up charge (1 credit = $0.01)

topup_modestring

Top-up mode: 'by' adds a fixed amount, 'to' restores balance to topup_amount

charge_thresholdnumber required

Trigger charge when remaining credits drop below this

max_monthly_spendnumber nullable required

Monthly overage cap in credits (null = unlimited)

current_month_chargednumber required

Credits charged via overages this month

current_month_startstring required

ISO timestamp of current billing month start

credit_limitnumber required

Plan's included credit allowance per period

current_period_usagenumber required

Credits consumed in current billing period

current_period_requestsinteger

Number of inference requests in current billing period

max_overage_hard_capnumber nullable

Platform hard cap on daily overage spend in credits (null = no platform cap)

paid_credit_balancenumber

Persistent paid credit wallet balance (carries over indefinitely)

usage_reset_hourinteger

Local hour when daily credits reset. 0-23 in usage_reset_timezone.

usage_reset_timezonestring

IANA timezone used to interpret usage_reset_hour.

usage_reset_hour_changed_atstring nullable

ISO timestamp of last reset-hour change. Null if never changed.

today_usagenumber

Credits consumed since midnight today in the team's usage_reset_timezone (falls back to UTC for invalid timezone names), regardless of plan reset interval.