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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/billing-seat-tier-rows-payment-attempt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/ui': minor
---

Surface seat-based billing details on payment attempts. The payment attempt resource now exposes a `totals` field (`BillingPaymentTotals`) carrying optional `baseFee` and `perUnitTotals` breakdowns. The payment-attempt detail page renders a "Seats" line (`{quantity} × {feePerBlock}`, or the tier total for unlimited tiers) between the plan title and subtotal when the subscription item is seat-billed.
5 changes: 4 additions & 1 deletion packages/clerk-js/src/core/resources/BillingPayment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,11 @@ import type {
BillingPaymentMethodResource,
BillingPaymentResource,
BillingPaymentStatus,
BillingPaymentTotals,
BillingSubscriptionItemResource,
} from '@clerk/shared/types';

import { billingMoneyAmountFromJSON } from '../../utils';
import { billingMoneyAmountFromJSON, billingPaymentTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPaymentMethod, BillingSubscriptionItem } from './internal';

Expand All@@ -22,6 +23,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
subscriptionItem!: BillingSubscriptionItemResource;
chargeType!: BillingPaymentChargeType;
status!: BillingPaymentStatus;
totals: BillingPaymentTotals | null = null;

constructor(data: BillingPaymentJSON) {
super();
Expand All@@ -42,6 +44,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
this.subscriptionItem = new BillingSubscriptionItem(data.subscription_item);
this.chargeType = data.charge_type;
this.status = data.status;
this.totals = data.totals ? billingPaymentTotalsFromJSON(data.totals) : null;
return this;
}
}
70 changes: 70 additions & 0 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
amount_formatted: (amount / 100).toFixed(2),
currency: 'USD',
currency_symbol: '$',
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(4500),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(500),
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.subtotal.amount).toBe(4500);
expect(totals.grandTotal.amount).toBe(5000);
expect(totals.taxTotal.amount).toBe(500);
expect(totals.baseFee).toBeNull();
expect(totals.perUnitTotals).toBeUndefined();
});

it('maps base_fee when present', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
base_fee: moneyJSON(1000),
};

expect(billingPaymentTotalsFromJSON(data).baseFee?.amount).toBe(1000);
});

it('maps per_unit_totals tiers with snake_case → camelCase conversion', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [
{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) },
{ quantity: null, fee_per_block: moneyJSON(0), total: moneyJSON(0) },
],
},
],
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.perUnitTotals).toHaveLength(1);
expect(totals.perUnitTotals?.[0].name).toBe('seats');
expect(totals.perUnitTotals?.[0].blockSize).toBe(1);
expect(totals.perUnitTotals?.[0].tiers[0]).toMatchObject({
quantity: 5,
feePerBlock: { amount: 1000 },
total: { amount: 5000 },
});
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});
12 changes: 12 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import type {
BillingCreditsJSON,
BillingMoneyAmount,
BillingMoneyAmountJSON,
BillingPaymentTotals,
BillingPaymentTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingStatementTotals,
Expand DownExpand Up@@ -32,6 +34,16 @@ const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingP
}));
};

export const billingPaymentTotalsFromJSON = (data: BillingPaymentTotalsJSON): BillingPaymentTotals => {
return {
subtotal: billingMoneyAmountFromJSON(data.subtotal),
grandTotal: billingMoneyAmountFromJSON(data.grand_total),
taxTotal: billingMoneyAmountFromJSON(data.tax_total),
baseFee: data.base_fee ? billingMoneyAmountFromJSON(data.base_fee) : null,
perUnitTotals: data.per_unit_totals ? billingPerUnitTotalsFromJSON(data.per_unit_totals) : undefined,
};
};

export const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
return {
proration: data.proration
Expand Down
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,11 @@ export const enUS: LocalizationResource = {
},
reSubscribe: 'Resubscribe',
seats: 'Seats',
seatsWithLimit: 'Seats (up to {{limit}})',
seatBreakdownSingular: '1 seat at {{rate}}/mo',
seatBreakdownPlural: '{{chargeable}} seats at {{rate}}/mo',
seatBreakdownIncludedSingular: '1 seat at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seatBreakdownIncludedPlural: '{{chargeable}} seats at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seeAllFeatures: 'See all features',
startFreeTrial: 'Start free trial',
startFreeTrial__days: 'Start {{days}}-day free trial',
Expand Down
34 changes: 34 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -505,6 +505,35 @@ export type BillingPaymentChargeType = 'checkout' | 'recurring';
*/
export type BillingPaymentStatus = 'pending' | 'paid' | 'failed';

/**
* The `BillingPaymentTotals` type represents the per-payment cost breakdown, including any base fee
* and per-unit (for example, seats) subtotals.
*
* @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.
*/
export interface BillingPaymentTotals {
/**
* The price of the items before taxes, credits, or discounts are applied.
*/
subtotal: BillingMoneyAmount;
/**
* The total amount for the payment, including taxes and after credits/discounts are applied.
*/
grandTotal: BillingMoneyAmount;
/**
* The amount of tax included in the payment.
*/
taxTotal: BillingMoneyAmount;
/**
* The flat base fee charged on top of any per-unit fees.
*/
baseFee?: BillingMoneyAmount | null;
/**
* Per-unit cost breakdown for this payment (for example, seats).
*/
perUnitTotals?: BillingPerUnitTotal[];
}

/**
* The `BillingPaymentResource` type represents a payment attempt for a user or Organization.
*
Expand DownExpand Up@@ -547,6 +576,11 @@ export interface BillingPaymentResource extends ClerkResource {
* The current status of the payment.
*/
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals.
* Absent on older responses.
*/
totals?: BillingPaymentTotals | null;
}

/**
Expand Down
18 changes: 18 additions & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -740,6 +740,19 @@ export interface BillingStatementGroupJSON extends ClerkResourceJSON {
items: BillingPaymentJSON[];
}

/**
* @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.
*
* Per-payment cost breakdown including optional base fee and per-unit (for example, seats) subtotals.
*/
export interface BillingPaymentTotalsJSON {
Comment thread
aeliox marked this conversation as resolved.
subtotal: BillingMoneyAmountJSON;
grand_total: BillingMoneyAmountJSON;
tax_total: BillingMoneyAmountJSON;
base_fee?: BillingMoneyAmountJSON | null;
per_unit_totals?: BillingPerUnitTotalJSON[];
}

/**
* @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@@ -754,6 +767,11 @@ export interface BillingPaymentJSON extends ClerkResourceJSON {
subscription_item: BillingSubscriptionItemJSON;
charge_type: BillingPaymentChargeType;
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats)
* subtotals. Absent on older responses.
*/
totals?: BillingPaymentTotalsJSON | null;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,6 +191,11 @@ export type __internal_LocalizationResource = {
keepSubscription: LocalizationValue;
reSubscribe: LocalizationValue;
seats: LocalizationValue;
seatsWithLimit: LocalizationValue<'limit'>;
seatBreakdownSingular: LocalizationValue<'rate'>;
seatBreakdownPlural: LocalizationValue<'chargeable' | 'rate'>;
seatBreakdownIncludedSingular: LocalizationValue<'totalSeats' | 'included' | 'rate'>;
seatBreakdownIncludedPlural: LocalizationValue<'totalSeats' | 'included' | 'chargeable' | 'rate'>;
subscribe: LocalizationValue;
startFreeTrial: LocalizationValue;
startFreeTrial__days: LocalizationValue<'days'>;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
import { __internal_usePaymentAttemptQuery } from '@clerk/shared/react/index';
import type { BillingSubscriptionItemResource } from '@clerk/shared/types';
import type { BillingPaymentResource } from '@clerk/shared/types';

import { Alert } from '@/ui/elements/Alert';
import { Header } from '@/ui/elements/Header';
import { LineItems } from '@/ui/elements/LineItems';
import { getPlanSeatLimit, getSeatsPerUnitTotal, summarizeSeatCharges } from '@/ui/utils/billingPlanSeats';
import { formatDate } from '@/ui/utils/formatDate';
import { truncateWithEndVisible } from '@/ui/utils/truncateTextWithEndVisible';

Expand DownExpand Up@@ -42,8 +43,6 @@ export const PaymentAttemptPage = () => {
enabled: Boolean(params.paymentAttemptId),
});

const subscriptionItem = paymentAttempt?.subscriptionItem;

if (isLoading) {
return (
<Box sx={{ display: 'flex', justifyContent: 'center', alignItems: 'center', height: '100%' }}>
Expand DownExpand Up@@ -147,7 +146,7 @@ export const PaymentAttemptPage = () => {
{paymentAttempt.status}
</Badge>
</Box>
<PaymentAttemptBody subscriptionItem={subscriptionItem} />
<PaymentAttemptBody paymentAttempt={paymentAttempt} />
<Box
elementDescriptor={descriptors.paymentAttemptFooter}
as='footer'
Expand DownExpand Up@@ -198,18 +197,25 @@ export const PaymentAttemptPage = () => {
);
};

function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSubscriptionItemResource | undefined }) {
if (!subscriptionItem) {
function PaymentAttemptBody({ paymentAttempt }: { paymentAttempt: BillingPaymentResource | undefined }) {
if (!paymentAttempt) {
return null;
}

const { subscriptionItem } = paymentAttempt;

const fee =
subscriptionItem.planPeriod === 'month'
? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.fee!
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.annualMonthlyFee!;

const seatsTotal = subscriptionItem.seats != null ? getSeatsPerUnitTotal(paymentAttempt.totals) : undefined;
Comment thread
aeliox marked this conversation as resolved.
const seatSummary = summarizeSeatCharges(seatsTotal);
const seatsChargeable = seatSummary ? seatSummary.totalSeats - seatSummary.included : 0;
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);

return (
<Box
elementDescriptor={descriptors.paymentAttemptBody}
Expand All@@ -225,6 +231,42 @@ function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSub
text={`${fee.currencySymbol}${fee.amountFormatted}`}
/>
</LineItems.Group>
{seatSummary && (
<LineItems.Group>
<LineItems.Title
title={
planSeatLimit != null
? localizationKeys('billing.seatsWithLimit', { limit: planSeatLimit })
: localizationKeys('billing.seats')
}
description={(() => {
const rate = `${seatSummary.paidTier.feePerBlock.currencySymbol}${seatSummary.paidTier.feePerBlock.amountFormatted}`;
const isSingular = seatsChargeable === 1;
if (seatSummary.included > 0) {
return isSingular
? localizationKeys('billing.seatBreakdownIncludedSingular', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
rate,
})
: localizationKeys('billing.seatBreakdownIncludedPlural', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
chargeable: seatsChargeable,
rate,
});
}
return isSingular
? localizationKeys('billing.seatBreakdownSingular', { rate })
: localizationKeys('billing.seatBreakdownPlural', { chargeable: seatsChargeable, rate });
})()}
/>
<LineItems.Description
prefix={subscriptionItem.planPeriod === 'annual' ? 'x12' : undefined}
text={`${seatSummary.paidTier.total.currencySymbol}${seatSummary.paidTier.total.amountFormatted}`}
/>
</LineItems.Group>
Comment thread
aeliox marked this conversation as resolved.
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(clerk-js,shared,ui): Add seats info to payment attempts page by aeliox · Pull Request #8527 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/billing-seat-tier-rows-payment-attempt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/ui': minor
---

Surface seat-based billing details on payment attempts. The payment attempt resource now exposes a `totals` field (`BillingPaymentTotals`) carrying optional `baseFee` and `perUnitTotals` breakdowns. The payment-attempt detail page renders a "Seats" line (`{quantity} × {feePerBlock}`, or the tier total for unlimited tiers) between the plan title and subtotal when the subscription item is seat-billed.
5 changes: 4 additions & 1 deletion packages/clerk-js/src/core/resources/BillingPayment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,11 @@ import type {
BillingPaymentMethodResource,
BillingPaymentResource,
BillingPaymentStatus,
BillingPaymentTotals,
BillingSubscriptionItemResource,
} from '@clerk/shared/types';

import { billingMoneyAmountFromJSON } from '../../utils';
import { billingMoneyAmountFromJSON, billingPaymentTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPaymentMethod, BillingSubscriptionItem } from './internal';

Expand All@@ -22,6 +23,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
subscriptionItem!: BillingSubscriptionItemResource;
chargeType!: BillingPaymentChargeType;
status!: BillingPaymentStatus;
totals: BillingPaymentTotals | null = null;

constructor(data: BillingPaymentJSON) {
super();
Expand All@@ -42,6 +44,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
this.subscriptionItem = new BillingSubscriptionItem(data.subscription_item);
this.chargeType = data.charge_type;
this.status = data.status;
this.totals = data.totals ? billingPaymentTotalsFromJSON(data.totals) : null;
return this;
}
}
70 changes: 70 additions & 0 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
amount_formatted: (amount / 100).toFixed(2),
currency: 'USD',
currency_symbol: '$',
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(4500),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(500),
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.subtotal.amount).toBe(4500);
expect(totals.grandTotal.amount).toBe(5000);
expect(totals.taxTotal.amount).toBe(500);
expect(totals.baseFee).toBeNull();
expect(totals.perUnitTotals).toBeUndefined();
});

