## GetEnterpriseAIUsageSummary

**post** `/gitpod.v1.BillingService/GetEnterpriseAIUsageSummary`

Returns organization-level enterprise AI usage totals for reporting.

Reports BYOK (bring-your-own-key) token spend: cost in the
organization's billing currency plus token counts, with a per-model
breakdown. Credit-based usage from managed models is not included and
the credits field is not populated by this endpoint.

Use this method to:

- Report total BYOK AI spend (cost and tokens) for a date range
- Break down organization usage by model

Only available for enterprise organizations.

### Examples

- Get usage totals for January:

  Returns organization-wide BYOK spend for the month. Both dates are
  inclusive and the range must not exceed 31 days.

  ```yaml
  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  dateRange:
    startTime: "2024-01-01T00:00:00Z"
    endTime: "2024-01-31T00:00:00Z"
  ```

### Authorization

Requires `billing:read_usage` permission on the organization.

### Body Parameters

- `dateRange: DateRange`

  Date range for the summary. Both start and end dates are inclusive.
  Time-of-day is ignored; dates are truncated to midnight in the specified timezone.

  - `endTime: string`

    End time of the date range (exclusive).

  - `startTime: string`

    Start time of the date range (inclusive).

- `organizationId: string`

- `timezone: optional string`

  IANA timezone name used to bucket usage. When empty, defaults to "UTC".

### Returns

- `budget: optional EnterpriseAIUsageBudget`

  budget is unset when no monthly budget applies to the organization.

  - `currency: optional BillingCurrency`

    - `"BILLING_CURRENCY_UNSPECIFIED"`

    - `"BILLING_CURRENCY_USD"`

    - `"BILLING_CURRENCY_EUR"`

    - `"BILLING_CURRENCY_GBP"`

  - `monthlyCostLimitMicrounits: optional string`

  - `monthlyCreditLimit: optional string`

  - `monthToDateUsage: optional EnterpriseAIUsage`

    - `costMicrounits: optional string`

    - `credits: optional number`

    - `currency: optional BillingCurrency`

    - `tokens: optional EnterpriseAITokenUsage`

      - `cacheTokens: optional string`

      - `inputTokens: optional string`

      - `outputTokens: optional string`

      - `totalTokens: optional string`

  - `source: optional EnterpriseAIUsageBudgetSource`

    - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"`

    - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"`

    - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"`

  - `utilizationPercent: optional number`

- `calculatedAt: optional string`

  calculated_at is the time through which usage has been calculated.
  Usage after this timestamp may still be processing.

- `usage: optional EnterpriseAIUsage`

- `usageByModel: optional array of EnterpriseAIUsageByModel`

  - `model: optional string`

  - `unpricedUsage: optional EnterpriseAIUsage`

    Usage excluded from spend because no matching BYOK rate was configured.

  - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType`

    - `tokenType: optional ByokRateCardTokenType`

      - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"`

      - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"`

      - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"`

      - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"`

      - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"`

    - `usage: optional EnterpriseAIUsage`

  - `usage: optional EnterpriseAIUsage`

  - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType`

    - `tokenType: optional ByokRateCardTokenType`

    - `usage: optional EnterpriseAIUsage`

### Example

```http
curl https://app.gitpod.io/api/gitpod.v1.BillingService/GetEnterpriseAIUsageSummary \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{
          "dateRange": {
            "endTime": "2024-01-31T00:00:00Z",
            "startTime": "2024-01-01T00:00:00Z"
          },
          "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
        }'
```

#### Response

```json
{
  "budget": {
    "currency": "BILLING_CURRENCY_UNSPECIFIED",
    "monthlyCostLimitMicrounits": "monthlyCostLimitMicrounits",
    "monthlyCreditLimit": "monthlyCreditLimit",
    "monthToDateUsage": {
      "costMicrounits": "costMicrounits",
      "credits": 0,
      "currency": "BILLING_CURRENCY_UNSPECIFIED",
      "tokens": {
        "cacheTokens": "cacheTokens",
        "inputTokens": "inputTokens",
        "outputTokens": "outputTokens",
        "totalTokens": "totalTokens"
      }
    },
    "source": "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED",
    "utilizationPercent": 0
  },
  "calculatedAt": "2019-12-27T18:11:19.117Z",
  "usage": {
    "costMicrounits": "costMicrounits",
    "credits": 0,
    "currency": "BILLING_CURRENCY_UNSPECIFIED",
    "tokens": {
      "cacheTokens": "cacheTokens",
      "inputTokens": "inputTokens",
      "outputTokens": "outputTokens",
      "totalTokens": "totalTokens"
    }
  },
  "usageByModel": [
    {
      "model": "model",
      "unpricedUsage": {
        "costMicrounits": "costMicrounits",
        "credits": 0,
        "currency": "BILLING_CURRENCY_UNSPECIFIED",
        "tokens": {
          "cacheTokens": "cacheTokens",
          "inputTokens": "inputTokens",
          "outputTokens": "outputTokens",
          "totalTokens": "totalTokens"
        }
      },
      "unpricedUsageByTokenType": [
        {
          "tokenType": "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED",
          "usage": {
            "costMicrounits": "costMicrounits",
            "credits": 0,
            "currency": "BILLING_CURRENCY_UNSPECIFIED",
            "tokens": {
              "cacheTokens": "cacheTokens",
              "inputTokens": "inputTokens",
              "outputTokens": "outputTokens",
              "totalTokens": "totalTokens"
            }
          }
        }
      ],
      "usage": {
        "costMicrounits": "costMicrounits",
        "credits": 0,
        "currency": "BILLING_CURRENCY_UNSPECIFIED",
        "tokens": {
          "cacheTokens": "cacheTokens",
          "inputTokens": "inputTokens",
          "outputTokens": "outputTokens",
          "totalTokens": "totalTokens"
        }
      },
      "usageByTokenType": [
        {
          "tokenType": "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED",
          "usage": {
            "costMicrounits": "costMicrounits",
            "credits": 0,
            "currency": "BILLING_CURRENCY_UNSPECIFIED",
            "tokens": {
              "cacheTokens": "cacheTokens",
              "inputTokens": "inputTokens",
              "outputTokens": "outputTokens",
              "totalTokens": "totalTokens"
            }
          }
        }
      ]
    }
  ]
}
```