Get Credit Usage Report

Unary · Billing 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.

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.

Endpoint

POST /api/gitpod.v1.BillingService/GetCreditUsageReport

Send a Bearer token as described in Authentication. If your organization uses a custom management-plane domain, replace https://app.ona.com with that domain.

Request example

export ONA_HOST=https://app.ona.com
export ONA_API_KEY=<your-token>

curl --request POST \
  --url "$ONA_HOST/api/gitpod.v1.BillingService/GetCreditUsageReport" \
  --header "Authorization: Bearer $ONA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "dateRange": {
    "endTime": "2026-01-01T00:00:00Z",
    "startTime": "2026-01-01T00:00:00Z"
  },
  "organizationId": "<organization-id>"
}'

import gitpod.v1.billing_pb2 as billing_pb2
import gitpod.v1.usage_pb2 as usage_pb2
import google.protobuf.timestamp_pb2 as timestamp_pb2
from ona_sdk import create_client_from_env

ona = create_client_from_env()
request = billing_pb2.GetCreditUsageReportRequest(
    organization_id="<organization-id>",
    date_range=usage_pb2.DateRange(
        start_time=timestamp_pb2.Timestamp(seconds=1767225600),
        end_time=timestamp_pb2.Timestamp(seconds=1767225600),
    ),
)
response = ona.services.billing.get_credit_usage_report(request)
print(response)

import { create } from "@bufbuild/protobuf";
import { createClientFromEnv } from "@gitpod/sdk";
import { GetCreditUsageReportRequestSchema } from "@gitpod/sdk/gitpod/v1/billing_pb";
import { timestampFromDate } from "@bufbuild/protobuf/wkt";

async function main() {
  const ona = createClientFromEnv();
  const request = create(GetCreditUsageReportRequestSchema, {
    organizationId: "<organization-id>",
    dateRange: {
      startTime: timestampFromDate(new Date("2026-01-01T00:00:00Z")),
      endTime: timestampFromDate(new Date("2026-01-01T00:00:00Z")),
    },
  });
  const response = await ona.services.billing.getCreditUsageReport(request);
  console.log(response);
}

main().catch(console.error);

package main

import (
	"context"
	"fmt"
	"log"

	"connectrpc.com/connect"
	"github.com/gitpod-io/gitpod-sdk-go/sdk"
	gitpodpb "github.com/gitpod-io/gitpod-sdk-go/v1"
	timestamppb "google.golang.org/protobuf/types/known/timestamppb"
)

func main() {
	ona, err := sdk.NewFromEnv()
	if err != nil {
		log.Fatal(err)
	}

	request := connect.NewRequest(&gitpodpb.GetCreditUsageReportRequest{
		OrganizationId: "<organization-id>",
		DateRange: &gitpodpb.DateRange{
			StartTime: &timestamppb.Timestamp{Seconds: 1767225600},
			EndTime: &timestamppb.Timestamp{Seconds: 1767225600},
		},
	})
	response, err := ona.Services.Billing.GetCreditUsageReport(context.Background(), request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response.Msg)
}

{
  "dateRange": {
    "endTime": "2026-01-01T00:00:00Z",
    "startTime": "2026-01-01T00:00:00Z"
  },
  "organizationId": "<organization-id>"
}

Request

gitpod.v1.GetCreditUsageReportRequest

Field	Type	Required	Description
`organizationId`	string	Yes	Constraints: `required=true, string.uuid=true`.
`dateRange`	DateRange	Yes	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. Constraints: `required=true`.
`timezone`	string	No	IANA timezone name (e.g. “America/New_York”, “Europe/Berlin”) used to bucket daily usage. When empty, defaults to “UTC”.
`filter`	CreditUsageReportFilter	No	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.

Response

gitpod.v1.GetCreditUsageReportResponse

Field	Type	Required	Description
`updatedAt`	RFC 3339 timestamp	No	When the report data was last computed.
`dailyUsage`	array of DailyCreditUsage	No	One entry per day in the requested date range.
`periodStart`	RFC 3339 timestamp	No	Start of the billing period for this organization. Used by the frontend to filter out months before usage tracking began.

AgentExecutionCreditUsage

AgentExecutionCreditUsage contains a single agent execution’s credit usage for a day, broken down by type.gitpod.v1.AgentExecutionCreditUsage

Field	Type	Required	Description
`agentExecutionId`	string	No	Empty when representing the “Others” aggregation bucket.
`displayName`	string	No
`usage`	array of CreditsByType	No

CreditUsageReportFilter

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.gitpod.v1.CreditUsageReportFilter

