chore(clerk-js,types): Switch to fees for plan prices#6490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
panteliselef merged 13 commits into from
Aug 12, 2025
Merged

chore(clerk-js,types): Switch to fees for plan prices #6490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d7daf96
chore(clerk-js,types): Switch to fees for plan prices
panteliselef Aug 8, 2025
53d1c86
address test in react
panteliselef Aug 8, 2025
6975c49
address feedback from rabbit
panteliselef Aug 8, 2025
69c583c
update typedoc
panteliselef Aug 8, 2025
0100be0
Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js
panteliselef Aug 8, 2025
360986c
remove duplication
panteliselef Aug 12, 2025
171100a
Merge branch 'refs/heads/main' into elef/com-1139-remove-amount-usage…
panteliselef Aug 12, 2025
0bb6872
leftover after conflicts
panteliselef Aug 12, 2025
6a0d739
update fees to moneyamount
panteliselef Aug 12, 2025
dbe1805
update typedocs
panteliselef Aug 12, 2025
3dd40eb
Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js
panteliselef Aug 12, 2025
22841e6
Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js
panteliselef Aug 12, 2025
5377039
patch test
panteliselef Aug 12, 2025
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
6 changes: 6 additions & 0 deletions .changeset/rich-drinks-ring.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Replace usage of top level amounts in plan with fees for displaying prices.
4 changes: 2 additions & 2 deletions .typedoc/__tests__/__snapshots__/file-structure.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"types/commerce-feature-resource.mdx",
"types/commerce-initialized-payment-source-json.mdx",
"types/commerce-initialized-payment-source-resource.mdx",
"types/commerce-money-json.mdx",
"types/commerce-money.mdx",
"types/commerce-money-amount-json.mdx",
"types/commerce-money-amount.mdx",
"types/commerce-payer-resource-type.mdx",
"types/commerce-payment-charge-type.mdx",
"types/commerce-payment-json.mdx",
Expand Down
8 changes: 4 additions & 4 deletions packages/backend/src/api/resources/CommercePlan.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';

