feat(clerk-js,localizations,shared): Add support for credits#7870

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
dstaley merged 3 commits into from
Feb 17, 2026
Merged

feat(clerk-js,localizations,shared): Add support for credits #7870

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f6e4a4
feat(clerk-js,localizations,shared,ui): Add support for credits (#7776)
dstaley Feb 17, 2026
907f239
chore(clerk-js): Bump bundlewatch
dstaley Feb 17, 2026
f6a6aa9
chore(repo): Fix changeset
dstaley Feb 17, 2026
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
7 changes: 7 additions & 0 deletions .changeset/shy-loops-type.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Add support for account credits in checkout.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@
{ "path": "./dist/keylessPrompt*.js", "maxSize": "6.5KB" },
{ "path": "./dist/enableOrganizationsPrompt*.js", "maxSize": "6.5KB" },
{ "path": "./dist/pricingTable*.js", "maxSize": "4.02KB" },
{ "path": "./dist/checkout*.js", "maxSize": "8.82KB" },
{ "path": "./dist/checkout*.js", "maxSize": "10KB" },
{ "path": "./dist/up-billing-page*.js", "maxSize": "3.0KB" },
{ "path": "./dist/op-billing-page*.js", "maxSize": "3.0KB" },
{ "path": "./dist/up-plans-page*.js", "maxSize": "1.0KB" },
Expand Down
17 changes: 14 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
Expand Up@@ -35,7 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
return null;
}

const showCredits = !!totals.credit?.amount && totals.credit.amount > 0;
const showProratedCredit = !!totals.credits?.proration?.amount && totals.credits.proration.amount.amount > 0;
const showAccountCredits = !!totals.credits?.payer?.appliedAmount && totals.credits.payer.appliedAmount.amount > 0;
const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
const showDowngradeInfo = !isImmediatePlanChange;

Expand DownExpand Up@@ -80,10 +81,20 @@ export const CheckoutForm = withCardStateProvider(() => {
<LineItems.Title title={localizationKeys('billing.subtotal')} />
<LineItems.Description text={`${totals.subtotal.currencySymbol}${totals.subtotal.amountFormatted}`} />
</LineItems.Group>
{showCredits && (
{showProratedCredit && (
<LineItems.Group variant='tertiary'>
<LineItems.Title title={localizationKeys('billing.creditRemainder')} />
<LineItems.Description text={`- ${totals.credit?.currencySymbol}${totals.credit?.amountFormatted}`} />
<LineItems.Description
text={`- ${totals.credits?.proration?.amount.currencySymbol}${totals.credits?.proration?.amount.amountFormatted}`}
/>
</LineItems.Group>
)}
{showAccountCredits && (
<LineItems.Group variant='tertiary'>
<LineItems.Title title={localizationKeys('billing.payerCreditRemainder')} />
<LineItems.Description
text={`- ${totals.credits?.payer?.appliedAmount?.currencySymbol}${totals.credits?.payer?.appliedAmount?.amountFormatted}`}
/>
</LineItems.Group>
)}
{showPastDue && (
Expand Down
107 changes: 107 additions & 0 deletions packages/clerk-js/src/ui/components/Checkout/__tests__/Checkout.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -309,6 +309,113 @@ describe('Checkout', () => {
});
});

it('renders credit details', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withUser({ email_addresses: ['test@clerk.com'] });
f.withBilling();
});

fixtures.clerk.user?.getPaymentMethods.mockResolvedValue({
data: [],
total_count: 0,
});

fixtures.clerk.billing.startCheckout.mockResolvedValue({
id: 'chk_credits_1',
status: 'needs_confirmation',
externalClientSecret: 'cs_test_credits_1',
externalGatewayId: 'gw_test',
totals: {
subtotal: { amount: 2500, amountFormatted: '25.00', currency: 'USD', currencySymbol: '$' },
grandTotal: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
taxTotal: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
credit: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
credits: {
proration: {
amount: { amount: 500, amountFormatted: '5.00', currency: 'USD', currencySymbol: '$' },
cycleDaysRemaining: 15,
cycleDaysTotal: 30,
cycleRemainingPercent: 50,
},
payer: {
remainingBalance: { amount: 2000, amountFormatted: '20.00', currency: 'USD', currencySymbol: '$' },
appliedAmount: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
},
total: { amount: 1500, amountFormatted: '15.00', currency: 'USD', currencySymbol: '$' },
},
pastDue: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
totalDueNow: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
},
isImmediatePlanChange: true,
planPeriod: 'month',
plan: {
id: 'plan_credits',
name: 'Pro',
description: 'Pro plan',
features: [],
fee: {
amount: 2500,
amountFormatted: '25.00',
currency: 'USD',
currencySymbol: '$',
},
annualFee: {
amount: 30000,
amountFormatted: '300.00',
currency: 'USD',
currencySymbol: '$',
},
annualMonthlyFee: {
amount: 2500,
amountFormatted: '25.00',
currency: 'USD',
currencySymbol: '$',
},
slug: 'pro',
avatarUrl: '',
publiclyVisible: true,
isDefault: true,
isRecurring: true,
hasBaseFee: false,
forPayerType: 'user',
freeTrialDays: 7,
freeTrialEnabled: true,
},
paymentMethod: undefined,
confirm: vi.fn(),
freeTrialEndsAt: null,
needsPaymentMethod: false,
} as any);

const { getByRole, getByText } = render(
<Drawer.Root
open
onOpenChange={() => {}}
>
<Checkout
planId='plan_credits'
planPeriod='month'
/>
</Drawer.Root>,
{ wrapper },
);

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

const prorationCreditRow = getByText('Credit for the remainder of your current subscription.').closest(
'.cl-lineItemsGroup',
);
const accountCreditRow = getByText('Credit from account balance.').closest('.cl-lineItemsGroup');

expect(prorationCreditRow).toBeInTheDocument();
expect(accountCreditRow).toBeInTheDocument();

expect(prorationCreditRow).toHaveTextContent('- $5.00');
expect(accountCreditRow).toHaveTextContent('- $10.00');
});

it('renders free trial details during confirmation stage', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down
26 changes: 25 additions & 1 deletion packages/clerk-js/src/utils/billing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
BillingCheckoutTotals,
BillingCheckoutTotalsJSON,
BillingCredits,
BillingCreditsJSON,
BillingMoneyAmount,
BillingMoneyAmountJSON,
BillingStatementTotals,
Expand All@@ -16,6 +18,26 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
};
};

const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
return {
proration: data.proration
? {
amount: billingMoneyAmountFromJSON(data.proration.amount),
cycleDaysRemaining: data.proration.cycle_days_remaining,
cycleDaysTotal: data.proration.cycle_days_total,
cycleRemainingPercent: data.proration.cycle_remaining_percent,
}
: null,
payer: data.payer
? {
remainingBalance: billingMoneyAmountFromJSON(data.payer.remaining_balance),
appliedAmount: billingMoneyAmountFromJSON(data.payer.applied_amount),
}
: null,
total: billingMoneyAmountFromJSON(data.total),
};
};