it('maps base_fee when present', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
base_fee: moneyJSON(1000),
};

expect(billingPaymentTotalsFromJSON(data).baseFee?.amount).toBe(1000);
});

it('maps per_unit_totals tiers with snake_case → camelCase conversion', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [
{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) },
{ quantity: null, fee_per_block: moneyJSON(0), total: moneyJSON(0) },
],
},
],
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.perUnitTotals).toHaveLength(1);
expect(totals.perUnitTotals?.[0].name).toBe('seats');
expect(totals.perUnitTotals?.[0].blockSize).toBe(1);
expect(totals.perUnitTotals?.[0].tiers[0]).toMatchObject({
quantity: 5,
feePerBlock: { amount: 1000 },
total: { amount: 5000 },
});
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});
12 changes: 12 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import type {
BillingCreditsJSON,
BillingMoneyAmount,
BillingMoneyAmountJSON,
BillingPaymentTotals,
BillingPaymentTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingStatementTotals,
Expand DownExpand Up@@ -32,6 +34,16 @@ const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingP
}));
};

export const billingPaymentTotalsFromJSON = (data: BillingPaymentTotalsJSON): BillingPaymentTotals => {
return {
subtotal: billingMoneyAmountFromJSON(data.subtotal),
grandTotal: billingMoneyAmountFromJSON(data.grand_total),
taxTotal: billingMoneyAmountFromJSON(data.tax_total),
baseFee: data.base_fee ? billingMoneyAmountFromJSON(data.base_fee) : null,
perUnitTotals: data.per_unit_totals ? billingPerUnitTotalsFromJSON(data.per_unit_totals) : undefined,
};
};

export const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
return {
proration: data.proration
Expand Down
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,11 @@ export const enUS: LocalizationResource = {
},
reSubscribe: 'Resubscribe',
seats: 'Seats',
seatsWithLimit: 'Seats (up to {{limit}})',
seatBreakdownSingular: '1 seat at {{rate}}/mo',
seatBreakdownPlural: '{{chargeable}} seats at {{rate}}/mo',
seatBreakdownIncludedSingular: '1 seat at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seatBreakdownIncludedPlural: '{{chargeable}} seats at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seeAllFeatures: 'See all features',
startFreeTrial: 'Start free trial',
startFreeTrial__days: 'Start {{days}}-day free trial',
Expand Down
34 changes: 34 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -505,6 +505,35 @@ export type BillingPaymentChargeType = 'checkout' | 'recurring';
*/
export type BillingPaymentStatus = 'pending' | 'paid' | 'failed';

/**
* The `BillingPaymentTotals` type represents the per-payment cost breakdown, including any base fee
* and per-unit (for example, seats) subtotals.
*
* @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.
*/
export interface BillingPaymentTotals {
/**
* The price of the items before taxes, credits, or discounts are applied.
*/
subtotal: BillingMoneyAmount;
/**
* The total amount for the payment, including taxes and after credits/discounts are applied.
*/
grandTotal: BillingMoneyAmount;
/**
* The amount of tax included in the payment.
*/
taxTotal: BillingMoneyAmount;
/**
* The flat base fee charged on top of any per-unit fees.
*/
baseFee?: BillingMoneyAmount | null;
/**
* Per-unit cost breakdown for this payment (for example, seats).
*/
perUnitTotals?: BillingPerUnitTotal[];
}

/**
* The `BillingPaymentResource` type represents a payment attempt for a user or Organization.
*
Expand DownExpand Up@@ -547,6 +576,11 @@ export interface BillingPaymentResource extends ClerkResource {
* The current status of the payment.
*/
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals.
* Absent on older responses.
*/
totals?: BillingPaymentTotals | null;
}

/**
Expand Down
18 changes: 18 additions & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -740,6 +740,19 @@ export interface BillingStatementGroupJSON extends ClerkResourceJSON {
items: BillingPaymentJSON[];
}

/**
* @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.
*
* Per-payment cost breakdown including optional base fee and per-unit (for example, seats) subtotals.
*/
export interface BillingPaymentTotalsJSON {
Comment thread
aeliox marked this conversation as resolved.
subtotal: BillingMoneyAmountJSON;
grand_total: BillingMoneyAmountJSON;
tax_total: BillingMoneyAmountJSON;
base_fee?: BillingMoneyAmountJSON | null;
per_unit_totals?: BillingPerUnitTotalJSON[];
}

/**
* @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@@ -754,6 +767,11 @@ export interface BillingPaymentJSON extends ClerkResourceJSON {
subscription_item: BillingSubscriptionItemJSON;
charge_type: BillingPaymentChargeType;
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats)
* subtotals. Absent on older responses.
*/
totals?: BillingPaymentTotalsJSON | null;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,6 +191,11 @@ export type __internal_LocalizationResource = {
keepSubscription: LocalizationValue;
reSubscribe: LocalizationValue;
seats: LocalizationValue;
seatsWithLimit: LocalizationValue<'limit'>;
seatBreakdownSingular: LocalizationValue<'rate'>;
seatBreakdownPlural: LocalizationValue<'chargeable' | 'rate'>;
seatBreakdownIncludedSingular: LocalizationValue<'totalSeats' | 'included' | 'rate'>;
seatBreakdownIncludedPlural: LocalizationValue<'totalSeats' | 'included' | 'chargeable' | 'rate'>;
subscribe: LocalizationValue;
startFreeTrial: LocalizationValue;
startFreeTrial__days: LocalizationValue<'days'>;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
import { __internal_usePaymentAttemptQuery } from '@clerk/shared/react/index';
import type { BillingSubscriptionItemResource } from '@clerk/shared/types';
import type { BillingPaymentResource } from '@clerk/shared/types';

import { Alert } from '@/ui/elements/Alert';
import { Header } from '@/ui/elements/Header';
import { LineItems } from '@/ui/elements/LineItems';
import { getPlanSeatLimit, getSeatsPerUnitTotal, summarizeSeatCharges } from '@/ui/utils/billingPlanSeats';
import { formatDate } from '@/ui/utils/formatDate';
import { truncateWithEndVisible } from '@/ui/utils/truncateTextWithEndVisible';

Expand DownExpand Up@@ -42,8 +43,6 @@ export const PaymentAttemptPage = () => {
enabled: Boolean(params.paymentAttemptId),
});

const subscriptionItem = paymentAttempt?.subscriptionItem;

if (isLoading) {
return (
<Box sx={{ display: 'flex', justifyContent: 'center', alignItems: 'center', height: '100%' }}>
Expand DownExpand Up@@ -147,7 +146,7 @@ export const PaymentAttemptPage = () => {
{paymentAttempt.status}
</Badge>
</Box>
<PaymentAttemptBody subscriptionItem={subscriptionItem} />
<PaymentAttemptBody paymentAttempt={paymentAttempt} />
<Box
elementDescriptor={descriptors.paymentAttemptFooter}
as='footer'
Expand DownExpand Up@@ -198,18 +197,25 @@ export const PaymentAttemptPage = () => {
);
};

function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSubscriptionItemResource | undefined }) {
if (!subscriptionItem) {
function PaymentAttemptBody({ paymentAttempt }: { paymentAttempt: BillingPaymentResource | undefined }) {
if (!paymentAttempt) {
return null;
}

const { subscriptionItem } = paymentAttempt;

const fee =
subscriptionItem.planPeriod === 'month'
? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.fee!
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.annualMonthlyFee!;

const seatsTotal = subscriptionItem.seats != null ? getSeatsPerUnitTotal(paymentAttempt.totals) : undefined;
Comment thread
aeliox marked this conversation as resolved.
const seatSummary = summarizeSeatCharges(seatsTotal);
const seatsChargeable = seatSummary ? seatSummary.totalSeats - seatSummary.included : 0;
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);

return (
<Box
elementDescriptor={descriptors.paymentAttemptBody}
Expand All@@ -225,6 +231,42 @@ function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSub
text={`${fee.currencySymbol}${fee.amountFormatted}`}
/>
</LineItems.Group>
{seatSummary && (
<LineItems.Group>
<LineItems.Title
title={
planSeatLimit != null
? localizationKeys('billing.seatsWithLimit', { limit: planSeatLimit })
: localizationKeys('billing.seats')
}
description={(() => {
const rate = `${seatSummary.paidTier.feePerBlock.currencySymbol}${seatSummary.paidTier.feePerBlock.amountFormatted}`;
const isSingular = seatsChargeable === 1;
if (seatSummary.included > 0) {
return isSingular
? localizationKeys('billing.seatBreakdownIncludedSingular', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
rate,
})
: localizationKeys('billing.seatBreakdownIncludedPlural', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
chargeable: seatsChargeable,
rate,
});
}
return isSingular
? localizationKeys('billing.seatBreakdownSingular', { rate })
: localizationKeys('billing.seatBreakdownPlural', { chargeable: seatsChargeable, rate });
})()}
/>
<LineItems.Description
prefix={subscriptionItem.planPeriod === 'annual' ? 'x12' : undefined}
text={`${seatSummary.paidTier.total.currencySymbol}${seatSummary.paidTier.total.amountFormatted}`}
/>
</LineItems.Group>
Comment thread
aeliox marked this conversation as resolved.
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(clerk-js,shared,ui): Add seats info to payment attempts page by aeliox · Pull Request #8527 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/billing-seat-tier-rows-payment-attempt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/ui': minor
---

Surface seat-based billing details on payment attempts. The payment attempt resource now exposes a `totals` field (`BillingPaymentTotals`) carrying optional `baseFee` and `perUnitTotals` breakdowns. The payment-attempt detail page renders a "Seats" line (`{quantity} × {feePerBlock}`, or the tier total for unlimited tiers) between the plan title and subtotal when the subscription item is seat-billed.
5 changes: 4 additions & 1 deletion packages/clerk-js/src/core/resources/BillingPayment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,11 @@ import type {
BillingPaymentMethodResource,
BillingPaymentResource,
BillingPaymentStatus,
BillingPaymentTotals,
BillingSubscriptionItemResource,
} from '@clerk/shared/types';

import { billingMoneyAmountFromJSON } from '../../utils';
import { billingMoneyAmountFromJSON, billingPaymentTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPaymentMethod, BillingSubscriptionItem } from './internal';

Expand All@@ -22,6 +23,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
subscriptionItem!: BillingSubscriptionItemResource;
chargeType!: BillingPaymentChargeType;
status!: BillingPaymentStatus;
totals: BillingPaymentTotals | null = null;

constructor(data: BillingPaymentJSON) {
super();
Expand All@@ -42,6 +44,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
this.subscriptionItem = new BillingSubscriptionItem(data.subscription_item);
this.chargeType = data.charge_type;
this.status = data.status;
this.totals = data.totals ? billingPaymentTotalsFromJSON(data.totals) : null;
return this;
}
}
70 changes: 70 additions & 0 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
amount_formatted: (amount / 100).toFixed(2),
currency: 'USD',
currency_symbol: '$',
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(4500),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(500),
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.subtotal.amount).toBe(4500);
expect(totals.grandTotal.amount).toBe(5000);
expect(totals.taxTotal.amount).toBe(500);
expect(totals.baseFee).toBeNull();
expect(totals.perUnitTotals).toBeUndefined();
});

