⚡ (billing) Automatic usage-based billing (#924)

BREAKING CHANGE: Stripe environment variables simplified. Check out the
new configs to adapt your existing system.

Closes #906





<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
### Summary by CodeRabbit

**New Features:**
- Introduced a usage-based billing system, providing more flexibility
and options for users.
- Integrated with Stripe for a smoother and more secure payment process.
- Enhanced the user interface with improvements to the billing,
workspace, and pricing pages for a more intuitive experience.

**Improvements:**
- Simplified the billing logic, removing additional chats and yearly
billing for a more streamlined user experience.
- Updated email notifications to keep users informed about their usage
and limits.
- Improved pricing and currency formatting for better clarity and
understanding.

**Testing:**
- Updated tests and specifications to ensure the reliability of new
features and improvements.

**Note:** These changes aim to provide a more flexible and user-friendly
billing system, with clearer pricing and improved notifications. Users
should find the new system more intuitive and easier to navigate.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

.github/workflows/send-limit-email-alerts.yml → .github/workflows/check-and-report-chats-usage.yml

@@ -1,4 +1,4 @@
-name: Send chats limit alert emails
+name: Check and report chats usage
 
 on:
   schedule:
@@ -22,8 +22,9 @@ jobs:
       SMTP_HOST: '${{ secrets.SMTP_HOST }}'
       SMTP_PORT: '${{ secrets.SMTP_PORT }}'
       NEXT_PUBLIC_SMTP_FROM: '${{ secrets.NEXT_PUBLIC_SMTP_FROM }}'
+      STRIPE_SECRET_KEY: '${{ secrets.STRIPE_SECRET_KEY }}'
     steps:
       - uses: actions/checkout@v2
       - uses: pnpm/[email protected]
       - run: pnpm i --frozen-lockfile
-      - run: pnpm turbo run sendAlertEmails
+      - run: pnpm turbo run checkAndReportChatsUsage

apps/builder/src/features/billing/api/createCheckoutSession.ts

@@ -4,7 +4,6 @@ import { TRPCError } from '@trpc/server'
 import { Plan } from '@typebot.io/prisma'
 import Stripe from 'stripe'
 import { z } from 'zod'
-import { parseSubscriptionItems } from '../helpers/parseSubscriptionItems'
 import { isAdminWriteWorkspaceForbidden } from '@/features/workspace/helpers/isAdminWriteWorkspaceForbidden'
 import { env } from '@typebot.io/env'
 
@@ -26,14 +25,12 @@ export const createCheckoutSession = authenticatedProcedure
       currency: z.enum(['usd', 'eur']),
       plan: z.enum([Plan.STARTER, Plan.PRO]),
       returnUrl: z.string(),
-      additionalChats: z.number(),
       vat: z
         .object({
           type: z.string(),
           value: z.string(),
         })
         .optional(),
-      isYearly: z.boolean(),
     })
   )
   .output(
@@ -43,17 +40,7 @@ export const createCheckoutSession = authenticatedProcedure
   )
   .mutation(
     async ({
-      input: {
-        vat,
-        email,
-        company,
-        workspaceId,
-        currency,
-        plan,
-        returnUrl,
-        additionalChats,
-        isYearly,
-      },
+      input: { vat, email, company, workspaceId, currency, plan, returnUrl },
       ctx: { user },
     }) => {
       if (!env.STRIPE_SECRET_KEY)
@@ -116,8 +103,6 @@ export const createCheckoutSession = authenticatedProcedure
         currency,
         plan,
         returnUrl,
-        additionalChats,
-        isYearly,
       })
 
       if (!checkoutUrl)
@@ -138,22 +123,12 @@ type Props = {
   currency: 'usd' | 'eur'
   plan: 'STARTER' | 'PRO'
   returnUrl: string
-  additionalChats: number
-  isYearly: boolean
   userId: string
 }
 
 export const createCheckoutSessionUrl =
   (stripe: Stripe) =>
-  async ({
-    customerId,
-    workspaceId,
-    currency,
-    plan,
-    returnUrl,
-    additionalChats,
-    isYearly,
-  }: Props) => {
+  async ({ customerId, workspaceId, currency, plan, returnUrl }: Props) => {
     const session = await stripe.checkout.sessions.create({
       success_url: `${returnUrl}?stripe=${plan}&success=true`,
       cancel_url: `${returnUrl}?stripe=cancel`,
@@ -167,12 +142,25 @@ export const createCheckoutSessionUrl =
       metadata: {
         workspaceId,
         plan,
-        additionalChats,
       },
       currency,
       billing_address_collection: 'required',
       automatic_tax: { enabled: true },
-      line_items: parseSubscriptionItems(plan, additionalChats, isYearly),
+      line_items: [
+        {
+          price:
+            plan === 'STARTER'
+              ? env.STRIPE_STARTER_PRICE_ID
+              : env.STRIPE_PRO_PRICE_ID,
+          quantity: 1,
+        },
+        {
+          price:
+            plan === 'STARTER'
+              ? env.STRIPE_STARTER_CHATS_PRICE_ID
+              : env.STRIPE_PRO_CHATS_PRICE_ID,
+        },
+      ],
     })
 
     return session.url

apps/builder/src/features/billing/api/getSubscription.ts

@@ -5,7 +5,6 @@ import Stripe from 'stripe'
 import { z } from 'zod'
 import { subscriptionSchema } from '@typebot.io/schemas/features/billing/subscription'
 import { isReadWorkspaceFobidden } from '@/features/workspace/helpers/isReadWorkspaceFobidden'
-import { priceIds } from '@typebot.io/lib/api/pricing'
 import { env } from '@typebot.io/env'
 
 export const getSubscription = authenticatedProcedure
@@ -75,24 +74,18 @@ export const getSubscription = authenticatedProcedure
 
     return {
       subscription: {
+        currentBillingPeriod:
+          subscriptionSchema.shape.currentBillingPeriod.parse({
+            start: new Date(currentSubscription.current_period_start),
+            end: new Date(currentSubscription.current_period_end),
+          }),
         status: subscriptionSchema.shape.status.parse(
           currentSubscription.status
         ),
-        isYearly: currentSubscription.items.data.some((item) => {
-          return (
-            priceIds.STARTER.chats.yearly === item.price.id ||
-            priceIds.PRO.chats.yearly === item.price.id
-          )
-        }),
         currency: currentSubscription.currency as 'usd' | 'eur',
         cancelDate: currentSubscription.cancel_at
           ? new Date(currentSubscription.cancel_at * 1000)
           : undefined,
       },
     }
   })
