GetCreditUsageReport
client.Billing.GetCreditUsageReport(ctx, body) (*BillingGetCreditUsageReportResponse, error)
POST/gitpod.v1.BillingService/GetCreditUsageReport
Returns a daily credit usage report for an enterprise organization.
Each day reports org-wide credits by usage type, plus per-user, per-team, per-environment, and per-conversation breakdowns (top consumers with the remainder aggregated into an “Others” bucket) and a per-model breakdown of intelligence usage.
Use this method to:
- Chart daily credit consumption over a date range
- Attribute credit usage to users, teams, environments, and conversations
- Restrict the report to a single user or service account
Examples
-
Get the report for January:
Both dates are inclusive and the range must not exceed 31 days.
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.
GetCreditUsageReport
package main
import (
"context"
"fmt"
"time"
"github.com/gitpod-io/gitpod-sdk-go"
"github.com/gitpod-io/gitpod-sdk-go/option"
"github.com/gitpod-io/gitpod-sdk-go/shared"
)
func main() {
client := gitpod.NewClient(
option.WithBearerToken("My Bearer Token"),
)
response, err := client.Billing.GetCreditUsageReport(context.TODO(), gitpod.BillingGetCreditUsageReportParams{
DateRange: gitpod.F(shared.DateRangeParam{
EndTime: gitpod.F(time.Now()),
StartTime: gitpod.F(time.Now()),
}),
OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.DailyUsage)
}
{
"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"
}Returns Examples
{
"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"
}