it('maps base_fee when present', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
base_fee: moneyJSON(1000),
};

expect(billingPaymentTotalsFromJSON(data).baseFee?.amount).toBe(1000);
});

it('maps per_unit_totals tiers with snake_case → camelCase conversion', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [
{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) },
{ quantity: null, fee_per_block: moneyJSON(0), total: moneyJSON(0) },
],
},
],
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.perUnitTotals).toHaveLength(1);
expect(totals.perUnitTotals?.[0].name).toBe('seats');
expect(totals.perUnitTotals?.[0].blockSize).toBe(1);
expect(totals.perUnitTotals?.[0].tiers[0]).toMatchObject({
quantity: 5,
feePerBlock: { amount: 1000 },
total: { amount: 5000 },
});
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});
12 changes: 12 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import type {
BillingCreditsJSON,
BillingMoneyAmount,
BillingMoneyAmountJSON,
BillingPaymentTotals,
BillingPaymentTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingStatementTotals,
Expand DownExpand Up@@ -32,6 +34,16 @@ const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingP
}));
};

export const billingPaymentTotalsFromJSON = (data: BillingPaymentTotalsJSON): BillingPaymentTotals => {
return {
subtotal: billingMoneyAmountFromJSON(data.subtotal),
grandTotal: billingMoneyAmountFromJSON(data.grand_total),
taxTotal: billingMoneyAmountFromJSON(data.tax_total),
baseFee: data.base_fee ? billingMoneyAmountFromJSON(data.base_fee) : null,
perUnitTotals: data.per_unit_totals ? billingPerUnitTotalsFromJSON(data.per_unit_totals) : undefined,
};
};

export const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
return {
proration: data.proration
Expand Down
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,11 @@ export const enUS: LocalizationResource = {
},
reSubscribe: 'Resubscribe',
seats: 'Seats',
seatsWithLimit: 'Seats (up to {{limit}})',
seatBreakdownSingular: '1 seat at {{rate}}/mo',
seatBreakdownPlural: '{{chargeable}} seats at {{rate}}/mo',
seatBreakdownIncludedSingular: '1 seat at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seatBreakdownIncludedPlural: '{{chargeable}} seats at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seeAllFeatures: 'See all features',
startFreeTrial: 'Start free trial',
startFreeTrial__days: 'Start {{days}}-day free trial',
Expand Down
34 changes: 34 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -505,6 +505,35 @@ export type BillingPaymentChargeType = 'checkout' | 'recurring';
*/
export type BillingPaymentStatus = 'pending' | 'paid' | 'failed';

/**
* The `BillingPaymentTotals` type represents the per-payment cost breakdown, including any base fee
* and per-unit (for example, seats) subtotals.
*
* @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.
*/
export interface BillingPaymentTotals {
/**
* The price of the items before taxes, credits, or discounts are applied.
*/
subtotal: BillingMoneyAmount;
/**
* The total amount for the payment, including taxes and after credits/discounts are applied.
*/
grandTotal: BillingMoneyAmount;
/**
* The amount of tax included in the payment.
*/
taxTotal: BillingMoneyAmount;
/**
* The flat base fee charged on top of any per-unit fees.
*/
baseFee?: BillingMoneyAmount | null;
/**
* Per-unit cost breakdown for this payment (for example, seats).
*/
perUnitTotals?: BillingPerUnitTotal[];
}

/**
* The `BillingPaymentResource` type represents a payment attempt for a user or Organization.
*
Expand DownExpand Up@@ -547,6 +576,11 @@ export interface BillingPaymentResource extends ClerkResource {
* The current status of the payment.
*/
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals.
* Absent on older responses.
*/
totals?: BillingPaymentTotals | null;
}

/**
Expand Down
18 changes: 18 additions & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -740,6 +740,19 @@ export interface BillingStatementGroupJSON extends ClerkResourceJSON {
items: BillingPaymentJSON[];
}

/**
* @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.
*
* Per-payment cost breakdown including optional base fee and per-unit (for example, seats) subtotals.
*/
export interface BillingPaymentTotalsJSON {
Comment thread
aeliox marked this conversation as resolved.
subtotal: BillingMoneyAmountJSON;
grand_total: BillingMoneyAmountJSON;
tax_total: BillingMoneyAmountJSON;
base_fee?: BillingMoneyAmountJSON | null;
per_unit_totals?: BillingPerUnitTotalJSON[];
}

/**
* @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@@ -754,6 +767,11 @@ export interface BillingPaymentJSON extends ClerkResourceJSON {
subscription_item: BillingSubscriptionItemJSON;
charge_type: BillingPaymentChargeType;
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats)
* subtotals. Absent on older responses.
*/
totals?: BillingPaymentTotalsJSON | null;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,6 +191,11 @@ export type __internal_LocalizationResource = {
keepSubscription: LocalizationValue;
reSubscribe: LocalizationValue;
seats: LocalizationValue;
seatsWithLimit: LocalizationValue<'limit'>;
seatBreakdownSingular: LocalizationValue<'rate'>;
seatBreakdownPlural: LocalizationValue<'chargeable' | 'rate'>;
seatBreakdownIncludedSingular: LocalizationValue<'totalSeats' | 'included' | 'rate'>;
seatBreakdownIncludedPlural: LocalizationValue<'totalSeats' | 'included' | 'chargeable' | 'rate'>;
subscribe: LocalizationValue;
startFreeTrial: LocalizationValue;
startFreeTrial__days: LocalizationValue<'days'>;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
import { __internal_usePaymentAttemptQuery } from '@clerk/shared/react/index';
import type { BillingSubscriptionItemResource } from '@clerk/shared/types';
import type { BillingPaymentResource } from '@clerk/shared/types';

import { Alert } from '@/ui/elements/Alert';
import { Header } from '@/ui/elements/Header';
import { LineItems } from '@/ui/elements/LineItems';
import { getPlanSeatLimit, getSeatsPerUnitTotal, summarizeSeatCharges } from '@/ui/utils/billingPlanSeats';
import { formatDate } from '@/ui/utils/formatDate';
import { truncateWithEndVisible } from '@/ui/utils/truncateTextWithEndVisible';

Expand DownExpand Up@@ -42,8 +43,6 @@ export const PaymentAttemptPage = () => {
enabled: Boolean(params.paymentAttemptId),
});

const subscriptionItem = paymentAttempt?.subscriptionItem;

if (isLoading) {
return (
<Box sx={{ display: 'flex', justifyContent: 'center', alignItems: 'center', height: '100%' }}>
Expand DownExpand Up@@ -147,7 +146,7 @@ export const PaymentAttemptPage = () => {
{paymentAttempt.status}
</Badge>
</Box>
<PaymentAttemptBody subscriptionItem={subscriptionItem} />
<PaymentAttemptBody paymentAttempt={paymentAttempt} />
<Box
elementDescriptor={descriptors.paymentAttemptFooter}
as='footer'
Expand DownExpand Up@@ -198,18 +197,25 @@ export const PaymentAttemptPage = () => {
);
};

function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSubscriptionItemResource | undefined }) {
if (!subscriptionItem) {
function PaymentAttemptBody({ paymentAttempt }: { paymentAttempt: BillingPaymentResource | undefined }) {
if (!paymentAttempt) {
return null;
}

const { subscriptionItem } = paymentAttempt;

const fee =
subscriptionItem.planPeriod === 'month'
? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.fee!
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.annualMonthlyFee!;

const seatsTotal = subscriptionItem.seats != null ? getSeatsPerUnitTotal(paymentAttempt.totals) : undefined;
Comment thread
aeliox marked this conversation as resolved.
const seatSummary = summarizeSeatCharges(seatsTotal);
const seatsChargeable = seatSummary ? seatSummary.totalSeats - seatSummary.included : 0;
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);

return (
<Box
elementDescriptor={descriptors.paymentAttemptBody}
Expand All@@ -225,6 +231,42 @@ function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSub
text={`${fee.currencySymbol}${fee.amountFormatted}`}
/>
</LineItems.Group>
{seatSummary && (
<LineItems.Group>
<LineItems.Title
title={
planSeatLimit != null
? localizationKeys('billing.seatsWithLimit', { limit: planSeatLimit })
: localizationKeys('billing.seats')
}
description={(() => {
const rate = `${seatSummary.paidTier.feePerBlock.currencySymbol}${seatSummary.paidTier.feePerBlock.amountFormatted}`;
const isSingular = seatsChargeable === 1;
if (seatSummary.included > 0) {
return isSingular
? localizationKeys('billing.seatBreakdownIncludedSingular', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
rate,
})
: localizationKeys('billing.seatBreakdownIncludedPlural', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
chargeable: seatsChargeable,
rate,
});
}
return isSingular
? localizationKeys('billing.seatBreakdownSingular', { rate })
: localizationKeys('billing.seatBreakdownPlural', { chargeable: seatsChargeable, rate });
})()}
/>
<LineItems.Description
prefix={subscriptionItem.planPeriod === 'annual' ? 'x12' : undefined}
text={`${seatSummary.paidTier.total.currencySymbol}${seatSummary.paidTier.total.amountFormatted}`}
/>
</LineItems.Group>
Comment thread
aeliox marked this conversation as resolved.
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(clerk-js,shared,ui): Add seats info to payment attempts page by aeliox · Pull Request #8527 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/billing-seat-tier-rows-payment-attempt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/ui': minor
---

Surface seat-based billing details on payment attempts. The payment attempt resource now exposes a `totals` field (`BillingPaymentTotals`) carrying optional `baseFee` and `perUnitTotals` breakdowns. The payment-attempt detail page renders a "Seats" line (`{quantity} × {feePerBlock}`, or the tier total for unlimited tiers) between the plan title and subtotal when the subscription item is seat-billed.
5 changes: 4 additions & 1 deletion packages/clerk-js/src/core/resources/BillingPayment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,11 @@ import type {
BillingPaymentMethodResource,
BillingPaymentResource,
BillingPaymentStatus,
BillingPaymentTotals,
BillingSubscriptionItemResource,
} from '@clerk/shared/types';

import { billingMoneyAmountFromJSON } from '../../utils';
import { billingMoneyAmountFromJSON, billingPaymentTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPaymentMethod, BillingSubscriptionItem } from './internal';

Expand All@@ -22,6 +23,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
subscriptionItem!: BillingSubscriptionItemResource;
chargeType!: BillingPaymentChargeType;
status!: BillingPaymentStatus;
totals: BillingPaymentTotals | null = null;

constructor(data: BillingPaymentJSON) {
super();
Expand All@@ -42,6 +44,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
this.subscriptionItem = new BillingSubscriptionItem(data.subscription_item);
this.chargeType = data.charge_type;
this.status = data.status;
this.totals = data.totals ? billingPaymentTotalsFromJSON(data.totals) : null;
return this;
}
}
70 changes: 70 additions & 0 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
amount_formatted: (amount / 100).toFixed(2),
currency: 'USD',
currency_symbol: '$',
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(4500),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(500),
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.subtotal.amount).toBe(4500);
expect(totals.grandTotal.amount).toBe(5000);
expect(totals.taxTotal.amount).toBe(500);
expect(totals.baseFee).toBeNull();
expect(totals.perUnitTotals).toBeUndefined();
});