-
-export const chatPriceIds = [priceIds.STARTER.chats.monthly]
-  .concat(priceIds.STARTER.chats.yearly)
-  .concat(priceIds.PRO.chats.monthly)
-  .concat(priceIds.PRO.chats.yearly)

apps/builder/src/features/billing/api/getUsage.ts

@@ -3,6 +3,8 @@ import { authenticatedProcedure } from '@/helpers/server/trpc'
 import { TRPCError } from '@trpc/server'
 import { z } from 'zod'
 import { isReadWorkspaceFobidden } from '@/features/workspace/helpers/isReadWorkspaceFobidden'
+import { env } from '@typebot.io/env'
+import Stripe from 'stripe'
 
 export const getUsage = authenticatedProcedure
   .meta({
@@ -19,13 +21,15 @@ export const getUsage = authenticatedProcedure
       workspaceId: z.string(),
     })
   )
-  .output(z.object({ totalChatsUsed: z.number() }))
+  .output(z.object({ totalChatsUsed: z.number(), resetsAt: z.date() }))
   .query(async ({ input: { workspaceId }, ctx: { user } }) => {
     const workspace = await prisma.workspace.findFirst({
       where: {
         id: workspaceId,
       },
       select: {
+        stripeId: true,
+        plan: true,
         members: {
           select: {
             userId: true,
@@ -42,19 +46,63 @@ export const getUsage = authenticatedProcedure
         message: 'Workspace not found',
       })
 
-    const now = new Date()
-    const firstDayOfMonth = new Date(now.getFullYear(), now.getMonth(), 1)
+    if (
+      !env.STRIPE_SECRET_KEY ||
+      !workspace.stripeId ||
+      (workspace.plan !== 'STARTER' && workspace.plan !== 'PRO')
+    ) {
+      const now = new Date()
+      const firstDayOfMonth = new Date(now.getFullYear(), now.getMonth(), 1)
+
+      const totalChatsUsed = await prisma.result.count({
+        where: {
+          typebotId: { in: workspace.typebots.map((typebot) => typebot.id) },
+          hasStarted: true,
+          createdAt: {
+            gte: firstDayOfMonth,
+          },
+        },
+      })
+
+      const firstDayOfNextMonth = new Date(
+        firstDayOfMonth.getFullYear(),
+        firstDayOfMonth.getMonth() + 1,
+        1
+      )
+      return { totalChatsUsed, resetsAt: firstDayOfNextMonth }
+    }
+
+    const stripe = new Stripe(env.STRIPE_SECRET_KEY, {
+      apiVersion: '2022-11-15',
+    })
+
+    const subscriptions = await stripe.subscriptions.list({
+      customer: workspace.stripeId,
+    })
+
+    const currentSubscription = subscriptions.data
+      .filter((sub) => ['past_due', 'active'].includes(sub.status))
+      .sort((a, b) => a.created - b.created)
+      .shift()
+
+    if (!currentSubscription)
+      throw new TRPCError({
+        code: 'INTERNAL_SERVER_ERROR',
+        message: `No subscription found on workspace: ${workspaceId}`,
+      })
+
     const totalChatsUsed = await prisma.result.count({
       where: {
         typebotId: { in: workspace.typebots.map((typebot) => typebot.id) },
         hasStarted: true,
         createdAt: {
-          gte: firstDayOfMonth,
+          gte: new Date(currentSubscription.current_period_start * 1000),
         },
       },
     })
 
     return {
       totalChatsUsed,
+      resetsAt: new Date(currentSubscription.current_period_end * 1000),
     }
   })

apps/builder/src/features/billing/api/listInvoices.ts

@@ -64,12 +64,12 @@ export const listInvoices = authenticatedProcedure
         .filter(
           (invoice) => isDefined(invoice.invoice_pdf) && isDefined(invoice.id)
         )
-        .map((i) => ({
-          id: i.number as string,
-          url: i.invoice_pdf as string,
-          amount: i.subtotal,
-          currency: i.currency,
-          date: i.status_transitions.paid_at,
+        .map((invoice) => ({
+          id: invoice.number as string,
+          url: invoice.invoice_pdf as string,
+          amount: invoice.subtotal,
+          currency: invoice.currency,
+          date: invoice.status_transitions.paid_at,
         })),
     }
   })