Sign in
billing

Get team overage settings

Return current overage billing configuration after billing authorization.

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

Path parameters

team_idstring required

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

Optional per-team monthly auto-refill cap in credits (null uses platform default)

effective_monthly_capnumber required

The monthly auto-refill cap actually enforced, in credits: the team's max_monthly_spend when it has selected one, and the platform default otherwise. Always populated, so a client never has to infer the ceiling in force from a null max_monthly_spend.

current_month_chargednumber required

Credits charged via overages this month

current_month_startstring required

ISO timestamp of current billing month start

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).

Changes