it('maps base_fee when present', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
base_fee: moneyJSON(1000),
};

expect(billingPaymentTotalsFromJSON(data).baseFee?.amount).toBe(1000);
});

it('maps per_unit_totals tiers with snake_case → camelCase conversion', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [
{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) },
{ quantity: null, fee_per_block: moneyJSON(0), total: moneyJSON(0) },
],
},
],
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.perUnitTotals).toHaveLength(1);
expect(totals.perUnitTotals?.[0].name).toBe('seats');
expect(totals.perUnitTotals?.[0].blockSize).toBe(1);
expect(totals.perUnitTotals?.[0].tiers[0]).toMatchObject({
quantity: 5,
feePerBlock: { amount: 1000 },
total: { amount: 5000 },
});
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});
12 changes: 12 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import type {
BillingCreditsJSON,
BillingMoneyAmount,
BillingMoneyAmountJSON,
BillingPaymentTotals,
BillingPaymentTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingStatementTotals,
Expand DownExpand Up@@ -32,6 +34,16 @@ const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingP
}));
};

export const billingPaymentTotalsFromJSON = (data: BillingPaymentTotalsJSON): BillingPaymentTotals => {
return {
subtotal: billingMoneyAmountFromJSON(data.subtotal),
grandTotal: billingMoneyAmountFromJSON(data.grand_total),
taxTotal: billingMoneyAmountFromJSON(data.tax_total),
baseFee: data.base_fee ? billingMoneyAmountFromJSON(data.base_fee) : null,
perUnitTotals: data.per_unit_totals ? billingPerUnitTotalsFromJSON(data.per_unit_totals) : undefined,
};
};

export const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
return {
proration: data.proration
Expand Down
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,11 @@ export const enUS: LocalizationResource = {
},
reSubscribe: 'Resubscribe',
seats: 'Seats',
seatsWithLimit: 'Seats (up to {{limit}})',
seatBreakdownSingular: '1 seat at {{rate}}/mo',
seatBreakdownPlural: '{{chargeable}} seats at {{rate}}/mo',
seatBreakdownIncludedSingular: '1 seat at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seatBreakdownIncludedPlural: '{{chargeable}} seats at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seeAllFeatures: 'See all features',
startFreeTrial: 'Start free trial',
startFreeTrial__days: 'Start {{days}}-day free trial',
Expand Down
34 changes: 34 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -505,6 +505,35 @@ export type BillingPaymentChargeType = 'checkout' | 'recurring';
*/
export type BillingPaymentStatus = 'pending' | 'paid' | 'failed';

/**
* The `BillingPaymentTotals` type represents the per-payment cost breakdown, including any base fee
* and per-unit (for example, seats) subtotals.
*
* @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.
*/
export interface BillingPaymentTotals {
/**
* The price of the items before taxes, credits, or discounts are applied.
*/
subtotal: BillingMoneyAmount;
/**
* The total amount for the payment, including taxes and after credits/discounts are applied.
*/
grandTotal: BillingMoneyAmount;
/**
* The amount of tax included in the payment.
*/
taxTotal: BillingMoneyAmount;
/**
* The flat base fee charged on top of any per-unit fees.
*/
baseFee?: BillingMoneyAmount | null;
/**
* Per-unit cost breakdown for this payment (for example, seats).
*/
perUnitTotals?: BillingPerUnitTotal[];
}

/**
* The `BillingPaymentResource` type represents a payment attempt for a user or Organization.
*
Expand DownExpand Up@@ -547,6 +576,11 @@ export interface BillingPaymentResource extends ClerkResource {
* The current status of the payment.
*/
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals.
* Absent on older responses.
*/
totals?: BillingPaymentTotals | null;
}

/**
Expand Down
18 changes: 18 additions & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -740,6 +740,19 @@ export interface BillingStatementGroupJSON extends ClerkResourceJSON {
items: BillingPaymentJSON[];
}

/**
* @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.
*
* Per-payment cost breakdown including optional base fee and per-unit (for example, seats) subtotals.
*/
export interface BillingPaymentTotalsJSON {
Comment thread
aeliox marked this conversation as resolved.
subtotal: BillingMoneyAmountJSON;
grand_total: BillingMoneyAmountJSON;
tax_total: BillingMoneyAmountJSON;
base_fee?: BillingMoneyAmountJSON | null;
per_unit_totals?: BillingPerUnitTotalJSON[];
}

/**
* @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@@ -754,6 +767,11 @@ export interface BillingPaymentJSON extends ClerkResourceJSON {
subscription_item: BillingSubscriptionItemJSON;
charge_type: BillingPaymentChargeType;
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats)
* subtotals. Absent on older responses.
*/
totals?: BillingPaymentTotalsJSON | null;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,6 +191,11 @@ export type __internal_LocalizationResource = {
keepSubscription: LocalizationValue;
reSubscribe: LocalizationValue;
seats: LocalizationValue;
seatsWithLimit: LocalizationValue<'limit'>;
seatBreakdownSingular: LocalizationValue<'rate'>;
seatBreakdownPlural: LocalizationValue<'chargeable' | 'rate'>;
seatBreakdownIncludedSingular: LocalizationValue<'totalSeats' | 'included' | 'rate'>;
seatBreakdownIncludedPlural: LocalizationValue<'totalSeats' | 'included' | 'chargeable' | 'rate'>;
subscribe: LocalizationValue;
startFreeTrial: LocalizationValue;
startFreeTrial__days: LocalizationValue<'days'>;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
import { __internal_usePaymentAttemptQuery } from '@clerk/shared/react/index';
import type { BillingSubscriptionItemResource } from '@clerk/shared/types';
import type { BillingPaymentResource } from '@clerk/shared/types';

import { Alert } from '@/ui/elements/Alert';
import { Header } from '@/ui/elements/Header';
import { LineItems } from '@/ui/elements/LineItems';
import { getPlanSeatLimit, getSeatsPerUnitTotal, summarizeSeatCharges } from '@/ui/utils/billingPlanSeats';
import { formatDate } from '@/ui/utils/formatDate';
import { truncateWithEndVisible } from '@/ui/utils/truncateTextWithEndVisible';

Expand DownExpand Up@@ -42,8 +43,6 @@ export const PaymentAttemptPage = () => {
enabled: Boolean(params.paymentAttemptId),
});

const subscriptionItem = paymentAttempt?.subscriptionItem;

if (isLoading) {
return (
<Box sx={{ display: 'flex', justifyContent: 'center', alignItems: 'center', height: '100%' }}>
Expand DownExpand Up@@ -147,7 +146,7 @@ export const PaymentAttemptPage = () => {
{paymentAttempt.status}
</Badge>
</Box>
<PaymentAttemptBody subscriptionItem={subscriptionItem} />
<PaymentAttemptBody paymentAttempt={paymentAttempt} />
<Box
elementDescriptor={descriptors.paymentAttemptFooter}
as='footer'
Expand DownExpand Up@@ -198,18 +197,25 @@ export const PaymentAttemptPage = () => {
);
};

function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSubscriptionItemResource | undefined }) {
if (!subscriptionItem) {
function PaymentAttemptBody({ paymentAttempt }: { paymentAttempt: BillingPaymentResource | undefined }) {
if (!paymentAttempt) {
return null;
}

const { subscriptionItem } = paymentAttempt;

const fee =
subscriptionItem.planPeriod === 'month'
? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.fee!
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.annualMonthlyFee!;

const seatsTotal = subscriptionItem.seats != null ? getSeatsPerUnitTotal(paymentAttempt.totals) : undefined;
Comment thread
aeliox marked this conversation as resolved.
const seatSummary = summarizeSeatCharges(seatsTotal);
const seatsChargeable = seatSummary ? seatSummary.totalSeats - seatSummary.included : 0;
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);

return (
<Box
elementDescriptor={descriptors.paymentAttemptBody}
Expand All@@ -225,6 +231,42 @@ function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSub
text={`${fee.currencySymbol}${fee.amountFormatted}`}
/>
</LineItems.Group>
{seatSummary && (
<LineItems.Group>
<LineItems.Title
title={
planSeatLimit != null
? localizationKeys('billing.seatsWithLimit', { limit: planSeatLimit })
: localizationKeys('billing.seats')
}
description={(() => {
const rate = `${seatSummary.paidTier.feePerBlock.currencySymbol}${seatSummary.paidTier.feePerBlock.amountFormatted}`;
const isSingular = seatsChargeable === 1;
if (seatSummary.included > 0) {
return isSingular
? localizationKeys('billing.seatBreakdownIncludedSingular', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
rate,
})
: localizationKeys('billing.seatBreakdownIncludedPlural', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
chargeable: seatsChargeable,
rate,
});
}
return isSingular
? localizationKeys('billing.seatBreakdownSingular', { rate })
: localizationKeys('billing.seatBreakdownPlural', { chargeable: seatsChargeable, rate });
})()}
/>
<LineItems.Description
prefix={subscriptionItem.planPeriod === 'annual' ? 'x12' : undefined}
text={`${seatSummary.paidTier.total.currencySymbol}${seatSummary.paidTier.total.amountFormatted}`}
/>
</LineItems.Group>
Comment thread
aeliox marked this conversation as resolved.
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat(clerk-js,shared,ui): Add seats info to payment attempts page by aeliox · Pull Request #8527 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/billing-seat-tier-rows-payment-attempt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/ui': minor
---

Surface seat-based billing details on payment attempts. The payment attempt resource now exposes a `totals` field (`BillingPaymentTotals`) carrying optional `baseFee` and `perUnitTotals` breakdowns. The payment-attempt detail page renders a "Seats" line (`{quantity} × {feePerBlock}`, or the tier total for unlimited tiers) between the plan title and subtotal when the subscription item is seat-billed.
5 changes: 4 additions & 1 deletion packages/clerk-js/src/core/resources/BillingPayment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,11 @@ import type {
BillingPaymentMethodResource,
BillingPaymentResource,
BillingPaymentStatus,
BillingPaymentTotals,
BillingSubscriptionItemResource,
} from '@clerk/shared/types';

import { billingMoneyAmountFromJSON } from '../../utils';
import { billingMoneyAmountFromJSON, billingPaymentTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPaymentMethod, BillingSubscriptionItem } from './internal';

Expand All@@ -22,6 +23,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
subscriptionItem!: BillingSubscriptionItemResource;
chargeType!: BillingPaymentChargeType;
status!: BillingPaymentStatus;
totals: BillingPaymentTotals | null = null;

constructor(data: BillingPaymentJSON) {
super();
Expand All@@ -42,6 +44,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
this.subscriptionItem = new BillingSubscriptionItem(data.subscription_item);
this.chargeType = data.charge_type;
this.status = data.status;
this.totals = data.totals ? billingPaymentTotalsFromJSON(data.totals) : null;
return this;
}
}
70 changes: 70 additions & 0 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
amount_formatted: (amount / 100).toFixed(2),
currency: 'USD',
currency_symbol: '$',
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(4500),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(500),
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.subtotal.amount).toBe(4500);
expect(totals.grandTotal.amount).toBe(5000);
expect(totals.taxTotal.amount).toBe(500);
expect(totals.baseFee).toBeNull();
expect(totals.perUnitTotals).toBeUndefined();
});

