Add getStripePortalUrl method to server

Author: Andrew Farries

components/gitpod-protocol/src/gitpod-service.ts

@@ -295,6 +295,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     createOrUpdateStripeCustomerForTeam(teamId: string, currency: string): Promise<void>;
     createOrUpdateStripeCustomerForUser(currency: string): Promise<void>;
     subscribeTeamToStripe(teamId: string, setupIntentId: string): Promise<void>;
+    getStripePortalUrl(attributionId: string): Promise<string>;
     getStripePortalUrlForTeam(teamId: string): Promise<string>;
     getUsageLimitForTeam(teamId: string): Promise<number | undefined>;
     setUsageLimitForTeam(teamId: string, spendingLimit: number): Promise<void>;

components/server/ee/src/user/stripe-service.ts

@@ -130,6 +130,18 @@ export class StripeService {
         return session.url;
     }
 
+    async getPortalUrlForUser(user: User): Promise<string> {
+        const customer = await this.findCustomerByUserId(user.id);
+        if (!customer) {
+            throw new Error(`No Stripe Customer ID found for user '${user.id}'`);
+        }
+        const session = await this.getStripe().billingPortal.sessions.create({
+            customer: customer.id,
+            return_url: this.config.hostUrl.with(() => ({ pathname: `/billing` })).toString(),
+        });
+        return session.url;
+    }
+
     async findUncancelledSubscriptionByCustomer(customerId: string): Promise<Stripe.Subscription | undefined> {
         const result = await this.getStripe().subscriptions.list({
             customer: customerId,

components/server/ee/src/workspace/gitpod-server-impl.ts

@@ -2150,6 +2150,43 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         }
     }
 
+    async getStripePortalUrl(ctx: TraceContext, attributionId: string): Promise<string> {
+        const attrId = AttributionId.parse(attributionId);
+        if (attrId === undefined) {
+            log.error(`Invalid attribution id: ${attributionId}`);
+            throw new ResponseError(ErrorCodes.BAD_REQUEST, `Invalid attibution id: ${attributionId}`);
+        }
+
+        const user = this.checkAndBlockUser("getStripePortalUrl");
+
+        let url: string;
+        if (attrId.kind === "user") {
+            await this.ensureStripeApiIsAllowed({ user });
+            try {
+                url = await this.stripeService.getPortalUrlForUser(user);
+            } catch (error) {
+                log.error(`Failed to get Stripe portal URL for user '${user.id}'`, error);
+                throw new ResponseError(
+                    ErrorCodes.INTERNAL_SERVER_ERROR,
+                    `Failed to get Stripe portal URL for user '${user.id}'`,
+                );
+            }
+        } else {
+            const team = await this.guardTeamOperation(attrId.teamId, "update");
+            await this.ensureStripeApiIsAllowed({ team });
+            try {
+                url = await this.stripeService.getPortalUrlForTeam(team);
+            } catch (error) {
+                log.error(`Failed to get Stripe portal URL for team '${team.id}'`, error);
+                throw new ResponseError(
+                    ErrorCodes.INTERNAL_SERVER_ERROR,
+                    `Failed to get Stripe portal URL for team '${team.id}'`,
+                );
+            }
+        }
+        return url;
+    }
+
     async getStripePortalUrlForTeam(ctx: TraceContext, teamId: string): Promise<string> {
         this.checkAndBlockUser("getStripePortalUrlForTeam");
         const team = await this.guardTeamOperation(teamId, "update");

components/server/src/auth/rate-limiter.ts

@@ -211,6 +211,7 @@ const defaultFunctions: FunctionsConfig = {
     createOrUpdateStripeCustomerForTeam: { group: "default", points: 1 },
     createOrUpdateStripeCustomerForUser: { group: "default", points: 1 },
     subscribeTeamToStripe: { group: "default", points: 1 },
+    getStripePortalUrl: { group: "default", points: 1 },
     getStripePortalUrlForTeam: { group: "default", points: 1 },
     listUsage: { group: "default", points: 1 },
     getBillingModeForTeam: { group: "default", points: 1 },

components/server/src/workspace/gitpod-server-impl.ts

@@ -3236,6 +3236,9 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
     async getStripePortalUrlForTeam(ctx: TraceContext, teamId: string): Promise<string> {
         throw new ResponseError(ErrorCodes.SAAS_FEATURE, `Not implemented in this version`);
     }
+    async getStripePortalUrl(ctx: TraceContext, attributionId: string): Promise<string> {
+        throw new ResponseError(ErrorCodes.SAAS_FEATURE, `Not implemented in this version`);
+    }
 
     async listUsage(ctx: TraceContext, req: ListUsageRequest): Promise<ListUsageResponse> {
         throw new ResponseError(ErrorCodes.SAAS_FEATURE, `Not implemented in this version`);