Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON } from '../../utils';
import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand DownExpand Up@@ -108,7 +108,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
this.amount = data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined;
this.credit =
data.credit && data.credit.amount ? { amount: billingMoneyAmountFromJSON(data.credit.amount) } : undefined;
this.seats = data.seats ? { quantity: data.seats.quantity } : undefined;
this.seats = data.seats
? {
quantity: data.seats.quantity,
...(data.seats.tiers ? { tiers: data.seats.tiers.map(billingPerUnitTotalTierFromJSON) } : {}),
}
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;

Expand Down
16 changes: 11 additions & 5 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,8 @@ import type {
BillingPerPeriodTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingPerUnitTotalTier,
BillingPerUnitTotalTierJSON,
BillingPlanUnitPriceJSON,
BillingStatementTotals,
BillingStatementTotalsJSON,
Expand All@@ -27,15 +29,19 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
};
};

export const billingPerUnitTotalTierFromJSON = (data: BillingPerUnitTotalTierJSON): BillingPerUnitTotalTier => {
return {
quantity: data.quantity,
feePerBlock: billingMoneyAmountFromJSON(data.fee_per_block),
total: billingMoneyAmountFromJSON(data.total),
};
};

const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] => {
return data.map(unitTotal => ({
name: unitTotal.name,
blockSize: unitTotal.block_size,
tiers: unitTotal.tiers.map(tier => ({
quantity: tier.quantity,
feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
total: billingMoneyAmountFromJSON(tier.total),
})),
tiers: unitTotal.tiers.map(billingPerUnitTotalTierFromJSON),
}));
};

