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
2 changes: 2 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,8 @@ export const enUS: LocalizationResource = {
plansPage: {
alerts: {
noPermissionsToManageBilling: 'You do not have permissions to manage billing for this organization.',
planMembershipLimitExceeded:
'Your organization has {{count}} members (including pending invitations). This plan only allows {{limit}} members.',
},
title: 'Plans',
},
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1223,6 +1223,7 @@ export type __internal_LocalizationResource = {
title: LocalizationValue;
alerts: {
noPermissionsToManageBilling: LocalizationValue;
planMembershipLimitExceeded: LocalizationValue<'count' | 'limit'>;
};
};
apiKeysPage: {
Expand Down
29 changes: 21 additions & 8 deletions packages/ui/src/components/PricingTable/PricingTableDefault.tsx
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
import { __internal_useOrganizationBase, useClerk, useSession } from '@clerk/shared/react';
import type {
BillingPlanResource,
BillingPlanUnitPrice,
BillingSubscriptionPlanPeriod,
PricingTableProps,
BillingPlanUnitPrice,
} from '@clerk/shared/types';
import * as React from 'react';

import { Switch } from '@/ui/elements/Switch';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getPlanSeatLimit, getSeatUnitPrice, organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import { useProtect } from '../../common';
Expand DownExpand Up@@ -137,6 +138,22 @@ function Card(props: CardProps) {
[plan, planPeriod, activeOrUpcomingSubscriptionBasedOnPlanPeriod],
);

const footerButtonTooltipText = React.useMemo(() => {
if (isSignedIn && !canManageBilling) {
return localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling');
}

if (organization && subscriberType === 'organization' && organizationExceedsPlanSeatLimit(plan, organization)) {
const seatLimit = getPlanSeatLimit(plan);
return localizationKeys('organizationProfile.plansPage.alerts.planMembershipLimitExceeded', {
count: organization.membersCount + organization.pendingInvitationsCount,
limit: seatLimit as number,
});
}

return null;
}, [isSignedIn, canManageBilling, organization, subscriberType, plan]);

const hasFeatures = plan.features.length > 0;

const { shouldShowFooter, shouldShowFooterNotice } = getPricingFooterState({
Expand DownExpand Up@@ -247,17 +264,13 @@ function Card(props: CardProps) {
elementDescriptor={descriptors.pricingTableCardFooterButton}
block
textVariant={isCompact ? 'buttonSmall' : 'buttonLarge'}
{...buttonPropsForPlan({ plan, isCompact, selectedPlanPeriod: planPeriod })}
{...buttonPropsForPlan({ plan, organization, isCompact, selectedPlanPeriod: planPeriod })}
onClick={event => {
onSelect(plan, event);
}}
/>
</Tooltip.Trigger>
{isSignedIn && !canManageBilling && (
<Tooltip.Content
text={localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling')}
/>
)}
{footerButtonTooltipText ? <Tooltip.Content text={footerButtonTooltipText} /> : null}
</Tooltip.Root>
)}
</Box>
Expand DownExpand Up@@ -595,7 +608,7 @@ const CardFeaturesListSeatCost = ({ plan }: { plan: BillingPlanResource }) => {
return null;
}

const seatUnitPrice = unitPrices.find(unitPrice => unitPrice.name.toLowerCase() === 'seats') ?? unitPrices[0];
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice) {
return null;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,47 @@ describe('PricingTable - plans visibility', () => {
pathRoot: '',
reload: vi.fn(),
} as const;
const seatLimitedOrganizationPlan = {
...testPlan,
id: 'plan_org_target',
name: 'Organization Plan',
slug: 'organization-plan',
forPayerType: 'org',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_target_1',
startsAtBlock: 1,
endsAfterBlock: 20,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;
const currentOrganizationPlan = {
...seatLimitedOrganizationPlan,
id: 'plan_org_current',
name: 'Current Organization Plan',
slug: 'current-organization-plan',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_current_1',
startsAtBlock: 1,
endsAfterBlock: 50,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;

it('shows no plans when user is signed in but has no subscription', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
Expand DownExpand Up@@ -581,6 +622,128 @@ describe('PricingTable - plans visibility', () => {
});
});

it('disables switching to an organization plan when the active org exceeds its seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 4,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeDisabled();
});

it('keeps switching enabled when the active org is exactly at the plan seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 3,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeEnabled();
});

it('fetches user plans and renders when using for: user', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down
20 changes: 16 additions & 4 deletions packages/ui/src/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,12 @@ import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionPlanPeriod,
OrganizationResource,
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { Appearance } from '../../internal/appearance';
Expand DownExpand Up@@ -196,12 +198,14 @@ export const usePlansContext = () => {
const buttonPropsForPlan = useCallback(
({
plan,
organization,
// TODO(@COMMERCE): This needs to be removed.
subscription: sub,
isCompact = false,
selectedPlanPeriod = 'annual',
}: {
plan?: BillingPlanResource;
plan: BillingPlanResource;
organization?: OrganizationResource | null;
subscription?: BillingSubscriptionItemResource;
isCompact?: boolean;
selectedPlanPeriod?: BillingSubscriptionPlanPeriod;
Expand All@@ -214,6 +218,8 @@ export const usePlansContext = () => {
} => {
const subscription =
sub ?? (plan ? activeOrUpcomingSubscriptionWithPlanPeriod(plan, selectedPlanPeriod) : undefined);
const exceedsPlanSeatLimit =
subscriberType === 'organization' && !!organization && organizationExceedsPlanSeatLimit(plan, organization);
let _selectedPlanPeriod = selectedPlanPeriod;
const isEligibleForSwitchToAnnual = Boolean(plan?.annualMonthlyFee);

Expand DownExpand Up@@ -279,11 +285,17 @@ export const usePlansContext = () => {
localizationKey: freeTrialOr(getLocalizationKey()),
variant: isCompact ? 'bordered' : 'solid',
colorScheme: isCompact ? 'secondary' : 'primary',
isDisabled: !canManageBilling,
disabled: !canManageBilling,
isDisabled: !canManageBilling || exceedsPlanSeatLimit,
disabled: !canManageBilling || exceedsPlanSeatLimit,
};
},
[activeOrUpcomingSubscriptionWithPlanPeriod, canManageBilling, subscriptionItems, topLevelSubscription],
[
activeOrUpcomingSubscriptionWithPlanPeriod,
canManageBilling,
subscriberType,
subscriptionItems,
topLevelSubscription,
],
);

const captionForSubscription = useCallback((subscription: BillingSubscriptionItemResource) => {
Expand Down
47 changes: 47 additions & 0 deletions packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
*/
export const getSeatUnitPrice = (plan: BillingPlanResource): BillingPlanUnitPrice | null => {
if (!plan.unitPrices?.length) {
return null;
}

const seatUnitPrice = plan.unitPrices.find(unitPrice => unitPrice.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
export const getPlanSeatLimit = (plan: BillingPlanResource): number | null | undefined => {
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice?.tiers.length) {
return undefined;
}

return seatUnitPrice.tiers[seatUnitPrice.tiers.length - 1]?.endsAfterBlock;
};

/**
* Given a plan and an organization, return true if the organization exceeds the seat limit for the plan.
*/
export const organizationExceedsPlanSeatLimit = (
plan: BillingPlanResource,
organization: OrganizationResource,
): boolean => {
const seatLimit = getPlanSeatLimit(plan);

if (seatLimit === undefined || seatLimit === null) {
return false;
}

return organization.membersCount + organization.pendingInvitationsCount > seatLimit;
};
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
2 changes: 2 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,8 @@ export const enUS: LocalizationResource = {
plansPage: {
alerts: {
noPermissionsToManageBilling: 'You do not have permissions to manage billing for this organization.',
planMembershipLimitExceeded:
'Your organization has {{count}} members (including pending invitations). This plan only allows {{limit}} members.',
},
title: 'Plans',
},
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1223,6 +1223,7 @@ export type __internal_LocalizationResource = {
title: LocalizationValue;
alerts: {
noPermissionsToManageBilling: LocalizationValue;
planMembershipLimitExceeded: LocalizationValue<'count' | 'limit'>;
};
};
apiKeysPage: {
Expand Down
29 changes: 21 additions & 8 deletions packages/ui/src/components/PricingTable/PricingTableDefault.tsx
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
import { __internal_useOrganizationBase, useClerk, useSession } from '@clerk/shared/react';
import type {
BillingPlanResource,
BillingPlanUnitPrice,
BillingSubscriptionPlanPeriod,
PricingTableProps,
BillingPlanUnitPrice,
} from '@clerk/shared/types';
import * as React from 'react';

import { Switch } from '@/ui/elements/Switch';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getPlanSeatLimit, getSeatUnitPrice, organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import { useProtect } from '../../common';
Expand DownExpand Up@@ -137,6 +138,22 @@ function Card(props: CardProps) {
[plan, planPeriod, activeOrUpcomingSubscriptionBasedOnPlanPeriod],
);

const footerButtonTooltipText = React.useMemo(() => {
if (isSignedIn && !canManageBilling) {
return localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling');
}

if (organization && subscriberType === 'organization' && organizationExceedsPlanSeatLimit(plan, organization)) {
const seatLimit = getPlanSeatLimit(plan);
return localizationKeys('organizationProfile.plansPage.alerts.planMembershipLimitExceeded', {
count: organization.membersCount + organization.pendingInvitationsCount,
limit: seatLimit as number,
});
}

return null;
}, [isSignedIn, canManageBilling, organization, subscriberType, plan]);

const hasFeatures = plan.features.length > 0;

const { shouldShowFooter, shouldShowFooterNotice } = getPricingFooterState({
Expand DownExpand Up@@ -247,17 +264,13 @@ function Card(props: CardProps) {
elementDescriptor={descriptors.pricingTableCardFooterButton}
block
textVariant={isCompact ? 'buttonSmall' : 'buttonLarge'}
{...buttonPropsForPlan({ plan, isCompact, selectedPlanPeriod: planPeriod })}
{...buttonPropsForPlan({ plan, organization, isCompact, selectedPlanPeriod: planPeriod })}
onClick={event => {
onSelect(plan, event);
}}
/>
</Tooltip.Trigger>
{isSignedIn && !canManageBilling && (
<Tooltip.Content
text={localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling')}
/>
)}
{footerButtonTooltipText ? <Tooltip.Content text={footerButtonTooltipText} /> : null}
</Tooltip.Root>
)}
</Box>
Expand DownExpand Up@@ -595,7 +608,7 @@ const CardFeaturesListSeatCost = ({ plan }: { plan: BillingPlanResource }) => {
return null;
}

const seatUnitPrice = unitPrices.find(unitPrice => unitPrice.name.toLowerCase() === 'seats') ?? unitPrices[0];
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice) {
return null;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,47 @@ describe('PricingTable - plans visibility', () => {
pathRoot: '',
reload: vi.fn(),
} as const;
const seatLimitedOrganizationPlan = {
...testPlan,
id: 'plan_org_target',
name: 'Organization Plan',
slug: 'organization-plan',
forPayerType: 'org',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_target_1',
startsAtBlock: 1,
endsAfterBlock: 20,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;
const currentOrganizationPlan = {
...seatLimitedOrganizationPlan,
id: 'plan_org_current',
name: 'Current Organization Plan',
slug: 'current-organization-plan',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_current_1',
startsAtBlock: 1,
endsAfterBlock: 50,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;

it('shows no plans when user is signed in but has no subscription', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
Expand DownExpand Up@@ -581,6 +622,128 @@ describe('PricingTable - plans visibility', () => {
});
});

it('disables switching to an organization plan when the active org exceeds its seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 4,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeDisabled();
});

it('keeps switching enabled when the active org is exactly at the plan seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 3,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeEnabled();
});

it('fetches user plans and renders when using for: user', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down
20 changes: 16 additions & 4 deletions packages/ui/src/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,12 @@ import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionPlanPeriod,
OrganizationResource,
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { Appearance } from '../../internal/appearance';
Expand DownExpand Up@@ -196,12 +198,14 @@ export const usePlansContext = () => {
const buttonPropsForPlan = useCallback(
({
plan,
organization,
// TODO(@COMMERCE): This needs to be removed.
subscription: sub,
isCompact = false,
selectedPlanPeriod = 'annual',
}: {
plan?: BillingPlanResource;
plan: BillingPlanResource;
organization?: OrganizationResource | null;
subscription?: BillingSubscriptionItemResource;
isCompact?: boolean;
selectedPlanPeriod?: BillingSubscriptionPlanPeriod;
Expand All@@ -214,6 +218,8 @@ export const usePlansContext = () => {
} => {
const subscription =
sub ?? (plan ? activeOrUpcomingSubscriptionWithPlanPeriod(plan, selectedPlanPeriod) : undefined);
const exceedsPlanSeatLimit =
subscriberType === 'organization' && !!organization && organizationExceedsPlanSeatLimit(plan, organization);
let _selectedPlanPeriod = selectedPlanPeriod;
const isEligibleForSwitchToAnnual = Boolean(plan?.annualMonthlyFee);

Expand DownExpand Up@@ -279,11 +285,17 @@ export const usePlansContext = () => {
localizationKey: freeTrialOr(getLocalizationKey()),
variant: isCompact ? 'bordered' : 'solid',
colorScheme: isCompact ? 'secondary' : 'primary',
isDisabled: !canManageBilling,
disabled: !canManageBilling,
isDisabled: !canManageBilling || exceedsPlanSeatLimit,
disabled: !canManageBilling || exceedsPlanSeatLimit,
};
},
[activeOrUpcomingSubscriptionWithPlanPeriod, canManageBilling, subscriptionItems, topLevelSubscription],
[
activeOrUpcomingSubscriptionWithPlanPeriod,
canManageBilling,
subscriberType,
subscriptionItems,
topLevelSubscription,
],
);

const captionForSubscription = useCallback((subscription: BillingSubscriptionItemResource) => {
Expand Down
47 changes: 47 additions & 0 deletions packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
*/
export const getSeatUnitPrice = (plan: BillingPlanResource): BillingPlanUnitPrice | null => {
if (!plan.unitPrices?.length) {
return null;
}

const seatUnitPrice = plan.unitPrices.find(unitPrice => unitPrice.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
export const getPlanSeatLimit = (plan: BillingPlanResource): number | null | undefined => {
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice?.tiers.length) {
return undefined;
}

return seatUnitPrice.tiers[seatUnitPrice.tiers.length - 1]?.endsAfterBlock;
};

/**
* Given a plan and an organization, return true if the organization exceeds the seat limit for the plan.
*/
export const organizationExceedsPlanSeatLimit = (
plan: BillingPlanResource,
organization: OrganizationResource,
): boolean => {
const seatLimit = getPlanSeatLimit(plan);

if (seatLimit === undefined || seatLimit === null) {
return false;
}

return organization.membersCount + organization.pendingInvitationsCount > seatLimit;
};
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
2 changes: 2 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,8 @@ export const enUS: LocalizationResource = {
plansPage: {
alerts: {
noPermissionsToManageBilling: 'You do not have permissions to manage billing for this organization.',
planMembershipLimitExceeded:
'Your organization has {{count}} members (including pending invitations). This plan only allows {{limit}} members.',
},
title: 'Plans',
},
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1223,6 +1223,7 @@ export type __internal_LocalizationResource = {
title: LocalizationValue;
alerts: {
noPermissionsToManageBilling: LocalizationValue;
planMembershipLimitExceeded: LocalizationValue<'count' | 'limit'>;
};
};
apiKeysPage: {
Expand Down
29 changes: 21 additions & 8 deletions packages/ui/src/components/PricingTable/PricingTableDefault.tsx
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
import { __internal_useOrganizationBase, useClerk, useSession } from '@clerk/shared/react';
import type {
BillingPlanResource,
BillingPlanUnitPrice,
BillingSubscriptionPlanPeriod,
PricingTableProps,
BillingPlanUnitPrice,
} from '@clerk/shared/types';
import * as React from 'react';

import { Switch } from '@/ui/elements/Switch';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getPlanSeatLimit, getSeatUnitPrice, organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import { useProtect } from '../../common';
Expand DownExpand Up@@ -137,6 +138,22 @@ function Card(props: CardProps) {
[plan, planPeriod, activeOrUpcomingSubscriptionBasedOnPlanPeriod],
);

const footerButtonTooltipText = React.useMemo(() => {
if (isSignedIn && !canManageBilling) {
return localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling');
}

if (organization && subscriberType === 'organization' && organizationExceedsPlanSeatLimit(plan, organization)) {
const seatLimit = getPlanSeatLimit(plan);
return localizationKeys('organizationProfile.plansPage.alerts.planMembershipLimitExceeded', {
count: organization.membersCount + organization.pendingInvitationsCount,
limit: seatLimit as number,
});
}

return null;
}, [isSignedIn, canManageBilling, organization, subscriberType, plan]);

const hasFeatures = plan.features.length > 0;

const { shouldShowFooter, shouldShowFooterNotice } = getPricingFooterState({
Expand DownExpand Up@@ -247,17 +264,13 @@ function Card(props: CardProps) {
elementDescriptor={descriptors.pricingTableCardFooterButton}
block
textVariant={isCompact ? 'buttonSmall' : 'buttonLarge'}
{...buttonPropsForPlan({ plan, isCompact, selectedPlanPeriod: planPeriod })}
{...buttonPropsForPlan({ plan, organization, isCompact, selectedPlanPeriod: planPeriod })}
onClick={event => {
onSelect(plan, event);
}}
/>
</Tooltip.Trigger>
{isSignedIn && !canManageBilling && (
<Tooltip.Content
text={localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling')}
/>
)}
{footerButtonTooltipText ? <Tooltip.Content text={footerButtonTooltipText} /> : null}
</Tooltip.Root>
)}
</Box>
Expand DownExpand Up@@ -595,7 +608,7 @@ const CardFeaturesListSeatCost = ({ plan }: { plan: BillingPlanResource }) => {
return null;
}

const seatUnitPrice = unitPrices.find(unitPrice => unitPrice.name.toLowerCase() === 'seats') ?? unitPrices[0];
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice) {
return null;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,47 @@ describe('PricingTable - plans visibility', () => {
pathRoot: '',
reload: vi.fn(),
} as const;
const seatLimitedOrganizationPlan = {
...testPlan,
id: 'plan_org_target',
name: 'Organization Plan',
slug: 'organization-plan',
forPayerType: 'org',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_target_1',
startsAtBlock: 1,
endsAfterBlock: 20,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;
const currentOrganizationPlan = {
...seatLimitedOrganizationPlan,
id: 'plan_org_current',
name: 'Current Organization Plan',
slug: 'current-organization-plan',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_current_1',
startsAtBlock: 1,
endsAfterBlock: 50,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;

it('shows no plans when user is signed in but has no subscription', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
Expand DownExpand Up@@ -581,6 +622,128 @@ describe('PricingTable - plans visibility', () => {
});
});

it('disables switching to an organization plan when the active org exceeds its seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 4,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeDisabled();
});

it('keeps switching enabled when the active org is exactly at the plan seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 3,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeEnabled();
});

it('fetches user plans and renders when using for: user', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down
20 changes: 16 additions & 4 deletions packages/ui/src/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,12 @@ import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionPlanPeriod,
OrganizationResource,
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { Appearance } from '../../internal/appearance';
Expand DownExpand Up@@ -196,12 +198,14 @@ export const usePlansContext = () => {
const buttonPropsForPlan = useCallback(
({
plan,
organization,
// TODO(@COMMERCE): This needs to be removed.
subscription: sub,
isCompact = false,
selectedPlanPeriod = 'annual',
}: {
plan?: BillingPlanResource;
plan: BillingPlanResource;
organization?: OrganizationResource | null;
subscription?: BillingSubscriptionItemResource;
isCompact?: boolean;
selectedPlanPeriod?: BillingSubscriptionPlanPeriod;
Expand All@@ -214,6 +218,8 @@ export const usePlansContext = () => {
} => {
const subscription =
sub ?? (plan ? activeOrUpcomingSubscriptionWithPlanPeriod(plan, selectedPlanPeriod) : undefined);
const exceedsPlanSeatLimit =
subscriberType === 'organization' && !!organization && organizationExceedsPlanSeatLimit(plan, organization);
let _selectedPlanPeriod = selectedPlanPeriod;
const isEligibleForSwitchToAnnual = Boolean(plan?.annualMonthlyFee);

Expand DownExpand Up@@ -279,11 +285,17 @@ export const usePlansContext = () => {
localizationKey: freeTrialOr(getLocalizationKey()),
variant: isCompact ? 'bordered' : 'solid',
colorScheme: isCompact ? 'secondary' : 'primary',
isDisabled: !canManageBilling,
disabled: !canManageBilling,
isDisabled: !canManageBilling || exceedsPlanSeatLimit,
disabled: !canManageBilling || exceedsPlanSeatLimit,
};
},
[activeOrUpcomingSubscriptionWithPlanPeriod, canManageBilling, subscriptionItems, topLevelSubscription],
[
activeOrUpcomingSubscriptionWithPlanPeriod,
canManageBilling,
subscriberType,
subscriptionItems,
topLevelSubscription,
],
);

const captionForSubscription = useCallback((subscription: BillingSubscriptionItemResource) => {
Expand Down
47 changes: 47 additions & 0 deletions packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
*/
export const getSeatUnitPrice = (plan: BillingPlanResource): BillingPlanUnitPrice | null => {
if (!plan.unitPrices?.length) {
return null;
}

const seatUnitPrice = plan.unitPrices.find(unitPrice => unitPrice.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
export const getPlanSeatLimit = (plan: BillingPlanResource): number | null | undefined => {
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice?.tiers.length) {
return undefined;
}

return seatUnitPrice.tiers[seatUnitPrice.tiers.length - 1]?.endsAfterBlock;
};

/**
* Given a plan and an organization, return true if the organization exceeds the seat limit for the plan.
*/
export const organizationExceedsPlanSeatLimit = (
plan: BillingPlanResource,
organization: OrganizationResource,
): boolean => {
const seatLimit = getPlanSeatLimit(plan);

if (seatLimit === undefined || seatLimit === null) {
return false;
}

return organization.membersCount + organization.pendingInvitationsCount > seatLimit;
};
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
2 changes: 2 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,8 @@ export const enUS: LocalizationResource = {
plansPage: {
alerts: {
noPermissionsToManageBilling: 'You do not have permissions to manage billing for this organization.',
planMembershipLimitExceeded:
'Your organization has {{count}} members (including pending invitations). This plan only allows {{limit}} members.',
},
title: 'Plans',
},
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1223,6 +1223,7 @@ export type __internal_LocalizationResource = {
title: LocalizationValue;
alerts: {
noPermissionsToManageBilling: LocalizationValue;
planMembershipLimitExceeded: LocalizationValue<'count' | 'limit'>;
};
};
apiKeysPage: {
Expand Down
29 changes: 21 additions & 8 deletions packages/ui/src/components/PricingTable/PricingTableDefault.tsx
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
import { __internal_useOrganizationBase, useClerk, useSession } from '@clerk/shared/react';
import type {
BillingPlanResource,
BillingPlanUnitPrice,
BillingSubscriptionPlanPeriod,
PricingTableProps,
BillingPlanUnitPrice,
} from '@clerk/shared/types';
import * as React from 'react';

import { Switch } from '@/ui/elements/Switch';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getPlanSeatLimit, getSeatUnitPrice, organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import { useProtect } from '../../common';
Expand DownExpand Up@@ -137,6 +138,22 @@ function Card(props: CardProps) {
[plan, planPeriod, activeOrUpcomingSubscriptionBasedOnPlanPeriod],
);

const footerButtonTooltipText = React.useMemo(() => {
if (isSignedIn && !canManageBilling) {
return localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling');
}

if (organization && subscriberType === 'organization' && organizationExceedsPlanSeatLimit(plan, organization)) {
const seatLimit = getPlanSeatLimit(plan);
return localizationKeys('organizationProfile.plansPage.alerts.planMembershipLimitExceeded', {
count: organization.membersCount + organization.pendingInvitationsCount,
limit: seatLimit as number,
});
}

return null;
}, [isSignedIn, canManageBilling, organization, subscriberType, plan]);

const hasFeatures = plan.features.length > 0;

const { shouldShowFooter, shouldShowFooterNotice } = getPricingFooterState({
Expand DownExpand Up@@ -247,17 +264,13 @@ function Card(props: CardProps) {
elementDescriptor={descriptors.pricingTableCardFooterButton}
block
textVariant={isCompact ? 'buttonSmall' : 'buttonLarge'}
{...buttonPropsForPlan({ plan, isCompact, selectedPlanPeriod: planPeriod })}
{...buttonPropsForPlan({ plan, organization, isCompact, selectedPlanPeriod: planPeriod })}
onClick={event => {
onSelect(plan, event);
}}
/>
</Tooltip.Trigger>
{isSignedIn && !canManageBilling && (
<Tooltip.Content
text={localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling')}
/>
)}
{footerButtonTooltipText ? <Tooltip.Content text={footerButtonTooltipText} /> : null}
</Tooltip.Root>
)}
</Box>
Expand DownExpand Up@@ -595,7 +608,7 @@ const CardFeaturesListSeatCost = ({ plan }: { plan: BillingPlanResource }) => {
return null;
}

const seatUnitPrice = unitPrices.find(unitPrice => unitPrice.name.toLowerCase() === 'seats') ?? unitPrices[0];
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice) {
return null;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,47 @@ describe('PricingTable - plans visibility', () => {
pathRoot: '',
reload: vi.fn(),
} as const;
const seatLimitedOrganizationPlan = {
...testPlan,
id: 'plan_org_target',
name: 'Organization Plan',
slug: 'organization-plan',
forPayerType: 'org',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_target_1',
startsAtBlock: 1,
endsAfterBlock: 20,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;
const currentOrganizationPlan = {
...seatLimitedOrganizationPlan,
id: 'plan_org_current',
name: 'Current Organization Plan',
slug: 'current-organization-plan',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_current_1',
startsAtBlock: 1,
endsAfterBlock: 50,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;

it('shows no plans when user is signed in but has no subscription', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
Expand DownExpand Up@@ -581,6 +622,128 @@ describe('PricingTable - plans visibility', () => {
});
});

it('disables switching to an organization plan when the active org exceeds its seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 4,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeDisabled();
});

it('keeps switching enabled when the active org is exactly at the plan seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 3,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeEnabled();
});

it('fetches user plans and renders when using for: user', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down
20 changes: 16 additions & 4 deletions packages/ui/src/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,12 @@ import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionPlanPeriod,
OrganizationResource,
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { Appearance } from '../../internal/appearance';
Expand DownExpand Up@@ -196,12 +198,14 @@ export const usePlansContext = () => {
const buttonPropsForPlan = useCallback(
({
plan,
organization,
// TODO(@COMMERCE): This needs to be removed.
subscription: sub,
isCompact = false,
selectedPlanPeriod = 'annual',
}: {
plan?: BillingPlanResource;
plan: BillingPlanResource;
organization?: OrganizationResource | null;
subscription?: BillingSubscriptionItemResource;
isCompact?: boolean;
selectedPlanPeriod?: BillingSubscriptionPlanPeriod;
Expand All@@ -214,6 +218,8 @@ export const usePlansContext = () => {
} => {
const subscription =
sub ?? (plan ? activeOrUpcomingSubscriptionWithPlanPeriod(plan, selectedPlanPeriod) : undefined);
const exceedsPlanSeatLimit =
subscriberType === 'organization' && !!organization && organizationExceedsPlanSeatLimit(plan, organization);
let _selectedPlanPeriod = selectedPlanPeriod;
const isEligibleForSwitchToAnnual = Boolean(plan?.annualMonthlyFee);

Expand DownExpand Up@@ -279,11 +285,17 @@ export const usePlansContext = () => {
localizationKey: freeTrialOr(getLocalizationKey()),
variant: isCompact ? 'bordered' : 'solid',
colorScheme: isCompact ? 'secondary' : 'primary',
isDisabled: !canManageBilling,
disabled: !canManageBilling,
isDisabled: !canManageBilling || exceedsPlanSeatLimit,
disabled: !canManageBilling || exceedsPlanSeatLimit,
};
},
[activeOrUpcomingSubscriptionWithPlanPeriod, canManageBilling, subscriptionItems, topLevelSubscription],
[
activeOrUpcomingSubscriptionWithPlanPeriod,
canManageBilling,
subscriberType,
subscriptionItems,
topLevelSubscription,
],
);

const captionForSubscription = useCallback((subscription: BillingSubscriptionItemResource) => {
Expand Down
47 changes: 47 additions & 0 deletions packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
*/
export const getSeatUnitPrice = (plan: BillingPlanResource): BillingPlanUnitPrice | null => {
if (!plan.unitPrices?.length) {
return null;
}

const seatUnitPrice = plan.unitPrices.find(unitPrice => unitPrice.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
export const getPlanSeatLimit = (plan: BillingPlanResource): number | null | undefined => {
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice?.tiers.length) {
return undefined;
}

return seatUnitPrice.tiers[seatUnitPrice.tiers.length - 1]?.endsAfterBlock;
};

/**
* Given a plan and an organization, return true if the organization exceeds the seat limit for the plan.
*/
export const organizationExceedsPlanSeatLimit = (
plan: BillingPlanResource,
organization: OrganizationResource,
): boolean => {
const seatLimit = getPlanSeatLimit(plan);

if (seatLimit === undefined || seatLimit === null) {
return false;
}

return organization.membersCount + organization.pendingInvitationsCount > seatLimit;
};
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
2 changes: 2 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,8 @@ export const enUS: LocalizationResource = {
plansPage: {
alerts: {
noPermissionsToManageBilling: 'You do not have permissions to manage billing for this organization.',
planMembershipLimitExceeded:
'Your organization has {{count}} members (including pending invitations). This plan only allows {{limit}} members.',
},
title: 'Plans',
},
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1223,6 +1223,7 @@ export type __internal_LocalizationResource = {
title: LocalizationValue;
alerts: {
noPermissionsToManageBilling: LocalizationValue;
planMembershipLimitExceeded: LocalizationValue<'count' | 'limit'>;
};
};
apiKeysPage: {
Expand Down
29 changes: 21 additions & 8 deletions packages/ui/src/components/PricingTable/PricingTableDefault.tsx
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
import { __internal_useOrganizationBase, useClerk, useSession } from '@clerk/shared/react';
import type {
BillingPlanResource,
BillingPlanUnitPrice,
BillingSubscriptionPlanPeriod,
PricingTableProps,
BillingPlanUnitPrice,
} from '@clerk/shared/types';
import * as React from 'react';

import { Switch } from '@/ui/elements/Switch';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getPlanSeatLimit, getSeatUnitPrice, organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import { useProtect } from '../../common';
Expand DownExpand Up@@ -137,6 +138,22 @@ function Card(props: CardProps) {
[plan, planPeriod, activeOrUpcomingSubscriptionBasedOnPlanPeriod],
);

const footerButtonTooltipText = React.useMemo(() => {
if (isSignedIn && !canManageBilling) {
return localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling');
}

if (organization && subscriberType === 'organization' && organizationExceedsPlanSeatLimit(plan, organization)) {
const seatLimit = getPlanSeatLimit(plan);
return localizationKeys('organizationProfile.plansPage.alerts.planMembershipLimitExceeded', {
count: organization.membersCount + organization.pendingInvitationsCount,
limit: seatLimit as number,
});
}

return null;
}, [isSignedIn, canManageBilling, organization, subscriberType, plan]);

const hasFeatures = plan.features.length > 0;

const { shouldShowFooter, shouldShowFooterNotice } = getPricingFooterState({
Expand DownExpand Up@@ -247,17 +264,13 @@ function Card(props: CardProps) {
elementDescriptor={descriptors.pricingTableCardFooterButton}
block
textVariant={isCompact ? 'buttonSmall' : 'buttonLarge'}
{...buttonPropsForPlan({ plan, isCompact, selectedPlanPeriod: planPeriod })}
{...buttonPropsForPlan({ plan, organization, isCompact, selectedPlanPeriod: planPeriod })}
onClick={event => {
onSelect(plan, event);
}}
/>
</Tooltip.Trigger>
{isSignedIn && !canManageBilling && (
<Tooltip.Content
text={localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling')}
/>
)}
{footerButtonTooltipText ? <Tooltip.Content text={footerButtonTooltipText} /> : null}
</Tooltip.Root>
)}
</Box>
Expand DownExpand Up@@ -595,7 +608,7 @@ const CardFeaturesListSeatCost = ({ plan }: { plan: BillingPlanResource }) => {
return null;
}

const seatUnitPrice = unitPrices.find(unitPrice => unitPrice.name.toLowerCase() === 'seats') ?? unitPrices[0];
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice) {
return null;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,47 @@ describe('PricingTable - plans visibility', () => {
pathRoot: '',
reload: vi.fn(),
} as const;
const seatLimitedOrganizationPlan = {
...testPlan,
id: 'plan_org_target',
name: 'Organization Plan',
slug: 'organization-plan',
forPayerType: 'org',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_target_1',
startsAtBlock: 1,
endsAfterBlock: 20,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;
const currentOrganizationPlan = {
...seatLimitedOrganizationPlan,
id: 'plan_org_current',
name: 'Current Organization Plan',
slug: 'current-organization-plan',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_current_1',
startsAtBlock: 1,
endsAfterBlock: 50,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;

it('shows no plans when user is signed in but has no subscription', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
Expand DownExpand Up@@ -581,6 +622,128 @@ describe('PricingTable - plans visibility', () => {
});
});

it('disables switching to an organization plan when the active org exceeds its seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 4,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeDisabled();
});

it('keeps switching enabled when the active org is exactly at the plan seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 3,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeEnabled();
});

it('fetches user plans and renders when using for: user', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down
20 changes: 16 additions & 4 deletions packages/ui/src/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,12 @@ import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionPlanPeriod,
OrganizationResource,
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { Appearance } from '../../internal/appearance';
Expand DownExpand Up@@ -196,12 +198,14 @@ export const usePlansContext = () => {
const buttonPropsForPlan = useCallback(
({
plan,
organization,
// TODO(@COMMERCE): This needs to be removed.
subscription: sub,
isCompact = false,
selectedPlanPeriod = 'annual',
}: {
plan?: BillingPlanResource;
plan: BillingPlanResource;
organization?: OrganizationResource | null;
subscription?: BillingSubscriptionItemResource;
isCompact?: boolean;
selectedPlanPeriod?: BillingSubscriptionPlanPeriod;
Expand All@@ -214,6 +218,8 @@ export const usePlansContext = () => {
} => {
const subscription =
sub ?? (plan ? activeOrUpcomingSubscriptionWithPlanPeriod(plan, selectedPlanPeriod) : undefined);
const exceedsPlanSeatLimit =
subscriberType === 'organization' && !!organization && organizationExceedsPlanSeatLimit(plan, organization);
let _selectedPlanPeriod = selectedPlanPeriod;
const isEligibleForSwitchToAnnual = Boolean(plan?.annualMonthlyFee);

Expand DownExpand Up@@ -279,11 +285,17 @@ export const usePlansContext = () => {
localizationKey: freeTrialOr(getLocalizationKey()),
variant: isCompact ? 'bordered' : 'solid',
colorScheme: isCompact ? 'secondary' : 'primary',
isDisabled: !canManageBilling,
disabled: !canManageBilling,
isDisabled: !canManageBilling || exceedsPlanSeatLimit,
disabled: !canManageBilling || exceedsPlanSeatLimit,
};
},
[activeOrUpcomingSubscriptionWithPlanPeriod, canManageBilling, subscriptionItems, topLevelSubscription],
[
activeOrUpcomingSubscriptionWithPlanPeriod,
canManageBilling,
subscriberType,
subscriptionItems,
topLevelSubscription,
],
);

const captionForSubscription = useCallback((subscription: BillingSubscriptionItemResource) => {
Expand Down
47 changes: 47 additions & 0 deletions packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
*/
export const getSeatUnitPrice = (plan: BillingPlanResource): BillingPlanUnitPrice | null => {
if (!plan.unitPrices?.length) {
return null;
}

const seatUnitPrice = plan.unitPrices.find(unitPrice => unitPrice.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
export const getPlanSeatLimit = (plan: BillingPlanResource): number | null | undefined => {
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice?.tiers.length) {
return undefined;
}

return seatUnitPrice.tiers[seatUnitPrice.tiers.length - 1]?.endsAfterBlock;
};

/**
* Given a plan and an organization, return true if the organization exceeds the seat limit for the plan.
*/
export const organizationExceedsPlanSeatLimit = (
plan: BillingPlanResource,
organization: OrganizationResource,
): boolean => {
const seatLimit = getPlanSeatLimit(plan);

if (seatLimit === undefined || seatLimit === null) {
return false;
}

return organization.membersCount + organization.pendingInvitationsCount > seatLimit;
};
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
2 changes: 2 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,8 @@ export const enUS: LocalizationResource = {
plansPage: {
alerts: {
noPermissionsToManageBilling: 'You do not have permissions to manage billing for this organization.',
planMembershipLimitExceeded:
'Your organization has {{count}} members (including pending invitations). This plan only allows {{limit}} members.',
},
title: 'Plans',
},
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1223,6 +1223,7 @@ export type __internal_LocalizationResource = {
title: LocalizationValue;
alerts: {
noPermissionsToManageBilling: LocalizationValue;
planMembershipLimitExceeded: LocalizationValue<'count' | 'limit'>;
};
};
apiKeysPage: {
Expand Down
29 changes: 21 additions & 8 deletions packages/ui/src/components/PricingTable/PricingTableDefault.tsx
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
import { __internal_useOrganizationBase, useClerk, useSession } from '@clerk/shared/react';
import type {
BillingPlanResource,
BillingPlanUnitPrice,
BillingSubscriptionPlanPeriod,
PricingTableProps,
BillingPlanUnitPrice,
} from '@clerk/shared/types';
import * as React from 'react';

import { Switch } from '@/ui/elements/Switch';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getPlanSeatLimit, getSeatUnitPrice, organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import { useProtect } from '../../common';
Expand DownExpand Up@@ -137,6 +138,22 @@ function Card(props: CardProps) {
[plan, planPeriod, activeOrUpcomingSubscriptionBasedOnPlanPeriod],
);

const footerButtonTooltipText = React.useMemo(() => {
if (isSignedIn && !canManageBilling) {
return localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling');
}

if (organization && subscriberType === 'organization' && organizationExceedsPlanSeatLimit(plan, organization)) {
const seatLimit = getPlanSeatLimit(plan);
return localizationKeys('organizationProfile.plansPage.alerts.planMembershipLimitExceeded', {
count: organization.membersCount + organization.pendingInvitationsCount,
limit: seatLimit as number,
});
}

return null;
}, [isSignedIn, canManageBilling, organization, subscriberType, plan]);

const hasFeatures = plan.features.length > 0;

const { shouldShowFooter, shouldShowFooterNotice } = getPricingFooterState({
Expand DownExpand Up@@ -247,17 +264,13 @@ function Card(props: CardProps) {
elementDescriptor={descriptors.pricingTableCardFooterButton}
block
textVariant={isCompact ? 'buttonSmall' : 'buttonLarge'}
{...buttonPropsForPlan({ plan, isCompact, selectedPlanPeriod: planPeriod })}
{...buttonPropsForPlan({ plan, organization, isCompact, selectedPlanPeriod: planPeriod })}
onClick={event => {
onSelect(plan, event);
}}
/>
</Tooltip.Trigger>
{isSignedIn && !canManageBilling && (
<Tooltip.Content
text={localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling')}
/>
)}
{footerButtonTooltipText ? <Tooltip.Content text={footerButtonTooltipText} /> : null}
</Tooltip.Root>
)}
</Box>
Expand DownExpand Up@@ -595,7 +608,7 @@ const CardFeaturesListSeatCost = ({ plan }: { plan: BillingPlanResource }) => {
return null;
}

const seatUnitPrice = unitPrices.find(unitPrice => unitPrice.name.toLowerCase() === 'seats') ?? unitPrices[0];
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice) {
return null;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,47 @@ describe('PricingTable - plans visibility', () => {
pathRoot: '',
reload: vi.fn(),
} as const;
const seatLimitedOrganizationPlan = {
...testPlan,
id: 'plan_org_target',
name: 'Organization Plan',
slug: 'organization-plan',
forPayerType: 'org',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_target_1',
startsAtBlock: 1,
endsAfterBlock: 20,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;
const currentOrganizationPlan = {
...seatLimitedOrganizationPlan,
id: 'plan_org_current',
name: 'Current Organization Plan',
slug: 'current-organization-plan',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_current_1',
startsAtBlock: 1,
endsAfterBlock: 50,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;

it('shows no plans when user is signed in but has no subscription', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
Expand DownExpand Up@@ -581,6 +622,128 @@ describe('PricingTable - plans visibility', () => {
});
});

it('disables switching to an organization plan when the active org exceeds its seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 4,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeDisabled();
});

it('keeps switching enabled when the active org is exactly at the plan seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 3,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeEnabled();
});

it('fetches user plans and renders when using for: user', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down
20 changes: 16 additions & 4 deletions packages/ui/src/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,12 @@ import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionPlanPeriod,
OrganizationResource,
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { Appearance } from '../../internal/appearance';
Expand DownExpand Up@@ -196,12 +198,14 @@ export const usePlansContext = () => {
const buttonPropsForPlan = useCallback(
({
plan,
organization,
// TODO(@COMMERCE): This needs to be removed.
subscription: sub,
isCompact = false,
selectedPlanPeriod = 'annual',
}: {
plan?: BillingPlanResource;
plan: BillingPlanResource;
organization?: OrganizationResource | null;
subscription?: BillingSubscriptionItemResource;
isCompact?: boolean;
selectedPlanPeriod?: BillingSubscriptionPlanPeriod;
Expand All@@ -214,6 +218,8 @@ export const usePlansContext = () => {
} => {
const subscription =
sub ?? (plan ? activeOrUpcomingSubscriptionWithPlanPeriod(plan, selectedPlanPeriod) : undefined);
const exceedsPlanSeatLimit =
subscriberType === 'organization' && !!organization && organizationExceedsPlanSeatLimit(plan, organization);
let _selectedPlanPeriod = selectedPlanPeriod;
const isEligibleForSwitchToAnnual = Boolean(plan?.annualMonthlyFee);

Expand DownExpand Up@@ -279,11 +285,17 @@ export const usePlansContext = () => {
localizationKey: freeTrialOr(getLocalizationKey()),
variant: isCompact ? 'bordered' : 'solid',
colorScheme: isCompact ? 'secondary' : 'primary',
isDisabled: !canManageBilling,
disabled: !canManageBilling,
isDisabled: !canManageBilling || exceedsPlanSeatLimit,
disabled: !canManageBilling || exceedsPlanSeatLimit,
};
},
[activeOrUpcomingSubscriptionWithPlanPeriod, canManageBilling, subscriptionItems, topLevelSubscription],
[
activeOrUpcomingSubscriptionWithPlanPeriod,
canManageBilling,
subscriberType,
subscriptionItems,
topLevelSubscription,
],
);

const captionForSubscription = useCallback((subscription: BillingSubscriptionItemResource) => {
Expand Down
47 changes: 47 additions & 0 deletions packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
*/
export const getSeatUnitPrice = (plan: BillingPlanResource): BillingPlanUnitPrice | null => {
if (!plan.unitPrices?.length) {
return null;
}

const seatUnitPrice = plan.unitPrices.find(unitPrice => unitPrice.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
export const getPlanSeatLimit = (plan: BillingPlanResource): number | null | undefined => {
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice?.tiers.length) {
return undefined;
}

return seatUnitPrice.tiers[seatUnitPrice.tiers.length - 1]?.endsAfterBlock;
};

/**
* Given a plan and an organization, return true if the organization exceeds the seat limit for the plan.
*/
export const organizationExceedsPlanSeatLimit = (
plan: BillingPlanResource,
organization: OrganizationResource,
): boolean => {
const seatLimit = getPlanSeatLimit(plan);

if (seatLimit === undefined || seatLimit === null) {
return false;
}

return organization.membersCount + organization.pendingInvitationsCount > seatLimit;
};
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
2 changes: 2 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,8 @@ export const enUS: LocalizationResource = {
plansPage: {
alerts: {
noPermissionsToManageBilling: 'You do not have permissions to manage billing for this organization.',
planMembershipLimitExceeded:
'Your organization has {{count}} members (including pending invitations). This plan only allows {{limit}} members.',
},
title: 'Plans',
},
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1223,6 +1223,7 @@ export type __internal_LocalizationResource = {
title: LocalizationValue;
alerts: {
noPermissionsToManageBilling: LocalizationValue;
planMembershipLimitExceeded: LocalizationValue<'count' | 'limit'>;
};
};
apiKeysPage: {
Expand Down
29 changes: 21 additions & 8 deletions packages/ui/src/components/PricingTable/PricingTableDefault.tsx
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
import { __internal_useOrganizationBase, useClerk, useSession } from '@clerk/shared/react';
import type {
BillingPlanResource,
BillingPlanUnitPrice,
BillingSubscriptionPlanPeriod,
PricingTableProps,
BillingPlanUnitPrice,
} from '@clerk/shared/types';
import * as React from 'react';

import { Switch } from '@/ui/elements/Switch';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getPlanSeatLimit, getSeatUnitPrice, organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import { useProtect } from '../../common';
Expand DownExpand Up@@ -137,6 +138,22 @@ function Card(props: CardProps) {
[plan, planPeriod, activeOrUpcomingSubscriptionBasedOnPlanPeriod],
);

const footerButtonTooltipText = React.useMemo(() => {
if (isSignedIn && !canManageBilling) {
return localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling');
}

if (organization && subscriberType === 'organization' && organizationExceedsPlanSeatLimit(plan, organization)) {
const seatLimit = getPlanSeatLimit(plan);
return localizationKeys('organizationProfile.plansPage.alerts.planMembershipLimitExceeded', {
count: organization.membersCount + organization.pendingInvitationsCount,
limit: seatLimit as number,
});
}

return null;
}, [isSignedIn, canManageBilling, organization, subscriberType, plan]);

const hasFeatures = plan.features.length > 0;

const { shouldShowFooter, shouldShowFooterNotice } = getPricingFooterState({
Expand DownExpand Up@@ -247,17 +264,13 @@ function Card(props: CardProps) {
elementDescriptor={descriptors.pricingTableCardFooterButton}
block
textVariant={isCompact ? 'buttonSmall' : 'buttonLarge'}
{...buttonPropsForPlan({ plan, isCompact, selectedPlanPeriod: planPeriod })}
{...buttonPropsForPlan({ plan, organization, isCompact, selectedPlanPeriod: planPeriod })}
onClick={event => {
onSelect(plan, event);
}}
/>
</Tooltip.Trigger>
{isSignedIn && !canManageBilling && (
<Tooltip.Content
text={localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling')}
/>
)}
{footerButtonTooltipText ? <Tooltip.Content text={footerButtonTooltipText} /> : null}
</Tooltip.Root>
)}
</Box>
Expand DownExpand Up@@ -595,7 +608,7 @@ const CardFeaturesListSeatCost = ({ plan }: { plan: BillingPlanResource }) => {
return null;
}

const seatUnitPrice = unitPrices.find(unitPrice => unitPrice.name.toLowerCase() === 'seats') ?? unitPrices[0];
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice) {
return null;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,47 @@ describe('PricingTable - plans visibility', () => {
pathRoot: '',
reload: vi.fn(),
} as const;
const seatLimitedOrganizationPlan = {
...testPlan,
id: 'plan_org_target',
name: 'Organization Plan',
slug: 'organization-plan',
forPayerType: 'org',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_target_1',
startsAtBlock: 1,
endsAfterBlock: 20,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;
const currentOrganizationPlan = {
...seatLimitedOrganizationPlan,
id: 'plan_org_current',
name: 'Current Organization Plan',
slug: 'current-organization-plan',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_current_1',
startsAtBlock: 1,
endsAfterBlock: 50,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;

it('shows no plans when user is signed in but has no subscription', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
Expand DownExpand Up@@ -581,6 +622,128 @@ describe('PricingTable - plans visibility', () => {
});
});

it('disables switching to an organization plan when the active org exceeds its seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 4,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeDisabled();
});

it('keeps switching enabled when the active org is exactly at the plan seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 3,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeEnabled();
});

it('fetches user plans and renders when using for: user', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down
20 changes: 16 additions & 4 deletions packages/ui/src/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,12 @@ import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionPlanPeriod,
OrganizationResource,
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { Appearance } from '../../internal/appearance';
Expand DownExpand Up@@ -196,12 +198,14 @@ export const usePlansContext = () => {
const buttonPropsForPlan = useCallback(
({
plan,
organization,
// TODO(@COMMERCE): This needs to be removed.
subscription: sub,
isCompact = false,
selectedPlanPeriod = 'annual',
}: {
plan?: BillingPlanResource;
plan: BillingPlanResource;
organization?: OrganizationResource | null;
subscription?: BillingSubscriptionItemResource;
isCompact?: boolean;
selectedPlanPeriod?: BillingSubscriptionPlanPeriod;
Expand All@@ -214,6 +218,8 @@ export const usePlansContext = () => {
} => {
const subscription =
sub ?? (plan ? activeOrUpcomingSubscriptionWithPlanPeriod(plan, selectedPlanPeriod) : undefined);
const exceedsPlanSeatLimit =
subscriberType === 'organization' && !!organization && organizationExceedsPlanSeatLimit(plan, organization);
let _selectedPlanPeriod = selectedPlanPeriod;
const isEligibleForSwitchToAnnual = Boolean(plan?.annualMonthlyFee);

Expand DownExpand Up@@ -279,11 +285,17 @@ export const usePlansContext = () => {
localizationKey: freeTrialOr(getLocalizationKey()),
variant: isCompact ? 'bordered' : 'solid',
colorScheme: isCompact ? 'secondary' : 'primary',
isDisabled: !canManageBilling,
disabled: !canManageBilling,
isDisabled: !canManageBilling || exceedsPlanSeatLimit,
disabled: !canManageBilling || exceedsPlanSeatLimit,
};
},
[activeOrUpcomingSubscriptionWithPlanPeriod, canManageBilling, subscriptionItems, topLevelSubscription],
[
activeOrUpcomingSubscriptionWithPlanPeriod,
canManageBilling,
subscriberType,
subscriptionItems,
topLevelSubscription,
],
);

const captionForSubscription = useCallback((subscription: BillingSubscriptionItemResource) => {
Expand Down
47 changes: 47 additions & 0 deletions packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
*/
export const getSeatUnitPrice = (plan: BillingPlanResource): BillingPlanUnitPrice | null => {
if (!plan.unitPrices?.length) {
return null;
}

const seatUnitPrice = plan.unitPrices.find(unitPrice => unitPrice.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
export const getPlanSeatLimit = (plan: BillingPlanResource): number | null | undefined => {
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice?.tiers.length) {
return undefined;
}

return seatUnitPrice.tiers[seatUnitPrice.tiers.length - 1]?.endsAfterBlock;
};

/**
* Given a plan and an organization, return true if the organization exceeds the seat limit for the plan.
*/
export const organizationExceedsPlanSeatLimit = (
plan: BillingPlanResource,
organization: OrganizationResource,
): boolean => {
const seatLimit = getPlanSeatLimit(plan);

if (seatLimit === undefined || seatLimit === null) {
return false;
}

return organization.membersCount + organization.pendingInvitationsCount > seatLimit;
};
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
2 changes: 2 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,6 +433,8 @@ export const enUS: LocalizationResource = {
plansPage: {
alerts: {
noPermissionsToManageBilling: 'You do not have permissions to manage billing for this organization.',
planMembershipLimitExceeded:
'Your organization has {{count}} members (including pending invitations). This plan only allows {{limit}} members.',
},
title: 'Plans',
},
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1223,6 +1223,7 @@ export type __internal_LocalizationResource = {
title: LocalizationValue;
alerts: {
noPermissionsToManageBilling: LocalizationValue;
planMembershipLimitExceeded: LocalizationValue<'count' | 'limit'>;
};
};
apiKeysPage: {
Expand Down
29 changes: 21 additions & 8 deletions packages/ui/src/components/PricingTable/PricingTableDefault.tsx
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
import { __internal_useOrganizationBase, useClerk, useSession } from '@clerk/shared/react';
import type {
BillingPlanResource,
BillingPlanUnitPrice,
BillingSubscriptionPlanPeriod,
PricingTableProps,
BillingPlanUnitPrice,
} from '@clerk/shared/types';
import * as React from 'react';

import { Switch } from '@/ui/elements/Switch';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getPlanSeatLimit, getSeatUnitPrice, organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import { useProtect } from '../../common';
Expand DownExpand Up@@ -137,6 +138,22 @@ function Card(props: CardProps) {
[plan, planPeriod, activeOrUpcomingSubscriptionBasedOnPlanPeriod],
);

const footerButtonTooltipText = React.useMemo(() => {
if (isSignedIn && !canManageBilling) {
return localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling');
}

if (organization && subscriberType === 'organization' && organizationExceedsPlanSeatLimit(plan, organization)) {
const seatLimit = getPlanSeatLimit(plan);
return localizationKeys('organizationProfile.plansPage.alerts.planMembershipLimitExceeded', {
count: organization.membersCount + organization.pendingInvitationsCount,
limit: seatLimit as number,
});
}

return null;
}, [isSignedIn, canManageBilling, organization, subscriberType, plan]);

const hasFeatures = plan.features.length > 0;

const { shouldShowFooter, shouldShowFooterNotice } = getPricingFooterState({
Expand DownExpand Up@@ -247,17 +264,13 @@ function Card(props: CardProps) {
elementDescriptor={descriptors.pricingTableCardFooterButton}
block
textVariant={isCompact ? 'buttonSmall' : 'buttonLarge'}
{...buttonPropsForPlan({ plan, isCompact, selectedPlanPeriod: planPeriod })}
{...buttonPropsForPlan({ plan, organization, isCompact, selectedPlanPeriod: planPeriod })}
onClick={event => {
onSelect(plan, event);
}}
/>
</Tooltip.Trigger>
{isSignedIn && !canManageBilling && (
<Tooltip.Content
text={localizationKeys('organizationProfile.plansPage.alerts.noPermissionsToManageBilling')}
/>
)}
{footerButtonTooltipText ? <Tooltip.Content text={footerButtonTooltipText} /> : null}
</Tooltip.Root>
)}
</Box>
Expand DownExpand Up@@ -595,7 +608,7 @@ const CardFeaturesListSeatCost = ({ plan }: { plan: BillingPlanResource }) => {
return null;
}

const seatUnitPrice = unitPrices.find(unitPrice => unitPrice.name.toLowerCase() === 'seats') ?? unitPrices[0];
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice) {
return null;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,47 @@ describe('PricingTable - plans visibility', () => {
pathRoot: '',
reload: vi.fn(),
} as const;
const seatLimitedOrganizationPlan = {
...testPlan,
id: 'plan_org_target',
name: 'Organization Plan',
slug: 'organization-plan',
forPayerType: 'org',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_target_1',
startsAtBlock: 1,
endsAfterBlock: 20,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;
const currentOrganizationPlan = {
...seatLimitedOrganizationPlan,
id: 'plan_org_current',
name: 'Current Organization Plan',
slug: 'current-organization-plan',
unitPrices: [
{
name: 'seats',
blockSize: 1,
tiers: [
{
id: 'tier_org_current_1',
startsAtBlock: 1,
endsAfterBlock: 50,
feePerBlock: testPlan.fee,
},
],
},
],
} as const;

it('shows no plans when user is signed in but has no subscription', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
Expand DownExpand Up@@ -581,6 +622,128 @@ describe('PricingTable - plans visibility', () => {
});
});

it('disables switching to an organization plan when the active org exceeds its seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 4,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeDisabled();
});

it('keeps switching enabled when the active org is exactly at the plan seat limit', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withBilling();
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.com'],
organization_memberships: [
{
name: 'Org1',
permissions: ['org:sys_billing:manage'],
members_count: 17,
pending_invitations_count: 3,
},
],
});
});

props.setProps({ for: 'organization' } as any);

fixtures.clerk.billing.getStatements.mockRejectedValue();
fixtures.clerk.organization.getPaymentMethods.mockRejectedValue();
fixtures.clerk.billing.getPlans.mockResolvedValue({ data: [seatLimitedOrganizationPlan as any], total_count: 1 });
fixtures.clerk.billing.getSubscription.mockResolvedValue({
id: 'sub_org_active',
status: 'active',
activeAt: new Date('2021-01-01'),
createdAt: new Date('2021-01-01'),
nextPayment: null,
pastDueAt: null,
updatedAt: null,
subscriptionItems: [
{
id: 'si_org_active',
plan: currentOrganizationPlan,
createdAt: new Date('2021-01-01'),
paymentMethodId: 'src_1',
pastDueAt: null,
canceledAt: null,
periodStart: new Date('2021-01-01'),
periodEnd: new Date('2021-01-31'),
planPeriod: 'month' as const,
status: 'active' as const,
isFreeTrial: false,
cancel: vi.fn(),
pathRoot: '',
reload: vi.fn(),
},
],
pathRoot: '',
reload: vi.fn(),
});

const { getByRole } = render(<PricingTable />, { wrapper });

await waitFor(() => {
expect(getByRole('heading', { name: 'Organization Plan' })).toBeVisible();
});

expect(getByRole('button', { name: 'Switch to this plan' })).toBeEnabled();
});

it('fetches user plans and renders when using for: user', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down
20 changes: 16 additions & 4 deletions packages/ui/src/contexts/components/Plans.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,12 @@ import type {
BillingPlanResource,
BillingSubscriptionItemResource,
BillingSubscriptionPlanPeriod,
OrganizationResource,
} from '@clerk/shared/types';
import { useCallback, useMemo } from 'react';

import { useProtect } from '@/ui/common/Gate';
import { organizationExceedsPlanSeatLimit } from '@/ui/utils/billingPlanSeats';
import { getClosestProfileScrollBox } from '@/ui/utils/getClosestProfileScrollBox';

import type { Appearance } from '../../internal/appearance';
Expand DownExpand Up@@ -196,12 +198,14 @@ export const usePlansContext = () => {
const buttonPropsForPlan = useCallback(
({
plan,
organization,
// TODO(@COMMERCE): This needs to be removed.
subscription: sub,
isCompact = false,
selectedPlanPeriod = 'annual',
}: {
plan?: BillingPlanResource;
plan: BillingPlanResource;
organization?: OrganizationResource | null;
subscription?: BillingSubscriptionItemResource;
isCompact?: boolean;
selectedPlanPeriod?: BillingSubscriptionPlanPeriod;
Expand All@@ -214,6 +218,8 @@ export const usePlansContext = () => {
} => {
const subscription =
sub ?? (plan ? activeOrUpcomingSubscriptionWithPlanPeriod(plan, selectedPlanPeriod) : undefined);
const exceedsPlanSeatLimit =
subscriberType === 'organization' && !!organization && organizationExceedsPlanSeatLimit(plan, organization);
let _selectedPlanPeriod = selectedPlanPeriod;
const isEligibleForSwitchToAnnual = Boolean(plan?.annualMonthlyFee);

Expand DownExpand Up@@ -279,11 +285,17 @@ export const usePlansContext = () => {
localizationKey: freeTrialOr(getLocalizationKey()),
variant: isCompact ? 'bordered' : 'solid',
colorScheme: isCompact ? 'secondary' : 'primary',
isDisabled: !canManageBilling,
disabled: !canManageBilling,
isDisabled: !canManageBilling || exceedsPlanSeatLimit,
disabled: !canManageBilling || exceedsPlanSeatLimit,
};
},
[activeOrUpcomingSubscriptionWithPlanPeriod, canManageBilling, subscriptionItems, topLevelSubscription],
[
activeOrUpcomingSubscriptionWithPlanPeriod,
canManageBilling,
subscriberType,
subscriptionItems,
topLevelSubscription,
],
);

const captionForSubscription = useCallback((subscription: BillingSubscriptionItemResource) => {
Expand Down
47 changes: 47 additions & 0 deletions packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
*/
export const getSeatUnitPrice = (plan: BillingPlanResource): BillingPlanUnitPrice | null => {
if (!plan.unitPrices?.length) {
return null;
}

const seatUnitPrice = plan.unitPrices.find(unitPrice => unitPrice.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
export const getPlanSeatLimit = (plan: BillingPlanResource): number | null | undefined => {
const seatUnitPrice = getSeatUnitPrice(plan);

if (!seatUnitPrice?.tiers.length) {
return undefined;
}

return seatUnitPrice.tiers[seatUnitPrice.tiers.length - 1]?.endsAfterBlock;
};

/**
* Given a plan and an organization, return true if the organization exceeds the seat limit for the plan.
*/
export const organizationExceedsPlanSeatLimit = (
plan: BillingPlanResource,
organization: OrganizationResource,
): boolean => {
const seatLimit = getPlanSeatLimit(plan);

if (seatLimit === undefined || seatLimit === null) {
return false;
}

return organization.membersCount + organization.pendingInvitationsCount > seatLimit;
};
Loading