Field	Type	Required	Description
`subject`	Subject	No	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.

CreditsByType

CreditsByType contains credits consumed for a single usage type.gitpod.v1.CreditsByType

Field	Type	Required	Description
`usageType`	UsageType	No
`credits`	number	No

DailyCreditUsage

DailyCreditUsage contains credit usage for a single day.gitpod.v1.DailyCreditUsage

Field	Type	Required	Description
`date`	RFC 3339 timestamp	No	Start of the day (midnight in the requested timezone).
`orgUsage`	array of CreditsByType	No	Org-wide usage broken down by type.
`userUsage`	array of UserCreditUsage	No	Per-user usage for this day (top users + “Others”).
`teamUsage`	array of TeamCreditUsage	No	Per-team usage for this day (top teams + “Others”). Empty team_id represents the “Others” aggregation bucket.
`environmentUsage`	array of EnvironmentCreditUsage	No	Per-environment usage for this day (top environments + “Others”). Empty environment_id represents the “Others” aggregation bucket.
`conversationUsage`	array of AgentExecutionCreditUsage	No	Per-agent-execution usage for this day (top conversations + “Others”). Empty agent_execution_id represents the “Others” aggregation bucket.
`usageByModel`	array of EnterpriseAIUsageByModel	No	Org-wide intelligence usage broken down by model.

DateRange

DateRange specifies a time period for queries.gitpod.v1.DateRange

Field	Type	Required	Description
`startTime`	RFC 3339 timestamp	Yes	Start time of the date range (inclusive). Constraints: `required=true`.
`endTime`	RFC 3339 timestamp	Yes	End time of the date range (exclusive). Constraints: `required=true`.

EnterpriseAIUsageByModel

gitpod.v1.EnterpriseAIUsageByModel

Field	Type	Required	Description
`model`	string	No
`usage`	EnterpriseAIUsage	No
`usageByTokenType`	array of EnterpriseAIUsageByTokenType	No
`unpricedUsage`	EnterpriseAIUsage	No	Usage excluded from spend because no matching BYOK rate was configured.
`unpricedUsageByTokenType`	array of EnterpriseAIUsageByTokenType	No

EnvironmentCreditUsage

EnvironmentCreditUsage contains a single environment’s credit usage for a day, broken down by type.gitpod.v1.EnvironmentCreditUsage

Field	Type	Required	Description
`environmentId`	string	No	Empty when representing the “Others” aggregation bucket.
`displayName`	string	No
`usage`	array of CreditsByType	No

Subject

gitpod.v1.Subject

Field	Type	Required	Description
`id`	string	No	id is the UUID of the subject Constraints: `ignore=1, string.uuid=true`.
`principal`	Principal	No	Principal is the principal of the subject Constraints: `enum.defined_only=true`.

TeamCreditUsage

TeamCreditUsage contains a single team’s credit usage for a day, broken down by type.gitpod.v1.TeamCreditUsage

Field	Type	Required	Description
`teamId`	string	No	Empty when representing the “Others” aggregation bucket.
`displayName`	string	No
`usage`	array of CreditsByType	No

UserCreditUsage

UserCreditUsage contains a single user’s credit usage, broken down by type.gitpod.v1.UserCreditUsage

Field	Type	Required	Description
`userId`	string	No	Empty when representing the “Others” aggregation bucket.
`displayName`	string	No
`usage`	array of CreditsByType	No
`usageByModel`	array of EnterpriseAIUsageByModel	No	Intelligence usage broken down by model.

Principal

Value	Number	Description
`PRINCIPAL_UNSPECIFIED`	0
`PRINCIPAL_ACCOUNT`	1
`PRINCIPAL_USER`	2
`PRINCIPAL_RUNNER`	3
`PRINCIPAL_ENVIRONMENT`	4
`PRINCIPAL_SERVICE_ACCOUNT`	5
`PRINCIPAL_RUNNER_MANAGER`	6

UsageType

UsageType identifies the category of usage.

Value	Number	Description
`USAGE_TYPE_UNSPECIFIED`	0
`USAGE_TYPE_ENVIRONMENT`	1
`USAGE_TYPE_AGENTIC`	2

Get Started

Using Ona

Configuration

Administration & Security

Infrastructure

Billing

Learn

Reference

Support

Releases

Examples

Authorization

Endpoint

Request example

Request

Response

​Examples

​Authorization

​Endpoint

​Request example

​Request

​Response

​Related types

Examples

Authorization

Endpoint

Request example

Request

Response

Related types