it('maps base_fee when present', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
base_fee: moneyJSON(1000),
};

expect(billingPaymentTotalsFromJSON(data).baseFee?.amount).toBe(1000);
});

it('maps per_unit_totals tiers with snake_case → camelCase conversion', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [
{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) },
{ quantity: null, fee_per_block: moneyJSON(0), total: moneyJSON(0) },
],
},
],
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.perUnitTotals).toHaveLength(1);
expect(totals.perUnitTotals?.[0].name).toBe('seats');
expect(totals.perUnitTotals?.[0].blockSize).toBe(1);
expect(totals.perUnitTotals?.[0].tiers[0]).toMatchObject({
quantity: 5,
feePerBlock: { amount: 1000 },
total: { amount: 5000 },
});
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});
12 changes: 12 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import type {
BillingCreditsJSON,
BillingMoneyAmount,
BillingMoneyAmountJSON,
BillingPaymentTotals,
BillingPaymentTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingStatementTotals,
Expand DownExpand Up@@ -32,6 +34,16 @@ const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingP
}));
};

export const billingPaymentTotalsFromJSON = (data: BillingPaymentTotalsJSON): BillingPaymentTotals => {
return {
subtotal: billingMoneyAmountFromJSON(data.subtotal),
grandTotal: billingMoneyAmountFromJSON(data.grand_total),
taxTotal: billingMoneyAmountFromJSON(data.tax_total),
baseFee: data.base_fee ? billingMoneyAmountFromJSON(data.base_fee) : null,
perUnitTotals: data.per_unit_totals ? billingPerUnitTotalsFromJSON(data.per_unit_totals) : undefined,
};
};

export const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
return {
proration: data.proration
Expand Down
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,11 @@ export const enUS: LocalizationResource = {
},
reSubscribe: 'Resubscribe',
seats: 'Seats',
seatsWithLimit: 'Seats (up to {{limit}})',
seatBreakdownSingular: '1 seat at {{rate}}/mo',
seatBreakdownPlural: '{{chargeable}} seats at {{rate}}/mo',
seatBreakdownIncludedSingular: '1 seat at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seatBreakdownIncludedPlural: '{{chargeable}} seats at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seeAllFeatures: 'See all features',
startFreeTrial: 'Start free trial',
startFreeTrial__days: 'Start {{days}}-day free trial',
Expand Down
34 changes: 34 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -505,6 +505,35 @@ export type BillingPaymentChargeType = 'checkout' | 'recurring';
*/
export type BillingPaymentStatus = 'pending' | 'paid' | 'failed';

/**
* The `BillingPaymentTotals` type represents the per-payment cost breakdown, including any base fee
* and per-unit (for example, seats) subtotals.
*
* @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.
*/
export interface BillingPaymentTotals {
/**
* The price of the items before taxes, credits, or discounts are applied.
*/
subtotal: BillingMoneyAmount;
/**
* The total amount for the payment, including taxes and after credits/discounts are applied.
*/
grandTotal: BillingMoneyAmount;
/**
* The amount of tax included in the payment.
*/
taxTotal: BillingMoneyAmount;
/**
* The flat base fee charged on top of any per-unit fees.
*/
baseFee?: BillingMoneyAmount | null;
/**
* Per-unit cost breakdown for this payment (for example, seats).
*/
perUnitTotals?: BillingPerUnitTotal[];
}

/**
* The `BillingPaymentResource` type represents a payment attempt for a user or Organization.
*
Expand DownExpand Up@@ -547,6 +576,11 @@ export interface BillingPaymentResource extends ClerkResource {
* The current status of the payment.
*/
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals.
* Absent on older responses.
*/
totals?: BillingPaymentTotals | null;
}

/**
Expand Down
18 changes: 18 additions & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -740,6 +740,19 @@ export interface BillingStatementGroupJSON extends ClerkResourceJSON {
items: BillingPaymentJSON[];
}

/**
* @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.
*
* Per-payment cost breakdown including optional base fee and per-unit (for example, seats) subtotals.
*/
export interface BillingPaymentTotalsJSON {
Comment thread
aeliox marked this conversation as resolved.
subtotal: BillingMoneyAmountJSON;
grand_total: BillingMoneyAmountJSON;
tax_total: BillingMoneyAmountJSON;
base_fee?: BillingMoneyAmountJSON | null;
per_unit_totals?: BillingPerUnitTotalJSON[];
}

/**
* @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@@ -754,6 +767,11 @@ export interface BillingPaymentJSON extends ClerkResourceJSON {
subscription_item: BillingSubscriptionItemJSON;
charge_type: BillingPaymentChargeType;
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats)
* subtotals. Absent on older responses.
*/
totals?: BillingPaymentTotalsJSON | null;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,6 +191,11 @@ export type __internal_LocalizationResource = {
keepSubscription: LocalizationValue;
reSubscribe: LocalizationValue;
seats: LocalizationValue;
seatsWithLimit: LocalizationValue<'limit'>;
seatBreakdownSingular: LocalizationValue<'rate'>;
seatBreakdownPlural: LocalizationValue<'chargeable' | 'rate'>;
seatBreakdownIncludedSingular: LocalizationValue<'totalSeats' | 'included' | 'rate'>;
seatBreakdownIncludedPlural: LocalizationValue<'totalSeats' | 'included' | 'chargeable' | 'rate'>;
subscribe: LocalizationValue;
startFreeTrial: LocalizationValue;
startFreeTrial__days: LocalizationValue<'days'>;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
import { __internal_usePaymentAttemptQuery } from '@clerk/shared/react/index';
import type { BillingSubscriptionItemResource } from '@clerk/shared/types';
import type { BillingPaymentResource } from '@clerk/shared/types';

import { Alert } from '@/ui/elements/Alert';
import { Header } from '@/ui/elements/Header';
import { LineItems } from '@/ui/elements/LineItems';
import { getPlanSeatLimit, getSeatsPerUnitTotal, summarizeSeatCharges } from '@/ui/utils/billingPlanSeats';
import { formatDate } from '@/ui/utils/formatDate';
import { truncateWithEndVisible } from '@/ui/utils/truncateTextWithEndVisible';

Expand DownExpand Up@@ -42,8 +43,6 @@ export const PaymentAttemptPage = () => {
enabled: Boolean(params.paymentAttemptId),
});

const subscriptionItem = paymentAttempt?.subscriptionItem;

if (isLoading) {
return (
<Box sx={{ display: 'flex', justifyContent: 'center', alignItems: 'center', height: '100%' }}>
Expand DownExpand Up@@ -147,7 +146,7 @@ export const PaymentAttemptPage = () => {
{paymentAttempt.status}
</Badge>
</Box>
<PaymentAttemptBody subscriptionItem={subscriptionItem} />
<PaymentAttemptBody paymentAttempt={paymentAttempt} />
<Box
elementDescriptor={descriptors.paymentAttemptFooter}
as='footer'
Expand DownExpand Up@@ -198,18 +197,25 @@ export const PaymentAttemptPage = () => {
);
};

function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSubscriptionItemResource | undefined }) {
if (!subscriptionItem) {
function PaymentAttemptBody({ paymentAttempt }: { paymentAttempt: BillingPaymentResource | undefined }) {
if (!paymentAttempt) {
return null;
}

const { subscriptionItem } = paymentAttempt;

const fee =
subscriptionItem.planPeriod === 'month'
? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.fee!
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.annualMonthlyFee!;

const seatsTotal = subscriptionItem.seats != null ? getSeatsPerUnitTotal(paymentAttempt.totals) : undefined;
Comment thread
aeliox marked this conversation as resolved.
const seatSummary = summarizeSeatCharges(seatsTotal);
const seatsChargeable = seatSummary ? seatSummary.totalSeats - seatSummary.included : 0;
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);

return (
<Box
elementDescriptor={descriptors.paymentAttemptBody}
Expand All@@ -225,6 +231,42 @@ function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSub
text={`${fee.currencySymbol}${fee.amountFormatted}`}
/>
</LineItems.Group>
{seatSummary && (
<LineItems.Group>
<LineItems.Title
title={
planSeatLimit != null
? localizationKeys('billing.seatsWithLimit', { limit: planSeatLimit })
: localizationKeys('billing.seats')
}
description={(() => {
const rate = `${seatSummary.paidTier.feePerBlock.currencySymbol}${seatSummary.paidTier.feePerBlock.amountFormatted}`;
const isSingular = seatsChargeable === 1;
if (seatSummary.included > 0) {
return isSingular
? localizationKeys('billing.seatBreakdownIncludedSingular', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
rate,
})
: localizationKeys('billing.seatBreakdownIncludedPlural', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
chargeable: seatsChargeable,
rate,
});
}
return isSingular
? localizationKeys('billing.seatBreakdownSingular', { rate })
: localizationKeys('billing.seatBreakdownPlural', { chargeable: seatsChargeable, rate });
})()}
/>
<LineItems.Description
prefix={subscriptionItem.planPeriod === 'annual' ? 'x12' : undefined}
text={`${seatSummary.paidTier.total.currencySymbol}${seatSummary.paidTier.total.amountFormatted}`}
/>
</LineItems.Group>
Comment thread
aeliox marked this conversation as resolved.
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(clerk-js,shared,ui): Add seats info to payment attempts page by aeliox · Pull Request #8527 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/billing-seat-tier-rows-payment-attempt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/ui': minor
---

Surface seat-based billing details on payment attempts. The payment attempt resource now exposes a `totals` field (`BillingPaymentTotals`) carrying optional `baseFee` and `perUnitTotals` breakdowns. The payment-attempt detail page renders a "Seats" line (`{quantity} × {feePerBlock}`, or the tier total for unlimited tiers) between the plan title and subtotal when the subscription item is seat-billed.
5 changes: 4 additions & 1 deletion packages/clerk-js/src/core/resources/BillingPayment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,11 @@ import type {
BillingPaymentMethodResource,
BillingPaymentResource,
BillingPaymentStatus,
BillingPaymentTotals,
BillingSubscriptionItemResource,
} from '@clerk/shared/types';

import { billingMoneyAmountFromJSON } from '../../utils';
import { billingMoneyAmountFromJSON, billingPaymentTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPaymentMethod, BillingSubscriptionItem } from './internal';

Expand All@@ -22,6 +23,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
subscriptionItem!: BillingSubscriptionItemResource;
chargeType!: BillingPaymentChargeType;
status!: BillingPaymentStatus;
totals: BillingPaymentTotals | null = null;

constructor(data: BillingPaymentJSON) {
super();
Expand All@@ -42,6 +44,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
this.subscriptionItem = new BillingSubscriptionItem(data.subscription_item);
this.chargeType = data.charge_type;
this.status = data.status;
this.totals = data.totals ? billingPaymentTotalsFromJSON(data.totals) : null;
return this;
}
}
70 changes: 70 additions & 0 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
amount_formatted: (amount / 100).toFixed(2),
currency: 'USD',
currency_symbol: '$',
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(4500),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(500),
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.subtotal.amount).toBe(4500);
expect(totals.grandTotal.amount).toBe(5000);
expect(totals.taxTotal.amount).toBe(500);
expect(totals.baseFee).toBeNull();
expect(totals.perUnitTotals).toBeUndefined();
});

