---
title: "GetCumulativeCreditUsage"
method: POST
path: "/gitpod.v1.BillingService/GetCumulativeCreditUsage"
tags: ["gitpod.v1.BillingService"]
---

# 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.

## Request body

- GitpodV1GetCumulativeCreditUsageRequest
  - `asOf` string, date-time — A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() ) to obtain a formatter capable of generating timestamps in this format.
  - `organizationId` string, uuid, required — organization_id is the ID of the organization to get cumulative usage for.

## Response `200`

Success

- GitpodV1GetCumulativeCreditUsageResponse
  - `orgUsage` GitpodV1CumulativeCreditUsage — CumulativeCreditUsage contains cumulative credit consumption totals.
    - `totalCredits` number, double — Total credits consumed.
    - `usageByType` GitpodV1CreditsByType[] — Credits consumed broken down by usage type.
      - `credits` number, double
      - `usageType` 'USAGE_TYPE_UNSPECIFIED' | 'USAGE_TYPE_ENVIRONMENT' | 'USAGE_TYPE_AGENTIC' — UsageType identifies the category of usage.
  - `periodStart` string, date-time — A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() ) to obtain a formatter capable of generating timestamps in this format.
  - `teamUsage` GitpodV1TeamCumulativeCreditUsage[] — Per-team cumulative usage with credit allocation comparison. Returns all teams (no top-N limit).
    - `creditBudget` string, nullable — The team's credit allocation (budget) in whole credits, if set. Not set means no allocation has been configured for this team.
    - `displayName` string
    - `teamId` string
    - `usage` GitpodV1CumulativeCreditUsage — CumulativeCreditUsage contains cumulative credit consumption totals.
      - `totalCredits` number, double — Total credits consumed.
      - `usageByType` GitpodV1CreditsByType[] — Credits consumed broken down by usage type.
        - `credits` number, double
        - `usageType` 'USAGE_TYPE_UNSPECIFIED' | 'USAGE_TYPE_ENVIRONMENT' | 'USAGE_TYPE_AGENTIC' — UsageType identifies the category of usage.
  - `unteamedUsage` GitpodV1CumulativeCreditUsage — CumulativeCreditUsage contains cumulative credit consumption totals.
    - `totalCredits` number, double — Total credits consumed.
    - `usageByType` GitpodV1CreditsByType[] — Credits consumed broken down by usage type.
      - `credits` number, double
      - `usageType` 'USAGE_TYPE_UNSPECIFIED' | 'USAGE_TYPE_ENVIRONMENT' | 'USAGE_TYPE_AGENTIC' — UsageType identifies the category of usage.
  - `userUsage` GitpodV1UserCreditBudgetUsage[] — 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` '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` string, nullable
    - `displayName` string
    - `isServiceAccount` 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` GitpodV1CumulativeCreditUsage — CumulativeCreditUsage contains cumulative credit consumption totals.
      - `totalCredits` number, double — Total credits consumed.
      - `usageByType` GitpodV1CreditsByType[] — Credits consumed broken down by usage type.
        - `credits` number, double
        - `usageType` 'USAGE_TYPE_UNSPECIFIED' | 'USAGE_TYPE_ENVIRONMENT' | 'USAGE_TYPE_AGENTIC' — UsageType identifies the category of usage.
    - `noCap` boolean
    - `overBudget` boolean
    - `usageByModel` GitpodV1EnterpriseAIUsageByModel[] — Month-to-date intelligence usage broken down by model.
      - `model` string
      - `unpricedUsage` GitpodV1EnterpriseAIUsage
        - `costMicrounits` string
        - `credits` number, double
        - `currency` 'BILLING_CURRENCY_UNSPECIFIED' | 'BILLING_CURRENCY_USD' | 'BILLING_CURRENCY_EUR' | 'BILLING_CURRENCY_GBP'
        - `tokens` GitpodV1EnterpriseAITokenUsage
          - `cacheTokens` string
          - `inputTokens` string
          - `outputTokens` string
          - `totalTokens` string
      - `unpricedUsageByTokenType` GitpodV1EnterpriseAIUsageByTokenType[]
        - `tokenType` '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` GitpodV1EnterpriseAIUsage
          - `costMicrounits` string
          - `credits` number, double
          - `currency` 'BILLING_CURRENCY_UNSPECIFIED' | 'BILLING_CURRENCY_USD' | 'BILLING_CURRENCY_EUR' | 'BILLING_CURRENCY_GBP'
          - `tokens` GitpodV1EnterpriseAITokenUsage
            - `cacheTokens` string
            - `inputTokens` string
            - `outputTokens` string
            - `totalTokens` string
      - `usage` GitpodV1EnterpriseAIUsage
        - `costMicrounits` string
        - `credits` number, double
        - `currency` 'BILLING_CURRENCY_UNSPECIFIED' | 'BILLING_CURRENCY_USD' | 'BILLING_CURRENCY_EUR' | 'BILLING_CURRENCY_GBP'
        - `tokens` GitpodV1EnterpriseAITokenUsage
          - `cacheTokens` string
          - `inputTokens` string
          - `outputTokens` string
          - `totalTokens` string
      - `usageByTokenType` GitpodV1EnterpriseAIUsageByTokenType[]
        - `tokenType` '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` GitpodV1EnterpriseAIUsage
          - `costMicrounits` string
          - `credits` number, double
          - `currency` 'BILLING_CURRENCY_UNSPECIFIED' | 'BILLING_CURRENCY_USD' | 'BILLING_CURRENCY_EUR' | 'BILLING_CURRENCY_GBP'
          - `tokens` GitpodV1EnterpriseAITokenUsage
            - `cacheTokens` string
            - `inputTokens` string
            - `outputTokens` string
            - `totalTokens` string
    - `userId` string
    - `utilizationPercent` number, double

## Other responses

- `default` — Error

---

[API](https://skmtc.net/gitpod-io/apis/gitpod-v1.md) · [All operations](https://skmtc.net/gitpod-io/apis/gitpod-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gitpod-io/gitpod-v1/versions/44d50c2ac284/schema)