Expand Down
7 changes: 7 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export const enUS: LocalizationResource = {
annually: 'Annually',
availableFeatures: 'Available features',
billedAnnually: 'Billed annually',
billedMonthly: 'Billed monthly',
billedMonthlyOnly: 'Only billed monthly',
billedAnnuallyOnly: 'Only billed annually',
cancelFreeTrial: 'Cancel free trial',
Expand DownExpand Up@@ -521,6 +522,11 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
includedSeatsUsage: '{{includedSeats}} seats included',
overview: 'Overview',
paidSeatsUsage: '{{seatsQuantity}} seats x {{amount}}',
seatLimit: 'Up to {{seatLimit}} seats',
seatLimitAndIncludedSeats: 'Up to {{seatLimit}} seats ({{includedSeats}} included)',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand DownExpand Up@@ -1364,6 +1370,7 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
overview: 'Overview',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -233,6 +233,7 @@ export interface BillingSubscriptionItemSeats {
* The seat limit active while the parent subscription item was active. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTier[];
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -609,6 +609,7 @@ export interface BillingSubscriptionItemSeatsJSON {
* The number of seats available. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTierJSON[];
}

/**
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,7 @@ export type __internal_LocalizationResource = {
switchToMonthlyWithPrice: LocalizationValue<'price' | 'currency'>;
switchToAnnualWithAnnualPrice: LocalizationValue<'price' | 'currency'>;
billedAnnually: LocalizationValue;
billedMonthly: LocalizationValue;
billedMonthlyOnly: LocalizationValue;
billedAnnuallyOnly: LocalizationValue;
cancelFreeTrial: LocalizationValue<'plan'>;
Expand DownExpand Up@@ -963,6 +964,7 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
overview: LocalizationValue;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand DownExpand Up@@ -1204,6 +1206,11 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
includedSeatsUsage: LocalizationValue<'includedSeats'>;
overview: LocalizationValue;
paidSeatsUsage: LocalizationValue<'seatsQuantity' | 'amount'>;
seatLimit: LocalizationValue<'seatLimit'>;
seatLimitAndIncludedSeats: LocalizationValue<'seatLimit' | 'includedSeats'>;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand Down
137 changes: 125 additions & 12 deletions packages/ui/src/components/Subscriptions/SubscriptionsList.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import type { BillingPlanResource, BillingSubscriptionItemResource } from '@clerk/shared/types';
import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionResource,
} from '@clerk/shared/types';
import { Fragment, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { ProfileSection } from '@/ui/elements/Section';
import { common } from '@/ui/styledSystem';
import { getIncludedSeatsUnitTier, getPlanSeatLimit, getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';

import {
normalizeFormatted,
Expand All@@ -14,7 +19,21 @@ import {
useSubscription,
} from '../../contexts';
import type { LocalizationKey } from '../../customizables';
import { Col, Flex, Icon, localizationKeys, Span, Table, Tbody, Td, Text, Th, Thead, Tr } from '../../customizables';
import {
Col,
Flex,
Icon,
localizationKeys,
Span,
Table,
Tbody,
Td,
Text,
Th,
Thead,
Tr,
useLocalizations,
} from '../../customizables';
import { ArrowsUpDown, CogFilled, Plans, Plus, Users } from '../../icons';
import { useRouter } from '../../router';
import { SubscriptionBadge } from './badge';
Expand All@@ -34,7 +53,7 @@ export function SubscriptionsList({
}) {
const localizationRoot = useSubscriberTypeLocalizationRoot();
const subscriberType = useSubscriberTypeContext();
const { subscriptionItems } = useSubscription();
const { subscriptionItems, data: subscription } = useSubscription();
const canManageBilling =
useProtect(has => has({ permission: 'org:sys_billing:manage' })) || subscriberType === 'user';
const { navigate } = useRouter();
Expand DownExpand Up@@ -113,6 +132,12 @@ export function SubscriptionsList({
length={sortedSubscriptionItems.length}
/>
))}
{subscription?.nextPayment ? (
<SubscriptionOverviewRow
nextPayment={subscription.nextPayment}
localizationRoot={localizationRoot}
/>
) : null}
</Tbody>
</Table>
)}
Expand DownExpand Up@@ -164,6 +189,56 @@ export function SubscriptionsList({
);
}

function SubscriptionOverviewRow({
nextPayment,
localizationRoot,
}: {
nextPayment: NonNullable<BillingSubscriptionResource['nextPayment']>;
localizationRoot: ReturnType<typeof useSubscriberTypeLocalizationRoot>;
}) {
return (
<Tr
sx={t => ({
background: common.mutedBackground(t),
})}
>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Text
variant='subtitle'
localizationKey={localizationKeys(`${localizationRoot}.billingPage.subscriptionsListSection.overview`)}
/>
</Td>
<Td
sx={_ => ({
textAlign: 'end',
})}
>
<Col
gap={1}
align='end'
>
<Text
variant='h2'
sx={t => ({
color: t.colors.$colorForeground,
})}
>
{nextPayment.amount.currencySymbol}
{nextPayment.amount.amountFormatted}

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will be updated to next_payment.totals.grand_total once #8739 is merged

</Text>
<Text
variant='subtitle'
colorScheme='secondary'
localizationKey={localizationKeys('badge__renewsAt', {
date: nextPayment.date,
})}
/>
</Col>
</Td>
</Tr>
);
}

function SubscriptionItemRow({
subscriptionItem,
length,
Expand All@@ -174,12 +249,37 @@ function SubscriptionItemRow({
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const fee = subscriptionItem.planPeriod === 'annual' ? subscriptionItem.plan.annualFee! : subscriptionItem.plan.fee!;
const { captionForSubscription } = usePlansContext();
const { t } = useLocalizations();

const feeFormatted = useMemo(() => {
return normalizeFormatted(fee.amountFormatted);
}, [fee.amountFormatted]);

const subItemSeatsQty = subscriptionItem.seats?.quantity;
const seatUnitPrice = getSeatUnitPrice(subscriptionItem.plan);
const includedSeatsUnitTier = getIncludedSeatsUnitTier(seatUnitPrice);
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);
const includedSeats =
includedSeatsUnitTier?.endsAfterBlock != null && seatUnitPrice
? includedSeatsUnitTier.endsAfterBlock * seatUnitPrice.blockSize
: null;
const seatsTotalTier = subscriptionItem.seats?.tiers?.find(t => t.total.amount > 0);
const monthLabel = t(localizationKeys('billing.month')).toLowerCase();
const seatLimitAndIncludedSeatsLocalizationKey =

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this conditional is very hard to scan

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's so bad :/ any suggestions? It's just picking a specific localization key, so doesn't feel weighty enough to extract to a separate component.

typeof planSeatLimit === 'number' && includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimitAndIncludedSeats', {
seatLimit: planSeatLimit,
includedSeats,
})
: typeof planSeatLimit === 'number'
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimit', {
seatLimit: planSeatLimit,
})
: includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.includedSeatsUsage', {
includedSeats,
})
: null;

return (
<Fragment key={subscriptionItem.id}>
Expand DownExpand Up@@ -272,7 +372,7 @@ function SubscriptionItemRow({
return {};
}}
>
<Td>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Col gap={1}>
<Flex
align='center'
Expand DownExpand Up@@ -300,14 +400,27 @@ function SubscriptionItemRow({
textAlign: 'end',
})}
>
<Text
variant='subtitle'
localizationKey={
subItemSeatsQty === null
? localizationKeys('billing.pricingTable.seatCost.unlimitedSeats')
: localizationKeys('billing.pricingTable.seatCost.upToSeats', { endsAfterBlock: subItemSeatsQty })
}
/>
<Col
gap={1}
align='end'
>
{seatLimitAndIncludedSeatsLocalizationKey ? (
<Text
variant='subtitle'
localizationKey={seatLimitAndIncludedSeatsLocalizationKey}
/>
) : null}
{seatsTotalTier && seatsTotalTier.quantity ? (
<Text variant='subtitle'>
{t(
localizationKeys('organizationProfile.billingPage.subscriptionsListSection.paidSeatsUsage', {
seatsQuantity: seatsTotalTier.quantity,
amount: `${seatsTotalTier.feePerBlock.currencySymbol}${seatsTotalTier.feePerBlock.amountFormatted} / ${monthLabel}`,
}),
)}
</Text>
) : null}
</Col>
</Td>
</Tr>
) : null}
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/contexts/components/SubscriberType.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ export const SubscriberTypeContext = createContext<ForPayerType | undefined>(DEF

export const useSubscriberTypeContext = (): ForPayerType => useContext(SubscriberTypeContext) || DEFAUlT;

export const useSubscriberTypeLocalizationRoot = () => {
export const useSubscriberTypeLocalizationRoot = (): 'userProfile' | 'organizationProfile' => {
const subscriberType = useSubscriberTypeContext();
return subscriberType === 'user' ? 'userProfile' : 'organizationProfile';
};
44 changes: 44 additions & 0 deletions packages/ui/src/utils/__tests__/billingPlanSeats.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
import { describe, expect, test } from 'vitest';

import {
getIncludedSeatsUnitTier,
getPaidSeatsUnitTier,
getSeatsPerUnitTotal,
organizationAndInvitationsExceedsPurchasedSeats,
Expand DownExpand Up@@ -160,6 +161,49 @@ describe('getPaidSeatsUnitTier', () => {
});
});

describe('getIncludedSeatsUnitTier', () => {
test('returns the included tier from a seats unit price with included seats', () => {
const includedTier = {
id: 'tier_included',
startsAtBlock: 1,
endsAfterBlock: 3,
feePerBlock: money(0),
};
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
includedTier,
{
id: 'tier_paid',
startsAtBlock: 4,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBe(includedTier);
});

test('returns null for paid-only seats unit prices', () => {
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_paid',
startsAtBlock: 1,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBeNull();
});
});

describe('organizationAndInvitationsExceedsPurchasedSeats', () => {
test('returns true when members, pending invitations, and invitations exceed seats entitlements', () => {
const subscriptionItem = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON } from '../../utils';
import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand DownExpand Up@@ -108,7 +108,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
this.amount = data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined;
this.credit =
data.credit && data.credit.amount ? { amount: billingMoneyAmountFromJSON(data.credit.amount) } : undefined;
this.seats = data.seats ? { quantity: data.seats.quantity } : undefined;
this.seats = data.seats
? {
quantity: data.seats.quantity,
...(data.seats.tiers ? { tiers: data.seats.tiers.map(billingPerUnitTotalTierFromJSON) } : {}),
}
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;

Expand Down
16 changes: 11 additions & 5 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,8 @@ import type {
BillingPerPeriodTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingPerUnitTotalTier,
BillingPerUnitTotalTierJSON,
BillingPlanUnitPriceJSON,
BillingStatementTotals,
BillingStatementTotalsJSON,
Expand All@@ -27,15 +29,19 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
};
};

export const billingPerUnitTotalTierFromJSON = (data: BillingPerUnitTotalTierJSON): BillingPerUnitTotalTier => {
return {
quantity: data.quantity,
feePerBlock: billingMoneyAmountFromJSON(data.fee_per_block),
total: billingMoneyAmountFromJSON(data.total),
};
};

const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] => {
return data.map(unitTotal => ({
name: unitTotal.name,
blockSize: unitTotal.block_size,
tiers: unitTotal.tiers.map(tier => ({
quantity: tier.quantity,
feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
total: billingMoneyAmountFromJSON(tier.total),
})),
tiers: unitTotal.tiers.map(billingPerUnitTotalTierFromJSON),
}));
};

Expand Down
7 changes: 7 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export const enUS: LocalizationResource = {
annually: 'Annually',
availableFeatures: 'Available features',
billedAnnually: 'Billed annually',
billedMonthly: 'Billed monthly',
billedMonthlyOnly: 'Only billed monthly',
billedAnnuallyOnly: 'Only billed annually',
cancelFreeTrial: 'Cancel free trial',
Expand DownExpand Up@@ -521,6 +522,11 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
includedSeatsUsage: '{{includedSeats}} seats included',
overview: 'Overview',
paidSeatsUsage: '{{seatsQuantity}} seats x {{amount}}',
seatLimit: 'Up to {{seatLimit}} seats',
seatLimitAndIncludedSeats: 'Up to {{seatLimit}} seats ({{includedSeats}} included)',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand DownExpand Up@@ -1364,6 +1370,7 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
overview: 'Overview',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -233,6 +233,7 @@ export interface BillingSubscriptionItemSeats {
* The seat limit active while the parent subscription item was active. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTier[];
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -609,6 +609,7 @@ export interface BillingSubscriptionItemSeatsJSON {
* The number of seats available. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTierJSON[];
}

/**
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,7 @@ export type __internal_LocalizationResource = {
switchToMonthlyWithPrice: LocalizationValue<'price' | 'currency'>;
switchToAnnualWithAnnualPrice: LocalizationValue<'price' | 'currency'>;
billedAnnually: LocalizationValue;
billedMonthly: LocalizationValue;
billedMonthlyOnly: LocalizationValue;
billedAnnuallyOnly: LocalizationValue;
cancelFreeTrial: LocalizationValue<'plan'>;
Expand DownExpand Up@@ -963,6 +964,7 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
overview: LocalizationValue;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand DownExpand Up@@ -1204,6 +1206,11 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
includedSeatsUsage: LocalizationValue<'includedSeats'>;
overview: LocalizationValue;
paidSeatsUsage: LocalizationValue<'seatsQuantity' | 'amount'>;
seatLimit: LocalizationValue<'seatLimit'>;
seatLimitAndIncludedSeats: LocalizationValue<'seatLimit' | 'includedSeats'>;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand Down
137 changes: 125 additions & 12 deletions packages/ui/src/components/Subscriptions/SubscriptionsList.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import type { BillingPlanResource, BillingSubscriptionItemResource } from '@clerk/shared/types';
import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionResource,
} from '@clerk/shared/types';
import { Fragment, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { ProfileSection } from '@/ui/elements/Section';
import { common } from '@/ui/styledSystem';
import { getIncludedSeatsUnitTier, getPlanSeatLimit, getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';

import {
normalizeFormatted,
Expand All@@ -14,7 +19,21 @@ import {
useSubscription,
} from '../../contexts';
import type { LocalizationKey } from '../../customizables';
import { Col, Flex, Icon, localizationKeys, Span, Table, Tbody, Td, Text, Th, Thead, Tr } from '../../customizables';
import {
Col,
Flex,
Icon,
localizationKeys,
Span,
Table,
Tbody,
Td,
Text,
Th,
Thead,
Tr,
useLocalizations,
} from '../../customizables';
import { ArrowsUpDown, CogFilled, Plans, Plus, Users } from '../../icons';
import { useRouter } from '../../router';
import { SubscriptionBadge } from './badge';
Expand All@@ -34,7 +53,7 @@ export function SubscriptionsList({
}) {
const localizationRoot = useSubscriberTypeLocalizationRoot();
const subscriberType = useSubscriberTypeContext();
const { subscriptionItems } = useSubscription();
const { subscriptionItems, data: subscription } = useSubscription();
const canManageBilling =
useProtect(has => has({ permission: 'org:sys_billing:manage' })) || subscriberType === 'user';
const { navigate } = useRouter();
Expand DownExpand Up@@ -113,6 +132,12 @@ export function SubscriptionsList({
length={sortedSubscriptionItems.length}
/>
))}
{subscription?.nextPayment ? (
<SubscriptionOverviewRow
nextPayment={subscription.nextPayment}
localizationRoot={localizationRoot}
/>
) : null}
</Tbody>
</Table>
)}
Expand DownExpand Up@@ -164,6 +189,56 @@ export function SubscriptionsList({
);
}

function SubscriptionOverviewRow({
nextPayment,
localizationRoot,
}: {
nextPayment: NonNullable<BillingSubscriptionResource['nextPayment']>;
localizationRoot: ReturnType<typeof useSubscriberTypeLocalizationRoot>;
}) {
return (
<Tr
sx={t => ({
background: common.mutedBackground(t),
})}
>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Text
variant='subtitle'
localizationKey={localizationKeys(`${localizationRoot}.billingPage.subscriptionsListSection.overview`)}
/>
</Td>
<Td
sx={_ => ({
textAlign: 'end',
})}
>
<Col
gap={1}
align='end'
>
<Text
variant='h2'
sx={t => ({
color: t.colors.$colorForeground,
})}
>
{nextPayment.amount.currencySymbol}
{nextPayment.amount.amountFormatted}

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will be updated to next_payment.totals.grand_total once #8739 is merged

</Text>
<Text
variant='subtitle'
colorScheme='secondary'
localizationKey={localizationKeys('badge__renewsAt', {
date: nextPayment.date,
})}
/>
</Col>
</Td>
</Tr>
);
}

function SubscriptionItemRow({
subscriptionItem,
length,
Expand All@@ -174,12 +249,37 @@ function SubscriptionItemRow({
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const fee = subscriptionItem.planPeriod === 'annual' ? subscriptionItem.plan.annualFee! : subscriptionItem.plan.fee!;
const { captionForSubscription } = usePlansContext();
const { t } = useLocalizations();

const feeFormatted = useMemo(() => {
return normalizeFormatted(fee.amountFormatted);
}, [fee.amountFormatted]);

const subItemSeatsQty = subscriptionItem.seats?.quantity;
const seatUnitPrice = getSeatUnitPrice(subscriptionItem.plan);
const includedSeatsUnitTier = getIncludedSeatsUnitTier(seatUnitPrice);
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);
const includedSeats =
includedSeatsUnitTier?.endsAfterBlock != null && seatUnitPrice
? includedSeatsUnitTier.endsAfterBlock * seatUnitPrice.blockSize
: null;
const seatsTotalTier = subscriptionItem.seats?.tiers?.find(t => t.total.amount > 0);
const monthLabel = t(localizationKeys('billing.month')).toLowerCase();
const seatLimitAndIncludedSeatsLocalizationKey =

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this conditional is very hard to scan

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's so bad :/ any suggestions? It's just picking a specific localization key, so doesn't feel weighty enough to extract to a separate component.

typeof planSeatLimit === 'number' && includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimitAndIncludedSeats', {
seatLimit: planSeatLimit,
includedSeats,
})
: typeof planSeatLimit === 'number'
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimit', {
seatLimit: planSeatLimit,
})
: includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.includedSeatsUsage', {
includedSeats,
})
: null;

return (
<Fragment key={subscriptionItem.id}>
Expand DownExpand Up@@ -272,7 +372,7 @@ function SubscriptionItemRow({
return {};
}}
>
<Td>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Col gap={1}>
<Flex
align='center'
Expand DownExpand Up@@ -300,14 +400,27 @@ function SubscriptionItemRow({
textAlign: 'end',
})}
>
<Text
variant='subtitle'
localizationKey={
subItemSeatsQty === null
? localizationKeys('billing.pricingTable.seatCost.unlimitedSeats')
: localizationKeys('billing.pricingTable.seatCost.upToSeats', { endsAfterBlock: subItemSeatsQty })
}
/>
<Col
gap={1}
align='end'
>
{seatLimitAndIncludedSeatsLocalizationKey ? (
<Text
variant='subtitle'
localizationKey={seatLimitAndIncludedSeatsLocalizationKey}
/>
) : null}
{seatsTotalTier && seatsTotalTier.quantity ? (
<Text variant='subtitle'>
{t(
localizationKeys('organizationProfile.billingPage.subscriptionsListSection.paidSeatsUsage', {
seatsQuantity: seatsTotalTier.quantity,
amount: `${seatsTotalTier.feePerBlock.currencySymbol}${seatsTotalTier.feePerBlock.amountFormatted} / ${monthLabel}`,
}),
)}
</Text>
) : null}
</Col>
</Td>
</Tr>
) : null}
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/contexts/components/SubscriberType.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ export const SubscriberTypeContext = createContext<ForPayerType | undefined>(DEF

export const useSubscriberTypeContext = (): ForPayerType => useContext(SubscriberTypeContext) || DEFAUlT;

export const useSubscriberTypeLocalizationRoot = () => {
export const useSubscriberTypeLocalizationRoot = (): 'userProfile' | 'organizationProfile' => {
const subscriberType = useSubscriberTypeContext();
return subscriberType === 'user' ? 'userProfile' : 'organizationProfile';
};
44 changes: 44 additions & 0 deletions packages/ui/src/utils/__tests__/billingPlanSeats.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
import { describe, expect, test } from 'vitest';

import {
getIncludedSeatsUnitTier,
getPaidSeatsUnitTier,
getSeatsPerUnitTotal,
organizationAndInvitationsExceedsPurchasedSeats,
Expand DownExpand Up@@ -160,6 +161,49 @@ describe('getPaidSeatsUnitTier', () => {
});
});

describe('getIncludedSeatsUnitTier', () => {
test('returns the included tier from a seats unit price with included seats', () => {
const includedTier = {
id: 'tier_included',
startsAtBlock: 1,
endsAfterBlock: 3,
feePerBlock: money(0),
};
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
includedTier,
{
id: 'tier_paid',
startsAtBlock: 4,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBe(includedTier);
});

test('returns null for paid-only seats unit prices', () => {
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_paid',
startsAtBlock: 1,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBeNull();
});
});

describe('organizationAndInvitationsExceedsPurchasedSeats', () => {
test('returns true when members, pending invitations, and invitations exceed seats entitlements', () => {
const subscriptionItem = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON } from '../../utils';
import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand DownExpand Up@@ -108,7 +108,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
this.amount = data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined;
this.credit =
data.credit && data.credit.amount ? { amount: billingMoneyAmountFromJSON(data.credit.amount) } : undefined;
this.seats = data.seats ? { quantity: data.seats.quantity } : undefined;
this.seats = data.seats
? {
quantity: data.seats.quantity,
...(data.seats.tiers ? { tiers: data.seats.tiers.map(billingPerUnitTotalTierFromJSON) } : {}),
}
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;

Expand Down
16 changes: 11 additions & 5 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,8 @@ import type {
BillingPerPeriodTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingPerUnitTotalTier,
BillingPerUnitTotalTierJSON,
BillingPlanUnitPriceJSON,
BillingStatementTotals,
BillingStatementTotalsJSON,
Expand All@@ -27,15 +29,19 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
};
};

export const billingPerUnitTotalTierFromJSON = (data: BillingPerUnitTotalTierJSON): BillingPerUnitTotalTier => {
return {
quantity: data.quantity,
feePerBlock: billingMoneyAmountFromJSON(data.fee_per_block),
total: billingMoneyAmountFromJSON(data.total),
};
};

const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] => {
return data.map(unitTotal => ({
name: unitTotal.name,
blockSize: unitTotal.block_size,
tiers: unitTotal.tiers.map(tier => ({
quantity: tier.quantity,
feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
total: billingMoneyAmountFromJSON(tier.total),
})),
tiers: unitTotal.tiers.map(billingPerUnitTotalTierFromJSON),
}));
};

Expand Down
7 changes: 7 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export const enUS: LocalizationResource = {
annually: 'Annually',
availableFeatures: 'Available features',
billedAnnually: 'Billed annually',
billedMonthly: 'Billed monthly',
billedMonthlyOnly: 'Only billed monthly',
billedAnnuallyOnly: 'Only billed annually',
cancelFreeTrial: 'Cancel free trial',
Expand DownExpand Up@@ -521,6 +522,11 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
includedSeatsUsage: '{{includedSeats}} seats included',
overview: 'Overview',
paidSeatsUsage: '{{seatsQuantity}} seats x {{amount}}',
seatLimit: 'Up to {{seatLimit}} seats',
seatLimitAndIncludedSeats: 'Up to {{seatLimit}} seats ({{includedSeats}} included)',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand DownExpand Up@@ -1364,6 +1370,7 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
overview: 'Overview',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -233,6 +233,7 @@ export interface BillingSubscriptionItemSeats {
* The seat limit active while the parent subscription item was active. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTier[];
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -609,6 +609,7 @@ export interface BillingSubscriptionItemSeatsJSON {
* The number of seats available. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTierJSON[];
}

/**
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,7 @@ export type __internal_LocalizationResource = {
switchToMonthlyWithPrice: LocalizationValue<'price' | 'currency'>;
switchToAnnualWithAnnualPrice: LocalizationValue<'price' | 'currency'>;
billedAnnually: LocalizationValue;
billedMonthly: LocalizationValue;
billedMonthlyOnly: LocalizationValue;
billedAnnuallyOnly: LocalizationValue;
cancelFreeTrial: LocalizationValue<'plan'>;
Expand DownExpand Up@@ -963,6 +964,7 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
overview: LocalizationValue;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand DownExpand Up@@ -1204,6 +1206,11 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
includedSeatsUsage: LocalizationValue<'includedSeats'>;
overview: LocalizationValue;
paidSeatsUsage: LocalizationValue<'seatsQuantity' | 'amount'>;
seatLimit: LocalizationValue<'seatLimit'>;
seatLimitAndIncludedSeats: LocalizationValue<'seatLimit' | 'includedSeats'>;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand Down
137 changes: 125 additions & 12 deletions packages/ui/src/components/Subscriptions/SubscriptionsList.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import type { BillingPlanResource, BillingSubscriptionItemResource } from '@clerk/shared/types';
import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionResource,
} from '@clerk/shared/types';
import { Fragment, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { ProfileSection } from '@/ui/elements/Section';
import { common } from '@/ui/styledSystem';
import { getIncludedSeatsUnitTier, getPlanSeatLimit, getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';

import {
normalizeFormatted,
Expand All@@ -14,7 +19,21 @@ import {
useSubscription,
} from '../../contexts';
import type { LocalizationKey } from '../../customizables';
import { Col, Flex, Icon, localizationKeys, Span, Table, Tbody, Td, Text, Th, Thead, Tr } from '../../customizables';
import {
Col,
Flex,
Icon,
localizationKeys,
Span,
Table,
Tbody,
Td,
Text,
Th,
Thead,
Tr,
useLocalizations,
} from '../../customizables';
import { ArrowsUpDown, CogFilled, Plans, Plus, Users } from '../../icons';
import { useRouter } from '../../router';
import { SubscriptionBadge } from './badge';
Expand All@@ -34,7 +53,7 @@ export function SubscriptionsList({
}) {
const localizationRoot = useSubscriberTypeLocalizationRoot();
const subscriberType = useSubscriberTypeContext();
const { subscriptionItems } = useSubscription();
const { subscriptionItems, data: subscription } = useSubscription();
const canManageBilling =
useProtect(has => has({ permission: 'org:sys_billing:manage' })) || subscriberType === 'user';
const { navigate } = useRouter();
Expand DownExpand Up@@ -113,6 +132,12 @@ export function SubscriptionsList({
length={sortedSubscriptionItems.length}
/>
))}
{subscription?.nextPayment ? (
<SubscriptionOverviewRow
nextPayment={subscription.nextPayment}
localizationRoot={localizationRoot}
/>
) : null}
</Tbody>
</Table>
)}
Expand DownExpand Up@@ -164,6 +189,56 @@ export function SubscriptionsList({
);
}

function SubscriptionOverviewRow({
nextPayment,
localizationRoot,
}: {
nextPayment: NonNullable<BillingSubscriptionResource['nextPayment']>;
localizationRoot: ReturnType<typeof useSubscriberTypeLocalizationRoot>;
}) {
return (
<Tr
sx={t => ({
background: common.mutedBackground(t),
})}
>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Text
variant='subtitle'
localizationKey={localizationKeys(`${localizationRoot}.billingPage.subscriptionsListSection.overview`)}
/>
</Td>
<Td
sx={_ => ({
textAlign: 'end',
})}
>
<Col
gap={1}
align='end'
>
<Text
variant='h2'
sx={t => ({
color: t.colors.$colorForeground,
})}
>
{nextPayment.amount.currencySymbol}
{nextPayment.amount.amountFormatted}

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will be updated to next_payment.totals.grand_total once #8739 is merged

</Text>
<Text
variant='subtitle'
colorScheme='secondary'
localizationKey={localizationKeys('badge__renewsAt', {
date: nextPayment.date,
})}
/>
</Col>
</Td>
</Tr>
);
}

function SubscriptionItemRow({
subscriptionItem,
length,
Expand All@@ -174,12 +249,37 @@ function SubscriptionItemRow({
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const fee = subscriptionItem.planPeriod === 'annual' ? subscriptionItem.plan.annualFee! : subscriptionItem.plan.fee!;
const { captionForSubscription } = usePlansContext();
const { t } = useLocalizations();

const feeFormatted = useMemo(() => {
return normalizeFormatted(fee.amountFormatted);
}, [fee.amountFormatted]);

const subItemSeatsQty = subscriptionItem.seats?.quantity;
const seatUnitPrice = getSeatUnitPrice(subscriptionItem.plan);
const includedSeatsUnitTier = getIncludedSeatsUnitTier(seatUnitPrice);
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);
const includedSeats =
includedSeatsUnitTier?.endsAfterBlock != null && seatUnitPrice
? includedSeatsUnitTier.endsAfterBlock * seatUnitPrice.blockSize
: null;
const seatsTotalTier = subscriptionItem.seats?.tiers?.find(t => t.total.amount > 0);
const monthLabel = t(localizationKeys('billing.month')).toLowerCase();
const seatLimitAndIncludedSeatsLocalizationKey =

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this conditional is very hard to scan

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's so bad :/ any suggestions? It's just picking a specific localization key, so doesn't feel weighty enough to extract to a separate component.

typeof planSeatLimit === 'number' && includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimitAndIncludedSeats', {
seatLimit: planSeatLimit,
includedSeats,
})
: typeof planSeatLimit === 'number'
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimit', {
seatLimit: planSeatLimit,
})
: includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.includedSeatsUsage', {
includedSeats,
})
: null;

return (
<Fragment key={subscriptionItem.id}>
Expand DownExpand Up@@ -272,7 +372,7 @@ function SubscriptionItemRow({
return {};
}}
>
<Td>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Col gap={1}>
<Flex
align='center'
Expand DownExpand Up@@ -300,14 +400,27 @@ function SubscriptionItemRow({
textAlign: 'end',
})}
>
<Text
variant='subtitle'
localizationKey={
subItemSeatsQty === null
? localizationKeys('billing.pricingTable.seatCost.unlimitedSeats')
: localizationKeys('billing.pricingTable.seatCost.upToSeats', { endsAfterBlock: subItemSeatsQty })
}
/>
<Col
gap={1}
align='end'
>
{seatLimitAndIncludedSeatsLocalizationKey ? (
<Text
variant='subtitle'
localizationKey={seatLimitAndIncludedSeatsLocalizationKey}
/>
) : null}
{seatsTotalTier && seatsTotalTier.quantity ? (
<Text variant='subtitle'>
{t(
localizationKeys('organizationProfile.billingPage.subscriptionsListSection.paidSeatsUsage', {
seatsQuantity: seatsTotalTier.quantity,
amount: `${seatsTotalTier.feePerBlock.currencySymbol}${seatsTotalTier.feePerBlock.amountFormatted} / ${monthLabel}`,
}),
)}
</Text>
) : null}
</Col>
</Td>
</Tr>
) : null}
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/contexts/components/SubscriberType.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ export const SubscriberTypeContext = createContext<ForPayerType | undefined>(DEF

export const useSubscriberTypeContext = (): ForPayerType => useContext(SubscriberTypeContext) || DEFAUlT;

export const useSubscriberTypeLocalizationRoot = () => {
export const useSubscriberTypeLocalizationRoot = (): 'userProfile' | 'organizationProfile' => {
const subscriberType = useSubscriberTypeContext();
return subscriberType === 'user' ? 'userProfile' : 'organizationProfile';
};
44 changes: 44 additions & 0 deletions packages/ui/src/utils/__tests__/billingPlanSeats.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
import { describe, expect, test } from 'vitest';

import {
getIncludedSeatsUnitTier,
getPaidSeatsUnitTier,
getSeatsPerUnitTotal,
organizationAndInvitationsExceedsPurchasedSeats,
Expand DownExpand Up@@ -160,6 +161,49 @@ describe('getPaidSeatsUnitTier', () => {
});
});

describe('getIncludedSeatsUnitTier', () => {
test('returns the included tier from a seats unit price with included seats', () => {
const includedTier = {
id: 'tier_included',
startsAtBlock: 1,
endsAfterBlock: 3,
feePerBlock: money(0),
};
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
includedTier,
{
id: 'tier_paid',
startsAtBlock: 4,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBe(includedTier);
});

test('returns null for paid-only seats unit prices', () => {
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_paid',
startsAtBlock: 1,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBeNull();
});
});

describe('organizationAndInvitationsExceedsPurchasedSeats', () => {
test('returns true when members, pending invitations, and invitations exceed seats entitlements', () => {
const subscriptionItem = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON } from '../../utils';
import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand DownExpand Up@@ -108,7 +108,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
this.amount = data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined;
this.credit =
data.credit && data.credit.amount ? { amount: billingMoneyAmountFromJSON(data.credit.amount) } : undefined;
this.seats = data.seats ? { quantity: data.seats.quantity } : undefined;
this.seats = data.seats
? {
quantity: data.seats.quantity,
...(data.seats.tiers ? { tiers: data.seats.tiers.map(billingPerUnitTotalTierFromJSON) } : {}),
}
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;

Expand Down
16 changes: 11 additions & 5 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,8 @@ import type {
BillingPerPeriodTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingPerUnitTotalTier,
BillingPerUnitTotalTierJSON,
BillingPlanUnitPriceJSON,
BillingStatementTotals,
BillingStatementTotalsJSON,
Expand All@@ -27,15 +29,19 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
};
};

export const billingPerUnitTotalTierFromJSON = (data: BillingPerUnitTotalTierJSON): BillingPerUnitTotalTier => {
return {
quantity: data.quantity,
feePerBlock: billingMoneyAmountFromJSON(data.fee_per_block),
total: billingMoneyAmountFromJSON(data.total),
};
};

const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] => {
return data.map(unitTotal => ({
name: unitTotal.name,
blockSize: unitTotal.block_size,
tiers: unitTotal.tiers.map(tier => ({
quantity: tier.quantity,
feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
total: billingMoneyAmountFromJSON(tier.total),
})),
tiers: unitTotal.tiers.map(billingPerUnitTotalTierFromJSON),
}));
};

Expand Down
7 changes: 7 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export const enUS: LocalizationResource = {
annually: 'Annually',
availableFeatures: 'Available features',
billedAnnually: 'Billed annually',
billedMonthly: 'Billed monthly',
billedMonthlyOnly: 'Only billed monthly',
billedAnnuallyOnly: 'Only billed annually',
cancelFreeTrial: 'Cancel free trial',
Expand DownExpand Up@@ -521,6 +522,11 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
includedSeatsUsage: '{{includedSeats}} seats included',
overview: 'Overview',
paidSeatsUsage: '{{seatsQuantity}} seats x {{amount}}',
seatLimit: 'Up to {{seatLimit}} seats',
seatLimitAndIncludedSeats: 'Up to {{seatLimit}} seats ({{includedSeats}} included)',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand DownExpand Up@@ -1364,6 +1370,7 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
overview: 'Overview',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -233,6 +233,7 @@ export interface BillingSubscriptionItemSeats {
* The seat limit active while the parent subscription item was active. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTier[];
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -609,6 +609,7 @@ export interface BillingSubscriptionItemSeatsJSON {
* The number of seats available. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTierJSON[];
}

/**
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,7 @@ export type __internal_LocalizationResource = {
switchToMonthlyWithPrice: LocalizationValue<'price' | 'currency'>;
switchToAnnualWithAnnualPrice: LocalizationValue<'price' | 'currency'>;
billedAnnually: LocalizationValue;
billedMonthly: LocalizationValue;
billedMonthlyOnly: LocalizationValue;
billedAnnuallyOnly: LocalizationValue;
cancelFreeTrial: LocalizationValue<'plan'>;
Expand DownExpand Up@@ -963,6 +964,7 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
overview: LocalizationValue;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand DownExpand Up@@ -1204,6 +1206,11 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
includedSeatsUsage: LocalizationValue<'includedSeats'>;
overview: LocalizationValue;
paidSeatsUsage: LocalizationValue<'seatsQuantity' | 'amount'>;
seatLimit: LocalizationValue<'seatLimit'>;
seatLimitAndIncludedSeats: LocalizationValue<'seatLimit' | 'includedSeats'>;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand Down
137 changes: 125 additions & 12 deletions packages/ui/src/components/Subscriptions/SubscriptionsList.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import type { BillingPlanResource, BillingSubscriptionItemResource } from '@clerk/shared/types';
import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionResource,
} from '@clerk/shared/types';
import { Fragment, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { ProfileSection } from '@/ui/elements/Section';
import { common } from '@/ui/styledSystem';
import { getIncludedSeatsUnitTier, getPlanSeatLimit, getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';

import {
normalizeFormatted,
Expand All@@ -14,7 +19,21 @@ import {
useSubscription,
} from '../../contexts';
import type { LocalizationKey } from '../../customizables';
import { Col, Flex, Icon, localizationKeys, Span, Table, Tbody, Td, Text, Th, Thead, Tr } from '../../customizables';
import {
Col,
Flex,
Icon,
localizationKeys,
Span,
Table,
Tbody,
Td,
Text,
Th,
Thead,
Tr,
useLocalizations,
} from '../../customizables';
import { ArrowsUpDown, CogFilled, Plans, Plus, Users } from '../../icons';
import { useRouter } from '../../router';
import { SubscriptionBadge } from './badge';
Expand All@@ -34,7 +53,7 @@ export function SubscriptionsList({
}) {
const localizationRoot = useSubscriberTypeLocalizationRoot();
const subscriberType = useSubscriberTypeContext();
const { subscriptionItems } = useSubscription();
const { subscriptionItems, data: subscription } = useSubscription();
const canManageBilling =
useProtect(has => has({ permission: 'org:sys_billing:manage' })) || subscriberType === 'user';
const { navigate } = useRouter();
Expand DownExpand Up@@ -113,6 +132,12 @@ export function SubscriptionsList({
length={sortedSubscriptionItems.length}
/>
))}
{subscription?.nextPayment ? (
<SubscriptionOverviewRow
nextPayment={subscription.nextPayment}
localizationRoot={localizationRoot}
/>
) : null}
</Tbody>
</Table>
)}
Expand DownExpand Up@@ -164,6 +189,56 @@ export function SubscriptionsList({
);
}

function SubscriptionOverviewRow({
nextPayment,
localizationRoot,
}: {
nextPayment: NonNullable<BillingSubscriptionResource['nextPayment']>;
localizationRoot: ReturnType<typeof useSubscriberTypeLocalizationRoot>;
}) {
return (
<Tr
sx={t => ({
background: common.mutedBackground(t),
})}
>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Text
variant='subtitle'
localizationKey={localizationKeys(`${localizationRoot}.billingPage.subscriptionsListSection.overview`)}
/>
</Td>
<Td
sx={_ => ({
textAlign: 'end',
})}
>
<Col
gap={1}
align='end'
>
<Text
variant='h2'
sx={t => ({
color: t.colors.$colorForeground,
})}
>
{nextPayment.amount.currencySymbol}
{nextPayment.amount.amountFormatted}

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will be updated to next_payment.totals.grand_total once #8739 is merged

</Text>
<Text
variant='subtitle'
colorScheme='secondary'
localizationKey={localizationKeys('badge__renewsAt', {
date: nextPayment.date,
})}
/>
</Col>
</Td>
</Tr>
);
}

function SubscriptionItemRow({
subscriptionItem,
length,
Expand All@@ -174,12 +249,37 @@ function SubscriptionItemRow({
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const fee = subscriptionItem.planPeriod === 'annual' ? subscriptionItem.plan.annualFee! : subscriptionItem.plan.fee!;
const { captionForSubscription } = usePlansContext();
const { t } = useLocalizations();

const feeFormatted = useMemo(() => {
return normalizeFormatted(fee.amountFormatted);
}, [fee.amountFormatted]);

const subItemSeatsQty = subscriptionItem.seats?.quantity;
const seatUnitPrice = getSeatUnitPrice(subscriptionItem.plan);
const includedSeatsUnitTier = getIncludedSeatsUnitTier(seatUnitPrice);
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);
const includedSeats =
includedSeatsUnitTier?.endsAfterBlock != null && seatUnitPrice
? includedSeatsUnitTier.endsAfterBlock * seatUnitPrice.blockSize
: null;
const seatsTotalTier = subscriptionItem.seats?.tiers?.find(t => t.total.amount > 0);
const monthLabel = t(localizationKeys('billing.month')).toLowerCase();
const seatLimitAndIncludedSeatsLocalizationKey =

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this conditional is very hard to scan

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's so bad :/ any suggestions? It's just picking a specific localization key, so doesn't feel weighty enough to extract to a separate component.

typeof planSeatLimit === 'number' && includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimitAndIncludedSeats', {
seatLimit: planSeatLimit,
includedSeats,
})
: typeof planSeatLimit === 'number'
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimit', {
seatLimit: planSeatLimit,
})
: includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.includedSeatsUsage', {
includedSeats,
})
: null;

return (
<Fragment key={subscriptionItem.id}>
Expand DownExpand Up@@ -272,7 +372,7 @@ function SubscriptionItemRow({
return {};
}}
>
<Td>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Col gap={1}>
<Flex
align='center'
Expand DownExpand Up@@ -300,14 +400,27 @@ function SubscriptionItemRow({
textAlign: 'end',
})}
>
<Text
variant='subtitle'
localizationKey={
subItemSeatsQty === null
? localizationKeys('billing.pricingTable.seatCost.unlimitedSeats')
: localizationKeys('billing.pricingTable.seatCost.upToSeats', { endsAfterBlock: subItemSeatsQty })
}
/>
<Col
gap={1}
align='end'
>
{seatLimitAndIncludedSeatsLocalizationKey ? (
<Text
variant='subtitle'
localizationKey={seatLimitAndIncludedSeatsLocalizationKey}
/>
) : null}
{seatsTotalTier && seatsTotalTier.quantity ? (
<Text variant='subtitle'>
{t(
localizationKeys('organizationProfile.billingPage.subscriptionsListSection.paidSeatsUsage', {
seatsQuantity: seatsTotalTier.quantity,
amount: `${seatsTotalTier.feePerBlock.currencySymbol}${seatsTotalTier.feePerBlock.amountFormatted} / ${monthLabel}`,
}),
)}
</Text>
) : null}
</Col>
</Td>
</Tr>
) : null}
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/contexts/components/SubscriberType.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ export const SubscriberTypeContext = createContext<ForPayerType | undefined>(DEF

export const useSubscriberTypeContext = (): ForPayerType => useContext(SubscriberTypeContext) || DEFAUlT;

export const useSubscriberTypeLocalizationRoot = () => {
export const useSubscriberTypeLocalizationRoot = (): 'userProfile' | 'organizationProfile' => {
const subscriberType = useSubscriberTypeContext();
return subscriberType === 'user' ? 'userProfile' : 'organizationProfile';
};
44 changes: 44 additions & 0 deletions packages/ui/src/utils/__tests__/billingPlanSeats.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
import { describe, expect, test } from 'vitest';

import {
getIncludedSeatsUnitTier,
getPaidSeatsUnitTier,
getSeatsPerUnitTotal,
organizationAndInvitationsExceedsPurchasedSeats,
Expand DownExpand Up@@ -160,6 +161,49 @@ describe('getPaidSeatsUnitTier', () => {
});
});

describe('getIncludedSeatsUnitTier', () => {
test('returns the included tier from a seats unit price with included seats', () => {
const includedTier = {
id: 'tier_included',
startsAtBlock: 1,
endsAfterBlock: 3,
feePerBlock: money(0),
};
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
includedTier,
{
id: 'tier_paid',
startsAtBlock: 4,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBe(includedTier);
});

test('returns null for paid-only seats unit prices', () => {
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_paid',
startsAtBlock: 1,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBeNull();
});
});

describe('organizationAndInvitationsExceedsPurchasedSeats', () => {
test('returns true when members, pending invitations, and invitations exceed seats entitlements', () => {
const subscriptionItem = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON } from '../../utils';
import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand DownExpand Up@@ -108,7 +108,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
this.amount = data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined;
this.credit =
data.credit && data.credit.amount ? { amount: billingMoneyAmountFromJSON(data.credit.amount) } : undefined;
this.seats = data.seats ? { quantity: data.seats.quantity } : undefined;
this.seats = data.seats
? {
quantity: data.seats.quantity,
...(data.seats.tiers ? { tiers: data.seats.tiers.map(billingPerUnitTotalTierFromJSON) } : {}),
}
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;

Expand Down
16 changes: 11 additions & 5 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,8 @@ import type {
BillingPerPeriodTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingPerUnitTotalTier,
BillingPerUnitTotalTierJSON,
BillingPlanUnitPriceJSON,
BillingStatementTotals,
BillingStatementTotalsJSON,
Expand All@@ -27,15 +29,19 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
};
};

export const billingPerUnitTotalTierFromJSON = (data: BillingPerUnitTotalTierJSON): BillingPerUnitTotalTier => {
return {
quantity: data.quantity,
feePerBlock: billingMoneyAmountFromJSON(data.fee_per_block),
total: billingMoneyAmountFromJSON(data.total),
};
};

const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] => {
return data.map(unitTotal => ({
name: unitTotal.name,
blockSize: unitTotal.block_size,
tiers: unitTotal.tiers.map(tier => ({
quantity: tier.quantity,
feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
total: billingMoneyAmountFromJSON(tier.total),
})),
tiers: unitTotal.tiers.map(billingPerUnitTotalTierFromJSON),
}));
};

Expand Down
7 changes: 7 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export const enUS: LocalizationResource = {
annually: 'Annually',
availableFeatures: 'Available features',
billedAnnually: 'Billed annually',
billedMonthly: 'Billed monthly',
billedMonthlyOnly: 'Only billed monthly',
billedAnnuallyOnly: 'Only billed annually',
cancelFreeTrial: 'Cancel free trial',
Expand DownExpand Up@@ -521,6 +522,11 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
includedSeatsUsage: '{{includedSeats}} seats included',
overview: 'Overview',
paidSeatsUsage: '{{seatsQuantity}} seats x {{amount}}',
seatLimit: 'Up to {{seatLimit}} seats',
seatLimitAndIncludedSeats: 'Up to {{seatLimit}} seats ({{includedSeats}} included)',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand DownExpand Up@@ -1364,6 +1370,7 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
overview: 'Overview',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -233,6 +233,7 @@ export interface BillingSubscriptionItemSeats {
* The seat limit active while the parent subscription item was active. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTier[];
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -609,6 +609,7 @@ export interface BillingSubscriptionItemSeatsJSON {
* The number of seats available. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTierJSON[];
}

/**
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,7 @@ export type __internal_LocalizationResource = {
switchToMonthlyWithPrice: LocalizationValue<'price' | 'currency'>;
switchToAnnualWithAnnualPrice: LocalizationValue<'price' | 'currency'>;
billedAnnually: LocalizationValue;
billedMonthly: LocalizationValue;
billedMonthlyOnly: LocalizationValue;
billedAnnuallyOnly: LocalizationValue;
cancelFreeTrial: LocalizationValue<'plan'>;
Expand DownExpand Up@@ -963,6 +964,7 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
overview: LocalizationValue;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand DownExpand Up@@ -1204,6 +1206,11 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
includedSeatsUsage: LocalizationValue<'includedSeats'>;
overview: LocalizationValue;
paidSeatsUsage: LocalizationValue<'seatsQuantity' | 'amount'>;
seatLimit: LocalizationValue<'seatLimit'>;
seatLimitAndIncludedSeats: LocalizationValue<'seatLimit' | 'includedSeats'>;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand Down
137 changes: 125 additions & 12 deletions packages/ui/src/components/Subscriptions/SubscriptionsList.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import type { BillingPlanResource, BillingSubscriptionItemResource } from '@clerk/shared/types';
import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionResource,
} from '@clerk/shared/types';
import { Fragment, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { ProfileSection } from '@/ui/elements/Section';
import { common } from '@/ui/styledSystem';
import { getIncludedSeatsUnitTier, getPlanSeatLimit, getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';

import {
normalizeFormatted,
Expand All@@ -14,7 +19,21 @@ import {
useSubscription,
} from '../../contexts';
import type { LocalizationKey } from '../../customizables';
import { Col, Flex, Icon, localizationKeys, Span, Table, Tbody, Td, Text, Th, Thead, Tr } from '../../customizables';
import {
Col,
Flex,
Icon,
localizationKeys,
Span,
Table,
Tbody,
Td,
Text,
Th,
Thead,
Tr,
useLocalizations,
} from '../../customizables';
import { ArrowsUpDown, CogFilled, Plans, Plus, Users } from '../../icons';
import { useRouter } from '../../router';
import { SubscriptionBadge } from './badge';
Expand All@@ -34,7 +53,7 @@ export function SubscriptionsList({
}) {
const localizationRoot = useSubscriberTypeLocalizationRoot();
const subscriberType = useSubscriberTypeContext();
const { subscriptionItems } = useSubscription();
const { subscriptionItems, data: subscription } = useSubscription();
const canManageBilling =
useProtect(has => has({ permission: 'org:sys_billing:manage' })) || subscriberType === 'user';
const { navigate } = useRouter();
Expand DownExpand Up@@ -113,6 +132,12 @@ export function SubscriptionsList({
length={sortedSubscriptionItems.length}
/>
))}
{subscription?.nextPayment ? (
<SubscriptionOverviewRow
nextPayment={subscription.nextPayment}
localizationRoot={localizationRoot}
/>
) : null}
</Tbody>
</Table>
)}
Expand DownExpand Up@@ -164,6 +189,56 @@ export function SubscriptionsList({
);
}

function SubscriptionOverviewRow({
nextPayment,
localizationRoot,
}: {
nextPayment: NonNullable<BillingSubscriptionResource['nextPayment']>;
localizationRoot: ReturnType<typeof useSubscriberTypeLocalizationRoot>;
}) {
return (
<Tr
sx={t => ({
background: common.mutedBackground(t),
})}
>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Text
variant='subtitle'
localizationKey={localizationKeys(`${localizationRoot}.billingPage.subscriptionsListSection.overview`)}
/>
</Td>
<Td
sx={_ => ({
textAlign: 'end',
})}
>
<Col
gap={1}
align='end'
>
<Text
variant='h2'
sx={t => ({
color: t.colors.$colorForeground,
})}
>
{nextPayment.amount.currencySymbol}
{nextPayment.amount.amountFormatted}

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will be updated to next_payment.totals.grand_total once #8739 is merged

</Text>
<Text
variant='subtitle'
colorScheme='secondary'
localizationKey={localizationKeys('badge__renewsAt', {
date: nextPayment.date,
})}
/>
</Col>
</Td>
</Tr>
);
}

function SubscriptionItemRow({
subscriptionItem,
length,
Expand All@@ -174,12 +249,37 @@ function SubscriptionItemRow({
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const fee = subscriptionItem.planPeriod === 'annual' ? subscriptionItem.plan.annualFee! : subscriptionItem.plan.fee!;
const { captionForSubscription } = usePlansContext();
const { t } = useLocalizations();

const feeFormatted = useMemo(() => {
return normalizeFormatted(fee.amountFormatted);
}, [fee.amountFormatted]);

const subItemSeatsQty = subscriptionItem.seats?.quantity;
const seatUnitPrice = getSeatUnitPrice(subscriptionItem.plan);
const includedSeatsUnitTier = getIncludedSeatsUnitTier(seatUnitPrice);
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);
const includedSeats =
includedSeatsUnitTier?.endsAfterBlock != null && seatUnitPrice
? includedSeatsUnitTier.endsAfterBlock * seatUnitPrice.blockSize
: null;
const seatsTotalTier = subscriptionItem.seats?.tiers?.find(t => t.total.amount > 0);
const monthLabel = t(localizationKeys('billing.month')).toLowerCase();
const seatLimitAndIncludedSeatsLocalizationKey =

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this conditional is very hard to scan

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's so bad :/ any suggestions? It's just picking a specific localization key, so doesn't feel weighty enough to extract to a separate component.

typeof planSeatLimit === 'number' && includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimitAndIncludedSeats', {
seatLimit: planSeatLimit,
includedSeats,
})
: typeof planSeatLimit === 'number'
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimit', {
seatLimit: planSeatLimit,
})
: includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.includedSeatsUsage', {
includedSeats,
})
: null;

return (
<Fragment key={subscriptionItem.id}>
Expand DownExpand Up@@ -272,7 +372,7 @@ function SubscriptionItemRow({
return {};
}}
>
<Td>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Col gap={1}>
<Flex
align='center'
Expand DownExpand Up@@ -300,14 +400,27 @@ function SubscriptionItemRow({
textAlign: 'end',
})}
>
<Text
variant='subtitle'
localizationKey={
subItemSeatsQty === null
? localizationKeys('billing.pricingTable.seatCost.unlimitedSeats')
: localizationKeys('billing.pricingTable.seatCost.upToSeats', { endsAfterBlock: subItemSeatsQty })
}
/>
<Col
gap={1}
align='end'
>
{seatLimitAndIncludedSeatsLocalizationKey ? (
<Text
variant='subtitle'
localizationKey={seatLimitAndIncludedSeatsLocalizationKey}
/>
) : null}
{seatsTotalTier && seatsTotalTier.quantity ? (
<Text variant='subtitle'>
{t(
localizationKeys('organizationProfile.billingPage.subscriptionsListSection.paidSeatsUsage', {
seatsQuantity: seatsTotalTier.quantity,
amount: `${seatsTotalTier.feePerBlock.currencySymbol}${seatsTotalTier.feePerBlock.amountFormatted} / ${monthLabel}`,
}),
)}
</Text>
) : null}
</Col>
</Td>
</Tr>
) : null}
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/contexts/components/SubscriberType.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ export const SubscriberTypeContext = createContext<ForPayerType | undefined>(DEF

export const useSubscriberTypeContext = (): ForPayerType => useContext(SubscriberTypeContext) || DEFAUlT;

export const useSubscriberTypeLocalizationRoot = () => {
export const useSubscriberTypeLocalizationRoot = (): 'userProfile' | 'organizationProfile' => {
const subscriberType = useSubscriberTypeContext();
return subscriberType === 'user' ? 'userProfile' : 'organizationProfile';
};
44 changes: 44 additions & 0 deletions packages/ui/src/utils/__tests__/billingPlanSeats.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
import { describe, expect, test } from 'vitest';

import {
getIncludedSeatsUnitTier,
getPaidSeatsUnitTier,
getSeatsPerUnitTotal,
organizationAndInvitationsExceedsPurchasedSeats,
Expand DownExpand Up@@ -160,6 +161,49 @@ describe('getPaidSeatsUnitTier', () => {
});
});

describe('getIncludedSeatsUnitTier', () => {
test('returns the included tier from a seats unit price with included seats', () => {
const includedTier = {
id: 'tier_included',
startsAtBlock: 1,
endsAfterBlock: 3,
feePerBlock: money(0),
};
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
includedTier,
{
id: 'tier_paid',
startsAtBlock: 4,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBe(includedTier);
});

test('returns null for paid-only seats unit prices', () => {
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_paid',
startsAtBlock: 1,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBeNull();
});
});

describe('organizationAndInvitationsExceedsPurchasedSeats', () => {
test('returns true when members, pending invitations, and invitations exceed seats entitlements', () => {
const subscriptionItem = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON } from '../../utils';
import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand DownExpand Up@@ -108,7 +108,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
this.amount = data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined;
this.credit =
data.credit && data.credit.amount ? { amount: billingMoneyAmountFromJSON(data.credit.amount) } : undefined;
this.seats = data.seats ? { quantity: data.seats.quantity } : undefined;
this.seats = data.seats
? {
quantity: data.seats.quantity,
...(data.seats.tiers ? { tiers: data.seats.tiers.map(billingPerUnitTotalTierFromJSON) } : {}),
}
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;

Expand Down
16 changes: 11 additions & 5 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,8 @@ import type {
BillingPerPeriodTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingPerUnitTotalTier,
BillingPerUnitTotalTierJSON,
BillingPlanUnitPriceJSON,
BillingStatementTotals,
BillingStatementTotalsJSON,
Expand All@@ -27,15 +29,19 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
};
};

export const billingPerUnitTotalTierFromJSON = (data: BillingPerUnitTotalTierJSON): BillingPerUnitTotalTier => {
return {
quantity: data.quantity,
feePerBlock: billingMoneyAmountFromJSON(data.fee_per_block),
total: billingMoneyAmountFromJSON(data.total),
};
};

const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] => {
return data.map(unitTotal => ({
name: unitTotal.name,
blockSize: unitTotal.block_size,
tiers: unitTotal.tiers.map(tier => ({
quantity: tier.quantity,
feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
total: billingMoneyAmountFromJSON(tier.total),
})),
tiers: unitTotal.tiers.map(billingPerUnitTotalTierFromJSON),
}));
};

Expand Down
7 changes: 7 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export const enUS: LocalizationResource = {
annually: 'Annually',
availableFeatures: 'Available features',
billedAnnually: 'Billed annually',
billedMonthly: 'Billed monthly',
billedMonthlyOnly: 'Only billed monthly',
billedAnnuallyOnly: 'Only billed annually',
cancelFreeTrial: 'Cancel free trial',
Expand DownExpand Up@@ -521,6 +522,11 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
includedSeatsUsage: '{{includedSeats}} seats included',
overview: 'Overview',
paidSeatsUsage: '{{seatsQuantity}} seats x {{amount}}',
seatLimit: 'Up to {{seatLimit}} seats',
seatLimitAndIncludedSeats: 'Up to {{seatLimit}} seats ({{includedSeats}} included)',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand DownExpand Up@@ -1364,6 +1370,7 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
overview: 'Overview',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -233,6 +233,7 @@ export interface BillingSubscriptionItemSeats {
* The seat limit active while the parent subscription item was active. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTier[];
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -609,6 +609,7 @@ export interface BillingSubscriptionItemSeatsJSON {
* The number of seats available. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTierJSON[];
}

/**
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,7 @@ export type __internal_LocalizationResource = {
switchToMonthlyWithPrice: LocalizationValue<'price' | 'currency'>;
switchToAnnualWithAnnualPrice: LocalizationValue<'price' | 'currency'>;
billedAnnually: LocalizationValue;
billedMonthly: LocalizationValue;
billedMonthlyOnly: LocalizationValue;
billedAnnuallyOnly: LocalizationValue;
cancelFreeTrial: LocalizationValue<'plan'>;
Expand DownExpand Up@@ -963,6 +964,7 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
overview: LocalizationValue;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand DownExpand Up@@ -1204,6 +1206,11 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
includedSeatsUsage: LocalizationValue<'includedSeats'>;
overview: LocalizationValue;
paidSeatsUsage: LocalizationValue<'seatsQuantity' | 'amount'>;
seatLimit: LocalizationValue<'seatLimit'>;
seatLimitAndIncludedSeats: LocalizationValue<'seatLimit' | 'includedSeats'>;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand Down
137 changes: 125 additions & 12 deletions packages/ui/src/components/Subscriptions/SubscriptionsList.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import type { BillingPlanResource, BillingSubscriptionItemResource } from '@clerk/shared/types';
import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionResource,
} from '@clerk/shared/types';
import { Fragment, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { ProfileSection } from '@/ui/elements/Section';
import { common } from '@/ui/styledSystem';
import { getIncludedSeatsUnitTier, getPlanSeatLimit, getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';

import {
normalizeFormatted,
Expand All@@ -14,7 +19,21 @@ import {
useSubscription,
} from '../../contexts';
import type { LocalizationKey } from '../../customizables';
import { Col, Flex, Icon, localizationKeys, Span, Table, Tbody, Td, Text, Th, Thead, Tr } from '../../customizables';
import {
Col,
Flex,
Icon,
localizationKeys,
Span,
Table,
Tbody,
Td,
Text,
Th,
Thead,
Tr,
useLocalizations,
} from '../../customizables';
import { ArrowsUpDown, CogFilled, Plans, Plus, Users } from '../../icons';
import { useRouter } from '../../router';
import { SubscriptionBadge } from './badge';
Expand All@@ -34,7 +53,7 @@ export function SubscriptionsList({
}) {
const localizationRoot = useSubscriberTypeLocalizationRoot();
const subscriberType = useSubscriberTypeContext();
const { subscriptionItems } = useSubscription();
const { subscriptionItems, data: subscription } = useSubscription();
const canManageBilling =
useProtect(has => has({ permission: 'org:sys_billing:manage' })) || subscriberType === 'user';
const { navigate } = useRouter();
Expand DownExpand Up@@ -113,6 +132,12 @@ export function SubscriptionsList({
length={sortedSubscriptionItems.length}
/>
))}
{subscription?.nextPayment ? (
<SubscriptionOverviewRow
nextPayment={subscription.nextPayment}
localizationRoot={localizationRoot}
/>
) : null}
</Tbody>
</Table>
)}
Expand DownExpand Up@@ -164,6 +189,56 @@ export function SubscriptionsList({
);
}

function SubscriptionOverviewRow({
nextPayment,
localizationRoot,
}: {
nextPayment: NonNullable<BillingSubscriptionResource['nextPayment']>;
localizationRoot: ReturnType<typeof useSubscriberTypeLocalizationRoot>;
}) {
return (
<Tr
sx={t => ({
background: common.mutedBackground(t),
})}
>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Text
variant='subtitle'
localizationKey={localizationKeys(`${localizationRoot}.billingPage.subscriptionsListSection.overview`)}
/>
</Td>
<Td
sx={_ => ({
textAlign: 'end',
})}
>
<Col
gap={1}
align='end'
>
<Text
variant='h2'
sx={t => ({
color: t.colors.$colorForeground,
})}
>
{nextPayment.amount.currencySymbol}
{nextPayment.amount.amountFormatted}

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will be updated to next_payment.totals.grand_total once #8739 is merged

</Text>
<Text
variant='subtitle'
colorScheme='secondary'
localizationKey={localizationKeys('badge__renewsAt', {
date: nextPayment.date,
})}
/>
</Col>
</Td>
</Tr>
);
}

function SubscriptionItemRow({
subscriptionItem,
length,
Expand All@@ -174,12 +249,37 @@ function SubscriptionItemRow({
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const fee = subscriptionItem.planPeriod === 'annual' ? subscriptionItem.plan.annualFee! : subscriptionItem.plan.fee!;
const { captionForSubscription } = usePlansContext();
const { t } = useLocalizations();

const feeFormatted = useMemo(() => {
return normalizeFormatted(fee.amountFormatted);
}, [fee.amountFormatted]);

const subItemSeatsQty = subscriptionItem.seats?.quantity;
const seatUnitPrice = getSeatUnitPrice(subscriptionItem.plan);
const includedSeatsUnitTier = getIncludedSeatsUnitTier(seatUnitPrice);
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);
const includedSeats =
includedSeatsUnitTier?.endsAfterBlock != null && seatUnitPrice
? includedSeatsUnitTier.endsAfterBlock * seatUnitPrice.blockSize
: null;
const seatsTotalTier = subscriptionItem.seats?.tiers?.find(t => t.total.amount > 0);
const monthLabel = t(localizationKeys('billing.month')).toLowerCase();
const seatLimitAndIncludedSeatsLocalizationKey =

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this conditional is very hard to scan

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's so bad :/ any suggestions? It's just picking a specific localization key, so doesn't feel weighty enough to extract to a separate component.

typeof planSeatLimit === 'number' && includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimitAndIncludedSeats', {
seatLimit: planSeatLimit,
includedSeats,
})
: typeof planSeatLimit === 'number'
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimit', {
seatLimit: planSeatLimit,
})
: includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.includedSeatsUsage', {
includedSeats,
})
: null;

return (
<Fragment key={subscriptionItem.id}>
Expand DownExpand Up@@ -272,7 +372,7 @@ function SubscriptionItemRow({
return {};
}}
>
<Td>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Col gap={1}>
<Flex
align='center'
Expand DownExpand Up@@ -300,14 +400,27 @@ function SubscriptionItemRow({
textAlign: 'end',
})}
>
<Text
variant='subtitle'
localizationKey={
subItemSeatsQty === null
? localizationKeys('billing.pricingTable.seatCost.unlimitedSeats')
: localizationKeys('billing.pricingTable.seatCost.upToSeats', { endsAfterBlock: subItemSeatsQty })
}
/>
<Col
gap={1}
align='end'
>
{seatLimitAndIncludedSeatsLocalizationKey ? (
<Text
variant='subtitle'
localizationKey={seatLimitAndIncludedSeatsLocalizationKey}
/>
) : null}
{seatsTotalTier && seatsTotalTier.quantity ? (
<Text variant='subtitle'>
{t(
localizationKeys('organizationProfile.billingPage.subscriptionsListSection.paidSeatsUsage', {
seatsQuantity: seatsTotalTier.quantity,
amount: `${seatsTotalTier.feePerBlock.currencySymbol}${seatsTotalTier.feePerBlock.amountFormatted} / ${monthLabel}`,
}),
)}
</Text>
) : null}
</Col>
</Td>
</Tr>
) : null}
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/contexts/components/SubscriberType.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ export const SubscriberTypeContext = createContext<ForPayerType | undefined>(DEF

export const useSubscriberTypeContext = (): ForPayerType => useContext(SubscriberTypeContext) || DEFAUlT;

export const useSubscriberTypeLocalizationRoot = () => {
export const useSubscriberTypeLocalizationRoot = (): 'userProfile' | 'organizationProfile' => {
const subscriberType = useSubscriberTypeContext();
return subscriberType === 'user' ? 'userProfile' : 'organizationProfile';
};
44 changes: 44 additions & 0 deletions packages/ui/src/utils/__tests__/billingPlanSeats.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
import { describe, expect, test } from 'vitest';

import {
getIncludedSeatsUnitTier,
getPaidSeatsUnitTier,
getSeatsPerUnitTotal,
organizationAndInvitationsExceedsPurchasedSeats,
Expand DownExpand Up@@ -160,6 +161,49 @@ describe('getPaidSeatsUnitTier', () => {
});
});

describe('getIncludedSeatsUnitTier', () => {
test('returns the included tier from a seats unit price with included seats', () => {
const includedTier = {
id: 'tier_included',
startsAtBlock: 1,
endsAfterBlock: 3,
feePerBlock: money(0),
};
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
includedTier,
{
id: 'tier_paid',
startsAtBlock: 4,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBe(includedTier);
});

test('returns null for paid-only seats unit prices', () => {
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_paid',
startsAtBlock: 1,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBeNull();
});
});

describe('organizationAndInvitationsExceedsPurchasedSeats', () => {
test('returns true when members, pending invitations, and invitations exceed seats entitlements', () => {
const subscriptionItem = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON } from '../../utils';
import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand DownExpand Up@@ -108,7 +108,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
this.amount = data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined;
this.credit =
data.credit && data.credit.amount ? { amount: billingMoneyAmountFromJSON(data.credit.amount) } : undefined;
this.seats = data.seats ? { quantity: data.seats.quantity } : undefined;
this.seats = data.seats
? {
quantity: data.seats.quantity,
...(data.seats.tiers ? { tiers: data.seats.tiers.map(billingPerUnitTotalTierFromJSON) } : {}),
}
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;

Expand Down
16 changes: 11 additions & 5 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,8 @@ import type {
BillingPerPeriodTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingPerUnitTotalTier,
BillingPerUnitTotalTierJSON,
BillingPlanUnitPriceJSON,
BillingStatementTotals,
BillingStatementTotalsJSON,
Expand All@@ -27,15 +29,19 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
};
};

export const billingPerUnitTotalTierFromJSON = (data: BillingPerUnitTotalTierJSON): BillingPerUnitTotalTier => {
return {
quantity: data.quantity,
feePerBlock: billingMoneyAmountFromJSON(data.fee_per_block),
total: billingMoneyAmountFromJSON(data.total),
};
};

const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] => {
return data.map(unitTotal => ({
name: unitTotal.name,
blockSize: unitTotal.block_size,
tiers: unitTotal.tiers.map(tier => ({
quantity: tier.quantity,
feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
total: billingMoneyAmountFromJSON(tier.total),
})),
tiers: unitTotal.tiers.map(billingPerUnitTotalTierFromJSON),
}));
};

Expand Down
7 changes: 7 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export const enUS: LocalizationResource = {
annually: 'Annually',
availableFeatures: 'Available features',
billedAnnually: 'Billed annually',
billedMonthly: 'Billed monthly',
billedMonthlyOnly: 'Only billed monthly',
billedAnnuallyOnly: 'Only billed annually',
cancelFreeTrial: 'Cancel free trial',
Expand DownExpand Up@@ -521,6 +522,11 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
includedSeatsUsage: '{{includedSeats}} seats included',
overview: 'Overview',
paidSeatsUsage: '{{seatsQuantity}} seats x {{amount}}',
seatLimit: 'Up to {{seatLimit}} seats',
seatLimitAndIncludedSeats: 'Up to {{seatLimit}} seats ({{includedSeats}} included)',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand DownExpand Up@@ -1364,6 +1370,7 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
overview: 'Overview',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -233,6 +233,7 @@ export interface BillingSubscriptionItemSeats {
* The seat limit active while the parent subscription item was active. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTier[];
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -609,6 +609,7 @@ export interface BillingSubscriptionItemSeatsJSON {
* The number of seats available. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTierJSON[];
}

/**
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,7 @@ export type __internal_LocalizationResource = {
switchToMonthlyWithPrice: LocalizationValue<'price' | 'currency'>;
switchToAnnualWithAnnualPrice: LocalizationValue<'price' | 'currency'>;
billedAnnually: LocalizationValue;
billedMonthly: LocalizationValue;
billedMonthlyOnly: LocalizationValue;
billedAnnuallyOnly: LocalizationValue;
cancelFreeTrial: LocalizationValue<'plan'>;
Expand DownExpand Up@@ -963,6 +964,7 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
overview: LocalizationValue;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand DownExpand Up@@ -1204,6 +1206,11 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
includedSeatsUsage: LocalizationValue<'includedSeats'>;
overview: LocalizationValue;
paidSeatsUsage: LocalizationValue<'seatsQuantity' | 'amount'>;
seatLimit: LocalizationValue<'seatLimit'>;
seatLimitAndIncludedSeats: LocalizationValue<'seatLimit' | 'includedSeats'>;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand Down
137 changes: 125 additions & 12 deletions packages/ui/src/components/Subscriptions/SubscriptionsList.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import type { BillingPlanResource, BillingSubscriptionItemResource } from '@clerk/shared/types';
import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionResource,
} from '@clerk/shared/types';
import { Fragment, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { ProfileSection } from '@/ui/elements/Section';
import { common } from '@/ui/styledSystem';
import { getIncludedSeatsUnitTier, getPlanSeatLimit, getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';

import {
normalizeFormatted,
Expand All@@ -14,7 +19,21 @@ import {
useSubscription,
} from '../../contexts';
import type { LocalizationKey } from '../../customizables';
import { Col, Flex, Icon, localizationKeys, Span, Table, Tbody, Td, Text, Th, Thead, Tr } from '../../customizables';
import {
Col,
Flex,
Icon,
localizationKeys,
Span,
Table,
Tbody,
Td,
Text,
Th,
Thead,
Tr,
useLocalizations,
} from '../../customizables';
import { ArrowsUpDown, CogFilled, Plans, Plus, Users } from '../../icons';
import { useRouter } from '../../router';
import { SubscriptionBadge } from './badge';
Expand All@@ -34,7 +53,7 @@ export function SubscriptionsList({
}) {
const localizationRoot = useSubscriberTypeLocalizationRoot();
const subscriberType = useSubscriberTypeContext();
const { subscriptionItems } = useSubscription();
const { subscriptionItems, data: subscription } = useSubscription();
const canManageBilling =
useProtect(has => has({ permission: 'org:sys_billing:manage' })) || subscriberType === 'user';
const { navigate } = useRouter();
Expand DownExpand Up@@ -113,6 +132,12 @@ export function SubscriptionsList({
length={sortedSubscriptionItems.length}
/>
))}
{subscription?.nextPayment ? (
<SubscriptionOverviewRow
nextPayment={subscription.nextPayment}
localizationRoot={localizationRoot}
/>
) : null}
</Tbody>
</Table>
)}
Expand DownExpand Up@@ -164,6 +189,56 @@ export function SubscriptionsList({
);
}

function SubscriptionOverviewRow({
nextPayment,
localizationRoot,
}: {
nextPayment: NonNullable<BillingSubscriptionResource['nextPayment']>;
localizationRoot: ReturnType<typeof useSubscriberTypeLocalizationRoot>;
}) {
return (
<Tr
sx={t => ({
background: common.mutedBackground(t),
})}
>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Text
variant='subtitle'
localizationKey={localizationKeys(`${localizationRoot}.billingPage.subscriptionsListSection.overview`)}
/>
</Td>
<Td
sx={_ => ({
textAlign: 'end',
})}
>
<Col
gap={1}
align='end'
>
<Text
variant='h2'
sx={t => ({
color: t.colors.$colorForeground,
})}
>
{nextPayment.amount.currencySymbol}
{nextPayment.amount.amountFormatted}

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will be updated to next_payment.totals.grand_total once #8739 is merged

</Text>
<Text
variant='subtitle'
colorScheme='secondary'
localizationKey={localizationKeys('badge__renewsAt', {
date: nextPayment.date,
})}
/>
</Col>
</Td>
</Tr>
);
}

function SubscriptionItemRow({
subscriptionItem,
length,
Expand All@@ -174,12 +249,37 @@ function SubscriptionItemRow({
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const fee = subscriptionItem.planPeriod === 'annual' ? subscriptionItem.plan.annualFee! : subscriptionItem.plan.fee!;
const { captionForSubscription } = usePlansContext();
const { t } = useLocalizations();

const feeFormatted = useMemo(() => {
return normalizeFormatted(fee.amountFormatted);
}, [fee.amountFormatted]);

const subItemSeatsQty = subscriptionItem.seats?.quantity;
const seatUnitPrice = getSeatUnitPrice(subscriptionItem.plan);
const includedSeatsUnitTier = getIncludedSeatsUnitTier(seatUnitPrice);
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);
const includedSeats =
includedSeatsUnitTier?.endsAfterBlock != null && seatUnitPrice
? includedSeatsUnitTier.endsAfterBlock * seatUnitPrice.blockSize
: null;
const seatsTotalTier = subscriptionItem.seats?.tiers?.find(t => t.total.amount > 0);
const monthLabel = t(localizationKeys('billing.month')).toLowerCase();
const seatLimitAndIncludedSeatsLocalizationKey =

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this conditional is very hard to scan

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's so bad :/ any suggestions? It's just picking a specific localization key, so doesn't feel weighty enough to extract to a separate component.

typeof planSeatLimit === 'number' && includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimitAndIncludedSeats', {
seatLimit: planSeatLimit,
includedSeats,
})
: typeof planSeatLimit === 'number'
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimit', {
seatLimit: planSeatLimit,
})
: includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.includedSeatsUsage', {
includedSeats,
})
: null;

return (
<Fragment key={subscriptionItem.id}>
Expand DownExpand Up@@ -272,7 +372,7 @@ function SubscriptionItemRow({
return {};
}}
>
<Td>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Col gap={1}>
<Flex
align='center'
Expand DownExpand Up@@ -300,14 +400,27 @@ function SubscriptionItemRow({
textAlign: 'end',
})}
>
<Text
variant='subtitle'
localizationKey={
subItemSeatsQty === null
? localizationKeys('billing.pricingTable.seatCost.unlimitedSeats')
: localizationKeys('billing.pricingTable.seatCost.upToSeats', { endsAfterBlock: subItemSeatsQty })
}
/>
<Col
gap={1}
align='end'
>
{seatLimitAndIncludedSeatsLocalizationKey ? (
<Text
variant='subtitle'
localizationKey={seatLimitAndIncludedSeatsLocalizationKey}
/>
) : null}
{seatsTotalTier && seatsTotalTier.quantity ? (
<Text variant='subtitle'>
{t(
localizationKeys('organizationProfile.billingPage.subscriptionsListSection.paidSeatsUsage', {
seatsQuantity: seatsTotalTier.quantity,
amount: `${seatsTotalTier.feePerBlock.currencySymbol}${seatsTotalTier.feePerBlock.amountFormatted} / ${monthLabel}`,
}),
)}
</Text>
) : null}
</Col>
</Td>
</Tr>
) : null}
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/contexts/components/SubscriberType.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ export const SubscriberTypeContext = createContext<ForPayerType | undefined>(DEF

export const useSubscriberTypeContext = (): ForPayerType => useContext(SubscriberTypeContext) || DEFAUlT;

export const useSubscriberTypeLocalizationRoot = () => {
export const useSubscriberTypeLocalizationRoot = (): 'userProfile' | 'organizationProfile' => {
const subscriberType = useSubscriberTypeContext();
return subscriberType === 'user' ? 'userProfile' : 'organizationProfile';
};
44 changes: 44 additions & 0 deletions packages/ui/src/utils/__tests__/billingPlanSeats.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
import { describe, expect, test } from 'vitest';

import {
getIncludedSeatsUnitTier,
getPaidSeatsUnitTier,
getSeatsPerUnitTotal,
organizationAndInvitationsExceedsPurchasedSeats,
Expand DownExpand Up@@ -160,6 +161,49 @@ describe('getPaidSeatsUnitTier', () => {
});
});

describe('getIncludedSeatsUnitTier', () => {
test('returns the included tier from a seats unit price with included seats', () => {
const includedTier = {
id: 'tier_included',
startsAtBlock: 1,
endsAfterBlock: 3,
feePerBlock: money(0),
};
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
includedTier,
{
id: 'tier_paid',
startsAtBlock: 4,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBe(includedTier);
});

test('returns null for paid-only seats unit prices', () => {
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_paid',
startsAtBlock: 1,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBeNull();
});
});

describe('organizationAndInvitationsExceedsPurchasedSeats', () => {
test('returns true when members, pending invitations, and invitations exceed seats entitlements', () => {
const subscriptionItem = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/resources/BillingSubscription.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type {

import { unixEpochToDate } from '@/utils/date';

import { billingCreditsFromJSON, billingMoneyAmountFromJSON } from '../../utils';
import { billingCreditsFromJSON, billingMoneyAmountFromJSON, billingPerUnitTotalTierFromJSON } from '../../utils';
import { Billing } from '../modules/billing/namespace';
import { BaseResource, BillingPlan, DeletedObject } from './internal';

Expand DownExpand Up@@ -108,7 +108,12 @@ export class BillingSubscriptionItem extends BaseResource implements BillingSubs
this.amount = data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined;
this.credit =
data.credit && data.credit.amount ? { amount: billingMoneyAmountFromJSON(data.credit.amount) } : undefined;
this.seats = data.seats ? { quantity: data.seats.quantity } : undefined;
this.seats = data.seats
? {
quantity: data.seats.quantity,
...(data.seats.tiers ? { tiers: data.seats.tiers.map(billingPerUnitTotalTierFromJSON) } : {}),
}
: undefined;

this.credits = data.credits ? billingCreditsFromJSON(data.credits) : undefined;

Expand Down
16 changes: 11 additions & 5 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,8 @@ import type {
BillingPerPeriodTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingPerUnitTotalTier,
BillingPerUnitTotalTierJSON,
BillingPlanUnitPriceJSON,
BillingStatementTotals,
BillingStatementTotalsJSON,
Expand All@@ -27,15 +29,19 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
};
};

export const billingPerUnitTotalTierFromJSON = (data: BillingPerUnitTotalTierJSON): BillingPerUnitTotalTier => {
return {
quantity: data.quantity,
feePerBlock: billingMoneyAmountFromJSON(data.fee_per_block),
total: billingMoneyAmountFromJSON(data.total),
};
};

const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] => {
return data.map(unitTotal => ({
name: unitTotal.name,
blockSize: unitTotal.block_size,
tiers: unitTotal.tiers.map(tier => ({
quantity: tier.quantity,
feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
total: billingMoneyAmountFromJSON(tier.total),
})),
tiers: unitTotal.tiers.map(billingPerUnitTotalTierFromJSON),
}));
};

Expand Down
7 changes: 7 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export const enUS: LocalizationResource = {
annually: 'Annually',
availableFeatures: 'Available features',
billedAnnually: 'Billed annually',
billedMonthly: 'Billed monthly',
billedMonthlyOnly: 'Only billed monthly',
billedAnnuallyOnly: 'Only billed annually',
cancelFreeTrial: 'Cancel free trial',
Expand DownExpand Up@@ -521,6 +522,11 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
includedSeatsUsage: '{{includedSeats}} seats included',
overview: 'Overview',
paidSeatsUsage: '{{seatsQuantity}} seats x {{amount}}',
seatLimit: 'Up to {{seatLimit}} seats',
seatLimitAndIncludedSeats: 'Up to {{seatLimit}} seats ({{includedSeats}} included)',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand DownExpand Up@@ -1364,6 +1370,7 @@ export const enUS: LocalizationResource = {
actionLabel__manageSubscription: 'Manage',
actionLabel__newSubscription: 'Subscribe to a plan',
actionLabel__switchPlan: 'Switch plans',
overview: 'Overview',
tableHeader__edit: 'Edit',
tableHeader__plan: 'Plan',
tableHeader__startDate: 'Start date',
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -233,6 +233,7 @@ export interface BillingSubscriptionItemSeats {
* The seat limit active while the parent subscription item was active. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTier[];
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -609,6 +609,7 @@ export interface BillingSubscriptionItemSeatsJSON {
* The number of seats available. `null` means unlimited.
*/
quantity: number | null;
tiers?: BillingPerUnitTotalTierJSON[];
}

/**
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,7 @@ export type __internal_LocalizationResource = {
switchToMonthlyWithPrice: LocalizationValue<'price' | 'currency'>;
switchToAnnualWithAnnualPrice: LocalizationValue<'price' | 'currency'>;
billedAnnually: LocalizationValue;
billedMonthly: LocalizationValue;
billedMonthlyOnly: LocalizationValue;
billedAnnuallyOnly: LocalizationValue;
cancelFreeTrial: LocalizationValue<'plan'>;
Expand DownExpand Up@@ -963,6 +964,7 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
overview: LocalizationValue;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand DownExpand Up@@ -1204,6 +1206,11 @@ export type __internal_LocalizationResource = {
actionLabel__newSubscription: LocalizationValue;
actionLabel__manageSubscription: LocalizationValue;
actionLabel__switchPlan: LocalizationValue;
includedSeatsUsage: LocalizationValue<'includedSeats'>;
overview: LocalizationValue;
paidSeatsUsage: LocalizationValue<'seatsQuantity' | 'amount'>;
seatLimit: LocalizationValue<'seatLimit'>;
seatLimitAndIncludedSeats: LocalizationValue<'seatLimit' | 'includedSeats'>;
};
paymentHistorySection: {
empty: LocalizationValue;
Expand Down
137 changes: 125 additions & 12 deletions packages/ui/src/components/Subscriptions/SubscriptionsList.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import type { BillingPlanResource, BillingSubscriptionItemResource } from '@clerk/shared/types';
import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionResource,
} from '@clerk/shared/types';
import { Fragment, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { ProfileSection } from '@/ui/elements/Section';
import { common } from '@/ui/styledSystem';
import { getIncludedSeatsUnitTier, getPlanSeatLimit, getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';

import {
normalizeFormatted,
Expand All@@ -14,7 +19,21 @@ import {
useSubscription,
} from '../../contexts';
import type { LocalizationKey } from '../../customizables';
import { Col, Flex, Icon, localizationKeys, Span, Table, Tbody, Td, Text, Th, Thead, Tr } from '../../customizables';
import {
Col,
Flex,
Icon,
localizationKeys,
Span,
Table,
Tbody,
Td,
Text,
Th,
Thead,
Tr,
useLocalizations,
} from '../../customizables';
import { ArrowsUpDown, CogFilled, Plans, Plus, Users } from '../../icons';
import { useRouter } from '../../router';
import { SubscriptionBadge } from './badge';
Expand All@@ -34,7 +53,7 @@ export function SubscriptionsList({
}) {
const localizationRoot = useSubscriberTypeLocalizationRoot();
const subscriberType = useSubscriberTypeContext();
const { subscriptionItems } = useSubscription();
const { subscriptionItems, data: subscription } = useSubscription();
const canManageBilling =
useProtect(has => has({ permission: 'org:sys_billing:manage' })) || subscriberType === 'user';
const { navigate } = useRouter();
Expand DownExpand Up@@ -113,6 +132,12 @@ export function SubscriptionsList({
length={sortedSubscriptionItems.length}
/>
))}
{subscription?.nextPayment ? (
<SubscriptionOverviewRow
nextPayment={subscription.nextPayment}
localizationRoot={localizationRoot}
/>
) : null}
</Tbody>
</Table>
)}
Expand DownExpand Up@@ -164,6 +189,56 @@ export function SubscriptionsList({
);
}

function SubscriptionOverviewRow({
nextPayment,
localizationRoot,
}: {
nextPayment: NonNullable<BillingSubscriptionResource['nextPayment']>;
localizationRoot: ReturnType<typeof useSubscriberTypeLocalizationRoot>;
}) {
return (
<Tr
sx={t => ({
background: common.mutedBackground(t),
})}
>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Text
variant='subtitle'
localizationKey={localizationKeys(`${localizationRoot}.billingPage.subscriptionsListSection.overview`)}
/>
</Td>
<Td
sx={_ => ({
textAlign: 'end',
})}
>
<Col
gap={1}
align='end'
>
<Text
variant='h2'
sx={t => ({
color: t.colors.$colorForeground,
})}
>
{nextPayment.amount.currencySymbol}
{nextPayment.amount.amountFormatted}

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will be updated to next_payment.totals.grand_total once #8739 is merged

</Text>
<Text
variant='subtitle'
colorScheme='secondary'
localizationKey={localizationKeys('badge__renewsAt', {
date: nextPayment.date,
})}
/>
</Col>
</Td>
</Tr>
);
}

function SubscriptionItemRow({
subscriptionItem,
length,
Expand All@@ -174,12 +249,37 @@ function SubscriptionItemRow({
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const fee = subscriptionItem.planPeriod === 'annual' ? subscriptionItem.plan.annualFee! : subscriptionItem.plan.fee!;
const { captionForSubscription } = usePlansContext();
const { t } = useLocalizations();

const feeFormatted = useMemo(() => {
return normalizeFormatted(fee.amountFormatted);
}, [fee.amountFormatted]);

const subItemSeatsQty = subscriptionItem.seats?.quantity;
const seatUnitPrice = getSeatUnitPrice(subscriptionItem.plan);
const includedSeatsUnitTier = getIncludedSeatsUnitTier(seatUnitPrice);
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);
const includedSeats =
includedSeatsUnitTier?.endsAfterBlock != null && seatUnitPrice
? includedSeatsUnitTier.endsAfterBlock * seatUnitPrice.blockSize
: null;
const seatsTotalTier = subscriptionItem.seats?.tiers?.find(t => t.total.amount > 0);
const monthLabel = t(localizationKeys('billing.month')).toLowerCase();
const seatLimitAndIncludedSeatsLocalizationKey =

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this conditional is very hard to scan

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's so bad :/ any suggestions? It's just picking a specific localization key, so doesn't feel weighty enough to extract to a separate component.

typeof planSeatLimit === 'number' && includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimitAndIncludedSeats', {
seatLimit: planSeatLimit,
includedSeats,
})
: typeof planSeatLimit === 'number'
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.seatLimit', {
seatLimit: planSeatLimit,
})
: includedSeats !== null
? localizationKeys('organizationProfile.billingPage.subscriptionsListSection.includedSeatsUsage', {
includedSeats,
})
: null;

return (
<Fragment key={subscriptionItem.id}>
Expand DownExpand Up@@ -272,7 +372,7 @@ function SubscriptionItemRow({
return {};
}}
>
<Td>
<Td sx={_ => ({ verticalAlign: 'top' })}>
<Col gap={1}>
<Flex
align='center'
Expand DownExpand Up@@ -300,14 +400,27 @@ function SubscriptionItemRow({
textAlign: 'end',
})}
>
<Text
variant='subtitle'
localizationKey={
subItemSeatsQty === null
? localizationKeys('billing.pricingTable.seatCost.unlimitedSeats')
: localizationKeys('billing.pricingTable.seatCost.upToSeats', { endsAfterBlock: subItemSeatsQty })
}
/>
<Col
gap={1}
align='end'
>
{seatLimitAndIncludedSeatsLocalizationKey ? (
<Text
variant='subtitle'
localizationKey={seatLimitAndIncludedSeatsLocalizationKey}
/>
) : null}
{seatsTotalTier && seatsTotalTier.quantity ? (
<Text variant='subtitle'>
{t(
localizationKeys('organizationProfile.billingPage.subscriptionsListSection.paidSeatsUsage', {
seatsQuantity: seatsTotalTier.quantity,
amount: `${seatsTotalTier.feePerBlock.currencySymbol}${seatsTotalTier.feePerBlock.amountFormatted} / ${monthLabel}`,
}),
)}
</Text>
) : null}
</Col>
</Td>
</Tr>
) : null}
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/contexts/components/SubscriberType.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ export const SubscriberTypeContext = createContext<ForPayerType | undefined>(DEF

export const useSubscriberTypeContext = (): ForPayerType => useContext(SubscriberTypeContext) || DEFAUlT;

export const useSubscriberTypeLocalizationRoot = () => {
export const useSubscriberTypeLocalizationRoot = (): 'userProfile' | 'organizationProfile' => {
const subscriberType = useSubscriberTypeContext();
return subscriberType === 'user' ? 'userProfile' : 'organizationProfile';
};
44 changes: 44 additions & 0 deletions packages/ui/src/utils/__tests__/billingPlanSeats.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
import { describe, expect, test } from 'vitest';

import {
getIncludedSeatsUnitTier,
getPaidSeatsUnitTier,
getSeatsPerUnitTotal,
organizationAndInvitationsExceedsPurchasedSeats,
Expand DownExpand Up@@ -160,6 +161,49 @@ describe('getPaidSeatsUnitTier', () => {
});
});

describe('getIncludedSeatsUnitTier', () => {
test('returns the included tier from a seats unit price with included seats', () => {
const includedTier = {
id: 'tier_included',
startsAtBlock: 1,
endsAfterBlock: 3,
feePerBlock: money(0),
};
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
includedTier,
{
id: 'tier_paid',
startsAtBlock: 4,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBe(includedTier);
});

test('returns null for paid-only seats unit prices', () => {
const unitPrice: BillingPlanUnitPrice = {
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_paid',
startsAtBlock: 1,
endsAfterBlock: null,
feePerBlock: money(500),
},
],
};

expect(getIncludedSeatsUnitTier(unitPrice)).toBeNull();
});
});

describe('organizationAndInvitationsExceedsPurchasedSeats', () => {
test('returns true when members, pending invitations, and invitations exceed seats entitlements', () => {
const subscriptionItem = {
Expand Down
Loading
Loading