feat(gh-copilot): add AI credit usage billing metrics collection

backend/plugins/gh-copilot/e2e/metrics/snapshot_tables/_tool_copilot_enterprise_ai_credit_usage.csv

@@ -0,0 +1,4 @@
+connection_id,scope_id,year,month,day,enterprise,model,organization,user,product,cost_center_id,cost_center_name,gross_quantity,discount_quantity,net_quantity,price_per_unit,gross_amount,discount_amount,net_amount
+1,octodemo,2025,12,10,octodemo,gpt-4.1,,,copilot,,,100.5,10.0,90.5,1.0,100.5,10.0,90.5
+1,octodemo,2025,12,10,octodemo,gpt-4o,,,copilot,cc-eng,Engineering,50.0,5.0,45.0,1.0,50.0,5.0,45.0
+1,octodemo,2025,12,10,octodemo,claude-3,,,copilot,cc-ml,Machine Learning,30.0,2.0,28.0,1.0,30.0,2.0,28.0

backend/plugins/gh-copilot/e2e/metrics/snapshot_tables/_tool_copilot_org_ai_credit_usage.csv

@@ -0,0 +1,4 @@
+connection_id,scope_id,year,month,day,organization,model,user,product,gross_quantity,discount_quantity,net_quantity,price_per_unit,gross_amount,discount_amount,net_amount
+1,octodemo,2025,12,10,octodemo,gpt-4.1,alice,copilot,50.0,5.0,45.0,1.0,50.0,5.0,45.0
+1,octodemo,2025,12,10,octodemo,gpt-4o,bob,copilot,30.0,3.0,27.0,1.0,30.0,3.0,27.0
+1,octodemo,2025,12,10,octodemo,claude-3,charlie,copilot,20.0,0.0,20.0,1.0,20.0,0.0,20.0

backend/plugins/gh-copilot/e2e/metrics/snapshot_tables/_tool_copilot_user_ai_credit_usage.csv

@@ -0,0 +1,4 @@
+connection_id,scope_id,year,month,day,user,model,product,gross_quantity,discount_quantity,net_quantity,price_per_unit,gross_amount,discount_amount,net_amount
+1,octodemo,2025,12,10,alice,gpt-4.1,copilot,50.0,5.0,45.0,1.0,50.0,5.0,45.0
+1,octodemo,2025,12,10,alice,gpt-4o,copilot,30.0,3.0,27.0,1.0,30.0,3.0,27.0
+1,octodemo,2025,12,10,bob,claude-3,copilot,20.0,2.0,18.0,1.0,20.0,2.0,18.0

backend/plugins/gh-copilot/models/enterprise_ai_credit_usage.go

@@ -0,0 +1,56 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package models
+
+import (
+	"github.com/apache/incubator-devlake/core/models/common"
+)
+
+// GhCopilotEnterpriseAiCreditUsage tracks AI credit consumption at the enterprise level.
+// One row per time period per model per entity (user, org, or cost center).
+type GhCopilotEnterpriseAiCreditUsage struct {
+	ConnectionId uint64 `gorm:"primaryKey" json:"connectionId"`
+	ScopeId      string `gorm:"primaryKey;type:varchar(191)" json:"scopeId"`
+	Year         int    `gorm:"primaryKey" json:"year"`
+	Month        int    `gorm:"primaryKey" json:"month"`
+	Day          int    `gorm:"primaryKey" json:"day"`
+
+	Enterprise   string `gorm:"primaryKey;type:varchar(191);comment:Enterprise slug" json:"enterprise"`
+	Model        string `gorm:"primaryKey;type:varchar(191);comment:AI model name (e.g., gpt-4.1)" json:"model"`
+	Organization string `gorm:"index;type:varchar(255);comment:Organization within enterprise, if specified" json:"organization"`
+	User         string `gorm:"index;type:varchar(255);comment:Username, if specified" json:"user"`
+
+	Product        string `gorm:"type:varchar(32);comment:Product name (e.g., copilot)" json:"product"`
+	CostCenterId   string `gorm:"index;type:varchar(255);comment:Cost center identifier" json:"costCenterId"`
+	CostCenterName string `gorm:"type:varchar(255);comment:Cost center display name" json:"costCenterName"`
+
+	// Credit usage breakdown
+	GrossQuantity    float64 `json:"grossQuantity" gorm:"comment:Raw credits consumed"`
+	DiscountQuantity float64 `json:"discountQuantity" gorm:"comment:Credits discounted"`
+	NetQuantity      float64 `json:"netQuantity" gorm:"comment:Credits after discount"`
+	PricePerUnit     float64 `json:"pricePerUnit" gorm:"comment:Price per credit unit"`
+	GrossAmount      float64 `json:"grossAmount" gorm:"comment:Gross cost before discount"`
+	DiscountAmount   float64 `json:"discountAmount" gorm:"comment:Discount amount"`
+	NetAmount        float64 `json:"netAmount" gorm:"comment:Net cost after discount"`
+
+	common.NoPKModel
+}
+
+func (GhCopilotEnterpriseAiCreditUsage) TableName() string {
+	return "_tool_copilot_enterprise_ai_credit_usage"
+}