export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | BillingCheckoutTotalsJSON>(
data: T,
): T extends { total_due_now: BillingMoneyAmountJSON } ? BillingCheckoutTotals : BillingStatementTotals => {
Expand All@@ -31,7 +53,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
if ('credit' in data) {
totals.credit = data.credit ? billingMoneyAmountFromJSON(data.credit) : null;
}

if ('credits' in data) {
totals.credits = data.credits ? billingCreditsFromJSON(data.credits) : null;
}
if ('total_due_now' in data) {
totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
}
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/en-US.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
},
credit: 'Credit',
creditRemainder: 'Credit for the remainder of your current subscription.',
payerCreditRemainder: 'Credit from account balance.',
defaultFreePlanActive: "You're currently on the Free plan",
free: 'Free',
getStarted: 'Get started',
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/react/__tests__/payment-element.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,11 @@ describe('PaymentElement Localization', () => {
totalDueNow: { amount: 1000, amountFormatted: '$10.00', currency: 'usd', currencySymbol: '$' },
totalDueAfterFreeTrial: null,
credit: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
credits: {
proration: null,
payer: null,
total: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
},
pastDue: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
},
status: 'needs_confirmation' as const,
Expand Down
19 changes: 19 additions & 0 deletions packages/shared/src/types/billing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -645,6 +645,24 @@ export interface BillingMoneyAmount {
currencySymbol: string;
}

export interface BillingProrationCreditDetail {
amount: BillingMoneyAmount;
cycleDaysRemaining: number;
cycleDaysTotal: number;
cycleRemainingPercent: number;
}

export interface BillingPayerCredit {
remainingBalance: BillingMoneyAmount;
appliedAmount: BillingMoneyAmount;
}

export interface BillingCredits {
proration: BillingProrationCreditDetail | null;
payer: BillingPayerCredit | null;
total: BillingMoneyAmount;
}

/**
* The `BillingCheckoutTotals` type represents the total costs, taxes, and other pricing details for a checkout session.
*
Expand All@@ -671,6 +689,7 @@ export interface BillingCheckoutTotals {
* Any credits (like account balance or promo credits) that are being applied to the checkout.
*/
credit: BillingMoneyAmount | null;
credits: BillingCredits | null;
/**
* Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout.
*/
Expand Down
30 changes: 30 additions & 0 deletions packages/shared/src/types/json.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -730,6 +730,7 @@ export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
credit?: {
amount: BillingMoneyAmountJSON;
};
credits?: BillingCreditsJSON;
plan: BillingPlanJSON;
plan_period: BillingSubscriptionPlanPeriod;
status: BillingSubscriptionStatus;
Expand DownExpand Up@@ -779,6 +780,33 @@ export interface BillingMoneyAmountJSON {
currency_symbol: string;
}

/**
* Contains proration credit details including billing cycle information.
*/
export interface BillingProrationCreditDetailJSON {
amount: BillingMoneyAmountJSON;
cycle_days_remaining: number;
cycle_days_total: number;
cycle_remaining_percent: number;
}

/**
* Contains payer credit details including the available balance and the amount applied to this checkout.
*/
export interface BillingPayerCreditJSON {
remaining_balance: BillingMoneyAmountJSON;
applied_amount: BillingMoneyAmountJSON;
}

/**
* Unified credits breakdown for checkout totals. Can be used instead of `credit` field.
*/
export interface BillingCreditsJSON {
proration: BillingProrationCreditDetailJSON | null;
payer: BillingPayerCreditJSON | null;
total: BillingMoneyAmountJSON;
}

/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
*/
Expand All@@ -788,6 +816,8 @@ export interface BillingCheckoutTotalsJSON {
tax_total: BillingMoneyAmountJSON;
total_due_now: BillingMoneyAmountJSON;
credit: BillingMoneyAmountJSON | null;
credits: BillingCreditsJSON | null;
account_credit: BillingMoneyAmountJSON | null;
past_due: BillingMoneyAmountJSON | null;
total_due_after_free_trial: BillingMoneyAmountJSON | null;
}
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/localization.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,7 @@ export type __internal_LocalizationResource = {
subtotal: LocalizationValue;
credit: LocalizationValue;
creditRemainder: LocalizationValue;
payerCreditRemainder: LocalizationValue;
totalDue: LocalizationValue;
totalDueToday: LocalizationValue;
pastDue: LocalizationValue;
Expand Down
, '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
feat(clerk-js,localizations,shared): Add support for credits#7870

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

dstaley
merged 3 commits into

from

Feb 17, 2026
 Merged


feat(clerk-js,localizations,shared): Add support for credits
#7870
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5f6e4a4

feat(clerk-js,localizations,shared,ui): Add support for credits (#7776)


dstaley Feb 17, 2026
907f239

chore(clerk-js): Bump bundlewatch


dstaley Feb 17, 2026
f6a6aa9

chore(repo): Fix changeset


dstaley Feb 17, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/shy-loops-type.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Add support for account credits in checkout.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/enableOrganizationsPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "4.02KB" },
 { "path": "./dist/checkout*.js", "maxSize": "8.82KB" },
 { "path": "./dist/checkout*.js", "maxSize": "10KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/up-plans-page*.js", "maxSize": "1.0KB" },
Expand Down

17 changes: 14 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
Expand Up@@ -35,7 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 return null;
 }

 const showCredits = !!totals.credit?.amount && totals.credit.amount > 0;
 const showProratedCredit = !!totals.credits?.proration?.amount && totals.credits.proration.amount.amount > 0;
 const showAccountCredits = !!totals.credits?.payer?.appliedAmount && totals.credits.payer.appliedAmount.amount > 0;
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

Expand DownExpand Up@@ -80,10 +81,20 @@ export const CheckoutForm = withCardStateProvider(() => {
 <LineItems.Title title={localizationKeys('billing.subtotal')} />
 <LineItems.Description text={`${totals.subtotal.currencySymbol}${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 {showCredits && (
 {showProratedCredit && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.creditRemainder')} />
 <LineItems.Description text={`- ${totals.credit?.currencySymbol}${totals.credit?.amountFormatted}`} />
 <LineItems.Description
 text={`- ${totals.credits?.proration?.amount.currencySymbol}${totals.credits?.proration?.amount.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showAccountCredits && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.payerCreditRemainder')} />
 <LineItems.Description
 text={`- ${totals.credits?.payer?.appliedAmount?.currencySymbol}${totals.credits?.payer?.appliedAmount?.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showPastDue && (
Expand Down

107 changes: 107 additions & 0 deletions
packages/clerk-js/src/ui/components/Checkout/__tests__/Checkout.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -309,6 +309,113 @@ describe('Checkout', () => {
 });
 });

 it('renders credit details', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
 f.withBilling();
 });

 fixtures.clerk.user?.getPaymentMethods.mockResolvedValue({
 data: [],
 total_count: 0,
 });

 fixtures.clerk.billing.startCheckout.mockResolvedValue({
 id: 'chk_credits_1',
 status: 'needs_confirmation',
 externalClientSecret: 'cs_test_credits_1',
 externalGatewayId: 'gw_test',
 totals: {
 subtotal: { amount: 2500, amountFormatted: '25.00', currency: 'USD', currencySymbol: '$' },
 grandTotal: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 taxTotal: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credit: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credits: {
 proration: {
 amount: { amount: 500, amountFormatted: '5.00', currency: 'USD', currencySymbol: '$' },
 cycleDaysRemaining: 15,
 cycleDaysTotal: 30,
 cycleRemainingPercent: 50,
 },
 payer: {
 remainingBalance: { amount: 2000, amountFormatted: '20.00', currency: 'USD', currencySymbol: '$' },
 appliedAmount: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 total: { amount: 1500, amountFormatted: '15.00', currency: 'USD', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 totalDueNow: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 isImmediatePlanChange: true,
 planPeriod: 'month',
 plan: {
 id: 'plan_credits',
 name: 'Pro',
 description: 'Pro plan',
 features: [],
 fee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualFee: {
 amount: 30000,
 amountFormatted: '300.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualMonthlyFee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 slug: 'pro',
 avatarUrl: '',
 publiclyVisible: true,
 isDefault: true,
 isRecurring: true,
 hasBaseFee: false,
 forPayerType: 'user',
 freeTrialDays: 7,
 freeTrialEnabled: true,
 },
 paymentMethod: undefined,
 confirm: vi.fn(),
 freeTrialEndsAt: null,
 needsPaymentMethod: false,
 } as any);

 const { getByRole, getByText } = render(
 <Drawer.Root
 open
 onOpenChange={() => {}}
 >
 <Checkout
 planId='plan_credits'
 planPeriod='month'
 />
 </Drawer.Root>,
 { wrapper },
 );

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

 const prorationCreditRow = getByText('Credit for the remainder of your current subscription.').closest(
 '.cl-lineItemsGroup',
 );
 const accountCreditRow = getByText('Credit from account balance.').closest('.cl-lineItemsGroup');

 expect(prorationCreditRow).toBeInTheDocument();
 expect(accountCreditRow).toBeInTheDocument();

 expect(prorationCreditRow).toHaveTextContent('- $5.00');
 expect(accountCreditRow).toHaveTextContent('- $10.00');
 });

 it('renders free trial details during confirmation stage', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/utils/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
 BillingCheckoutTotals,
 BillingCheckoutTotalsJSON,
 BillingCredits,
 BillingCreditsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingStatementTotals,
Expand All@@ -16,6 +18,26 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
 };
};

const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
 return {
 proration: data.proration
 ? {
 amount: billingMoneyAmountFromJSON(data.proration.amount),
 cycleDaysRemaining: data.proration.cycle_days_remaining,
 cycleDaysTotal: data.proration.cycle_days_total,
 cycleRemainingPercent: data.proration.cycle_remaining_percent,
 }
 : null,
 payer: data.payer
 ? {
 remainingBalance: billingMoneyAmountFromJSON(data.payer.remaining_balance),
 appliedAmount: billingMoneyAmountFromJSON(data.payer.applied_amount),
 }
 : null,
 total: billingMoneyAmountFromJSON(data.total),
 };
};

export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | BillingCheckoutTotalsJSON>(
 data: T,
): T extends { total_due_now: BillingMoneyAmountJSON } ? BillingCheckoutTotals : BillingStatementTotals => {
Expand All@@ -31,7 +53,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
 if ('credit' in data) {
 totals.credit = data.credit ? billingMoneyAmountFromJSON(data.credit) : null;
 }

 if ('credits' in data) {
 totals.credits = data.credits ? billingCreditsFromJSON(data.credits) : null;
 }
 if ('total_due_now' in data) {
 totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
 },
 credit: 'Credit',
 creditRemainder: 'Credit for the remainder of your current subscription.',
 payerCreditRemainder: 'Credit from account balance.',
 defaultFreePlanActive: "You're currently on the Free plan",
 free: 'Free',
 getStarted: 'Get started',
Expand Down

5 changes: 5 additions & 0 deletions
packages/shared/src/react/__tests__/payment-element.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,11 @@ describe('PaymentElement Localization', () => {
 totalDueNow: { amount: 1000, amountFormatted: '$10.00', currency: 'usd', currencySymbol: '$' },
 totalDueAfterFreeTrial: null,
 credit: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 credits: {
 proration: null,
 payer: null,
 total: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 status: 'needs_confirmation' as const,
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -645,6 +645,24 @@ export interface BillingMoneyAmount {
 currencySymbol: string;
}

export interface BillingProrationCreditDetail {
 amount: BillingMoneyAmount;
 cycleDaysRemaining: number;
 cycleDaysTotal: number;
 cycleRemainingPercent: number;
}

export interface BillingPayerCredit {
 remainingBalance: BillingMoneyAmount;
 appliedAmount: BillingMoneyAmount;
}

export interface BillingCredits {
 proration: BillingProrationCreditDetail | null;
 payer: BillingPayerCredit | null;
 total: BillingMoneyAmount;
}

/**
 * The `BillingCheckoutTotals` type represents the total costs, taxes, and other pricing details for a checkout session.
 *
Expand All@@ -671,6 +689,7 @@ export interface BillingCheckoutTotals {
 * Any credits (like account balance or promo credits) that are being applied to the checkout.
 */
 credit: BillingMoneyAmount | null;
 credits: BillingCredits | null;
 /**
 * Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout.
 */
Expand Down

30 changes: 30 additions & 0 deletions
packages/shared/src/types/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -730,6 +730,7 @@ export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 credit?: {
 amount: BillingMoneyAmountJSON;
 };
 credits?: BillingCreditsJSON;
 plan: BillingPlanJSON;
 plan_period: BillingSubscriptionPlanPeriod;
 status: BillingSubscriptionStatus;
Expand DownExpand Up@@ -779,6 +780,33 @@ export interface BillingMoneyAmountJSON {
 currency_symbol: string;
}

/**
 * Contains proration credit details including billing cycle information.
 */
export interface BillingProrationCreditDetailJSON {
 amount: BillingMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
}

/**
 * Contains payer credit details including the available balance and the amount applied to this checkout.
 */
export interface BillingPayerCreditJSON {
 remaining_balance: BillingMoneyAmountJSON;
 applied_amount: BillingMoneyAmountJSON;
}

/**
 * Unified credits breakdown for checkout totals. Can be used instead of `credit` field.
 */
export interface BillingCreditsJSON {
 proration: BillingProrationCreditDetailJSON | null;
 payer: BillingPayerCreditJSON | null;
 total: BillingMoneyAmountJSON;
}

/**
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
Expand All@@ -788,6 +816,8 @@ export interface BillingCheckoutTotalsJSON {
 tax_total: BillingMoneyAmountJSON;
 total_due_now: BillingMoneyAmountJSON;
 credit: BillingMoneyAmountJSON | null;
 credits: BillingCreditsJSON | null;
 account_credit: BillingMoneyAmountJSON | null;
 past_due: BillingMoneyAmountJSON | null;
 total_due_after_free_trial: BillingMoneyAmountJSON | null;
}
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,7 @@ export type __internal_LocalizationResource = {
 subtotal: LocalizationValue;
 credit: LocalizationValue;
 creditRemainder: LocalizationValue;
 payerCreditRemainder: LocalizationValue;
 totalDue: LocalizationValue;
 totalDueToday: LocalizationValue;
 pastDue: LocalizationValue;
Expand Down

, '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
feat(clerk-js,localizations,shared): Add support for credits#7870

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

dstaley
merged 3 commits into

from

Feb 17, 2026
 Merged


feat(clerk-js,localizations,shared): Add support for credits
#7870
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5f6e4a4

feat(clerk-js,localizations,shared,ui): Add support for credits (#7776)


dstaley Feb 17, 2026
907f239

chore(clerk-js): Bump bundlewatch


dstaley Feb 17, 2026
f6a6aa9

chore(repo): Fix changeset


dstaley Feb 17, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/shy-loops-type.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Add support for account credits in checkout.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/enableOrganizationsPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "4.02KB" },
 { "path": "./dist/checkout*.js", "maxSize": "8.82KB" },
 { "path": "./dist/checkout*.js", "maxSize": "10KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/up-plans-page*.js", "maxSize": "1.0KB" },
Expand Down

17 changes: 14 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
Expand Up@@ -35,7 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 return null;
 }

 const showCredits = !!totals.credit?.amount && totals.credit.amount > 0;
 const showProratedCredit = !!totals.credits?.proration?.amount && totals.credits.proration.amount.amount > 0;
 const showAccountCredits = !!totals.credits?.payer?.appliedAmount && totals.credits.payer.appliedAmount.amount > 0;
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

Expand DownExpand Up@@ -80,10 +81,20 @@ export const CheckoutForm = withCardStateProvider(() => {
 <LineItems.Title title={localizationKeys('billing.subtotal')} />
 <LineItems.Description text={`${totals.subtotal.currencySymbol}${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 {showCredits && (
 {showProratedCredit && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.creditRemainder')} />
 <LineItems.Description text={`- ${totals.credit?.currencySymbol}${totals.credit?.amountFormatted}`} />
 <LineItems.Description
 text={`- ${totals.credits?.proration?.amount.currencySymbol}${totals.credits?.proration?.amount.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showAccountCredits && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.payerCreditRemainder')} />
 <LineItems.Description
 text={`- ${totals.credits?.payer?.appliedAmount?.currencySymbol}${totals.credits?.payer?.appliedAmount?.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showPastDue && (
Expand Down

107 changes: 107 additions & 0 deletions
packages/clerk-js/src/ui/components/Checkout/__tests__/Checkout.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -309,6 +309,113 @@ describe('Checkout', () => {
 });
 });

 it('renders credit details', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
 f.withBilling();
 });

 fixtures.clerk.user?.getPaymentMethods.mockResolvedValue({
 data: [],
 total_count: 0,
 });

 fixtures.clerk.billing.startCheckout.mockResolvedValue({
 id: 'chk_credits_1',
 status: 'needs_confirmation',
 externalClientSecret: 'cs_test_credits_1',
 externalGatewayId: 'gw_test',
 totals: {
 subtotal: { amount: 2500, amountFormatted: '25.00', currency: 'USD', currencySymbol: '$' },
 grandTotal: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 taxTotal: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credit: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credits: {
 proration: {
 amount: { amount: 500, amountFormatted: '5.00', currency: 'USD', currencySymbol: '$' },
 cycleDaysRemaining: 15,
 cycleDaysTotal: 30,
 cycleRemainingPercent: 50,
 },
 payer: {
 remainingBalance: { amount: 2000, amountFormatted: '20.00', currency: 'USD', currencySymbol: '$' },
 appliedAmount: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 total: { amount: 1500, amountFormatted: '15.00', currency: 'USD', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 totalDueNow: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 isImmediatePlanChange: true,
 planPeriod: 'month',
 plan: {
 id: 'plan_credits',
 name: 'Pro',
 description: 'Pro plan',
 features: [],
 fee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualFee: {
 amount: 30000,
 amountFormatted: '300.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualMonthlyFee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 slug: 'pro',
 avatarUrl: '',
 publiclyVisible: true,
 isDefault: true,
 isRecurring: true,
 hasBaseFee: false,
 forPayerType: 'user',
 freeTrialDays: 7,
 freeTrialEnabled: true,
 },
 paymentMethod: undefined,
 confirm: vi.fn(),
 freeTrialEndsAt: null,
 needsPaymentMethod: false,
 } as any);

 const { getByRole, getByText } = render(
 <Drawer.Root
 open
 onOpenChange={() => {}}
 >
 <Checkout
 planId='plan_credits'
 planPeriod='month'
 />
 </Drawer.Root>,
 { wrapper },
 );

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

 const prorationCreditRow = getByText('Credit for the remainder of your current subscription.').closest(
 '.cl-lineItemsGroup',
 );
 const accountCreditRow = getByText('Credit from account balance.').closest('.cl-lineItemsGroup');

 expect(prorationCreditRow).toBeInTheDocument();
 expect(accountCreditRow).toBeInTheDocument();

 expect(prorationCreditRow).toHaveTextContent('- $5.00');
 expect(accountCreditRow).toHaveTextContent('- $10.00');
 });

 it('renders free trial details during confirmation stage', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/utils/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
 BillingCheckoutTotals,
 BillingCheckoutTotalsJSON,
 BillingCredits,
 BillingCreditsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingStatementTotals,
Expand All@@ -16,6 +18,26 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
 };
};

const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
 return {
 proration: data.proration
 ? {
 amount: billingMoneyAmountFromJSON(data.proration.amount),
 cycleDaysRemaining: data.proration.cycle_days_remaining,
 cycleDaysTotal: data.proration.cycle_days_total,
 cycleRemainingPercent: data.proration.cycle_remaining_percent,
 }
 : null,
 payer: data.payer
 ? {
 remainingBalance: billingMoneyAmountFromJSON(data.payer.remaining_balance),
 appliedAmount: billingMoneyAmountFromJSON(data.payer.applied_amount),
 }
 : null,
 total: billingMoneyAmountFromJSON(data.total),
 };
};

export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | BillingCheckoutTotalsJSON>(
 data: T,
): T extends { total_due_now: BillingMoneyAmountJSON } ? BillingCheckoutTotals : BillingStatementTotals => {
Expand All@@ -31,7 +53,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
 if ('credit' in data) {
 totals.credit = data.credit ? billingMoneyAmountFromJSON(data.credit) : null;
 }

 if ('credits' in data) {
 totals.credits = data.credits ? billingCreditsFromJSON(data.credits) : null;
 }
 if ('total_due_now' in data) {
 totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
 },
 credit: 'Credit',
 creditRemainder: 'Credit for the remainder of your current subscription.',
 payerCreditRemainder: 'Credit from account balance.',
 defaultFreePlanActive: "You're currently on the Free plan",
 free: 'Free',
 getStarted: 'Get started',
Expand Down

5 changes: 5 additions & 0 deletions
packages/shared/src/react/__tests__/payment-element.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,11 @@ describe('PaymentElement Localization', () => {
 totalDueNow: { amount: 1000, amountFormatted: '$10.00', currency: 'usd', currencySymbol: '$' },
 totalDueAfterFreeTrial: null,
 credit: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 credits: {
 proration: null,
 payer: null,
 total: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 status: 'needs_confirmation' as const,
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -645,6 +645,24 @@ export interface BillingMoneyAmount {
 currencySymbol: string;
}

export interface BillingProrationCreditDetail {
 amount: BillingMoneyAmount;
 cycleDaysRemaining: number;
 cycleDaysTotal: number;
 cycleRemainingPercent: number;
}

export interface BillingPayerCredit {
 remainingBalance: BillingMoneyAmount;
 appliedAmount: BillingMoneyAmount;
}

export interface BillingCredits {
 proration: BillingProrationCreditDetail | null;
 payer: BillingPayerCredit | null;
 total: BillingMoneyAmount;
}

/**
 * The `BillingCheckoutTotals` type represents the total costs, taxes, and other pricing details for a checkout session.
 *
Expand All@@ -671,6 +689,7 @@ export interface BillingCheckoutTotals {
 * Any credits (like account balance or promo credits) that are being applied to the checkout.
 */
 credit: BillingMoneyAmount | null;
 credits: BillingCredits | null;
 /**
 * Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout.
 */
Expand Down

30 changes: 30 additions & 0 deletions
packages/shared/src/types/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -730,6 +730,7 @@ export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 credit?: {
 amount: BillingMoneyAmountJSON;
 };
 credits?: BillingCreditsJSON;
 plan: BillingPlanJSON;
 plan_period: BillingSubscriptionPlanPeriod;
 status: BillingSubscriptionStatus;
Expand DownExpand Up@@ -779,6 +780,33 @@ export interface BillingMoneyAmountJSON {
 currency_symbol: string;
}

/**
 * Contains proration credit details including billing cycle information.
 */
export interface BillingProrationCreditDetailJSON {
 amount: BillingMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
}

/**
 * Contains payer credit details including the available balance and the amount applied to this checkout.
 */
export interface BillingPayerCreditJSON {
 remaining_balance: BillingMoneyAmountJSON;
 applied_amount: BillingMoneyAmountJSON;
}

/**
 * Unified credits breakdown for checkout totals. Can be used instead of `credit` field.
 */
export interface BillingCreditsJSON {
 proration: BillingProrationCreditDetailJSON | null;
 payer: BillingPayerCreditJSON | null;
 total: BillingMoneyAmountJSON;
}

/**
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
Expand All@@ -788,6 +816,8 @@ export interface BillingCheckoutTotalsJSON {
 tax_total: BillingMoneyAmountJSON;
 total_due_now: BillingMoneyAmountJSON;
 credit: BillingMoneyAmountJSON | null;
 credits: BillingCreditsJSON | null;
 account_credit: BillingMoneyAmountJSON | null;
 past_due: BillingMoneyAmountJSON | null;
 total_due_after_free_trial: BillingMoneyAmountJSON | null;
}
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,7 @@ export type __internal_LocalizationResource = {
 subtotal: LocalizationValue;
 credit: LocalizationValue;
 creditRemainder: LocalizationValue;
 payerCreditRemainder: LocalizationValue;
 totalDue: LocalizationValue;
 totalDueToday: LocalizationValue;
 pastDue: LocalizationValue;
Expand Down

, '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
feat(clerk-js,localizations,shared): Add support for credits#7870

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

dstaley
merged 3 commits into

from

Feb 17, 2026
 Merged


feat(clerk-js,localizations,shared): Add support for credits
#7870
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5f6e4a4

feat(clerk-js,localizations,shared,ui): Add support for credits (#7776)


dstaley Feb 17, 2026
907f239

chore(clerk-js): Bump bundlewatch


dstaley Feb 17, 2026
f6a6aa9

chore(repo): Fix changeset


dstaley Feb 17, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/shy-loops-type.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Add support for account credits in checkout.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/enableOrganizationsPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "4.02KB" },
 { "path": "./dist/checkout*.js", "maxSize": "8.82KB" },
 { "path": "./dist/checkout*.js", "maxSize": "10KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/up-plans-page*.js", "maxSize": "1.0KB" },
Expand Down

17 changes: 14 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
Expand Up@@ -35,7 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 return null;
 }

 const showCredits = !!totals.credit?.amount && totals.credit.amount > 0;
 const showProratedCredit = !!totals.credits?.proration?.amount && totals.credits.proration.amount.amount > 0;
 const showAccountCredits = !!totals.credits?.payer?.appliedAmount && totals.credits.payer.appliedAmount.amount > 0;
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

Expand DownExpand Up@@ -80,10 +81,20 @@ export const CheckoutForm = withCardStateProvider(() => {
 <LineItems.Title title={localizationKeys('billing.subtotal')} />
 <LineItems.Description text={`${totals.subtotal.currencySymbol}${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 {showCredits && (
 {showProratedCredit && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.creditRemainder')} />
 <LineItems.Description text={`- ${totals.credit?.currencySymbol}${totals.credit?.amountFormatted}`} />
 <LineItems.Description
 text={`- ${totals.credits?.proration?.amount.currencySymbol}${totals.credits?.proration?.amount.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showAccountCredits && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.payerCreditRemainder')} />
 <LineItems.Description
 text={`- ${totals.credits?.payer?.appliedAmount?.currencySymbol}${totals.credits?.payer?.appliedAmount?.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showPastDue && (
Expand Down

107 changes: 107 additions & 0 deletions
packages/clerk-js/src/ui/components/Checkout/__tests__/Checkout.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -309,6 +309,113 @@ describe('Checkout', () => {
 });
 });

 it('renders credit details', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
 f.withBilling();
 });

 fixtures.clerk.user?.getPaymentMethods.mockResolvedValue({
 data: [],
 total_count: 0,
 });

 fixtures.clerk.billing.startCheckout.mockResolvedValue({
 id: 'chk_credits_1',
 status: 'needs_confirmation',
 externalClientSecret: 'cs_test_credits_1',
 externalGatewayId: 'gw_test',
 totals: {
 subtotal: { amount: 2500, amountFormatted: '25.00', currency: 'USD', currencySymbol: '$' },
 grandTotal: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 taxTotal: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credit: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credits: {
 proration: {
 amount: { amount: 500, amountFormatted: '5.00', currency: 'USD', currencySymbol: '$' },
 cycleDaysRemaining: 15,
 cycleDaysTotal: 30,
 cycleRemainingPercent: 50,
 },
 payer: {
 remainingBalance: { amount: 2000, amountFormatted: '20.00', currency: 'USD', currencySymbol: '$' },
 appliedAmount: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 total: { amount: 1500, amountFormatted: '15.00', currency: 'USD', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 totalDueNow: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 isImmediatePlanChange: true,
 planPeriod: 'month',
 plan: {
 id: 'plan_credits',
 name: 'Pro',
 description: 'Pro plan',
 features: [],
 fee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualFee: {
 amount: 30000,
 amountFormatted: '300.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualMonthlyFee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 slug: 'pro',
 avatarUrl: '',
 publiclyVisible: true,
 isDefault: true,
 isRecurring: true,
 hasBaseFee: false,
 forPayerType: 'user',
 freeTrialDays: 7,
 freeTrialEnabled: true,
 },
 paymentMethod: undefined,
 confirm: vi.fn(),
 freeTrialEndsAt: null,
 needsPaymentMethod: false,
 } as any);

 const { getByRole, getByText } = render(
 <Drawer.Root
 open
 onOpenChange={() => {}}
 >
 <Checkout
 planId='plan_credits'
 planPeriod='month'
 />
 </Drawer.Root>,
 { wrapper },
 );

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

 const prorationCreditRow = getByText('Credit for the remainder of your current subscription.').closest(
 '.cl-lineItemsGroup',
 );
 const accountCreditRow = getByText('Credit from account balance.').closest('.cl-lineItemsGroup');

 expect(prorationCreditRow).toBeInTheDocument();
 expect(accountCreditRow).toBeInTheDocument();

 expect(prorationCreditRow).toHaveTextContent('- $5.00');
 expect(accountCreditRow).toHaveTextContent('- $10.00');
 });

 it('renders free trial details during confirmation stage', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/utils/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
 BillingCheckoutTotals,
 BillingCheckoutTotalsJSON,
 BillingCredits,
 BillingCreditsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingStatementTotals,
Expand All@@ -16,6 +18,26 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
 };
};

const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
 return {
 proration: data.proration
 ? {
 amount: billingMoneyAmountFromJSON(data.proration.amount),
 cycleDaysRemaining: data.proration.cycle_days_remaining,
 cycleDaysTotal: data.proration.cycle_days_total,
 cycleRemainingPercent: data.proration.cycle_remaining_percent,
 }
 : null,
 payer: data.payer
 ? {
 remainingBalance: billingMoneyAmountFromJSON(data.payer.remaining_balance),
 appliedAmount: billingMoneyAmountFromJSON(data.payer.applied_amount),
 }
 : null,
 total: billingMoneyAmountFromJSON(data.total),
 };
};

export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | BillingCheckoutTotalsJSON>(
 data: T,
): T extends { total_due_now: BillingMoneyAmountJSON } ? BillingCheckoutTotals : BillingStatementTotals => {
Expand All@@ -31,7 +53,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
 if ('credit' in data) {
 totals.credit = data.credit ? billingMoneyAmountFromJSON(data.credit) : null;
 }

 if ('credits' in data) {
 totals.credits = data.credits ? billingCreditsFromJSON(data.credits) : null;
 }
 if ('total_due_now' in data) {
 totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
 },
 credit: 'Credit',
 creditRemainder: 'Credit for the remainder of your current subscription.',
 payerCreditRemainder: 'Credit from account balance.',
 defaultFreePlanActive: "You're currently on the Free plan",
 free: 'Free',
 getStarted: 'Get started',
Expand Down

5 changes: 5 additions & 0 deletions
packages/shared/src/react/__tests__/payment-element.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,11 @@ describe('PaymentElement Localization', () => {
 totalDueNow: { amount: 1000, amountFormatted: '$10.00', currency: 'usd', currencySymbol: '$' },
 totalDueAfterFreeTrial: null,
 credit: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 credits: {
 proration: null,
 payer: null,
 total: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 status: 'needs_confirmation' as const,
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -645,6 +645,24 @@ export interface BillingMoneyAmount {
 currencySymbol: string;
}

export interface BillingProrationCreditDetail {
 amount: BillingMoneyAmount;
 cycleDaysRemaining: number;
 cycleDaysTotal: number;
 cycleRemainingPercent: number;
}

export interface BillingPayerCredit {
 remainingBalance: BillingMoneyAmount;
 appliedAmount: BillingMoneyAmount;
}

export interface BillingCredits {
 proration: BillingProrationCreditDetail | null;
 payer: BillingPayerCredit | null;
 total: BillingMoneyAmount;
}

/**
 * The `BillingCheckoutTotals` type represents the total costs, taxes, and other pricing details for a checkout session.
 *
Expand All@@ -671,6 +689,7 @@ export interface BillingCheckoutTotals {
 * Any credits (like account balance or promo credits) that are being applied to the checkout.
 */
 credit: BillingMoneyAmount | null;
 credits: BillingCredits | null;
 /**
 * Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout.
 */
Expand Down

30 changes: 30 additions & 0 deletions
packages/shared/src/types/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -730,6 +730,7 @@ export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 credit?: {
 amount: BillingMoneyAmountJSON;
 };
 credits?: BillingCreditsJSON;
 plan: BillingPlanJSON;
 plan_period: BillingSubscriptionPlanPeriod;
 status: BillingSubscriptionStatus;
Expand DownExpand Up@@ -779,6 +780,33 @@ export interface BillingMoneyAmountJSON {
 currency_symbol: string;
}

/**
 * Contains proration credit details including billing cycle information.
 */
export interface BillingProrationCreditDetailJSON {
 amount: BillingMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
}

/**
 * Contains payer credit details including the available balance and the amount applied to this checkout.
 */
export interface BillingPayerCreditJSON {
 remaining_balance: BillingMoneyAmountJSON;
 applied_amount: BillingMoneyAmountJSON;
}

/**
 * Unified credits breakdown for checkout totals. Can be used instead of `credit` field.
 */
export interface BillingCreditsJSON {
 proration: BillingProrationCreditDetailJSON | null;
 payer: BillingPayerCreditJSON | null;
 total: BillingMoneyAmountJSON;
}

/**
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
Expand All@@ -788,6 +816,8 @@ export interface BillingCheckoutTotalsJSON {
 tax_total: BillingMoneyAmountJSON;
 total_due_now: BillingMoneyAmountJSON;
 credit: BillingMoneyAmountJSON | null;
 credits: BillingCreditsJSON | null;
 account_credit: BillingMoneyAmountJSON | null;
 past_due: BillingMoneyAmountJSON | null;
 total_due_after_free_trial: BillingMoneyAmountJSON | null;
}
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,7 @@ export type __internal_LocalizationResource = {
 subtotal: LocalizationValue;
 credit: LocalizationValue;
 creditRemainder: LocalizationValue;
 payerCreditRemainder: LocalizationValue;
 totalDue: LocalizationValue;
 totalDueToday: LocalizationValue;
 pastDue: LocalizationValue;
Expand Down

, '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
feat(clerk-js,localizations,shared): Add support for credits#7870

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

dstaley
merged 3 commits into

from

Feb 17, 2026
 Merged


feat(clerk-js,localizations,shared): Add support for credits
#7870
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5f6e4a4

feat(clerk-js,localizations,shared,ui): Add support for credits (#7776)


dstaley Feb 17, 2026
907f239

chore(clerk-js): Bump bundlewatch


dstaley Feb 17, 2026
f6a6aa9

chore(repo): Fix changeset


dstaley Feb 17, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/shy-loops-type.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Add support for account credits in checkout.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/enableOrganizationsPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "4.02KB" },
 { "path": "./dist/checkout*.js", "maxSize": "8.82KB" },
 { "path": "./dist/checkout*.js", "maxSize": "10KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/up-plans-page*.js", "maxSize": "1.0KB" },
Expand Down

17 changes: 14 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
Expand Up@@ -35,7 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 return null;
 }

 const showCredits = !!totals.credit?.amount && totals.credit.amount > 0;
 const showProratedCredit = !!totals.credits?.proration?.amount && totals.credits.proration.amount.amount > 0;
 const showAccountCredits = !!totals.credits?.payer?.appliedAmount && totals.credits.payer.appliedAmount.amount > 0;
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

Expand DownExpand Up@@ -80,10 +81,20 @@ export const CheckoutForm = withCardStateProvider(() => {
 <LineItems.Title title={localizationKeys('billing.subtotal')} />
 <LineItems.Description text={`${totals.subtotal.currencySymbol}${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 {showCredits && (
 {showProratedCredit && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.creditRemainder')} />
 <LineItems.Description text={`- ${totals.credit?.currencySymbol}${totals.credit?.amountFormatted}`} />
 <LineItems.Description
 text={`- ${totals.credits?.proration?.amount.currencySymbol}${totals.credits?.proration?.amount.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showAccountCredits && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.payerCreditRemainder')} />
 <LineItems.Description
 text={`- ${totals.credits?.payer?.appliedAmount?.currencySymbol}${totals.credits?.payer?.appliedAmount?.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showPastDue && (
Expand Down

107 changes: 107 additions & 0 deletions
packages/clerk-js/src/ui/components/Checkout/__tests__/Checkout.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -309,6 +309,113 @@ describe('Checkout', () => {
 });
 });

 it('renders credit details', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
 f.withBilling();
 });

 fixtures.clerk.user?.getPaymentMethods.mockResolvedValue({
 data: [],
 total_count: 0,
 });

 fixtures.clerk.billing.startCheckout.mockResolvedValue({
 id: 'chk_credits_1',
 status: 'needs_confirmation',
 externalClientSecret: 'cs_test_credits_1',
 externalGatewayId: 'gw_test',
 totals: {
 subtotal: { amount: 2500, amountFormatted: '25.00', currency: 'USD', currencySymbol: '$' },
 grandTotal: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 taxTotal: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credit: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credits: {
 proration: {
 amount: { amount: 500, amountFormatted: '5.00', currency: 'USD', currencySymbol: '$' },
 cycleDaysRemaining: 15,
 cycleDaysTotal: 30,
 cycleRemainingPercent: 50,
 },
 payer: {
 remainingBalance: { amount: 2000, amountFormatted: '20.00', currency: 'USD', currencySymbol: '$' },
 appliedAmount: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 total: { amount: 1500, amountFormatted: '15.00', currency: 'USD', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 totalDueNow: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 isImmediatePlanChange: true,
 planPeriod: 'month',
 plan: {
 id: 'plan_credits',
 name: 'Pro',
 description: 'Pro plan',
 features: [],
 fee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualFee: {
 amount: 30000,
 amountFormatted: '300.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualMonthlyFee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 slug: 'pro',
 avatarUrl: '',
 publiclyVisible: true,
 isDefault: true,
 isRecurring: true,
 hasBaseFee: false,
 forPayerType: 'user',
 freeTrialDays: 7,
 freeTrialEnabled: true,
 },
 paymentMethod: undefined,
 confirm: vi.fn(),
 freeTrialEndsAt: null,
 needsPaymentMethod: false,
 } as any);

 const { getByRole, getByText } = render(
 <Drawer.Root
 open
 onOpenChange={() => {}}
 >
 <Checkout
 planId='plan_credits'
 planPeriod='month'
 />
 </Drawer.Root>,
 { wrapper },
 );

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

 const prorationCreditRow = getByText('Credit for the remainder of your current subscription.').closest(
 '.cl-lineItemsGroup',
 );
 const accountCreditRow = getByText('Credit from account balance.').closest('.cl-lineItemsGroup');

 expect(prorationCreditRow).toBeInTheDocument();
 expect(accountCreditRow).toBeInTheDocument();

 expect(prorationCreditRow).toHaveTextContent('- $5.00');
 expect(accountCreditRow).toHaveTextContent('- $10.00');
 });

 it('renders free trial details during confirmation stage', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/utils/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
 BillingCheckoutTotals,
 BillingCheckoutTotalsJSON,
 BillingCredits,
 BillingCreditsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingStatementTotals,
Expand All@@ -16,6 +18,26 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
 };
};

const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
 return {
 proration: data.proration
 ? {
 amount: billingMoneyAmountFromJSON(data.proration.amount),
 cycleDaysRemaining: data.proration.cycle_days_remaining,
 cycleDaysTotal: data.proration.cycle_days_total,
 cycleRemainingPercent: data.proration.cycle_remaining_percent,
 }
 : null,
 payer: data.payer
 ? {
 remainingBalance: billingMoneyAmountFromJSON(data.payer.remaining_balance),
 appliedAmount: billingMoneyAmountFromJSON(data.payer.applied_amount),
 }
 : null,
 total: billingMoneyAmountFromJSON(data.total),
 };
};

export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | BillingCheckoutTotalsJSON>(
 data: T,
): T extends { total_due_now: BillingMoneyAmountJSON } ? BillingCheckoutTotals : BillingStatementTotals => {
Expand All@@ -31,7 +53,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
 if ('credit' in data) {
 totals.credit = data.credit ? billingMoneyAmountFromJSON(data.credit) : null;
 }

 if ('credits' in data) {
 totals.credits = data.credits ? billingCreditsFromJSON(data.credits) : null;
 }
 if ('total_due_now' in data) {
 totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
 },
 credit: 'Credit',
 creditRemainder: 'Credit for the remainder of your current subscription.',
 payerCreditRemainder: 'Credit from account balance.',
 defaultFreePlanActive: "You're currently on the Free plan",
 free: 'Free',
 getStarted: 'Get started',
Expand Down

5 changes: 5 additions & 0 deletions
packages/shared/src/react/__tests__/payment-element.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,11 @@ describe('PaymentElement Localization', () => {
 totalDueNow: { amount: 1000, amountFormatted: '$10.00', currency: 'usd', currencySymbol: '$' },
 totalDueAfterFreeTrial: null,
 credit: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 credits: {
 proration: null,
 payer: null,
 total: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 status: 'needs_confirmation' as const,
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -645,6 +645,24 @@ export interface BillingMoneyAmount {
 currencySymbol: string;
}

export interface BillingProrationCreditDetail {
 amount: BillingMoneyAmount;
 cycleDaysRemaining: number;
 cycleDaysTotal: number;
 cycleRemainingPercent: number;
}

export interface BillingPayerCredit {
 remainingBalance: BillingMoneyAmount;
 appliedAmount: BillingMoneyAmount;
}

export interface BillingCredits {
 proration: BillingProrationCreditDetail | null;
 payer: BillingPayerCredit | null;
 total: BillingMoneyAmount;
}

/**
 * The `BillingCheckoutTotals` type represents the total costs, taxes, and other pricing details for a checkout session.
 *
Expand All@@ -671,6 +689,7 @@ export interface BillingCheckoutTotals {
 * Any credits (like account balance or promo credits) that are being applied to the checkout.
 */
 credit: BillingMoneyAmount | null;
 credits: BillingCredits | null;
 /**
 * Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout.
 */
Expand Down

30 changes: 30 additions & 0 deletions
packages/shared/src/types/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -730,6 +730,7 @@ export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 credit?: {
 amount: BillingMoneyAmountJSON;
 };
 credits?: BillingCreditsJSON;
 plan: BillingPlanJSON;
 plan_period: BillingSubscriptionPlanPeriod;
 status: BillingSubscriptionStatus;
Expand DownExpand Up@@ -779,6 +780,33 @@ export interface BillingMoneyAmountJSON {
 currency_symbol: string;
}

/**
 * Contains proration credit details including billing cycle information.
 */
export interface BillingProrationCreditDetailJSON {
 amount: BillingMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
}

/**
 * Contains payer credit details including the available balance and the amount applied to this checkout.
 */
export interface BillingPayerCreditJSON {
 remaining_balance: BillingMoneyAmountJSON;
 applied_amount: BillingMoneyAmountJSON;
}

/**
 * Unified credits breakdown for checkout totals. Can be used instead of `credit` field.
 */
export interface BillingCreditsJSON {
 proration: BillingProrationCreditDetailJSON | null;
 payer: BillingPayerCreditJSON | null;
 total: BillingMoneyAmountJSON;
}

/**
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
Expand All@@ -788,6 +816,8 @@ export interface BillingCheckoutTotalsJSON {
 tax_total: BillingMoneyAmountJSON;
 total_due_now: BillingMoneyAmountJSON;
 credit: BillingMoneyAmountJSON | null;
 credits: BillingCreditsJSON | null;
 account_credit: BillingMoneyAmountJSON | null;
 past_due: BillingMoneyAmountJSON | null;
 total_due_after_free_trial: BillingMoneyAmountJSON | null;
}
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,7 @@ export type __internal_LocalizationResource = {
 subtotal: LocalizationValue;
 credit: LocalizationValue;
 creditRemainder: LocalizationValue;
 payerCreditRemainder: LocalizationValue;
 totalDue: LocalizationValue;
 totalDueToday: LocalizationValue;
 pastDue: LocalizationValue;
Expand Down

, '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
feat(clerk-js,localizations,shared): Add support for credits#7870

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

dstaley
merged 3 commits into

from

Feb 17, 2026
 Merged


feat(clerk-js,localizations,shared): Add support for credits
#7870
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5f6e4a4

feat(clerk-js,localizations,shared,ui): Add support for credits (#7776)


dstaley Feb 17, 2026
907f239

chore(clerk-js): Bump bundlewatch


dstaley Feb 17, 2026
f6a6aa9

chore(repo): Fix changeset


dstaley Feb 17, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/shy-loops-type.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Add support for account credits in checkout.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/enableOrganizationsPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "4.02KB" },
 { "path": "./dist/checkout*.js", "maxSize": "8.82KB" },
 { "path": "./dist/checkout*.js", "maxSize": "10KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/up-plans-page*.js", "maxSize": "1.0KB" },
Expand Down

17 changes: 14 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
Expand Up@@ -35,7 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 return null;
 }

 const showCredits = !!totals.credit?.amount && totals.credit.amount > 0;
 const showProratedCredit = !!totals.credits?.proration?.amount && totals.credits.proration.amount.amount > 0;
 const showAccountCredits = !!totals.credits?.payer?.appliedAmount && totals.credits.payer.appliedAmount.amount > 0;
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

Expand DownExpand Up@@ -80,10 +81,20 @@ export const CheckoutForm = withCardStateProvider(() => {
 <LineItems.Title title={localizationKeys('billing.subtotal')} />
 <LineItems.Description text={`${totals.subtotal.currencySymbol}${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 {showCredits && (
 {showProratedCredit && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.creditRemainder')} />
 <LineItems.Description text={`- ${totals.credit?.currencySymbol}${totals.credit?.amountFormatted}`} />
 <LineItems.Description
 text={`- ${totals.credits?.proration?.amount.currencySymbol}${totals.credits?.proration?.amount.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showAccountCredits && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.payerCreditRemainder')} />
 <LineItems.Description
 text={`- ${totals.credits?.payer?.appliedAmount?.currencySymbol}${totals.credits?.payer?.appliedAmount?.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showPastDue && (
Expand Down

107 changes: 107 additions & 0 deletions
packages/clerk-js/src/ui/components/Checkout/__tests__/Checkout.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -309,6 +309,113 @@ describe('Checkout', () => {
 });
 });

 it('renders credit details', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
 f.withBilling();
 });

 fixtures.clerk.user?.getPaymentMethods.mockResolvedValue({
 data: [],
 total_count: 0,
 });

 fixtures.clerk.billing.startCheckout.mockResolvedValue({
 id: 'chk_credits_1',
 status: 'needs_confirmation',
 externalClientSecret: 'cs_test_credits_1',
 externalGatewayId: 'gw_test',
 totals: {
 subtotal: { amount: 2500, amountFormatted: '25.00', currency: 'USD', currencySymbol: '$' },
 grandTotal: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 taxTotal: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credit: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credits: {
 proration: {
 amount: { amount: 500, amountFormatted: '5.00', currency: 'USD', currencySymbol: '$' },
 cycleDaysRemaining: 15,
 cycleDaysTotal: 30,
 cycleRemainingPercent: 50,
 },
 payer: {
 remainingBalance: { amount: 2000, amountFormatted: '20.00', currency: 'USD', currencySymbol: '$' },
 appliedAmount: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 total: { amount: 1500, amountFormatted: '15.00', currency: 'USD', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 totalDueNow: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 isImmediatePlanChange: true,
 planPeriod: 'month',
 plan: {
 id: 'plan_credits',
 name: 'Pro',
 description: 'Pro plan',
 features: [],
 fee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualFee: {
 amount: 30000,
 amountFormatted: '300.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualMonthlyFee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 slug: 'pro',
 avatarUrl: '',
 publiclyVisible: true,
 isDefault: true,
 isRecurring: true,
 hasBaseFee: false,
 forPayerType: 'user',
 freeTrialDays: 7,
 freeTrialEnabled: true,
 },
 paymentMethod: undefined,
 confirm: vi.fn(),
 freeTrialEndsAt: null,
 needsPaymentMethod: false,
 } as any);

 const { getByRole, getByText } = render(
 <Drawer.Root
 open
 onOpenChange={() => {}}
 >
 <Checkout
 planId='plan_credits'
 planPeriod='month'
 />
 </Drawer.Root>,
 { wrapper },
 );

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

 const prorationCreditRow = getByText('Credit for the remainder of your current subscription.').closest(
 '.cl-lineItemsGroup',
 );
 const accountCreditRow = getByText('Credit from account balance.').closest('.cl-lineItemsGroup');

 expect(prorationCreditRow).toBeInTheDocument();
 expect(accountCreditRow).toBeInTheDocument();

 expect(prorationCreditRow).toHaveTextContent('- $5.00');
 expect(accountCreditRow).toHaveTextContent('- $10.00');
 });

 it('renders free trial details during confirmation stage', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/utils/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
 BillingCheckoutTotals,
 BillingCheckoutTotalsJSON,
 BillingCredits,
 BillingCreditsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingStatementTotals,
Expand All@@ -16,6 +18,26 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
 };
};

const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
 return {
 proration: data.proration
 ? {
 amount: billingMoneyAmountFromJSON(data.proration.amount),
 cycleDaysRemaining: data.proration.cycle_days_remaining,
 cycleDaysTotal: data.proration.cycle_days_total,
 cycleRemainingPercent: data.proration.cycle_remaining_percent,
 }
 : null,
 payer: data.payer
 ? {
 remainingBalance: billingMoneyAmountFromJSON(data.payer.remaining_balance),
 appliedAmount: billingMoneyAmountFromJSON(data.payer.applied_amount),
 }
 : null,
 total: billingMoneyAmountFromJSON(data.total),
 };
};

export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | BillingCheckoutTotalsJSON>(
 data: T,
): T extends { total_due_now: BillingMoneyAmountJSON } ? BillingCheckoutTotals : BillingStatementTotals => {
Expand All@@ -31,7 +53,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
 if ('credit' in data) {
 totals.credit = data.credit ? billingMoneyAmountFromJSON(data.credit) : null;
 }

 if ('credits' in data) {
 totals.credits = data.credits ? billingCreditsFromJSON(data.credits) : null;
 }
 if ('total_due_now' in data) {
 totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
 },
 credit: 'Credit',
 creditRemainder: 'Credit for the remainder of your current subscription.',
 payerCreditRemainder: 'Credit from account balance.',
 defaultFreePlanActive: "You're currently on the Free plan",
 free: 'Free',
 getStarted: 'Get started',
Expand Down

5 changes: 5 additions & 0 deletions
packages/shared/src/react/__tests__/payment-element.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,11 @@ describe('PaymentElement Localization', () => {
 totalDueNow: { amount: 1000, amountFormatted: '$10.00', currency: 'usd', currencySymbol: '$' },
 totalDueAfterFreeTrial: null,
 credit: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 credits: {
 proration: null,
 payer: null,
 total: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 status: 'needs_confirmation' as const,
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -645,6 +645,24 @@ export interface BillingMoneyAmount {
 currencySymbol: string;
}

export interface BillingProrationCreditDetail {
 amount: BillingMoneyAmount;
 cycleDaysRemaining: number;
 cycleDaysTotal: number;
 cycleRemainingPercent: number;
}

export interface BillingPayerCredit {
 remainingBalance: BillingMoneyAmount;
 appliedAmount: BillingMoneyAmount;
}

export interface BillingCredits {
 proration: BillingProrationCreditDetail | null;
 payer: BillingPayerCredit | null;
 total: BillingMoneyAmount;
}

/**
 * The `BillingCheckoutTotals` type represents the total costs, taxes, and other pricing details for a checkout session.
 *
Expand All@@ -671,6 +689,7 @@ export interface BillingCheckoutTotals {
 * Any credits (like account balance or promo credits) that are being applied to the checkout.
 */
 credit: BillingMoneyAmount | null;
 credits: BillingCredits | null;
 /**
 * Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout.
 */
Expand Down

30 changes: 30 additions & 0 deletions
packages/shared/src/types/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -730,6 +730,7 @@ export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 credit?: {
 amount: BillingMoneyAmountJSON;
 };
 credits?: BillingCreditsJSON;
 plan: BillingPlanJSON;
 plan_period: BillingSubscriptionPlanPeriod;
 status: BillingSubscriptionStatus;
Expand DownExpand Up@@ -779,6 +780,33 @@ export interface BillingMoneyAmountJSON {
 currency_symbol: string;
}

/**
 * Contains proration credit details including billing cycle information.
 */
export interface BillingProrationCreditDetailJSON {
 amount: BillingMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
}

/**
 * Contains payer credit details including the available balance and the amount applied to this checkout.
 */
export interface BillingPayerCreditJSON {
 remaining_balance: BillingMoneyAmountJSON;
 applied_amount: BillingMoneyAmountJSON;
}

/**
 * Unified credits breakdown for checkout totals. Can be used instead of `credit` field.
 */
export interface BillingCreditsJSON {
 proration: BillingProrationCreditDetailJSON | null;
 payer: BillingPayerCreditJSON | null;
 total: BillingMoneyAmountJSON;
}

/**
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
Expand All@@ -788,6 +816,8 @@ export interface BillingCheckoutTotalsJSON {
 tax_total: BillingMoneyAmountJSON;
 total_due_now: BillingMoneyAmountJSON;
 credit: BillingMoneyAmountJSON | null;
 credits: BillingCreditsJSON | null;
 account_credit: BillingMoneyAmountJSON | null;
 past_due: BillingMoneyAmountJSON | null;
 total_due_after_free_trial: BillingMoneyAmountJSON | null;
}
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,7 @@ export type __internal_LocalizationResource = {
 subtotal: LocalizationValue;
 credit: LocalizationValue;
 creditRemainder: LocalizationValue;
 payerCreditRemainder: LocalizationValue;
 totalDue: LocalizationValue;
 totalDueToday: LocalizationValue;
 pastDue: LocalizationValue;
Expand Down

, '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
feat(clerk-js,localizations,shared): Add support for credits#7870

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

dstaley
merged 3 commits into

from

Feb 17, 2026
 Merged


feat(clerk-js,localizations,shared): Add support for credits
#7870
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5f6e4a4

feat(clerk-js,localizations,shared,ui): Add support for credits (#7776)


dstaley Feb 17, 2026
907f239

chore(clerk-js): Bump bundlewatch


dstaley Feb 17, 2026
f6a6aa9

chore(repo): Fix changeset


dstaley Feb 17, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/shy-loops-type.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Add support for account credits in checkout.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/enableOrganizationsPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "4.02KB" },
 { "path": "./dist/checkout*.js", "maxSize": "8.82KB" },
 { "path": "./dist/checkout*.js", "maxSize": "10KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/up-plans-page*.js", "maxSize": "1.0KB" },
Expand Down

17 changes: 14 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
Expand Up@@ -35,7 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 return null;
 }

 const showCredits = !!totals.credit?.amount && totals.credit.amount > 0;
 const showProratedCredit = !!totals.credits?.proration?.amount && totals.credits.proration.amount.amount > 0;
 const showAccountCredits = !!totals.credits?.payer?.appliedAmount && totals.credits.payer.appliedAmount.amount > 0;
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

Expand DownExpand Up@@ -80,10 +81,20 @@ export const CheckoutForm = withCardStateProvider(() => {
 <LineItems.Title title={localizationKeys('billing.subtotal')} />
 <LineItems.Description text={`${totals.subtotal.currencySymbol}${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 {showCredits && (
 {showProratedCredit && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.creditRemainder')} />
 <LineItems.Description text={`- ${totals.credit?.currencySymbol}${totals.credit?.amountFormatted}`} />
 <LineItems.Description
 text={`- ${totals.credits?.proration?.amount.currencySymbol}${totals.credits?.proration?.amount.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showAccountCredits && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.payerCreditRemainder')} />
 <LineItems.Description
 text={`- ${totals.credits?.payer?.appliedAmount?.currencySymbol}${totals.credits?.payer?.appliedAmount?.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showPastDue && (
Expand Down

107 changes: 107 additions & 0 deletions
packages/clerk-js/src/ui/components/Checkout/__tests__/Checkout.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -309,6 +309,113 @@ describe('Checkout', () => {
 });
 });

 it('renders credit details', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
 f.withBilling();
 });

 fixtures.clerk.user?.getPaymentMethods.mockResolvedValue({
 data: [],
 total_count: 0,
 });

 fixtures.clerk.billing.startCheckout.mockResolvedValue({
 id: 'chk_credits_1',
 status: 'needs_confirmation',
 externalClientSecret: 'cs_test_credits_1',
 externalGatewayId: 'gw_test',
 totals: {
 subtotal: { amount: 2500, amountFormatted: '25.00', currency: 'USD', currencySymbol: '$' },
 grandTotal: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 taxTotal: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credit: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credits: {
 proration: {
 amount: { amount: 500, amountFormatted: '5.00', currency: 'USD', currencySymbol: '$' },
 cycleDaysRemaining: 15,
 cycleDaysTotal: 30,
 cycleRemainingPercent: 50,
 },
 payer: {
 remainingBalance: { amount: 2000, amountFormatted: '20.00', currency: 'USD', currencySymbol: '$' },
 appliedAmount: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 total: { amount: 1500, amountFormatted: '15.00', currency: 'USD', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 totalDueNow: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 isImmediatePlanChange: true,
 planPeriod: 'month',
 plan: {
 id: 'plan_credits',
 name: 'Pro',
 description: 'Pro plan',
 features: [],
 fee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualFee: {
 amount: 30000,
 amountFormatted: '300.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualMonthlyFee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 slug: 'pro',
 avatarUrl: '',
 publiclyVisible: true,
 isDefault: true,
 isRecurring: true,
 hasBaseFee: false,
 forPayerType: 'user',
 freeTrialDays: 7,
 freeTrialEnabled: true,
 },
 paymentMethod: undefined,
 confirm: vi.fn(),
 freeTrialEndsAt: null,
 needsPaymentMethod: false,
 } as any);

 const { getByRole, getByText } = render(
 <Drawer.Root
 open
 onOpenChange={() => {}}
 >
 <Checkout
 planId='plan_credits'
 planPeriod='month'
 />
 </Drawer.Root>,
 { wrapper },
 );

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

 const prorationCreditRow = getByText('Credit for the remainder of your current subscription.').closest(
 '.cl-lineItemsGroup',
 );
 const accountCreditRow = getByText('Credit from account balance.').closest('.cl-lineItemsGroup');

 expect(prorationCreditRow).toBeInTheDocument();
 expect(accountCreditRow).toBeInTheDocument();

 expect(prorationCreditRow).toHaveTextContent('- $5.00');
 expect(accountCreditRow).toHaveTextContent('- $10.00');
 });

 it('renders free trial details during confirmation stage', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/utils/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
 BillingCheckoutTotals,
 BillingCheckoutTotalsJSON,
 BillingCredits,
 BillingCreditsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingStatementTotals,
Expand All@@ -16,6 +18,26 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
 };
};

const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
 return {
 proration: data.proration
 ? {
 amount: billingMoneyAmountFromJSON(data.proration.amount),
 cycleDaysRemaining: data.proration.cycle_days_remaining,
 cycleDaysTotal: data.proration.cycle_days_total,
 cycleRemainingPercent: data.proration.cycle_remaining_percent,
 }
 : null,
 payer: data.payer
 ? {
 remainingBalance: billingMoneyAmountFromJSON(data.payer.remaining_balance),
 appliedAmount: billingMoneyAmountFromJSON(data.payer.applied_amount),
 }
 : null,
 total: billingMoneyAmountFromJSON(data.total),
 };
};

export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | BillingCheckoutTotalsJSON>(
 data: T,
): T extends { total_due_now: BillingMoneyAmountJSON } ? BillingCheckoutTotals : BillingStatementTotals => {
Expand All@@ -31,7 +53,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
 if ('credit' in data) {
 totals.credit = data.credit ? billingMoneyAmountFromJSON(data.credit) : null;
 }

 if ('credits' in data) {
 totals.credits = data.credits ? billingCreditsFromJSON(data.credits) : null;
 }
 if ('total_due_now' in data) {
 totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
 },
 credit: 'Credit',
 creditRemainder: 'Credit for the remainder of your current subscription.',
 payerCreditRemainder: 'Credit from account balance.',
 defaultFreePlanActive: "You're currently on the Free plan",
 free: 'Free',
 getStarted: 'Get started',
Expand Down

5 changes: 5 additions & 0 deletions
packages/shared/src/react/__tests__/payment-element.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,11 @@ describe('PaymentElement Localization', () => {
 totalDueNow: { amount: 1000, amountFormatted: '$10.00', currency: 'usd', currencySymbol: '$' },
 totalDueAfterFreeTrial: null,
 credit: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 credits: {
 proration: null,
 payer: null,
 total: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 status: 'needs_confirmation' as const,
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -645,6 +645,24 @@ export interface BillingMoneyAmount {
 currencySymbol: string;
}

export interface BillingProrationCreditDetail {
 amount: BillingMoneyAmount;
 cycleDaysRemaining: number;
 cycleDaysTotal: number;
 cycleRemainingPercent: number;
}

export interface BillingPayerCredit {
 remainingBalance: BillingMoneyAmount;
 appliedAmount: BillingMoneyAmount;
}

export interface BillingCredits {
 proration: BillingProrationCreditDetail | null;
 payer: BillingPayerCredit | null;
 total: BillingMoneyAmount;
}

/**
 * The `BillingCheckoutTotals` type represents the total costs, taxes, and other pricing details for a checkout session.
 *
Expand All@@ -671,6 +689,7 @@ export interface BillingCheckoutTotals {
 * Any credits (like account balance or promo credits) that are being applied to the checkout.
 */
 credit: BillingMoneyAmount | null;
 credits: BillingCredits | null;
 /**
 * Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout.
 */
Expand Down

30 changes: 30 additions & 0 deletions
packages/shared/src/types/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -730,6 +730,7 @@ export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 credit?: {
 amount: BillingMoneyAmountJSON;
 };
 credits?: BillingCreditsJSON;
 plan: BillingPlanJSON;
 plan_period: BillingSubscriptionPlanPeriod;
 status: BillingSubscriptionStatus;
Expand DownExpand Up@@ -779,6 +780,33 @@ export interface BillingMoneyAmountJSON {
 currency_symbol: string;
}

/**
 * Contains proration credit details including billing cycle information.
 */
export interface BillingProrationCreditDetailJSON {
 amount: BillingMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
}

/**
 * Contains payer credit details including the available balance and the amount applied to this checkout.
 */
export interface BillingPayerCreditJSON {
 remaining_balance: BillingMoneyAmountJSON;
 applied_amount: BillingMoneyAmountJSON;
}

/**
 * Unified credits breakdown for checkout totals. Can be used instead of `credit` field.
 */
export interface BillingCreditsJSON {
 proration: BillingProrationCreditDetailJSON | null;
 payer: BillingPayerCreditJSON | null;
 total: BillingMoneyAmountJSON;
}

/**
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
Expand All@@ -788,6 +816,8 @@ export interface BillingCheckoutTotalsJSON {
 tax_total: BillingMoneyAmountJSON;
 total_due_now: BillingMoneyAmountJSON;
 credit: BillingMoneyAmountJSON | null;
 credits: BillingCreditsJSON | null;
 account_credit: BillingMoneyAmountJSON | null;
 past_due: BillingMoneyAmountJSON | null;
 total_due_after_free_trial: BillingMoneyAmountJSON | null;
}
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,7 @@ export type __internal_LocalizationResource = {
 subtotal: LocalizationValue;
 credit: LocalizationValue;
 creditRemainder: LocalizationValue;
 payerCreditRemainder: LocalizationValue;
 totalDue: LocalizationValue;
 totalDueToday: LocalizationValue;
 pastDue: LocalizationValue;
Expand Down

, '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
feat(clerk-js,localizations,shared): Add support for credits#7870

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

dstaley
merged 3 commits into

from

Feb 17, 2026
 Merged


feat(clerk-js,localizations,shared): Add support for credits
#7870
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5f6e4a4

feat(clerk-js,localizations,shared,ui): Add support for credits (#7776)


dstaley Feb 17, 2026
907f239

chore(clerk-js): Bump bundlewatch


dstaley Feb 17, 2026
f6a6aa9

chore(repo): Fix changeset


dstaley Feb 17, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/shy-loops-type.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
---

Add support for account credits in checkout.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/enableOrganizationsPrompt*.js", "maxSize": "6.5KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "4.02KB" },
 { "path": "./dist/checkout*.js", "maxSize": "8.82KB" },
 { "path": "./dist/checkout*.js", "maxSize": "10KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "3.0KB" },
 { "path": "./dist/up-plans-page*.js", "maxSize": "1.0KB" },
Expand Down

17 changes: 14 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
Expand Up@@ -35,7 +35,8 @@ export const CheckoutForm = withCardStateProvider(() => {
 return null;
 }

 const showCredits = !!totals.credit?.amount && totals.credit.amount > 0;
 const showProratedCredit = !!totals.credits?.proration?.amount && totals.credits.proration.amount.amount > 0;
 const showAccountCredits = !!totals.credits?.payer?.appliedAmount && totals.credits.payer.appliedAmount.amount > 0;
 const showPastDue = !!totals.pastDue?.amount && totals.pastDue.amount > 0;
 const showDowngradeInfo = !isImmediatePlanChange;

Expand DownExpand Up@@ -80,10 +81,20 @@ export const CheckoutForm = withCardStateProvider(() => {
 <LineItems.Title title={localizationKeys('billing.subtotal')} />
 <LineItems.Description text={`${totals.subtotal.currencySymbol}${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 {showCredits && (
 {showProratedCredit && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.creditRemainder')} />
 <LineItems.Description text={`- ${totals.credit?.currencySymbol}${totals.credit?.amountFormatted}`} />
 <LineItems.Description
 text={`- ${totals.credits?.proration?.amount.currencySymbol}${totals.credits?.proration?.amount.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showAccountCredits && (
 <LineItems.Group variant='tertiary'>
 <LineItems.Title title={localizationKeys('billing.payerCreditRemainder')} />
 <LineItems.Description
 text={`- ${totals.credits?.payer?.appliedAmount?.currencySymbol}${totals.credits?.payer?.appliedAmount?.amountFormatted}`}
 />
 </LineItems.Group>
 )}
 {showPastDue && (
Expand Down

107 changes: 107 additions & 0 deletions
packages/clerk-js/src/ui/components/Checkout/__tests__/Checkout.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -309,6 +309,113 @@ describe('Checkout', () => {
 });
 });

 it('renders credit details', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
 f.withBilling();
 });

 fixtures.clerk.user?.getPaymentMethods.mockResolvedValue({
 data: [],
 total_count: 0,
 });

 fixtures.clerk.billing.startCheckout.mockResolvedValue({
 id: 'chk_credits_1',
 status: 'needs_confirmation',
 externalClientSecret: 'cs_test_credits_1',
 externalGatewayId: 'gw_test',
 totals: {
 subtotal: { amount: 2500, amountFormatted: '25.00', currency: 'USD', currencySymbol: '$' },
 grandTotal: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 taxTotal: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credit: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 credits: {
 proration: {
 amount: { amount: 500, amountFormatted: '5.00', currency: 'USD', currencySymbol: '$' },
 cycleDaysRemaining: 15,
 cycleDaysTotal: 30,
 cycleRemainingPercent: 50,
 },
 payer: {
 remainingBalance: { amount: 2000, amountFormatted: '20.00', currency: 'USD', currencySymbol: '$' },
 appliedAmount: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 total: { amount: 1500, amountFormatted: '15.00', currency: 'USD', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '0.00', currency: 'USD', currencySymbol: '$' },
 totalDueNow: { amount: 1000, amountFormatted: '10.00', currency: 'USD', currencySymbol: '$' },
 },
 isImmediatePlanChange: true,
 planPeriod: 'month',
 plan: {
 id: 'plan_credits',
 name: 'Pro',
 description: 'Pro plan',
 features: [],
 fee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualFee: {
 amount: 30000,
 amountFormatted: '300.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 annualMonthlyFee: {
 amount: 2500,
 amountFormatted: '25.00',
 currency: 'USD',
 currencySymbol: '$',
 },
 slug: 'pro',
 avatarUrl: '',
 publiclyVisible: true,
 isDefault: true,
 isRecurring: true,
 hasBaseFee: false,
 forPayerType: 'user',
 freeTrialDays: 7,
 freeTrialEnabled: true,
 },
 paymentMethod: undefined,
 confirm: vi.fn(),
 freeTrialEndsAt: null,
 needsPaymentMethod: false,
 } as any);

 const { getByRole, getByText } = render(
 <Drawer.Root
 open
 onOpenChange={() => {}}
 >
 <Checkout
 planId='plan_credits'
 planPeriod='month'
 />
 </Drawer.Root>,
 { wrapper },
 );

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

 const prorationCreditRow = getByText('Credit for the remainder of your current subscription.').closest(
 '.cl-lineItemsGroup',
 );
 const accountCreditRow = getByText('Credit from account balance.').closest('.cl-lineItemsGroup');

 expect(prorationCreditRow).toBeInTheDocument();
 expect(accountCreditRow).toBeInTheDocument();

 expect(prorationCreditRow).toHaveTextContent('- $5.00');
 expect(accountCreditRow).toHaveTextContent('- $10.00');
 });

 it('renders free trial details during confirmation stage', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withUser({ email_addresses: ['test@clerk.com'] });
Expand Down

26 changes: 25 additions & 1 deletion
packages/clerk-js/src/utils/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type {
 BillingCheckoutTotals,
 BillingCheckoutTotalsJSON,
 BillingCredits,
 BillingCreditsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingStatementTotals,
Expand All@@ -16,6 +18,26 @@ export const billingMoneyAmountFromJSON = (data: BillingMoneyAmountJSON): Billin
 };
};

const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
 return {
 proration: data.proration
 ? {
 amount: billingMoneyAmountFromJSON(data.proration.amount),
 cycleDaysRemaining: data.proration.cycle_days_remaining,
 cycleDaysTotal: data.proration.cycle_days_total,
 cycleRemainingPercent: data.proration.cycle_remaining_percent,
 }
 : null,
 payer: data.payer
 ? {
 remainingBalance: billingMoneyAmountFromJSON(data.payer.remaining_balance),
 appliedAmount: billingMoneyAmountFromJSON(data.payer.applied_amount),
 }
 : null,
 total: billingMoneyAmountFromJSON(data.total),
 };
};

export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | BillingCheckoutTotalsJSON>(
 data: T,
): T extends { total_due_now: BillingMoneyAmountJSON } ? BillingCheckoutTotals : BillingStatementTotals => {
Expand All@@ -31,7 +53,9 @@ export const billingTotalsFromJSON = <T extends BillingStatementTotalsJSON | Bil
 if ('credit' in data) {
 totals.credit = data.credit ? billingMoneyAmountFromJSON(data.credit) : null;
 }

 if ('credits' in data) {
 totals.credits = data.credits ? billingCreditsFromJSON(data.credits) : null;
 }
 if ('total_due_now' in data) {
 totals.totalDueNow = billingMoneyAmountFromJSON(data.total_due_now);
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export const enUS: LocalizationResource = {
 },
 credit: 'Credit',
 creditRemainder: 'Credit for the remainder of your current subscription.',
 payerCreditRemainder: 'Credit from account balance.',
 defaultFreePlanActive: "You're currently on the Free plan",
 free: 'Free',
 getStarted: 'Get started',
Expand Down

5 changes: 5 additions & 0 deletions
packages/shared/src/react/__tests__/payment-element.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,11 @@ describe('PaymentElement Localization', () => {
 totalDueNow: { amount: 1000, amountFormatted: '$10.00', currency: 'usd', currencySymbol: '$' },
 totalDueAfterFreeTrial: null,
 credit: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 credits: {
 proration: null,
 payer: null,
 total: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 pastDue: { amount: 0, amountFormatted: '$0.00', currency: 'usd', currencySymbol: '$' },
 },
 status: 'needs_confirmation' as const,
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -645,6 +645,24 @@ export interface BillingMoneyAmount {
 currencySymbol: string;
}

export interface BillingProrationCreditDetail {
 amount: BillingMoneyAmount;
 cycleDaysRemaining: number;
 cycleDaysTotal: number;
 cycleRemainingPercent: number;
}

export interface BillingPayerCredit {
 remainingBalance: BillingMoneyAmount;
 appliedAmount: BillingMoneyAmount;
}

export interface BillingCredits {
 proration: BillingProrationCreditDetail | null;
 payer: BillingPayerCredit | null;
 total: BillingMoneyAmount;
}

/**
 * The `BillingCheckoutTotals` type represents the total costs, taxes, and other pricing details for a checkout session.
 *
Expand All@@ -671,6 +689,7 @@ export interface BillingCheckoutTotals {
 * Any credits (like account balance or promo credits) that are being applied to the checkout.
 */
 credit: BillingMoneyAmount | null;
 credits: BillingCredits | null;
 /**
 * Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout.
 */
Expand Down

30 changes: 30 additions & 0 deletions
packages/shared/src/types/json.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -730,6 +730,7 @@ export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 credit?: {
 amount: BillingMoneyAmountJSON;
 };
 credits?: BillingCreditsJSON;
 plan: BillingPlanJSON;
 plan_period: BillingSubscriptionPlanPeriod;
 status: BillingSubscriptionStatus;
Expand DownExpand Up@@ -779,6 +780,33 @@ export interface BillingMoneyAmountJSON {
 currency_symbol: string;
}

/**
 * Contains proration credit details including billing cycle information.
 */
export interface BillingProrationCreditDetailJSON {
 amount: BillingMoneyAmountJSON;
 cycle_days_remaining: number;
 cycle_days_total: number;
 cycle_remaining_percent: number;
}

/**
 * Contains payer credit details including the available balance and the amount applied to this checkout.
 */
export interface BillingPayerCreditJSON {
 remaining_balance: BillingMoneyAmountJSON;
 applied_amount: BillingMoneyAmountJSON;
}

/**
 * Unified credits breakdown for checkout totals. Can be used instead of `credit` field.
 */
export interface BillingCreditsJSON {
 proration: BillingProrationCreditDetailJSON | null;
 payer: BillingPayerCreditJSON | null;
 total: BillingMoneyAmountJSON;
}

/**
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
Expand All@@ -788,6 +816,8 @@ export interface BillingCheckoutTotalsJSON {
 tax_total: BillingMoneyAmountJSON;
 total_due_now: BillingMoneyAmountJSON;
 credit: BillingMoneyAmountJSON | null;
 credits: BillingCreditsJSON | null;
 account_credit: BillingMoneyAmountJSON | null;
 past_due: BillingMoneyAmountJSON | null;
 total_due_after_free_trial: BillingMoneyAmountJSON | null;
}
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,7 @@ export type __internal_LocalizationResource = {
 subtotal: LocalizationValue;
 credit: LocalizationValue;
 creditRemainder: LocalizationValue;
 payerCreditRemainder: LocalizationValue;
 totalDue: LocalizationValue;
 totalDueToday: LocalizationValue;
 pastDue: LocalizationValue;
Expand Down