type CommerceFee = {
type CommerceMoneyAmount = {
amount: number;
amountFormatted: string;
currency: string;
Expand DownExpand Up@@ -53,15 +53,15 @@ export class CommercePlan {
/**
* The monthly fee of the plan.
*/
readonly fee: CommerceFee,
readonly fee: CommerceMoneyAmount,
/**
* The annual fee of the plan.
*/
readonly annualFee: CommerceFee,
readonly annualFee: CommerceMoneyAmount,
/**
* The annual fee of the plan on a monthly basis.
*/
readonly annualMonthlyFee: CommerceFee,
readonly annualMonthlyFee: CommerceMoneyAmount,
/**
* The type of payer for the plan.
*/
Expand Down
18 changes: 9 additions & 9 deletions packages/backend/src/api/resources/JSON.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -800,17 +800,17 @@ interface CommercePayeeJSON {
gateway_status: 'active' | 'pending' | 'restricted' | 'disconnected';
}

interface CommerceFeeJSON {
interface CommerceMoneyAmountJSON {
amount: number;
amount_formatted: string;
currency: string;
currency_symbol: string;
}

interface CommerceTotalsJSON {
subtotal: CommerceFeeJSON;
tax_total: CommerceFeeJSON;
grand_total: CommerceFeeJSON;
subtotal: CommerceMoneyAmountJSON;
tax_total: CommerceMoneyAmountJSON;
grand_total: CommerceMoneyAmountJSON;
}

export interface FeatureJSON extends ClerkResourceJSON {
Expand All@@ -836,9 +836,9 @@ export interface CommercePlanJSON extends ClerkResourceJSON {
is_recurring: boolean;
has_base_fee: boolean;
publicly_visible: boolean;
fee: CommerceFeeJSON;
annual_fee: CommerceFeeJSON;
annual_monthly_fee: CommerceFeeJSON;
fee: CommerceMoneyAmountJSON;
annual_fee: CommerceMoneyAmountJSON;
annual_monthly_fee: CommerceMoneyAmountJSON;
for_payer_type: 'org' | 'user';
features: FeatureJSON[];
}
Expand All@@ -847,7 +847,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
object: typeof ObjectType.CommerceSubscriptionItem;
status: 'abandoned' | 'active' | 'canceled' | 'ended' | 'expired' | 'incomplete' | 'past_due' | 'upcoming';
credit: {
amount: CommerceFeeJSON;
amount: CommerceMoneyAmountJSON;
cycle_days_remaining: number;
cycle_days_total: number;
cycle_remaining_percent: number;
Expand All@@ -861,7 +861,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
lifetime_paid: number;
next_payment_amount: number;
next_payment_date: number;
amount: CommerceFeeJSON;
amount: CommerceMoneyAmountJSON;
plan: {
id: string;
instance_id: string;
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/core/resources/CommercePayment.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
CommerceMoney,
CommerceMoneyAmount,
CommercePaymentChargeType,
CommercePaymentJSON,
CommercePaymentResource,
Expand All@@ -8,13 +8,13 @@ import type {
CommerceSubscriptionItemResource,
} from '@clerk/types';

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, CommercePaymentSource, CommerceSubscriptionItem } from './internal';

export class CommercePayment extends BaseResource implements CommercePaymentResource {
id!: string;
amount!: CommerceMoney;
amount!: CommerceMoneyAmount;
failedAt?: Date;
paidAt?: Date;
updatedAt!: Date;
Expand All@@ -38,7 +38,7 @@ export class CommercePayment extends BaseResource implements CommercePaymentReso
}

this.id = data.id;
this.amount = commerceMoneyFromJSON(data.amount);
this.amount = commerceMoneyAmountFromJSON(data.amount);
this.paidAt = data.paid_at ? unixEpochToDate(data.paid_at) : undefined;
this.failedAt = data.failed_at ? unixEpochToDate(data.failed_at) : undefined;
this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down
51 changes: 9 additions & 42 deletions packages/clerk-js/src/core/resources/CommercePlan.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
import type {
CommerceMoneyAmount,
CommercePayerResourceType,
CommercePlanJSON,
CommercePlanJSONSnapshot,
CommercePlanResource,
} from '@clerk/types';

import { commerceMoneyAmountFromJSON } from '@/utils/commerce';

import { BaseResource, CommerceFeature } from './internal';

export class CommercePlan extends BaseResource implements CommercePlanResource {
id!: string;
name!: string;
amount!: number;
amountFormatted!: string;
annualAmount!: number;
annualAmountFormatted!: string;
annualMonthlyAmount!: number;
annualMonthlyAmountFormatted!: string;
currencySymbol!: string;
currency!: string;
fee!: CommerceMoneyAmount;
annualFee!: CommerceMoneyAmount;
annualMonthlyFee!: CommerceMoneyAmount;
description!: string;
isDefault!: boolean;
isRecurring!: boolean;
Expand All@@ -42,14 +39,9 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

this.id = data.id;
this.name = data.name;
this.amount = data.amount;
this.amountFormatted = data.amount_formatted;
this.annualAmount = data.annual_amount;
this.annualAmountFormatted = data.annual_amount_formatted;
this.annualMonthlyAmount = data.annual_monthly_amount;
this.annualMonthlyAmountFormatted = data.annual_monthly_amount_formatted;
this.currencySymbol = data.currency_symbol;
this.currency = data.currency;
this.fee = commerceMoneyAmountFromJSON(data.fee);
this.annualFee = commerceMoneyAmountFromJSON(data.annual_fee);
this.annualMonthlyFee = commerceMoneyAmountFromJSON(data.annual_monthly_fee);
this.description = data.description;
this.isDefault = data.is_default;
this.isRecurring = data.is_recurring;
Expand All@@ -64,29 +56,4 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

return this;
}

public __internal_toSnapshot(): CommercePlanJSONSnapshot {
return {
object: 'commerce_plan',
id: this.id,
name: this.name,
amount: this.amount,
amount_formatted: this.amountFormatted,
annual_amount: this.annualAmount,
annual_amount_formatted: this.annualAmountFormatted,
annual_monthly_amount: this.annualMonthlyAmount,
annual_monthly_amount_formatted: this.annualMonthlyAmountFormatted,
currency: this.currency,
currency_symbol: this.currencySymbol,
description: this.description,
is_default: this.isDefault,
is_recurring: this.isRecurring,
has_base_fee: this.hasBaseFee,
for_payer_type: this.forPayerType,
publicly_visible: this.publiclyVisible,
slug: this.slug,
avatar_url: this.avatarUrl,
features: this.features.map(feature => feature.__internal_toSnapshot()),
};
}
}
17 changes: 9 additions & 8 deletions packages/clerk-js/src/core/resources/CommerceSubscription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type {
CancelSubscriptionParams,
CommerceMoney,
CommerceMoneyAmount,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CommerceSubscriptionJSON,
Expand All@@ -12,7 +12,7 @@ import type {

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

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { BaseResource, CommercePlan, DeletedObject } from './internal';

export class CommerceSubscription extends BaseResource implements CommerceSubscriptionResource {
Expand All@@ -23,7 +23,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
pastDueAt!: Date | null;
updatedAt!: Date | null;
nextPayment: {
amount: CommerceMoney;
amount: CommerceMoneyAmount;
date: Date;
} | null = null;
subscriptionItems!: CommerceSubscriptionItemResource[];
Expand All@@ -47,7 +47,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;
this.nextPayment = data.next_payment
? {
amount: commerceMoneyFromJSON(data.next_payment.amount),
amount: commerceMoneyAmountFromJSON(data.next_payment.amount),
date: unixEpochToDate(data.next_payment.date),
}
: null;
Expand All@@ -69,9 +69,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
canceledAt!: Date | null;
pastDueAt!: Date | null;
//TODO(@COMMERCE): Why can this be undefined ?
amount?: CommerceMoney;
amount?: CommerceMoneyAmount;
credit?: {
amount: CommerceMoney;
amount: CommerceMoneyAmount;
};
isFreeTrial!: boolean;

Expand All@@ -98,8 +98,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
this.periodEnd = data.period_end ? unixEpochToDate(data.period_end) : null;
this.canceledAt = data.canceled_at ? unixEpochToDate(data.canceled_at) : null;

this.amount = data.amount ? commerceMoneyFromJSON(data.amount) : undefined;
this.credit = data.credit && data.credit.amount ? { amount: commerceMoneyFromJSON(data.credit.amount) } : undefined;
this.amount = data.amount ? commerceMoneyAmountFromJSON(data.amount) : undefined;
this.credit =
data.credit && data.credit.amount ? { amount: commerceMoneyAmountFromJSON(data.credit.amount) } : undefined;

this.isFreeTrial = this.withDefault(data.is_free_trial, false);
return this;
Expand Down
8 changes: 5 additions & 3 deletions packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { __experimental_useCheckout as useCheckout, useOrganization } from '@clerk/shared/react';
import type { CommerceMoney, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import type { CommerceMoneyAmount, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import { useMemo, useState } from 'react';

import { Card } from '@/ui/elements/Card';
Expand DownExpand Up@@ -35,6 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
const showDowngradeInfo = !isImmediatePlanChange;

const fee = planPeriod === 'month' ? plan.fee : plan.annualMonthlyFee;

Comment thread
panteliselef marked this conversation as resolved.
return (
<Drawer.Body>
<Box
Expand All@@ -54,7 +56,7 @@ export const CheckoutForm = withCardStateProvider(() => {
/>
<LineItems.Description
prefix={planPeriod === 'annual' ? 'x12' : undefined}
text={`${plan.currencySymbol}${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
Comment on lines 58 to 61

@coderabbitaicoderabbitaiBotAug 8, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Localize hard-coded 'x12' multiplier

All user-facing strings must be localized. Replace 'x12' with a localization key (e.g., commerce.checkout.x12) or a parameterized key.

- prefix={planPeriod === 'annual' ? 'x12' : undefined}+ prefix={planPeriod === 'annual' ? localizationKeys('commerce.checkout.x12') : undefined}
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
prefix={planPeriod ==='annual' ? 'x12' : undefined}
text={`${plan.currencySymbol}${planPeriod==='month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
prefix={planPeriod ==='annual' ? localizationKeys('commerce.checkout.x12') : undefined}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx around lines 58
to 61, the hard-coded string 'x12' used as a prefix should be replaced with a
localized string. Update the code to use a localization key such as
'commerce.checkout.x12' or a parameterized localization key instead of the
literal 'x12' to ensure all user-facing strings are properly localized.

</LineItems.Group>
Expand DownExpand Up@@ -312,7 +314,7 @@ const ExistingPaymentSourceForm = withCardStateProvider(
totalDueNow,
paymentSources,
}: {
totalDueNow: CommerceMoney;
totalDueNow: CommerceMoneyAmount;
paymentSources: CommercePaymentSourceResource[];
}) => {
const { checkout } = useCheckout();
Expand Down
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
chore(clerk-js,types): Switch to fees for plan prices#6490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 13 commits into

from

Aug 12, 2025
 Merged


chore(clerk-js,types): Switch to fees for plan prices
#6490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
d7daf96

chore(clerk-js,types): Switch to fees for plan prices


panteliselef Aug 8, 2025
53d1c86

address test in react


panteliselef Aug 8, 2025
6975c49

address feedback from rabbit


panteliselef Aug 8, 2025
69c583c

update typedoc


panteliselef Aug 8, 2025
0100be0

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 8, 2025
360986c

remove duplication


panteliselef Aug 12, 2025
171100a

Merge branch 'refs/heads/main' into elef/com-1139-remove-amount-usage…


panteliselef Aug 12, 2025
0bb6872

leftover after conflicts


panteliselef Aug 12, 2025
6a0d739

update fees to moneyamount


panteliselef Aug 12, 2025
dbe1805

update typedocs


panteliselef Aug 12, 2025
3dd40eb

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
22841e6

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
5377039

patch test


panteliselef Aug 12, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/rich-drinks-ring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Replace usage of top level amounts in plan with fees for displaying prices.

4 changes: 2 additions & 2 deletions
.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "types/commerce-feature-resource.mdx",
 "types/commerce-initialized-payment-source-json.mdx",
 "types/commerce-initialized-payment-source-resource.mdx",
 "types/commerce-money-json.mdx",
 "types/commerce-money.mdx",
 "types/commerce-money-amount-json.mdx",
 "types/commerce-money-amount.mdx",
 "types/commerce-payer-resource-type.mdx",
 "types/commerce-payment-charge-type.mdx",
 "types/commerce-payment-json.mdx",
Expand Down

8 changes: 4 additions & 4 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';

type CommerceFee = {
type CommerceMoneyAmount = {
 amount: number;
 amountFormatted: string;
 currency: string;
Expand DownExpand Up@@ -53,15 +53,15 @@ export class CommercePlan {
 /**
 * The monthly fee of the plan.
 */
 readonly fee: CommerceFee,
 readonly fee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan.
 */
 readonly annualFee: CommerceFee,
 readonly annualFee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan on a monthly basis.
 */
 readonly annualMonthlyFee: CommerceFee,
 readonly annualMonthlyFee: CommerceMoneyAmount,
 /**
 * The type of payer for the plan.
 */
Expand Down

18 changes: 9 additions & 9 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -800,17 +800,17 @@ interface CommercePayeeJSON {
 gateway_status: 'active' | 'pending' | 'restricted' | 'disconnected';
}

interface CommerceFeeJSON {
interface CommerceMoneyAmountJSON {
 amount: number;
 amount_formatted: string;
 currency: string;
 currency_symbol: string;
}

interface CommerceTotalsJSON {
 subtotal: CommerceFeeJSON;
 tax_total: CommerceFeeJSON;
 grand_total: CommerceFeeJSON;
 subtotal: CommerceMoneyAmountJSON;
 tax_total: CommerceMoneyAmountJSON;
 grand_total: CommerceMoneyAmountJSON;
}

export interface FeatureJSON extends ClerkResourceJSON {
Expand All@@ -836,9 +836,9 @@ export interface CommercePlanJSON extends ClerkResourceJSON {
 is_recurring: boolean;
 has_base_fee: boolean;
 publicly_visible: boolean;
 fee: CommerceFeeJSON;
 annual_fee: CommerceFeeJSON;
 annual_monthly_fee: CommerceFeeJSON;
 fee: CommerceMoneyAmountJSON;
 annual_fee: CommerceMoneyAmountJSON;
 annual_monthly_fee: CommerceMoneyAmountJSON;
 for_payer_type: 'org' | 'user';
 features: FeatureJSON[];
}
Expand All@@ -847,7 +847,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.CommerceSubscriptionItem;
 status: 'abandoned' | 'active' | 'canceled' | 'ended' | 'expired' | 'incomplete' | 'past_due' | 'upcoming';
 credit: {
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
Expand All@@ -861,7 +861,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 lifetime_paid: number;
 next_payment_amount: number;
 next_payment_date: number;
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 plan: {
 id: string;
 instance_id: string;
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/core/resources/CommercePayment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
CommerceMoney,
CommerceMoneyAmount,
 CommercePaymentChargeType,
 CommercePaymentJSON,
 CommercePaymentResource,
Expand All@@ -8,13 +8,13 @@ import type {
 CommerceSubscriptionItemResource,
} from '@clerk/types';

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, CommercePaymentSource, CommerceSubscriptionItem } from './internal';

export class CommercePayment extends BaseResource implements CommercePaymentResource {
 id!: string;
 amount!: CommerceMoney;
 amount!: CommerceMoneyAmount;
 failedAt?: Date;
 paidAt?: Date;
 updatedAt!: Date;
Expand All@@ -38,7 +38,7 @@ export class CommercePayment extends BaseResource implements CommercePaymentReso
 }

 this.id = data.id;
 this.amount = commerceMoneyFromJSON(data.amount);
 this.amount = commerceMoneyAmountFromJSON(data.amount);
 this.paidAt = data.paid_at ? unixEpochToDate(data.paid_at) : undefined;
 this.failedAt = data.failed_at ? unixEpochToDate(data.failed_at) : undefined;
 this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down

51 changes: 9 additions & 42 deletions
packages/clerk-js/src/core/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
import type {
 CommerceMoneyAmount,
 CommercePayerResourceType,
 CommercePlanJSON,
 CommercePlanJSONSnapshot,
 CommercePlanResource,
} from '@clerk/types';

import { commerceMoneyAmountFromJSON } from '@/utils/commerce';

import { BaseResource, CommerceFeature } from './internal';

export class CommercePlan extends BaseResource implements CommercePlanResource {
 id!: string;
 name!: string;
 amount!: number;
 amountFormatted!: string;
 annualAmount!: number;
 annualAmountFormatted!: string;
 annualMonthlyAmount!: number;
 annualMonthlyAmountFormatted!: string;
 currencySymbol!: string;
 currency!: string;
 fee!: CommerceMoneyAmount;
 annualFee!: CommerceMoneyAmount;
 annualMonthlyFee!: CommerceMoneyAmount;
 description!: string;
 isDefault!: boolean;
 isRecurring!: boolean;
Expand All@@ -42,14 +39,9 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 this.id = data.id;
 this.name = data.name;
 this.amount = data.amount;
 this.amountFormatted = data.amount_formatted;
 this.annualAmount = data.annual_amount;
 this.annualAmountFormatted = data.annual_amount_formatted;
 this.annualMonthlyAmount = data.annual_monthly_amount;
 this.annualMonthlyAmountFormatted = data.annual_monthly_amount_formatted;
 this.currencySymbol = data.currency_symbol;
 this.currency = data.currency;
 this.fee = commerceMoneyAmountFromJSON(data.fee);
 this.annualFee = commerceMoneyAmountFromJSON(data.annual_fee);
 this.annualMonthlyFee = commerceMoneyAmountFromJSON(data.annual_monthly_fee);
 this.description = data.description;
 this.isDefault = data.is_default;
 this.isRecurring = data.is_recurring;
Expand All@@ -64,29 +56,4 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 return this;
 }

 public __internal_toSnapshot(): CommercePlanJSONSnapshot {
 return {
 object: 'commerce_plan',
 id: this.id,
 name: this.name,
 amount: this.amount,
 amount_formatted: this.amountFormatted,
 annual_amount: this.annualAmount,
 annual_amount_formatted: this.annualAmountFormatted,
 annual_monthly_amount: this.annualMonthlyAmount,
 annual_monthly_amount_formatted: this.annualMonthlyAmountFormatted,
 currency: this.currency,
 currency_symbol: this.currencySymbol,
 description: this.description,
 is_default: this.isDefault,
 is_recurring: this.isRecurring,
 has_base_fee: this.hasBaseFee,
 for_payer_type: this.forPayerType,
 publicly_visible: this.publiclyVisible,
 slug: this.slug,
 avatar_url: this.avatarUrl,
 features: this.features.map(feature => feature.__internal_toSnapshot()),
 };
 }
}

17 changes: 9 additions & 8 deletions
packages/clerk-js/src/core/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type {
 CancelSubscriptionParams,
CommerceMoney,
CommerceMoneyAmount,
 CommerceSubscriptionItemJSON,
 CommerceSubscriptionItemResource,
 CommerceSubscriptionJSON,
Expand All@@ -12,7 +12,7 @@ import type {

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

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { BaseResource, CommercePlan, DeletedObject } from './internal';

export class CommerceSubscription extends BaseResource implements CommerceSubscriptionResource {
Expand All@@ -23,7 +23,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 pastDueAt!: Date | null;
 updatedAt!: Date | null;
 nextPayment: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 date: Date;
 } | null = null;
 subscriptionItems!: CommerceSubscriptionItemResource[];
Expand All@@ -47,7 +47,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;
 this.nextPayment = data.next_payment
 ? {
 amount: commerceMoneyFromJSON(data.next_payment.amount),
 amount: commerceMoneyAmountFromJSON(data.next_payment.amount),
 date: unixEpochToDate(data.next_payment.date),
 }
 : null;
Expand All@@ -69,9 +69,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 canceledAt!: Date | null;
 pastDueAt!: Date | null;
 //TODO(@COMMERCE): Why can this be undefined ?
 amount?: CommerceMoney;
 amount?: CommerceMoneyAmount;
 credit?: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 };
 isFreeTrial!: boolean;

Expand All@@ -98,8 +98,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 this.periodEnd = data.period_end ? unixEpochToDate(data.period_end) : null;
 this.canceledAt = data.canceled_at ? unixEpochToDate(data.canceled_at) : null;

 this.amount = data.amount ? commerceMoneyFromJSON(data.amount) : undefined;
 this.credit = data.credit && data.credit.amount ? { amount: commerceMoneyFromJSON(data.credit.amount) } : undefined;
 this.amount = data.amount ? commerceMoneyAmountFromJSON(data.amount) : undefined;
 this.credit =
 data.credit && data.credit.amount ? { amount: commerceMoneyAmountFromJSON(data.credit.amount) } : undefined;

 this.isFreeTrial = this.withDefault(data.is_free_trial, false);
 return this;
Expand Down

8 changes: 5 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { __experimental_useCheckout as useCheckout, useOrganization } from '@clerk/shared/react';
import type { CommerceMoney, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import type { CommerceMoneyAmount, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import { useMemo, useState } from 'react';

import { Card } from '@/ui/elements/Card';
Expand DownExpand Up@@ -35,6 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

 const fee = planPeriod === 'month' ? plan.fee : plan.annualMonthlyFee;

Comment thread
panteliselef marked this conversation as resolved.

 return (
 <Drawer.Body>
 <Box
Expand All@@ -54,7 +56,7 @@ export const CheckoutForm = withCardStateProvider(() => {
 />
 <LineItems.Description
 prefix={planPeriod === 'annual' ? 'x12' : undefined}
 text={`${plan.currencySymbol}${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
 text={`${fee.currencySymbol}${fee.amountFormatted}`}
 suffix={localizationKeys('commerce.checkout.perMonth')}
 />

Comment on lines

58
 to 
61

@coderabbitaicoderabbitaiBotAug 8, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Localize hard-coded 'x12' multiplier
All user-facing strings must be localized. Replace 'x12' with a localization key (e.g., commerce.checkout.x12) or a parameterized key.
- prefix={planPeriod === 'annual' ? 'x12' : undefined}+ prefix={planPeriod === 'annual' ? localizationKeys('commerce.checkout.x12') : undefined}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

prefix={planPeriod ==='annual' ? 'x12' : undefined}
text={`${plan.currencySymbol}${planPeriod==='month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
prefix={planPeriod ==='annual' ? localizationKeys('commerce.checkout.x12') : undefined}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx around lines 58
to 61, the hard-coded string 'x12' used as a prefix should be replaced with a
localized string. Update the code to use a localization key such as
'commerce.checkout.x12' or a parameterized localization key instead of the
literal 'x12' to ensure all user-facing strings are properly localized.

 </LineItems.Group>
Expand DownExpand Up@@ -312,7 +314,7 @@ const ExistingPaymentSourceForm = withCardStateProvider(
 totalDueNow,
 paymentSources,
 }: {
 totalDueNow: CommerceMoney;
 totalDueNow: CommerceMoneyAmount;
 paymentSources: CommercePaymentSourceResource[];
 }) => {
 const { checkout } = useCheckout();
Expand Down
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
chore(clerk-js,types): Switch to fees for plan prices#6490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 13 commits into

from

Aug 12, 2025
 Merged


chore(clerk-js,types): Switch to fees for plan prices
#6490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
d7daf96

chore(clerk-js,types): Switch to fees for plan prices


panteliselef Aug 8, 2025
53d1c86

address test in react


panteliselef Aug 8, 2025
6975c49

address feedback from rabbit


panteliselef Aug 8, 2025
69c583c

update typedoc


panteliselef Aug 8, 2025
0100be0

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 8, 2025
360986c

remove duplication


panteliselef Aug 12, 2025
171100a

Merge branch 'refs/heads/main' into elef/com-1139-remove-amount-usage…


panteliselef Aug 12, 2025
0bb6872

leftover after conflicts


panteliselef Aug 12, 2025
6a0d739

update fees to moneyamount


panteliselef Aug 12, 2025
dbe1805

update typedocs


panteliselef Aug 12, 2025
3dd40eb

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
22841e6

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
5377039

patch test


panteliselef Aug 12, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/rich-drinks-ring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Replace usage of top level amounts in plan with fees for displaying prices.

4 changes: 2 additions & 2 deletions
.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "types/commerce-feature-resource.mdx",
 "types/commerce-initialized-payment-source-json.mdx",
 "types/commerce-initialized-payment-source-resource.mdx",
 "types/commerce-money-json.mdx",
 "types/commerce-money.mdx",
 "types/commerce-money-amount-json.mdx",
 "types/commerce-money-amount.mdx",
 "types/commerce-payer-resource-type.mdx",
 "types/commerce-payment-charge-type.mdx",
 "types/commerce-payment-json.mdx",
Expand Down

8 changes: 4 additions & 4 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';

type CommerceFee = {
type CommerceMoneyAmount = {
 amount: number;
 amountFormatted: string;
 currency: string;
Expand DownExpand Up@@ -53,15 +53,15 @@ export class CommercePlan {
 /**
 * The monthly fee of the plan.
 */
 readonly fee: CommerceFee,
 readonly fee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan.
 */
 readonly annualFee: CommerceFee,
 readonly annualFee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan on a monthly basis.
 */
 readonly annualMonthlyFee: CommerceFee,
 readonly annualMonthlyFee: CommerceMoneyAmount,
 /**
 * The type of payer for the plan.
 */
Expand Down

18 changes: 9 additions & 9 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -800,17 +800,17 @@ interface CommercePayeeJSON {
 gateway_status: 'active' | 'pending' | 'restricted' | 'disconnected';
}

interface CommerceFeeJSON {
interface CommerceMoneyAmountJSON {
 amount: number;
 amount_formatted: string;
 currency: string;
 currency_symbol: string;
}

interface CommerceTotalsJSON {
 subtotal: CommerceFeeJSON;
 tax_total: CommerceFeeJSON;
 grand_total: CommerceFeeJSON;
 subtotal: CommerceMoneyAmountJSON;
 tax_total: CommerceMoneyAmountJSON;
 grand_total: CommerceMoneyAmountJSON;
}

export interface FeatureJSON extends ClerkResourceJSON {
Expand All@@ -836,9 +836,9 @@ export interface CommercePlanJSON extends ClerkResourceJSON {
 is_recurring: boolean;
 has_base_fee: boolean;
 publicly_visible: boolean;
 fee: CommerceFeeJSON;
 annual_fee: CommerceFeeJSON;
 annual_monthly_fee: CommerceFeeJSON;
 fee: CommerceMoneyAmountJSON;
 annual_fee: CommerceMoneyAmountJSON;
 annual_monthly_fee: CommerceMoneyAmountJSON;
 for_payer_type: 'org' | 'user';
 features: FeatureJSON[];
}
Expand All@@ -847,7 +847,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.CommerceSubscriptionItem;
 status: 'abandoned' | 'active' | 'canceled' | 'ended' | 'expired' | 'incomplete' | 'past_due' | 'upcoming';
 credit: {
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
Expand All@@ -861,7 +861,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 lifetime_paid: number;
 next_payment_amount: number;
 next_payment_date: number;
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 plan: {
 id: string;
 instance_id: string;
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/core/resources/CommercePayment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
CommerceMoney,
CommerceMoneyAmount,
 CommercePaymentChargeType,
 CommercePaymentJSON,
 CommercePaymentResource,
Expand All@@ -8,13 +8,13 @@ import type {
 CommerceSubscriptionItemResource,
} from '@clerk/types';

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, CommercePaymentSource, CommerceSubscriptionItem } from './internal';

export class CommercePayment extends BaseResource implements CommercePaymentResource {
 id!: string;
 amount!: CommerceMoney;
 amount!: CommerceMoneyAmount;
 failedAt?: Date;
 paidAt?: Date;
 updatedAt!: Date;
Expand All@@ -38,7 +38,7 @@ export class CommercePayment extends BaseResource implements CommercePaymentReso
 }

 this.id = data.id;
 this.amount = commerceMoneyFromJSON(data.amount);
 this.amount = commerceMoneyAmountFromJSON(data.amount);
 this.paidAt = data.paid_at ? unixEpochToDate(data.paid_at) : undefined;
 this.failedAt = data.failed_at ? unixEpochToDate(data.failed_at) : undefined;
 this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down

51 changes: 9 additions & 42 deletions
packages/clerk-js/src/core/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
import type {
 CommerceMoneyAmount,
 CommercePayerResourceType,
 CommercePlanJSON,
 CommercePlanJSONSnapshot,
 CommercePlanResource,
} from '@clerk/types';

import { commerceMoneyAmountFromJSON } from '@/utils/commerce';

import { BaseResource, CommerceFeature } from './internal';

export class CommercePlan extends BaseResource implements CommercePlanResource {
 id!: string;
 name!: string;
 amount!: number;
 amountFormatted!: string;
 annualAmount!: number;
 annualAmountFormatted!: string;
 annualMonthlyAmount!: number;
 annualMonthlyAmountFormatted!: string;
 currencySymbol!: string;
 currency!: string;
 fee!: CommerceMoneyAmount;
 annualFee!: CommerceMoneyAmount;
 annualMonthlyFee!: CommerceMoneyAmount;
 description!: string;
 isDefault!: boolean;
 isRecurring!: boolean;
Expand All@@ -42,14 +39,9 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 this.id = data.id;
 this.name = data.name;
 this.amount = data.amount;
 this.amountFormatted = data.amount_formatted;
 this.annualAmount = data.annual_amount;
 this.annualAmountFormatted = data.annual_amount_formatted;
 this.annualMonthlyAmount = data.annual_monthly_amount;
 this.annualMonthlyAmountFormatted = data.annual_monthly_amount_formatted;
 this.currencySymbol = data.currency_symbol;
 this.currency = data.currency;
 this.fee = commerceMoneyAmountFromJSON(data.fee);
 this.annualFee = commerceMoneyAmountFromJSON(data.annual_fee);
 this.annualMonthlyFee = commerceMoneyAmountFromJSON(data.annual_monthly_fee);
 this.description = data.description;
 this.isDefault = data.is_default;
 this.isRecurring = data.is_recurring;
Expand All@@ -64,29 +56,4 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 return this;
 }

 public __internal_toSnapshot(): CommercePlanJSONSnapshot {
 return {
 object: 'commerce_plan',
 id: this.id,
 name: this.name,
 amount: this.amount,
 amount_formatted: this.amountFormatted,
 annual_amount: this.annualAmount,
 annual_amount_formatted: this.annualAmountFormatted,
 annual_monthly_amount: this.annualMonthlyAmount,
 annual_monthly_amount_formatted: this.annualMonthlyAmountFormatted,
 currency: this.currency,
 currency_symbol: this.currencySymbol,
 description: this.description,
 is_default: this.isDefault,
 is_recurring: this.isRecurring,
 has_base_fee: this.hasBaseFee,
 for_payer_type: this.forPayerType,
 publicly_visible: this.publiclyVisible,
 slug: this.slug,
 avatar_url: this.avatarUrl,
 features: this.features.map(feature => feature.__internal_toSnapshot()),
 };
 }
}

17 changes: 9 additions & 8 deletions
packages/clerk-js/src/core/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type {
 CancelSubscriptionParams,
CommerceMoney,
CommerceMoneyAmount,
 CommerceSubscriptionItemJSON,
 CommerceSubscriptionItemResource,
 CommerceSubscriptionJSON,
Expand All@@ -12,7 +12,7 @@ import type {

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

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { BaseResource, CommercePlan, DeletedObject } from './internal';

export class CommerceSubscription extends BaseResource implements CommerceSubscriptionResource {
Expand All@@ -23,7 +23,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 pastDueAt!: Date | null;
 updatedAt!: Date | null;
 nextPayment: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 date: Date;
 } | null = null;
 subscriptionItems!: CommerceSubscriptionItemResource[];
Expand All@@ -47,7 +47,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;
 this.nextPayment = data.next_payment
 ? {
 amount: commerceMoneyFromJSON(data.next_payment.amount),
 amount: commerceMoneyAmountFromJSON(data.next_payment.amount),
 date: unixEpochToDate(data.next_payment.date),
 }
 : null;
Expand All@@ -69,9 +69,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 canceledAt!: Date | null;
 pastDueAt!: Date | null;
 //TODO(@COMMERCE): Why can this be undefined ?
 amount?: CommerceMoney;
 amount?: CommerceMoneyAmount;
 credit?: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 };
 isFreeTrial!: boolean;

Expand All@@ -98,8 +98,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 this.periodEnd = data.period_end ? unixEpochToDate(data.period_end) : null;
 this.canceledAt = data.canceled_at ? unixEpochToDate(data.canceled_at) : null;

 this.amount = data.amount ? commerceMoneyFromJSON(data.amount) : undefined;
 this.credit = data.credit && data.credit.amount ? { amount: commerceMoneyFromJSON(data.credit.amount) } : undefined;
 this.amount = data.amount ? commerceMoneyAmountFromJSON(data.amount) : undefined;
 this.credit =
 data.credit && data.credit.amount ? { amount: commerceMoneyAmountFromJSON(data.credit.amount) } : undefined;

 this.isFreeTrial = this.withDefault(data.is_free_trial, false);
 return this;
Expand Down

8 changes: 5 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { __experimental_useCheckout as useCheckout, useOrganization } from '@clerk/shared/react';
import type { CommerceMoney, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import type { CommerceMoneyAmount, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import { useMemo, useState } from 'react';

import { Card } from '@/ui/elements/Card';
Expand DownExpand Up@@ -35,6 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

 const fee = planPeriod === 'month' ? plan.fee : plan.annualMonthlyFee;

Comment thread
panteliselef marked this conversation as resolved.

 return (
 <Drawer.Body>
 <Box
Expand All@@ -54,7 +56,7 @@ export const CheckoutForm = withCardStateProvider(() => {
 />
 <LineItems.Description
 prefix={planPeriod === 'annual' ? 'x12' : undefined}
 text={`${plan.currencySymbol}${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
 text={`${fee.currencySymbol}${fee.amountFormatted}`}
 suffix={localizationKeys('commerce.checkout.perMonth')}
 />

Comment on lines

58
 to 
61

@coderabbitaicoderabbitaiBotAug 8, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Localize hard-coded 'x12' multiplier
All user-facing strings must be localized. Replace 'x12' with a localization key (e.g., commerce.checkout.x12) or a parameterized key.
- prefix={planPeriod === 'annual' ? 'x12' : undefined}+ prefix={planPeriod === 'annual' ? localizationKeys('commerce.checkout.x12') : undefined}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

prefix={planPeriod ==='annual' ? 'x12' : undefined}
text={`${plan.currencySymbol}${planPeriod==='month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
prefix={planPeriod ==='annual' ? localizationKeys('commerce.checkout.x12') : undefined}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx around lines 58
to 61, the hard-coded string 'x12' used as a prefix should be replaced with a
localized string. Update the code to use a localization key such as
'commerce.checkout.x12' or a parameterized localization key instead of the
literal 'x12' to ensure all user-facing strings are properly localized.

 </LineItems.Group>
Expand DownExpand Up@@ -312,7 +314,7 @@ const ExistingPaymentSourceForm = withCardStateProvider(
 totalDueNow,
 paymentSources,
 }: {
 totalDueNow: CommerceMoney;
 totalDueNow: CommerceMoneyAmount;
 paymentSources: CommercePaymentSourceResource[];
 }) => {
 const { checkout } = useCheckout();
Expand Down
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
chore(clerk-js,types): Switch to fees for plan prices#6490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 13 commits into

from

Aug 12, 2025
 Merged


chore(clerk-js,types): Switch to fees for plan prices
#6490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
d7daf96

chore(clerk-js,types): Switch to fees for plan prices


panteliselef Aug 8, 2025
53d1c86

address test in react


panteliselef Aug 8, 2025
6975c49

address feedback from rabbit


panteliselef Aug 8, 2025
69c583c

update typedoc


panteliselef Aug 8, 2025
0100be0

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 8, 2025
360986c

remove duplication


panteliselef Aug 12, 2025
171100a

Merge branch 'refs/heads/main' into elef/com-1139-remove-amount-usage…


panteliselef Aug 12, 2025
0bb6872

leftover after conflicts


panteliselef Aug 12, 2025
6a0d739

update fees to moneyamount


panteliselef Aug 12, 2025
dbe1805

update typedocs


panteliselef Aug 12, 2025
3dd40eb

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
22841e6

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
5377039

patch test


panteliselef Aug 12, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/rich-drinks-ring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Replace usage of top level amounts in plan with fees for displaying prices.

4 changes: 2 additions & 2 deletions
.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "types/commerce-feature-resource.mdx",
 "types/commerce-initialized-payment-source-json.mdx",
 "types/commerce-initialized-payment-source-resource.mdx",
 "types/commerce-money-json.mdx",
 "types/commerce-money.mdx",
 "types/commerce-money-amount-json.mdx",
 "types/commerce-money-amount.mdx",
 "types/commerce-payer-resource-type.mdx",
 "types/commerce-payment-charge-type.mdx",
 "types/commerce-payment-json.mdx",
Expand Down

8 changes: 4 additions & 4 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';

type CommerceFee = {
type CommerceMoneyAmount = {
 amount: number;
 amountFormatted: string;
 currency: string;
Expand DownExpand Up@@ -53,15 +53,15 @@ export class CommercePlan {
 /**
 * The monthly fee of the plan.
 */
 readonly fee: CommerceFee,
 readonly fee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan.
 */
 readonly annualFee: CommerceFee,
 readonly annualFee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan on a monthly basis.
 */
 readonly annualMonthlyFee: CommerceFee,
 readonly annualMonthlyFee: CommerceMoneyAmount,
 /**
 * The type of payer for the plan.
 */
Expand Down

18 changes: 9 additions & 9 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -800,17 +800,17 @@ interface CommercePayeeJSON {
 gateway_status: 'active' | 'pending' | 'restricted' | 'disconnected';
}

interface CommerceFeeJSON {
interface CommerceMoneyAmountJSON {
 amount: number;
 amount_formatted: string;
 currency: string;
 currency_symbol: string;
}

interface CommerceTotalsJSON {
 subtotal: CommerceFeeJSON;
 tax_total: CommerceFeeJSON;
 grand_total: CommerceFeeJSON;
 subtotal: CommerceMoneyAmountJSON;
 tax_total: CommerceMoneyAmountJSON;
 grand_total: CommerceMoneyAmountJSON;
}

export interface FeatureJSON extends ClerkResourceJSON {
Expand All@@ -836,9 +836,9 @@ export interface CommercePlanJSON extends ClerkResourceJSON {
 is_recurring: boolean;
 has_base_fee: boolean;
 publicly_visible: boolean;
 fee: CommerceFeeJSON;
 annual_fee: CommerceFeeJSON;
 annual_monthly_fee: CommerceFeeJSON;
 fee: CommerceMoneyAmountJSON;
 annual_fee: CommerceMoneyAmountJSON;
 annual_monthly_fee: CommerceMoneyAmountJSON;
 for_payer_type: 'org' | 'user';
 features: FeatureJSON[];
}
Expand All@@ -847,7 +847,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.CommerceSubscriptionItem;
 status: 'abandoned' | 'active' | 'canceled' | 'ended' | 'expired' | 'incomplete' | 'past_due' | 'upcoming';
 credit: {
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
Expand All@@ -861,7 +861,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 lifetime_paid: number;
 next_payment_amount: number;
 next_payment_date: number;
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 plan: {
 id: string;
 instance_id: string;
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/core/resources/CommercePayment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
CommerceMoney,
CommerceMoneyAmount,
 CommercePaymentChargeType,
 CommercePaymentJSON,
 CommercePaymentResource,
Expand All@@ -8,13 +8,13 @@ import type {
 CommerceSubscriptionItemResource,
} from '@clerk/types';

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, CommercePaymentSource, CommerceSubscriptionItem } from './internal';

export class CommercePayment extends BaseResource implements CommercePaymentResource {
 id!: string;
 amount!: CommerceMoney;
 amount!: CommerceMoneyAmount;
 failedAt?: Date;
 paidAt?: Date;
 updatedAt!: Date;
Expand All@@ -38,7 +38,7 @@ export class CommercePayment extends BaseResource implements CommercePaymentReso
 }

 this.id = data.id;
 this.amount = commerceMoneyFromJSON(data.amount);
 this.amount = commerceMoneyAmountFromJSON(data.amount);
 this.paidAt = data.paid_at ? unixEpochToDate(data.paid_at) : undefined;
 this.failedAt = data.failed_at ? unixEpochToDate(data.failed_at) : undefined;
 this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down

51 changes: 9 additions & 42 deletions
packages/clerk-js/src/core/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
import type {
 CommerceMoneyAmount,
 CommercePayerResourceType,
 CommercePlanJSON,
 CommercePlanJSONSnapshot,
 CommercePlanResource,
} from '@clerk/types';

import { commerceMoneyAmountFromJSON } from '@/utils/commerce';

import { BaseResource, CommerceFeature } from './internal';

export class CommercePlan extends BaseResource implements CommercePlanResource {
 id!: string;
 name!: string;
 amount!: number;
 amountFormatted!: string;
 annualAmount!: number;
 annualAmountFormatted!: string;
 annualMonthlyAmount!: number;
 annualMonthlyAmountFormatted!: string;
 currencySymbol!: string;
 currency!: string;
 fee!: CommerceMoneyAmount;
 annualFee!: CommerceMoneyAmount;
 annualMonthlyFee!: CommerceMoneyAmount;
 description!: string;
 isDefault!: boolean;
 isRecurring!: boolean;
Expand All@@ -42,14 +39,9 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 this.id = data.id;
 this.name = data.name;
 this.amount = data.amount;
 this.amountFormatted = data.amount_formatted;
 this.annualAmount = data.annual_amount;
 this.annualAmountFormatted = data.annual_amount_formatted;
 this.annualMonthlyAmount = data.annual_monthly_amount;
 this.annualMonthlyAmountFormatted = data.annual_monthly_amount_formatted;
 this.currencySymbol = data.currency_symbol;
 this.currency = data.currency;
 this.fee = commerceMoneyAmountFromJSON(data.fee);
 this.annualFee = commerceMoneyAmountFromJSON(data.annual_fee);
 this.annualMonthlyFee = commerceMoneyAmountFromJSON(data.annual_monthly_fee);
 this.description = data.description;
 this.isDefault = data.is_default;
 this.isRecurring = data.is_recurring;
Expand All@@ -64,29 +56,4 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 return this;
 }

 public __internal_toSnapshot(): CommercePlanJSONSnapshot {
 return {
 object: 'commerce_plan',
 id: this.id,
 name: this.name,
 amount: this.amount,
 amount_formatted: this.amountFormatted,
 annual_amount: this.annualAmount,
 annual_amount_formatted: this.annualAmountFormatted,
 annual_monthly_amount: this.annualMonthlyAmount,
 annual_monthly_amount_formatted: this.annualMonthlyAmountFormatted,
 currency: this.currency,
 currency_symbol: this.currencySymbol,
 description: this.description,
 is_default: this.isDefault,
 is_recurring: this.isRecurring,
 has_base_fee: this.hasBaseFee,
 for_payer_type: this.forPayerType,
 publicly_visible: this.publiclyVisible,
 slug: this.slug,
 avatar_url: this.avatarUrl,
 features: this.features.map(feature => feature.__internal_toSnapshot()),
 };
 }
}

17 changes: 9 additions & 8 deletions
packages/clerk-js/src/core/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type {
 CancelSubscriptionParams,
CommerceMoney,
CommerceMoneyAmount,
 CommerceSubscriptionItemJSON,
 CommerceSubscriptionItemResource,
 CommerceSubscriptionJSON,
Expand All@@ -12,7 +12,7 @@ import type {

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

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { BaseResource, CommercePlan, DeletedObject } from './internal';

export class CommerceSubscription extends BaseResource implements CommerceSubscriptionResource {
Expand All@@ -23,7 +23,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 pastDueAt!: Date | null;
 updatedAt!: Date | null;
 nextPayment: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 date: Date;
 } | null = null;
 subscriptionItems!: CommerceSubscriptionItemResource[];
Expand All@@ -47,7 +47,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;
 this.nextPayment = data.next_payment
 ? {
 amount: commerceMoneyFromJSON(data.next_payment.amount),
 amount: commerceMoneyAmountFromJSON(data.next_payment.amount),
 date: unixEpochToDate(data.next_payment.date),
 }
 : null;
Expand All@@ -69,9 +69,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 canceledAt!: Date | null;
 pastDueAt!: Date | null;
 //TODO(@COMMERCE): Why can this be undefined ?
 amount?: CommerceMoney;
 amount?: CommerceMoneyAmount;
 credit?: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 };
 isFreeTrial!: boolean;

Expand All@@ -98,8 +98,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 this.periodEnd = data.period_end ? unixEpochToDate(data.period_end) : null;
 this.canceledAt = data.canceled_at ? unixEpochToDate(data.canceled_at) : null;

 this.amount = data.amount ? commerceMoneyFromJSON(data.amount) : undefined;
 this.credit = data.credit && data.credit.amount ? { amount: commerceMoneyFromJSON(data.credit.amount) } : undefined;
 this.amount = data.amount ? commerceMoneyAmountFromJSON(data.amount) : undefined;
 this.credit =
 data.credit && data.credit.amount ? { amount: commerceMoneyAmountFromJSON(data.credit.amount) } : undefined;

 this.isFreeTrial = this.withDefault(data.is_free_trial, false);
 return this;
Expand Down

8 changes: 5 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { __experimental_useCheckout as useCheckout, useOrganization } from '@clerk/shared/react';
import type { CommerceMoney, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import type { CommerceMoneyAmount, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import { useMemo, useState } from 'react';

import { Card } from '@/ui/elements/Card';
Expand DownExpand Up@@ -35,6 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

 const fee = planPeriod === 'month' ? plan.fee : plan.annualMonthlyFee;

Comment thread
panteliselef marked this conversation as resolved.

 return (
 <Drawer.Body>
 <Box
Expand All@@ -54,7 +56,7 @@ export const CheckoutForm = withCardStateProvider(() => {
 />
 <LineItems.Description
 prefix={planPeriod === 'annual' ? 'x12' : undefined}
 text={`${plan.currencySymbol}${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
 text={`${fee.currencySymbol}${fee.amountFormatted}`}
 suffix={localizationKeys('commerce.checkout.perMonth')}
 />

Comment on lines

58
 to 
61

@coderabbitaicoderabbitaiBotAug 8, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Localize hard-coded 'x12' multiplier
All user-facing strings must be localized. Replace 'x12' with a localization key (e.g., commerce.checkout.x12) or a parameterized key.
- prefix={planPeriod === 'annual' ? 'x12' : undefined}+ prefix={planPeriod === 'annual' ? localizationKeys('commerce.checkout.x12') : undefined}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

prefix={planPeriod ==='annual' ? 'x12' : undefined}
text={`${plan.currencySymbol}${planPeriod==='month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
prefix={planPeriod ==='annual' ? localizationKeys('commerce.checkout.x12') : undefined}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx around lines 58
to 61, the hard-coded string 'x12' used as a prefix should be replaced with a
localized string. Update the code to use a localization key such as
'commerce.checkout.x12' or a parameterized localization key instead of the
literal 'x12' to ensure all user-facing strings are properly localized.

 </LineItems.Group>
Expand DownExpand Up@@ -312,7 +314,7 @@ const ExistingPaymentSourceForm = withCardStateProvider(
 totalDueNow,
 paymentSources,
 }: {
 totalDueNow: CommerceMoney;
 totalDueNow: CommerceMoneyAmount;
 paymentSources: CommercePaymentSourceResource[];
 }) => {
 const { checkout } = useCheckout();
Expand Down
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
chore(clerk-js,types): Switch to fees for plan prices#6490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 13 commits into

from

Aug 12, 2025
 Merged


chore(clerk-js,types): Switch to fees for plan prices
#6490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
d7daf96

chore(clerk-js,types): Switch to fees for plan prices


panteliselef Aug 8, 2025
53d1c86

address test in react


panteliselef Aug 8, 2025
6975c49

address feedback from rabbit


panteliselef Aug 8, 2025
69c583c

update typedoc


panteliselef Aug 8, 2025
0100be0

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 8, 2025
360986c

remove duplication


panteliselef Aug 12, 2025
171100a

Merge branch 'refs/heads/main' into elef/com-1139-remove-amount-usage…


panteliselef Aug 12, 2025
0bb6872

leftover after conflicts


panteliselef Aug 12, 2025
6a0d739

update fees to moneyamount


panteliselef Aug 12, 2025
dbe1805

update typedocs


panteliselef Aug 12, 2025
3dd40eb

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
22841e6

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
5377039

patch test


panteliselef Aug 12, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/rich-drinks-ring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Replace usage of top level amounts in plan with fees for displaying prices.

4 changes: 2 additions & 2 deletions
.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "types/commerce-feature-resource.mdx",
 "types/commerce-initialized-payment-source-json.mdx",
 "types/commerce-initialized-payment-source-resource.mdx",
 "types/commerce-money-json.mdx",
 "types/commerce-money.mdx",
 "types/commerce-money-amount-json.mdx",
 "types/commerce-money-amount.mdx",
 "types/commerce-payer-resource-type.mdx",
 "types/commerce-payment-charge-type.mdx",
 "types/commerce-payment-json.mdx",
Expand Down

8 changes: 4 additions & 4 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';

type CommerceFee = {
type CommerceMoneyAmount = {
 amount: number;
 amountFormatted: string;
 currency: string;
Expand DownExpand Up@@ -53,15 +53,15 @@ export class CommercePlan {
 /**
 * The monthly fee of the plan.
 */
 readonly fee: CommerceFee,
 readonly fee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan.
 */
 readonly annualFee: CommerceFee,
 readonly annualFee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan on a monthly basis.
 */
 readonly annualMonthlyFee: CommerceFee,
 readonly annualMonthlyFee: CommerceMoneyAmount,
 /**
 * The type of payer for the plan.
 */
Expand Down

18 changes: 9 additions & 9 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -800,17 +800,17 @@ interface CommercePayeeJSON {
 gateway_status: 'active' | 'pending' | 'restricted' | 'disconnected';
}

interface CommerceFeeJSON {
interface CommerceMoneyAmountJSON {
 amount: number;
 amount_formatted: string;
 currency: string;
 currency_symbol: string;
}

interface CommerceTotalsJSON {
 subtotal: CommerceFeeJSON;
 tax_total: CommerceFeeJSON;
 grand_total: CommerceFeeJSON;
 subtotal: CommerceMoneyAmountJSON;
 tax_total: CommerceMoneyAmountJSON;
 grand_total: CommerceMoneyAmountJSON;
}

export interface FeatureJSON extends ClerkResourceJSON {
Expand All@@ -836,9 +836,9 @@ export interface CommercePlanJSON extends ClerkResourceJSON {
 is_recurring: boolean;
 has_base_fee: boolean;
 publicly_visible: boolean;
 fee: CommerceFeeJSON;
 annual_fee: CommerceFeeJSON;
 annual_monthly_fee: CommerceFeeJSON;
 fee: CommerceMoneyAmountJSON;
 annual_fee: CommerceMoneyAmountJSON;
 annual_monthly_fee: CommerceMoneyAmountJSON;
 for_payer_type: 'org' | 'user';
 features: FeatureJSON[];
}
Expand All@@ -847,7 +847,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.CommerceSubscriptionItem;
 status: 'abandoned' | 'active' | 'canceled' | 'ended' | 'expired' | 'incomplete' | 'past_due' | 'upcoming';
 credit: {
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
Expand All@@ -861,7 +861,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 lifetime_paid: number;
 next_payment_amount: number;
 next_payment_date: number;
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 plan: {
 id: string;
 instance_id: string;
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/core/resources/CommercePayment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
CommerceMoney,
CommerceMoneyAmount,
 CommercePaymentChargeType,
 CommercePaymentJSON,
 CommercePaymentResource,
Expand All@@ -8,13 +8,13 @@ import type {
 CommerceSubscriptionItemResource,
} from '@clerk/types';

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, CommercePaymentSource, CommerceSubscriptionItem } from './internal';

export class CommercePayment extends BaseResource implements CommercePaymentResource {
 id!: string;
 amount!: CommerceMoney;
 amount!: CommerceMoneyAmount;
 failedAt?: Date;
 paidAt?: Date;
 updatedAt!: Date;
Expand All@@ -38,7 +38,7 @@ export class CommercePayment extends BaseResource implements CommercePaymentReso
 }

 this.id = data.id;
 this.amount = commerceMoneyFromJSON(data.amount);
 this.amount = commerceMoneyAmountFromJSON(data.amount);
 this.paidAt = data.paid_at ? unixEpochToDate(data.paid_at) : undefined;
 this.failedAt = data.failed_at ? unixEpochToDate(data.failed_at) : undefined;
 this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down

51 changes: 9 additions & 42 deletions
packages/clerk-js/src/core/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
import type {
 CommerceMoneyAmount,
 CommercePayerResourceType,
 CommercePlanJSON,
 CommercePlanJSONSnapshot,
 CommercePlanResource,
} from '@clerk/types';

import { commerceMoneyAmountFromJSON } from '@/utils/commerce';

import { BaseResource, CommerceFeature } from './internal';

export class CommercePlan extends BaseResource implements CommercePlanResource {
 id!: string;
 name!: string;
 amount!: number;
 amountFormatted!: string;
 annualAmount!: number;
 annualAmountFormatted!: string;
 annualMonthlyAmount!: number;
 annualMonthlyAmountFormatted!: string;
 currencySymbol!: string;
 currency!: string;
 fee!: CommerceMoneyAmount;
 annualFee!: CommerceMoneyAmount;
 annualMonthlyFee!: CommerceMoneyAmount;
 description!: string;
 isDefault!: boolean;
 isRecurring!: boolean;
Expand All@@ -42,14 +39,9 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 this.id = data.id;
 this.name = data.name;
 this.amount = data.amount;
 this.amountFormatted = data.amount_formatted;
 this.annualAmount = data.annual_amount;
 this.annualAmountFormatted = data.annual_amount_formatted;
 this.annualMonthlyAmount = data.annual_monthly_amount;
 this.annualMonthlyAmountFormatted = data.annual_monthly_amount_formatted;
 this.currencySymbol = data.currency_symbol;
 this.currency = data.currency;
 this.fee = commerceMoneyAmountFromJSON(data.fee);
 this.annualFee = commerceMoneyAmountFromJSON(data.annual_fee);
 this.annualMonthlyFee = commerceMoneyAmountFromJSON(data.annual_monthly_fee);
 this.description = data.description;
 this.isDefault = data.is_default;
 this.isRecurring = data.is_recurring;
Expand All@@ -64,29 +56,4 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 return this;
 }

 public __internal_toSnapshot(): CommercePlanJSONSnapshot {
 return {
 object: 'commerce_plan',
 id: this.id,
 name: this.name,
 amount: this.amount,
 amount_formatted: this.amountFormatted,
 annual_amount: this.annualAmount,
 annual_amount_formatted: this.annualAmountFormatted,
 annual_monthly_amount: this.annualMonthlyAmount,
 annual_monthly_amount_formatted: this.annualMonthlyAmountFormatted,
 currency: this.currency,
 currency_symbol: this.currencySymbol,
 description: this.description,
 is_default: this.isDefault,
 is_recurring: this.isRecurring,
 has_base_fee: this.hasBaseFee,
 for_payer_type: this.forPayerType,
 publicly_visible: this.publiclyVisible,
 slug: this.slug,
 avatar_url: this.avatarUrl,
 features: this.features.map(feature => feature.__internal_toSnapshot()),
 };
 }
}

17 changes: 9 additions & 8 deletions
packages/clerk-js/src/core/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type {
 CancelSubscriptionParams,
CommerceMoney,
CommerceMoneyAmount,
 CommerceSubscriptionItemJSON,
 CommerceSubscriptionItemResource,
 CommerceSubscriptionJSON,
Expand All@@ -12,7 +12,7 @@ import type {

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

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { BaseResource, CommercePlan, DeletedObject } from './internal';

export class CommerceSubscription extends BaseResource implements CommerceSubscriptionResource {
Expand All@@ -23,7 +23,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 pastDueAt!: Date | null;
 updatedAt!: Date | null;
 nextPayment: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 date: Date;
 } | null = null;
 subscriptionItems!: CommerceSubscriptionItemResource[];
Expand All@@ -47,7 +47,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;
 this.nextPayment = data.next_payment
 ? {
 amount: commerceMoneyFromJSON(data.next_payment.amount),
 amount: commerceMoneyAmountFromJSON(data.next_payment.amount),
 date: unixEpochToDate(data.next_payment.date),
 }
 : null;
Expand All@@ -69,9 +69,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 canceledAt!: Date | null;
 pastDueAt!: Date | null;
 //TODO(@COMMERCE): Why can this be undefined ?
 amount?: CommerceMoney;
 amount?: CommerceMoneyAmount;
 credit?: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 };
 isFreeTrial!: boolean;

Expand All@@ -98,8 +98,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 this.periodEnd = data.period_end ? unixEpochToDate(data.period_end) : null;
 this.canceledAt = data.canceled_at ? unixEpochToDate(data.canceled_at) : null;

 this.amount = data.amount ? commerceMoneyFromJSON(data.amount) : undefined;
 this.credit = data.credit && data.credit.amount ? { amount: commerceMoneyFromJSON(data.credit.amount) } : undefined;
 this.amount = data.amount ? commerceMoneyAmountFromJSON(data.amount) : undefined;
 this.credit =
 data.credit && data.credit.amount ? { amount: commerceMoneyAmountFromJSON(data.credit.amount) } : undefined;

 this.isFreeTrial = this.withDefault(data.is_free_trial, false);
 return this;
Expand Down

8 changes: 5 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { __experimental_useCheckout as useCheckout, useOrganization } from '@clerk/shared/react';
import type { CommerceMoney, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import type { CommerceMoneyAmount, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import { useMemo, useState } from 'react';

import { Card } from '@/ui/elements/Card';
Expand DownExpand Up@@ -35,6 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

 const fee = planPeriod === 'month' ? plan.fee : plan.annualMonthlyFee;

Comment thread
panteliselef marked this conversation as resolved.

 return (
 <Drawer.Body>
 <Box
Expand All@@ -54,7 +56,7 @@ export const CheckoutForm = withCardStateProvider(() => {
 />
 <LineItems.Description
 prefix={planPeriod === 'annual' ? 'x12' : undefined}
 text={`${plan.currencySymbol}${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
 text={`${fee.currencySymbol}${fee.amountFormatted}`}
 suffix={localizationKeys('commerce.checkout.perMonth')}
 />

Comment on lines

58
 to 
61

@coderabbitaicoderabbitaiBotAug 8, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Localize hard-coded 'x12' multiplier
All user-facing strings must be localized. Replace 'x12' with a localization key (e.g., commerce.checkout.x12) or a parameterized key.
- prefix={planPeriod === 'annual' ? 'x12' : undefined}+ prefix={planPeriod === 'annual' ? localizationKeys('commerce.checkout.x12') : undefined}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

prefix={planPeriod ==='annual' ? 'x12' : undefined}
text={`${plan.currencySymbol}${planPeriod==='month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
prefix={planPeriod ==='annual' ? localizationKeys('commerce.checkout.x12') : undefined}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx around lines 58
to 61, the hard-coded string 'x12' used as a prefix should be replaced with a
localized string. Update the code to use a localization key such as
'commerce.checkout.x12' or a parameterized localization key instead of the
literal 'x12' to ensure all user-facing strings are properly localized.

 </LineItems.Group>
Expand DownExpand Up@@ -312,7 +314,7 @@ const ExistingPaymentSourceForm = withCardStateProvider(
 totalDueNow,
 paymentSources,
 }: {
 totalDueNow: CommerceMoney;
 totalDueNow: CommerceMoneyAmount;
 paymentSources: CommercePaymentSourceResource[];
 }) => {
 const { checkout } = useCheckout();
Expand Down
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
chore(clerk-js,types): Switch to fees for plan prices#6490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 13 commits into

from

Aug 12, 2025
 Merged


chore(clerk-js,types): Switch to fees for plan prices
#6490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
d7daf96

chore(clerk-js,types): Switch to fees for plan prices


panteliselef Aug 8, 2025
53d1c86

address test in react


panteliselef Aug 8, 2025
6975c49

address feedback from rabbit


panteliselef Aug 8, 2025
69c583c

update typedoc


panteliselef Aug 8, 2025
0100be0

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 8, 2025
360986c

remove duplication


panteliselef Aug 12, 2025
171100a

Merge branch 'refs/heads/main' into elef/com-1139-remove-amount-usage…


panteliselef Aug 12, 2025
0bb6872

leftover after conflicts


panteliselef Aug 12, 2025
6a0d739

update fees to moneyamount


panteliselef Aug 12, 2025
dbe1805

update typedocs


panteliselef Aug 12, 2025
3dd40eb

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
22841e6

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
5377039

patch test


panteliselef Aug 12, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/rich-drinks-ring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Replace usage of top level amounts in plan with fees for displaying prices.

4 changes: 2 additions & 2 deletions
.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "types/commerce-feature-resource.mdx",
 "types/commerce-initialized-payment-source-json.mdx",
 "types/commerce-initialized-payment-source-resource.mdx",
 "types/commerce-money-json.mdx",
 "types/commerce-money.mdx",
 "types/commerce-money-amount-json.mdx",
 "types/commerce-money-amount.mdx",
 "types/commerce-payer-resource-type.mdx",
 "types/commerce-payment-charge-type.mdx",
 "types/commerce-payment-json.mdx",
Expand Down

8 changes: 4 additions & 4 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';

type CommerceFee = {
type CommerceMoneyAmount = {
 amount: number;
 amountFormatted: string;
 currency: string;
Expand DownExpand Up@@ -53,15 +53,15 @@ export class CommercePlan {
 /**
 * The monthly fee of the plan.
 */
 readonly fee: CommerceFee,
 readonly fee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan.
 */
 readonly annualFee: CommerceFee,
 readonly annualFee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan on a monthly basis.
 */
 readonly annualMonthlyFee: CommerceFee,
 readonly annualMonthlyFee: CommerceMoneyAmount,
 /**
 * The type of payer for the plan.
 */
Expand Down

18 changes: 9 additions & 9 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -800,17 +800,17 @@ interface CommercePayeeJSON {
 gateway_status: 'active' | 'pending' | 'restricted' | 'disconnected';
}

interface CommerceFeeJSON {
interface CommerceMoneyAmountJSON {
 amount: number;
 amount_formatted: string;
 currency: string;
 currency_symbol: string;
}

interface CommerceTotalsJSON {
 subtotal: CommerceFeeJSON;
 tax_total: CommerceFeeJSON;
 grand_total: CommerceFeeJSON;
 subtotal: CommerceMoneyAmountJSON;
 tax_total: CommerceMoneyAmountJSON;
 grand_total: CommerceMoneyAmountJSON;
}

export interface FeatureJSON extends ClerkResourceJSON {
Expand All@@ -836,9 +836,9 @@ export interface CommercePlanJSON extends ClerkResourceJSON {
 is_recurring: boolean;
 has_base_fee: boolean;
 publicly_visible: boolean;
 fee: CommerceFeeJSON;
 annual_fee: CommerceFeeJSON;
 annual_monthly_fee: CommerceFeeJSON;
 fee: CommerceMoneyAmountJSON;
 annual_fee: CommerceMoneyAmountJSON;
 annual_monthly_fee: CommerceMoneyAmountJSON;
 for_payer_type: 'org' | 'user';
 features: FeatureJSON[];
}
Expand All@@ -847,7 +847,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.CommerceSubscriptionItem;
 status: 'abandoned' | 'active' | 'canceled' | 'ended' | 'expired' | 'incomplete' | 'past_due' | 'upcoming';
 credit: {
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
Expand All@@ -861,7 +861,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 lifetime_paid: number;
 next_payment_amount: number;
 next_payment_date: number;
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 plan: {
 id: string;
 instance_id: string;
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/core/resources/CommercePayment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
CommerceMoney,
CommerceMoneyAmount,
 CommercePaymentChargeType,
 CommercePaymentJSON,
 CommercePaymentResource,
Expand All@@ -8,13 +8,13 @@ import type {
 CommerceSubscriptionItemResource,
} from '@clerk/types';

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, CommercePaymentSource, CommerceSubscriptionItem } from './internal';

export class CommercePayment extends BaseResource implements CommercePaymentResource {
 id!: string;
 amount!: CommerceMoney;
 amount!: CommerceMoneyAmount;
 failedAt?: Date;
 paidAt?: Date;
 updatedAt!: Date;
Expand All@@ -38,7 +38,7 @@ export class CommercePayment extends BaseResource implements CommercePaymentReso
 }

 this.id = data.id;
 this.amount = commerceMoneyFromJSON(data.amount);
 this.amount = commerceMoneyAmountFromJSON(data.amount);
 this.paidAt = data.paid_at ? unixEpochToDate(data.paid_at) : undefined;
 this.failedAt = data.failed_at ? unixEpochToDate(data.failed_at) : undefined;
 this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down

51 changes: 9 additions & 42 deletions
packages/clerk-js/src/core/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
import type {
 CommerceMoneyAmount,
 CommercePayerResourceType,
 CommercePlanJSON,
 CommercePlanJSONSnapshot,
 CommercePlanResource,
} from '@clerk/types';

import { commerceMoneyAmountFromJSON } from '@/utils/commerce';

import { BaseResource, CommerceFeature } from './internal';

export class CommercePlan extends BaseResource implements CommercePlanResource {
 id!: string;
 name!: string;
 amount!: number;
 amountFormatted!: string;
 annualAmount!: number;
 annualAmountFormatted!: string;
 annualMonthlyAmount!: number;
 annualMonthlyAmountFormatted!: string;
 currencySymbol!: string;
 currency!: string;
 fee!: CommerceMoneyAmount;
 annualFee!: CommerceMoneyAmount;
 annualMonthlyFee!: CommerceMoneyAmount;
 description!: string;
 isDefault!: boolean;
 isRecurring!: boolean;
Expand All@@ -42,14 +39,9 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 this.id = data.id;
 this.name = data.name;
 this.amount = data.amount;
 this.amountFormatted = data.amount_formatted;
 this.annualAmount = data.annual_amount;
 this.annualAmountFormatted = data.annual_amount_formatted;
 this.annualMonthlyAmount = data.annual_monthly_amount;
 this.annualMonthlyAmountFormatted = data.annual_monthly_amount_formatted;
 this.currencySymbol = data.currency_symbol;
 this.currency = data.currency;
 this.fee = commerceMoneyAmountFromJSON(data.fee);
 this.annualFee = commerceMoneyAmountFromJSON(data.annual_fee);
 this.annualMonthlyFee = commerceMoneyAmountFromJSON(data.annual_monthly_fee);
 this.description = data.description;
 this.isDefault = data.is_default;
 this.isRecurring = data.is_recurring;
Expand All@@ -64,29 +56,4 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 return this;
 }

 public __internal_toSnapshot(): CommercePlanJSONSnapshot {
 return {
 object: 'commerce_plan',
 id: this.id,
 name: this.name,
 amount: this.amount,
 amount_formatted: this.amountFormatted,
 annual_amount: this.annualAmount,
 annual_amount_formatted: this.annualAmountFormatted,
 annual_monthly_amount: this.annualMonthlyAmount,
 annual_monthly_amount_formatted: this.annualMonthlyAmountFormatted,
 currency: this.currency,
 currency_symbol: this.currencySymbol,
 description: this.description,
 is_default: this.isDefault,
 is_recurring: this.isRecurring,
 has_base_fee: this.hasBaseFee,
 for_payer_type: this.forPayerType,
 publicly_visible: this.publiclyVisible,
 slug: this.slug,
 avatar_url: this.avatarUrl,
 features: this.features.map(feature => feature.__internal_toSnapshot()),
 };
 }
}

17 changes: 9 additions & 8 deletions
packages/clerk-js/src/core/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type {
 CancelSubscriptionParams,
CommerceMoney,
CommerceMoneyAmount,
 CommerceSubscriptionItemJSON,
 CommerceSubscriptionItemResource,
 CommerceSubscriptionJSON,
Expand All@@ -12,7 +12,7 @@ import type {

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

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { BaseResource, CommercePlan, DeletedObject } from './internal';

export class CommerceSubscription extends BaseResource implements CommerceSubscriptionResource {
Expand All@@ -23,7 +23,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 pastDueAt!: Date | null;
 updatedAt!: Date | null;
 nextPayment: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 date: Date;
 } | null = null;
 subscriptionItems!: CommerceSubscriptionItemResource[];
Expand All@@ -47,7 +47,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;
 this.nextPayment = data.next_payment
 ? {
 amount: commerceMoneyFromJSON(data.next_payment.amount),
 amount: commerceMoneyAmountFromJSON(data.next_payment.amount),
 date: unixEpochToDate(data.next_payment.date),
 }
 : null;
Expand All@@ -69,9 +69,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 canceledAt!: Date | null;
 pastDueAt!: Date | null;
 //TODO(@COMMERCE): Why can this be undefined ?
 amount?: CommerceMoney;
 amount?: CommerceMoneyAmount;
 credit?: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 };
 isFreeTrial!: boolean;

Expand All@@ -98,8 +98,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 this.periodEnd = data.period_end ? unixEpochToDate(data.period_end) : null;
 this.canceledAt = data.canceled_at ? unixEpochToDate(data.canceled_at) : null;

 this.amount = data.amount ? commerceMoneyFromJSON(data.amount) : undefined;
 this.credit = data.credit && data.credit.amount ? { amount: commerceMoneyFromJSON(data.credit.amount) } : undefined;
 this.amount = data.amount ? commerceMoneyAmountFromJSON(data.amount) : undefined;
 this.credit =
 data.credit && data.credit.amount ? { amount: commerceMoneyAmountFromJSON(data.credit.amount) } : undefined;

 this.isFreeTrial = this.withDefault(data.is_free_trial, false);
 return this;
Expand Down

8 changes: 5 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { __experimental_useCheckout as useCheckout, useOrganization } from '@clerk/shared/react';
import type { CommerceMoney, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import type { CommerceMoneyAmount, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import { useMemo, useState } from 'react';

import { Card } from '@/ui/elements/Card';
Expand DownExpand Up@@ -35,6 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

 const fee = planPeriod === 'month' ? plan.fee : plan.annualMonthlyFee;

Comment thread
panteliselef marked this conversation as resolved.

 return (
 <Drawer.Body>
 <Box
Expand All@@ -54,7 +56,7 @@ export const CheckoutForm = withCardStateProvider(() => {
 />
 <LineItems.Description
 prefix={planPeriod === 'annual' ? 'x12' : undefined}
 text={`${plan.currencySymbol}${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
 text={`${fee.currencySymbol}${fee.amountFormatted}`}
 suffix={localizationKeys('commerce.checkout.perMonth')}
 />

Comment on lines

58
 to 
61

@coderabbitaicoderabbitaiBotAug 8, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Localize hard-coded 'x12' multiplier
All user-facing strings must be localized. Replace 'x12' with a localization key (e.g., commerce.checkout.x12) or a parameterized key.
- prefix={planPeriod === 'annual' ? 'x12' : undefined}+ prefix={planPeriod === 'annual' ? localizationKeys('commerce.checkout.x12') : undefined}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

prefix={planPeriod ==='annual' ? 'x12' : undefined}
text={`${plan.currencySymbol}${planPeriod==='month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
prefix={planPeriod ==='annual' ? localizationKeys('commerce.checkout.x12') : undefined}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx around lines 58
to 61, the hard-coded string 'x12' used as a prefix should be replaced with a
localized string. Update the code to use a localization key such as
'commerce.checkout.x12' or a parameterized localization key instead of the
literal 'x12' to ensure all user-facing strings are properly localized.

 </LineItems.Group>
Expand DownExpand Up@@ -312,7 +314,7 @@ const ExistingPaymentSourceForm = withCardStateProvider(
 totalDueNow,
 paymentSources,
 }: {
 totalDueNow: CommerceMoney;
 totalDueNow: CommerceMoneyAmount;
 paymentSources: CommercePaymentSourceResource[];
 }) => {
 const { checkout } = useCheckout();
Expand Down
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
chore(clerk-js,types): Switch to fees for plan prices#6490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 13 commits into

from

Aug 12, 2025
 Merged


chore(clerk-js,types): Switch to fees for plan prices
#6490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
d7daf96

chore(clerk-js,types): Switch to fees for plan prices


panteliselef Aug 8, 2025
53d1c86

address test in react


panteliselef Aug 8, 2025
6975c49

address feedback from rabbit


panteliselef Aug 8, 2025
69c583c

update typedoc


panteliselef Aug 8, 2025
0100be0

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 8, 2025
360986c

remove duplication


panteliselef Aug 12, 2025
171100a

Merge branch 'refs/heads/main' into elef/com-1139-remove-amount-usage…


panteliselef Aug 12, 2025
0bb6872

leftover after conflicts


panteliselef Aug 12, 2025
6a0d739

update fees to moneyamount


panteliselef Aug 12, 2025
dbe1805

update typedocs


panteliselef Aug 12, 2025
3dd40eb

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
22841e6

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
5377039

patch test


panteliselef Aug 12, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/rich-drinks-ring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Replace usage of top level amounts in plan with fees for displaying prices.

4 changes: 2 additions & 2 deletions
.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "types/commerce-feature-resource.mdx",
 "types/commerce-initialized-payment-source-json.mdx",
 "types/commerce-initialized-payment-source-resource.mdx",
 "types/commerce-money-json.mdx",
 "types/commerce-money.mdx",
 "types/commerce-money-amount-json.mdx",
 "types/commerce-money-amount.mdx",
 "types/commerce-payer-resource-type.mdx",
 "types/commerce-payment-charge-type.mdx",
 "types/commerce-payment-json.mdx",
Expand Down

8 changes: 4 additions & 4 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';

type CommerceFee = {
type CommerceMoneyAmount = {
 amount: number;
 amountFormatted: string;
 currency: string;
Expand DownExpand Up@@ -53,15 +53,15 @@ export class CommercePlan {
 /**
 * The monthly fee of the plan.
 */
 readonly fee: CommerceFee,
 readonly fee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan.
 */
 readonly annualFee: CommerceFee,
 readonly annualFee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan on a monthly basis.
 */
 readonly annualMonthlyFee: CommerceFee,
 readonly annualMonthlyFee: CommerceMoneyAmount,
 /**
 * The type of payer for the plan.
 */
Expand Down

18 changes: 9 additions & 9 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -800,17 +800,17 @@ interface CommercePayeeJSON {
 gateway_status: 'active' | 'pending' | 'restricted' | 'disconnected';
}

interface CommerceFeeJSON {
interface CommerceMoneyAmountJSON {
 amount: number;
 amount_formatted: string;
 currency: string;
 currency_symbol: string;
}

interface CommerceTotalsJSON {
 subtotal: CommerceFeeJSON;
 tax_total: CommerceFeeJSON;
 grand_total: CommerceFeeJSON;
 subtotal: CommerceMoneyAmountJSON;
 tax_total: CommerceMoneyAmountJSON;
 grand_total: CommerceMoneyAmountJSON;
}

export interface FeatureJSON extends ClerkResourceJSON {
Expand All@@ -836,9 +836,9 @@ export interface CommercePlanJSON extends ClerkResourceJSON {
 is_recurring: boolean;
 has_base_fee: boolean;
 publicly_visible: boolean;
 fee: CommerceFeeJSON;
 annual_fee: CommerceFeeJSON;
 annual_monthly_fee: CommerceFeeJSON;
 fee: CommerceMoneyAmountJSON;
 annual_fee: CommerceMoneyAmountJSON;
 annual_monthly_fee: CommerceMoneyAmountJSON;
 for_payer_type: 'org' | 'user';
 features: FeatureJSON[];
}
Expand All@@ -847,7 +847,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.CommerceSubscriptionItem;
 status: 'abandoned' | 'active' | 'canceled' | 'ended' | 'expired' | 'incomplete' | 'past_due' | 'upcoming';
 credit: {
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
Expand All@@ -861,7 +861,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 lifetime_paid: number;
 next_payment_amount: number;
 next_payment_date: number;
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 plan: {
 id: string;
 instance_id: string;
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/core/resources/CommercePayment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
CommerceMoney,
CommerceMoneyAmount,
 CommercePaymentChargeType,
 CommercePaymentJSON,
 CommercePaymentResource,
Expand All@@ -8,13 +8,13 @@ import type {
 CommerceSubscriptionItemResource,
} from '@clerk/types';

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, CommercePaymentSource, CommerceSubscriptionItem } from './internal';

export class CommercePayment extends BaseResource implements CommercePaymentResource {
 id!: string;
 amount!: CommerceMoney;
 amount!: CommerceMoneyAmount;
 failedAt?: Date;
 paidAt?: Date;
 updatedAt!: Date;
Expand All@@ -38,7 +38,7 @@ export class CommercePayment extends BaseResource implements CommercePaymentReso
 }

 this.id = data.id;
 this.amount = commerceMoneyFromJSON(data.amount);
 this.amount = commerceMoneyAmountFromJSON(data.amount);
 this.paidAt = data.paid_at ? unixEpochToDate(data.paid_at) : undefined;
 this.failedAt = data.failed_at ? unixEpochToDate(data.failed_at) : undefined;
 this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down

51 changes: 9 additions & 42 deletions
packages/clerk-js/src/core/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
import type {
 CommerceMoneyAmount,
 CommercePayerResourceType,
 CommercePlanJSON,
 CommercePlanJSONSnapshot,
 CommercePlanResource,
} from '@clerk/types';

import { commerceMoneyAmountFromJSON } from '@/utils/commerce';

import { BaseResource, CommerceFeature } from './internal';

export class CommercePlan extends BaseResource implements CommercePlanResource {
 id!: string;
 name!: string;
 amount!: number;
 amountFormatted!: string;
 annualAmount!: number;
 annualAmountFormatted!: string;
 annualMonthlyAmount!: number;
 annualMonthlyAmountFormatted!: string;
 currencySymbol!: string;
 currency!: string;
 fee!: CommerceMoneyAmount;
 annualFee!: CommerceMoneyAmount;
 annualMonthlyFee!: CommerceMoneyAmount;
 description!: string;
 isDefault!: boolean;
 isRecurring!: boolean;
Expand All@@ -42,14 +39,9 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 this.id = data.id;
 this.name = data.name;
 this.amount = data.amount;
 this.amountFormatted = data.amount_formatted;
 this.annualAmount = data.annual_amount;
 this.annualAmountFormatted = data.annual_amount_formatted;
 this.annualMonthlyAmount = data.annual_monthly_amount;
 this.annualMonthlyAmountFormatted = data.annual_monthly_amount_formatted;
 this.currencySymbol = data.currency_symbol;
 this.currency = data.currency;
 this.fee = commerceMoneyAmountFromJSON(data.fee);
 this.annualFee = commerceMoneyAmountFromJSON(data.annual_fee);
 this.annualMonthlyFee = commerceMoneyAmountFromJSON(data.annual_monthly_fee);
 this.description = data.description;
 this.isDefault = data.is_default;
 this.isRecurring = data.is_recurring;
Expand All@@ -64,29 +56,4 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 return this;
 }

 public __internal_toSnapshot(): CommercePlanJSONSnapshot {
 return {
 object: 'commerce_plan',
 id: this.id,
 name: this.name,
 amount: this.amount,
 amount_formatted: this.amountFormatted,
 annual_amount: this.annualAmount,
 annual_amount_formatted: this.annualAmountFormatted,
 annual_monthly_amount: this.annualMonthlyAmount,
 annual_monthly_amount_formatted: this.annualMonthlyAmountFormatted,
 currency: this.currency,
 currency_symbol: this.currencySymbol,
 description: this.description,
 is_default: this.isDefault,
 is_recurring: this.isRecurring,
 has_base_fee: this.hasBaseFee,
 for_payer_type: this.forPayerType,
 publicly_visible: this.publiclyVisible,
 slug: this.slug,
 avatar_url: this.avatarUrl,
 features: this.features.map(feature => feature.__internal_toSnapshot()),
 };
 }
}

17 changes: 9 additions & 8 deletions
packages/clerk-js/src/core/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type {
 CancelSubscriptionParams,
CommerceMoney,
CommerceMoneyAmount,
 CommerceSubscriptionItemJSON,
 CommerceSubscriptionItemResource,
 CommerceSubscriptionJSON,
Expand All@@ -12,7 +12,7 @@ import type {

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

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { BaseResource, CommercePlan, DeletedObject } from './internal';

export class CommerceSubscription extends BaseResource implements CommerceSubscriptionResource {
Expand All@@ -23,7 +23,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 pastDueAt!: Date | null;
 updatedAt!: Date | null;
 nextPayment: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 date: Date;
 } | null = null;
 subscriptionItems!: CommerceSubscriptionItemResource[];
Expand All@@ -47,7 +47,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;
 this.nextPayment = data.next_payment
 ? {
 amount: commerceMoneyFromJSON(data.next_payment.amount),
 amount: commerceMoneyAmountFromJSON(data.next_payment.amount),
 date: unixEpochToDate(data.next_payment.date),
 }
 : null;
Expand All@@ -69,9 +69,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 canceledAt!: Date | null;
 pastDueAt!: Date | null;
 //TODO(@COMMERCE): Why can this be undefined ?
 amount?: CommerceMoney;
 amount?: CommerceMoneyAmount;
 credit?: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 };
 isFreeTrial!: boolean;

Expand All@@ -98,8 +98,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 this.periodEnd = data.period_end ? unixEpochToDate(data.period_end) : null;
 this.canceledAt = data.canceled_at ? unixEpochToDate(data.canceled_at) : null;

 this.amount = data.amount ? commerceMoneyFromJSON(data.amount) : undefined;
 this.credit = data.credit && data.credit.amount ? { amount: commerceMoneyFromJSON(data.credit.amount) } : undefined;
 this.amount = data.amount ? commerceMoneyAmountFromJSON(data.amount) : undefined;
 this.credit =
 data.credit && data.credit.amount ? { amount: commerceMoneyAmountFromJSON(data.credit.amount) } : undefined;

 this.isFreeTrial = this.withDefault(data.is_free_trial, false);
 return this;
Expand Down

8 changes: 5 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { __experimental_useCheckout as useCheckout, useOrganization } from '@clerk/shared/react';
import type { CommerceMoney, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import type { CommerceMoneyAmount, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import { useMemo, useState } from 'react';

import { Card } from '@/ui/elements/Card';
Expand DownExpand Up@@ -35,6 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

 const fee = planPeriod === 'month' ? plan.fee : plan.annualMonthlyFee;

Comment thread
panteliselef marked this conversation as resolved.

 return (
 <Drawer.Body>
 <Box
Expand All@@ -54,7 +56,7 @@ export const CheckoutForm = withCardStateProvider(() => {
 />
 <LineItems.Description
 prefix={planPeriod === 'annual' ? 'x12' : undefined}
 text={`${plan.currencySymbol}${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
 text={`${fee.currencySymbol}${fee.amountFormatted}`}
 suffix={localizationKeys('commerce.checkout.perMonth')}
 />

Comment on lines

58
 to 
61

@coderabbitaicoderabbitaiBotAug 8, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Localize hard-coded 'x12' multiplier
All user-facing strings must be localized. Replace 'x12' with a localization key (e.g., commerce.checkout.x12) or a parameterized key.
- prefix={planPeriod === 'annual' ? 'x12' : undefined}+ prefix={planPeriod === 'annual' ? localizationKeys('commerce.checkout.x12') : undefined}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

prefix={planPeriod ==='annual' ? 'x12' : undefined}
text={`${plan.currencySymbol}${planPeriod==='month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
prefix={planPeriod ==='annual' ? localizationKeys('commerce.checkout.x12') : undefined}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx around lines 58
to 61, the hard-coded string 'x12' used as a prefix should be replaced with a
localized string. Update the code to use a localization key such as
'commerce.checkout.x12' or a parameterized localization key instead of the
literal 'x12' to ensure all user-facing strings are properly localized.

 </LineItems.Group>
Expand DownExpand Up@@ -312,7 +314,7 @@ const ExistingPaymentSourceForm = withCardStateProvider(
 totalDueNow,
 paymentSources,
 }: {
 totalDueNow: CommerceMoney;
 totalDueNow: CommerceMoneyAmount;
 paymentSources: CommercePaymentSourceResource[];
 }) => {
 const { checkout } = useCheckout();
Expand Down
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
chore(clerk-js,types): Switch to fees for plan prices#6490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 13 commits into

from

Aug 12, 2025
 Merged


chore(clerk-js,types): Switch to fees for plan prices
#6490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
d7daf96

chore(clerk-js,types): Switch to fees for plan prices


panteliselef Aug 8, 2025
53d1c86

address test in react


panteliselef Aug 8, 2025
6975c49

address feedback from rabbit


panteliselef Aug 8, 2025
69c583c

update typedoc


panteliselef Aug 8, 2025
0100be0

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 8, 2025
360986c

remove duplication


panteliselef Aug 12, 2025
171100a

Merge branch 'refs/heads/main' into elef/com-1139-remove-amount-usage…


panteliselef Aug 12, 2025
0bb6872

leftover after conflicts


panteliselef Aug 12, 2025
6a0d739

update fees to moneyamount


panteliselef Aug 12, 2025
dbe1805

update typedocs


panteliselef Aug 12, 2025
3dd40eb

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
22841e6

Merge branch 'main' into elef/com-1139-remove-amount-usage-from-clerk-js


panteliselef Aug 12, 2025
5377039

patch test


panteliselef Aug 12, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/rich-drinks-ring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Replace usage of top level amounts in plan with fees for displaying prices.

4 changes: 2 additions & 2 deletions
.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "types/commerce-feature-resource.mdx",
 "types/commerce-initialized-payment-source-json.mdx",
 "types/commerce-initialized-payment-source-resource.mdx",
 "types/commerce-money-json.mdx",
 "types/commerce-money.mdx",
 "types/commerce-money-amount-json.mdx",
 "types/commerce-money-amount.mdx",
 "types/commerce-payer-resource-type.mdx",
 "types/commerce-payment-charge-type.mdx",
 "types/commerce-payment-json.mdx",
Expand Down

8 changes: 4 additions & 4 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';

type CommerceFee = {
type CommerceMoneyAmount = {
 amount: number;
 amountFormatted: string;
 currency: string;
Expand DownExpand Up@@ -53,15 +53,15 @@ export class CommercePlan {
 /**
 * The monthly fee of the plan.
 */
 readonly fee: CommerceFee,
 readonly fee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan.
 */
 readonly annualFee: CommerceFee,
 readonly annualFee: CommerceMoneyAmount,
 /**
 * The annual fee of the plan on a monthly basis.
 */
 readonly annualMonthlyFee: CommerceFee,
 readonly annualMonthlyFee: CommerceMoneyAmount,
 /**
 * The type of payer for the plan.
 */
Expand Down

18 changes: 9 additions & 9 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -800,17 +800,17 @@ interface CommercePayeeJSON {
 gateway_status: 'active' | 'pending' | 'restricted' | 'disconnected';
}

interface CommerceFeeJSON {
interface CommerceMoneyAmountJSON {
 amount: number;
 amount_formatted: string;
 currency: string;
 currency_symbol: string;
}

interface CommerceTotalsJSON {
 subtotal: CommerceFeeJSON;
 tax_total: CommerceFeeJSON;
 grand_total: CommerceFeeJSON;
 subtotal: CommerceMoneyAmountJSON;
 tax_total: CommerceMoneyAmountJSON;
 grand_total: CommerceMoneyAmountJSON;
}

export interface FeatureJSON extends ClerkResourceJSON {
Expand All@@ -836,9 +836,9 @@ export interface CommercePlanJSON extends ClerkResourceJSON {
 is_recurring: boolean;
 has_base_fee: boolean;
 publicly_visible: boolean;
 fee: CommerceFeeJSON;
 annual_fee: CommerceFeeJSON;
 annual_monthly_fee: CommerceFeeJSON;
 fee: CommerceMoneyAmountJSON;
 annual_fee: CommerceMoneyAmountJSON;
 annual_monthly_fee: CommerceMoneyAmountJSON;
 for_payer_type: 'org' | 'user';
 features: FeatureJSON[];
}
Expand All@@ -847,7 +847,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.CommerceSubscriptionItem;
 status: 'abandoned' | 'active' | 'canceled' | 'ended' | 'expired' | 'incomplete' | 'past_due' | 'upcoming';
 credit: {
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
Expand All@@ -861,7 +861,7 @@ export interface CommerceSubscriptionItemJSON extends ClerkResourceJSON {
 lifetime_paid: number;
 next_payment_amount: number;
 next_payment_date: number;
 amount: CommerceFeeJSON;
 amount: CommerceMoneyAmountJSON;
 plan: {
 id: string;
 instance_id: string;
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/core/resources/CommercePayment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type {
CommerceMoney,
CommerceMoneyAmount,
 CommercePaymentChargeType,
 CommercePaymentJSON,
 CommercePaymentResource,
Expand All@@ -8,13 +8,13 @@ import type {
 CommerceSubscriptionItemResource,
} from '@clerk/types';

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, CommercePaymentSource, CommerceSubscriptionItem } from './internal';

export class CommercePayment extends BaseResource implements CommercePaymentResource {
 id!: string;
 amount!: CommerceMoney;
 amount!: CommerceMoneyAmount;
 failedAt?: Date;
 paidAt?: Date;
 updatedAt!: Date;
Expand All@@ -38,7 +38,7 @@ export class CommercePayment extends BaseResource implements CommercePaymentReso
 }

 this.id = data.id;
 this.amount = commerceMoneyFromJSON(data.amount);
 this.amount = commerceMoneyAmountFromJSON(data.amount);
 this.paidAt = data.paid_at ? unixEpochToDate(data.paid_at) : undefined;
 this.failedAt = data.failed_at ? unixEpochToDate(data.failed_at) : undefined;
 this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down

51 changes: 9 additions & 42 deletions
packages/clerk-js/src/core/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
import type {
 CommerceMoneyAmount,
 CommercePayerResourceType,
 CommercePlanJSON,
 CommercePlanJSONSnapshot,
 CommercePlanResource,
} from '@clerk/types';

import { commerceMoneyAmountFromJSON } from '@/utils/commerce';

import { BaseResource, CommerceFeature } from './internal';

export class CommercePlan extends BaseResource implements CommercePlanResource {
 id!: string;
 name!: string;
 amount!: number;
 amountFormatted!: string;
 annualAmount!: number;
 annualAmountFormatted!: string;
 annualMonthlyAmount!: number;
 annualMonthlyAmountFormatted!: string;
 currencySymbol!: string;
 currency!: string;
 fee!: CommerceMoneyAmount;
 annualFee!: CommerceMoneyAmount;
 annualMonthlyFee!: CommerceMoneyAmount;
 description!: string;
 isDefault!: boolean;
 isRecurring!: boolean;
Expand All@@ -42,14 +39,9 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 this.id = data.id;
 this.name = data.name;
 this.amount = data.amount;
 this.amountFormatted = data.amount_formatted;
 this.annualAmount = data.annual_amount;
 this.annualAmountFormatted = data.annual_amount_formatted;
 this.annualMonthlyAmount = data.annual_monthly_amount;
 this.annualMonthlyAmountFormatted = data.annual_monthly_amount_formatted;
 this.currencySymbol = data.currency_symbol;
 this.currency = data.currency;
 this.fee = commerceMoneyAmountFromJSON(data.fee);
 this.annualFee = commerceMoneyAmountFromJSON(data.annual_fee);
 this.annualMonthlyFee = commerceMoneyAmountFromJSON(data.annual_monthly_fee);
 this.description = data.description;
 this.isDefault = data.is_default;
 this.isRecurring = data.is_recurring;
Expand All@@ -64,29 +56,4 @@ export class CommercePlan extends BaseResource implements CommercePlanResource {

 return this;
 }

 public __internal_toSnapshot(): CommercePlanJSONSnapshot {
 return {
 object: 'commerce_plan',
 id: this.id,
 name: this.name,
 amount: this.amount,
 amount_formatted: this.amountFormatted,
 annual_amount: this.annualAmount,
 annual_amount_formatted: this.annualAmountFormatted,
 annual_monthly_amount: this.annualMonthlyAmount,
 annual_monthly_amount_formatted: this.annualMonthlyAmountFormatted,
 currency: this.currency,
 currency_symbol: this.currencySymbol,
 description: this.description,
 is_default: this.isDefault,
 is_recurring: this.isRecurring,
 has_base_fee: this.hasBaseFee,
 for_payer_type: this.forPayerType,
 publicly_visible: this.publiclyVisible,
 slug: this.slug,
 avatar_url: this.avatarUrl,
 features: this.features.map(feature => feature.__internal_toSnapshot()),
 };
 }
}

17 changes: 9 additions & 8 deletions
packages/clerk-js/src/core/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type {
 CancelSubscriptionParams,
CommerceMoney,
CommerceMoneyAmount,
 CommerceSubscriptionItemJSON,
 CommerceSubscriptionItemResource,
 CommerceSubscriptionJSON,
Expand All@@ -12,7 +12,7 @@ import type {

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

import { commerceMoneyFromJSON } from '../../utils';
import { commerceMoneyAmountFromJSON } from '../../utils';
import { BaseResource, CommercePlan, DeletedObject } from './internal';

export class CommerceSubscription extends BaseResource implements CommerceSubscriptionResource {
Expand All@@ -23,7 +23,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 pastDueAt!: Date | null;
 updatedAt!: Date | null;
 nextPayment: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 date: Date;
 } | null = null;
 subscriptionItems!: CommerceSubscriptionItemResource[];
Expand All@@ -47,7 +47,7 @@ export class CommerceSubscription extends BaseResource implements CommerceSubscr
 this.pastDueAt = data.past_due_at ? unixEpochToDate(data.past_due_at) : null;
 this.nextPayment = data.next_payment
 ? {
 amount: commerceMoneyFromJSON(data.next_payment.amount),
 amount: commerceMoneyAmountFromJSON(data.next_payment.amount),
 date: unixEpochToDate(data.next_payment.date),
 }
 : null;
Expand All@@ -69,9 +69,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 canceledAt!: Date | null;
 pastDueAt!: Date | null;
 //TODO(@COMMERCE): Why can this be undefined ?
 amount?: CommerceMoney;
 amount?: CommerceMoneyAmount;
 credit?: {
 amount: CommerceMoney;
 amount: CommerceMoneyAmount;
 };
 isFreeTrial!: boolean;

Expand All@@ -98,8 +98,9 @@ export class CommerceSubscriptionItem extends BaseResource implements CommerceSu
 this.periodEnd = data.period_end ? unixEpochToDate(data.period_end) : null;
 this.canceledAt = data.canceled_at ? unixEpochToDate(data.canceled_at) : null;

 this.amount = data.amount ? commerceMoneyFromJSON(data.amount) : undefined;
 this.credit = data.credit && data.credit.amount ? { amount: commerceMoneyFromJSON(data.credit.amount) } : undefined;
 this.amount = data.amount ? commerceMoneyAmountFromJSON(data.amount) : undefined;
 this.credit =
 data.credit && data.credit.amount ? { amount: commerceMoneyAmountFromJSON(data.credit.amount) } : undefined;

 this.isFreeTrial = this.withDefault(data.is_free_trial, false);
 return this;
Expand Down

8 changes: 5 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { __experimental_useCheckout as useCheckout, useOrganization } from '@clerk/shared/react';
import type { CommerceMoney, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import type { CommerceMoneyAmount, CommercePaymentSourceResource, ConfirmCheckoutParams } from '@clerk/types';
import { useMemo, useState } from 'react';

import { Card } from '@/ui/elements/Card';
Expand DownExpand Up@@ -35,6 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

 const fee = planPeriod === 'month' ? plan.fee : plan.annualMonthlyFee;

Comment thread
panteliselef marked this conversation as resolved.

 return (
 <Drawer.Body>
 <Box
Expand All@@ -54,7 +56,7 @@ export const CheckoutForm = withCardStateProvider(() => {
 />
 <LineItems.Description
 prefix={planPeriod === 'annual' ? 'x12' : undefined}
 text={`${plan.currencySymbol}${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
 text={`${fee.currencySymbol}${fee.amountFormatted}`}
 suffix={localizationKeys('commerce.checkout.perMonth')}
 />

Comment on lines

58
 to 
61

@coderabbitaicoderabbitaiBotAug 8, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Localize hard-coded 'x12' multiplier
All user-facing strings must be localized. Replace 'x12' with a localization key (e.g., commerce.checkout.x12) or a parameterized key.
- prefix={planPeriod === 'annual' ? 'x12' : undefined}+ prefix={planPeriod === 'annual' ? localizationKeys('commerce.checkout.x12') : undefined}
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

prefix={planPeriod ==='annual' ? 'x12' : undefined}
text={`${plan.currencySymbol}${planPeriod==='month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
prefix={planPeriod ==='annual' ? localizationKeys('commerce.checkout.x12') : undefined}
text={`${fee.currencySymbol}${fee.amountFormatted}`}
suffix={localizationKeys('commerce.checkout.perMonth')}
/>
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx around lines 58
to 61, the hard-coded string 'x12' used as a prefix should be replaced with a
localized string. Update the code to use a localization key such as
'commerce.checkout.x12' or a parameterized localization key instead of the
literal 'x12' to ensure all user-facing strings are properly localized.

 </LineItems.Group>
Expand DownExpand Up@@ -312,7 +314,7 @@ const ExistingPaymentSourceForm = withCardStateProvider(
 totalDueNow,
 paymentSources,
 }: {
 totalDueNow: CommerceMoney;
 totalDueNow: CommerceMoneyAmount;
 paymentSources: CommercePaymentSourceResource[];
 }) => {
 const { checkout } = useCheckout();
Expand Down
Loading