backend/plugins/gh-copilot/models/migrationscripts/20260708_add_ai_credit_usage_metrics.go

@@ -0,0 +1,45 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package migrationscripts
+
+import (
+	"github.com/apache/incubator-devlake/core/context"
+	"github.com/apache/incubator-devlake/core/errors"
+	"github.com/apache/incubator-devlake/helpers/migrationhelper"
+	"github.com/apache/incubator-devlake/plugins/gh-copilot/models"
+)
+
+type addAiCreditUsageMetrics struct{}
+
+func (u *addAiCreditUsageMetrics) Up(basicRes context.BasicRes) errors.Error {
+	return migrationhelper.AutoMigrateTables(
+		basicRes,
+		&models.GhCopilotEnterpriseAiCreditUsage{},
+		&models.GhCopilotOrgAiCreditUsage{},
+		&models.GhCopilotUserAiCreditUsage{},
+		&models.GhCopilotUserDailyMetrics{},
+	)
+}
+
+func (u *addAiCreditUsageMetrics) Version() uint64 {
+	return 20260708000000
+}
+
+func (u *addAiCreditUsageMetrics) Name() string {
+	return "add AI credit usage billing tables"
+}

backend/plugins/gh-copilot/models/migrationscripts/register.go

@@ -31,5 +31,6 @@ func All() []plugin.MigrationScript {
 		new(addPRFieldsToEnterpriseMetrics),
 		new(addOrganizationIdToUserMetrics),
 		new(addCopilotMetricsGaps),
+		new(addAiCreditUsageMetrics),
 	}
 }

backend/plugins/gh-copilot/models/models.go

@@ -47,5 +47,9 @@ func GetTablesInfo() []dal.Tabler {
 		&GhCopilotSeat{},
 		// User-team mappings
 		&GhCopilotUserTeam{},
+		// AI credit usage billing (enterprise, org, user levels)
+		&GhCopilotEnterpriseAiCreditUsage{},
+		&GhCopilotOrgAiCreditUsage{},
+		&GhCopilotUserAiCreditUsage{},
 	}
 }

backend/plugins/gh-copilot/models/models_test.go

