The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
Use yearly billing period bounds and recompute usage on yearly-to-monthly switch
Kiran K4b3cc63311a6
diff --git a/apps/web/app/(ee)/api/stripe/webhook/checkout-session-completed.ts b/apps/web/app/(ee)/api/stripe/webhook/checkout-session-completed.tsindex 0858be9a83..9570016b04 100644--- a/apps/web/app/(ee)/api/stripe/webhook/checkout-session-completed.ts+++ b/apps/web/app/(ee)/api/stripe/webhook/checkout-session-completed.ts@@ -6,6 +6,7 @@ import { tokenCache } from "@/lib/auth/token-cache";import { wouldGainPartnerAccess } from "@/lib/plans/has-partner-access";import { prisma } from "@/lib/prisma";import { stripe } from "@/lib/stripe";+import { getSubscriptionBillingFields } from "@/lib/stripe/workspace-subscription-fields";import { redis } from "@/lib/upstash";import { sendBatchEmail } from "@dub/email";import TrialStartedEmail from "@dub/email/templates/trial/trial-started";@@ -100,6 +101,7 @@ export async function checkoutSessionCompleted(trialEndsAt,paymentFailedAt: null,...(planPeriod !== undefined && { planPeriod }),+ ...getSubscriptionBillingFields(subscription),},include: {users: {diff --git a/apps/web/app/(ee)/api/stripe/webhook/utils/update-workspace-plan.ts b/apps/web/app/(ee)/api/stripe/webhook/utils/update-workspace-plan.tsindex fb169c33e7..2acd9093c7 100644--- a/apps/web/app/(ee)/api/stripe/webhook/utils/update-workspace-plan.ts+++ b/apps/web/app/(ee)/api/stripe/webhook/utils/update-workspace-plan.ts@@ -1,3 +1,4 @@+import { recomputeWorkspaceUsage } from "@/lib/api/billing/recompute-workspace-usage";import { pauseOrCancelCampaignsForProgramOnPlanDowngrade } from "@/lib/api/campaigns/pause-campaigns-on-plan-downgrade";import { deleteWorkspaceFolders } from "@/lib/api/folders/delete-workspace-folders";import { stripAdvancedRewardModifiersForProgram } from "@/lib/api/partners/strip-advanced-reward-modifiers";@@ -13,14 +14,18 @@ import {import { wouldLoseAdvancedFeatures } from "@/lib/plans/would-lose-advanced-features";import { prisma } from "@/lib/prisma";import {- getSubscriptionCancellationFields,+ getSubscriptionBillingFields,getSubscriptionTrialEndsAt,} from "@/lib/stripe/workspace-subscription-fields";import { WorkspaceProps } from "@/lib/types";import { sendBatchEmail } from "@dub/email";import AdvancedPlanDowngradeNotice from "@dub/email/templates/advanced-plan-downgrade-notice";import UpgradeEmail from "@dub/email/templates/upgrade-email";-import { getPlanAndTierFromPriceId, NEW_BUSINESS_PRICE_IDS } from "@dub/utils";+import {+ getBillingStartDate,+ getPlanAndTierFromPriceId,+ NEW_BUSINESS_PRICE_IDS,+} from "@dub/utils";import type Stripe from "stripe";import { getPlanPeriodFromStripeSubscription } from "./get-plan-period-from-stripe-subscription";import { getWorkspaceLimitsFromStripeSubscription } from "./get-workspace-limits-from-stripe-subscription";@@ -41,6 +46,7 @@ export async function updateWorkspacePlan({| "trialEndsAt"| "billingCycleEndsAt"| "subscriptionCanceledAt"+ | "billingCycleStart"| "partnersLimit"> & {plan: string;@@ -64,7 +70,7 @@ export async function updateWorkspacePlan({const trialEndsAt = getSubscriptionTrialEndsAt(subscription);const isPaidPlanActivated =workspace.trialEndsAt !== null && trialEndsAt === null;- const cancellationFields = getSubscriptionCancellationFields(subscription);+ const cancellationFields = getSubscriptionBillingFields(subscription);const planPeriod = getPlanPeriodFromStripeSubscription(subscription);const limits = getWorkspaceLimitsFromStripeSubscription({@@ -72,6 +78,16 @@ export async function updateWorkspacePlan({subscription,});+ const isYearlyToMonthly =+ workspace.planPeriod === "yearly" && planPeriod === "monthly";++ const recomputedUsage = isYearlyToMonthly+ ? await recomputeWorkspaceUsage({+ workspaceId: workspace.id,+ billingStart: getBillingStartDate(workspace.billingCycleStart),+ })+ : null;+const datetimeFieldsUpdated =workspace.billingCycleEndsAt?.getTime() !==cancellationFields.billingCycleEndsAt?.getTime() ||@@ -119,6 +135,23 @@ export async function updateWorkspacePlan({...(trialEndsAt !== undefined && { trialEndsAt }),...cancellationFields,...(planPeriod !== undefined && { planPeriod }),+ ...(recomputedUsage && {+ usage: recomputedUsage.usage,+ linksUsage: recomputedUsage.linksUsage,+ payoutsUsage: recomputedUsage.payoutsUsage,+ sentEmails: {+ deleteMany: {+ type: {+ in: [+ "firstUsageLimitEmail",+ "secondUsageLimitEmail",+ "firstLinksLimitEmail",+ "secondLinksLimitEmail",+ ],+ },+ },+ },+ }),},include: {users: {diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/settings/billing/plan-usage.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/settings/billing/plan-usage.tsxindex ad11abd9be..8366a182c4 100644--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/settings/billing/plan-usage.tsx+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/settings/billing/plan-usage.tsx@@ -34,7 +34,7 @@ import {import {capitalize,cn,- getFirstAndLastDay,+ getBillingPeriodBounds,INFINITY_NUMBER,isLegacyBusinessPlan,isWorkspaceBillingTrialActive,@@ -73,6 +73,7 @@ export default function PlanUsage() {tagsLimit,usersLimit,billingCycleStart,+ planPeriod,trialEndsAt,subscriptionCanceledAt,billingCycleEndsAt,@@ -92,23 +93,32 @@ export default function PlanUsage() {const { groupsCount } = useGroupsCount();- const [billingStart, billingEnd] = useMemo(() => {+ const [billingStart, billingEnd, billingPeriodLabel] = useMemo(() => {if (billingCycleStart) {- const { firstDay, lastDay } = getFirstAndLastDay(billingCycleStart);- const start = firstDay.toLocaleDateString("en-us", {+ const { start, displayEnd } = getBillingPeriodBounds({+ planPeriod,+ billingCycleStart,+ billingCycleEndsAt,+ });+ const startFormatted = start.toLocaleDateString("en-us", {month: "short",day: "numeric",year: "numeric",});- const end = lastDay.toLocaleDateString("en-us", {+ const endFormatted = displayEnd.toLocaleDateString("en-us", {month: "short",day: "numeric",year: "numeric",});- return [start, end];+ const label =+ planPeriod === "yearly" && billingCycleEndsAt+ ? "Current billing period"+ : "Current billing cycle";++ return [startFormatted, endFormatted, label];}return [];- }, [billingCycleStart]);+ }, [billingCycleStart, planPeriod, billingCycleEndsAt]);const usageTabs = useMemo(() => {const tabs = [@@ -275,7 +285,7 @@ export default function PlanUsage() {{billingStart && billingEnd && (<p className="mt-1.5 text-balance text-sm font-medium leading-normal text-neutral-700"><>- Current billing cycle:{" "}+ {billingPeriodLabel}:{" "}<span className="font-normal">{billingStart} - {billingEnd}</span>diff --git a/apps/web/lib/api/billing/recompute-workspace-usage.ts b/apps/web/lib/api/billing/recompute-workspace-usage.tsnew file mode 100644index 0000000000..8c2b0500f4--- /dev/null+++ b/apps/web/lib/api/billing/recompute-workspace-usage.ts@@ -0,0 +1,59 @@+import { getAnalytics } from "@/lib/analytics/get-analytics";+import { prisma } from "@/lib/prisma";+import { analyticsResponse } from "@/lib/zod/schemas/analytics-response";++export async function recomputeWorkspaceUsage({+ workspaceId,+ billingStart,+ billingEnd = new Date(),+ dataAvailableFrom,+}: {+ workspaceId: string;+ billingStart: Date;+ billingEnd?: Date;+ dataAvailableFrom?: Date;+}) {+ const [clicksResponse, linksUsage, payoutsUsage] = await Promise.all([+ getAnalytics({+ workspaceId,+ event: "clicks",+ groupBy: "count",+ start: billingStart,+ end: billingEnd,+ dataAvailableFrom,+ }),++ prisma.link.count({+ where: {+ projectId: workspaceId,+ createdAt: {+ gte: billingStart,+ lte: billingEnd,+ },+ },+ }),++ prisma.invoice.aggregate({+ where: {+ workspaceId,+ type: "partnerPayout",+ status: "completed",+ paidAt: {+ gte: billingStart,+ lte: billingEnd,+ },+ },+ _sum: {+ amount: true,+ },+ }),+ ]);++ const { clicks: usage } = analyticsResponse.count.parse(clicksResponse);++ return {+ usage,+ linksUsage,+ payoutsUsage: payoutsUsage._sum.amount ?? 0,+ };+}diff --git a/apps/web/lib/stripe/workspace-subscription-fields.ts b/apps/web/lib/stripe/workspace-subscription-fields.tsindex 1a018de22f..f2a83a20f2 100644--- a/apps/web/lib/stripe/workspace-subscription-fields.ts+++ b/apps/web/lib/stripe/workspace-subscription-fields.ts@@ -21,7 +21,7 @@ export function getSubscriptionTrialEndsAt(* timestamps (`cancel_at`, then `canceled_at`) so the value is stable across webhooks.* `billingCycleEndsAt` uses subscription item `current_period_end` (Basil API).*/-export function getSubscriptionCancellationFields(+export function getSubscriptionBillingFields(subscription?: Pick<Stripe.Subscription,"cancel_at_period_end" | "cancel_at" | "canceled_at" | "items"@@ -36,10 +36,12 @@ export function getSubscriptionCancellationFields(billingCycleEndsAt: null,};}+const cancelAtPeriodEnd = subscription.cancel_at_period_end ?? false;const currentPeriodEnd = subscription.items.data[0]?.current_period_end;const cancelAtUnix =subscription.cancel_at ?? subscription.canceled_at ?? null;+return {subscriptionCanceledAt:cancelAtPeriodEnd && cancelAtUnix != nulldiff --git a/apps/web/lib/swr/use-usage-timeseries.ts b/apps/web/lib/swr/use-usage-timeseries.tsindex 6c87fb7cfc..e0e3d3f6d9 100644--- a/apps/web/lib/swr/use-usage-timeseries.ts+++ b/apps/web/lib/swr/use-usage-timeseries.ts@@ -1,4 +1,4 @@-import { fetcher, getFirstAndLastDay } from "@dub/utils";+import { fetcher, getBillingPeriodBounds } from "@dub/utils";import { endOfDay, startOfDay } from "date-fns";import { useSearchParams } from "next/navigation";import { useMemo } from "react";@@ -9,8 +9,20 @@ import useWorkspace from "./use-workspace";export function useUsageTimeseries({resource: definedResource,}: { resource?: "links" | "events" } = {}) {- const { id: workspaceId, billingCycleStart, totalLinks } = useWorkspace();- const { firstDay, lastDay } = getFirstAndLastDay(billingCycleStart ?? 0);+ const {+ id: workspaceId,+ billingCycleStart,+ billingCycleEndsAt,+ planPeriod,+ totalLinks,+ } = useWorkspace();++ const { start: firstDay, end: lastDay } = getBillingPeriodBounds({+ planPeriod,+ billingCycleStart: billingCycleStart ?? 0,+ billingCycleEndsAt,+ });+const searchParams = useSearchParams();const defaultActiveTab = useMemo(() => {diff --git a/packages/utils/src/functions/datetime/billing-utils.ts b/packages/utils/src/functions/datetime/billing-utils.tsindex 7c54432af9..bf6bd96541 100644--- a/packages/utils/src/functions/datetime/billing-utils.ts+++ b/packages/utils/src/functions/datetime/billing-utils.ts@@ -1,3 +1,39 @@+import { getFirstAndLastDay } from "./get-first-and-last-day";++// Returns the current billing period bounds for usage display.+// Yearly plans use Stripe's period end; monthly plans use billingCycleStart day-of-month.+export function getBillingPeriodBounds({+ planPeriod,+ billingCycleStart,+ billingCycleEndsAt,+}: {+ planPeriod?: string | null;+ billingCycleStart: number;+ billingCycleEndsAt?: Date | string | null;+}): { start: Date; end: Date; displayEnd: Date } {+ if (planPeriod === "yearly" && billingCycleEndsAt) {+ const periodEnd = new Date(billingCycleEndsAt);+ const start = new Date(periodEnd);+ start.setFullYear(start.getFullYear() - 1);+ const now = new Date();+ const end = now < periodEnd ? now : periodEnd;++ return {+ start,+ end,+ displayEnd: periodEnd,+ };+ }++ const { firstDay, lastDay } = getFirstAndLastDay(billingCycleStart);++ return {+ start: firstDay,+ end: lastDay,+ displayEnd: lastDay,+ };+}+// Function to get the last day of the current monthexport const getLastDayOfMonth = () => {const today = new Date();