Cost Thresholds

List cost thresholds

Lists what people in your organization may spend per month on a usage type: the organization's own threshold; with teamId, that team's own and the own thresholds of the people in it; with userId, that user's own. A threshold that opens next month is listed with its validFrom in the future. Omit usageType for every type.

A team or user of another organization answers 404; a usage type nothing can enforce yet answers 422. A user falls under their own threshold, else their team's, else the organization's. To see which one a user is under, with their spend this month, use GET /v1/users/{userId}/cost-thresholds/{usageType}.

currency is the money a threshold written for the named team or user would carry: their cost-center currency, else the organization's primary.

Scope: policies:read, and teams:read when a team is named.

get/v1/cost-thresholds

Request

  • Base URL
    https://api.telgea.com
  • Auth
    API key in header x-api-key

Query parameters

usageType'DATA' | 'VOICE' | 'SMS' | 'MMS'

The usage type the threshold is on. VOICE is international calling: reaching it pauses international calls and SMS on the person's lines, where their market offers the pause. Other types answer 422 until the platform can enforce them.

Example:VOICE
teamIdstring uuid

UUID of the team the threshold is for. Omit with userId for the organization's own.

Example:2f6b0d3a-8c1e-4a7f-9b2d-1e3c4d5f6a70
userIdstring uuid

UUID of the user the threshold is for. Omit with teamId for the organization's own.

Example:9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01

Response

The thresholds in force or opening next month.

currencystring

ISO 4217 code a threshold written for the named team or user would carry. Absent when neither is named.

Example response

{
  "thresholds": [
    {
      "id": "5d0b2c1e-7f3a-4b6c-9e8d-2a1f0c3b4d5e",
      "usageType": "VOICE",
      "scope": "team",
      "teamId": "2f6b0d3a-8c1e-4a7f-9b2d-1e3c4d5f6a70",
      "maxAmount": 50,
      "currency": "EUR",
      "period": "monthly",
      "validFrom": "2026-10-01T00:00:00.000Z"
    }
  ],
  "currency": "EUR"
}

Changes

No recorded changes to this operation across all 1 revision of this API.