it('maps base_fee when present', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
base_fee: moneyJSON(1000),
};

expect(billingPaymentTotalsFromJSON(data).baseFee?.amount).toBe(1000);
});

it('maps per_unit_totals tiers with snake_case → camelCase conversion', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [
{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) },
{ quantity: null, fee_per_block: moneyJSON(0), total: moneyJSON(0) },
],
},
],
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.perUnitTotals).toHaveLength(1);
expect(totals.perUnitTotals?.[0].name).toBe('seats');
expect(totals.perUnitTotals?.[0].blockSize).toBe(1);
expect(totals.perUnitTotals?.[0].tiers[0]).toMatchObject({
quantity: 5,
feePerBlock: { amount: 1000 },
total: { amount: 5000 },
});
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});
12 changes: 12 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import type {
BillingCreditsJSON,
BillingMoneyAmount,
BillingMoneyAmountJSON,
BillingPaymentTotals,
BillingPaymentTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingStatementTotals,
Expand DownExpand Up@@ -32,6 +34,16 @@ const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingP
}));
};

export const billingPaymentTotalsFromJSON = (data: BillingPaymentTotalsJSON): BillingPaymentTotals => {
return {
subtotal: billingMoneyAmountFromJSON(data.subtotal),
grandTotal: billingMoneyAmountFromJSON(data.grand_total),
taxTotal: billingMoneyAmountFromJSON(data.tax_total),
baseFee: data.base_fee ? billingMoneyAmountFromJSON(data.base_fee) : null,
perUnitTotals: data.per_unit_totals ? billingPerUnitTotalsFromJSON(data.per_unit_totals) : undefined,
};
};

export const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
return {
proration: data.proration
Expand Down
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,11 @@ export const enUS: LocalizationResource = {
},
reSubscribe: 'Resubscribe',
seats: 'Seats',
seatsWithLimit: 'Seats (up to {{limit}})',
seatBreakdownSingular: '1 seat at {{rate}}/mo',
seatBreakdownPlural: '{{chargeable}} seats at {{rate}}/mo',
seatBreakdownIncludedSingular: '1 seat at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seatBreakdownIncludedPlural: '{{chargeable}} seats at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seeAllFeatures: 'See all features',
startFreeTrial: 'Start free trial',
startFreeTrial__days: 'Start {{days}}-day free trial',
Expand Down
34 changes: 34 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -505,6 +505,35 @@ export type BillingPaymentChargeType = 'checkout' | 'recurring';
*/
export type BillingPaymentStatus = 'pending' | 'paid' | 'failed';

/**
* The `BillingPaymentTotals` type represents the per-payment cost breakdown, including any base fee
* and per-unit (for example, seats) subtotals.
*
* @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.
*/
export interface BillingPaymentTotals {
/**
* The price of the items before taxes, credits, or discounts are applied.
*/
subtotal: BillingMoneyAmount;
/**
* The total amount for the payment, including taxes and after credits/discounts are applied.
*/
grandTotal: BillingMoneyAmount;
/**
* The amount of tax included in the payment.
*/
taxTotal: BillingMoneyAmount;
/**
* The flat base fee charged on top of any per-unit fees.
*/
baseFee?: BillingMoneyAmount | null;
/**
* Per-unit cost breakdown for this payment (for example, seats).
*/
perUnitTotals?: BillingPerUnitTotal[];
}

/**
* The `BillingPaymentResource` type represents a payment attempt for a user or Organization.
*
Expand DownExpand Up@@ -547,6 +576,11 @@ export interface BillingPaymentResource extends ClerkResource {
* The current status of the payment.
*/
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals.
* Absent on older responses.
*/
totals?: BillingPaymentTotals | null;
}

/**
Expand Down
18 changes: 18 additions & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -740,6 +740,19 @@ export interface BillingStatementGroupJSON extends ClerkResourceJSON {
items: BillingPaymentJSON[];
}

/**
* @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.
*
* Per-payment cost breakdown including optional base fee and per-unit (for example, seats) subtotals.
*/
export interface BillingPaymentTotalsJSON {
Comment thread
aeliox marked this conversation as resolved.
subtotal: BillingMoneyAmountJSON;
grand_total: BillingMoneyAmountJSON;
tax_total: BillingMoneyAmountJSON;
base_fee?: BillingMoneyAmountJSON | null;
per_unit_totals?: BillingPerUnitTotalJSON[];
}

/**
* @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@@ -754,6 +767,11 @@ export interface BillingPaymentJSON extends ClerkResourceJSON {
subscription_item: BillingSubscriptionItemJSON;
charge_type: BillingPaymentChargeType;
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats)
* subtotals. Absent on older responses.
*/
totals?: BillingPaymentTotalsJSON | null;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,6 +191,11 @@ export type __internal_LocalizationResource = {
keepSubscription: LocalizationValue;
reSubscribe: LocalizationValue;
seats: LocalizationValue;
seatsWithLimit: LocalizationValue<'limit'>;
seatBreakdownSingular: LocalizationValue<'rate'>;
seatBreakdownPlural: LocalizationValue<'chargeable' | 'rate'>;
seatBreakdownIncludedSingular: LocalizationValue<'totalSeats' | 'included' | 'rate'>;
seatBreakdownIncludedPlural: LocalizationValue<'totalSeats' | 'included' | 'chargeable' | 'rate'>;
subscribe: LocalizationValue;
startFreeTrial: LocalizationValue;
startFreeTrial__days: LocalizationValue<'days'>;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
import { __internal_usePaymentAttemptQuery } from '@clerk/shared/react/index';
import type { BillingSubscriptionItemResource } from '@clerk/shared/types';
import type { BillingPaymentResource } from '@clerk/shared/types';

import { Alert } from '@/ui/elements/Alert';
import { Header } from '@/ui/elements/Header';
import { LineItems } from '@/ui/elements/LineItems';
import { getPlanSeatLimit, getSeatsPerUnitTotal, summarizeSeatCharges } from '@/ui/utils/billingPlanSeats';
import { formatDate } from '@/ui/utils/formatDate';
import { truncateWithEndVisible } from '@/ui/utils/truncateTextWithEndVisible';

Expand DownExpand Up@@ -42,8 +43,6 @@ export const PaymentAttemptPage = () => {
enabled: Boolean(params.paymentAttemptId),
});

const subscriptionItem = paymentAttempt?.subscriptionItem;

if (isLoading) {
return (
<Box sx={{ display: 'flex', justifyContent: 'center', alignItems: 'center', height: '100%' }}>
Expand DownExpand Up@@ -147,7 +146,7 @@ export const PaymentAttemptPage = () => {
{paymentAttempt.status}
</Badge>
</Box>
<PaymentAttemptBody subscriptionItem={subscriptionItem} />
<PaymentAttemptBody paymentAttempt={paymentAttempt} />
<Box
elementDescriptor={descriptors.paymentAttemptFooter}
as='footer'
Expand DownExpand Up@@ -198,18 +197,25 @@ export const PaymentAttemptPage = () => {
);
};

function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSubscriptionItemResource | undefined }) {
if (!subscriptionItem) {
function PaymentAttemptBody({ paymentAttempt }: { paymentAttempt: BillingPaymentResource | undefined }) {
if (!paymentAttempt) {
return null;
}

const { subscriptionItem } = paymentAttempt;

const fee =
subscriptionItem.planPeriod === 'month'
? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.fee!
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.annualMonthlyFee!;

const seatsTotal = subscriptionItem.seats != null ? getSeatsPerUnitTotal(paymentAttempt.totals) : undefined;
Comment thread
aeliox marked this conversation as resolved.
const seatSummary = summarizeSeatCharges(seatsTotal);
const seatsChargeable = seatSummary ? seatSummary.totalSeats - seatSummary.included : 0;
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);

return (
<Box
elementDescriptor={descriptors.paymentAttemptBody}
Expand All@@ -225,6 +231,42 @@ function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSub
text={`${fee.currencySymbol}${fee.amountFormatted}`}
/>
</LineItems.Group>
{seatSummary && (
<LineItems.Group>
<LineItems.Title
title={
planSeatLimit != null
? localizationKeys('billing.seatsWithLimit', { limit: planSeatLimit })
: localizationKeys('billing.seats')
}
description={(() => {
const rate = `${seatSummary.paidTier.feePerBlock.currencySymbol}${seatSummary.paidTier.feePerBlock.amountFormatted}`;
const isSingular = seatsChargeable === 1;
if (seatSummary.included > 0) {
return isSingular
? localizationKeys('billing.seatBreakdownIncludedSingular', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
rate,
})
: localizationKeys('billing.seatBreakdownIncludedPlural', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
chargeable: seatsChargeable,
rate,
});
}
return isSingular
? localizationKeys('billing.seatBreakdownSingular', { rate })
: localizationKeys('billing.seatBreakdownPlural', { chargeable: seatsChargeable, rate });
})()}
/>
<LineItems.Description
prefix={subscriptionItem.planPeriod === 'annual' ? 'x12' : undefined}
text={`${seatSummary.paidTier.total.currencySymbol}${seatSummary.paidTier.total.amountFormatted}`}
/>
</LineItems.Group>
Comment thread
aeliox marked this conversation as resolved.
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(clerk-js,shared,ui): Add seats info to payment attempts page by aeliox · Pull Request #8527 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/billing-seat-tier-rows-payment-attempt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/ui': minor
---

Surface seat-based billing details on payment attempts. The payment attempt resource now exposes a `totals` field (`BillingPaymentTotals`) carrying optional `baseFee` and `perUnitTotals` breakdowns. The payment-attempt detail page renders a "Seats" line (`{quantity} × {feePerBlock}`, or the tier total for unlimited tiers) between the plan title and subtotal when the subscription item is seat-billed.
5 changes: 4 additions & 1 deletion packages/clerk-js/src/core/resources/BillingPayment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,11 @@ import type {
BillingPaymentMethodResource,
BillingPaymentResource,
BillingPaymentStatus,
BillingPaymentTotals,
BillingSubscriptionItemResource,
} from '@clerk/shared/types';

import { billingMoneyAmountFromJSON } from '../../utils';
import { billingMoneyAmountFromJSON, billingPaymentTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPaymentMethod, BillingSubscriptionItem } from './internal';

Expand All@@ -22,6 +23,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
subscriptionItem!: BillingSubscriptionItemResource;
chargeType!: BillingPaymentChargeType;
status!: BillingPaymentStatus;
totals: BillingPaymentTotals | null = null;

constructor(data: BillingPaymentJSON) {
super();
Expand All@@ -42,6 +44,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
this.subscriptionItem = new BillingSubscriptionItem(data.subscription_item);
this.chargeType = data.charge_type;
this.status = data.status;
this.totals = data.totals ? billingPaymentTotalsFromJSON(data.totals) : null;
return this;
}
}
70 changes: 70 additions & 0 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
amount_formatted: (amount / 100).toFixed(2),
currency: 'USD',
currency_symbol: '$',
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(4500),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(500),
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.subtotal.amount).toBe(4500);
expect(totals.grandTotal.amount).toBe(5000);
expect(totals.taxTotal.amount).toBe(500);
expect(totals.baseFee).toBeNull();
expect(totals.perUnitTotals).toBeUndefined();
});

