feat(billing): refactor promo code handling and update payment data structure

Author: Dobrunia

src/billing/cloudpayments.ts

@@ -162,16 +162,21 @@ export default class CloudPaymentsWebhooks {
 
     const recurrentPaymentSettings = data.cloudPayments?.recurrent;
 
-    if (data.promoCodeValue && !data.isCardLinkOperation) {
+    if (data.promo && !data.isCardLinkOperation) {
       try {
         const promoCodeService = new PromoCodeService(context.factories);
-        const promoPricing = await promoCodeService.getPricingForPlan(data.promoCodeValue, data.userId, data.workspaceId, plan);
+        const promoPricing = await promoCodeService.getPricingForPromoCodeId(
+          data.promo.id,
+          data.userId,
+          data.workspaceId,
+          plan
+        );
 
         if (
-          promoPricing.promoCode._id.toString() !== data.promoCodeId ||
-          promoPricing.finalAmount !== data.finalAmount ||
-          promoPricing.originalAmount !== data.originalAmount ||
-          promoPricing.discountAmount !== data.discountAmount
+          promoPricing.benefitType !== data.promo.benefitType ||
+          promoPricing.finalAmount !== data.promo.finalAmount ||
+          promoPricing.originalAmount !== data.promo.originalAmount ||
+          promoPricing.discountAmount !== data.promo.discountAmount
         ) {
           this.sendError(res, CheckCodes.WRONG_AMOUNT, '[Billing / Check] Promo code payment data does not match current promo calculation', body);
 
@@ -190,8 +195,8 @@ export default class CloudPaymentsWebhooks {
      * The amount will be considered correct if it is equal to the cost of the tariff plan.
      * Also, the cost will be correct if it is a payment to activate the subscription.
      */
-    const expectedAmount = data.finalAmount ?? plan.monthlyCharge;
-    const isRightAmount = +body.Amount === expectedAmount || (!data.finalAmount && recurrentPaymentSettings?.startDate);
+    const expectedAmount = data.promo?.finalAmount ?? plan.monthlyCharge;
+    const isRightAmount = +body.Amount === expectedAmount || (!data.promo?.finalAmount && recurrentPaymentSettings?.startDate);
 
     if (!isRightAmount) {
       this.sendError(res, CheckCodes.WRONG_AMOUNT, `[Billing / Check] Amount does not equal to plan monthly charge`, body);
@@ -322,20 +327,25 @@ export default class CloudPaymentsWebhooks {
         await workspace.setSubscriptionId(subscriptionId);
       }
 
-      if (data.promoCodeValue && !data.isCardLinkOperation && data.benefitType) {
+      if (data.promo && !data.isCardLinkOperation) {
         const promoCodeService = new PromoCodeService(req.context.factories);
-        const promoCode = await promoCodeService.getValidPromoCode(data.promoCodeValue, data.userId, data.workspaceId);
+        const promoPricing = await promoCodeService.getPricingForPromoCodeId(
+          data.promo.id,
+          data.userId,
+          data.workspaceId,
+          tariffPlan
+        );
 
         await promoCodeService.createUsage({
-          promoCode,
+          promoCode: promoPricing.promoCode,
           userId: data.userId,
           workspaceId: workspace._id,
           planId: tariffPlan._id,
-          benefitType: data.benefitType,
-          originalAmount: data.originalAmount,
-          finalAmount: data.finalAmount,
-          discountAmount: data.discountAmount,
-          utm: data.promoUtm,
+          benefitType: data.promo.benefitType,
+          originalAmount: data.promo.originalAmount,
+          finalAmount: data.promo.finalAmount,
+          discountAmount: data.promo.discountAmount,
+          utm: data.promo.utm,
         });
       }
     } catch (e) {
@@ -485,7 +495,7 @@ plan monthly charge: ${data.cloudPayments?.recurrent.amount} ${body.Currency}`
          */
         const userEmail = body.IssuerBankCountry === RUSSIA_ISO_CODE ? user.email : undefined;
 
-        await this.sendReceipt(workspace, tariffPlan, userEmail, data.finalAmount ?? tariffPlan.monthlyCharge);
+        await this.sendReceipt(workspace, tariffPlan, userEmail, data.promo?.finalAmount ?? tariffPlan.monthlyCharge);
 
         let messageText = '';
 

src/billing/types/paymentData.ts

@@ -37,55 +37,66 @@ interface CloudPaymentsSettings {
   recurrent: RecurrentPaymentSettings;
 }
 
-export interface PaymentData {
+/**
+ * Promo data attached to payment request
+ */
+export interface PaymentPromoData {
   /**
-   * Data for Cloudpayments needs
+   * Applied promo code id
    */
-  cloudPayments?: CloudPaymentsSettings;
+  id: string;
+
   /**
-   * Workspace Identifier
+   * Promo benefit type
    */
-  workspaceId: string;
+  benefitType: 'percent_discount' | 'amount_discount' | 'fixed_price';
+
   /**
-   * Id of the user making the payment
+   * Plan price before promo
    */
-  userId: string;
+  originalAmount: number;
+
   /**
-   * Workspace current plan id or plan id to change
+   * Final price after promo
    */
-  tariffPlanId: string;
+  finalAmount: number;
+
   /**
-   * If true, we will save user card
+   * Actual discount amount
    */
-  shouldSaveCard: boolean;
+  discountAmount: number;
+
   /**
-   * Applied promo code id
+   * UTM parameters captured when promo was applied
    */
-  promoCodeId?: string;
+  utm?: Utm;
+}
+
+export interface PaymentData {
   /**
-   * Applied promo code value
+   * Data for Cloudpayments needs
    */
-  promoCodeValue?: string;
+  cloudPayments?: CloudPaymentsSettings;
   /**
-   * Promo benefit type
+   * Workspace Identifier
    */
-  benefitType?: 'grant_plan' | 'percent_discount' | 'amount_discount' | 'fixed_price';
+  workspaceId: string;
   /**
-   * Plan price before promo
+   * Id of the user making the payment
    */
-  originalAmount?: number;
+  userId: string;
   /**
-   * Final price after promo
+   * Workspace current plan id or plan id to change
    */
-  finalAmount?: number;
+  tariffPlanId: string;
   /**
-   * Actual discount amount
+   * If true, we will save user card
    */
-  discountAmount?: number;
+  shouldSaveCard: boolean;
   /**
-   * UTM parameters captured when promo was applied
+   * Applied promo code data
    */
-  promoUtm?: Utm;
+  promo?: PaymentPromoData;
   /**
    * True if this is card linking operation – charging minimal amount of money to validate card info
    */

src/resolvers/billingNew.ts

@@ -12,7 +12,7 @@ import { UserInputError } from 'apollo-server-express';
 import cloudPaymentsApi, { CloudPaymentsJsonData } from '../utils/cloudPaymentsApi';
 import * as telegram from '../utils/telegram';
 import { TelegramBotURLs } from '../utils/telegram';
-import PromoCodeService, { PromoCodeError, PromoCodeErrorCode, PromoCodePreviewResult } from '../utils/promoCodeService';
+import PromoCodeService, { PromoCodeError, PromoCodeErrorCode, PromoCodePreviewResult, buildPaymentPromoData } from '../utils/promoCodeService';
 import { publish } from '../rabbitmq';
 import type { Utm } from '@hawk.so/types';
 import { validateUtmParams } from '../utils/utm/utm';
@@ -117,10 +117,13 @@ export default {
       checksum: string;
       nextPaymentDate: Date;
       cloudPaymentsPublicId: string;
-      promoCode?: string;
-      originalAmount?: number;
-      finalAmount?: number;
-      discountAmount?: number;
+      promo?: {
+        id: string;
+        benefitType: 'percent_discount' | 'amount_discount' | 'fixed_price';
+        originalAmount: number;
+        finalAmount: number;
+        discountAmount: number;
+      };
     }> {
       const { workspaceId, tariffPlanId, shouldSaveCard, promoCode } = input;
       const promoUtm = validateUtmParams(input.promoUtm);
@@ -162,23 +165,15 @@ export default {
       }
 
       let paymentAmount = plan.monthlyCharge;
-      let promoPaymentData;
+      let paymentPromo;
 
       if (promoCode && !isCardLinkOperation) {
         try {
           const promoCodeService = new PromoCodeService(factories);
           const pricing = await promoCodeService.getPricingForPlan(promoCode, user.id, workspace._id.toString(), plan);
 
           paymentAmount = pricing.finalAmount;
-          promoPaymentData = {
-            promoCodeId: pricing.promoCode._id.toString(),
-            promoCodeValue: pricing.promoCode.value,
-            benefitType: pricing.benefitType,
-            originalAmount: pricing.originalAmount,
-            finalAmount: pricing.finalAmount,
-            discountAmount: pricing.discountAmount,
-            ...(promoUtm && Object.keys(promoUtm).length > 0 ? { promoUtm } : {}),
-          };
+          paymentPromo = buildPaymentPromoData(pricing, promoUtm);
         } catch (error) {
           throwPromoCodeGraphQLError(error);
         }
@@ -207,7 +202,7 @@ export default {
           tariffPlanId: plan._id.toString(),
           shouldSaveCard: Boolean(shouldSaveCard),
           nextPaymentDate: nextPaymentDate.toISOString(),
-          ...promoPaymentData,
+          ...(paymentPromo ? { promo: paymentPromo } : {}),
         };
 
       const checksum = await checksumService.generateChecksum(checksumData);
@@ -239,10 +234,7 @@ debug: ${Boolean(workspace.isDebug)}`
         checksum,
         nextPaymentDate,
         cloudPaymentsPublicId: process.env.CLOUDPAYMENTS_PUBLIC_ID || '',
-        promoCode: promoPaymentData?.promoCodeValue,
-        originalAmount: promoPaymentData?.originalAmount,
-        finalAmount: promoPaymentData?.finalAmount,
-        discountAmount: promoPaymentData?.discountAmount,
+        promo: paymentPromo,
       };
     },
   },
@@ -394,7 +386,7 @@ debug: ${Boolean(workspace.isDebug)}`
         throw new UserInputError('Wrong checksum data');
       }
 
-      const planPaymentAmount = paymentData.finalAmount ?? plan.monthlyCharge;
+      const planPaymentAmount = paymentData.promo?.finalAmount ?? plan.monthlyCharge;
 
       const token = fullUserInfo.bankCards?.find(card => card.id === args.input.cardId)?.token;
 

src/typeDefs/billing.ts

@@ -342,6 +342,36 @@ type PreviewPromoCodeResponse {
   plans: [PromoCodePlanPrice!]!
 }
 
+"""
+Promo data returned with composePayment
+"""
+type ComposePaymentPromo {
+  """
+  Applied promo code id
+  """
+  id: ID!
+
+  """
+  Promo benefit type
+  """
+  benefitType: PromoCodeBenefitType!
+
+  """
+  Plan price before promo
+  """
+  originalAmount: Int!
+
+  """
+  Plan price after promo
+  """
+  finalAmount: Int!
+
+  """
+  Actual discount amount in money
+  """
+  discountAmount: Int!
+}
+
 """
 Response of composePayment query
 """
@@ -382,24 +412,9 @@ type ComposePaymentResponse {
   cloudPaymentsPublicId: String!
 
   """
-  Applied promo code value
-  """
-  promoCode: String
-
-  """
-  Plan price before promo
-  """
-  originalAmount: Int
-
-  """
-  Plan price after promo
-  """
-  finalAmount: Int
-
-  """
-  Actual discount amount in money
+  Applied promo code data
   """
-  discountAmount: Int
+  promo: ComposePaymentPromo
 }
 
 

src/utils/checksumService.ts

@@ -1,5 +1,5 @@
 import jwt, { Secret } from 'jsonwebtoken';
-import type { Utm } from '@hawk.so/types';
+import type { PaymentPromoData } from '../billing/types/paymentData';
 
 export type ChecksumData = PlanPurchaseChecksumData | CardLinkChecksumData;
 
@@ -25,33 +25,9 @@ interface PlanPurchaseChecksumData {
    */
   nextPaymentDate: string;
   /**
-   * Applied promo code id
+   * Applied promo code data
    */
-  promoCodeId?: string;
-  /**
-   * Applied promo code value
-   */
-  promoCodeValue?: string;
-  /**
-   * Promo benefit type
-   */
-  benefitType?: 'grant_plan' | 'percent_discount' | 'amount_discount' | 'fixed_price';
-  /**
-   * Plan price before promo
-   */
-  originalAmount?: number;
-  /**
-   * Final price after promo
-   */
-  finalAmount?: number;
-  /**
-   * Actual discount amount
-   */
-  discountAmount?: number;
-  /**
-   * UTM parameters captured when promo was applied
-   */
-  promoUtm?: Utm;
+  promo?: PaymentPromoData;
 }
 
 interface CardLinkChecksumData {
@@ -112,13 +88,7 @@ class ChecksumService {
         tariffPlanId: payload.tariffPlanId,
         shouldSaveCard: payload.shouldSaveCard,
         nextPaymentDate: payload.nextPaymentDate,
-        promoCodeId: payload.promoCodeId,
-        promoCodeValue: payload.promoCodeValue,
-        benefitType: payload.benefitType,
-        originalAmount: payload.originalAmount,
-        finalAmount: payload.finalAmount,
-        discountAmount: payload.discountAmount,
-        promoUtm: payload.promoUtm,
+        promo: payload.promo,
       };
     }
   }