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
5 changes: 5 additions & 0 deletions .changeset/good-ads-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': minor
---

Add support for rendering per-seat costs in checkout
8 changes: 8 additions & 0 deletions .changeset/khaki-hairs-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Add support for total due per period to checkout
3 changes: 3 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
if ('total_due_now' in data) {
totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
}
if ('total_due_per_period' in data) {
totals.totalDuePerPeriod = billingMoneyAmountFromJSON(data.total_due_per_period);
}

if ('total_due_after_free_trial' in data) {
totals.totalDueAfterFreeTrial = data.total_due_after_free_trial
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
title__subscriptionSuccessful: 'Success!',
title__trialSuccess: 'Trial successfully started!',
totalDueAfterTrial: 'Total Due after trial ends in {{days}} days',
totalDuePerPeriod: 'Total Due per period',
},
credit: 'Credit',
prorationCredit: 'Prorated credit',
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -840,6 +840,10 @@ export interface BillingCheckoutTotals {
* The amount that needs to be immediately paid to complete the checkout.
*/
totalDueNow: BillingMoneyAmount;
/**
* The amount that will be charged per period for this subscription.
*/
totalDuePerPeriod: BillingMoneyAmount;
/**
* Any credits (like account balance or promo credits) that are being applied to the checkout.
*/
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -860,6 +860,7 @@ export interface BillingCheckoutTotalsJSON {
*/
per_unit_totals?: BillingPerUnitTotalJSON[];
total_due_now: BillingMoneyAmountJSON;
total_due_per_period: BillingMoneyAmountJSON;
credit: BillingMoneyAmountJSON | null;
credits: BillingCreditsJSON | null;
account_credit: BillingMoneyAmountJSON | null;
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -301,6 +301,7 @@ export type __internal_LocalizationResource = {
downgradeNotice: LocalizationValue;
pastDueNotice: LocalizationValue;
totalDueAfterTrial: LocalizationValue<'days'>;
totalDuePerPeriod: LocalizationValue;
perMonth: LocalizationValue;
};
};
Expand Down
39 changes: 36 additions & 3 deletions packages/ui/src/components/Checkout/CheckoutForm.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,12 @@ import { LineItems } from '@/ui/elements/LineItems';
import { SegmentedControl } from '@/ui/elements/SegmentedControl';
import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';
import {
getCheckoutSeatUnitTotal,
getIncludedSeatsUnitTotalTier,
getPaidSeatsUnitTotalTier,
getSeatUnitPrice,
} from '@/ui/utils/billingPlanSeats';
import { handleError } from '@/ui/utils/errorHandler';

import { DevOnly } from '../../common/DevOnly';
Expand DownExpand Up@@ -48,10 +53,21 @@ export const CheckoutForm = withCardStateProvider(() => {
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
plan.annualMonthlyFee!;

const descriptionElements = [];
const seatPerUnitTotal = getCheckoutSeatUnitTotal(totals);
const includedSeatsTier = getIncludedSeatsUnitTotalTier(seatPerUnitTotal);
const paidSeatsTier = getPaidSeatsUnitTotalTier(seatPerUnitTotal);

const descriptionElements: Array<ReturnType<typeof localizationKeys>> = [];
if (planPeriod === 'annual') {
descriptionElements.push(localizationKeys('billing.billedAnnually'));
}
if (includedSeatsTier && includedSeatsTier.quantity !== null) {
descriptionElements.push(
localizationKeys('billing.pricingTable.seatCost.includedSeats', {
includedSeats: includedSeatsTier.quantity,
}),
);
}
const seatUnitPrice = getSeatUnitPrice(plan);
if (seatUnitPrice && seatUnitPrice.tiers.length === 1 && seatUnitPrice.tiers[0].feePerBlock.amount === 0) {
descriptionElements.push(
Expand DownExpand Up@@ -91,6 +107,16 @@ export const CheckoutForm = withCardStateProvider(() => {
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
{paidSeatsTier && paidSeatsTier.quantity !== null && (
<LineItems.Group borderTop>
<LineItems.Title title={localizationKeys('billing.seats')} />
<LineItems.Description
prefix={`${paidSeatsTier.quantity} x`}
text={`${paidSeatsTier.feePerBlock.currencySymbol}${paidSeatsTier.feePerBlock.amountFormatted}`}
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand DownExpand Up@@ -129,7 +155,7 @@ export const CheckoutForm = withCardStateProvider(() => {
</LineItems.Group>
)}

{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial && (
{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial ? (
<LineItems.Group variant='tertiary'>
<LineItems.Title
title={localizationKeys('billing.checkout.totalDueAfterTrial', {
Expand All@@ -140,6 +166,13 @@ export const CheckoutForm = withCardStateProvider(() => {
text={`${totals.totalDueAfterFreeTrial.currencySymbol}${totals.totalDueAfterFreeTrial.amountFormatted}`}
/>
</LineItems.Group>
) : (
<LineItems.Group variant='tertiary'>
<LineItems.Title title={localizationKeys('billing.checkout.totalDuePerPeriod')} />
<LineItems.Description
text={`${totals.totalDuePerPeriod.currencySymbol}${totals.totalDuePerPeriod.amountFormatted}`}
/>
</LineItems.Group>
)}

<LineItems.Group borderTop>
Expand Down
1 change: 0 additions & 1 deletion packages/ui/src/elements/LineItems.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,6 @@ const Title = React.forwardRef<HTMLTableCellElement, TitleProps>(({ title, descr
<Span
sx={t => ({
display: 'inline-flex',
alignItems: 'center',
gap: t.space.$1,
})}
>
Expand Down
71 changes: 70 additions & 1 deletion packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';
import type {
BillingPerUnitTotal,
BillingPerUnitTotalTier,
BillingPlanResource,
BillingPlanUnitPrice,
OrganizationResource,
} from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
Expand All@@ -17,6 +23,69 @@ export const getSeatUnitPrice = (plan: { unitPrices?: BillingPlanUnitPrice[] }):
return null;
};

/**
* Similar to the above, given a checkout totals, return the unit price for seats.
*/
export const getCheckoutSeatUnitTotal = (checkout: {
perUnitTotals?: BillingPerUnitTotal[];
}): BillingPerUnitTotal | null => {
if (!checkout.perUnitTotals?.length) {
return null;
}

const seatUnitPrice = checkout.perUnitTotals.find(unitTotal => unitTotal.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents per-seat costs. If no tier is found, return null.
*/
export const getPaidSeatsUnitTotalTier = (unitTotal: BillingPerUnitTotal | null): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (unitTotal.tiers.length === 1 && unitTotal.tiers[0].feePerBlock.amount > 0) {
return unitTotal.tiers[0];
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[1];
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents included seats. If no tier is found, return null.
*/
export const getIncludedSeatsUnitTotalTier = (
unitTotal: BillingPerUnitTotal | null,
): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[0];
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(ui): Add per-seat costs to checkout totals by dstaley · Pull Request #8464 · clerk/javascript · GitHub
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
5 changes: 5 additions & 0 deletions .changeset/good-ads-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': minor
---

Add support for rendering per-seat costs in checkout
8 changes: 8 additions & 0 deletions .changeset/khaki-hairs-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Add support for total due per period to checkout
3 changes: 3 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
if ('total_due_now' in data) {
totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
}
if ('total_due_per_period' in data) {
totals.totalDuePerPeriod = billingMoneyAmountFromJSON(data.total_due_per_period);
}

if ('total_due_after_free_trial' in data) {
totals.totalDueAfterFreeTrial = data.total_due_after_free_trial
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
title__subscriptionSuccessful: 'Success!',
title__trialSuccess: 'Trial successfully started!',
totalDueAfterTrial: 'Total Due after trial ends in {{days}} days',
totalDuePerPeriod: 'Total Due per period',
},
credit: 'Credit',
prorationCredit: 'Prorated credit',
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -840,6 +840,10 @@ export interface BillingCheckoutTotals {
* The amount that needs to be immediately paid to complete the checkout.
*/
totalDueNow: BillingMoneyAmount;
/**
* The amount that will be charged per period for this subscription.
*/
totalDuePerPeriod: BillingMoneyAmount;
/**
* Any credits (like account balance or promo credits) that are being applied to the checkout.
*/
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -860,6 +860,7 @@ export interface BillingCheckoutTotalsJSON {
*/
per_unit_totals?: BillingPerUnitTotalJSON[];
total_due_now: BillingMoneyAmountJSON;
total_due_per_period: BillingMoneyAmountJSON;
credit: BillingMoneyAmountJSON | null;
credits: BillingCreditsJSON | null;
account_credit: BillingMoneyAmountJSON | null;
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -301,6 +301,7 @@ export type __internal_LocalizationResource = {
downgradeNotice: LocalizationValue;
pastDueNotice: LocalizationValue;
totalDueAfterTrial: LocalizationValue<'days'>;
totalDuePerPeriod: LocalizationValue;
perMonth: LocalizationValue;
};
};
Expand Down
39 changes: 36 additions & 3 deletions packages/ui/src/components/Checkout/CheckoutForm.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,12 @@ import { LineItems } from '@/ui/elements/LineItems';
import { SegmentedControl } from '@/ui/elements/SegmentedControl';
import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';
import {
getCheckoutSeatUnitTotal,
getIncludedSeatsUnitTotalTier,
getPaidSeatsUnitTotalTier,
getSeatUnitPrice,
} from '@/ui/utils/billingPlanSeats';
import { handleError } from '@/ui/utils/errorHandler';

import { DevOnly } from '../../common/DevOnly';
Expand DownExpand Up@@ -48,10 +53,21 @@ export const CheckoutForm = withCardStateProvider(() => {
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
plan.annualMonthlyFee!;

const descriptionElements = [];
const seatPerUnitTotal = getCheckoutSeatUnitTotal(totals);
const includedSeatsTier = getIncludedSeatsUnitTotalTier(seatPerUnitTotal);
const paidSeatsTier = getPaidSeatsUnitTotalTier(seatPerUnitTotal);

const descriptionElements: Array<ReturnType<typeof localizationKeys>> = [];
if (planPeriod === 'annual') {
descriptionElements.push(localizationKeys('billing.billedAnnually'));
}
if (includedSeatsTier && includedSeatsTier.quantity !== null) {
descriptionElements.push(
localizationKeys('billing.pricingTable.seatCost.includedSeats', {
includedSeats: includedSeatsTier.quantity,
}),
);
}
const seatUnitPrice = getSeatUnitPrice(plan);
if (seatUnitPrice && seatUnitPrice.tiers.length === 1 && seatUnitPrice.tiers[0].feePerBlock.amount === 0) {
descriptionElements.push(
Expand DownExpand Up@@ -91,6 +107,16 @@ export const CheckoutForm = withCardStateProvider(() => {
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
{paidSeatsTier && paidSeatsTier.quantity !== null && (
<LineItems.Group borderTop>
<LineItems.Title title={localizationKeys('billing.seats')} />
<LineItems.Description
prefix={`${paidSeatsTier.quantity} x`}
text={`${paidSeatsTier.feePerBlock.currencySymbol}${paidSeatsTier.feePerBlock.amountFormatted}`}
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand DownExpand Up@@ -129,7 +155,7 @@ export const CheckoutForm = withCardStateProvider(() => {
</LineItems.Group>
)}

{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial && (
{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial ? (
<LineItems.Group variant='tertiary'>
<LineItems.Title
title={localizationKeys('billing.checkout.totalDueAfterTrial', {
Expand All@@ -140,6 +166,13 @@ export const CheckoutForm = withCardStateProvider(() => {
text={`${totals.totalDueAfterFreeTrial.currencySymbol}${totals.totalDueAfterFreeTrial.amountFormatted}`}
/>
</LineItems.Group>
) : (
<LineItems.Group variant='tertiary'>
<LineItems.Title title={localizationKeys('billing.checkout.totalDuePerPeriod')} />
<LineItems.Description
text={`${totals.totalDuePerPeriod.currencySymbol}${totals.totalDuePerPeriod.amountFormatted}`}
/>
</LineItems.Group>
)}

<LineItems.Group borderTop>
Expand Down
1 change: 0 additions & 1 deletion packages/ui/src/elements/LineItems.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,6 @@ const Title = React.forwardRef<HTMLTableCellElement, TitleProps>(({ title, descr
<Span
sx={t => ({
display: 'inline-flex',
alignItems: 'center',
gap: t.space.$1,
})}
>
Expand Down
71 changes: 70 additions & 1 deletion packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';
import type {
BillingPerUnitTotal,
BillingPerUnitTotalTier,
BillingPlanResource,
BillingPlanUnitPrice,
OrganizationResource,
} from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
Expand All@@ -17,6 +23,69 @@ export const getSeatUnitPrice = (plan: { unitPrices?: BillingPlanUnitPrice[] }):
return null;
};

/**
* Similar to the above, given a checkout totals, return the unit price for seats.
*/
export const getCheckoutSeatUnitTotal = (checkout: {
perUnitTotals?: BillingPerUnitTotal[];
}): BillingPerUnitTotal | null => {
if (!checkout.perUnitTotals?.length) {
return null;
}

const seatUnitPrice = checkout.perUnitTotals.find(unitTotal => unitTotal.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents per-seat costs. If no tier is found, return null.
*/
export const getPaidSeatsUnitTotalTier = (unitTotal: BillingPerUnitTotal | null): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (unitTotal.tiers.length === 1 && unitTotal.tiers[0].feePerBlock.amount > 0) {
return unitTotal.tiers[0];
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[1];
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents included seats. If no tier is found, return null.
*/
export const getIncludedSeatsUnitTotalTier = (
unitTotal: BillingPerUnitTotal | null,
): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[0];
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(ui): Add per-seat costs to checkout totals by dstaley · Pull Request #8464 · clerk/javascript · GitHub
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
5 changes: 5 additions & 0 deletions .changeset/good-ads-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': minor
---

Add support for rendering per-seat costs in checkout
8 changes: 8 additions & 0 deletions .changeset/khaki-hairs-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Add support for total due per period to checkout
3 changes: 3 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
if ('total_due_now' in data) {
totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
}
if ('total_due_per_period' in data) {
totals.totalDuePerPeriod = billingMoneyAmountFromJSON(data.total_due_per_period);
}

if ('total_due_after_free_trial' in data) {
totals.totalDueAfterFreeTrial = data.total_due_after_free_trial
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
title__subscriptionSuccessful: 'Success!',
title__trialSuccess: 'Trial successfully started!',
totalDueAfterTrial: 'Total Due after trial ends in {{days}} days',
totalDuePerPeriod: 'Total Due per period',
},
credit: 'Credit',
prorationCredit: 'Prorated credit',
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -840,6 +840,10 @@ export interface BillingCheckoutTotals {
* The amount that needs to be immediately paid to complete the checkout.
*/
totalDueNow: BillingMoneyAmount;
/**
* The amount that will be charged per period for this subscription.
*/
totalDuePerPeriod: BillingMoneyAmount;
/**
* Any credits (like account balance or promo credits) that are being applied to the checkout.
*/
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -860,6 +860,7 @@ export interface BillingCheckoutTotalsJSON {
*/
per_unit_totals?: BillingPerUnitTotalJSON[];
total_due_now: BillingMoneyAmountJSON;
total_due_per_period: BillingMoneyAmountJSON;
credit: BillingMoneyAmountJSON | null;
credits: BillingCreditsJSON | null;
account_credit: BillingMoneyAmountJSON | null;
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -301,6 +301,7 @@ export type __internal_LocalizationResource = {
downgradeNotice: LocalizationValue;
pastDueNotice: LocalizationValue;
totalDueAfterTrial: LocalizationValue<'days'>;
totalDuePerPeriod: LocalizationValue;
perMonth: LocalizationValue;
};
};
Expand Down
39 changes: 36 additions & 3 deletions packages/ui/src/components/Checkout/CheckoutForm.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,12 @@ import { LineItems } from '@/ui/elements/LineItems';
import { SegmentedControl } from '@/ui/elements/SegmentedControl';
import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';
import {
getCheckoutSeatUnitTotal,
getIncludedSeatsUnitTotalTier,
getPaidSeatsUnitTotalTier,
getSeatUnitPrice,
} from '@/ui/utils/billingPlanSeats';
import { handleError } from '@/ui/utils/errorHandler';

import { DevOnly } from '../../common/DevOnly';
Expand DownExpand Up@@ -48,10 +53,21 @@ export const CheckoutForm = withCardStateProvider(() => {
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
plan.annualMonthlyFee!;

const descriptionElements = [];
const seatPerUnitTotal = getCheckoutSeatUnitTotal(totals);
const includedSeatsTier = getIncludedSeatsUnitTotalTier(seatPerUnitTotal);
const paidSeatsTier = getPaidSeatsUnitTotalTier(seatPerUnitTotal);

const descriptionElements: Array<ReturnType<typeof localizationKeys>> = [];
if (planPeriod === 'annual') {
descriptionElements.push(localizationKeys('billing.billedAnnually'));
}
if (includedSeatsTier && includedSeatsTier.quantity !== null) {
descriptionElements.push(
localizationKeys('billing.pricingTable.seatCost.includedSeats', {
includedSeats: includedSeatsTier.quantity,
}),
);
}
const seatUnitPrice = getSeatUnitPrice(plan);
if (seatUnitPrice && seatUnitPrice.tiers.length === 1 && seatUnitPrice.tiers[0].feePerBlock.amount === 0) {
descriptionElements.push(
Expand DownExpand Up@@ -91,6 +107,16 @@ export const CheckoutForm = withCardStateProvider(() => {
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
{paidSeatsTier && paidSeatsTier.quantity !== null && (
<LineItems.Group borderTop>
<LineItems.Title title={localizationKeys('billing.seats')} />
<LineItems.Description
prefix={`${paidSeatsTier.quantity} x`}
text={`${paidSeatsTier.feePerBlock.currencySymbol}${paidSeatsTier.feePerBlock.amountFormatted}`}
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand DownExpand Up@@ -129,7 +155,7 @@ export const CheckoutForm = withCardStateProvider(() => {
</LineItems.Group>
)}

{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial && (
{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial ? (
<LineItems.Group variant='tertiary'>
<LineItems.Title
title={localizationKeys('billing.checkout.totalDueAfterTrial', {
Expand All@@ -140,6 +166,13 @@ export const CheckoutForm = withCardStateProvider(() => {
text={`${totals.totalDueAfterFreeTrial.currencySymbol}${totals.totalDueAfterFreeTrial.amountFormatted}`}
/>
</LineItems.Group>
) : (
<LineItems.Group variant='tertiary'>
<LineItems.Title title={localizationKeys('billing.checkout.totalDuePerPeriod')} />
<LineItems.Description
text={`${totals.totalDuePerPeriod.currencySymbol}${totals.totalDuePerPeriod.amountFormatted}`}
/>
</LineItems.Group>
)}

<LineItems.Group borderTop>
Expand Down
1 change: 0 additions & 1 deletion packages/ui/src/elements/LineItems.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,6 @@ const Title = React.forwardRef<HTMLTableCellElement, TitleProps>(({ title, descr
<Span
sx={t => ({
display: 'inline-flex',
alignItems: 'center',
gap: t.space.$1,
})}
>
Expand Down
71 changes: 70 additions & 1 deletion packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';
import type {
BillingPerUnitTotal,
BillingPerUnitTotalTier,
BillingPlanResource,
BillingPlanUnitPrice,
OrganizationResource,
} from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
Expand All@@ -17,6 +23,69 @@ export const getSeatUnitPrice = (plan: { unitPrices?: BillingPlanUnitPrice[] }):
return null;
};

/**
* Similar to the above, given a checkout totals, return the unit price for seats.
*/
export const getCheckoutSeatUnitTotal = (checkout: {
perUnitTotals?: BillingPerUnitTotal[];
}): BillingPerUnitTotal | null => {
if (!checkout.perUnitTotals?.length) {
return null;
}

const seatUnitPrice = checkout.perUnitTotals.find(unitTotal => unitTotal.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents per-seat costs. If no tier is found, return null.
*/
export const getPaidSeatsUnitTotalTier = (unitTotal: BillingPerUnitTotal | null): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (unitTotal.tiers.length === 1 && unitTotal.tiers[0].feePerBlock.amount > 0) {
return unitTotal.tiers[0];
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[1];
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents included seats. If no tier is found, return null.
*/
export const getIncludedSeatsUnitTotalTier = (
unitTotal: BillingPerUnitTotal | null,
): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[0];
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(ui): Add per-seat costs to checkout totals by dstaley · Pull Request #8464 · clerk/javascript · GitHub
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
5 changes: 5 additions & 0 deletions .changeset/good-ads-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': minor
---

Add support for rendering per-seat costs in checkout
8 changes: 8 additions & 0 deletions .changeset/khaki-hairs-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Add support for total due per period to checkout
3 changes: 3 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
if ('total_due_now' in data) {
totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
}
if ('total_due_per_period' in data) {
totals.totalDuePerPeriod = billingMoneyAmountFromJSON(data.total_due_per_period);
}

if ('total_due_after_free_trial' in data) {
totals.totalDueAfterFreeTrial = data.total_due_after_free_trial
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
title__subscriptionSuccessful: 'Success!',
title__trialSuccess: 'Trial successfully started!',
totalDueAfterTrial: 'Total Due after trial ends in {{days}} days',
totalDuePerPeriod: 'Total Due per period',
},
credit: 'Credit',
prorationCredit: 'Prorated credit',
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -840,6 +840,10 @@ export interface BillingCheckoutTotals {
* The amount that needs to be immediately paid to complete the checkout.
*/
totalDueNow: BillingMoneyAmount;
/**
* The amount that will be charged per period for this subscription.
*/
totalDuePerPeriod: BillingMoneyAmount;
/**
* Any credits (like account balance or promo credits) that are being applied to the checkout.
*/
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -860,6 +860,7 @@ export interface BillingCheckoutTotalsJSON {
*/
per_unit_totals?: BillingPerUnitTotalJSON[];
total_due_now: BillingMoneyAmountJSON;
total_due_per_period: BillingMoneyAmountJSON;
credit: BillingMoneyAmountJSON | null;
credits: BillingCreditsJSON | null;
account_credit: BillingMoneyAmountJSON | null;
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -301,6 +301,7 @@ export type __internal_LocalizationResource = {
downgradeNotice: LocalizationValue;
pastDueNotice: LocalizationValue;
totalDueAfterTrial: LocalizationValue<'days'>;
totalDuePerPeriod: LocalizationValue;
perMonth: LocalizationValue;
};
};
Expand Down
39 changes: 36 additions & 3 deletions packages/ui/src/components/Checkout/CheckoutForm.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,12 @@ import { LineItems } from '@/ui/elements/LineItems';
import { SegmentedControl } from '@/ui/elements/SegmentedControl';
import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';
import {
getCheckoutSeatUnitTotal,
getIncludedSeatsUnitTotalTier,
getPaidSeatsUnitTotalTier,
getSeatUnitPrice,
} from '@/ui/utils/billingPlanSeats';
import { handleError } from '@/ui/utils/errorHandler';

import { DevOnly } from '../../common/DevOnly';
Expand DownExpand Up@@ -48,10 +53,21 @@ export const CheckoutForm = withCardStateProvider(() => {
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
plan.annualMonthlyFee!;

const descriptionElements = [];
const seatPerUnitTotal = getCheckoutSeatUnitTotal(totals);
const includedSeatsTier = getIncludedSeatsUnitTotalTier(seatPerUnitTotal);
const paidSeatsTier = getPaidSeatsUnitTotalTier(seatPerUnitTotal);

const descriptionElements: Array<ReturnType<typeof localizationKeys>> = [];
if (planPeriod === 'annual') {
descriptionElements.push(localizationKeys('billing.billedAnnually'));
}
if (includedSeatsTier && includedSeatsTier.quantity !== null) {
descriptionElements.push(
localizationKeys('billing.pricingTable.seatCost.includedSeats', {
includedSeats: includedSeatsTier.quantity,
}),
);
}
const seatUnitPrice = getSeatUnitPrice(plan);
if (seatUnitPrice && seatUnitPrice.tiers.length === 1 && seatUnitPrice.tiers[0].feePerBlock.amount === 0) {
descriptionElements.push(
Expand DownExpand Up@@ -91,6 +107,16 @@ export const CheckoutForm = withCardStateProvider(() => {
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
{paidSeatsTier && paidSeatsTier.quantity !== null && (
<LineItems.Group borderTop>
<LineItems.Title title={localizationKeys('billing.seats')} />
<LineItems.Description
prefix={`${paidSeatsTier.quantity} x`}
text={`${paidSeatsTier.feePerBlock.currencySymbol}${paidSeatsTier.feePerBlock.amountFormatted}`}
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand DownExpand Up@@ -129,7 +155,7 @@ export const CheckoutForm = withCardStateProvider(() => {
</LineItems.Group>
)}

{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial && (
{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial ? (
<LineItems.Group variant='tertiary'>
<LineItems.Title
title={localizationKeys('billing.checkout.totalDueAfterTrial', {
Expand All@@ -140,6 +166,13 @@ export const CheckoutForm = withCardStateProvider(() => {
text={`${totals.totalDueAfterFreeTrial.currencySymbol}${totals.totalDueAfterFreeTrial.amountFormatted}`}
/>
</LineItems.Group>
) : (
<LineItems.Group variant='tertiary'>
<LineItems.Title title={localizationKeys('billing.checkout.totalDuePerPeriod')} />
<LineItems.Description
text={`${totals.totalDuePerPeriod.currencySymbol}${totals.totalDuePerPeriod.amountFormatted}`}
/>
</LineItems.Group>
)}

<LineItems.Group borderTop>
Expand Down
1 change: 0 additions & 1 deletion packages/ui/src/elements/LineItems.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,6 @@ const Title = React.forwardRef<HTMLTableCellElement, TitleProps>(({ title, descr
<Span
sx={t => ({
display: 'inline-flex',
alignItems: 'center',
gap: t.space.$1,
})}
>
Expand Down
71 changes: 70 additions & 1 deletion packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';
import type {
BillingPerUnitTotal,
BillingPerUnitTotalTier,
BillingPlanResource,
BillingPlanUnitPrice,
OrganizationResource,
} from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
Expand All@@ -17,6 +23,69 @@ export const getSeatUnitPrice = (plan: { unitPrices?: BillingPlanUnitPrice[] }):
return null;
};

/**
* Similar to the above, given a checkout totals, return the unit price for seats.
*/
export const getCheckoutSeatUnitTotal = (checkout: {
perUnitTotals?: BillingPerUnitTotal[];
}): BillingPerUnitTotal | null => {
if (!checkout.perUnitTotals?.length) {
return null;
}

const seatUnitPrice = checkout.perUnitTotals.find(unitTotal => unitTotal.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents per-seat costs. If no tier is found, return null.
*/
export const getPaidSeatsUnitTotalTier = (unitTotal: BillingPerUnitTotal | null): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (unitTotal.tiers.length === 1 && unitTotal.tiers[0].feePerBlock.amount > 0) {
return unitTotal.tiers[0];
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[1];
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents included seats. If no tier is found, return null.
*/
export const getIncludedSeatsUnitTotalTier = (
unitTotal: BillingPerUnitTotal | null,
): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[0];
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat(ui): Add per-seat costs to checkout totals by dstaley · Pull Request #8464 · clerk/javascript · GitHub
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
5 changes: 5 additions & 0 deletions .changeset/good-ads-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': minor
---

Add support for rendering per-seat costs in checkout
8 changes: 8 additions & 0 deletions .changeset/khaki-hairs-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Add support for total due per period to checkout
3 changes: 3 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
if ('total_due_now' in data) {
totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
}
if ('total_due_per_period' in data) {
totals.totalDuePerPeriod = billingMoneyAmountFromJSON(data.total_due_per_period);
}

if ('total_due_after_free_trial' in data) {
totals.totalDueAfterFreeTrial = data.total_due_after_free_trial
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
title__subscriptionSuccessful: 'Success!',
title__trialSuccess: 'Trial successfully started!',
totalDueAfterTrial: 'Total Due after trial ends in {{days}} days',
totalDuePerPeriod: 'Total Due per period',
},
credit: 'Credit',
prorationCredit: 'Prorated credit',
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -840,6 +840,10 @@ export interface BillingCheckoutTotals {
* The amount that needs to be immediately paid to complete the checkout.
*/
totalDueNow: BillingMoneyAmount;
/**
* The amount that will be charged per period for this subscription.
*/
totalDuePerPeriod: BillingMoneyAmount;
/**
* Any credits (like account balance or promo credits) that are being applied to the checkout.
*/
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -860,6 +860,7 @@ export interface BillingCheckoutTotalsJSON {
*/
per_unit_totals?: BillingPerUnitTotalJSON[];
total_due_now: BillingMoneyAmountJSON;
total_due_per_period: BillingMoneyAmountJSON;
credit: BillingMoneyAmountJSON | null;
credits: BillingCreditsJSON | null;
account_credit: BillingMoneyAmountJSON | null;
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -301,6 +301,7 @@ export type __internal_LocalizationResource = {
downgradeNotice: LocalizationValue;
pastDueNotice: LocalizationValue;
totalDueAfterTrial: LocalizationValue<'days'>;
totalDuePerPeriod: LocalizationValue;
perMonth: LocalizationValue;
};
};
Expand Down
39 changes: 36 additions & 3 deletions packages/ui/src/components/Checkout/CheckoutForm.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,12 @@ import { LineItems } from '@/ui/elements/LineItems';
import { SegmentedControl } from '@/ui/elements/SegmentedControl';
import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';
import {
getCheckoutSeatUnitTotal,
getIncludedSeatsUnitTotalTier,
getPaidSeatsUnitTotalTier,
getSeatUnitPrice,
} from '@/ui/utils/billingPlanSeats';
import { handleError } from '@/ui/utils/errorHandler';

import { DevOnly } from '../../common/DevOnly';
Expand DownExpand Up@@ -48,10 +53,21 @@ export const CheckoutForm = withCardStateProvider(() => {
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
plan.annualMonthlyFee!;

const descriptionElements = [];
const seatPerUnitTotal = getCheckoutSeatUnitTotal(totals);
const includedSeatsTier = getIncludedSeatsUnitTotalTier(seatPerUnitTotal);
const paidSeatsTier = getPaidSeatsUnitTotalTier(seatPerUnitTotal);

const descriptionElements: Array<ReturnType<typeof localizationKeys>> = [];
if (planPeriod === 'annual') {
descriptionElements.push(localizationKeys('billing.billedAnnually'));
}
if (includedSeatsTier && includedSeatsTier.quantity !== null) {
descriptionElements.push(
localizationKeys('billing.pricingTable.seatCost.includedSeats', {
includedSeats: includedSeatsTier.quantity,
}),
);
}
const seatUnitPrice = getSeatUnitPrice(plan);
if (seatUnitPrice && seatUnitPrice.tiers.length === 1 && seatUnitPrice.tiers[0].feePerBlock.amount === 0) {
descriptionElements.push(
Expand DownExpand Up@@ -91,6 +107,16 @@ export const CheckoutForm = withCardStateProvider(() => {
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
{paidSeatsTier && paidSeatsTier.quantity !== null && (
<LineItems.Group borderTop>
<LineItems.Title title={localizationKeys('billing.seats')} />
<LineItems.Description
prefix={`${paidSeatsTier.quantity} x`}
text={`${paidSeatsTier.feePerBlock.currencySymbol}${paidSeatsTier.feePerBlock.amountFormatted}`}
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand DownExpand Up@@ -129,7 +155,7 @@ export const CheckoutForm = withCardStateProvider(() => {
</LineItems.Group>
)}

{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial && (
{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial ? (
<LineItems.Group variant='tertiary'>
<LineItems.Title
title={localizationKeys('billing.checkout.totalDueAfterTrial', {
Expand All@@ -140,6 +166,13 @@ export const CheckoutForm = withCardStateProvider(() => {
text={`${totals.totalDueAfterFreeTrial.currencySymbol}${totals.totalDueAfterFreeTrial.amountFormatted}`}
/>
</LineItems.Group>
) : (
<LineItems.Group variant='tertiary'>
<LineItems.Title title={localizationKeys('billing.checkout.totalDuePerPeriod')} />
<LineItems.Description
text={`${totals.totalDuePerPeriod.currencySymbol}${totals.totalDuePerPeriod.amountFormatted}`}
/>
</LineItems.Group>
)}

<LineItems.Group borderTop>
Expand Down
1 change: 0 additions & 1 deletion packages/ui/src/elements/LineItems.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,6 @@ const Title = React.forwardRef<HTMLTableCellElement, TitleProps>(({ title, descr
<Span
sx={t => ({
display: 'inline-flex',
alignItems: 'center',
gap: t.space.$1,
})}
>
Expand Down
71 changes: 70 additions & 1 deletion packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';
import type {
BillingPerUnitTotal,
BillingPerUnitTotalTier,
BillingPlanResource,
BillingPlanUnitPrice,
OrganizationResource,
} from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
Expand All@@ -17,6 +23,69 @@ export const getSeatUnitPrice = (plan: { unitPrices?: BillingPlanUnitPrice[] }):
return null;
};

/**
* Similar to the above, given a checkout totals, return the unit price for seats.
*/
export const getCheckoutSeatUnitTotal = (checkout: {
perUnitTotals?: BillingPerUnitTotal[];
}): BillingPerUnitTotal | null => {
if (!checkout.perUnitTotals?.length) {
return null;
}

const seatUnitPrice = checkout.perUnitTotals.find(unitTotal => unitTotal.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents per-seat costs. If no tier is found, return null.
*/
export const getPaidSeatsUnitTotalTier = (unitTotal: BillingPerUnitTotal | null): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (unitTotal.tiers.length === 1 && unitTotal.tiers[0].feePerBlock.amount > 0) {
return unitTotal.tiers[0];
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[1];
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents included seats. If no tier is found, return null.
*/
export const getIncludedSeatsUnitTotalTier = (
unitTotal: BillingPerUnitTotal | null,
): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[0];
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(ui): Add per-seat costs to checkout totals by dstaley · Pull Request #8464 · clerk/javascript · GitHub
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
5 changes: 5 additions & 0 deletions .changeset/good-ads-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': minor
---

Add support for rendering per-seat costs in checkout
8 changes: 8 additions & 0 deletions .changeset/khaki-hairs-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Add support for total due per period to checkout
3 changes: 3 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
if ('total_due_now' in data) {
totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
}
if ('total_due_per_period' in data) {
totals.totalDuePerPeriod = billingMoneyAmountFromJSON(data.total_due_per_period);
}

if ('total_due_after_free_trial' in data) {
totals.totalDueAfterFreeTrial = data.total_due_after_free_trial
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
title__subscriptionSuccessful: 'Success!',
title__trialSuccess: 'Trial successfully started!',
totalDueAfterTrial: 'Total Due after trial ends in {{days}} days',
totalDuePerPeriod: 'Total Due per period',
},
credit: 'Credit',
prorationCredit: 'Prorated credit',
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -840,6 +840,10 @@ export interface BillingCheckoutTotals {
* The amount that needs to be immediately paid to complete the checkout.
*/
totalDueNow: BillingMoneyAmount;
/**
* The amount that will be charged per period for this subscription.
*/
totalDuePerPeriod: BillingMoneyAmount;
/**
* Any credits (like account balance or promo credits) that are being applied to the checkout.
*/
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -860,6 +860,7 @@ export interface BillingCheckoutTotalsJSON {
*/
per_unit_totals?: BillingPerUnitTotalJSON[];
total_due_now: BillingMoneyAmountJSON;
total_due_per_period: BillingMoneyAmountJSON;
credit: BillingMoneyAmountJSON | null;
credits: BillingCreditsJSON | null;
account_credit: BillingMoneyAmountJSON | null;
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -301,6 +301,7 @@ export type __internal_LocalizationResource = {
downgradeNotice: LocalizationValue;
pastDueNotice: LocalizationValue;
totalDueAfterTrial: LocalizationValue<'days'>;
totalDuePerPeriod: LocalizationValue;
perMonth: LocalizationValue;
};
};
Expand Down
39 changes: 36 additions & 3 deletions packages/ui/src/components/Checkout/CheckoutForm.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,12 @@ import { LineItems } from '@/ui/elements/LineItems';
import { SegmentedControl } from '@/ui/elements/SegmentedControl';
import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';
import {
getCheckoutSeatUnitTotal,
getIncludedSeatsUnitTotalTier,
getPaidSeatsUnitTotalTier,
getSeatUnitPrice,
} from '@/ui/utils/billingPlanSeats';
import { handleError } from '@/ui/utils/errorHandler';

import { DevOnly } from '../../common/DevOnly';
Expand DownExpand Up@@ -48,10 +53,21 @@ export const CheckoutForm = withCardStateProvider(() => {
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
plan.annualMonthlyFee!;

const descriptionElements = [];
const seatPerUnitTotal = getCheckoutSeatUnitTotal(totals);
const includedSeatsTier = getIncludedSeatsUnitTotalTier(seatPerUnitTotal);
const paidSeatsTier = getPaidSeatsUnitTotalTier(seatPerUnitTotal);

const descriptionElements: Array<ReturnType<typeof localizationKeys>> = [];
if (planPeriod === 'annual') {
descriptionElements.push(localizationKeys('billing.billedAnnually'));
}
if (includedSeatsTier && includedSeatsTier.quantity !== null) {
descriptionElements.push(
localizationKeys('billing.pricingTable.seatCost.includedSeats', {
includedSeats: includedSeatsTier.quantity,
}),
);
}
const seatUnitPrice = getSeatUnitPrice(plan);
if (seatUnitPrice && seatUnitPrice.tiers.length === 1 && seatUnitPrice.tiers[0].feePerBlock.amount === 0) {
descriptionElements.push(
Expand DownExpand Up@@ -91,6 +107,16 @@ export const CheckoutForm = withCardStateProvider(() => {
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
{paidSeatsTier && paidSeatsTier.quantity !== null && (
<LineItems.Group borderTop>
<LineItems.Title title={localizationKeys('billing.seats')} />
<LineItems.Description
prefix={`${paidSeatsTier.quantity} x`}
text={`${paidSeatsTier.feePerBlock.currencySymbol}${paidSeatsTier.feePerBlock.amountFormatted}`}
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand DownExpand Up@@ -129,7 +155,7 @@ export const CheckoutForm = withCardStateProvider(() => {
</LineItems.Group>
)}

{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial && (
{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial ? (
<LineItems.Group variant='tertiary'>
<LineItems.Title
title={localizationKeys('billing.checkout.totalDueAfterTrial', {
Expand All@@ -140,6 +166,13 @@ export const CheckoutForm = withCardStateProvider(() => {
text={`${totals.totalDueAfterFreeTrial.currencySymbol}${totals.totalDueAfterFreeTrial.amountFormatted}`}
/>
</LineItems.Group>
) : (
<LineItems.Group variant='tertiary'>
<LineItems.Title title={localizationKeys('billing.checkout.totalDuePerPeriod')} />
<LineItems.Description
text={`${totals.totalDuePerPeriod.currencySymbol}${totals.totalDuePerPeriod.amountFormatted}`}
/>
</LineItems.Group>
)}

<LineItems.Group borderTop>
Expand Down
1 change: 0 additions & 1 deletion packages/ui/src/elements/LineItems.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,6 @@ const Title = React.forwardRef<HTMLTableCellElement, TitleProps>(({ title, descr
<Span
sx={t => ({
display: 'inline-flex',
alignItems: 'center',
gap: t.space.$1,
})}
>
Expand Down
71 changes: 70 additions & 1 deletion packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';
import type {
BillingPerUnitTotal,
BillingPerUnitTotalTier,
BillingPlanResource,
BillingPlanUnitPrice,
OrganizationResource,
} from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
Expand All@@ -17,6 +23,69 @@ export const getSeatUnitPrice = (plan: { unitPrices?: BillingPlanUnitPrice[] }):
return null;
};

/**
* Similar to the above, given a checkout totals, return the unit price for seats.
*/
export const getCheckoutSeatUnitTotal = (checkout: {
perUnitTotals?: BillingPerUnitTotal[];
}): BillingPerUnitTotal | null => {
if (!checkout.perUnitTotals?.length) {
return null;
}

const seatUnitPrice = checkout.perUnitTotals.find(unitTotal => unitTotal.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents per-seat costs. If no tier is found, return null.
*/
export const getPaidSeatsUnitTotalTier = (unitTotal: BillingPerUnitTotal | null): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (unitTotal.tiers.length === 1 && unitTotal.tiers[0].feePerBlock.amount > 0) {
return unitTotal.tiers[0];
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[1];
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents included seats. If no tier is found, return null.
*/
export const getIncludedSeatsUnitTotalTier = (
unitTotal: BillingPerUnitTotal | null,
): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[0];
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(ui): Add per-seat costs to checkout totals by dstaley · Pull Request #8464 · clerk/javascript · GitHub
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
5 changes: 5 additions & 0 deletions .changeset/good-ads-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': minor
---

Add support for rendering per-seat costs in checkout
8 changes: 8 additions & 0 deletions .changeset/khaki-hairs-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Add support for total due per period to checkout
3 changes: 3 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
if ('total_due_now' in data) {
totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
}
if ('total_due_per_period' in data) {
totals.totalDuePerPeriod = billingMoneyAmountFromJSON(data.total_due_per_period);
}

if ('total_due_after_free_trial' in data) {
totals.totalDueAfterFreeTrial = data.total_due_after_free_trial
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
title__subscriptionSuccessful: 'Success!',
title__trialSuccess: 'Trial successfully started!',
totalDueAfterTrial: 'Total Due after trial ends in {{days}} days',
totalDuePerPeriod: 'Total Due per period',
},
credit: 'Credit',
prorationCredit: 'Prorated credit',
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -840,6 +840,10 @@ export interface BillingCheckoutTotals {
* The amount that needs to be immediately paid to complete the checkout.
*/
totalDueNow: BillingMoneyAmount;
/**
* The amount that will be charged per period for this subscription.
*/
totalDuePerPeriod: BillingMoneyAmount;
/**
* Any credits (like account balance or promo credits) that are being applied to the checkout.
*/
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -860,6 +860,7 @@ export interface BillingCheckoutTotalsJSON {
*/
per_unit_totals?: BillingPerUnitTotalJSON[];
total_due_now: BillingMoneyAmountJSON;
total_due_per_period: BillingMoneyAmountJSON;
credit: BillingMoneyAmountJSON | null;
credits: BillingCreditsJSON | null;
account_credit: BillingMoneyAmountJSON | null;
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -301,6 +301,7 @@ export type __internal_LocalizationResource = {
downgradeNotice: LocalizationValue;
pastDueNotice: LocalizationValue;
totalDueAfterTrial: LocalizationValue<'days'>;
totalDuePerPeriod: LocalizationValue;
perMonth: LocalizationValue;
};
};
Expand Down
39 changes: 36 additions & 3 deletions packages/ui/src/components/Checkout/CheckoutForm.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,12 @@ import { LineItems } from '@/ui/elements/LineItems';
import { SegmentedControl } from '@/ui/elements/SegmentedControl';
import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';
import {
getCheckoutSeatUnitTotal,
getIncludedSeatsUnitTotalTier,
getPaidSeatsUnitTotalTier,
getSeatUnitPrice,
} from '@/ui/utils/billingPlanSeats';
import { handleError } from '@/ui/utils/errorHandler';

import { DevOnly } from '../../common/DevOnly';
Expand DownExpand Up@@ -48,10 +53,21 @@ export const CheckoutForm = withCardStateProvider(() => {
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
plan.annualMonthlyFee!;

const descriptionElements = [];
const seatPerUnitTotal = getCheckoutSeatUnitTotal(totals);
const includedSeatsTier = getIncludedSeatsUnitTotalTier(seatPerUnitTotal);
const paidSeatsTier = getPaidSeatsUnitTotalTier(seatPerUnitTotal);

const descriptionElements: Array<ReturnType<typeof localizationKeys>> = [];
if (planPeriod === 'annual') {
descriptionElements.push(localizationKeys('billing.billedAnnually'));
}
if (includedSeatsTier && includedSeatsTier.quantity !== null) {
descriptionElements.push(
localizationKeys('billing.pricingTable.seatCost.includedSeats', {
includedSeats: includedSeatsTier.quantity,
}),
);
}
const seatUnitPrice = getSeatUnitPrice(plan);
if (seatUnitPrice && seatUnitPrice.tiers.length === 1 && seatUnitPrice.tiers[0].feePerBlock.amount === 0) {
descriptionElements.push(
Expand DownExpand Up@@ -91,6 +107,16 @@ export const CheckoutForm = withCardStateProvider(() => {
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
{paidSeatsTier && paidSeatsTier.quantity !== null && (
<LineItems.Group borderTop>
<LineItems.Title title={localizationKeys('billing.seats')} />
<LineItems.Description
prefix={`${paidSeatsTier.quantity} x`}
text={`${paidSeatsTier.feePerBlock.currencySymbol}${paidSeatsTier.feePerBlock.amountFormatted}`}
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand DownExpand Up@@ -129,7 +155,7 @@ export const CheckoutForm = withCardStateProvider(() => {
</LineItems.Group>
)}

{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial && (
{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial ? (
<LineItems.Group variant='tertiary'>
<LineItems.Title
title={localizationKeys('billing.checkout.totalDueAfterTrial', {
Expand All@@ -140,6 +166,13 @@ export const CheckoutForm = withCardStateProvider(() => {
text={`${totals.totalDueAfterFreeTrial.currencySymbol}${totals.totalDueAfterFreeTrial.amountFormatted}`}
/>
</LineItems.Group>
) : (
<LineItems.Group variant='tertiary'>
<LineItems.Title title={localizationKeys('billing.checkout.totalDuePerPeriod')} />
<LineItems.Description
text={`${totals.totalDuePerPeriod.currencySymbol}${totals.totalDuePerPeriod.amountFormatted}`}
/>
</LineItems.Group>
)}

<LineItems.Group borderTop>
Expand Down
1 change: 0 additions & 1 deletion packages/ui/src/elements/LineItems.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,6 @@ const Title = React.forwardRef<HTMLTableCellElement, TitleProps>(({ title, descr
<Span
sx={t => ({
display: 'inline-flex',
alignItems: 'center',
gap: t.space.$1,
})}
>
Expand Down
71 changes: 70 additions & 1 deletion packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';
import type {
BillingPerUnitTotal,
BillingPerUnitTotalTier,
BillingPlanResource,
BillingPlanUnitPrice,
OrganizationResource,
} from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
Expand All@@ -17,6 +23,69 @@ export const getSeatUnitPrice = (plan: { unitPrices?: BillingPlanUnitPrice[] }):
return null;
};

/**
* Similar to the above, given a checkout totals, return the unit price for seats.
*/
export const getCheckoutSeatUnitTotal = (checkout: {
perUnitTotals?: BillingPerUnitTotal[];
}): BillingPerUnitTotal | null => {
if (!checkout.perUnitTotals?.length) {
return null;
}

const seatUnitPrice = checkout.perUnitTotals.find(unitTotal => unitTotal.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents per-seat costs. If no tier is found, return null.
*/
export const getPaidSeatsUnitTotalTier = (unitTotal: BillingPerUnitTotal | null): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (unitTotal.tiers.length === 1 && unitTotal.tiers[0].feePerBlock.amount > 0) {
return unitTotal.tiers[0];
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[1];
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents included seats. If no tier is found, return null.
*/
export const getIncludedSeatsUnitTotalTier = (
unitTotal: BillingPerUnitTotal | null,
): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[0];
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat(ui): Add per-seat costs to checkout totals by dstaley · Pull Request #8464 · clerk/javascript · GitHub
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
5 changes: 5 additions & 0 deletions .changeset/good-ads-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': minor
---

Add support for rendering per-seat costs in checkout
8 changes: 8 additions & 0 deletions .changeset/khaki-hairs-punch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Add support for total due per period to checkout
3 changes: 3 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
if ('total_due_now' in data) {
totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
}
if ('total_due_per_period' in data) {
totals.totalDuePerPeriod = billingMoneyAmountFromJSON(data.total_due_per_period);
}

if ('total_due_after_free_trial' in data) {
totals.totalDueAfterFreeTrial = data.total_due_after_free_trial
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
title__subscriptionSuccessful: 'Success!',
title__trialSuccess: 'Trial successfully started!',
totalDueAfterTrial: 'Total Due after trial ends in {{days}} days',
totalDuePerPeriod: 'Total Due per period',
},
credit: 'Credit',
prorationCredit: 'Prorated credit',
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -840,6 +840,10 @@ export interface BillingCheckoutTotals {
* The amount that needs to be immediately paid to complete the checkout.
*/
totalDueNow: BillingMoneyAmount;
/**
* The amount that will be charged per period for this subscription.
*/
totalDuePerPeriod: BillingMoneyAmount;
/**
* Any credits (like account balance or promo credits) that are being applied to the checkout.
*/
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -860,6 +860,7 @@ export interface BillingCheckoutTotalsJSON {
*/
per_unit_totals?: BillingPerUnitTotalJSON[];
total_due_now: BillingMoneyAmountJSON;
total_due_per_period: BillingMoneyAmountJSON;
credit: BillingMoneyAmountJSON | null;
credits: BillingCreditsJSON | null;
account_credit: BillingMoneyAmountJSON | null;
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -301,6 +301,7 @@ export type __internal_LocalizationResource = {
downgradeNotice: LocalizationValue;
pastDueNotice: LocalizationValue;
totalDueAfterTrial: LocalizationValue<'days'>;
totalDuePerPeriod: LocalizationValue;
perMonth: LocalizationValue;
};
};
Expand Down
39 changes: 36 additions & 3 deletions packages/ui/src/components/Checkout/CheckoutForm.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,12 @@ import { LineItems } from '@/ui/elements/LineItems';
import { SegmentedControl } from '@/ui/elements/SegmentedControl';
import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';
import { getSeatUnitPrice } from '@/ui/utils/billingPlanSeats';
import {
getCheckoutSeatUnitTotal,
getIncludedSeatsUnitTotalTier,
getPaidSeatsUnitTotalTier,
getSeatUnitPrice,
} from '@/ui/utils/billingPlanSeats';
import { handleError } from '@/ui/utils/errorHandler';

import { DevOnly } from '../../common/DevOnly';
Expand DownExpand Up@@ -48,10 +53,21 @@ export const CheckoutForm = withCardStateProvider(() => {
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
plan.annualMonthlyFee!;

const descriptionElements = [];
const seatPerUnitTotal = getCheckoutSeatUnitTotal(totals);
const includedSeatsTier = getIncludedSeatsUnitTotalTier(seatPerUnitTotal);
const paidSeatsTier = getPaidSeatsUnitTotalTier(seatPerUnitTotal);

const descriptionElements: Array<ReturnType<typeof localizationKeys>> = [];
if (planPeriod === 'annual') {
descriptionElements.push(localizationKeys('billing.billedAnnually'));
}
if (includedSeatsTier && includedSeatsTier.quantity !== null) {
descriptionElements.push(
localizationKeys('billing.pricingTable.seatCost.includedSeats', {
includedSeats: includedSeatsTier.quantity,
}),
);
}
const seatUnitPrice = getSeatUnitPrice(plan);
if (seatUnitPrice && seatUnitPrice.tiers.length === 1 && seatUnitPrice.tiers[0].feePerBlock.amount === 0) {
descriptionElements.push(
Expand DownExpand Up@@ -91,6 +107,16 @@ export const CheckoutForm = withCardStateProvider(() => {
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
{paidSeatsTier && paidSeatsTier.quantity !== null && (
<LineItems.Group borderTop>
<LineItems.Title title={localizationKeys('billing.seats')} />
<LineItems.Description
prefix={`${paidSeatsTier.quantity} x`}
text={`${paidSeatsTier.feePerBlock.currencySymbol}${paidSeatsTier.feePerBlock.amountFormatted}`}
suffix={localizationKeys('billing.checkout.perMonth')}
/>
</LineItems.Group>
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand DownExpand Up@@ -129,7 +155,7 @@ export const CheckoutForm = withCardStateProvider(() => {
</LineItems.Group>
)}

{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial && (
{!!freeTrialEndsAt && !!plan.freeTrialDays && totals.totalDueAfterFreeTrial ? (
<LineItems.Group variant='tertiary'>
<LineItems.Title
title={localizationKeys('billing.checkout.totalDueAfterTrial', {
Expand All@@ -140,6 +166,13 @@ export const CheckoutForm = withCardStateProvider(() => {
text={`${totals.totalDueAfterFreeTrial.currencySymbol}${totals.totalDueAfterFreeTrial.amountFormatted}`}
/>
</LineItems.Group>
) : (
<LineItems.Group variant='tertiary'>
<LineItems.Title title={localizationKeys('billing.checkout.totalDuePerPeriod')} />
<LineItems.Description
text={`${totals.totalDuePerPeriod.currencySymbol}${totals.totalDuePerPeriod.amountFormatted}`}
/>
</LineItems.Group>
)}

<LineItems.Group borderTop>
Expand Down
1 change: 0 additions & 1 deletion packages/ui/src/elements/LineItems.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,6 @@ const Title = React.forwardRef<HTMLTableCellElement, TitleProps>(({ title, descr
<Span
sx={t => ({
display: 'inline-flex',
alignItems: 'center',
gap: t.space.$1,
})}
>
Expand Down
71 changes: 70 additions & 1 deletion packages/ui/src/utils/billingPlanSeats.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { BillingPlanResource, BillingPlanUnitPrice, OrganizationResource } from '@clerk/shared/types';
import type {
BillingPerUnitTotal,
BillingPerUnitTotalTier,
BillingPlanResource,
BillingPlanUnitPrice,
OrganizationResource,
} from '@clerk/shared/types';

/**
* Given a plan, return the unit price for seats.
Expand All@@ -17,6 +23,69 @@ export const getSeatUnitPrice = (plan: { unitPrices?: BillingPlanUnitPrice[] }):
return null;
};

/**
* Similar to the above, given a checkout totals, return the unit price for seats.
*/
export const getCheckoutSeatUnitTotal = (checkout: {
perUnitTotals?: BillingPerUnitTotal[];
}): BillingPerUnitTotal | null => {
if (!checkout.perUnitTotals?.length) {
return null;
}

const seatUnitPrice = checkout.perUnitTotals.find(unitTotal => unitTotal.name === 'seats');

if (seatUnitPrice) {
return seatUnitPrice;
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents per-seat costs. If no tier is found, return null.
*/
export const getPaidSeatsUnitTotalTier = (unitTotal: BillingPerUnitTotal | null): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (unitTotal.tiers.length === 1 && unitTotal.tiers[0].feePerBlock.amount > 0) {
return unitTotal.tiers[0];
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[1];
}

return null;
};

/**
* Given a checkout unit total, return the unit total tier that represents included seats. If no tier is found, return null.
*/
export const getIncludedSeatsUnitTotalTier = (
unitTotal: BillingPerUnitTotal | null,
): BillingPerUnitTotalTier | null => {
if (!unitTotal) {
return null;
}

if (
unitTotal.tiers.length === 2 &&
unitTotal.tiers[0].feePerBlock.amount === 0 &&
unitTotal.tiers[1].feePerBlock.amount > 0
) {
return unitTotal.tiers[0];
}

return null;
};

/**
* Given a plan, return the seat limit for the plan, or undefined if the plan does not have a seat limit.
*/
Expand Down
Loading