it('maps base_fee when present', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
base_fee: moneyJSON(1000),
};

expect(billingPaymentTotalsFromJSON(data).baseFee?.amount).toBe(1000);
});

it('maps per_unit_totals tiers with snake_case → camelCase conversion', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [
{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) },
{ quantity: null, fee_per_block: moneyJSON(0), total: moneyJSON(0) },
],
},
],
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.perUnitTotals).toHaveLength(1);
expect(totals.perUnitTotals?.[0].name).toBe('seats');
expect(totals.perUnitTotals?.[0].blockSize).toBe(1);
expect(totals.perUnitTotals?.[0].tiers[0]).toMatchObject({
quantity: 5,
feePerBlock: { amount: 1000 },
total: { amount: 5000 },
});
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});
12 changes: 12 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import type {
BillingCreditsJSON,
BillingMoneyAmount,
BillingMoneyAmountJSON,
BillingPaymentTotals,
BillingPaymentTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingStatementTotals,
Expand DownExpand Up@@ -32,6 +34,16 @@ const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingP
}));
};

export const billingPaymentTotalsFromJSON = (data: BillingPaymentTotalsJSON): BillingPaymentTotals => {
return {
subtotal: billingMoneyAmountFromJSON(data.subtotal),
grandTotal: billingMoneyAmountFromJSON(data.grand_total),
taxTotal: billingMoneyAmountFromJSON(data.tax_total),
baseFee: data.base_fee ? billingMoneyAmountFromJSON(data.base_fee) : null,
perUnitTotals: data.per_unit_totals ? billingPerUnitTotalsFromJSON(data.per_unit_totals) : undefined,
};
};

export const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
return {
proration: data.proration
Expand Down
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,11 @@ export const enUS: LocalizationResource = {
},
reSubscribe: 'Resubscribe',
seats: 'Seats',
seatsWithLimit: 'Seats (up to {{limit}})',
seatBreakdownSingular: '1 seat at {{rate}}/mo',
seatBreakdownPlural: '{{chargeable}} seats at {{rate}}/mo',
seatBreakdownIncludedSingular: '1 seat at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seatBreakdownIncludedPlural: '{{chargeable}} seats at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seeAllFeatures: 'See all features',
startFreeTrial: 'Start free trial',
startFreeTrial__days: 'Start {{days}}-day free trial',
Expand Down
34 changes: 34 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -505,6 +505,35 @@ export type BillingPaymentChargeType = 'checkout' | 'recurring';
*/
export type BillingPaymentStatus = 'pending' | 'paid' | 'failed';

/**
* The `BillingPaymentTotals` type represents the per-payment cost breakdown, including any base fee
* and per-unit (for example, seats) subtotals.
*
* @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.
*/
export interface BillingPaymentTotals {
/**
* The price of the items before taxes, credits, or discounts are applied.
*/
subtotal: BillingMoneyAmount;
/**
* The total amount for the payment, including taxes and after credits/discounts are applied.
*/
grandTotal: BillingMoneyAmount;
/**
* The amount of tax included in the payment.
*/
taxTotal: BillingMoneyAmount;
/**
* The flat base fee charged on top of any per-unit fees.
*/
baseFee?: BillingMoneyAmount | null;
/**
* Per-unit cost breakdown for this payment (for example, seats).
*/
perUnitTotals?: BillingPerUnitTotal[];
}

/**
* The `BillingPaymentResource` type represents a payment attempt for a user or Organization.
*
Expand DownExpand Up@@ -547,6 +576,11 @@ export interface BillingPaymentResource extends ClerkResource {
* The current status of the payment.
*/
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals.
* Absent on older responses.
*/
totals?: BillingPaymentTotals | null;
}

/**
Expand Down
18 changes: 18 additions & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -740,6 +740,19 @@ export interface BillingStatementGroupJSON extends ClerkResourceJSON {
items: BillingPaymentJSON[];
}

/**
* @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.
*
* Per-payment cost breakdown including optional base fee and per-unit (for example, seats) subtotals.
*/
export interface BillingPaymentTotalsJSON {
Comment thread
aeliox marked this conversation as resolved.
subtotal: BillingMoneyAmountJSON;
grand_total: BillingMoneyAmountJSON;
tax_total: BillingMoneyAmountJSON;
base_fee?: BillingMoneyAmountJSON | null;
per_unit_totals?: BillingPerUnitTotalJSON[];
}

/**
* @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@@ -754,6 +767,11 @@ export interface BillingPaymentJSON extends ClerkResourceJSON {
subscription_item: BillingSubscriptionItemJSON;
charge_type: BillingPaymentChargeType;
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats)
* subtotals. Absent on older responses.
*/
totals?: BillingPaymentTotalsJSON | null;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,6 +191,11 @@ export type __internal_LocalizationResource = {
keepSubscription: LocalizationValue;
reSubscribe: LocalizationValue;
seats: LocalizationValue;
seatsWithLimit: LocalizationValue<'limit'>;
seatBreakdownSingular: LocalizationValue<'rate'>;
seatBreakdownPlural: LocalizationValue<'chargeable' | 'rate'>;
seatBreakdownIncludedSingular: LocalizationValue<'totalSeats' | 'included' | 'rate'>;
seatBreakdownIncludedPlural: LocalizationValue<'totalSeats' | 'included' | 'chargeable' | 'rate'>;
subscribe: LocalizationValue;
startFreeTrial: LocalizationValue;
startFreeTrial__days: LocalizationValue<'days'>;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
import { __internal_usePaymentAttemptQuery } from '@clerk/shared/react/index';
import type { BillingSubscriptionItemResource } from '@clerk/shared/types';
import type { BillingPaymentResource } from '@clerk/shared/types';

import { Alert } from '@/ui/elements/Alert';
import { Header } from '@/ui/elements/Header';
import { LineItems } from '@/ui/elements/LineItems';
import { getPlanSeatLimit, getSeatsPerUnitTotal, summarizeSeatCharges } from '@/ui/utils/billingPlanSeats';
import { formatDate } from '@/ui/utils/formatDate';
import { truncateWithEndVisible } from '@/ui/utils/truncateTextWithEndVisible';

Expand DownExpand Up@@ -42,8 +43,6 @@ export const PaymentAttemptPage = () => {
enabled: Boolean(params.paymentAttemptId),
});

const subscriptionItem = paymentAttempt?.subscriptionItem;

if (isLoading) {
return (
<Box sx={{ display: 'flex', justifyContent: 'center', alignItems: 'center', height: '100%' }}>
Expand DownExpand Up@@ -147,7 +146,7 @@ export const PaymentAttemptPage = () => {
{paymentAttempt.status}
</Badge>
</Box>
<PaymentAttemptBody subscriptionItem={subscriptionItem} />
<PaymentAttemptBody paymentAttempt={paymentAttempt} />
<Box
elementDescriptor={descriptors.paymentAttemptFooter}
as='footer'
Expand DownExpand Up@@ -198,18 +197,25 @@ export const PaymentAttemptPage = () => {
);
};

function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSubscriptionItemResource | undefined }) {
if (!subscriptionItem) {
function PaymentAttemptBody({ paymentAttempt }: { paymentAttempt: BillingPaymentResource | undefined }) {
if (!paymentAttempt) {
return null;
}

const { subscriptionItem } = paymentAttempt;

const fee =
subscriptionItem.planPeriod === 'month'
? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.fee!
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.annualMonthlyFee!;

const seatsTotal = subscriptionItem.seats != null ? getSeatsPerUnitTotal(paymentAttempt.totals) : undefined;
Comment thread
aeliox marked this conversation as resolved.
const seatSummary = summarizeSeatCharges(seatsTotal);
const seatsChargeable = seatSummary ? seatSummary.totalSeats - seatSummary.included : 0;
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);

return (
<Box
elementDescriptor={descriptors.paymentAttemptBody}
Expand All@@ -225,6 +231,42 @@ function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSub
text={`${fee.currencySymbol}${fee.amountFormatted}`}
/>
</LineItems.Group>
{seatSummary && (
<LineItems.Group>
<LineItems.Title
title={
planSeatLimit != null
? localizationKeys('billing.seatsWithLimit', { limit: planSeatLimit })
: localizationKeys('billing.seats')
}
description={(() => {
const rate = `${seatSummary.paidTier.feePerBlock.currencySymbol}${seatSummary.paidTier.feePerBlock.amountFormatted}`;
const isSingular = seatsChargeable === 1;
if (seatSummary.included > 0) {
return isSingular
? localizationKeys('billing.seatBreakdownIncludedSingular', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
rate,
})
: localizationKeys('billing.seatBreakdownIncludedPlural', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
chargeable: seatsChargeable,
rate,
});
}
return isSingular
? localizationKeys('billing.seatBreakdownSingular', { rate })
: localizationKeys('billing.seatBreakdownPlural', { chargeable: seatsChargeable, rate });
})()}
/>
<LineItems.Description
prefix={subscriptionItem.planPeriod === 'annual' ? 'x12' : undefined}
text={`${seatSummary.paidTier.total.currencySymbol}${seatSummary.paidTier.total.amountFormatted}`}
/>
</LineItems.Group>
Comment thread
aeliox marked this conversation as resolved.
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat(clerk-js,shared,ui): Add seats info to payment attempts page by aeliox · Pull Request #8527 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/billing-seat-tier-rows-payment-attempt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/ui': minor
---

Surface seat-based billing details on payment attempts. The payment attempt resource now exposes a `totals` field (`BillingPaymentTotals`) carrying optional `baseFee` and `perUnitTotals` breakdowns. The payment-attempt detail page renders a "Seats" line (`{quantity} × {feePerBlock}`, or the tier total for unlimited tiers) between the plan title and subtotal when the subscription item is seat-billed.
5 changes: 4 additions & 1 deletion packages/clerk-js/src/core/resources/BillingPayment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,11 @@ import type {
BillingPaymentMethodResource,
BillingPaymentResource,
BillingPaymentStatus,
BillingPaymentTotals,
BillingSubscriptionItemResource,
} from '@clerk/shared/types';

import { billingMoneyAmountFromJSON } from '../../utils';
import { billingMoneyAmountFromJSON, billingPaymentTotalsFromJSON } from '../../utils';
import { unixEpochToDate } from '../../utils/date';
import { BaseResource, BillingPaymentMethod, BillingSubscriptionItem } from './internal';

Expand All@@ -22,6 +23,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
subscriptionItem!: BillingSubscriptionItemResource;
chargeType!: BillingPaymentChargeType;
status!: BillingPaymentStatus;
totals: BillingPaymentTotals | null = null;

constructor(data: BillingPaymentJSON) {
super();
Expand All@@ -42,6 +44,7 @@ export class BillingPayment extends BaseResource implements BillingPaymentResour
this.subscriptionItem = new BillingSubscriptionItem(data.subscription_item);
this.chargeType = data.charge_type;
this.status = data.status;
this.totals = data.totals ? billingPaymentTotalsFromJSON(data.totals) : null;
return this;
}
}
70 changes: 70 additions & 0 deletions packages/clerk-js/src/utils/__tests__/billing.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
import type { BillingMoneyAmountJSON, BillingPaymentTotalsJSON } from '@clerk/shared/types';
import { describe, expect, it } from 'vitest';

import { billingPaymentTotalsFromJSON } from '../billing';

const moneyJSON = (amount: number): BillingMoneyAmountJSON => ({
amount,
amount_formatted: (amount / 100).toFixed(2),
currency: 'USD',
currency_symbol: '$',
});

describe('billingPaymentTotalsFromJSON', () => {
it('maps subtotal, grand_total, and tax_total', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(4500),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(500),
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.subtotal.amount).toBe(4500);
expect(totals.grandTotal.amount).toBe(5000);
expect(totals.taxTotal.amount).toBe(500);
expect(totals.baseFee).toBeNull();
expect(totals.perUnitTotals).toBeUndefined();
});

it('maps base_fee when present', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
base_fee: moneyJSON(1000),
};

expect(billingPaymentTotalsFromJSON(data).baseFee?.amount).toBe(1000);
});

