feat(admin-panel) - add billing/usage section (#21672)

Add billing/usage section <img width="740" height="763" alt="Screenshot 2026-06-16 at 14 39 51" src="https://github.com/user-attachments/assets/42db4fe4-3158-4ab8-aee5-28121ea530cd" />  <a href="https://cubic.dev/pr/twentyhq/twenty/pull/21672?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a>
2026-06-16 15:18:43 +02:00
parent d5c7b735d2
commit 16a92f52a4
6 changed files with 176 additions and 5 deletions
@@ -1,6 +1,7 @@
 import { Field, Float, ObjectType } from '@nestjs/graphql';

 import { AdminPanelWorkspaceSubscriptionDTO } from 'src/engine/core-modules/admin-panel/dtos/admin-panel-workspace-subscription.dto';
+import { AdminPanelWorkspaceUsageDTO } from 'src/engine/core-modules/admin-panel/dtos/admin-panel-workspace-usage.dto';

@ObjectType('AdminPanelWorkspaceBilling')
 export class AdminPanelWorkspaceBillingDTO {
@@ -12,4 +13,7 @@ export class AdminPanelWorkspaceBillingDTO {

  @Field(() => AdminPanelWorkspaceSubscriptionDTO, { nullable: true })
  subscription: AdminPanelWorkspaceSubscriptionDTO | null;
+
+  @Field(() => AdminPanelWorkspaceUsageDTO, { nullable: true })
+  usage: AdminPanelWorkspaceUsageDTO | null;
 }
@@ -0,0 +1,25 @@
+import { Field, Float, ObjectType } from '@nestjs/graphql';
+
+@ObjectType('AdminPanelWorkspaceUsage')
+export class AdminPanelWorkspaceUsageDTO {
+  @Field(() => Date)
+  periodStart: Date;
+
+  @Field(() => Date)
+  periodEnd: Date;
+
+  @Field(() => Float)
+  usedCredits: number;
+
+  @Field(() => Float)
+  grantedCredits: number;
+
+  @Field(() => Float)
+  rolloverCredits: number;
+
+  @Field(() => Float)
+  totalGrantedCredits: number;
+
+  @Field(() => Float)
+  remainingCredits: number;
+}
@@ -1,14 +1,18 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable, Logger } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';

 import { In, type Repository } from 'typeorm';

 import { AdminPanelWorkspaceBillingDTO } from 'src/engine/core-modules/admin-panel/dtos/admin-panel-workspace-billing.dto';
+import { type AdminPanelWorkspaceUsageDTO } from 'src/engine/core-modules/admin-panel/dtos/admin-panel-workspace-usage.dto';
 import { BillingCustomerEntity } from 'src/engine/core-modules/billing/entities/billing-customer.entity';
 import { BillingPriceEntity } from 'src/engine/core-modules/billing/entities/billing-price.entity';
 import { BillingPlanKey } from 'src/engine/core-modules/billing/enums/billing-plan-key.enum';
 import { BillingSubscriptionService } from 'src/engine/core-modules/billing/services/billing-subscription.service';
+import { BillingUsageService } from 'src/engine/core-modules/billing/services/billing-usage.service';
 import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
+import { toDisplayCredits } from 'src/engine/core-modules/usage/utils/to-display-credits.util';
+import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
 import { InjectWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/inject-workspace-scoped-repository.decorator';
 import { WorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/workspace-scoped-repository';
 const CREDIT_BALANCE_MICRO_UNIT = 1_000_000;
@@ -19,12 +23,17 @@ const KNOWN_PLAN_KEYS: ReadonlySet<string> = new Set(

@Injectable()
 export class AdminPanelBillingService {
+  private readonly logger = new Logger(AdminPanelBillingService.name);
+
  constructor(
    @InjectWorkspaceScopedRepository(BillingCustomerEntity)
    private readonly billingCustomerRepository: WorkspaceScopedRepository<BillingCustomerEntity>,
    @InjectRepository(BillingPriceEntity)
    private readonly billingPriceRepository: Repository<BillingPriceEntity>,
+    @InjectRepository(WorkspaceEntity)
+    private readonly workspaceRepository: Repository<WorkspaceEntity>,
    private readonly billingSubscriptionService: BillingSubscriptionService,
+    private readonly billingUsageService: BillingUsageService,
    private readonly twentyConfigService: TwentyConfigService,
  ) {}

@@ -57,9 +66,12 @@ export class AdminPanelBillingService {
        stripeCustomerId,
        creditBalance,
        subscription: null,
+        usage: null,
      };
    }

+    const usage = await this.getWorkspaceUsage(workspaceId);
+
    const items = subscription.billingSubscriptionItems ?? [];
    const priceIds = items.map((item) => item.stripePriceId);
    const prices = priceIds.length
@@ -80,6 +92,7 @@ export class AdminPanelBillingService {
    return {
      stripeCustomerId,
      creditBalance,
+      usage,
      subscription: {
        stripeSubscriptionId: subscription.stripeSubscriptionId,
        status: subscription.status,
@@ -112,4 +125,48 @@ export class AdminPanelBillingService {
      },
    };
  }
+
+  private async getWorkspaceUsage(
+    workspaceId: string,
+  ): Promise<AdminPanelWorkspaceUsageDTO | null> {
+    const workspace = await this.workspaceRepository.findOne({
+      where: { id: workspaceId },
+    });
+
+    if (!workspace) {
+      return null;
+    }
+
+    try {
+      const [usage] =
+        await this.billingUsageService.getResourceCreditProductUsage(workspace);
+
+      if (!usage) {
+        return null;
+      }
+
+      const usedCredits = toDisplayCredits(usage.usedCredits);
+      const grantedCredits = toDisplayCredits(usage.grantedCredits);
+      const rolloverCredits = toDisplayCredits(usage.rolloverCredits);
+      const totalGrantedCredits = toDisplayCredits(usage.totalGrantedCredits);
+
+      return {
+        periodStart: usage.periodStart,
+        periodEnd: usage.periodEnd,
+        usedCredits,
+        grantedCredits,
+        rolloverCredits,
+        totalGrantedCredits,
+        remainingCredits: totalGrantedCredits - usedCredits,
+      };
+    } catch (error) {
+      this.logger.warn(
+        `Failed to compute credit usage for workspace ${workspaceId}: ${
+          error instanceof Error ? error.message : String(error)
+        }`,
+      );
+
+      return null;
+    }
+  }
 }