@@ -41,6 +41,9 @@ func TestGetTablesInfo(t *testing.T) {
 		(&GhCopilotUserMetricsByModelFeature{}).TableName():    false,
 		(&GhCopilotSeat{}).TableName():                         false,
 		(&GhCopilotUserTeam{}).TableName():                     false,
+		(&GhCopilotEnterpriseAiCreditUsage{}).TableName():      false,
+		(&GhCopilotOrgAiCreditUsage{}).TableName():             false,
+		(&GhCopilotUserAiCreditUsage{}).TableName():            false,
 	}
 
 	if len(tables) != len(expected) {

backend/plugins/gh-copilot/models/org_ai_credit_usage.go

@@ -0,0 +1,53 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package models
+
+import (
+	"github.com/apache/incubator-devlake/core/models/common"
+)
+
+// GhCopilotOrgAiCreditUsage tracks AI credit consumption at the organization level.
+// One row per time period per model per user (within the organization).
+type GhCopilotOrgAiCreditUsage struct {
+	ConnectionId uint64 `gorm:"primaryKey" json:"connectionId"`
+	ScopeId      string `gorm:"primaryKey;type:varchar(191)" json:"scopeId"`
+	Year         int    `gorm:"primaryKey" json:"year"`
+	Month        int    `gorm:"primaryKey" json:"month"`
+	Day          int    `gorm:"primaryKey" json:"day"`
+
+	Organization string `gorm:"primaryKey;type:varchar(191);comment:Organization name" json:"organization"`
+	Model        string `gorm:"primaryKey;type:varchar(191);comment:AI model name (e.g., gpt-4.1)" json:"model"`
+	User         string `gorm:"index;type:varchar(255);comment:Username consuming the credits" json:"user"`
+
+	Product string `gorm:"type:varchar(32);comment:Product name (e.g., copilot)" json:"product"`
+
+	// Credit usage breakdown
+	GrossQuantity    float64 `json:"grossQuantity" gorm:"comment:Raw credits consumed"`
+	DiscountQuantity float64 `json:"discountQuantity" gorm:"comment:Credits discounted"`
+	NetQuantity      float64 `json:"netQuantity" gorm:"comment:Credits after discount"`
+	PricePerUnit     float64 `json:"pricePerUnit" gorm:"comment:Price per credit unit"`
+	GrossAmount      float64 `json:"grossAmount" gorm:"comment:Gross cost before discount"`
+	DiscountAmount   float64 `json:"discountAmount" gorm:"comment:Discount amount"`
+	NetAmount        float64 `json:"netAmount" gorm:"comment:Net cost after discount"`
+
+	common.NoPKModel
+}
+
+func (GhCopilotOrgAiCreditUsage) TableName() string {
+	return "_tool_copilot_org_ai_credit_usage"
+}

backend/plugins/gh-copilot/models/user_ai_credit_usage.go

@@ -0,0 +1,52 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package models
+
+import (
+	"github.com/apache/incubator-devlake/core/models/common"
+)
+
+// GhCopilotUserAiCreditUsage tracks AI credit consumption at the individual user level.
+// One row per time period per model per authenticated user.
+type GhCopilotUserAiCreditUsage struct {
+	ConnectionId uint64 `gorm:"primaryKey" json:"connectionId"`
+	ScopeId      string `gorm:"primaryKey;type:varchar(191)" json:"scopeId"`
+	Year         int    `gorm:"primaryKey" json:"year"`
+	Month        int    `gorm:"primaryKey" json:"month"`
+	Day          int    `gorm:"primaryKey" json:"day"`
+
+	User  string `gorm:"primaryKey;type:varchar(191);comment:GitHub username" json:"user"`
+	Model string `gorm:"primaryKey;type:varchar(191);comment:AI model name (e.g., gpt-4.1)" json:"model"`
+
+	Product string `gorm:"type:varchar(32);comment:Product name (e.g., copilot)" json:"product"`
+
+	// Credit usage breakdown
+	GrossQuantity    float64 `json:"grossQuantity" gorm:"comment:Raw credits consumed"`
+	DiscountQuantity float64 `json:"discountQuantity" gorm:"comment:Credits discounted"`
+	NetQuantity      float64 `json:"netQuantity" gorm:"comment:Credits after discount"`
+	PricePerUnit     float64 `json:"pricePerUnit" gorm:"comment:Price per credit unit"`
+	GrossAmount      float64 `json:"grossAmount" gorm:"comment:Gross cost before discount"`
+	DiscountAmount   float64 `json:"discountAmount" gorm:"comment:Discount amount"`
+	NetAmount        float64 `json:"netAmount" gorm:"comment:Net cost after discount"`
+
+	common.NoPKModel
+}
+
+func (GhCopilotUserAiCreditUsage) TableName() string {
+	return "_tool_copilot_user_ai_credit_usage"
+}

backend/plugins/gh-copilot/models/user_metrics.go

@@ -38,6 +38,7 @@ type GhCopilotUserDailyMetrics struct {
 	UsedCli                      bool   `json:"usedCli" gorm:"comment:Whether user used Copilot CLI"`
 	UsedCopilotCodeReviewActive  bool   `json:"usedCopilotCodeReviewActive" gorm:"comment:Whether user actively used code review"`
 	UsedCopilotCodeReviewPassive bool   `json:"usedCopilotCodeReviewPassive" gorm:"comment:Whether user passively used code review"`
+	AiCreditsUsed                float64 `json:"aiCreditsUsed" gorm:"comment:AI credits consumed on this day"`
 
 	CopilotActivityMetrics `mapstructure:",squash"`
 	CopilotCliMetrics      `mapstructure:",squash"`

backend/plugins/gh-copilot/tasks/ai_credit_collector.go

@@ -0,0 +1,123 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+the ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package tasks
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"net/url"
+	"strconv"
+	"time"
+
+	"github.com/apache/incubator-devlake/core/errors"
+	"github.com/apache/incubator-devlake/core/plugin"
+	helper "github.com/apache/incubator-devlake/helpers/pluginhelper/api"
+)
+
+const rawAiCreditUsageTable = "copilot_ai_credit_usage"
+
+func CollectAiCreditUsage(taskCtx plugin.SubTaskContext) errors.Error {
+	data, ok := taskCtx.TaskContext().GetData().(*GhCopilotTaskData)
+	if !ok {
+		return errors.Default.New("task data is not GhCopilotTaskData")
+	}
+	connection := data.Connection
+	connection.Normalize()
+
+	apiClient, err := CreateApiClient(taskCtx.TaskContext(), connection)
+	if err != nil {
+		return err
+	}
+
+	var urlTemplate string
+	var scope string
+
+	if connection.HasEnterprise() {
+		urlTemplate = fmt.Sprintf("enterprises/%s/settings/billing/ai_credit/usage", connection.Enterprise)
+		scope = connection.Enterprise
+	} else if connection.Organization != "" {
+		urlTemplate = fmt.Sprintf("organizations/%s/settings/billing/ai_credit/usage", connection.Organization)
+		scope = connection.Organization
+	} else {
+		urlTemplate = "user/settings/billing/ai_credit/usage"
+		scope = "user"
+	}
+
+	rawArgs := helper.RawDataSubTaskArgs{
+		Ctx:   taskCtx,
+		Table: rawAiCreditUsageTable,
+		Options: copilotRawParams{
+			ConnectionId: data.Options.ConnectionId,
+			ScopeId:      data.Options.ScopeId,
+			Organization: connection.Organization,
+			Endpoint:     connection.Endpoint,
+		},
+	}
+
+	collector, err := helper.NewStatefulApiCollector(rawArgs)
+	if err != nil {
+		return err
+	}
+
+	now := time.Now().UTC()
+	start, until := computeReportDateRange(now, collector.GetSince())
+	start = clampDailyMetricsStartForBackfill(start, until)
+
+	dayIter := newDayIterator(start, until)
+
+	err = collector.InitCollector(helper.ApiCollectorArgs{
+		ApiClient:   apiClient,
+		Input:       dayIter,
+		UrlTemplate: urlTemplate,
+		Query: func(reqData *helper.RequestData) (url.Values, errors.Error) {
+			input := reqData.Input.(*dayInput)
+			day, parseErr := time.Parse("2006-01-02", input.Day)
+			if parseErr != nil {
+				return nil, errors.Convert(parseErr)
+			}
+			q := url.Values{}
+			q.Set("year", strconv.Itoa(day.Year()))
+			q.Set("month", strconv.Itoa(int(day.Month())))
+			q.Set("day", strconv.Itoa(day.Day()))
+			return q, nil
+		},
+		Incremental:   true,
+		Concurrency:   1,
+		AfterResponse: ignoreNoContent,
+		ResponseParser: func(res *http.Response) ([]json.RawMessage, errors.Error) {
+			if res.StatusCode != http.StatusOK {
+				return nil, errors.HttpStatus(res.StatusCode).New(fmt.Sprintf("failed to collect AI credit usage for %s", scope))
+			}
+
+			var response struct {
+				UsageItems []json.RawMessage `json:"usageItems"`
+			}
+			if unmErr := helper.UnmarshalResponse(res, &response); unmErr != nil {
+				return nil, unmErr
+			}
+
+			return response.UsageItems, nil
+		},
+	})
+	if err != nil {
+		return err
+	}
+
+	return collector.Execute()
+}