---
title: "Get team overage settings"
method: GET
path: "/v1/billing/team/{team_id}/overage-settings"
tags: ["billing"]
---

# Get team overage settings

`GET /v1/billing/team/{team_id}/overage-settings`

## Request

- Base URL: `https://api.pioneer.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pioneer.ai/v1/billing/team/{team_id}/overage-settings`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/pioneer/apis/brain-api/docs/v1/billing/team/:team_id/overage-settings/get.ts> (a function with typed inputs; its response is checked against the schema)

Return current overage billing configuration after billing authorization.

## Path parameters

- `team_id` string, required

## Response `200`

Successful Response

- OverageSettingsResponse: Current overage billing settings for a team.
  - `overage_enabled` boolean, required
  - `topup_amount` number, required: Credits added per top-up charge (1 credit = $0.01)
  - `topup_mode` string: Top-up mode: 'by' adds a fixed amount, 'to' restores balance to topup_amount
  - `charge_threshold` number, required: Trigger charge when remaining credits drop below this
  - `max_monthly_spend` number, nullable, required: Optional per-team monthly auto-refill cap in credits (null uses platform default)
  - `effective_monthly_cap` number, 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_charged` number, required: Credits charged via overages this month
  - `current_month_start` string, required: ISO timestamp of current billing month start
  - `usage_reset_hour` integer: Local hour when daily credits reset. 0-23 in usage_reset_timezone.
  - `usage_reset_timezone` string: IANA timezone used to interpret usage_reset_hour.
  - `usage_reset_hour_changed_at` string, nullable: ISO timestamp of last reset-hour change. Null if never changed.
  - `today_usage` number: Credits consumed since midnight today in the team's usage_reset_timezone (falls back to UTC for invalid timezone names).

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-24** `0e5e86e2bae5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pioneer/apis/brain-api/changes/v1/billing/team/:team_id/overage-settings/get.md)

---

[API](https://skmtc.dev/pioneer/apis/brain-api.md) - [All operations](https://skmtc.dev/pioneer/apis/brain-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pioneer/apis/brain-api/revisions/0e5e86e2bae5?raw)