Billing
BillingService provides billing and subscription management functionality.
GetCreditUsageExport
GetCreditUsageReport
GetCumulativeCreditUsage
GetEnterpriseAIUsageSummary
GetEnterpriseAIUsageTimeSeries
ListEnterpriseAITeamUsage
ListEnterpriseAIUserUsage
ListEnterpriseUserCreditUsage
ModelsExpand Collapse
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.
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.
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.
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.
DailyCreditUsage object { conversationUsage, date, environmentUsage, 4 more } DailyCreditUsage contains credit usage for a single day.
DailyCreditUsage contains credit usage for a single day.
conversationUsage: optional array of AgentExecutionCreditUsage { agentExecutionId, displayName, usage } Per-agent-execution usage for this day (top conversations + “Others”).
Empty agent_execution_id represents the “Others” aggregation bucket.
Per-agent-execution usage for this day (top conversations + “Others”). Empty agent_execution_id represents the “Others” aggregation bucket.
Per-environment usage for this day (top environments + “Others”).
Empty environment_id represents the “Others” aggregation bucket.
Per-environment usage for this day (top environments + “Others”). Empty environment_id represents the “Others” aggregation bucket.
Per-team usage for this day (top teams + “Others”).
Empty team_id represents the “Others” aggregation bucket.
Per-team usage for this day (top teams + “Others”). Empty team_id represents the “Others” aggregation bucket.
usageByModel: optional array of EnterpriseAIUsageByModel { model, unpricedUsage, unpricedUsageByTokenType, 2 more } Org-wide intelligence usage broken down by model.
Org-wide intelligence usage broken down by model.
Per-user usage for this day (top users + “Others”).
Per-user usage for this day (top users + “Others”).
usageByModel: optional array of EnterpriseAIUsageByModel { model, unpricedUsage, unpricedUsageByTokenType, 2 more } Intelligence usage broken down by model.
Intelligence usage broken down by model.
DailyEnterpriseAIUsage object { date, budget, teamUsage, 3 more }
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.
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 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 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()
method. In Python, a standard datetime.datetime object can be converted
to this format using
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() to obtain a formatter capable of generating timestamps in this format.
budget: optional EnterpriseAIUsageBudget { currency, monthlyCostLimitMicrounits, monthlyCreditLimit, 3 more } budget is unset when no monthly budget applies to the organization.
budget is unset when no monthly budget applies to the organization.
budget: optional EnterpriseAIUsageBudget { currency, monthlyCostLimitMicrounits, monthlyCreditLimit, 3 more } budget is unset when no monthly budget applies to this team.
budget is unset when no monthly budget applies to this team.
usageByModel: optional array of EnterpriseAIUsageByModel { model, unpricedUsage, unpricedUsageByTokenType, 2 more } Usage for this day broken down by model. When the request filters by
subject, contains only that subject’s model usage.
Usage for this day broken down by model. When the request filters by subject, contains only that subject’s model usage.
TeamCumulativeCreditUsage object { creditBudget, displayName, teamId, usage } TeamCumulativeCreditUsage contains a team’s cumulative credit usage and allocation.
TeamCumulativeCreditUsage contains a team’s cumulative credit usage and allocation.
TeamEnterpriseAIUsage object { budget, displayName, teamId, 2 more }
budget: optional EnterpriseAIUsageBudget { currency, monthlyCostLimitMicrounits, monthlyCreditLimit, 3 more } budget is unset when no monthly budget applies to this team.
budget is unset when no monthly budget applies to this team.
UserCreditBudgetUsage object { budgetSource, creditBudget, displayName, 7 more }
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.
CumulativeCreditUsage contains cumulative credit consumption totals.
CumulativeCreditUsage contains cumulative credit consumption totals.
usageByModel: optional array of EnterpriseAIUsageByModel { model, unpricedUsage, unpricedUsageByTokenType, 2 more } Month-to-date intelligence usage broken down by model.
Month-to-date intelligence usage broken down by model.
UserCreditUsage object { displayName, usage, usageByModel, userId } UserCreditUsage contains a single user’s credit usage, broken down by type.
UserCreditUsage contains a single user’s credit usage, broken down by type.
usageByModel: optional array of EnterpriseAIUsageByModel { model, unpricedUsage, unpricedUsageByTokenType, 2 more } Intelligence usage broken down by model.
Intelligence usage broken down by model.
BillingGetCreditUsageReportResponse object { dailyUsage, periodStart, updatedAt }
dailyUsage: optional array of DailyCreditUsage { conversationUsage, date, environmentUsage, 4 more } One entry per day in the requested date range.
One entry per day in the requested date range.
conversationUsage: optional array of AgentExecutionCreditUsage { agentExecutionId, displayName, usage } Per-agent-execution usage for this day (top conversations + “Others”).
Empty agent_execution_id represents the “Others” aggregation bucket.
Per-agent-execution usage for this day (top conversations + “Others”). Empty agent_execution_id represents the “Others” aggregation bucket.
Per-environment usage for this day (top environments + “Others”).
Empty environment_id represents the “Others” aggregation bucket.
Per-environment usage for this day (top environments + “Others”). Empty environment_id represents the “Others” aggregation bucket.
Per-team usage for this day (top teams + “Others”).
Empty team_id represents the “Others” aggregation bucket.
Per-team usage for this day (top teams + “Others”). Empty team_id represents the “Others” aggregation bucket.
usageByModel: optional array of EnterpriseAIUsageByModel { model, unpricedUsage, unpricedUsageByTokenType, 2 more } Org-wide intelligence usage broken down by model.
Org-wide intelligence usage broken down by model.
Per-user usage for this day (top users + “Others”).
Per-user usage for this day (top users + “Others”).
usageByModel: optional array of EnterpriseAIUsageByModel { model, unpricedUsage, unpricedUsageByTokenType, 2 more } Intelligence usage broken down by model.
Intelligence usage broken down by model.
BillingGetCumulativeCreditUsageResponse object { orgUsage, periodStart, teamUsage, 2 more }
Org-wide cumulative usage, broken down by type and total.
Org-wide cumulative usage, broken down by type and total.
Start of the cumulative calculation period. Cumulative totals are computed from this date forward.
Per-team cumulative usage with credit allocation comparison.
Returns all teams (no top-N limit).
Per-team cumulative usage with credit allocation comparison. Returns all teams (no top-N limit).
Usage by members not assigned to any team.
Usage by members not assigned to any team.
userUsage: optional array of UserCreditBudgetUsage { budgetSource, creditBudget, displayName, 7 more } 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.
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.
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.
CumulativeCreditUsage contains cumulative credit consumption totals.
CumulativeCreditUsage contains cumulative credit consumption totals.
usageByModel: optional array of EnterpriseAIUsageByModel { model, unpricedUsage, unpricedUsageByTokenType, 2 more } Month-to-date intelligence usage broken down by model.
Month-to-date intelligence usage broken down by model.
BillingGetEnterpriseAIUsageSummaryResponse object { budget, calculatedAt, usage, usageByModel }
budget: optional EnterpriseAIUsageBudget { currency, monthlyCostLimitMicrounits, monthlyCreditLimit, 3 more } budget is unset when no monthly budget applies to the organization.
budget is unset when no monthly budget applies to the organization.
calculated_at is the time through which usage has been calculated. Usage after this timestamp may still be processing.
usageByModel: optional array of EnterpriseAIUsageByModel { model, unpricedUsage, unpricedUsageByTokenType, 2 more }
BillingGetEnterpriseAIUsageTimeSeriesResponse object { calculatedAt, dailyUsage }
calculated_at is the time through which usage has been calculated. Usage after this timestamp may still be processing.
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.
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 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 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()
method. In Python, a standard datetime.datetime object can be converted
to this format using
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() to obtain a formatter capable of generating timestamps in this format.
budget: optional EnterpriseAIUsageBudget { currency, monthlyCostLimitMicrounits, monthlyCreditLimit, 3 more } budget is unset when no monthly budget applies to the organization.
budget is unset when no monthly budget applies to the organization.
budget: optional EnterpriseAIUsageBudget { currency, monthlyCostLimitMicrounits, monthlyCreditLimit, 3 more } budget is unset when no monthly budget applies to this team.
budget is unset when no monthly budget applies to this team.
usageByModel: optional array of EnterpriseAIUsageByModel { model, unpricedUsage, unpricedUsageByTokenType, 2 more } Usage for this day broken down by model. When the request filters by
subject, contains only that subject’s model usage.
Usage for this day broken down by model. When the request filters by subject, contains only that subject’s model usage.