Files
calendar/apps/web/pages/api/twilio/webhook.ts
T
ead42c1a9c feat: SMS credits for free users (#21245)
* Add credits section to billing

* create seperate router for credits

* add stripe checkout session

* schema changes + code improvements

* rename to creditBalance

* custom quantify input with error message

* add checkout session completed webhook endpoint

* fix typo

* UI fixes

* add payCredits handler

* add error toast message

* allow scheduling sms up as close to 15 minutes in the future

* schedule at most 2 hours in advance

* webhook to pay for sent sms

* continued work on twilio callback

* code clean up

* further implementation for credit handling

* add migration

* object as param for scheduleSMS

* object as param for sendSMS

* fix TrpcSessionUser imports

* fix imports

* add db changes

* add cron job for price setting

* twilio status callback to create expense log

* remove unused code

* set up low credit balance email

* fixes for buying credits

* fixes in api/twilio/webhook

* add test to save credits to credits balance

* fix typos

* add new helper function chargeCredits

* expand twilioProvider

* fix type errors

* adjust tests

* type errors

* clean up

* clean up

* fix subscription active check

* remove some user/org related code

* more changes to remove user/org support

* send emails seperatly to admins

* fixes for team billing page

* fix stripe success url

* fixes to creating expense log

* email imrovements and more

* get monthly team price from stripe

* fix import

* fix monthly credits calculation

* finsih low credit balance warning email

* credit balance limit reached email

* create CreditService

* cancel SMS and send as email instead

* add messageDispatcher

* fix type error

* fix type error

* fix type error

* fix import

* fix unit test

* clean up twilioProvider

* clean up chckSmsPrices/route

* add missing translations

* add skeleton loader

* add admin check to get handler

* code clean up + fixes

* improve scheduling with fallback

* fix type error

* add bookingUid to handleSendingSMS

* add unit tests for creditService

* add more tests to credit-service.test.ts

* add test for cancelScheduledMessagesAndScheduleEmails

* fix test and type error

* add back resolve

* fix empty resolve

* adjust limitReachedAt logic

* address mrge comment on styling

* add getAdminMembership to repository

* twilio/webhook clean up (feedback)

* feedback - clean up

* remove todo comment

* clean up twilio/webhook

* code clean up

* add use client

* add createOneTimeCheckout to stripe service

* refactor repository pattern

* small fixes + clean up

* fix type error

* add missing import

* fix hasAvailableCredits for user

* force-dynamic

* rename credits to creditBalance

* fix stripe import

* remove not needed code

* fix e2e tests

* improve low balance warning email

* dynamic-import CreditService

* index.ts

* add user logic checkSmsPrices endpoint

* fix e2e tests

* remove dynamic import CreditService

* Revert "remove dynamic import CreditService"

This reverts commit e272978a7ff3fc5a04139e656c9f8d2c84a40dda.

* no need to dynamic-import credit service

* Revert "no need to dynamic-import credit service"

This reverts commit ba5ae488d08979a65fb47b5d0722cda9f45d6ea0.

* fix twilio webhook

* add userId support in checkout.session.completed

* clean up code

* only select id in getAdminMembership

* revert billing/package.json

* fix type checks

* fix type checks

* adjust hasAvailableCredits function

* fixes for checkout sessioned completed

* add UI for user

* fix type errors

* adds requires credits badge

* remove team check from update.handler

* clean up inlcude statements

* fix credit-service tests

* add tests

* fix type errors

* fix type errors

* fix and add tests

* imrove badge

* code clean up

* add reminderScheduler test

* add additional credits as title

* fixes for warningSentAt and limitReachedAt

* mock stripe

---------

Co-authored-by: CarinaWolli <wollencarina@gmail.com>
Co-authored-by: hbjORbj <sldisek783@gmail.com>
Co-authored-by: Udit Takkar <53316345+Udit-takkar@users.noreply.github.com>
Co-authored-by: Peer Richelsen <peeroke@gmail.com>
2025-05-13 15:55:19 +02:00

168 lines
4.6 KiB
TypeScript

import type { NextApiRequest, NextApiResponse } from "next";
import { z } from "zod";
import * as twilio from "@calcom/features/ee/workflows/lib/reminders/providers/twilioProvider";
import { IS_SMS_CREDITS_ENABLED, WEBAPP_URL } from "@calcom/lib/constants";
import getOrgIdFromMemberOrTeamId from "@calcom/lib/getOrgIdFromMemberOrTeamId";
import { defaultHandler } from "@calcom/lib/server/defaultHandler";
import prisma from "@calcom/prisma";
const InputSchema = z.object({
userId: z
.string()
.optional()
.transform((val) => {
const num = Number(val);
return isNaN(num) ? undefined : num;
}),
teamId: z
.string()
.optional()
.transform((val) => {
const num = Number(val);
return isNaN(num) ? undefined : num;
}),
bookingUid: z.string().optional(),
});
/*
Twilio status callback: creates expense log when sms is delivered or undelivered
*/
async function handler(req: NextApiRequest, res: NextApiResponse) {
const signature = req.headers["x-twilio-signature"];
const baseUrl = `${WEBAPP_URL}/api/twilio/webhook`;
const queryParams = new URLSearchParams(req.query as Record<string, string>).toString();
const requestUrl = queryParams ? `${baseUrl}?${queryParams}` : baseUrl;
if (typeof signature !== "string") {
return res.status(401).send("Missing Twilio signature");
}
const isSignatureValid = await twilio.validateWebhookRequest({
requestUrl,
signature,
params: req.body,
});
if (!isSignatureValid) {
return res.status(401).send("Invalid Twilio signature");
}
const messageStatus = req.body.MessageStatus;
if (messageStatus !== "delivered" && messageStatus !== "undelivered") {
return res.status(200).send(`SMS not yet delivered/undelivered`);
}
if (!IS_SMS_CREDITS_ENABLED) {
return res.status(200).send(`SMS credits are not enabled.`);
}
const countryCode = await twilio.getCountryCodeForNumber(req.body.To);
const smsSid = req.body.SmsSid;
const {
userId: parsedUserId,
teamId: parsedTeamId,
bookingUid: parsedBookingUid,
} = InputSchema.parse(req.query);
if (!parsedUserId && !parsedTeamId) {
return res.status(401).send("Team or user id is required");
}
const { CreditService } = await import("@calcom/features/ee/billing/credit-service");
const creditService = new CreditService();
if (countryCode === "US" || countryCode === "CA") {
// SMS to US and CA are free on a team plan
let teamIdToCharge = parsedTeamId;
if (!teamIdToCharge && parsedUserId) {
const teamMembership = await prisma.membership.findFirst({
where: {
userId: parsedUserId,
accepted: true,
},
select: {
teamId: true,
},
});
teamIdToCharge = teamMembership?.teamId;
}
await creditService.chargeCredits({
teamId: teamIdToCharge,
userId: !teamIdToCharge ? parsedUserId : undefined,
bookingUid: parsedBookingUid,
smsSid,
credits: 0,
});
return res.status(200).send(`SMS to US and CA are free on a team plan. Credits set to 0`);
}
let orgId;
if (parsedTeamId) {
const team = await prisma.team.findUnique({
where: {
id: parsedTeamId,
},
select: {
isOrganization: true,
id: true,
},
});
orgId = team?.isOrganization ? team.id : undefined;
}
if (!orgId) {
orgId = await getOrgIdFromMemberOrTeamId({
memberId: parsedUserId,
teamId: parsedTeamId,
});
}
if (orgId) {
await creditService.chargeCredits({
teamId: orgId,
bookingUid: parsedBookingUid,
smsSid,
credits: 0,
});
return res.status(200).send(`SMS are free for organizations. Credits set to 0`);
}
const price = await twilio.getPriceForSMS(smsSid);
const credits = price ? creditService.calculateCreditsFromPrice(price) : null;
const chargedUserOrTeamId = await creditService.chargeCredits({
credits,
teamId: parsedTeamId,
userId: parsedUserId,
smsSid,
bookingUid: parsedBookingUid,
});
if (chargedUserOrTeamId) {
return res.status(200).send(
`Expense log with ${credits ? credits : "no"} credits created for
${
chargedUserOrTeamId.teamId
? `teamId ${chargedUserOrTeamId.teamId}`
: `userId ${chargedUserOrTeamId.userId}`
}`
);
}
// this should never happen - even when out of credits we still charge a team
return res.status(500).send("No team or users found to be charged");
}
export default defaultHandler({
POST: Promise.resolve({ default: handler }),
});