# Billing ## GetCreditUsageExport **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. ### Body Parameters - `dateRange: 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. - `endTime: string` End time of the date range (exclusive). - `startTime: string` Start time of the date range (inclusive). - `organizationId: string` - `groupBy: optional CreditUsageExportGroupBy` How to group the export data. Defaults to DAILY_SUMMARY. - `"CREDIT_USAGE_EXPORT_GROUP_BY_UNSPECIFIED"` - `"CREDIT_USAGE_EXPORT_GROUP_BY_DAILY_SUMMARY"` - `"CREDIT_USAGE_EXPORT_GROUP_BY_RESOURCE"` ### Returns - `downloadUrl: optional string` Signed download URL for the CSV export. Valid for five minutes, and only for the principal that requested it. ### Example ```http curl https://app.gitpod.io/api/gitpod.v1.BillingService/GetCreditUsageExport \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $GITPOD_API_KEY" \ -d '{ "dateRange": { "endTime": "2024-01-31T00:00:00Z", "startTime": "2024-01-01T00:00:00Z" }, "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047" }' ``` #### Response ```json { "downloadUrl": "downloadUrl" } ``` ## GetCreditUsageReport **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. ### Body Parameters - `dateRange: 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. - `endTime: string` End time of the date range (exclusive). - `startTime: string` Start time of the date range (inclusive). - `organizationId: string` - `filter: optional 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. - `subject: optional 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: optional string` id is the UUID of the subject - `principal: optional Principal` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` - `timezone: optional string` IANA timezone name (e.g. "America/New_York", "Europe/Berlin") used to bucket daily usage. When empty, defaults to "UTC". ### Returns - `dailyUsage: optional array of DailyCreditUsage` One entry per day in the requested date range. - `conversationUsage: optional array of AgentExecutionCreditUsage` Per-agent-execution usage for this day (top conversations + "Others"). Empty agent_execution_id represents the "Others" aggregation bucket. - `agentExecutionId: optional string` Empty when representing the "Others" aggregation bucket. - `displayName: optional string` - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` - `date: optional string` Start of the day (midnight in the requested timezone). - `environmentUsage: optional array of EnvironmentCreditUsage` Per-environment usage for this day (top environments + "Others"). Empty environment_id represents the "Others" aggregation bucket. - `displayName: optional string` - `environmentId: optional string` Empty when representing the "Others" aggregation bucket. - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `orgUsage: optional array of CreditsByType` Org-wide usage broken down by type. - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `teamUsage: optional array of TeamCreditUsage` Per-team usage for this day (top teams + "Others"). Empty team_id represents the "Others" aggregation bucket. - `displayName: optional string` - `teamId: optional string` Empty when representing the "Others" aggregation bucket. - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `usageByModel: optional array of EnterpriseAIUsageByModel` Org-wide intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userUsage: optional array of UserCreditUsage` Per-user usage for this day (top users + "Others"). - `displayName: optional string` - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `usageByModel: optional array of EnterpriseAIUsageByModel` Intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `userId: optional string` Empty when representing the "Others" aggregation bucket. - `periodStart: optional string` Start of the billing period for this organization. Used by the frontend to filter out months before usage tracking began. - `updatedAt: optional string` When the report data was last computed. ### Example ```http curl https://app.gitpod.io/api/gitpod.v1.BillingService/GetCreditUsageReport \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $GITPOD_API_KEY" \ -d '{ "dateRange": { "endTime": "2024-01-31T00:00:00Z", "startTime": "2024-01-01T00:00:00Z" }, "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047" }' ``` #### Response ```json { "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 **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. ### Body Parameters - `organizationId: string` organization_id is the ID of the organization to get cumulative usage for. - `asOf: optional string` as_of is the point in time to compute cumulative usage up to. Defaults to now if not set. ### Returns - `orgUsage: optional CumulativeCreditUsage` Org-wide cumulative usage, broken down by type and total. - `totalCredits: optional number` Total credits consumed. - `usageByType: optional array of CreditsByType` Credits consumed broken down by usage type. - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` - `periodStart: optional string` Start of the cumulative calculation period. Cumulative totals are computed from this date forward. - `teamUsage: optional array of TeamCumulativeCreditUsage` Per-team cumulative usage with credit allocation comparison. Returns all teams (no top-N limit). - `creditBudget: optional string` The team's credit allocation (budget) in whole credits, if set. Not set means no allocation has been configured for this team. - `displayName: optional string` - `teamId: optional string` - `usage: optional CumulativeCreditUsage` Cumulative credit usage for this team. - `unteamedUsage: optional CumulativeCreditUsage` Usage by members not assigned to any team. - `userUsage: optional array of 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: optional EnterpriseAIUserBudgetPolicySource` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `creditBudget: optional string` - `displayName: optional string` - `isServiceAccount: optional boolean` 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: optional CumulativeCreditUsage` CumulativeCreditUsage contains cumulative credit consumption totals. - `noCap: optional boolean` - `overBudget: optional boolean` - `usageByModel: optional array of EnterpriseAIUsageByModel` Month-to-date intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userId: optional string` - `utilizationPercent: optional number` ### Example ```http curl https://app.gitpod.io/api/gitpod.v1.BillingService/GetCumulativeCreditUsage \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $GITPOD_API_KEY" \ -d '{ "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047" }' ``` #### 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 **post** `/gitpod.v1.BillingService/GetEnterpriseAIUsageSummary` Returns organization-level enterprise AI usage totals for reporting. Reports BYOK (bring-your-own-key) token spend: cost in the organization's billing currency plus token counts, with a per-model breakdown. Credit-based usage from managed models is not included and the credits field is not populated by this endpoint. Use this method to: - Report total BYOK AI spend (cost and tokens) for a date range - Break down organization usage by model Only available for enterprise organizations. ### Examples - Get usage totals for January: Returns organization-wide BYOK spend for the month. Both dates are inclusive and the range must not exceed 31 days. ```yaml organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" dateRange: startTime: "2024-01-01T00:00:00Z" endTime: "2024-01-31T00:00:00Z" ``` ### Authorization Requires `billing:read_usage` permission on the organization. ### Body Parameters - `dateRange: DateRange` Date range for the summary. Both start and end dates are inclusive. Time-of-day is ignored; dates are truncated to midnight in the specified timezone. - `endTime: string` End time of the date range (exclusive). - `startTime: string` Start time of the date range (inclusive). - `organizationId: string` - `timezone: optional string` IANA timezone name used to bucket usage. When empty, defaults to "UTC". ### Returns - `budget: optional EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to the organization. - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `monthlyCostLimitMicrounits: optional string` - `monthlyCreditLimit: optional string` - `monthToDateUsage: optional EnterpriseAIUsage` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `source: optional EnterpriseAIUsageBudgetSource` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `utilizationPercent: optional number` - `calculatedAt: optional string` calculated_at is the time through which usage has been calculated. Usage after this timestamp may still be processing. - `usage: optional EnterpriseAIUsage` - `usageByModel: optional array of EnterpriseAIUsageByModel` - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` ### Example ```http curl https://app.gitpod.io/api/gitpod.v1.BillingService/GetEnterpriseAIUsageSummary \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $GITPOD_API_KEY" \ -d '{ "dateRange": { "endTime": "2024-01-31T00:00:00Z", "startTime": "2024-01-01T00:00:00Z" }, "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047" }' ``` #### Response ```json { "budget": { "currency": "BILLING_CURRENCY_UNSPECIFIED", "monthlyCostLimitMicrounits": "monthlyCostLimitMicrounits", "monthlyCreditLimit": "monthlyCreditLimit", "monthToDateUsage": { "costMicrounits": "costMicrounits", "credits": 0, "currency": "BILLING_CURRENCY_UNSPECIFIED", "tokens": { "cacheTokens": "cacheTokens", "inputTokens": "inputTokens", "outputTokens": "outputTokens", "totalTokens": "totalTokens" } }, "source": "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED", "utilizationPercent": 0 }, "calculatedAt": "2019-12-27T18:11:19.117Z", "usage": { "costMicrounits": "costMicrounits", "credits": 0, "currency": "BILLING_CURRENCY_UNSPECIFIED", "tokens": { "cacheTokens": "cacheTokens", "inputTokens": "inputTokens", "outputTokens": "outputTokens", "totalTokens": "totalTokens" } }, "usageByModel": [ { "model": "model", "unpricedUsage": { "costMicrounits": "costMicrounits", "credits": 0, "currency": "BILLING_CURRENCY_UNSPECIFIED", "tokens": { "cacheTokens": "cacheTokens", "inputTokens": "inputTokens", "outputTokens": "outputTokens", "totalTokens": "totalTokens" } }, "unpricedUsageByTokenType": [ { "tokenType": "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED", "usage": { "costMicrounits": "costMicrounits", "credits": 0, "currency": "BILLING_CURRENCY_UNSPECIFIED", "tokens": { "cacheTokens": "cacheTokens", "inputTokens": "inputTokens", "outputTokens": "outputTokens", "totalTokens": "totalTokens" } } } ], "usage": { "costMicrounits": "costMicrounits", "credits": 0, "currency": "BILLING_CURRENCY_UNSPECIFIED", "tokens": { "cacheTokens": "cacheTokens", "inputTokens": "inputTokens", "outputTokens": "outputTokens", "totalTokens": "totalTokens" } }, "usageByTokenType": [ { "tokenType": "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED", "usage": { "costMicrounits": "costMicrounits", "credits": 0, "currency": "BILLING_CURRENCY_UNSPECIFIED", "tokens": { "cacheTokens": "cacheTokens", "inputTokens": "inputTokens", "outputTokens": "outputTokens", "totalTokens": "totalTokens" } } } ] } ] } ``` ## GetEnterpriseAIUsageTimeSeries **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. ### Body Parameters - `dateRange: 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. - `endTime: string` End time of the date range (exclusive). - `startTime: string` Start time of the date range (inclusive). - `organizationId: string` - `filter: optional EnterpriseAIUsageTimeSeriesFilter` - `subject: optional Subject` Restrict the per-user breakdown to a single subject. - `id: optional string` id is the UUID of the subject - `principal: optional Principal` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` - `timezone: optional string` IANA timezone name used to bucket daily usage. When empty, defaults to "UTC". ### Returns - `calculatedAt: optional string` calculated_at is the time through which usage has been calculated. Usage after this timestamp may still be processing. - `dailyUsage: optional array of DailyEnterpriseAIUsage` - `date: string` 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: optional EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to the organization. - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `monthlyCostLimitMicrounits: optional string` - `monthlyCreditLimit: optional string` - `monthToDateUsage: optional EnterpriseAIUsage` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `source: optional EnterpriseAIUsageBudgetSource` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `utilizationPercent: optional number` - `teamUsage: optional array of TeamEnterpriseAIUsage` - `budget: optional EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to this team. - `displayName: optional string` - `teamId: optional string` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByModel: optional array of EnterpriseAIUsageByModel` Usage for this day broken down by model. When the request filters by subject, contains only that subject's model usage. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userUsage: optional array of UserEnterpriseAIUsage` - `displayName: optional string` - `usage: optional EnterpriseAIUsage` - `userId: optional string` Empty when representing the "Others" aggregation bucket. ### Example ```http curl https://app.gitpod.io/api/gitpod.v1.BillingService/GetEnterpriseAIUsageTimeSeries \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $GITPOD_API_KEY" \ -d '{ "dateRange": { "endTime": "2024-01-31T00:00:00Z", "startTime": "2024-01-01T00:00:00Z" }, "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047" }' ``` #### Response ```json { "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 **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. ### Query Parameters - `token: optional string` - `pageSize: optional number` ### Body Parameters - `dateRange: DateRange` 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. - `endTime: string` End time of the date range (exclusive). - `startTime: string` Start time of the date range (inclusive). - `organizationId: string` - `filter: optional object { teamIds }` - `teamIds: optional array of string` - `pagination: optional object { token, pageSize }` - `token: optional string` Token for the next set of results that was returned as next_token of a PaginationResponse - `pageSize: optional number` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `timezone: optional string` IANA timezone name used to bucket usage. When empty, defaults to "UTC". ### Returns - `calculatedAt: optional string` calculated_at is the time through which usage has been calculated. Usage after this timestamp may still be processing. - `pagination: optional object { nextToken }` - `nextToken: optional string` Token passed for retrieving the next set of results. Empty if there are no more results - `teamUsage: optional array of TeamEnterpriseAIUsage` - `budget: optional EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to this team. - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `monthlyCostLimitMicrounits: optional string` - `monthlyCreditLimit: optional string` - `monthToDateUsage: optional EnterpriseAIUsage` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `source: optional EnterpriseAIUsageBudgetSource` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `utilizationPercent: optional number` - `displayName: optional string` - `teamId: optional string` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` ### Example ```http curl https://app.gitpod.io/api/gitpod.v1.BillingService/ListEnterpriseAITeamUsage \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $GITPOD_API_KEY" \ -d '{ "dateRange": { "endTime": "2024-01-31T00:00:00Z", "startTime": "2024-01-01T00:00:00Z" }, "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047" }' ``` #### Response ```json { "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 **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. ### Query Parameters - `token: optional string` - `pageSize: optional number` ### Body Parameters - `dateRange: DateRange` 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. - `endTime: string` End time of the date range (exclusive). - `startTime: string` Start time of the date range (inclusive). - `organizationId: string` - `filter: optional object { subject }` Optional filter narrowing the returned user usage. When set to a subject, the response contains only usage for that user or service account. - `subject: optional 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: optional string` id is the UUID of the subject - `principal: optional Principal` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` - `pagination: optional object { token, pageSize }` - `token: optional string` Token for the next set of results that was returned as next_token of a PaginationResponse - `pageSize: optional number` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `sort: optional object { field, order }` sort controls the ordering of results. Defaults to total spend descending. - `field: optional "SORT_FIELD_UNSPECIFIED" or "SORT_FIELD_USAGE" or "SORT_FIELD_DISPLAY_NAME" or 2 more` - `"SORT_FIELD_UNSPECIFIED"` - `"SORT_FIELD_USAGE"` - `"SORT_FIELD_DISPLAY_NAME"` - `"SORT_FIELD_BUDGET"` - `"SORT_FIELD_BUDGET_USED"` - `order: optional SortOrder` - `"SORT_ORDER_UNSPECIFIED"` - `"SORT_ORDER_ASC"` - `"SORT_ORDER_DESC"` - `timezone: optional string` IANA timezone name used to bucket usage. When empty, defaults to "UTC". ### Returns - `calculatedAt: optional string` calculated_at is the time through which usage has been calculated. Usage after this timestamp may still be processing. - `pagination: optional object { nextToken }` - `nextToken: optional string` Token passed for retrieving the next set of results. Empty if there are no more results - `totalCount: optional number` Total number of users with usage in the billing period, across all pages. - `userUsage: optional array of UserCostBudgetUsage` - `budgetSource: optional EnterpriseAIUserBudgetPolicySource` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `displayName: optional string` - `isServiceAccount: optional boolean` - `monthlyCostLimitMicrounits: optional string` - `monthToDateUsage: optional 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: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `noCap: optional boolean` - `overBudget: optional boolean` - `userId: optional string` - `utilizationPercent: optional number` ### Example ```http curl https://app.gitpod.io/api/gitpod.v1.BillingService/ListEnterpriseAIUserUsage \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $GITPOD_API_KEY" \ -d '{ "dateRange": { "endTime": "2024-01-31T00:00:00Z", "startTime": "2024-01-01T00:00:00Z" }, "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047" }' ``` #### Response ```json { "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 **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. ### Query Parameters - `token: optional string` - `pageSize: optional number` ### Body Parameters - `organizationId: string` organization_id is the ID of the organization to list user credit usage for. - `asOf: optional string` as_of is the point in time to compute month-to-date usage up to. Defaults to now if not set. - `pagination: optional object { token, pageSize }` - `token: optional string` Token for the next set of results that was returned as next_token of a PaginationResponse - `pageSize: optional number` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `sort: optional object { field, order }` sort controls the ordering of results. Defaults to total credits descending. - `field: optional "SORT_FIELD_UNSPECIFIED" or "SORT_FIELD_USAGE" or "SORT_FIELD_DISPLAY_NAME" or 2 more` - `"SORT_FIELD_UNSPECIFIED"` - `"SORT_FIELD_USAGE"` - `"SORT_FIELD_DISPLAY_NAME"` - `"SORT_FIELD_BUDGET"` - `"SORT_FIELD_BUDGET_USED"` - `order: optional SortOrder` - `"SORT_ORDER_UNSPECIFIED"` - `"SORT_ORDER_ASC"` - `"SORT_ORDER_DESC"` ### Returns - `pagination: optional object { nextToken }` - `nextToken: optional string` Token passed for retrieving the next set of results. Empty if there are no more results - `totalCount: optional number` Total number of users with usage in the billing period, across all pages. - `userUsage: optional array of UserCreditBudgetUsage` Per-user month-to-date usage with effective monthly budget comparison. Ordered according to the request's sort field, defaulting to total credits descending. - `budgetSource: optional EnterpriseAIUserBudgetPolicySource` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `creditBudget: optional string` - `displayName: optional string` - `isServiceAccount: optional boolean` 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: optional CumulativeCreditUsage` CumulativeCreditUsage contains cumulative credit consumption totals. - `totalCredits: optional number` Total credits consumed. - `usageByType: optional array of CreditsByType` Credits consumed broken down by usage type. - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` - `noCap: optional boolean` - `overBudget: optional boolean` - `usageByModel: optional array of EnterpriseAIUsageByModel` Month-to-date intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userId: optional string` - `utilizationPercent: optional number` ### Example ```http curl https://app.gitpod.io/api/gitpod.v1.BillingService/ListEnterpriseUserCreditUsage \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $GITPOD_API_KEY" \ -d '{ "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047" }' ``` #### 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 - `AgentExecutionCreditUsage object { agentExecutionId, displayName, usage }` AgentExecutionCreditUsage contains a single agent execution's credit usage for a day, broken down by type. - `agentExecutionId: optional string` Empty when representing the "Others" aggregation bucket. - `displayName: optional string` - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` ### Billing Currency - `BillingCurrency = "BILLING_CURRENCY_UNSPECIFIED" or "BILLING_CURRENCY_USD" or "BILLING_CURRENCY_EUR" or "BILLING_CURRENCY_GBP"` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` ### Byok Rate Card Token Type - `ByokRateCardTokenType = "BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED" or "BYOK_RATE_CARD_TOKEN_TYPE_INPUT" or "BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT" or 2 more` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` ### Credit Usage Export Group By - `CreditUsageExportGroupBy = "CREDIT_USAGE_EXPORT_GROUP_BY_UNSPECIFIED" or "CREDIT_USAGE_EXPORT_GROUP_BY_DAILY_SUMMARY" or "CREDIT_USAGE_EXPORT_GROUP_BY_RESOURCE"` How to group the credit usage export data. - `"CREDIT_USAGE_EXPORT_GROUP_BY_UNSPECIFIED"` - `"CREDIT_USAGE_EXPORT_GROUP_BY_DAILY_SUMMARY"` - `"CREDIT_USAGE_EXPORT_GROUP_BY_RESOURCE"` ### Credit Usage Report Filter - `CreditUsageReportFilter object { subject }` 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: optional 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: optional string` id is the UUID of the subject - `principal: optional Principal` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` ### Credits By Type - `CreditsByType object { credits, usageType }` CreditsByType contains credits consumed for a single usage type. - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` ### Cumulative Credit Usage - `CumulativeCreditUsage object { totalCredits, usageByType }` CumulativeCreditUsage contains cumulative credit consumption totals. - `totalCredits: optional number` Total credits consumed. - `usageByType: optional array of CreditsByType` Credits consumed broken down by usage type. - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` ### Daily Credit Usage - `DailyCreditUsage object { conversationUsage, date, environmentUsage, 4 more }` DailyCreditUsage contains credit usage for a single day. - `conversationUsage: optional array of AgentExecutionCreditUsage` Per-agent-execution usage for this day (top conversations + "Others"). Empty agent_execution_id represents the "Others" aggregation bucket. - `agentExecutionId: optional string` Empty when representing the "Others" aggregation bucket. - `displayName: optional string` - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` - `date: optional string` Start of the day (midnight in the requested timezone). - `environmentUsage: optional array of EnvironmentCreditUsage` Per-environment usage for this day (top environments + "Others"). Empty environment_id represents the "Others" aggregation bucket. - `displayName: optional string` - `environmentId: optional string` Empty when representing the "Others" aggregation bucket. - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `orgUsage: optional array of CreditsByType` Org-wide usage broken down by type. - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `teamUsage: optional array of TeamCreditUsage` Per-team usage for this day (top teams + "Others"). Empty team_id represents the "Others" aggregation bucket. - `displayName: optional string` - `teamId: optional string` Empty when representing the "Others" aggregation bucket. - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `usageByModel: optional array of EnterpriseAIUsageByModel` Org-wide intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userUsage: optional array of UserCreditUsage` Per-user usage for this day (top users + "Others"). - `displayName: optional string` - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `usageByModel: optional array of EnterpriseAIUsageByModel` Intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `userId: optional string` Empty when representing the "Others" aggregation bucket. ### Daily Enterprise AI Usage - `DailyEnterpriseAIUsage object { date, budget, teamUsage, 3 more }` - `date: string` 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: optional EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to the organization. - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `monthlyCostLimitMicrounits: optional string` - `monthlyCreditLimit: optional string` - `monthToDateUsage: optional EnterpriseAIUsage` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `source: optional EnterpriseAIUsageBudgetSource` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `utilizationPercent: optional number` - `teamUsage: optional array of TeamEnterpriseAIUsage` - `budget: optional EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to this team. - `displayName: optional string` - `teamId: optional string` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByModel: optional array of EnterpriseAIUsageByModel` Usage for this day broken down by model. When the request filters by subject, contains only that subject's model usage. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userUsage: optional array of UserEnterpriseAIUsage` - `displayName: optional string` - `usage: optional EnterpriseAIUsage` - `userId: optional string` Empty when representing the "Others" aggregation bucket. ### Enterprise AI Token Usage - `EnterpriseAITokenUsage object { cacheTokens, inputTokens, outputTokens, totalTokens }` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` ### Enterprise AI Usage - `EnterpriseAIUsage object { costMicrounits, credits, currency, tokens }` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` ### Enterprise AI Usage Budget - `EnterpriseAIUsageBudget object { currency, monthlyCostLimitMicrounits, monthlyCreditLimit, 3 more }` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `monthlyCostLimitMicrounits: optional string` - `monthlyCreditLimit: optional string` - `monthToDateUsage: optional EnterpriseAIUsage` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `source: optional EnterpriseAIUsageBudgetSource` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `utilizationPercent: optional number` ### Enterprise AI Usage Budget Source - `EnterpriseAIUsageBudgetSource = "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED" or "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION" or "ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` ### Enterprise AI Usage By Model - `EnterpriseAIUsageByModel object { model, unpricedUsage, unpricedUsageByTokenType, 2 more }` - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` ### Enterprise AI Usage By Token Type - `EnterpriseAIUsageByTokenType object { tokenType, usage }` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` ### Enterprise AI Usage Time Series Filter - `EnterpriseAIUsageTimeSeriesFilter object { subject }` - `subject: optional Subject` Restrict the per-user breakdown to a single subject. - `id: optional string` id is the UUID of the subject - `principal: optional Principal` Principal is the principal of the subject - `"PRINCIPAL_UNSPECIFIED"` - `"PRINCIPAL_ACCOUNT"` - `"PRINCIPAL_USER"` - `"PRINCIPAL_RUNNER"` - `"PRINCIPAL_ENVIRONMENT"` - `"PRINCIPAL_SERVICE_ACCOUNT"` - `"PRINCIPAL_RUNNER_MANAGER"` ### Enterprise AI User Budget Policy Source - `EnterpriseAIUserBudgetPolicySource = "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED" or "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE" or "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION" or "ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` ### Environment Credit Usage - `EnvironmentCreditUsage object { displayName, environmentId, usage }` EnvironmentCreditUsage contains a single environment's credit usage for a day, broken down by type. - `displayName: optional string` - `environmentId: optional string` Empty when representing the "Others" aggregation bucket. - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` ### Team Credit Usage - `TeamCreditUsage object { displayName, teamId, usage }` TeamCreditUsage contains a single team's credit usage for a day, broken down by type. - `displayName: optional string` - `teamId: optional string` Empty when representing the "Others" aggregation bucket. - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` ### Team Cumulative Credit Usage - `TeamCumulativeCreditUsage object { creditBudget, displayName, teamId, usage }` TeamCumulativeCreditUsage contains a team's cumulative credit usage and allocation. - `creditBudget: optional string` The team's credit allocation (budget) in whole credits, if set. Not set means no allocation has been configured for this team. - `displayName: optional string` - `teamId: optional string` - `usage: optional CumulativeCreditUsage` Cumulative credit usage for this team. - `totalCredits: optional number` Total credits consumed. - `usageByType: optional array of CreditsByType` Credits consumed broken down by usage type. - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` ### Team Enterprise AI Usage - `TeamEnterpriseAIUsage object { budget, displayName, teamId, 2 more }` - `budget: optional EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to this team. - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `monthlyCostLimitMicrounits: optional string` - `monthlyCreditLimit: optional string` - `monthToDateUsage: optional EnterpriseAIUsage` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `source: optional EnterpriseAIUsageBudgetSource` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `utilizationPercent: optional number` - `displayName: optional string` - `teamId: optional string` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` ### Usage Type - `UsageType = "USAGE_TYPE_UNSPECIFIED" or "USAGE_TYPE_ENVIRONMENT" or "USAGE_TYPE_AGENTIC"` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` ### User Cost Budget Usage - `UserCostBudgetUsage object { budgetSource, currency, displayName, 7 more }` - `budgetSource: optional EnterpriseAIUserBudgetPolicySource` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `displayName: optional string` - `isServiceAccount: optional boolean` - `monthlyCostLimitMicrounits: optional string` - `monthToDateUsage: optional 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: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `noCap: optional boolean` - `overBudget: optional boolean` - `userId: optional string` - `utilizationPercent: optional number` ### User Credit Budget Usage - `UserCreditBudgetUsage object { budgetSource, creditBudget, displayName, 7 more }` - `budgetSource: optional EnterpriseAIUserBudgetPolicySource` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `creditBudget: optional string` - `displayName: optional string` - `isServiceAccount: optional boolean` 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: optional CumulativeCreditUsage` CumulativeCreditUsage contains cumulative credit consumption totals. - `totalCredits: optional number` Total credits consumed. - `usageByType: optional array of CreditsByType` Credits consumed broken down by usage type. - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` - `noCap: optional boolean` - `overBudget: optional boolean` - `usageByModel: optional array of EnterpriseAIUsageByModel` Month-to-date intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userId: optional string` - `utilizationPercent: optional number` ### User Credit Usage - `UserCreditUsage object { displayName, usage, usageByModel, userId }` UserCreditUsage contains a single user's credit usage, broken down by type. - `displayName: optional string` - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` - `usageByModel: optional array of EnterpriseAIUsageByModel` Intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userId: optional string` Empty when representing the "Others" aggregation bucket. ### User Enterprise AI Usage - `UserEnterpriseAIUsage object { displayName, usage, userId }` - `displayName: optional string` - `usage: optional EnterpriseAIUsage` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `userId: optional string` Empty when representing the "Others" aggregation bucket. ### Billing Get Credit Usage Export Response - `BillingGetCreditUsageExportResponse object { downloadUrl }` - `downloadUrl: optional string` Signed download URL for the CSV export. Valid for five minutes, and only for the principal that requested it. ### Billing Get Credit Usage Report Response - `BillingGetCreditUsageReportResponse object { dailyUsage, periodStart, updatedAt }` - `dailyUsage: optional array of DailyCreditUsage` One entry per day in the requested date range. - `conversationUsage: optional array of AgentExecutionCreditUsage` Per-agent-execution usage for this day (top conversations + "Others"). Empty agent_execution_id represents the "Others" aggregation bucket. - `agentExecutionId: optional string` Empty when representing the "Others" aggregation bucket. - `displayName: optional string` - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` - `date: optional string` Start of the day (midnight in the requested timezone). - `environmentUsage: optional array of EnvironmentCreditUsage` Per-environment usage for this day (top environments + "Others"). Empty environment_id represents the "Others" aggregation bucket. - `displayName: optional string` - `environmentId: optional string` Empty when representing the "Others" aggregation bucket. - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `orgUsage: optional array of CreditsByType` Org-wide usage broken down by type. - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `teamUsage: optional array of TeamCreditUsage` Per-team usage for this day (top teams + "Others"). Empty team_id represents the "Others" aggregation bucket. - `displayName: optional string` - `teamId: optional string` Empty when representing the "Others" aggregation bucket. - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `usageByModel: optional array of EnterpriseAIUsageByModel` Org-wide intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userUsage: optional array of UserCreditUsage` Per-user usage for this day (top users + "Others"). - `displayName: optional string` - `usage: optional array of CreditsByType` - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `usageByModel: optional array of EnterpriseAIUsageByModel` Intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `userId: optional string` Empty when representing the "Others" aggregation bucket. - `periodStart: optional string` Start of the billing period for this organization. Used by the frontend to filter out months before usage tracking began. - `updatedAt: optional string` When the report data was last computed. ### Billing Get Cumulative Credit Usage Response - `BillingGetCumulativeCreditUsageResponse object { orgUsage, periodStart, teamUsage, 2 more }` - `orgUsage: optional CumulativeCreditUsage` Org-wide cumulative usage, broken down by type and total. - `totalCredits: optional number` Total credits consumed. - `usageByType: optional array of CreditsByType` Credits consumed broken down by usage type. - `credits: optional number` - `usageType: optional UsageType` UsageType identifies the category of usage. - `"USAGE_TYPE_UNSPECIFIED"` - `"USAGE_TYPE_ENVIRONMENT"` - `"USAGE_TYPE_AGENTIC"` - `periodStart: optional string` Start of the cumulative calculation period. Cumulative totals are computed from this date forward. - `teamUsage: optional array of TeamCumulativeCreditUsage` Per-team cumulative usage with credit allocation comparison. Returns all teams (no top-N limit). - `creditBudget: optional string` The team's credit allocation (budget) in whole credits, if set. Not set means no allocation has been configured for this team. - `displayName: optional string` - `teamId: optional string` - `usage: optional CumulativeCreditUsage` Cumulative credit usage for this team. - `unteamedUsage: optional CumulativeCreditUsage` Usage by members not assigned to any team. - `userUsage: optional array of 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: optional EnterpriseAIUserBudgetPolicySource` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_NONE"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USER_BUDGET_POLICY_SOURCE_USER"` - `creditBudget: optional string` - `displayName: optional string` - `isServiceAccount: optional boolean` 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: optional CumulativeCreditUsage` CumulativeCreditUsage contains cumulative credit consumption totals. - `noCap: optional boolean` - `overBudget: optional boolean` - `usageByModel: optional array of EnterpriseAIUsageByModel` Month-to-date intelligence usage broken down by model. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userId: optional string` - `utilizationPercent: optional number` ### Billing Get Enterprise AI Usage Summary Response - `BillingGetEnterpriseAIUsageSummaryResponse object { budget, calculatedAt, usage, usageByModel }` - `budget: optional EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to the organization. - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `monthlyCostLimitMicrounits: optional string` - `monthlyCreditLimit: optional string` - `monthToDateUsage: optional EnterpriseAIUsage` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `source: optional EnterpriseAIUsageBudgetSource` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `utilizationPercent: optional number` - `calculatedAt: optional string` calculated_at is the time through which usage has been calculated. Usage after this timestamp may still be processing. - `usage: optional EnterpriseAIUsage` - `usageByModel: optional array of EnterpriseAIUsageByModel` - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` ### Billing Get Enterprise AI Usage Time Series Response - `BillingGetEnterpriseAIUsageTimeSeriesResponse object { calculatedAt, dailyUsage }` - `calculatedAt: optional string` calculated_at is the time through which usage has been calculated. Usage after this timestamp may still be processing. - `dailyUsage: optional array of DailyEnterpriseAIUsage` - `date: string` 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: optional EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to the organization. - `currency: optional BillingCurrency` - `"BILLING_CURRENCY_UNSPECIFIED"` - `"BILLING_CURRENCY_USD"` - `"BILLING_CURRENCY_EUR"` - `"BILLING_CURRENCY_GBP"` - `monthlyCostLimitMicrounits: optional string` - `monthlyCreditLimit: optional string` - `monthToDateUsage: optional EnterpriseAIUsage` - `costMicrounits: optional string` - `credits: optional number` - `currency: optional BillingCurrency` - `tokens: optional EnterpriseAITokenUsage` - `cacheTokens: optional string` - `inputTokens: optional string` - `outputTokens: optional string` - `totalTokens: optional string` - `source: optional EnterpriseAIUsageBudgetSource` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_UNSPECIFIED"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_ORGANIZATION"` - `"ENTERPRISE_AI_USAGE_BUDGET_SOURCE_TEAM"` - `utilizationPercent: optional number` - `teamUsage: optional array of TeamEnterpriseAIUsage` - `budget: optional EnterpriseAIUsageBudget` budget is unset when no monthly budget applies to this team. - `displayName: optional string` - `teamId: optional string` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `"BYOK_RATE_CARD_TOKEN_TYPE_UNSPECIFIED"` - `"BYOK_RATE_CARD_TOKEN_TYPE_INPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_OUTPUT"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_READ"` - `"BYOK_RATE_CARD_TOKEN_TYPE_CACHE_WRITE"` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByModel: optional array of EnterpriseAIUsageByModel` Usage for this day broken down by model. When the request filters by subject, contains only that subject's model usage. - `model: optional string` - `unpricedUsage: optional EnterpriseAIUsage` Usage excluded from spend because no matching BYOK rate was configured. - `unpricedUsageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `usage: optional EnterpriseAIUsage` - `usageByTokenType: optional array of EnterpriseAIUsageByTokenType` - `tokenType: optional ByokRateCardTokenType` - `usage: optional EnterpriseAIUsage` - `userUsage: optional array of UserEnterpriseAIUsage` - `displayName: optional string` - `usage: optional EnterpriseAIUsage` - `userId: optional string` Empty when representing the "Others" aggregation bucket.