# Billing ## GetCreditUsageExport `client.Billing.GetCreditUsageExport(ctx, body) (*BillingGetCreditUsageExportResponse, error)` **post** `/gitpod.v1.BillingService/GetCreditUsageExport` Returns a signed download URL for a CSV export of credit usage. The URL points to an HTTP endpoint that streams gzip-compressed CSV and is valid for five minutes. The download must be made by the same principal that requested it, carrying its own bearer token. The export range may cover up to a year. For organizations without enterprise credit usage enabled (no billing contract start date), the export instead contains BYOK cost usage with a different column set, and groupBy=RESOURCE is rejected. Use this method to: - Export per-user daily credit usage for external reporting - Export a per-environment and per-conversation resource breakdown ### Examples - Export January's daily summary: ```yaml organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" dateRange: startTime: "2024-01-01T00:00:00Z" endTime: "2024-01-31T00:00:00Z" groupBy: CREDIT_USAGE_EXPORT_GROUP_BY_DAILY_SUMMARY ``` ### Authorization Requires `billing:read_usage` permission on the organization. ### Parameters - `body BillingGetCreditUsageExportParams` - `DateRange param.Field[DateRange]` Date range to export. Both start and end dates are inclusive; time-of-day is ignored. Unlike GetCreditUsageReport, the range may cover up to a year. - `OrganizationID param.Field[string]` - `GroupBy param.Field[CreditUsageExportGroupBy]` How to group the export data. Defaults to DAILY_SUMMARY. ### Returns - `type BillingGetCreditUsageExportResponse struct{…}` - `DownloadURL string` Signed download URL for the CSV export. Valid for five minutes, and only for the principal that requested it. ### Example ```go package main import ( "context" "fmt" "time" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" "github.com/gitpod-io/gitpod-sdk-go/shared" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) response, err := client.Billing.GetCreditUsageExport(context.TODO(), gitpod.BillingGetCreditUsageExportParams{ DateRange: gitpod.F(shared.DateRangeParam{ EndTime: gitpod.F(time.Now()), StartTime: gitpod.F(time.Now()), }), OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), GroupBy: gitpod.F(gitpod.CreditUsageExportGroupByDailySummary), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.DownloadURL) } ``` #### Response ```json { "downloadUrl": "downloadUrl" } ``` ## GetCreditUsageReport `client.Billing.GetCreditUsageReport(ctx, body) (*BillingGetCreditUsageReportResponse, error)` **post** `/gitpod.v1.BillingService/GetCreditUsageReport` Returns a daily credit usage report for an enterprise organization. Each day reports org-wide credits by usage type, plus per-user, per-team, per-environment, and per-conversation breakdowns (top consumers with the remainder aggregated into an "Others" bucket) and a per-model breakdown of intelligence usage. Use this method to: - Chart daily credit consumption over a date range - Attribute credit usage to users, teams, environments, and conversations - Restrict the report to a single user or service account ### Examples - Get the report for January: 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. A user without it can read their own usage by setting filter.subject to their own user identity; this self-access path is not available to service accounts. ### Parameters - `body BillingGetCreditUsageReportParams` - `DateRange param.Field[DateRange]` Date range for the report. Both start and end dates are inclusive. Time-of-day is ignored; dates are truncated to midnight in the specified timezone. The range must not exceed 31 days. - `OrganizationID param.Field[string]` - `Filter param.Field[CreditUsageReportFilter]` Optional filter narrowing the returned data. When unset or empty, the response preserves the default behavior (top-N users + "Others"). See CreditUsageReportFilter for per-field response-scoping semantics. - `Timezone param.Field[string]` IANA timezone name (e.g. "America/New_York", "Europe/Berlin") used to bucket daily usage. When empty, defaults to "UTC". ### Returns - `type BillingGetCreditUsageReportResponse struct{…}` - `DailyUsage []DailyCreditUsage` One entry per day in the requested date range. - `ConversationUsage []AgentExecutionCreditUsage` Per-agent-execution usage for this day (top conversations + "Others"). Empty agent_execution_id represents the "Others" aggregation bucket. - `AgentExecutionID string` Empty when representing the "Others" aggregation bucket. - `DisplayName string` - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` - `Date Time` Start of the day (midnight in the requested timezone). - `EnvironmentUsage []EnvironmentCreditUsage` Per-environment usage for this day (top environments + "Others"). Empty environment_id represents the "Others" aggregation bucket. - `DisplayName string` - `EnvironmentID string` Empty when representing the "Others" aggregation bucket. - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `OrgUsage []CreditsByType` Org-wide usage broken down by type. - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `TeamUsage []TeamCreditUsage` Per-team usage for this day (top teams + "Others"). Empty team_id represents the "Others" aggregation bucket. - `DisplayName string` - `TeamID string` Empty when representing the "Others" aggregation bucket. - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `UsageByModel []EnterpriseAIUsageByModel` Org-wide intelligence usage broken down by model. - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` - `UserUsage []UserCreditUsage` Per-user usage for this day (top users + "Others"). - `DisplayName string` - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `UsageByModel []EnterpriseAIUsageByModel` Intelligence usage broken down by model. - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `UserID string` Empty when representing the "Others" aggregation bucket. - `PeriodStart Time` Start of the billing period for this organization. Used by the frontend to filter out months before usage tracking began. - `UpdatedAt Time` When the report data was last computed. ### Example ```go package main import ( "context" "fmt" "time" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" "github.com/gitpod-io/gitpod-sdk-go/shared" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) response, err := client.Billing.GetCreditUsageReport(context.TODO(), gitpod.BillingGetCreditUsageReportParams{ DateRange: gitpod.F(shared.DateRangeParam{ EndTime: gitpod.F(time.Now()), StartTime: gitpod.F(time.Now()), }), OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.DailyUsage) } ``` #### Response ```json { "dailyUsage": [ { "conversationUsage": [ { "agentExecutionId": "agentExecutionId", "displayName": "displayName", "usage": [ { "credits": 0, "usageType": "USAGE_TYPE_UNSPECIFIED" } ] } ], "date": "2019-12-27T18:11:19.117Z", "environmentUsage": [ { "displayName": "displayName", "environmentId": "environmentId", "usage": [ { "credits": 0, "usageType": "USAGE_TYPE_UNSPECIFIED" } ] } ], "orgUsage": [ { "credits": 0, "usageType": "USAGE_TYPE_UNSPECIFIED" } ], "teamUsage": [ { "displayName": "displayName", "teamId": "teamId", "usage": [ { "credits": 0, "usageType": "USAGE_TYPE_UNSPECIFIED" } ] } ], "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" } } } ] } ], "userUsage": [ { "displayName": "displayName", "usage": [ { "credits": 0, "usageType": "USAGE_TYPE_UNSPECIFIED" } ], "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" } } } ] } ], "userId": "userId" } ] } ], "periodStart": "2019-12-27T18:11:19.117Z", "updatedAt": "2019-12-27T18:11:19.117Z" } ``` ## GetCumulativeCreditUsage `client.Billing.GetCumulativeCreditUsage(ctx, body) (*BillingGetCumulativeCreditUsageResponse, error)` **post** `/gitpod.v1.BillingService/GetCumulativeCreditUsage` Returns cumulative credit usage for an organization and its teams. Use this method to: - Get the total cumulative credit consumption as of a point in time - Get per-team cumulative usage with credit allocation (budget) comparison - Display team credit summaries on the usage page and team detail page - Display user budget utilization when user budgets are enabled ### Examples - Get current cumulative usage: ```yaml organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" ``` - Get cumulative usage as of a specific date: ```yaml organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" asOf: "2026-03-31T23:59:59Z" ``` ### Authorization Requires `billing:read_usage` permission on the organization. ### Parameters - `body BillingGetCumulativeCreditUsageParams` - `OrganizationID param.Field[string]` organization_id is the ID of the organization to get cumulative usage for. - `AsOf param.Field[Time]` as_of is the point in time to compute cumulative usage up to. Defaults to now if not set. ### Returns - `type BillingGetCumulativeCreditUsageResponse struct{…}` - `OrgUsage CumulativeCreditUsage` Org-wide cumulative usage, broken down by type and total. - `TotalCredits float64` Total credits consumed. - `UsageByType []CreditsByType` Credits consumed broken down by usage type. - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` - `PeriodStart Time` Start of the cumulative calculation period. Cumulative totals are computed from this date forward. - `TeamUsage []TeamCumulativeCreditUsage` Per-team cumulative usage with credit allocation comparison. Returns all teams (no top-N limit). - `CreditBudget string` The team's credit allocation (budget) in whole credits, if set. Not set means no allocation has been configured for this team. - `DisplayName string` - `TeamID string` - `Usage CumulativeCreditUsage` Cumulative credit usage for this team. - `UnteamedUsage CumulativeCreditUsage` Usage by members not assigned to any team. - `UserUsage []UserCreditBudgetUsage` Per-user month-to-date usage for every user with usage in the period. The budget fields on each entry are populated only when a monthly budget applies to that user. This list is not paginated or capped; for large organizations prefer ListEnterpriseUserCreditUsage. - `BudgetSource EnterpriseAIUserBudgetPolicySource` - `const EnterpriseAIUserBudgetPolicySourceUnspecified EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUserBudgetPolicySourceNone EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `const EnterpriseAIUserBudgetPolicySourceOrganization EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `const EnterpriseAIUserBudgetPolicySourceUser EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `CreditBudget string` - `DisplayName string` - `IsServiceAccount bool` True when user_id refers to a service account rather than a human user. The dashboard uses this to mark non-human accounts in admin tables. - `MonthToDateUsage CumulativeCreditUsage` CumulativeCreditUsage contains cumulative credit consumption totals. - `NoCap bool` - `OverBudget bool` - `UsageByModel []EnterpriseAIUsageByModel` Month-to-date intelligence usage broken down by model. - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` - `UserID string` - `UtilizationPercent float64` ### Example ```go package main import ( "context" "fmt" "time" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) response, err := client.Billing.GetCumulativeCreditUsage(context.TODO(), gitpod.BillingGetCumulativeCreditUsageParams{ OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), AsOf: gitpod.F(time.Now()), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.OrgUsage) } ``` #### Response ```json { "orgUsage": { "totalCredits": 0, "usageByType": [ { "credits": 0, "usageType": "USAGE_TYPE_UNSPECIFIED" } ] }, "periodStart": "2019-12-27T18:11:19.117Z", "teamUsage": [ { "creditBudget": "creditBudget", "displayName": "displayName", "teamId": "teamId", "usage": { "totalCredits": 0, "usageByType": [ { "credits": 0, "usageType": "USAGE_TYPE_UNSPECIFIED" } ] } } ], "unteamedUsage": { "totalCredits": 0, "usageByType": [ { "credits": 0, "usageType": "USAGE_TYPE_UNSPECIFIED" } ] }, "userUsage": [ { "budgetSource": "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED", "creditBudget": "creditBudget", "displayName": "displayName", "isServiceAccount": true, "monthToDateUsage": { "totalCredits": 0, "usageByType": [ { "credits": 0, "usageType": "USAGE_TYPE_UNSPECIFIED" } ] }, "noCap": true, "overBudget": true, "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" } } } ] } ], "userId": "userId", "utilizationPercent": 0 } ] } ``` ## GetEnterpriseAIUsageSummary `client.Billing.GetEnterpriseAIUsageSummary(ctx, body) (*BillingGetEnterpriseAIUsageSummaryResponse, error)` **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. ### Parameters - `body BillingGetEnterpriseAIUsageSummaryParams` - `DateRange param.Field[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. - `OrganizationID param.Field[string]` - `Timezone param.Field[string]` IANA timezone name used to bucket usage. When empty, defaults to "UTC". ### Returns - `type BillingGetEnterpriseAIUsageSummaryResponse struct{…}` - `Budget EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to the organization. - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `MonthlyCostLimitMicrounits string` - `MonthlyCreditLimit string` - `MonthToDateUsage EnterpriseAIUsage` - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `Source EnterpriseAIUsageBudgetSource` - `const EnterpriseAIUsageBudgetSourceUnspecified EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUsageBudgetSourceOrganization EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `const EnterpriseAIUsageBudgetSourceTeam EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `UtilizationPercent float64` - `CalculatedAt Time` calculated_at is the time through which usage has been calculated. Usage after this timestamp may still be processing. - `Usage EnterpriseAIUsage` - `UsageByModel []EnterpriseAIUsageByModel` - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` ### Example ```go package main import ( "context" "fmt" "time" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" "github.com/gitpod-io/gitpod-sdk-go/shared" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) response, err := client.Billing.GetEnterpriseAIUsageSummary(context.TODO(), gitpod.BillingGetEnterpriseAIUsageSummaryParams{ DateRange: gitpod.F(shared.DateRangeParam{ EndTime: gitpod.F(time.Now()), StartTime: gitpod.F(time.Now()), }), OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Budget) } ``` #### 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" } } } ] } ] } ``` ## GetEnterpriseAIUsageTimeSeries `client.Billing.GetEnterpriseAIUsageTimeSeries(ctx, body) (*BillingGetEnterpriseAIUsageTimeSeriesResponse, error)` **post** `/gitpod.v1.BillingService/GetEnterpriseAIUsageTimeSeries` Returns daily enterprise AI usage totals for the organization. Each day reports BYOK token spend (cost and tokens) with per-user, per-team, and per-model breakdowns. Per-user entries cover the top spenders with the remainder aggregated into an "Others" bucket; usage not attributed to a user or service account appears only in the daily totals. The credits field is not populated by this endpoint. When filter.subject is set the response contains only that subject's usage: daily totals and the team breakdown are omitted, and the model breakdown covers the subject only. Use this method to: - Chart daily BYOK AI spend over a date range - Feed daily per-user usage into external dashboards - Restrict the response to a single user or service account Only available for enterprise organizations. ### Examples - Get daily usage for January: Returns one entry per day with per-user, per-team, and per-model breakdowns. 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. ### Parameters - `body BillingGetEnterpriseAIUsageTimeSeriesParams` - `DateRange param.Field[DateRange]` Date range for the daily usage series. Both start and end dates are inclusive. Time-of-day is ignored; dates are truncated to midnight in the specified timezone. - `OrganizationID param.Field[string]` - `Filter param.Field[EnterpriseAIUsageTimeSeriesFilter]` - `Timezone param.Field[string]` IANA timezone name used to bucket daily usage. When empty, defaults to "UTC". ### Returns - `type BillingGetEnterpriseAIUsageTimeSeriesResponse struct{…}` - `CalculatedAt Time` calculated_at is the time through which usage has been calculated. Usage after this timestamp may still be processing. - `DailyUsage []DailyEnterpriseAIUsage` - `Date Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Budget EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to the organization. - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `MonthlyCostLimitMicrounits string` - `MonthlyCreditLimit string` - `MonthToDateUsage EnterpriseAIUsage` - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `Source EnterpriseAIUsageBudgetSource` - `const EnterpriseAIUsageBudgetSourceUnspecified EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUsageBudgetSourceOrganization EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `const EnterpriseAIUsageBudgetSourceTeam EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `UtilizationPercent float64` - `TeamUsage []TeamEnterpriseAIUsage` - `Budget EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to this team. - `DisplayName string` - `TeamID string` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByModel []EnterpriseAIUsageByModel` Usage for this day broken down by model. When the request filters by subject, contains only that subject's model usage. - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` - `UserUsage []UserEnterpriseAIUsage` - `DisplayName string` - `Usage EnterpriseAIUsage` - `UserID string` Empty when representing the "Others" aggregation bucket. ### Example ```go package main import ( "context" "fmt" "time" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" "github.com/gitpod-io/gitpod-sdk-go/shared" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) response, err := client.Billing.GetEnterpriseAIUsageTimeSeries(context.TODO(), gitpod.BillingGetEnterpriseAIUsageTimeSeriesParams{ DateRange: gitpod.F(shared.DateRangeParam{ EndTime: gitpod.F(time.Now()), StartTime: gitpod.F(time.Now()), }), OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.CalculatedAt) } ``` #### Response ```json { "calculatedAt": "2019-12-27T18:11:19.117Z", "dailyUsage": [ { "date": "2019-12-27T18:11:19.117Z", "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 }, "teamUsage": [ { "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 }, "displayName": "displayName", "teamId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "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" } } } ] } ], "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" } } } ] } ], "userUsage": [ { "displayName": "displayName", "usage": { "costMicrounits": "costMicrounits", "credits": 0, "currency": "BILLING_CURRENCY_UNSPECIFIED", "tokens": { "cacheTokens": "cacheTokens", "inputTokens": "inputTokens", "outputTokens": "outputTokens", "totalTokens": "totalTokens" } }, "userId": "userId" } ] } ] } ``` ## ListEnterpriseAITeamUsage `client.Billing.ListEnterpriseAITeamUsage(ctx, params) (*TeamUsagePage[TeamEnterpriseAIUsage], error)` **post** `/gitpod.v1.BillingService/ListEnterpriseAITeamUsage` Lists enterprise AI usage grouped by team. Reports BYOK token spend per team (cost and tokens) with each team's monthly budget when one applies. The credits field is not populated by this endpoint. Use this method to: - Compare BYOK AI spend across teams - Track team budget utilization - Filter usage to specific teams Only available for enterprise organizations. ### Examples - List team usage for January: Returns BYOK spend per team with monthly budgets. 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. ### Parameters - `params BillingListEnterpriseAITeamUsageParams` - `DateRange param.Field[DateRange]` Body param: Date range for the team usage list. Both start and end dates are inclusive. Time-of-day is ignored; dates are truncated to midnight in the specified timezone. - `OrganizationID param.Field[string]` Body param - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `Filter param.Field[BillingListEnterpriseAITeamUsageParamsFilter]` Body param - `TeamIDs []string` - `Pagination param.Field[BillingListEnterpriseAITeamUsageParamsPagination]` Body param - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `Timezone param.Field[string]` Body param: IANA timezone name used to bucket usage. When empty, defaults to "UTC". ### Returns - `type TeamEnterpriseAIUsage struct{…}` - `Budget EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to this team. - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `MonthlyCostLimitMicrounits string` - `MonthlyCreditLimit string` - `MonthToDateUsage EnterpriseAIUsage` - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `Source EnterpriseAIUsageBudgetSource` - `const EnterpriseAIUsageBudgetSourceUnspecified EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUsageBudgetSourceOrganization EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `const EnterpriseAIUsageBudgetSourceTeam EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `UtilizationPercent float64` - `DisplayName string` - `TeamID string` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` ### Example ```go package main import ( "context" "fmt" "time" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" "github.com/gitpod-io/gitpod-sdk-go/shared" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) page, err := client.Billing.ListEnterpriseAITeamUsage(context.TODO(), gitpod.BillingListEnterpriseAITeamUsageParams{ DateRange: gitpod.F(shared.DateRangeParam{ EndTime: gitpod.F(time.Now()), StartTime: gitpod.F(time.Now()), }), OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "calculatedAt": "2019-12-27T18:11:19.117Z", "pagination": { "nextToken": "nextToken" }, "teamUsage": [ { "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 }, "displayName": "displayName", "teamId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "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" } } } ] } ] } ``` ## ListEnterpriseAIUserUsage `client.Billing.ListEnterpriseAIUserUsage(ctx, params) (*UserUsagePage[UserCostBudgetUsage], error)` **post** `/gitpod.v1.BillingService/ListEnterpriseAIUserUsage` Lists enterprise AI usage grouped by user with effective monthly budget data. Reports BYOK token spend (cost and tokens) for each user and service account with attributed usage in the date range, including each subject's effective monthly budget. Usage not attributed to a user or service account is excluded, so the sum across subjects can be less than the organization totals from GetEnterpriseAIUsageSummary. The credits field is not populated by this endpoint. Budget fields (month_to_date_usage, utilization_percent, over_budget) are computed from usage inside the requested date range measured against the monthly limit. Send a range that starts on the first day of the month for true month-to-date figures. Use this method to: - Export per-user BYOK AI spend to external reporting - Identify the highest spenders in the organization - Track per-user budget utilization and over-budget users Only available for enterprise organizations. ### Examples - List user usage for January: Returns per-user BYOK spend with effective budgets, highest spend first. 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. Callers without it can read their own usage by setting filter.subject to themselves. ### Parameters - `params BillingListEnterpriseAIUserUsageParams` - `DateRange param.Field[DateRange]` Body param: Date range for the user usage list. Both start and end dates are inclusive. Time-of-day is ignored; dates are truncated to midnight in the specified timezone. - `OrganizationID param.Field[string]` Body param - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `Filter param.Field[BillingListEnterpriseAIUserUsageParamsFilter]` Body param: Optional filter narrowing the returned user usage. When set to a subject, the response contains only usage for that user or service account. - `Subject Subject` Restrict the user usage list to a single subject. The subject must be PRINCIPAL_USER or PRINCIPAL_SERVICE_ACCOUNT and belong to the request's organization. - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Pagination param.Field[BillingListEnterpriseAIUserUsageParamsPagination]` Body param - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `Sort param.Field[BillingListEnterpriseAIUserUsageParamsSort]` Body param: sort controls the ordering of results. Defaults to total spend descending. - `Field BillingListEnterpriseAIUserUsageParamsSortField` - `const BillingListEnterpriseAIUserUsageParamsSortFieldSortFieldUnspecified BillingListEnterpriseAIUserUsageParamsSortField = "SORT_FIELD_UNSPECIFIED"` - `const BillingListEnterpriseAIUserUsageParamsSortFieldSortFieldUsage BillingListEnterpriseAIUserUsageParamsSortField = "SORT_FIELD_USAGE"` - `const BillingListEnterpriseAIUserUsageParamsSortFieldSortFieldDisplayName BillingListEnterpriseAIUserUsageParamsSortField = "SORT_FIELD_DISPLAY_NAME"` - `const BillingListEnterpriseAIUserUsageParamsSortFieldSortFieldBudget BillingListEnterpriseAIUserUsageParamsSortField = "SORT_FIELD_BUDGET"` - `const BillingListEnterpriseAIUserUsageParamsSortFieldSortFieldBudgetUsed BillingListEnterpriseAIUserUsageParamsSortField = "SORT_FIELD_BUDGET_USED"` - `Order SortOrder` - `const SortOrderUnspecified SortOrder = "SORT_ORDER_UNSPECIFIED"` - `const SortOrderAsc SortOrder = "SORT_ORDER_ASC"` - `const SortOrderDesc SortOrder = "SORT_ORDER_DESC"` - `Timezone param.Field[string]` Body param: IANA timezone name used to bucket usage. When empty, defaults to "UTC". ### Returns - `type UserCostBudgetUsage struct{…}` - `BudgetSource EnterpriseAIUserBudgetPolicySource` - `const EnterpriseAIUserBudgetPolicySourceUnspecified EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUserBudgetPolicySourceNone EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `const EnterpriseAIUserBudgetPolicySourceOrganization EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `const EnterpriseAIUserBudgetPolicySourceUser EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `DisplayName string` - `IsServiceAccount bool` - `MonthlyCostLimitMicrounits string` - `MonthToDateUsage EnterpriseAIUsage` Usage within the requested date range. Reflects true month-to-date usage when the range starts on the first day of the month. - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `NoCap bool` - `OverBudget bool` - `UserID string` - `UtilizationPercent float64` ### Example ```go package main import ( "context" "fmt" "time" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" "github.com/gitpod-io/gitpod-sdk-go/shared" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) page, err := client.Billing.ListEnterpriseAIUserUsage(context.TODO(), gitpod.BillingListEnterpriseAIUserUsageParams{ DateRange: gitpod.F(shared.DateRangeParam{ EndTime: gitpod.F(time.Now()), StartTime: gitpod.F(time.Now()), }), OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "calculatedAt": "2019-12-27T18:11:19.117Z", "pagination": { "nextToken": "nextToken" }, "totalCount": 0, "userUsage": [ { "budgetSource": "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED", "currency": "BILLING_CURRENCY_UNSPECIFIED", "displayName": "displayName", "isServiceAccount": true, "monthlyCostLimitMicrounits": "monthlyCostLimitMicrounits", "monthToDateUsage": { "costMicrounits": "costMicrounits", "credits": 0, "currency": "BILLING_CURRENCY_UNSPECIFIED", "tokens": { "cacheTokens": "cacheTokens", "inputTokens": "inputTokens", "outputTokens": "outputTokens", "totalTokens": "totalTokens" } }, "noCap": true, "overBudget": true, "userId": "userId", "utilizationPercent": 0 } ] } ``` ## ListEnterpriseUserCreditUsage `client.Billing.ListEnterpriseUserCreditUsage(ctx, params) (*UserUsagePage[UserCreditBudgetUsage], error)` **post** `/gitpod.v1.BillingService/ListEnterpriseUserCreditUsage` Lists per-user month-to-date credit usage with effective monthly budgets. Results are ordered by total credits descending so the highest spenders appear first, with user_id as a stable tiebreaker. Use cursor pagination to walk the full set for large organizations. The default SORT_FIELD_USAGE ordering supports cursor pagination over any number of users. Sorting by display name, budget, or budget utilization computes the order in memory and is limited to organizations with at most 10,000 users; beyond that, use SORT_FIELD_USAGE. Because month-to-date figures are recomputed per request, hold a date range stable across a paginated walk to keep page tokens valid. Use this method to: - Export per-user credit usage to external reporting - Identify the highest spenders in the organization - Track per-user budget utilization and over-budget users ### Examples - List user usage for the current month: ```yaml organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" pagination: pageSize: 50 ``` ### Authorization Requires `billing:read_usage` permission on the organization. ### Parameters - `params BillingListEnterpriseUserCreditUsageParams` - `OrganizationID param.Field[string]` Body param: organization_id is the ID of the organization to list user credit usage for. - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `AsOf param.Field[Time]` Body param: as_of is the point in time to compute month-to-date usage up to. Defaults to now if not set. - `Pagination param.Field[BillingListEnterpriseUserCreditUsageParamsPagination]` Body param - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `Sort param.Field[BillingListEnterpriseUserCreditUsageParamsSort]` Body param: sort controls the ordering of results. Defaults to total credits descending. - `Field BillingListEnterpriseUserCreditUsageParamsSortField` - `const BillingListEnterpriseUserCreditUsageParamsSortFieldSortFieldUnspecified BillingListEnterpriseUserCreditUsageParamsSortField = "SORT_FIELD_UNSPECIFIED"` - `const BillingListEnterpriseUserCreditUsageParamsSortFieldSortFieldUsage BillingListEnterpriseUserCreditUsageParamsSortField = "SORT_FIELD_USAGE"` - `const BillingListEnterpriseUserCreditUsageParamsSortFieldSortFieldDisplayName BillingListEnterpriseUserCreditUsageParamsSortField = "SORT_FIELD_DISPLAY_NAME"` - `const BillingListEnterpriseUserCreditUsageParamsSortFieldSortFieldBudget BillingListEnterpriseUserCreditUsageParamsSortField = "SORT_FIELD_BUDGET"` - `const BillingListEnterpriseUserCreditUsageParamsSortFieldSortFieldBudgetUsed BillingListEnterpriseUserCreditUsageParamsSortField = "SORT_FIELD_BUDGET_USED"` - `Order SortOrder` - `const SortOrderUnspecified SortOrder = "SORT_ORDER_UNSPECIFIED"` - `const SortOrderAsc SortOrder = "SORT_ORDER_ASC"` - `const SortOrderDesc SortOrder = "SORT_ORDER_DESC"` ### Returns - `type UserCreditBudgetUsage struct{…}` - `BudgetSource EnterpriseAIUserBudgetPolicySource` - `const EnterpriseAIUserBudgetPolicySourceUnspecified EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUserBudgetPolicySourceNone EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `const EnterpriseAIUserBudgetPolicySourceOrganization EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `const EnterpriseAIUserBudgetPolicySourceUser EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `CreditBudget string` - `DisplayName string` - `IsServiceAccount bool` True when user_id refers to a service account rather than a human user. The dashboard uses this to mark non-human accounts in admin tables. - `MonthToDateUsage CumulativeCreditUsage` CumulativeCreditUsage contains cumulative credit consumption totals. - `TotalCredits float64` Total credits consumed. - `UsageByType []CreditsByType` Credits consumed broken down by usage type. - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` - `NoCap bool` - `OverBudget bool` - `UsageByModel []EnterpriseAIUsageByModel` Month-to-date intelligence usage broken down by model. - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` - `UserID string` - `UtilizationPercent float64` ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) page, err := client.Billing.ListEnterpriseUserCreditUsage(context.TODO(), gitpod.BillingListEnterpriseUserCreditUsageParams{ OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), Pagination: gitpod.F(gitpod.BillingListEnterpriseUserCreditUsageParamsPagination{ PageSize: gitpod.F(int64(50)), }), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "pagination": { "nextToken": "nextToken" }, "totalCount": 0, "userUsage": [ { "budgetSource": "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED", "creditBudget": "creditBudget", "displayName": "displayName", "isServiceAccount": true, "monthToDateUsage": { "totalCredits": 0, "usageByType": [ { "credits": 0, "usageType": "USAGE_TYPE_UNSPECIFIED" } ] }, "noCap": true, "overBudget": true, "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" } } } ] } ], "userId": "userId", "utilizationPercent": 0 } ] } ``` ## Domain Types ### Agent Execution Credit Usage - `type AgentExecutionCreditUsage struct{…}` AgentExecutionCreditUsage contains a single agent execution's credit usage for a day, broken down by type. - `AgentExecutionID string` Empty when representing the "Others" aggregation bucket. - `DisplayName string` - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` ### Billing Currency - `type BillingCurrency string` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` ### Byok Rate Card Token Type - `type ByokRateCardTokenType string` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` ### Credit Usage Export Group By - `type CreditUsageExportGroupBy string` How to group the credit usage export data. - `const CreditUsageExportGroupByUnspecified CreditUsageExportGroupBy = "CREDIT_USAGE_EXPORT_GROUP_BY_UNSPECIFIED"` - `const CreditUsageExportGroupByDailySummary CreditUsageExportGroupBy = "CREDIT_USAGE_EXPORT_GROUP_BY_DAILY_SUMMARY"` - `const CreditUsageExportGroupByResource CreditUsageExportGroupBy = "CREDIT_USAGE_EXPORT_GROUP_BY_RESOURCE"` ### Credit Usage Report Filter - `type CreditUsageReportFilter struct{…}` CreditUsageReportFilter narrows the data returned by GetCreditUsageReport. Wrapping filters in a message (rather than adding bare fields) lets future filters (team, environment, resource kind) be added without further breaking changes. - `Subject Subject` Restrict the per-user breakdown to a single subject. The subject must be PRINCIPAL_USER or PRINCIPAL_SERVICE_ACCOUNT and belong to the request's organization. When unset, the report returns the default top-N users + "Others" breakdown. When this field is set: - daily_usage[*].user_usage contains rows only for the requested subject; no "Others" aggregation bucket is produced. - daily_usage[*].org_usage, team_usage, environment_usage, and conversation_usage are omitted (empty). Callers that need those sections should issue an unfiltered call. - period_start and updated_at remain populated. - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` ### Credits By Type - `type CreditsByType struct{…}` CreditsByType contains credits consumed for a single usage type. - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` ### Cumulative Credit Usage - `type CumulativeCreditUsage struct{…}` CumulativeCreditUsage contains cumulative credit consumption totals. - `TotalCredits float64` Total credits consumed. - `UsageByType []CreditsByType` Credits consumed broken down by usage type. - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` ### Daily Credit Usage - `type DailyCreditUsage struct{…}` DailyCreditUsage contains credit usage for a single day. - `ConversationUsage []AgentExecutionCreditUsage` Per-agent-execution usage for this day (top conversations + "Others"). Empty agent_execution_id represents the "Others" aggregation bucket. - `AgentExecutionID string` Empty when representing the "Others" aggregation bucket. - `DisplayName string` - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` - `Date Time` Start of the day (midnight in the requested timezone). - `EnvironmentUsage []EnvironmentCreditUsage` Per-environment usage for this day (top environments + "Others"). Empty environment_id represents the "Others" aggregation bucket. - `DisplayName string` - `EnvironmentID string` Empty when representing the "Others" aggregation bucket. - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `OrgUsage []CreditsByType` Org-wide usage broken down by type. - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `TeamUsage []TeamCreditUsage` Per-team usage for this day (top teams + "Others"). Empty team_id represents the "Others" aggregation bucket. - `DisplayName string` - `TeamID string` Empty when representing the "Others" aggregation bucket. - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `UsageByModel []EnterpriseAIUsageByModel` Org-wide intelligence usage broken down by model. - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` - `UserUsage []UserCreditUsage` Per-user usage for this day (top users + "Others"). - `DisplayName string` - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `UsageByModel []EnterpriseAIUsageByModel` Intelligence usage broken down by model. - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `UserID string` Empty when representing the "Others" aggregation bucket. ### Daily Enterprise AI Usage - `type DailyEnterpriseAIUsage struct{…}` - `Date Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Budget EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to the organization. - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `MonthlyCostLimitMicrounits string` - `MonthlyCreditLimit string` - `MonthToDateUsage EnterpriseAIUsage` - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `Source EnterpriseAIUsageBudgetSource` - `const EnterpriseAIUsageBudgetSourceUnspecified EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUsageBudgetSourceOrganization EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `const EnterpriseAIUsageBudgetSourceTeam EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `UtilizationPercent float64` - `TeamUsage []TeamEnterpriseAIUsage` - `Budget EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to this team. - `DisplayName string` - `TeamID string` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByModel []EnterpriseAIUsageByModel` Usage for this day broken down by model. When the request filters by subject, contains only that subject's model usage. - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` - `UserUsage []UserEnterpriseAIUsage` - `DisplayName string` - `Usage EnterpriseAIUsage` - `UserID string` Empty when representing the "Others" aggregation bucket. ### Enterprise AI Token Usage - `type EnterpriseAITokenUsage struct{…}` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` ### Enterprise AI Usage - `type EnterpriseAIUsage struct{…}` - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` ### Enterprise AI Usage Budget - `type EnterpriseAIUsageBudget struct{…}` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `MonthlyCostLimitMicrounits string` - `MonthlyCreditLimit string` - `MonthToDateUsage EnterpriseAIUsage` - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `Source EnterpriseAIUsageBudgetSource` - `const EnterpriseAIUsageBudgetSourceUnspecified EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUsageBudgetSourceOrganization EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `const EnterpriseAIUsageBudgetSourceTeam EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `UtilizationPercent float64` ### Enterprise AI Usage Budget Source - `type EnterpriseAIUsageBudgetSource string` - `const EnterpriseAIUsageBudgetSourceUnspecified EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUsageBudgetSourceOrganization EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `const EnterpriseAIUsageBudgetSourceTeam EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` ### Enterprise AI Usage By Model - `type EnterpriseAIUsageByModel struct{…}` - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` ### Enterprise AI Usage By Token Type - `type EnterpriseAIUsageByTokenType struct{…}` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` ### Enterprise AI Usage Time Series Filter - `type EnterpriseAIUsageTimeSeriesFilter struct{…}` - `Subject Subject` Restrict the per-user breakdown to a single subject. - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` ### Enterprise AI User Budget Policy Source - `type EnterpriseAIUserBudgetPolicySource string` - `const EnterpriseAIUserBudgetPolicySourceUnspecified EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUserBudgetPolicySourceNone EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `const EnterpriseAIUserBudgetPolicySourceOrganization EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `const EnterpriseAIUserBudgetPolicySourceUser EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` ### Environment Credit Usage - `type EnvironmentCreditUsage struct{…}` EnvironmentCreditUsage contains a single environment's credit usage for a day, broken down by type. - `DisplayName string` - `EnvironmentID string` Empty when representing the "Others" aggregation bucket. - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` ### Team Credit Usage - `type TeamCreditUsage struct{…}` TeamCreditUsage contains a single team's credit usage for a day, broken down by type. - `DisplayName string` - `TeamID string` Empty when representing the "Others" aggregation bucket. - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` ### Team Cumulative Credit Usage - `type TeamCumulativeCreditUsage struct{…}` TeamCumulativeCreditUsage contains a team's cumulative credit usage and allocation. - `CreditBudget string` The team's credit allocation (budget) in whole credits, if set. Not set means no allocation has been configured for this team. - `DisplayName string` - `TeamID string` - `Usage CumulativeCreditUsage` Cumulative credit usage for this team. - `TotalCredits float64` Total credits consumed. - `UsageByType []CreditsByType` Credits consumed broken down by usage type. - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` ### Team Enterprise AI Usage - `type TeamEnterpriseAIUsage struct{…}` - `Budget EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to this team. - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `MonthlyCostLimitMicrounits string` - `MonthlyCreditLimit string` - `MonthToDateUsage EnterpriseAIUsage` - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `Source EnterpriseAIUsageBudgetSource` - `const EnterpriseAIUsageBudgetSourceUnspecified EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUsageBudgetSourceOrganization EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `const EnterpriseAIUsageBudgetSourceTeam EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `UtilizationPercent float64` - `DisplayName string` - `TeamID string` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` ### Usage Type - `type UsageType string` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` ### User Cost Budget Usage - `type UserCostBudgetUsage struct{…}` - `BudgetSource EnterpriseAIUserBudgetPolicySource` - `const EnterpriseAIUserBudgetPolicySourceUnspecified EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUserBudgetPolicySourceNone EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `const EnterpriseAIUserBudgetPolicySourceOrganization EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `const EnterpriseAIUserBudgetPolicySourceUser EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `DisplayName string` - `IsServiceAccount bool` - `MonthlyCostLimitMicrounits string` - `MonthToDateUsage EnterpriseAIUsage` Usage within the requested date range. Reflects true month-to-date usage when the range starts on the first day of the month. - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `NoCap bool` - `OverBudget bool` - `UserID string` - `UtilizationPercent float64` ### User Credit Budget Usage - `type UserCreditBudgetUsage struct{…}` - `BudgetSource EnterpriseAIUserBudgetPolicySource` - `const EnterpriseAIUserBudgetPolicySourceUnspecified EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `const EnterpriseAIUserBudgetPolicySourceNone EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `const EnterpriseAIUserBudgetPolicySourceOrganization EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `const EnterpriseAIUserBudgetPolicySourceUser EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `CreditBudget string` - `DisplayName string` - `IsServiceAccount bool` True when user_id refers to a service account rather than a human user. The dashboard uses this to mark non-human accounts in admin tables. - `MonthToDateUsage CumulativeCreditUsage` CumulativeCreditUsage contains cumulative credit consumption totals. - `TotalCredits float64` Total credits consumed. - `UsageByType []CreditsByType` Credits consumed broken down by usage type. - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` - `NoCap bool` - `OverBudget bool` - `UsageByModel []EnterpriseAIUsageByModel` Month-to-date intelligence usage broken down by model. - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` - `UserID string` - `UtilizationPercent float64` ### User Credit Usage - `type UserCreditUsage struct{…}` UserCreditUsage contains a single user's credit usage, broken down by type. - `DisplayName string` - `Usage []CreditsByType` - `Credits float64` - `UsageType UsageType` UsageType identifies the category of usage. - `const UsageTypeUnspecified UsageType = "USAGE_TYPE_UNSPECIFIED"` - `const UsageTypeEnvironment UsageType = "USAGE_TYPE_ENVIRONMENT"` - `const UsageTypeAgentic UsageType = "USAGE_TYPE_AGENTIC"` - `UsageByModel []EnterpriseAIUsageByModel` Intelligence usage broken down by model. - `Model string` - `UnpricedUsage EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `UnpricedUsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `const ByokRateCardTokenTypeUnspecified ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `const ByokRateCardTokenTypeInput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `const ByokRateCardTokenTypeOutput ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `const ByokRateCardTokenTypeCacheRead ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `const ByokRateCardTokenTypeCacheWrite ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `Usage EnterpriseAIUsage` - `Usage EnterpriseAIUsage` - `UsageByTokenType []EnterpriseAIUsageByTokenType` - `TokenType ByokRateCardTokenType` - `Usage EnterpriseAIUsage` - `UserID string` Empty when representing the "Others" aggregation bucket. ### User Enterprise AI Usage - `type UserEnterpriseAIUsage struct{…}` - `DisplayName string` - `Usage EnterpriseAIUsage` - `CostMicrounits string` - `Credits float64` - `Currency BillingCurrency` - `const BillingCurrencyUnspecified BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED"` - `const BillingCurrencyUsd BillingCurrency = "BILLING_CURRENCY_USD"` - `const BillingCurrencyEur BillingCurrency = "BILLING_CURRENCY_EUR"` - `const BillingCurrencyGbp BillingCurrency = "BILLING_CURRENCY_GBP"` - `Tokens EnterpriseAITokenUsage` - `CacheTokens string` - `InputTokens string` - `OutputTokens string` - `TotalTokens string` - `UserID string` Empty when representing the "Others" aggregation bucket.