feat: load and log Copilot plan info from copilot_internal/user API (#687)

rajbos · Copilot · web-flow · commit 0f54a678d063 · 2026-04-29T13:14:47.000+02:00
* feat: load and log Copilot plan info from copilot_internal/user API After a GitHub session is established (startup restore, manual sign-in, or external session change), fire-and-forget fetch of https://api.github.com/copilot_internal/user to log the user's Copilot plan details (plan type, IDE chat, agent mode, public code suggestions, PR summaries) to the output channel. - Add CopilotPlanInfo type, fetchCopilotPlanInfoPage (internal) and fetchCopilotPlanInfo (exported with injectable fetcher for tests) to githubPrService.ts - Add CopilotTokenTracker.loadAndLogCopilotPlanInfo() that calls the fetcher and logs key plan fields; non-2xx responses and network errors are surfaced as warnings (best-effort, no impact on startup) - Wire void calls from restoreGitHubSession, authenticateWithGitHub, and the onDidChangeSessions handler so plan info refreshes on session change - Add 6 unit tests covering success, 401/403, network error, invalid response format, and partial data Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * feat: add copilotPlans.json with plan names and monthly premium request allotments Add a new data file mapping copilot_plan API values to display names, monthly prices, and premium request allotments (as of 2026-04-27): free → Copilot Free → 50 premium requests/month individual → Copilot Pro → 300 premium requests/month pro → Copilot Pro → 300 premium requests/month pro_plus → Copilot Pro+ → 1500 premium requests/month business → Copilot Business → 300 premium requests/month enterprise → Copilot Enterprise → 1000 premium requests/month Update loadAndLogCopilotPlanInfo() to look up the plan from the new file and include the human-readable name and credit allotment in the output log line, e.g.: Copilot plan: Copilot Enterprise (enterprise) Monthly premium requests: 1,000/month Document the new file in vscode-extension/src/README.md. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * feat: add monthlyAiCreditsUsd to copilotPlans.json and log it Each plan now records the dollar value of AI credits included per month (1 AI credit = \.01): free → \ (none) pro → \/month pro_plus → \/month business → \/month enterprise → \/month Update loadAndLogCopilotPlanInfo() to include the AI credits line: Monthly AI credits: \/month included Update README table and metadata notes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * feat: show Copilot plan name and included AI credits in details table Store the resolved plan from copilot_internal/user on the tracker (_copilotPlanResolved) and pass it to the details webview via window.__INITIAL_DETAILS__.copilotPlan. In the metrics table, two new rows appear after 'Estimated cost (TBB)' when a plan is known — only for the 'Last 30 Days' and 'Previous Month' columns (Today/Projected show '—' since the allotment is per-month): 🏷️ Copilot plan — Copilot Enterprise Copilot Enterprise — 💳 Included AI credits — \ \ — Both rows include tooltips. Rows are omitted entirely when the plan has not yet been loaded (e.g. user not signed in to GitHub). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * refactor: merge Copilot plan and AI credits into a single table row Combine the two rows into one: 'Copilot plan' now shows 'Copilot Enterprise (\ credits)' in the Last 30 Days and Previous Month columns instead of separate plan/credits rows. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * refactor: move Copilot plan info to label column Show 'Copilot Enterprise (\ credits/month)' in the row label and '—' in all value columns for a cleaner look. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diff --git a/vscode-extension/src/README.md b/vscode-extension/src/README.md
@@ -2,6 +2,41 @@
 
 This directory contains JSON configuration files for the GitHub Copilot Token Tracker extension.
 
+## copilotPlans.json
+
+Contains GitHub Copilot plan definitions — the `plans` object keys match the `copilot_plan` value returned by the `copilot_internal/user` API endpoint.
+
+**Structure:**
+```json
+{
+  "plans": {
+    "<plan-id>": {
+      "name": "Display name",
+      "monthlyPricePerUser": 10,
+      "monthlyPremiumRequests": 300,
+      "codeCompletionsPerMonth": null,
+      "description": "..."
+    }
+  }
+}
+```
+
+- `monthlyPremiumRequests` — included allotment per user per month; extra requests are $0.04 each
+- `monthlyAiCreditsUsd` — dollar value of AI credits included with the plan (1 AI credit = $0.01); `0` = none included
+- `codeCompletionsPerMonth` — tab completions limit; `null` = unlimited (paid plans)
+
+**Current plans:**
+
+| ID | Name | $/user/mo | AI credits/mo | Premium requests/mo |
+|----|------|-----------|---------------|---------------------|
+| `free` | Copilot Free | $0 | none | 50 |
+| `individual` / `pro` | Copilot Pro | $10 | $10 | 300 |
+| `pro_plus` | Copilot Pro+ | $39 | $39 | 1,500 |
+| `business` | Copilot Business | $19 | $19 | 300 |
+| `enterprise` | Copilot Enterprise | $39 | $39 | 1,000 |
+
+**How to update:** Edit the `plans` object when GitHub changes pricing or adds plans. Update `metadata.lastUpdated` and reference the [official plans page](https://docs.github.com/en/copilot/get-started/plans).
+
 ## tokenEstimators.json
 
 Contains character-to-token ratio estimators for different AI models. These ratios are used to estimate token counts from text length.
diff --git a/vscode-extension/src/copilotPlans.json b/vscode-extension/src/copilotPlans.json
@@ -0,0 +1,59 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "GitHub Copilot plan definitions. Keys match the value of the 'copilot_plan' field returned by the copilot_internal/user API endpoint.",
+  "metadata": {
+    "lastUpdated": "2026-04-27",
+    "source": "https://docs.github.com/en/copilot/get-started/plans",
+    "notes": "monthlyPremiumRequests is the included allotment per user per month. null means unlimited. Extra premium requests beyond the allotment are billed at $0.04 each. Code completions (tab completions) do not consume premium requests on paid plans. monthlyAiCreditsUsd is the dollar value of AI credits included with the plan (1 AI credit = $0.01)."
+  },
+  "plans": {
+    "free": {
+      "name": "Copilot Free",
+      "monthlyPricePerUser": 0,
+      "monthlyAiCreditsUsd": 0,
+      "monthlyPremiumRequests": 50,
+      "codeCompletionsPerMonth": 2000,
+      "description": "Limited plan for light use and evaluation"
+    },
+    "individual": {
+      "name": "Copilot Pro",
+      "monthlyPricePerUser": 10,
+      "monthlyAiCreditsUsd": 10,
+      "monthlyPremiumRequests": 300,
+      "codeCompletionsPerMonth": null,
+      "description": "For individual developers (legacy plan ID, same as 'pro')"
+    },
+    "pro": {
+      "name": "Copilot Pro",
+      "monthlyPricePerUser": 10,
+      "monthlyAiCreditsUsd": 10,
+      "monthlyPremiumRequests": 300,
+      "codeCompletionsPerMonth": null,
+      "description": "For individual developers"
+    },
+    "pro_plus": {
+      "name": "Copilot Pro+",
+      "monthlyPricePerUser": 39,
+      "monthlyAiCreditsUsd": 39,
+      "monthlyPremiumRequests": 1500,
+      "codeCompletionsPerMonth": null,
+      "description": "For power users needing more premium requests and the broadest model selection"
+    },
+    "business": {
+      "name": "Copilot Business",
+      "monthlyPricePerUser": 19,
+      "monthlyAiCreditsUsd": 19,
+      "monthlyPremiumRequests": 300,
+      "codeCompletionsPerMonth": null,
+      "description": "For organizations; includes policy controls and audit logs"
+    },
+    "enterprise": {
+      "name": "Copilot Enterprise",
+      "monthlyPricePerUser": 39,
+      "monthlyAiCreditsUsd": 39,
+      "monthlyPremiumRequests": 1000,
+      "codeCompletionsPerMonth": null,
+      "description": "For large organizations on GitHub Enterprise Cloud; includes custom models and expanded controls"
+    }
+  }
+}
diff --git a/vscode-extension/src/extension.ts b/vscode-extension/src/extension.ts
@@ -7,6 +7,7 @@ import tokenEstimatorsData from './tokenEstimators.json';
 import modelPricingData from './modelPricing.json';
 import toolNamesData from './toolNames.json';
 import customizationPatternsData from './customizationPatterns.json';
+import copilotPlansData from './copilotPlans.json';
 import { REPO_HYGIENE_SKILL } from './backend/repoHygieneSkill';
 import { BackendFacade } from './backend/facade';
 import { BackendCommandHandler } from './backend/commands';
@@ -18,6 +19,8 @@ import {
 	detectAiType,
 	discoverGitHubRepos,
 	fetchRepoPrs,
+	fetchCopilotPlanInfo,
+	type CopilotPlanInfo,
 	type RepoPrDetail,
 	type RepoPrInfo,
 	type RepoPrStatsResult,
@@ -281,6 +284,8 @@ class CopilotTokenTracker implements vscode.Disposable {
 	private _sessionRestorePromise: Promise<void> | undefined;
 	/** True when the user explicitly signed out from our extension this VS Code session. Gated by globalState so it survives reloads. */
 	private _githubSignedOutByUser: boolean = false;
+	/** Resolved Copilot plan details fetched from copilot_internal/user after sign-in. */
+	private _copilotPlanResolved: { planId: string; planName: string; monthlyAiCreditsUsd: number; monthlyPremiumRequests: number | null } | undefined;
 
 	// Cached PR stats result for the repos tab
 	private _lastRepoPrStats?: RepoPrStatsResult;
@@ -899,6 +904,7 @@ class CopilotTokenTracker implements vscode.Disposable {
 					this.githubSession = session;
 					await this.context.globalState.update('github.authenticated', true);
 					await this.context.globalState.update('github.username', session.account.label);
+					void this.loadAndLogCopilotPlanInfo();
 				} else {
 					this.githubSession = undefined;
 					await this.context.globalState.update('github.authenticated', false);
@@ -1101,6 +1107,7 @@ class CopilotTokenTracker implements vscode.Disposable {
 				vscode.window.showInformationMessage(`GitHub authentication successful! Logged in as ${session.account.label}`);
 				await this.context.globalState.update('github.authenticated', true);
 				await this.context.globalState.update('github.username', session.account.label);
+				void this.loadAndLogCopilotPlanInfo();
 			}
 		} catch (error) {
 			this.error('GitHub authentication failed:', error);
@@ -1296,6 +1303,7 @@ class CopilotTokenTracker implements vscode.Disposable {
 				this.log(`✅ GitHub session found for ${session.account.label}`);
 				await this.context.globalState.update('github.authenticated', true);
 				await this.context.globalState.update('github.username', session.account.label);
+				void this.loadAndLogCopilotPlanInfo();
 			} else {
 				const wasAuthenticated = this.context.globalState.get<boolean>('github.authenticated', false);
 				if (wasAuthenticated) {
@@ -1312,6 +1320,47 @@ class CopilotTokenTracker implements vscode.Disposable {
 		}
 	}
 
+	/**
+	 * Fetch and log Copilot plan information for the authenticated user.
+	 * Best-effort: silently skips if not authenticated or if the endpoint is unavailable.
+	 */
+	private async loadAndLogCopilotPlanInfo(): Promise<void> {
+		if (!this.githubSession) { return; }
+		try {
+			const { planInfo, statusCode, error } = await fetchCopilotPlanInfo(this.githubSession.accessToken);
+			if (error || !planInfo) {
+				this.warn(`Copilot plan info unavailable (HTTP ${statusCode ?? 'n/a'}): ${error ?? 'no data'}`);
+				return;
+			}
+			const planId = planInfo.copilot_plan as string | undefined;
+			const plans = copilotPlansData.plans as Record<string, { name: string; monthlyPremiumRequests: number | null; monthlyPricePerUser: number; monthlyAiCreditsUsd: number }>;
+			const knownPlan = planId ? plans[planId] : undefined;
+			const planLabel = knownPlan ? `${knownPlan.name} (${planId})` : (planId ?? 'unknown');
+			this.log(`Copilot plan: ${planLabel}`);
+			if (knownPlan) {
+				const credits = knownPlan.monthlyPremiumRequests !== null ? `${knownPlan.monthlyPremiumRequests.toLocaleString()}/month` : 'unlimited';
+				this.log(`  Monthly premium requests: ${credits}`);
+				const aiCredits = knownPlan.monthlyAiCreditsUsd > 0 ? `$${knownPlan.monthlyAiCreditsUsd}/month included` : 'none';
+				this.log(`  Monthly AI credits: ${aiCredits}`);
+				this._copilotPlanResolved = {
+					planId: planId!,
+					planName: knownPlan.name,
+					monthlyAiCreditsUsd: knownPlan.monthlyAiCreditsUsd,
+					monthlyPremiumRequests: knownPlan.monthlyPremiumRequests,
+				};
+			} else if (planId) {
+				// Unknown plan ID — store it with no credits so the webview still shows it
+				this._copilotPlanResolved = { planId, planName: planId, monthlyAiCreditsUsd: 0, monthlyPremiumRequests: null };
+			}
+			if (planInfo.ide_chat !== undefined)          { this.log(`  IDE chat: ${planInfo.ide_chat}`); }
+			if (planInfo.copilot_ide_agent !== undefined) { this.log(`  Agent mode: ${planInfo.copilot_ide_agent}`); }
+			if (planInfo.public_code_suggestions !== undefined) { this.log(`  Public code suggestions: ${planInfo.public_code_suggestions}`); }
+			if (planInfo.unlimited_pr_summaries !== undefined)  { this.log(`  Unlimited PR summaries: ${planInfo.unlimited_pr_summaries}`); }
+		} catch (err) {
+			this.warn('Failed to load Copilot plan info: ' + String(err));
+		}
+	}
+
 	public async updateTokenStats(silent: boolean = false): Promise<DetailedStats | undefined> {
 		try {
 			this.log('Updating token stats...');
@@ -6437,6 +6486,7 @@ ${hashtag}`;
       backendConfigured: this.isBackendConfigured(),
       sortSettings,
       compactNumbers: this.getCompactNumbersSetting(),
+      copilotPlan: this._copilotPlanResolved,
     };
     const initialData = JSON.stringify(dataWithBackend).replace(
       /</g,
diff --git a/vscode-extension/src/githubPrService.ts b/vscode-extension/src/githubPrService.ts
@@ -26,6 +26,78 @@ export type RepoPrStatsResult = {
 	since: string; // ISO date string
 };
 
+// ---------------------------------------------------------------------------
+// Copilot plan info
+// ---------------------------------------------------------------------------
+
+export type CopilotPlanInfo = {
+	copilot_plan?: string;             // e.g. "copilot_individual" | "copilot_business" | "copilot_enterprise" | "copilot_free"
+	public_code_suggestions?: string;  // "block" | "allow"
+	ide_chat?: string;                 // "enabled" | "disabled"
+	copilot_ide_agent?: string;        // "enabled" | "disabled"
+	unlimited_pr_summaries?: boolean;
+	assignee?: { login?: string; id?: number };
+	[key: string]: unknown;
+};
+
+export type CopilotPlanResult = { planInfo?: CopilotPlanInfo; statusCode?: number; error?: string };
+
+/** Internal low-level fetcher for the copilot_internal/user endpoint. */
+function fetchCopilotPlanInfoPage(token: string): Promise<CopilotPlanResult> {
+	return new Promise((resolve) => {
+		const req = https.request(
+			{
+				hostname: 'api.github.com',
+				path: '/copilot_internal/user',
+				headers: {
+					Authorization: `Bearer ${token}`,
+					'User-Agent': 'copilot-token-tracker',
+					Accept: 'application/json',
+				},
+			},
+			(res) => {
+				let data = '';
+				res.on('data', (chunk) => (data += chunk));
+				res.on('end', () => {
+					const statusCode = res.statusCode ?? 0;
+					if (statusCode < 200 || statusCode >= 300) {
+						resolve({ statusCode, error: `HTTP ${statusCode}` });
+						return;
+					}
+					try {
+						const parsed = JSON.parse(data);
+						if (typeof parsed !== 'object' || parsed === null) {
+							resolve({ statusCode, error: 'Unexpected response format' });
+							return;
+						}
+						resolve({ planInfo: parsed as CopilotPlanInfo, statusCode });
+					} catch (e) {
+						resolve({ statusCode, error: String(e) });
+					}
+				});
+			},
+		);
+		req.on('error', (e) => resolve({ error: e.message }));
+		req.setTimeout(15000, () => {
+			req.destroy(new Error('Request timed out after 15 s'));
+		});
+		req.end();
+	});
+}
+
+/**
+ * Fetch GitHub Copilot plan information for the authenticated user.
+ * Uses the VS Code-only internal endpoint `https://api.github.com/copilot_internal/user`.
+ * Treat as best-effort — this endpoint may not be available for all accounts.
+ * @param fetcher Injectable fetcher for testing; defaults to the real HTTPS implementation.
+ */
+export function fetchCopilotPlanInfo(
+	token: string,
+	fetcher: (token: string) => Promise<CopilotPlanResult> = fetchCopilotPlanInfoPage,
+): Promise<CopilotPlanResult> {
+	return fetcher(token);
+}
+
 /** Detect which AI system a GitHub login belongs to, or null if not an AI bot. */
 export function detectAiType(login: string): RepoPrDetail['aiType'] | null {
 	const l = login.toLowerCase();
diff --git a/vscode-extension/src/webview/details/main.ts b/vscode-extension/src/webview/details/main.ts
@@ -40,6 +40,12 @@ type DetailedStats = {
 	lastUpdated: string | Date;
 	backendConfigured?: boolean;
 	compactNumbers?: boolean;
+	copilotPlan?: {
+		planId: string;
+		planName: string;
+		monthlyAiCreditsUsd: number;
+		monthlyPremiumRequests: number | null;
+	};
 	sortSettings?: {
 		editor?: { key?: string; dir?: string };
 		model?: { key?: string; dir?: string };
@@ -236,6 +242,15 @@ function buildMetricsSection(
 			icon: '🟢', color: '#7ce38b',
 			today: formatCost(stats.today.estimatedCostCopilot ?? 0), last30Days: formatCost(stats.last30Days.estimatedCostCopilot ?? 0), lastMonth: formatCost(stats.lastMonth.estimatedCostCopilot ?? 0), projected: formatCost(projections.projectedCostCopilot ?? 0)
 		},
+		...(stats.copilotPlan ? (() => {
+			const credits = stats.copilotPlan.monthlyAiCreditsUsd > 0 ? `$${stats.copilotPlan.monthlyAiCreditsUsd} credits/month` : 'no credits';
+			return [{
+				label: `${stats.copilotPlan.planName} (${credits})`,
+				labelTooltip: `Your active GitHub Copilot subscription plan (ID: ${stats.copilotPlan.planId}). Included AI credits cover token-based billing (1 AI credit = $0.01).`,
+				icon: '🏷️', color: '#60a5fa',
+				today: '—', last30Days: '—', lastMonth: '—', projected: '—'
+			}];
+		})() : []),
 		{ label: 'Sessions', icon: '📅', color: '#66aaff', today: formatNumber(stats.today.sessions), last30Days: formatNumber(stats.last30Days.sessions), lastMonth: formatNumber(stats.lastMonth.sessions), projected: formatNumber(projections.projectedSessions) },
 		{ label: 'Average interactions/session', icon: '💬', color: '#8ce0ff', today: formatNumber(stats.today.avgInteractionsPerSession), last30Days: formatNumber(stats.last30Days.avgInteractionsPerSession), lastMonth: formatNumber(stats.lastMonth.avgInteractionsPerSession), projected: '—' },
 		{ label: 'Average tokens/session', icon: '🔢', color: '#7ce38b', today: formatCompact(stats.today.avgTokensPerSession), last30Days: formatCompact(stats.last30Days.avgTokensPerSession), lastMonth: formatCompact(stats.lastMonth.avgTokensPerSession), projected: '—' }
diff --git a/vscode-extension/test/unit/githubPrService.test.ts b/vscode-extension/test/unit/githubPrService.test.ts
@@ -1,6 +1,6 @@
 import test from 'node:test';
 import * as assert from 'node:assert/strict';
-import { detectAiType, fetchRepoPrs } from '../../src/githubPrService';
+import { detectAiType, fetchRepoPrs, fetchCopilotPlanInfo, type CopilotPlanInfo } from '../../src/githubPrService';
 
 // ---------------------------------------------------------------------------
 // detectAiType — pure function, no I/O
@@ -145,3 +145,60 @@ test('fetchRepoPrs: propagates generic error from fetchPage', async () => {
 	assert.equal(prs.length, 0);
 	assert.equal(error, 'Network error');
 });
+
+// ---------------------------------------------------------------------------
+// fetchCopilotPlanInfo — uses injectable fetcher
+// ---------------------------------------------------------------------------
+
+test('fetchCopilotPlanInfo: returns plan info on success', async () => {
+	const planData: CopilotPlanInfo = {
+		copilot_plan: 'copilot_individual',
+		ide_chat: 'enabled',
+		copilot_ide_agent: 'enabled',
+		public_code_suggestions: 'block',
+		unlimited_pr_summaries: true,
+	};
+	const mockFetcher = async () => ({ planInfo: planData, statusCode: 200 });
+	const { planInfo, statusCode, error } = await fetchCopilotPlanInfo('token', mockFetcher);
+	assert.equal(error, undefined);
+	assert.equal(statusCode, 200);
+	assert.deepEqual(planInfo, planData);
+});
+
+test('fetchCopilotPlanInfo: returns error on non-2xx response', async () => {
+	const mockFetcher = async () => ({ statusCode: 401, error: 'HTTP 401' });
+	const { planInfo, statusCode, error } = await fetchCopilotPlanInfo('token', mockFetcher);
+	assert.equal(planInfo, undefined);
+	assert.equal(statusCode, 401);
+	assert.equal(error, 'HTTP 401');
+});
+
+test('fetchCopilotPlanInfo: returns error on 403 response', async () => {
+	const mockFetcher = async () => ({ statusCode: 403, error: 'HTTP 403' });
+	const { planInfo, statusCode, error } = await fetchCopilotPlanInfo('token', mockFetcher);
+	assert.equal(planInfo, undefined);
+	assert.equal(statusCode, 403);
+});
+
+test('fetchCopilotPlanInfo: returns error on network failure', async () => {
+	const mockFetcher = async () => ({ error: 'socket hang up' });
+	const { planInfo, error } = await fetchCopilotPlanInfo('token', mockFetcher);
+	assert.equal(planInfo, undefined);
+	assert.equal(error, 'socket hang up');
+});
+
+test('fetchCopilotPlanInfo: returns error on unexpected response format', async () => {
+	const mockFetcher = async () => ({ statusCode: 200, error: 'Unexpected response format' });
+	const { planInfo, error } = await fetchCopilotPlanInfo('token', mockFetcher);
+	assert.equal(planInfo, undefined);
+	assert.ok(error?.includes('Unexpected response format'));
+});
+
+test('fetchCopilotPlanInfo: handles partial plan data gracefully', async () => {
+	// Not all fields may be present — only copilot_plan returned
+	const mockFetcher = async () => ({ planInfo: { copilot_plan: 'copilot_free' } as CopilotPlanInfo, statusCode: 200 });
+	const { planInfo, error } = await fetchCopilotPlanInfo('token', mockFetcher);
+	assert.equal(error, undefined);
+	assert.equal(planInfo?.copilot_plan, 'copilot_free');
+	assert.equal(planInfo?.ide_chat, undefined);
+});