it('maps per_unit_totals tiers with snake_case → camelCase conversion', () => {
const data: BillingPaymentTotalsJSON = {
subtotal: moneyJSON(5000),
grand_total: moneyJSON(5000),
tax_total: moneyJSON(0),
per_unit_totals: [
{
name: 'seats',
block_size: 1,
tiers: [
{ quantity: 5, fee_per_block: moneyJSON(1000), total: moneyJSON(5000) },
{ quantity: null, fee_per_block: moneyJSON(0), total: moneyJSON(0) },
],
},
],
};

const totals = billingPaymentTotalsFromJSON(data);

expect(totals.perUnitTotals).toHaveLength(1);
expect(totals.perUnitTotals?.[0].name).toBe('seats');
expect(totals.perUnitTotals?.[0].blockSize).toBe(1);
expect(totals.perUnitTotals?.[0].tiers[0]).toMatchObject({
quantity: 5,
feePerBlock: { amount: 1000 },
total: { amount: 5000 },
});
expect(totals.perUnitTotals?.[0].tiers[1].quantity).toBeNull();
});
});
12 changes: 12 additions & 0 deletions packages/clerk-js/src/utils/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import type {
BillingCreditsJSON,
BillingMoneyAmount,
BillingMoneyAmountJSON,
BillingPaymentTotals,
BillingPaymentTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingStatementTotals,
Expand DownExpand Up@@ -32,6 +34,16 @@ const billingPerUnitTotalsFromJSON = (data: BillingPerUnitTotalJSON[]): BillingP
}));
};

export const billingPaymentTotalsFromJSON = (data: BillingPaymentTotalsJSON): BillingPaymentTotals => {
return {
subtotal: billingMoneyAmountFromJSON(data.subtotal),
grandTotal: billingMoneyAmountFromJSON(data.grand_total),
taxTotal: billingMoneyAmountFromJSON(data.tax_total),
baseFee: data.base_fee ? billingMoneyAmountFromJSON(data.base_fee) : null,
perUnitTotals: data.per_unit_totals ? billingPerUnitTotalsFromJSON(data.per_unit_totals) : undefined,
};
};

export const billingCreditsFromJSON = (data: BillingCreditsJSON): BillingCredits => {
return {
proration: data.proration
Expand Down
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,11 @@ export const enUS: LocalizationResource = {
},
reSubscribe: 'Resubscribe',
seats: 'Seats',
seatsWithLimit: 'Seats (up to {{limit}})',
seatBreakdownSingular: '1 seat at {{rate}}/mo',
seatBreakdownPlural: '{{chargeable}} seats at {{rate}}/mo',
seatBreakdownIncludedSingular: '1 seat at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seatBreakdownIncludedPlural: '{{chargeable}} seats at {{rate}}/mo ({{totalSeats}} total - {{included}} included)',
seeAllFeatures: 'See all features',
startFreeTrial: 'Start free trial',
startFreeTrial__days: 'Start {{days}}-day free trial',
Expand Down
34 changes: 34 additions & 0 deletions packages/shared/src/types/billing.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -505,6 +505,35 @@ export type BillingPaymentChargeType = 'checkout' | 'recurring';
*/
export type BillingPaymentStatus = 'pending' | 'paid' | 'failed';

/**
* The `BillingPaymentTotals` type represents the per-payment cost breakdown, including any base fee
* and per-unit (for example, seats) subtotals.
*
* @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.
*/
export interface BillingPaymentTotals {
/**
* The price of the items before taxes, credits, or discounts are applied.
*/
subtotal: BillingMoneyAmount;
/**
* The total amount for the payment, including taxes and after credits/discounts are applied.
*/
grandTotal: BillingMoneyAmount;
/**
* The amount of tax included in the payment.
*/
taxTotal: BillingMoneyAmount;
/**
* The flat base fee charged on top of any per-unit fees.
*/
baseFee?: BillingMoneyAmount | null;
/**
* Per-unit cost breakdown for this payment (for example, seats).
*/
perUnitTotals?: BillingPerUnitTotal[];
}

/**
* The `BillingPaymentResource` type represents a payment attempt for a user or Organization.
*
Expand DownExpand Up@@ -547,6 +576,11 @@ export interface BillingPaymentResource extends ClerkResource {
* The current status of the payment.
*/
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals.
* Absent on older responses.
*/
totals?: BillingPaymentTotals | null;
}

/**
Expand Down
18 changes: 18 additions & 0 deletions packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -740,6 +740,19 @@ export interface BillingStatementGroupJSON extends ClerkResourceJSON {
items: BillingPaymentJSON[];
}

/**
* @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.
*
* Per-payment cost breakdown including optional base fee and per-unit (for example, seats) subtotals.
*/
export interface BillingPaymentTotalsJSON {
Comment thread
aeliox marked this conversation as resolved.
subtotal: BillingMoneyAmountJSON;
grand_total: BillingMoneyAmountJSON;
tax_total: BillingMoneyAmountJSON;
base_fee?: BillingMoneyAmountJSON | null;
per_unit_totals?: BillingPerUnitTotalJSON[];
}

/**
* @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@@ -754,6 +767,11 @@ export interface BillingPaymentJSON extends ClerkResourceJSON {
subscription_item: BillingSubscriptionItemJSON;
charge_type: BillingPaymentChargeType;
status: BillingPaymentStatus;
/**
* Per-payment breakdown with optional base fee and per-unit (for example, seats)
* subtotals. Absent on older responses.
*/
totals?: BillingPaymentTotalsJSON | null;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,6 +191,11 @@ export type __internal_LocalizationResource = {
keepSubscription: LocalizationValue;
reSubscribe: LocalizationValue;
seats: LocalizationValue;
seatsWithLimit: LocalizationValue<'limit'>;
seatBreakdownSingular: LocalizationValue<'rate'>;
seatBreakdownPlural: LocalizationValue<'chargeable' | 'rate'>;
seatBreakdownIncludedSingular: LocalizationValue<'totalSeats' | 'included' | 'rate'>;
seatBreakdownIncludedPlural: LocalizationValue<'totalSeats' | 'included' | 'chargeable' | 'rate'>;
subscribe: LocalizationValue;
startFreeTrial: LocalizationValue;
startFreeTrial__days: LocalizationValue<'days'>;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
import { __internal_usePaymentAttemptQuery } from '@clerk/shared/react/index';
import type { BillingSubscriptionItemResource } from '@clerk/shared/types';
import type { BillingPaymentResource } from '@clerk/shared/types';

import { Alert } from '@/ui/elements/Alert';
import { Header } from '@/ui/elements/Header';
import { LineItems } from '@/ui/elements/LineItems';
import { getPlanSeatLimit, getSeatsPerUnitTotal, summarizeSeatCharges } from '@/ui/utils/billingPlanSeats';
import { formatDate } from '@/ui/utils/formatDate';
import { truncateWithEndVisible } from '@/ui/utils/truncateTextWithEndVisible';

Expand DownExpand Up@@ -42,8 +43,6 @@ export const PaymentAttemptPage = () => {
enabled: Boolean(params.paymentAttemptId),
});

const subscriptionItem = paymentAttempt?.subscriptionItem;

if (isLoading) {
return (
<Box sx={{ display: 'flex', justifyContent: 'center', alignItems: 'center', height: '100%' }}>
Expand DownExpand Up@@ -147,7 +146,7 @@ export const PaymentAttemptPage = () => {
{paymentAttempt.status}
</Badge>
</Box>
<PaymentAttemptBody subscriptionItem={subscriptionItem} />
<PaymentAttemptBody paymentAttempt={paymentAttempt} />
<Box
elementDescriptor={descriptors.paymentAttemptFooter}
as='footer'
Expand DownExpand Up@@ -198,18 +197,25 @@ export const PaymentAttemptPage = () => {
);
};

function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSubscriptionItemResource | undefined }) {
if (!subscriptionItem) {
function PaymentAttemptBody({ paymentAttempt }: { paymentAttempt: BillingPaymentResource | undefined }) {
if (!paymentAttempt) {
return null;
}

const { subscriptionItem } = paymentAttempt;

const fee =
subscriptionItem.planPeriod === 'month'
? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.fee!
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
subscriptionItem.plan.annualMonthlyFee!;

const seatsTotal = subscriptionItem.seats != null ? getSeatsPerUnitTotal(paymentAttempt.totals) : undefined;
Comment thread
aeliox marked this conversation as resolved.
const seatSummary = summarizeSeatCharges(seatsTotal);
const seatsChargeable = seatSummary ? seatSummary.totalSeats - seatSummary.included : 0;
const planSeatLimit = getPlanSeatLimit(subscriptionItem.plan);

return (
<Box
elementDescriptor={descriptors.paymentAttemptBody}
Expand All@@ -225,6 +231,42 @@ function PaymentAttemptBody({ subscriptionItem }: { subscriptionItem: BillingSub
text={`${fee.currencySymbol}${fee.amountFormatted}`}
/>
</LineItems.Group>
{seatSummary && (
<LineItems.Group>
<LineItems.Title
title={
planSeatLimit != null
? localizationKeys('billing.seatsWithLimit', { limit: planSeatLimit })
: localizationKeys('billing.seats')
}
description={(() => {
const rate = `${seatSummary.paidTier.feePerBlock.currencySymbol}${seatSummary.paidTier.feePerBlock.amountFormatted}`;
const isSingular = seatsChargeable === 1;
if (seatSummary.included > 0) {
return isSingular
? localizationKeys('billing.seatBreakdownIncludedSingular', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
rate,
})
: localizationKeys('billing.seatBreakdownIncludedPlural', {
totalSeats: seatSummary.totalSeats,
included: seatSummary.included,
chargeable: seatsChargeable,
rate,
});
}
return isSingular
? localizationKeys('billing.seatBreakdownSingular', { rate })
: localizationKeys('billing.seatBreakdownPlural', { chargeable: seatsChargeable, rate });
})()}
/>
<LineItems.Description
prefix={subscriptionItem.planPeriod === 'annual' ? 'x12' : undefined}
text={`${seatSummary.paidTier.total.currencySymbol}${seatSummary.paidTier.total.amountFormatted}`}
/>
</LineItems.Group>
Comment thread
aeliox marked this conversation as resolved.
)}
<LineItems.Group
borderTop
variant='tertiary'
Expand Down
Loading
Loading