fix(backend): Update Subscription and SubscriptionItem resources#9196

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
dstaley merged 2 commits into from
Jul 30, 2026
Merged

fix(backend): Update Subscription and SubscriptionItem resources #9196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cbd099
fix(backend): Update Subscription and SubscriptionItem resources
dstaley Jul 17, 2026
d40a9c3
lint: sort imports
dstaley Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tame-bats-tell.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

Update fields for BillingSubscription and BillingSubscriptionItem
Comment on lines +2 to +5

@coderabbitaicoderabbitaiBotJul 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bashset -euo pipefail
cat packages/backend/package.json
rg -n -C 3 '\b(BillingSubscription|BillingSubscriptionItem)\b' packages/backend/src

Repository: clerk/javascript

Length of output: 24693

🏁 Script executed:

#!/bin/bashset -euo pipefail
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscription.ts
printf'\n---\n'
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscriptionItem.ts
printf'\n---\n'
sed -n '140,190p' packages/backend/src/index.ts
printf'\n---\n'
sed -n '1,80p' .changeset/tame-bats-tell.md

Repository: clerk/javascript

Length of output: 10343

Require a major changeset for the Billing API surfaceBillingSubscription and BillingSubscriptionItem are exported from @clerk/backend, so the constructor shape and nextPayment.amount type change are breaking API changes. Update this changeset to major and add migration guidance.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/tame-bats-tell.md around lines 2 - 5, Update the changeset entry
for `@clerk/backend` from minor to major to reflect the breaking
BillingSubscription and BillingSubscriptionItem API changes, and add migration
guidance covering the constructor shape and nextPayment.amount type updates.

Source: Coding guidelines

21 changes: 14 additions & 7 deletions packages/backend/src/api/resources/CommerceSubscription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { BillingMoneyAmount } from '@clerk/shared/types';
import type { BillingMoneyAmount, BillingPerUnitTotal, BillingTotals } from '@clerk/shared/types';

import { billingMoneyAmountFromJSON, billingPerUnitTotalsFromJSON, billingTotalsFromJSON } from '../../util/billing';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

Expand All@@ -12,6 +13,8 @@ export class BillingSubscription {
constructor(
/** The unique identifier for the Subscription. */
readonly id: string,
/** The ID of the instance this Subscription belongs to. */
readonly instanceId: string,
/** The current status of the Subscription. */
readonly status: BillingSubscriptionJSON['status'],
/** The ID of the payer for this Subscription. */
Expand All@@ -32,6 +35,10 @@ export class BillingSubscription {
date: number;
/** The amount of the next payment. */
amount: BillingMoneyAmount;
/** The per-unit cost breakdown for the next payment. */
perUnitTotals?: BillingPerUnitTotal[];
/** The full cost breakdown for the next payment. */
totals?: BillingTotals;
} | null,
/** Whether the payer is eligible for a free trial. */
readonly eligibleForFreeTrial: boolean,
Expand All@@ -41,17 +48,17 @@ export class BillingSubscription {
const nextPayment = data.next_payment
? {
date: data.next_payment.date,
amount: {
amount: data.next_payment.amount.amount,
amountFormatted: data.next_payment.amount.amount_formatted,
currency: data.next_payment.amount.currency,
currencySymbol: data.next_payment.amount.currency_symbol,
},
amount: billingMoneyAmountFromJSON(data.next_payment.amount),
perUnitTotals: data.next_payment.per_unit_totals
? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
: undefined,
totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
}
: null;

return new BillingSubscription(
data.id,
data.instance_id,
data.status,
data.payer_id,
data.created_at,
Expand Down
60 changes: 40 additions & 20 deletions packages/backend/src/api/resources/CommerceSubscriptionItem.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/shared/types';
import type {
BillingMoneyAmount,
BillingPerUnitTotal,
BillingSubscriptionItemSeats,
BillingTotals,
} from '@clerk/shared/types';

import {
billingMoneyAmountFromJSON,
billingPerUnitTotalsFromJSON,
billingSubscriptionItemSeatsFromJSON,
billingTotalsFromJSON,
} from '../../util/billing';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

Expand All@@ -12,6 +23,8 @@ export class BillingSubscriptionItem {
constructor(
/** The unique identifier for the Subscription Item. */
readonly id: string,
/** The ID of the instance this Subscription Item belongs to. */
readonly instanceId: string,
/** The status of the Subscription Item. */
readonly status: BillingSubscriptionItemJSON['status'],
/** The period of the Plan associated with this Subscription Item. */
Expand All@@ -22,9 +35,13 @@ export class BillingSubscriptionItem {
readonly nextPayment:
| {
/** The amount of the next payment. */
amount: number;
amount: BillingMoneyAmount;
/** The Unix timestamp (milliseconds) of when the next payment is scheduled. */
date: number;
/** The per-unit cost breakdown for the next payment. */
perUnitTotals?: BillingPerUnitTotal[];
/** The full cost breakdown for the next payment. */
totals?: BillingTotals;
}
| null
| undefined,
Expand All@@ -34,6 +51,8 @@ export class BillingSubscriptionItem {
readonly plan: BillingPlan | null,
/** The ID of the Plan associated with this Subscription Item. */
readonly planId: string | null,
/** The ID of the price associated with this Subscription Item. */
readonly priceId: string | null,
/** The Unix timestamp (milliseconds) of when the Subscription Item was created. */
readonly createdAt: number,
/** The Unix timestamp (milliseconds) of when the Subscription Item was last updated. */
Expand All@@ -49,36 +68,36 @@ export class BillingSubscriptionItem {
/** The ID of the payer for this Subscription Item. */
readonly payerId: string | undefined,
/** Whether this Subscription Item is currently in a free trial period. */
readonly isFreeTrial?: boolean,
readonly isFreeTrial: boolean,
/** The lifetime amount paid for this Subscription Item. */
readonly lifetimePaid?: BillingMoneyAmount,
/** Seat entitlement details for organization subscription items with seat-based billing. */
readonly seats?: BillingSubscriptionItemSeats,
) {}

static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
function formatAmountJSON(
amount: BillingMoneyAmountJSON | null | undefined,
): BillingMoneyAmount | null | undefined {
if (!amount) {
return amount;
}

return {
amount: amount.amount,
amountFormatted: amount.amount_formatted,
currency: amount.currency,
currencySymbol: amount.currency_symbol,
};
}
const nextPayment = data.next_payment
? {
amount: billingMoneyAmountFromJSON(data.next_payment.amount),
date: data.next_payment.date,
perUnitTotals: data.next_payment.per_unit_totals
? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
: undefined,
totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
}
: data.next_payment;

return new BillingSubscriptionItem(
data.id,
data.instance_id,
data.status,
data.plan_period,
data.period_start,
data.next_payment,
formatAmountJSON(data.amount) ?? undefined,
nextPayment,
data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined,
data.plan ? BillingPlan.fromJSON(data.plan) : null,
data.plan_id ?? null,
data.price_id ?? null,
data.created_at,
data.updated_at,
data.period_end,
Expand All@@ -87,7 +106,8 @@ export class BillingSubscriptionItem {
data.ended_at,
data.payer_id,
data.is_free_trial,
formatAmountJSON(data.lifetime_paid) ?? undefined,
data.lifetime_paid ? billingMoneyAmountFromJSON(data.lifetime_paid) : undefined,
data.seats ? billingSubscriptionItemSeatsFromJSON(data.seats) : undefined,
);
}
}
27 changes: 19 additions & 8 deletions packages/backend/src/api/resources/JSON.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import type { LastAuthenticationStrategy, SignUpStatus, VerificationStatus } from '@clerk/shared/types';
import type {
BillingPerUnitTotalJSON,
BillingSubscriptionItemNextPaymentJSON,
BillingSubscriptionItemSeatsJSON,
BillingTotalsJSON as SharedBillingTotalsJSON,
LastAuthenticationStrategy,
SignUpStatus,
VerificationStatus,
} from '@clerk/shared/types';

import type {
ActorTokenStatus,
Expand DownExpand Up@@ -1006,25 +1014,25 @@ type BillingSubscriptionItemStatus =
*/
export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
object: typeof ObjectType.BillingSubscriptionItem;
instance_id: string;
status: BillingSubscriptionItemStatus;
plan_period: 'month' | 'annual';
payer_id?: string;
price_id?: string;
period_start: number;
period_end: number | null;
is_free_trial?: boolean;
is_free_trial: boolean;
ended_at: number | null;
created_at: number;
updated_at: number;
canceled_at: number | null;
past_due_at: number | null;
lifetime_paid: BillingMoneyAmountJSON | null;
next_payment?: {
amount: number;
date: number;
} | null;
amount: BillingMoneyAmountJSON;
lifetime_paid?: BillingMoneyAmountJSON | null;
next_payment?: BillingSubscriptionItemNextPaymentJSON | null;
amount?: BillingMoneyAmountJSON | null;
plan?: BillingPlanJSON | null;
plan_id?: string | null;
seats?: BillingSubscriptionItemSeatsJSON;
}

/**
Expand DownExpand Up@@ -1127,6 +1135,7 @@ export interface BillingSubscriptionWebhookEventJSON extends ClerkResourceJSON {

export interface BillingSubscriptionJSON extends ClerkResourceJSON {
object: typeof ObjectType.BillingSubscription;
instance_id: string;
status: 'active' | 'past_due' | 'canceled' | 'ended' | 'abandoned' | 'incomplete';
payer_id: string;
created_at: number;
Expand All@@ -1137,6 +1146,8 @@ export interface BillingSubscriptionJSON extends ClerkResourceJSON {
next_payment?: {
date: number;
amount: BillingMoneyAmountJSON;
per_unit_totals?: BillingPerUnitTotalJSON[];
totals?: SharedBillingTotalsJSON;
};
eligible_for_free_trial?: boolean;
}
Expand Down
105 changes: 105 additions & 0 deletions packages/backend/src/util/billing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type {
BillingCredits,
BillingCreditsJSON,
BillingDiscounts,
BillingDiscountsJSON,
BillingMoneyAmount,
BillingMoneyAmountJSON,
BillingPeriodTotals,
BillingPeriodTotalsJSON,
BillingPerUnitTotal,
BillingPerUnitTotalJSON,
BillingSubscriptionItemSeats,
BillingSubscriptionItemSeatsJSON,
BillingTotals,
BillingTotalsJSON,
} from '@clerk/shared/types';

export const billingMoneyAmountFromJSON = (amount: BillingMoneyAmountJSON): BillingMoneyAmount => ({
amount: amount.amount,
amountFormatted: amount.amount_formatted,
currency: amount.currency,
currencySymbol: amount.currency_symbol,
});

export const billingPerUnitTotalsFromJSON = (perUnitTotals: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] =>
perUnitTotals.map(perUnitTotal => ({
name: perUnitTotal.name,
blockSize: perUnitTotal.block_size,
tiers: perUnitTotal.tiers.map(tier => ({
quantity: tier.quantity,
feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
total: billingMoneyAmountFromJSON(tier.total),
})),
}));

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

const billingDiscountsFromJSON = (discounts: BillingDiscountsJSON): BillingDiscounts => ({
proration: discounts.proration
? {
amount: billingMoneyAmountFromJSON(discounts.proration.amount),
cycleDaysPassed: discounts.proration.cycle_days_passed,
cycleDaysTotal: discounts.proration.cycle_days_total,
cyclePassedPercent: discounts.proration.cycle_passed_percent,
}
: null,
total: billingMoneyAmountFromJSON(discounts.total),
});

const billingPeriodTotalsFromJSON = (totals: BillingPeriodTotalsJSON): BillingPeriodTotals => ({
subtotal: billingMoneyAmountFromJSON(totals.subtotal),
baseFee: billingMoneyAmountFromJSON(totals.base_fee),
taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
});

export const billingTotalsFromJSON = (totals: BillingTotalsJSON): BillingTotals => ({
subtotal: billingMoneyAmountFromJSON(totals.subtotal),
baseFee: totals.base_fee ? billingMoneyAmountFromJSON(totals.base_fee) : null,
taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
totalDueAfterFreeTrial: totals.total_due_after_free_trial
? billingMoneyAmountFromJSON(totals.total_due_after_free_trial)
: totals.total_due_after_free_trial,
credit: totals.credit ? billingMoneyAmountFromJSON(totals.credit) : totals.credit,
credits: totals.credits ? billingCreditsFromJSON(totals.credits) : null,
discounts: totals.discounts ? billingDiscountsFromJSON(totals.discounts) : null,
pastDue: totals.past_due ? billingMoneyAmountFromJSON(totals.past_due) : totals.past_due,
totalDueNow: totals.total_due_now ? billingMoneyAmountFromJSON(totals.total_due_now) : undefined,
perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
totalsDuePerPeriod: totals.totals_due_per_period
? billingPeriodTotalsFromJSON(totals.totals_due_per_period)
: undefined,
totalDuePerPeriod: totals.total_due_per_period ? billingMoneyAmountFromJSON(totals.total_due_per_period) : undefined,
});

export const billingSubscriptionItemSeatsFromJSON = (
seats: BillingSubscriptionItemSeatsJSON,
): BillingSubscriptionItemSeats => ({
quantity: seats.quantity,
tiers: seats.tiers
? seats.tiers.map(tier => ({
quantity: tier.quantity,
feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
total: billingMoneyAmountFromJSON(tier.total),
}))
: undefined,
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(backend): Update Subscription and SubscriptionItem resources#9196

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 2 commits into

from

Jul 30, 2026
 Merged


fix(backend): Update Subscription and SubscriptionItem resources
#9196
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1cbd099

fix(backend): Update Subscription and SubscriptionItem resources


dstaley Jul 17, 2026
d40a9c3

lint: sort imports


dstaley Jul 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/tame-bats-tell.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

Update fields for BillingSubscription and BillingSubscriptionItem

Comment on lines

+2
 to 
+5

@coderabbitaicoderabbitaiBotJul 17, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bashset -euo pipefail
cat packages/backend/package.json
rg -n -C 3 '\b(BillingSubscription|BillingSubscriptionItem)\b' packages/backend/src
Repository: clerk/javascript
Length of output: 24693
🏁 Script executed:
#!/bin/bashset -euo pipefail
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscription.ts
printf'\n---\n'
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscriptionItem.ts
printf'\n---\n'
sed -n '140,190p' packages/backend/src/index.ts
printf'\n---\n'
sed -n '1,80p' .changeset/tame-bats-tell.md
Repository: clerk/javascript
Length of output: 10343
Require a major changeset for the Billing API surfaceBillingSubscription and BillingSubscriptionItem are exported from @clerk/backend, so the constructor shape and nextPayment.amount type change are breaking API changes. Update this changeset to major and add migration guidance.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/tame-bats-tell.md around lines 2 - 5, Update the changeset entry
for `@clerk/backend` from minor to major to reflect the breaking
BillingSubscription and BillingSubscriptionItem API changes, and add migration
guidance covering the constructor shape and nextPayment.amount type updates.

Source: Coding guidelines

21 changes: 14 additions & 7 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { BillingMoneyAmount } from '@clerk/shared/types';
import type { BillingMoneyAmount, BillingPerUnitTotal, BillingTotals } from '@clerk/shared/types';

import { billingMoneyAmountFromJSON, billingPerUnitTotalsFromJSON, billingTotalsFromJSON } from '../../util/billing';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

Expand All@@ -12,6 +13,8 @@ export class BillingSubscription {
 constructor(
 /** The unique identifier for the Subscription. */
 readonly id: string,
 /** The ID of the instance this Subscription belongs to. */
 readonly instanceId: string,
 /** The current status of the Subscription. */
 readonly status: BillingSubscriptionJSON['status'],
 /** The ID of the payer for this Subscription. */
Expand All@@ -32,6 +35,10 @@ export class BillingSubscription {
 date: number;
 /** The amount of the next payment. */
 amount: BillingMoneyAmount;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 } | null,
 /** Whether the payer is eligible for a free trial. */
 readonly eligibleForFreeTrial: boolean,
Expand All@@ -41,17 +48,17 @@ export class BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
 amount: {
 amount: data.next_payment.amount.amount,
 amountFormatted: data.next_payment.amount.amount_formatted,
 currency: data.next_payment.amount.currency,
 currencySymbol: data.next_payment.amount.currency_symbol,
 },
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : null;

 return new BillingSubscription(
 data.id,
 data.instance_id,
 data.status,
 data.payer_id,
 data.created_at,
Expand Down

60 changes: 40 additions & 20 deletions
packages/backend/src/api/resources/CommerceSubscriptionItem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/shared/types';
import type {
 BillingMoneyAmount,
 BillingPerUnitTotal,
 BillingSubscriptionItemSeats,
 BillingTotals,
} from '@clerk/shared/types';

import {
 billingMoneyAmountFromJSON,
 billingPerUnitTotalsFromJSON,
 billingSubscriptionItemSeatsFromJSON,
 billingTotalsFromJSON,
} from '../../util/billing';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

Expand All@@ -12,6 +23,8 @@ export class BillingSubscriptionItem {
 constructor(
 /** The unique identifier for the Subscription Item. */
 readonly id: string,
 /** The ID of the instance this Subscription Item belongs to. */
 readonly instanceId: string,
 /** The status of the Subscription Item. */
 readonly status: BillingSubscriptionItemJSON['status'],
 /** The period of the Plan associated with this Subscription Item. */
Expand All@@ -22,9 +35,13 @@ export class BillingSubscriptionItem {
 readonly nextPayment:
 | {
 /** The amount of the next payment. */
 amount: number;
 amount: BillingMoneyAmount;
 /** The Unix timestamp (milliseconds) of when the next payment is scheduled. */
 date: number;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 }
 | null
 | undefined,
Expand All@@ -34,6 +51,8 @@ export class BillingSubscriptionItem {
 readonly plan: BillingPlan | null,
 /** The ID of the Plan associated with this Subscription Item. */
 readonly planId: string | null,
 /** The ID of the price associated with this Subscription Item. */
 readonly priceId: string | null,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was created. */
 readonly createdAt: number,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was last updated. */
Expand All@@ -49,36 +68,36 @@ export class BillingSubscriptionItem {
 /** The ID of the payer for this Subscription Item. */
 readonly payerId: string | undefined,
 /** Whether this Subscription Item is currently in a free trial period. */
 readonly isFreeTrial?: boolean,
 readonly isFreeTrial: boolean,
 /** The lifetime amount paid for this Subscription Item. */
 readonly lifetimePaid?: BillingMoneyAmount,
 /** Seat entitlement details for organization subscription items with seat-based billing. */
 readonly seats?: BillingSubscriptionItemSeats,
 ) {}

 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
 if (!amount) {
 return amount;
 }

 return {
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
 };
 }
 const nextPayment = data.next_payment
 ? {
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 date: data.next_payment.date,
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : data.next_payment;

 return new BillingSubscriptionItem(
 data.id,
 data.instance_id,
 data.status,
 data.plan_period,
 data.period_start,
data.next_payment,
formatAmountJSON(data.amount) ?? undefined,
nextPayment,
data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined,
 data.plan ? BillingPlan.fromJSON(data.plan) : null,
 data.plan_id ?? null,
 data.price_id ?? null,
 data.created_at,
 data.updated_at,
 data.period_end,
Expand All@@ -87,7 +106,8 @@ export class BillingSubscriptionItem {
 data.ended_at,
 data.payer_id,
 data.is_free_trial,
 formatAmountJSON(data.lifetime_paid) ?? undefined,
 data.lifetime_paid ? billingMoneyAmountFromJSON(data.lifetime_paid) : undefined,
 data.seats ? billingSubscriptionItemSeatsFromJSON(data.seats) : undefined,
 );
 }
}

27 changes: 19 additions & 8 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import type { LastAuthenticationStrategy, SignUpStatus, VerificationStatus } from '@clerk/shared/types';
import type {
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemNextPaymentJSON,
 BillingSubscriptionItemSeatsJSON,
 BillingTotalsJSON as SharedBillingTotalsJSON,
 LastAuthenticationStrategy,
 SignUpStatus,
 VerificationStatus,
} from '@clerk/shared/types';

import type {
 ActorTokenStatus,
Expand DownExpand Up@@ -1006,25 +1014,25 @@ type BillingSubscriptionItemStatus =
 */
export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscriptionItem;
 instance_id: string;
 status: BillingSubscriptionItemStatus;
 plan_period: 'month' | 'annual';
 payer_id?: string;
 price_id?: string;
 period_start: number;
 period_end: number | null;
 is_free_trial?: boolean;
 is_free_trial: boolean;
 ended_at: number | null;
 created_at: number;
 updated_at: number;
 canceled_at: number | null;
 past_due_at: number | null;
 lifetime_paid: BillingMoneyAmountJSON | null;
 next_payment?: {
 amount: number;
 date: number;
 } | null;
 amount: BillingMoneyAmountJSON;
 lifetime_paid?: BillingMoneyAmountJSON | null;
 next_payment?: BillingSubscriptionItemNextPaymentJSON | null;
 amount?: BillingMoneyAmountJSON | null;
 plan?: BillingPlanJSON | null;
 plan_id?: string | null;
 seats?: BillingSubscriptionItemSeatsJSON;
}

/**
Expand DownExpand Up@@ -1127,6 +1135,7 @@ export interface BillingSubscriptionWebhookEventJSON extends ClerkResourceJSON {

export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscription;
 instance_id: string;
 status: 'active' | 'past_due' | 'canceled' | 'ended' | 'abandoned' | 'incomplete';
 payer_id: string;
 created_at: number;
Expand All@@ -1137,6 +1146,8 @@ export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 next_payment?: {
 date: number;
 amount: BillingMoneyAmountJSON;
 per_unit_totals?: BillingPerUnitTotalJSON[];
 totals?: SharedBillingTotalsJSON;
 };
 eligible_for_free_trial?: boolean;
}
Expand Down

105 changes: 105 additions & 0 deletions
packages/backend/src/util/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type {
 BillingCredits,
 BillingCreditsJSON,
 BillingDiscounts,
 BillingDiscountsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingPeriodTotals,
 BillingPeriodTotalsJSON,
 BillingPerUnitTotal,
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemSeats,
 BillingSubscriptionItemSeatsJSON,
 BillingTotals,
 BillingTotalsJSON,
} from '@clerk/shared/types';

export const billingMoneyAmountFromJSON = (amount: BillingMoneyAmountJSON): BillingMoneyAmount => ({
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
});

export const billingPerUnitTotalsFromJSON = (perUnitTotals: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] =>
 perUnitTotals.map(perUnitTotal => ({
 name: perUnitTotal.name,
 blockSize: perUnitTotal.block_size,
 tiers: perUnitTotal.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 })),
 }));

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

const billingDiscountsFromJSON = (discounts: BillingDiscountsJSON): BillingDiscounts => ({
 proration: discounts.proration
 ? {
 amount: billingMoneyAmountFromJSON(discounts.proration.amount),
 cycleDaysPassed: discounts.proration.cycle_days_passed,
 cycleDaysTotal: discounts.proration.cycle_days_total,
 cyclePassedPercent: discounts.proration.cycle_passed_percent,
 }
 : null,
 total: billingMoneyAmountFromJSON(discounts.total),
});

const billingPeriodTotalsFromJSON = (totals: BillingPeriodTotalsJSON): BillingPeriodTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: billingMoneyAmountFromJSON(totals.base_fee),
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
});

export const billingTotalsFromJSON = (totals: BillingTotalsJSON): BillingTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: totals.base_fee ? billingMoneyAmountFromJSON(totals.base_fee) : null,
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 totalDueAfterFreeTrial: totals.total_due_after_free_trial
 ? billingMoneyAmountFromJSON(totals.total_due_after_free_trial)
 : totals.total_due_after_free_trial,
 credit: totals.credit ? billingMoneyAmountFromJSON(totals.credit) : totals.credit,
 credits: totals.credits ? billingCreditsFromJSON(totals.credits) : null,
 discounts: totals.discounts ? billingDiscountsFromJSON(totals.discounts) : null,
 pastDue: totals.past_due ? billingMoneyAmountFromJSON(totals.past_due) : totals.past_due,
 totalDueNow: totals.total_due_now ? billingMoneyAmountFromJSON(totals.total_due_now) : undefined,
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
 totalsDuePerPeriod: totals.totals_due_per_period
 ? billingPeriodTotalsFromJSON(totals.totals_due_per_period)
 : undefined,
 totalDuePerPeriod: totals.total_due_per_period ? billingMoneyAmountFromJSON(totals.total_due_per_period) : undefined,
});

export const billingSubscriptionItemSeatsFromJSON = (
 seats: BillingSubscriptionItemSeatsJSON,
): BillingSubscriptionItemSeats => ({
 quantity: seats.quantity,
 tiers: seats.tiers
 ? seats.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 }))
 : undefined,
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(backend): Update Subscription and SubscriptionItem resources#9196

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 2 commits into

from

Jul 30, 2026
 Merged


fix(backend): Update Subscription and SubscriptionItem resources
#9196
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1cbd099

fix(backend): Update Subscription and SubscriptionItem resources


dstaley Jul 17, 2026
d40a9c3

lint: sort imports


dstaley Jul 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/tame-bats-tell.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

Update fields for BillingSubscription and BillingSubscriptionItem

Comment on lines

+2
 to 
+5

@coderabbitaicoderabbitaiBotJul 17, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bashset -euo pipefail
cat packages/backend/package.json
rg -n -C 3 '\b(BillingSubscription|BillingSubscriptionItem)\b' packages/backend/src
Repository: clerk/javascript
Length of output: 24693
🏁 Script executed:
#!/bin/bashset -euo pipefail
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscription.ts
printf'\n---\n'
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscriptionItem.ts
printf'\n---\n'
sed -n '140,190p' packages/backend/src/index.ts
printf'\n---\n'
sed -n '1,80p' .changeset/tame-bats-tell.md
Repository: clerk/javascript
Length of output: 10343
Require a major changeset for the Billing API surfaceBillingSubscription and BillingSubscriptionItem are exported from @clerk/backend, so the constructor shape and nextPayment.amount type change are breaking API changes. Update this changeset to major and add migration guidance.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/tame-bats-tell.md around lines 2 - 5, Update the changeset entry
for `@clerk/backend` from minor to major to reflect the breaking
BillingSubscription and BillingSubscriptionItem API changes, and add migration
guidance covering the constructor shape and nextPayment.amount type updates.

Source: Coding guidelines

21 changes: 14 additions & 7 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { BillingMoneyAmount } from '@clerk/shared/types';
import type { BillingMoneyAmount, BillingPerUnitTotal, BillingTotals } from '@clerk/shared/types';

import { billingMoneyAmountFromJSON, billingPerUnitTotalsFromJSON, billingTotalsFromJSON } from '../../util/billing';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

Expand All@@ -12,6 +13,8 @@ export class BillingSubscription {
 constructor(
 /** The unique identifier for the Subscription. */
 readonly id: string,
 /** The ID of the instance this Subscription belongs to. */
 readonly instanceId: string,
 /** The current status of the Subscription. */
 readonly status: BillingSubscriptionJSON['status'],
 /** The ID of the payer for this Subscription. */
Expand All@@ -32,6 +35,10 @@ export class BillingSubscription {
 date: number;
 /** The amount of the next payment. */
 amount: BillingMoneyAmount;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 } | null,
 /** Whether the payer is eligible for a free trial. */
 readonly eligibleForFreeTrial: boolean,
Expand All@@ -41,17 +48,17 @@ export class BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
 amount: {
 amount: data.next_payment.amount.amount,
 amountFormatted: data.next_payment.amount.amount_formatted,
 currency: data.next_payment.amount.currency,
 currencySymbol: data.next_payment.amount.currency_symbol,
 },
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : null;

 return new BillingSubscription(
 data.id,
 data.instance_id,
 data.status,
 data.payer_id,
 data.created_at,
Expand Down

60 changes: 40 additions & 20 deletions
packages/backend/src/api/resources/CommerceSubscriptionItem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/shared/types';
import type {
 BillingMoneyAmount,
 BillingPerUnitTotal,
 BillingSubscriptionItemSeats,
 BillingTotals,
} from '@clerk/shared/types';

import {
 billingMoneyAmountFromJSON,
 billingPerUnitTotalsFromJSON,
 billingSubscriptionItemSeatsFromJSON,
 billingTotalsFromJSON,
} from '../../util/billing';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

Expand All@@ -12,6 +23,8 @@ export class BillingSubscriptionItem {
 constructor(
 /** The unique identifier for the Subscription Item. */
 readonly id: string,
 /** The ID of the instance this Subscription Item belongs to. */
 readonly instanceId: string,
 /** The status of the Subscription Item. */
 readonly status: BillingSubscriptionItemJSON['status'],
 /** The period of the Plan associated with this Subscription Item. */
Expand All@@ -22,9 +35,13 @@ export class BillingSubscriptionItem {
 readonly nextPayment:
 | {
 /** The amount of the next payment. */
 amount: number;
 amount: BillingMoneyAmount;
 /** The Unix timestamp (milliseconds) of when the next payment is scheduled. */
 date: number;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 }
 | null
 | undefined,
Expand All@@ -34,6 +51,8 @@ export class BillingSubscriptionItem {
 readonly plan: BillingPlan | null,
 /** The ID of the Plan associated with this Subscription Item. */
 readonly planId: string | null,
 /** The ID of the price associated with this Subscription Item. */
 readonly priceId: string | null,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was created. */
 readonly createdAt: number,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was last updated. */
Expand All@@ -49,36 +68,36 @@ export class BillingSubscriptionItem {
 /** The ID of the payer for this Subscription Item. */
 readonly payerId: string | undefined,
 /** Whether this Subscription Item is currently in a free trial period. */
 readonly isFreeTrial?: boolean,
 readonly isFreeTrial: boolean,
 /** The lifetime amount paid for this Subscription Item. */
 readonly lifetimePaid?: BillingMoneyAmount,
 /** Seat entitlement details for organization subscription items with seat-based billing. */
 readonly seats?: BillingSubscriptionItemSeats,
 ) {}

 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
 if (!amount) {
 return amount;
 }

 return {
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
 };
 }
 const nextPayment = data.next_payment
 ? {
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 date: data.next_payment.date,
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : data.next_payment;

 return new BillingSubscriptionItem(
 data.id,
 data.instance_id,
 data.status,
 data.plan_period,
 data.period_start,
data.next_payment,
formatAmountJSON(data.amount) ?? undefined,
nextPayment,
data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined,
 data.plan ? BillingPlan.fromJSON(data.plan) : null,
 data.plan_id ?? null,
 data.price_id ?? null,
 data.created_at,
 data.updated_at,
 data.period_end,
Expand All@@ -87,7 +106,8 @@ export class BillingSubscriptionItem {
 data.ended_at,
 data.payer_id,
 data.is_free_trial,
 formatAmountJSON(data.lifetime_paid) ?? undefined,
 data.lifetime_paid ? billingMoneyAmountFromJSON(data.lifetime_paid) : undefined,
 data.seats ? billingSubscriptionItemSeatsFromJSON(data.seats) : undefined,
 );
 }
}

27 changes: 19 additions & 8 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import type { LastAuthenticationStrategy, SignUpStatus, VerificationStatus } from '@clerk/shared/types';
import type {
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemNextPaymentJSON,
 BillingSubscriptionItemSeatsJSON,
 BillingTotalsJSON as SharedBillingTotalsJSON,
 LastAuthenticationStrategy,
 SignUpStatus,
 VerificationStatus,
} from '@clerk/shared/types';

import type {
 ActorTokenStatus,
Expand DownExpand Up@@ -1006,25 +1014,25 @@ type BillingSubscriptionItemStatus =
 */
export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscriptionItem;
 instance_id: string;
 status: BillingSubscriptionItemStatus;
 plan_period: 'month' | 'annual';
 payer_id?: string;
 price_id?: string;
 period_start: number;
 period_end: number | null;
 is_free_trial?: boolean;
 is_free_trial: boolean;
 ended_at: number | null;
 created_at: number;
 updated_at: number;
 canceled_at: number | null;
 past_due_at: number | null;
 lifetime_paid: BillingMoneyAmountJSON | null;
 next_payment?: {
 amount: number;
 date: number;
 } | null;
 amount: BillingMoneyAmountJSON;
 lifetime_paid?: BillingMoneyAmountJSON | null;
 next_payment?: BillingSubscriptionItemNextPaymentJSON | null;
 amount?: BillingMoneyAmountJSON | null;
 plan?: BillingPlanJSON | null;
 plan_id?: string | null;
 seats?: BillingSubscriptionItemSeatsJSON;
}

/**
Expand DownExpand Up@@ -1127,6 +1135,7 @@ export interface BillingSubscriptionWebhookEventJSON extends ClerkResourceJSON {

export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscription;
 instance_id: string;
 status: 'active' | 'past_due' | 'canceled' | 'ended' | 'abandoned' | 'incomplete';
 payer_id: string;
 created_at: number;
Expand All@@ -1137,6 +1146,8 @@ export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 next_payment?: {
 date: number;
 amount: BillingMoneyAmountJSON;
 per_unit_totals?: BillingPerUnitTotalJSON[];
 totals?: SharedBillingTotalsJSON;
 };
 eligible_for_free_trial?: boolean;
}
Expand Down

105 changes: 105 additions & 0 deletions
packages/backend/src/util/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type {
 BillingCredits,
 BillingCreditsJSON,
 BillingDiscounts,
 BillingDiscountsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingPeriodTotals,
 BillingPeriodTotalsJSON,
 BillingPerUnitTotal,
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemSeats,
 BillingSubscriptionItemSeatsJSON,
 BillingTotals,
 BillingTotalsJSON,
} from '@clerk/shared/types';

export const billingMoneyAmountFromJSON = (amount: BillingMoneyAmountJSON): BillingMoneyAmount => ({
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
});

export const billingPerUnitTotalsFromJSON = (perUnitTotals: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] =>
 perUnitTotals.map(perUnitTotal => ({
 name: perUnitTotal.name,
 blockSize: perUnitTotal.block_size,
 tiers: perUnitTotal.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 })),
 }));

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

const billingDiscountsFromJSON = (discounts: BillingDiscountsJSON): BillingDiscounts => ({
 proration: discounts.proration
 ? {
 amount: billingMoneyAmountFromJSON(discounts.proration.amount),
 cycleDaysPassed: discounts.proration.cycle_days_passed,
 cycleDaysTotal: discounts.proration.cycle_days_total,
 cyclePassedPercent: discounts.proration.cycle_passed_percent,
 }
 : null,
 total: billingMoneyAmountFromJSON(discounts.total),
});

const billingPeriodTotalsFromJSON = (totals: BillingPeriodTotalsJSON): BillingPeriodTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: billingMoneyAmountFromJSON(totals.base_fee),
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
});

export const billingTotalsFromJSON = (totals: BillingTotalsJSON): BillingTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: totals.base_fee ? billingMoneyAmountFromJSON(totals.base_fee) : null,
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 totalDueAfterFreeTrial: totals.total_due_after_free_trial
 ? billingMoneyAmountFromJSON(totals.total_due_after_free_trial)
 : totals.total_due_after_free_trial,
 credit: totals.credit ? billingMoneyAmountFromJSON(totals.credit) : totals.credit,
 credits: totals.credits ? billingCreditsFromJSON(totals.credits) : null,
 discounts: totals.discounts ? billingDiscountsFromJSON(totals.discounts) : null,
 pastDue: totals.past_due ? billingMoneyAmountFromJSON(totals.past_due) : totals.past_due,
 totalDueNow: totals.total_due_now ? billingMoneyAmountFromJSON(totals.total_due_now) : undefined,
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
 totalsDuePerPeriod: totals.totals_due_per_period
 ? billingPeriodTotalsFromJSON(totals.totals_due_per_period)
 : undefined,
 totalDuePerPeriod: totals.total_due_per_period ? billingMoneyAmountFromJSON(totals.total_due_per_period) : undefined,
});

export const billingSubscriptionItemSeatsFromJSON = (
 seats: BillingSubscriptionItemSeatsJSON,
): BillingSubscriptionItemSeats => ({
 quantity: seats.quantity,
 tiers: seats.tiers
 ? seats.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 }))
 : undefined,
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(backend): Update Subscription and SubscriptionItem resources#9196

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 2 commits into

from

Jul 30, 2026
 Merged


fix(backend): Update Subscription and SubscriptionItem resources
#9196
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1cbd099

fix(backend): Update Subscription and SubscriptionItem resources


dstaley Jul 17, 2026
d40a9c3

lint: sort imports


dstaley Jul 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/tame-bats-tell.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

Update fields for BillingSubscription and BillingSubscriptionItem

Comment on lines

+2
 to 
+5

@coderabbitaicoderabbitaiBotJul 17, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bashset -euo pipefail
cat packages/backend/package.json
rg -n -C 3 '\b(BillingSubscription|BillingSubscriptionItem)\b' packages/backend/src
Repository: clerk/javascript
Length of output: 24693
🏁 Script executed:
#!/bin/bashset -euo pipefail
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscription.ts
printf'\n---\n'
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscriptionItem.ts
printf'\n---\n'
sed -n '140,190p' packages/backend/src/index.ts
printf'\n---\n'
sed -n '1,80p' .changeset/tame-bats-tell.md
Repository: clerk/javascript
Length of output: 10343
Require a major changeset for the Billing API surfaceBillingSubscription and BillingSubscriptionItem are exported from @clerk/backend, so the constructor shape and nextPayment.amount type change are breaking API changes. Update this changeset to major and add migration guidance.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/tame-bats-tell.md around lines 2 - 5, Update the changeset entry
for `@clerk/backend` from minor to major to reflect the breaking
BillingSubscription and BillingSubscriptionItem API changes, and add migration
guidance covering the constructor shape and nextPayment.amount type updates.

Source: Coding guidelines

21 changes: 14 additions & 7 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { BillingMoneyAmount } from '@clerk/shared/types';
import type { BillingMoneyAmount, BillingPerUnitTotal, BillingTotals } from '@clerk/shared/types';

import { billingMoneyAmountFromJSON, billingPerUnitTotalsFromJSON, billingTotalsFromJSON } from '../../util/billing';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

Expand All@@ -12,6 +13,8 @@ export class BillingSubscription {
 constructor(
 /** The unique identifier for the Subscription. */
 readonly id: string,
 /** The ID of the instance this Subscription belongs to. */
 readonly instanceId: string,
 /** The current status of the Subscription. */
 readonly status: BillingSubscriptionJSON['status'],
 /** The ID of the payer for this Subscription. */
Expand All@@ -32,6 +35,10 @@ export class BillingSubscription {
 date: number;
 /** The amount of the next payment. */
 amount: BillingMoneyAmount;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 } | null,
 /** Whether the payer is eligible for a free trial. */
 readonly eligibleForFreeTrial: boolean,
Expand All@@ -41,17 +48,17 @@ export class BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
 amount: {
 amount: data.next_payment.amount.amount,
 amountFormatted: data.next_payment.amount.amount_formatted,
 currency: data.next_payment.amount.currency,
 currencySymbol: data.next_payment.amount.currency_symbol,
 },
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : null;

 return new BillingSubscription(
 data.id,
 data.instance_id,
 data.status,
 data.payer_id,
 data.created_at,
Expand Down

60 changes: 40 additions & 20 deletions
packages/backend/src/api/resources/CommerceSubscriptionItem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/shared/types';
import type {
 BillingMoneyAmount,
 BillingPerUnitTotal,
 BillingSubscriptionItemSeats,
 BillingTotals,
} from '@clerk/shared/types';

import {
 billingMoneyAmountFromJSON,
 billingPerUnitTotalsFromJSON,
 billingSubscriptionItemSeatsFromJSON,
 billingTotalsFromJSON,
} from '../../util/billing';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

Expand All@@ -12,6 +23,8 @@ export class BillingSubscriptionItem {
 constructor(
 /** The unique identifier for the Subscription Item. */
 readonly id: string,
 /** The ID of the instance this Subscription Item belongs to. */
 readonly instanceId: string,
 /** The status of the Subscription Item. */
 readonly status: BillingSubscriptionItemJSON['status'],
 /** The period of the Plan associated with this Subscription Item. */
Expand All@@ -22,9 +35,13 @@ export class BillingSubscriptionItem {
 readonly nextPayment:
 | {
 /** The amount of the next payment. */
 amount: number;
 amount: BillingMoneyAmount;
 /** The Unix timestamp (milliseconds) of when the next payment is scheduled. */
 date: number;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 }
 | null
 | undefined,
Expand All@@ -34,6 +51,8 @@ export class BillingSubscriptionItem {
 readonly plan: BillingPlan | null,
 /** The ID of the Plan associated with this Subscription Item. */
 readonly planId: string | null,
 /** The ID of the price associated with this Subscription Item. */
 readonly priceId: string | null,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was created. */
 readonly createdAt: number,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was last updated. */
Expand All@@ -49,36 +68,36 @@ export class BillingSubscriptionItem {
 /** The ID of the payer for this Subscription Item. */
 readonly payerId: string | undefined,
 /** Whether this Subscription Item is currently in a free trial period. */
 readonly isFreeTrial?: boolean,
 readonly isFreeTrial: boolean,
 /** The lifetime amount paid for this Subscription Item. */
 readonly lifetimePaid?: BillingMoneyAmount,
 /** Seat entitlement details for organization subscription items with seat-based billing. */
 readonly seats?: BillingSubscriptionItemSeats,
 ) {}

 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
 if (!amount) {
 return amount;
 }

 return {
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
 };
 }
 const nextPayment = data.next_payment
 ? {
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 date: data.next_payment.date,
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : data.next_payment;

 return new BillingSubscriptionItem(
 data.id,
 data.instance_id,
 data.status,
 data.plan_period,
 data.period_start,
data.next_payment,
formatAmountJSON(data.amount) ?? undefined,
nextPayment,
data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined,
 data.plan ? BillingPlan.fromJSON(data.plan) : null,
 data.plan_id ?? null,
 data.price_id ?? null,
 data.created_at,
 data.updated_at,
 data.period_end,
Expand All@@ -87,7 +106,8 @@ export class BillingSubscriptionItem {
 data.ended_at,
 data.payer_id,
 data.is_free_trial,
 formatAmountJSON(data.lifetime_paid) ?? undefined,
 data.lifetime_paid ? billingMoneyAmountFromJSON(data.lifetime_paid) : undefined,
 data.seats ? billingSubscriptionItemSeatsFromJSON(data.seats) : undefined,
 );
 }
}

27 changes: 19 additions & 8 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import type { LastAuthenticationStrategy, SignUpStatus, VerificationStatus } from '@clerk/shared/types';
import type {
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemNextPaymentJSON,
 BillingSubscriptionItemSeatsJSON,
 BillingTotalsJSON as SharedBillingTotalsJSON,
 LastAuthenticationStrategy,
 SignUpStatus,
 VerificationStatus,
} from '@clerk/shared/types';

import type {
 ActorTokenStatus,
Expand DownExpand Up@@ -1006,25 +1014,25 @@ type BillingSubscriptionItemStatus =
 */
export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscriptionItem;
 instance_id: string;
 status: BillingSubscriptionItemStatus;
 plan_period: 'month' | 'annual';
 payer_id?: string;
 price_id?: string;
 period_start: number;
 period_end: number | null;
 is_free_trial?: boolean;
 is_free_trial: boolean;
 ended_at: number | null;
 created_at: number;
 updated_at: number;
 canceled_at: number | null;
 past_due_at: number | null;
 lifetime_paid: BillingMoneyAmountJSON | null;
 next_payment?: {
 amount: number;
 date: number;
 } | null;
 amount: BillingMoneyAmountJSON;
 lifetime_paid?: BillingMoneyAmountJSON | null;
 next_payment?: BillingSubscriptionItemNextPaymentJSON | null;
 amount?: BillingMoneyAmountJSON | null;
 plan?: BillingPlanJSON | null;
 plan_id?: string | null;
 seats?: BillingSubscriptionItemSeatsJSON;
}

/**
Expand DownExpand Up@@ -1127,6 +1135,7 @@ export interface BillingSubscriptionWebhookEventJSON extends ClerkResourceJSON {

export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscription;
 instance_id: string;
 status: 'active' | 'past_due' | 'canceled' | 'ended' | 'abandoned' | 'incomplete';
 payer_id: string;
 created_at: number;
Expand All@@ -1137,6 +1146,8 @@ export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 next_payment?: {
 date: number;
 amount: BillingMoneyAmountJSON;
 per_unit_totals?: BillingPerUnitTotalJSON[];
 totals?: SharedBillingTotalsJSON;
 };
 eligible_for_free_trial?: boolean;
}
Expand Down

105 changes: 105 additions & 0 deletions
packages/backend/src/util/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type {
 BillingCredits,
 BillingCreditsJSON,
 BillingDiscounts,
 BillingDiscountsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingPeriodTotals,
 BillingPeriodTotalsJSON,
 BillingPerUnitTotal,
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemSeats,
 BillingSubscriptionItemSeatsJSON,
 BillingTotals,
 BillingTotalsJSON,
} from '@clerk/shared/types';

export const billingMoneyAmountFromJSON = (amount: BillingMoneyAmountJSON): BillingMoneyAmount => ({
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
});

export const billingPerUnitTotalsFromJSON = (perUnitTotals: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] =>
 perUnitTotals.map(perUnitTotal => ({
 name: perUnitTotal.name,
 blockSize: perUnitTotal.block_size,
 tiers: perUnitTotal.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 })),
 }));

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

const billingDiscountsFromJSON = (discounts: BillingDiscountsJSON): BillingDiscounts => ({
 proration: discounts.proration
 ? {
 amount: billingMoneyAmountFromJSON(discounts.proration.amount),
 cycleDaysPassed: discounts.proration.cycle_days_passed,
 cycleDaysTotal: discounts.proration.cycle_days_total,
 cyclePassedPercent: discounts.proration.cycle_passed_percent,
 }
 : null,
 total: billingMoneyAmountFromJSON(discounts.total),
});

const billingPeriodTotalsFromJSON = (totals: BillingPeriodTotalsJSON): BillingPeriodTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: billingMoneyAmountFromJSON(totals.base_fee),
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
});

export const billingTotalsFromJSON = (totals: BillingTotalsJSON): BillingTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: totals.base_fee ? billingMoneyAmountFromJSON(totals.base_fee) : null,
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 totalDueAfterFreeTrial: totals.total_due_after_free_trial
 ? billingMoneyAmountFromJSON(totals.total_due_after_free_trial)
 : totals.total_due_after_free_trial,
 credit: totals.credit ? billingMoneyAmountFromJSON(totals.credit) : totals.credit,
 credits: totals.credits ? billingCreditsFromJSON(totals.credits) : null,
 discounts: totals.discounts ? billingDiscountsFromJSON(totals.discounts) : null,
 pastDue: totals.past_due ? billingMoneyAmountFromJSON(totals.past_due) : totals.past_due,
 totalDueNow: totals.total_due_now ? billingMoneyAmountFromJSON(totals.total_due_now) : undefined,
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
 totalsDuePerPeriod: totals.totals_due_per_period
 ? billingPeriodTotalsFromJSON(totals.totals_due_per_period)
 : undefined,
 totalDuePerPeriod: totals.total_due_per_period ? billingMoneyAmountFromJSON(totals.total_due_per_period) : undefined,
});

export const billingSubscriptionItemSeatsFromJSON = (
 seats: BillingSubscriptionItemSeatsJSON,
): BillingSubscriptionItemSeats => ({
 quantity: seats.quantity,
 tiers: seats.tiers
 ? seats.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 }))
 : undefined,
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(backend): Update Subscription and SubscriptionItem resources#9196

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 2 commits into

from

Jul 30, 2026
 Merged


fix(backend): Update Subscription and SubscriptionItem resources
#9196
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1cbd099

fix(backend): Update Subscription and SubscriptionItem resources


dstaley Jul 17, 2026
d40a9c3

lint: sort imports


dstaley Jul 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/tame-bats-tell.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

Update fields for BillingSubscription and BillingSubscriptionItem

Comment on lines

+2
 to 
+5

@coderabbitaicoderabbitaiBotJul 17, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bashset -euo pipefail
cat packages/backend/package.json
rg -n -C 3 '\b(BillingSubscription|BillingSubscriptionItem)\b' packages/backend/src
Repository: clerk/javascript
Length of output: 24693
🏁 Script executed:
#!/bin/bashset -euo pipefail
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscription.ts
printf'\n---\n'
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscriptionItem.ts
printf'\n---\n'
sed -n '140,190p' packages/backend/src/index.ts
printf'\n---\n'
sed -n '1,80p' .changeset/tame-bats-tell.md
Repository: clerk/javascript
Length of output: 10343
Require a major changeset for the Billing API surfaceBillingSubscription and BillingSubscriptionItem are exported from @clerk/backend, so the constructor shape and nextPayment.amount type change are breaking API changes. Update this changeset to major and add migration guidance.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/tame-bats-tell.md around lines 2 - 5, Update the changeset entry
for `@clerk/backend` from minor to major to reflect the breaking
BillingSubscription and BillingSubscriptionItem API changes, and add migration
guidance covering the constructor shape and nextPayment.amount type updates.

Source: Coding guidelines

21 changes: 14 additions & 7 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { BillingMoneyAmount } from '@clerk/shared/types';
import type { BillingMoneyAmount, BillingPerUnitTotal, BillingTotals } from '@clerk/shared/types';

import { billingMoneyAmountFromJSON, billingPerUnitTotalsFromJSON, billingTotalsFromJSON } from '../../util/billing';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

Expand All@@ -12,6 +13,8 @@ export class BillingSubscription {
 constructor(
 /** The unique identifier for the Subscription. */
 readonly id: string,
 /** The ID of the instance this Subscription belongs to. */
 readonly instanceId: string,
 /** The current status of the Subscription. */
 readonly status: BillingSubscriptionJSON['status'],
 /** The ID of the payer for this Subscription. */
Expand All@@ -32,6 +35,10 @@ export class BillingSubscription {
 date: number;
 /** The amount of the next payment. */
 amount: BillingMoneyAmount;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 } | null,
 /** Whether the payer is eligible for a free trial. */
 readonly eligibleForFreeTrial: boolean,
Expand All@@ -41,17 +48,17 @@ export class BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
 amount: {
 amount: data.next_payment.amount.amount,
 amountFormatted: data.next_payment.amount.amount_formatted,
 currency: data.next_payment.amount.currency,
 currencySymbol: data.next_payment.amount.currency_symbol,
 },
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : null;

 return new BillingSubscription(
 data.id,
 data.instance_id,
 data.status,
 data.payer_id,
 data.created_at,
Expand Down

60 changes: 40 additions & 20 deletions
packages/backend/src/api/resources/CommerceSubscriptionItem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/shared/types';
import type {
 BillingMoneyAmount,
 BillingPerUnitTotal,
 BillingSubscriptionItemSeats,
 BillingTotals,
} from '@clerk/shared/types';

import {
 billingMoneyAmountFromJSON,
 billingPerUnitTotalsFromJSON,
 billingSubscriptionItemSeatsFromJSON,
 billingTotalsFromJSON,
} from '../../util/billing';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

Expand All@@ -12,6 +23,8 @@ export class BillingSubscriptionItem {
 constructor(
 /** The unique identifier for the Subscription Item. */
 readonly id: string,
 /** The ID of the instance this Subscription Item belongs to. */
 readonly instanceId: string,
 /** The status of the Subscription Item. */
 readonly status: BillingSubscriptionItemJSON['status'],
 /** The period of the Plan associated with this Subscription Item. */
Expand All@@ -22,9 +35,13 @@ export class BillingSubscriptionItem {
 readonly nextPayment:
 | {
 /** The amount of the next payment. */
 amount: number;
 amount: BillingMoneyAmount;
 /** The Unix timestamp (milliseconds) of when the next payment is scheduled. */
 date: number;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 }
 | null
 | undefined,
Expand All@@ -34,6 +51,8 @@ export class BillingSubscriptionItem {
 readonly plan: BillingPlan | null,
 /** The ID of the Plan associated with this Subscription Item. */
 readonly planId: string | null,
 /** The ID of the price associated with this Subscription Item. */
 readonly priceId: string | null,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was created. */
 readonly createdAt: number,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was last updated. */
Expand All@@ -49,36 +68,36 @@ export class BillingSubscriptionItem {
 /** The ID of the payer for this Subscription Item. */
 readonly payerId: string | undefined,
 /** Whether this Subscription Item is currently in a free trial period. */
 readonly isFreeTrial?: boolean,
 readonly isFreeTrial: boolean,
 /** The lifetime amount paid for this Subscription Item. */
 readonly lifetimePaid?: BillingMoneyAmount,
 /** Seat entitlement details for organization subscription items with seat-based billing. */
 readonly seats?: BillingSubscriptionItemSeats,
 ) {}

 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
 if (!amount) {
 return amount;
 }

 return {
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
 };
 }
 const nextPayment = data.next_payment
 ? {
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 date: data.next_payment.date,
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : data.next_payment;

 return new BillingSubscriptionItem(
 data.id,
 data.instance_id,
 data.status,
 data.plan_period,
 data.period_start,
data.next_payment,
formatAmountJSON(data.amount) ?? undefined,
nextPayment,
data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined,
 data.plan ? BillingPlan.fromJSON(data.plan) : null,
 data.plan_id ?? null,
 data.price_id ?? null,
 data.created_at,
 data.updated_at,
 data.period_end,
Expand All@@ -87,7 +106,8 @@ export class BillingSubscriptionItem {
 data.ended_at,
 data.payer_id,
 data.is_free_trial,
 formatAmountJSON(data.lifetime_paid) ?? undefined,
 data.lifetime_paid ? billingMoneyAmountFromJSON(data.lifetime_paid) : undefined,
 data.seats ? billingSubscriptionItemSeatsFromJSON(data.seats) : undefined,
 );
 }
}

27 changes: 19 additions & 8 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import type { LastAuthenticationStrategy, SignUpStatus, VerificationStatus } from '@clerk/shared/types';
import type {
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemNextPaymentJSON,
 BillingSubscriptionItemSeatsJSON,
 BillingTotalsJSON as SharedBillingTotalsJSON,
 LastAuthenticationStrategy,
 SignUpStatus,
 VerificationStatus,
} from '@clerk/shared/types';

import type {
 ActorTokenStatus,
Expand DownExpand Up@@ -1006,25 +1014,25 @@ type BillingSubscriptionItemStatus =
 */
export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscriptionItem;
 instance_id: string;
 status: BillingSubscriptionItemStatus;
 plan_period: 'month' | 'annual';
 payer_id?: string;
 price_id?: string;
 period_start: number;
 period_end: number | null;
 is_free_trial?: boolean;
 is_free_trial: boolean;
 ended_at: number | null;
 created_at: number;
 updated_at: number;
 canceled_at: number | null;
 past_due_at: number | null;
 lifetime_paid: BillingMoneyAmountJSON | null;
 next_payment?: {
 amount: number;
 date: number;
 } | null;
 amount: BillingMoneyAmountJSON;
 lifetime_paid?: BillingMoneyAmountJSON | null;
 next_payment?: BillingSubscriptionItemNextPaymentJSON | null;
 amount?: BillingMoneyAmountJSON | null;
 plan?: BillingPlanJSON | null;
 plan_id?: string | null;
 seats?: BillingSubscriptionItemSeatsJSON;
}

/**
Expand DownExpand Up@@ -1127,6 +1135,7 @@ export interface BillingSubscriptionWebhookEventJSON extends ClerkResourceJSON {

export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscription;
 instance_id: string;
 status: 'active' | 'past_due' | 'canceled' | 'ended' | 'abandoned' | 'incomplete';
 payer_id: string;
 created_at: number;
Expand All@@ -1137,6 +1146,8 @@ export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 next_payment?: {
 date: number;
 amount: BillingMoneyAmountJSON;
 per_unit_totals?: BillingPerUnitTotalJSON[];
 totals?: SharedBillingTotalsJSON;
 };
 eligible_for_free_trial?: boolean;
}
Expand Down

105 changes: 105 additions & 0 deletions
packages/backend/src/util/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type {
 BillingCredits,
 BillingCreditsJSON,
 BillingDiscounts,
 BillingDiscountsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingPeriodTotals,
 BillingPeriodTotalsJSON,
 BillingPerUnitTotal,
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemSeats,
 BillingSubscriptionItemSeatsJSON,
 BillingTotals,
 BillingTotalsJSON,
} from '@clerk/shared/types';

export const billingMoneyAmountFromJSON = (amount: BillingMoneyAmountJSON): BillingMoneyAmount => ({
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
});

export const billingPerUnitTotalsFromJSON = (perUnitTotals: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] =>
 perUnitTotals.map(perUnitTotal => ({
 name: perUnitTotal.name,
 blockSize: perUnitTotal.block_size,
 tiers: perUnitTotal.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 })),
 }));

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

const billingDiscountsFromJSON = (discounts: BillingDiscountsJSON): BillingDiscounts => ({
 proration: discounts.proration
 ? {
 amount: billingMoneyAmountFromJSON(discounts.proration.amount),
 cycleDaysPassed: discounts.proration.cycle_days_passed,
 cycleDaysTotal: discounts.proration.cycle_days_total,
 cyclePassedPercent: discounts.proration.cycle_passed_percent,
 }
 : null,
 total: billingMoneyAmountFromJSON(discounts.total),
});

const billingPeriodTotalsFromJSON = (totals: BillingPeriodTotalsJSON): BillingPeriodTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: billingMoneyAmountFromJSON(totals.base_fee),
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
});

export const billingTotalsFromJSON = (totals: BillingTotalsJSON): BillingTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: totals.base_fee ? billingMoneyAmountFromJSON(totals.base_fee) : null,
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 totalDueAfterFreeTrial: totals.total_due_after_free_trial
 ? billingMoneyAmountFromJSON(totals.total_due_after_free_trial)
 : totals.total_due_after_free_trial,
 credit: totals.credit ? billingMoneyAmountFromJSON(totals.credit) : totals.credit,
 credits: totals.credits ? billingCreditsFromJSON(totals.credits) : null,
 discounts: totals.discounts ? billingDiscountsFromJSON(totals.discounts) : null,
 pastDue: totals.past_due ? billingMoneyAmountFromJSON(totals.past_due) : totals.past_due,
 totalDueNow: totals.total_due_now ? billingMoneyAmountFromJSON(totals.total_due_now) : undefined,
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
 totalsDuePerPeriod: totals.totals_due_per_period
 ? billingPeriodTotalsFromJSON(totals.totals_due_per_period)
 : undefined,
 totalDuePerPeriod: totals.total_due_per_period ? billingMoneyAmountFromJSON(totals.total_due_per_period) : undefined,
});

export const billingSubscriptionItemSeatsFromJSON = (
 seats: BillingSubscriptionItemSeatsJSON,
): BillingSubscriptionItemSeats => ({
 quantity: seats.quantity,
 tiers: seats.tiers
 ? seats.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 }))
 : undefined,
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(backend): Update Subscription and SubscriptionItem resources#9196

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 2 commits into

from

Jul 30, 2026
 Merged


fix(backend): Update Subscription and SubscriptionItem resources
#9196
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1cbd099

fix(backend): Update Subscription and SubscriptionItem resources


dstaley Jul 17, 2026
d40a9c3

lint: sort imports


dstaley Jul 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/tame-bats-tell.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

Update fields for BillingSubscription and BillingSubscriptionItem

Comment on lines

+2
 to 
+5

@coderabbitaicoderabbitaiBotJul 17, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bashset -euo pipefail
cat packages/backend/package.json
rg -n -C 3 '\b(BillingSubscription|BillingSubscriptionItem)\b' packages/backend/src
Repository: clerk/javascript
Length of output: 24693
🏁 Script executed:
#!/bin/bashset -euo pipefail
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscription.ts
printf'\n---\n'
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscriptionItem.ts
printf'\n---\n'
sed -n '140,190p' packages/backend/src/index.ts
printf'\n---\n'
sed -n '1,80p' .changeset/tame-bats-tell.md
Repository: clerk/javascript
Length of output: 10343
Require a major changeset for the Billing API surfaceBillingSubscription and BillingSubscriptionItem are exported from @clerk/backend, so the constructor shape and nextPayment.amount type change are breaking API changes. Update this changeset to major and add migration guidance.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/tame-bats-tell.md around lines 2 - 5, Update the changeset entry
for `@clerk/backend` from minor to major to reflect the breaking
BillingSubscription and BillingSubscriptionItem API changes, and add migration
guidance covering the constructor shape and nextPayment.amount type updates.

Source: Coding guidelines

21 changes: 14 additions & 7 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { BillingMoneyAmount } from '@clerk/shared/types';
import type { BillingMoneyAmount, BillingPerUnitTotal, BillingTotals } from '@clerk/shared/types';

import { billingMoneyAmountFromJSON, billingPerUnitTotalsFromJSON, billingTotalsFromJSON } from '../../util/billing';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

Expand All@@ -12,6 +13,8 @@ export class BillingSubscription {
 constructor(
 /** The unique identifier for the Subscription. */
 readonly id: string,
 /** The ID of the instance this Subscription belongs to. */
 readonly instanceId: string,
 /** The current status of the Subscription. */
 readonly status: BillingSubscriptionJSON['status'],
 /** The ID of the payer for this Subscription. */
Expand All@@ -32,6 +35,10 @@ export class BillingSubscription {
 date: number;
 /** The amount of the next payment. */
 amount: BillingMoneyAmount;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 } | null,
 /** Whether the payer is eligible for a free trial. */
 readonly eligibleForFreeTrial: boolean,
Expand All@@ -41,17 +48,17 @@ export class BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
 amount: {
 amount: data.next_payment.amount.amount,
 amountFormatted: data.next_payment.amount.amount_formatted,
 currency: data.next_payment.amount.currency,
 currencySymbol: data.next_payment.amount.currency_symbol,
 },
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : null;

 return new BillingSubscription(
 data.id,
 data.instance_id,
 data.status,
 data.payer_id,
 data.created_at,
Expand Down

60 changes: 40 additions & 20 deletions
packages/backend/src/api/resources/CommerceSubscriptionItem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/shared/types';
import type {
 BillingMoneyAmount,
 BillingPerUnitTotal,
 BillingSubscriptionItemSeats,
 BillingTotals,
} from '@clerk/shared/types';

import {
 billingMoneyAmountFromJSON,
 billingPerUnitTotalsFromJSON,
 billingSubscriptionItemSeatsFromJSON,
 billingTotalsFromJSON,
} from '../../util/billing';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

Expand All@@ -12,6 +23,8 @@ export class BillingSubscriptionItem {
 constructor(
 /** The unique identifier for the Subscription Item. */
 readonly id: string,
 /** The ID of the instance this Subscription Item belongs to. */
 readonly instanceId: string,
 /** The status of the Subscription Item. */
 readonly status: BillingSubscriptionItemJSON['status'],
 /** The period of the Plan associated with this Subscription Item. */
Expand All@@ -22,9 +35,13 @@ export class BillingSubscriptionItem {
 readonly nextPayment:
 | {
 /** The amount of the next payment. */
 amount: number;
 amount: BillingMoneyAmount;
 /** The Unix timestamp (milliseconds) of when the next payment is scheduled. */
 date: number;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 }
 | null
 | undefined,
Expand All@@ -34,6 +51,8 @@ export class BillingSubscriptionItem {
 readonly plan: BillingPlan | null,
 /** The ID of the Plan associated with this Subscription Item. */
 readonly planId: string | null,
 /** The ID of the price associated with this Subscription Item. */
 readonly priceId: string | null,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was created. */
 readonly createdAt: number,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was last updated. */
Expand All@@ -49,36 +68,36 @@ export class BillingSubscriptionItem {
 /** The ID of the payer for this Subscription Item. */
 readonly payerId: string | undefined,
 /** Whether this Subscription Item is currently in a free trial period. */
 readonly isFreeTrial?: boolean,
 readonly isFreeTrial: boolean,
 /** The lifetime amount paid for this Subscription Item. */
 readonly lifetimePaid?: BillingMoneyAmount,
 /** Seat entitlement details for organization subscription items with seat-based billing. */
 readonly seats?: BillingSubscriptionItemSeats,
 ) {}

 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
 if (!amount) {
 return amount;
 }

 return {
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
 };
 }
 const nextPayment = data.next_payment
 ? {
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 date: data.next_payment.date,
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : data.next_payment;

 return new BillingSubscriptionItem(
 data.id,
 data.instance_id,
 data.status,
 data.plan_period,
 data.period_start,
data.next_payment,
formatAmountJSON(data.amount) ?? undefined,
nextPayment,
data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined,
 data.plan ? BillingPlan.fromJSON(data.plan) : null,
 data.plan_id ?? null,
 data.price_id ?? null,
 data.created_at,
 data.updated_at,
 data.period_end,
Expand All@@ -87,7 +106,8 @@ export class BillingSubscriptionItem {
 data.ended_at,
 data.payer_id,
 data.is_free_trial,
 formatAmountJSON(data.lifetime_paid) ?? undefined,
 data.lifetime_paid ? billingMoneyAmountFromJSON(data.lifetime_paid) : undefined,
 data.seats ? billingSubscriptionItemSeatsFromJSON(data.seats) : undefined,
 );
 }
}

27 changes: 19 additions & 8 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import type { LastAuthenticationStrategy, SignUpStatus, VerificationStatus } from '@clerk/shared/types';
import type {
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemNextPaymentJSON,
 BillingSubscriptionItemSeatsJSON,
 BillingTotalsJSON as SharedBillingTotalsJSON,
 LastAuthenticationStrategy,
 SignUpStatus,
 VerificationStatus,
} from '@clerk/shared/types';

import type {
 ActorTokenStatus,
Expand DownExpand Up@@ -1006,25 +1014,25 @@ type BillingSubscriptionItemStatus =
 */
export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscriptionItem;
 instance_id: string;
 status: BillingSubscriptionItemStatus;
 plan_period: 'month' | 'annual';
 payer_id?: string;
 price_id?: string;
 period_start: number;
 period_end: number | null;
 is_free_trial?: boolean;
 is_free_trial: boolean;
 ended_at: number | null;
 created_at: number;
 updated_at: number;
 canceled_at: number | null;
 past_due_at: number | null;
 lifetime_paid: BillingMoneyAmountJSON | null;
 next_payment?: {
 amount: number;
 date: number;
 } | null;
 amount: BillingMoneyAmountJSON;
 lifetime_paid?: BillingMoneyAmountJSON | null;
 next_payment?: BillingSubscriptionItemNextPaymentJSON | null;
 amount?: BillingMoneyAmountJSON | null;
 plan?: BillingPlanJSON | null;
 plan_id?: string | null;
 seats?: BillingSubscriptionItemSeatsJSON;
}

/**
Expand DownExpand Up@@ -1127,6 +1135,7 @@ export interface BillingSubscriptionWebhookEventJSON extends ClerkResourceJSON {

export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscription;
 instance_id: string;
 status: 'active' | 'past_due' | 'canceled' | 'ended' | 'abandoned' | 'incomplete';
 payer_id: string;
 created_at: number;
Expand All@@ -1137,6 +1146,8 @@ export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 next_payment?: {
 date: number;
 amount: BillingMoneyAmountJSON;
 per_unit_totals?: BillingPerUnitTotalJSON[];
 totals?: SharedBillingTotalsJSON;
 };
 eligible_for_free_trial?: boolean;
}
Expand Down

105 changes: 105 additions & 0 deletions
packages/backend/src/util/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type {
 BillingCredits,
 BillingCreditsJSON,
 BillingDiscounts,
 BillingDiscountsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingPeriodTotals,
 BillingPeriodTotalsJSON,
 BillingPerUnitTotal,
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemSeats,
 BillingSubscriptionItemSeatsJSON,
 BillingTotals,
 BillingTotalsJSON,
} from '@clerk/shared/types';

export const billingMoneyAmountFromJSON = (amount: BillingMoneyAmountJSON): BillingMoneyAmount => ({
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
});

export const billingPerUnitTotalsFromJSON = (perUnitTotals: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] =>
 perUnitTotals.map(perUnitTotal => ({
 name: perUnitTotal.name,
 blockSize: perUnitTotal.block_size,
 tiers: perUnitTotal.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 })),
 }));

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

const billingDiscountsFromJSON = (discounts: BillingDiscountsJSON): BillingDiscounts => ({
 proration: discounts.proration
 ? {
 amount: billingMoneyAmountFromJSON(discounts.proration.amount),
 cycleDaysPassed: discounts.proration.cycle_days_passed,
 cycleDaysTotal: discounts.proration.cycle_days_total,
 cyclePassedPercent: discounts.proration.cycle_passed_percent,
 }
 : null,
 total: billingMoneyAmountFromJSON(discounts.total),
});

const billingPeriodTotalsFromJSON = (totals: BillingPeriodTotalsJSON): BillingPeriodTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: billingMoneyAmountFromJSON(totals.base_fee),
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
});

export const billingTotalsFromJSON = (totals: BillingTotalsJSON): BillingTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: totals.base_fee ? billingMoneyAmountFromJSON(totals.base_fee) : null,
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 totalDueAfterFreeTrial: totals.total_due_after_free_trial
 ? billingMoneyAmountFromJSON(totals.total_due_after_free_trial)
 : totals.total_due_after_free_trial,
 credit: totals.credit ? billingMoneyAmountFromJSON(totals.credit) : totals.credit,
 credits: totals.credits ? billingCreditsFromJSON(totals.credits) : null,
 discounts: totals.discounts ? billingDiscountsFromJSON(totals.discounts) : null,
 pastDue: totals.past_due ? billingMoneyAmountFromJSON(totals.past_due) : totals.past_due,
 totalDueNow: totals.total_due_now ? billingMoneyAmountFromJSON(totals.total_due_now) : undefined,
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
 totalsDuePerPeriod: totals.totals_due_per_period
 ? billingPeriodTotalsFromJSON(totals.totals_due_per_period)
 : undefined,
 totalDuePerPeriod: totals.total_due_per_period ? billingMoneyAmountFromJSON(totals.total_due_per_period) : undefined,
});

export const billingSubscriptionItemSeatsFromJSON = (
 seats: BillingSubscriptionItemSeatsJSON,
): BillingSubscriptionItemSeats => ({
 quantity: seats.quantity,
 tiers: seats.tiers
 ? seats.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 }))
 : undefined,
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(backend): Update Subscription and SubscriptionItem resources#9196

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 2 commits into

from

Jul 30, 2026
 Merged


fix(backend): Update Subscription and SubscriptionItem resources
#9196
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1cbd099

fix(backend): Update Subscription and SubscriptionItem resources


dstaley Jul 17, 2026
d40a9c3

lint: sort imports


dstaley Jul 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/tame-bats-tell.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

Update fields for BillingSubscription and BillingSubscriptionItem

Comment on lines

+2
 to 
+5

@coderabbitaicoderabbitaiBotJul 17, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bashset -euo pipefail
cat packages/backend/package.json
rg -n -C 3 '\b(BillingSubscription|BillingSubscriptionItem)\b' packages/backend/src
Repository: clerk/javascript
Length of output: 24693
🏁 Script executed:
#!/bin/bashset -euo pipefail
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscription.ts
printf'\n---\n'
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscriptionItem.ts
printf'\n---\n'
sed -n '140,190p' packages/backend/src/index.ts
printf'\n---\n'
sed -n '1,80p' .changeset/tame-bats-tell.md
Repository: clerk/javascript
Length of output: 10343
Require a major changeset for the Billing API surfaceBillingSubscription and BillingSubscriptionItem are exported from @clerk/backend, so the constructor shape and nextPayment.amount type change are breaking API changes. Update this changeset to major and add migration guidance.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/tame-bats-tell.md around lines 2 - 5, Update the changeset entry
for `@clerk/backend` from minor to major to reflect the breaking
BillingSubscription and BillingSubscriptionItem API changes, and add migration
guidance covering the constructor shape and nextPayment.amount type updates.

Source: Coding guidelines

21 changes: 14 additions & 7 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { BillingMoneyAmount } from '@clerk/shared/types';
import type { BillingMoneyAmount, BillingPerUnitTotal, BillingTotals } from '@clerk/shared/types';

import { billingMoneyAmountFromJSON, billingPerUnitTotalsFromJSON, billingTotalsFromJSON } from '../../util/billing';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

Expand All@@ -12,6 +13,8 @@ export class BillingSubscription {
 constructor(
 /** The unique identifier for the Subscription. */
 readonly id: string,
 /** The ID of the instance this Subscription belongs to. */
 readonly instanceId: string,
 /** The current status of the Subscription. */
 readonly status: BillingSubscriptionJSON['status'],
 /** The ID of the payer for this Subscription. */
Expand All@@ -32,6 +35,10 @@ export class BillingSubscription {
 date: number;
 /** The amount of the next payment. */
 amount: BillingMoneyAmount;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 } | null,
 /** Whether the payer is eligible for a free trial. */
 readonly eligibleForFreeTrial: boolean,
Expand All@@ -41,17 +48,17 @@ export class BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
 amount: {
 amount: data.next_payment.amount.amount,
 amountFormatted: data.next_payment.amount.amount_formatted,
 currency: data.next_payment.amount.currency,
 currencySymbol: data.next_payment.amount.currency_symbol,
 },
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : null;

 return new BillingSubscription(
 data.id,
 data.instance_id,
 data.status,
 data.payer_id,
 data.created_at,
Expand Down

60 changes: 40 additions & 20 deletions
packages/backend/src/api/resources/CommerceSubscriptionItem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/shared/types';
import type {
 BillingMoneyAmount,
 BillingPerUnitTotal,
 BillingSubscriptionItemSeats,
 BillingTotals,
} from '@clerk/shared/types';

import {
 billingMoneyAmountFromJSON,
 billingPerUnitTotalsFromJSON,
 billingSubscriptionItemSeatsFromJSON,
 billingTotalsFromJSON,
} from '../../util/billing';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

Expand All@@ -12,6 +23,8 @@ export class BillingSubscriptionItem {
 constructor(
 /** The unique identifier for the Subscription Item. */
 readonly id: string,
 /** The ID of the instance this Subscription Item belongs to. */
 readonly instanceId: string,
 /** The status of the Subscription Item. */
 readonly status: BillingSubscriptionItemJSON['status'],
 /** The period of the Plan associated with this Subscription Item. */
Expand All@@ -22,9 +35,13 @@ export class BillingSubscriptionItem {
 readonly nextPayment:
 | {
 /** The amount of the next payment. */
 amount: number;
 amount: BillingMoneyAmount;
 /** The Unix timestamp (milliseconds) of when the next payment is scheduled. */
 date: number;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 }
 | null
 | undefined,
Expand All@@ -34,6 +51,8 @@ export class BillingSubscriptionItem {
 readonly plan: BillingPlan | null,
 /** The ID of the Plan associated with this Subscription Item. */
 readonly planId: string | null,
 /** The ID of the price associated with this Subscription Item. */
 readonly priceId: string | null,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was created. */
 readonly createdAt: number,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was last updated. */
Expand All@@ -49,36 +68,36 @@ export class BillingSubscriptionItem {
 /** The ID of the payer for this Subscription Item. */
 readonly payerId: string | undefined,
 /** Whether this Subscription Item is currently in a free trial period. */
 readonly isFreeTrial?: boolean,
 readonly isFreeTrial: boolean,
 /** The lifetime amount paid for this Subscription Item. */
 readonly lifetimePaid?: BillingMoneyAmount,
 /** Seat entitlement details for organization subscription items with seat-based billing. */
 readonly seats?: BillingSubscriptionItemSeats,
 ) {}

 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
 if (!amount) {
 return amount;
 }

 return {
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
 };
 }
 const nextPayment = data.next_payment
 ? {
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 date: data.next_payment.date,
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : data.next_payment;

 return new BillingSubscriptionItem(
 data.id,
 data.instance_id,
 data.status,
 data.plan_period,
 data.period_start,
data.next_payment,
formatAmountJSON(data.amount) ?? undefined,
nextPayment,
data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined,
 data.plan ? BillingPlan.fromJSON(data.plan) : null,
 data.plan_id ?? null,
 data.price_id ?? null,
 data.created_at,
 data.updated_at,
 data.period_end,
Expand All@@ -87,7 +106,8 @@ export class BillingSubscriptionItem {
 data.ended_at,
 data.payer_id,
 data.is_free_trial,
 formatAmountJSON(data.lifetime_paid) ?? undefined,
 data.lifetime_paid ? billingMoneyAmountFromJSON(data.lifetime_paid) : undefined,
 data.seats ? billingSubscriptionItemSeatsFromJSON(data.seats) : undefined,
 );
 }
}

27 changes: 19 additions & 8 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import type { LastAuthenticationStrategy, SignUpStatus, VerificationStatus } from '@clerk/shared/types';
import type {
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemNextPaymentJSON,
 BillingSubscriptionItemSeatsJSON,
 BillingTotalsJSON as SharedBillingTotalsJSON,
 LastAuthenticationStrategy,
 SignUpStatus,
 VerificationStatus,
} from '@clerk/shared/types';

import type {
 ActorTokenStatus,
Expand DownExpand Up@@ -1006,25 +1014,25 @@ type BillingSubscriptionItemStatus =
 */
export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscriptionItem;
 instance_id: string;
 status: BillingSubscriptionItemStatus;
 plan_period: 'month' | 'annual';
 payer_id?: string;
 price_id?: string;
 period_start: number;
 period_end: number | null;
 is_free_trial?: boolean;
 is_free_trial: boolean;
 ended_at: number | null;
 created_at: number;
 updated_at: number;
 canceled_at: number | null;
 past_due_at: number | null;
 lifetime_paid: BillingMoneyAmountJSON | null;
 next_payment?: {
 amount: number;
 date: number;
 } | null;
 amount: BillingMoneyAmountJSON;
 lifetime_paid?: BillingMoneyAmountJSON | null;
 next_payment?: BillingSubscriptionItemNextPaymentJSON | null;
 amount?: BillingMoneyAmountJSON | null;
 plan?: BillingPlanJSON | null;
 plan_id?: string | null;
 seats?: BillingSubscriptionItemSeatsJSON;
}

/**
Expand DownExpand Up@@ -1127,6 +1135,7 @@ export interface BillingSubscriptionWebhookEventJSON extends ClerkResourceJSON {

export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscription;
 instance_id: string;
 status: 'active' | 'past_due' | 'canceled' | 'ended' | 'abandoned' | 'incomplete';
 payer_id: string;
 created_at: number;
Expand All@@ -1137,6 +1146,8 @@ export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 next_payment?: {
 date: number;
 amount: BillingMoneyAmountJSON;
 per_unit_totals?: BillingPerUnitTotalJSON[];
 totals?: SharedBillingTotalsJSON;
 };
 eligible_for_free_trial?: boolean;
}
Expand Down

105 changes: 105 additions & 0 deletions
packages/backend/src/util/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type {
 BillingCredits,
 BillingCreditsJSON,
 BillingDiscounts,
 BillingDiscountsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingPeriodTotals,
 BillingPeriodTotalsJSON,
 BillingPerUnitTotal,
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemSeats,
 BillingSubscriptionItemSeatsJSON,
 BillingTotals,
 BillingTotalsJSON,
} from '@clerk/shared/types';

export const billingMoneyAmountFromJSON = (amount: BillingMoneyAmountJSON): BillingMoneyAmount => ({
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
});

export const billingPerUnitTotalsFromJSON = (perUnitTotals: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] =>
 perUnitTotals.map(perUnitTotal => ({
 name: perUnitTotal.name,
 blockSize: perUnitTotal.block_size,
 tiers: perUnitTotal.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 })),
 }));

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

const billingDiscountsFromJSON = (discounts: BillingDiscountsJSON): BillingDiscounts => ({
 proration: discounts.proration
 ? {
 amount: billingMoneyAmountFromJSON(discounts.proration.amount),
 cycleDaysPassed: discounts.proration.cycle_days_passed,
 cycleDaysTotal: discounts.proration.cycle_days_total,
 cyclePassedPercent: discounts.proration.cycle_passed_percent,
 }
 : null,
 total: billingMoneyAmountFromJSON(discounts.total),
});

const billingPeriodTotalsFromJSON = (totals: BillingPeriodTotalsJSON): BillingPeriodTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: billingMoneyAmountFromJSON(totals.base_fee),
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
});

export const billingTotalsFromJSON = (totals: BillingTotalsJSON): BillingTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: totals.base_fee ? billingMoneyAmountFromJSON(totals.base_fee) : null,
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 totalDueAfterFreeTrial: totals.total_due_after_free_trial
 ? billingMoneyAmountFromJSON(totals.total_due_after_free_trial)
 : totals.total_due_after_free_trial,
 credit: totals.credit ? billingMoneyAmountFromJSON(totals.credit) : totals.credit,
 credits: totals.credits ? billingCreditsFromJSON(totals.credits) : null,
 discounts: totals.discounts ? billingDiscountsFromJSON(totals.discounts) : null,
 pastDue: totals.past_due ? billingMoneyAmountFromJSON(totals.past_due) : totals.past_due,
 totalDueNow: totals.total_due_now ? billingMoneyAmountFromJSON(totals.total_due_now) : undefined,
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
 totalsDuePerPeriod: totals.totals_due_per_period
 ? billingPeriodTotalsFromJSON(totals.totals_due_per_period)
 : undefined,
 totalDuePerPeriod: totals.total_due_per_period ? billingMoneyAmountFromJSON(totals.total_due_per_period) : undefined,
});

export const billingSubscriptionItemSeatsFromJSON = (
 seats: BillingSubscriptionItemSeatsJSON,
): BillingSubscriptionItemSeats => ({
 quantity: seats.quantity,
 tiers: seats.tiers
 ? seats.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 }))
 : undefined,
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(backend): Update Subscription and SubscriptionItem resources#9196

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

dstaley
merged 2 commits into

from

Jul 30, 2026
 Merged


fix(backend): Update Subscription and SubscriptionItem resources
#9196
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1cbd099

fix(backend): Update Subscription and SubscriptionItem resources


dstaley Jul 17, 2026
d40a9c3

lint: sort imports


dstaley Jul 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/tame-bats-tell.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

Update fields for BillingSubscription and BillingSubscriptionItem

Comment on lines

+2
 to 
+5

@coderabbitaicoderabbitaiBotJul 17, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bashset -euo pipefail
cat packages/backend/package.json
rg -n -C 3 '\b(BillingSubscription|BillingSubscriptionItem)\b' packages/backend/src
Repository: clerk/javascript
Length of output: 24693
🏁 Script executed:
#!/bin/bashset -euo pipefail
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscription.ts
printf'\n---\n'
sed -n '1,140p' packages/backend/src/api/resources/CommerceSubscriptionItem.ts
printf'\n---\n'
sed -n '140,190p' packages/backend/src/index.ts
printf'\n---\n'
sed -n '1,80p' .changeset/tame-bats-tell.md
Repository: clerk/javascript
Length of output: 10343
Require a major changeset for the Billing API surfaceBillingSubscription and BillingSubscriptionItem are exported from @clerk/backend, so the constructor shape and nextPayment.amount type change are breaking API changes. Update this changeset to major and add migration guidance.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/tame-bats-tell.md around lines 2 - 5, Update the changeset entry
for `@clerk/backend` from minor to major to reflect the breaking
BillingSubscription and BillingSubscriptionItem API changes, and add migration
guidance covering the constructor shape and nextPayment.amount type updates.

Source: Coding guidelines

21 changes: 14 additions & 7 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { BillingMoneyAmount } from '@clerk/shared/types';
import type { BillingMoneyAmount, BillingPerUnitTotal, BillingTotals } from '@clerk/shared/types';

import { billingMoneyAmountFromJSON, billingPerUnitTotalsFromJSON, billingTotalsFromJSON } from '../../util/billing';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

Expand All@@ -12,6 +13,8 @@ export class BillingSubscription {
 constructor(
 /** The unique identifier for the Subscription. */
 readonly id: string,
 /** The ID of the instance this Subscription belongs to. */
 readonly instanceId: string,
 /** The current status of the Subscription. */
 readonly status: BillingSubscriptionJSON['status'],
 /** The ID of the payer for this Subscription. */
Expand All@@ -32,6 +35,10 @@ export class BillingSubscription {
 date: number;
 /** The amount of the next payment. */
 amount: BillingMoneyAmount;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 } | null,
 /** Whether the payer is eligible for a free trial. */
 readonly eligibleForFreeTrial: boolean,
Expand All@@ -41,17 +48,17 @@ export class BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
 amount: {
 amount: data.next_payment.amount.amount,
 amountFormatted: data.next_payment.amount.amount_formatted,
 currency: data.next_payment.amount.currency,
 currencySymbol: data.next_payment.amount.currency_symbol,
 },
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : null;

 return new BillingSubscription(
 data.id,
 data.instance_id,
 data.status,
 data.payer_id,
 data.created_at,
Expand Down

60 changes: 40 additions & 20 deletions
packages/backend/src/api/resources/CommerceSubscriptionItem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/shared/types';
import type {
 BillingMoneyAmount,
 BillingPerUnitTotal,
 BillingSubscriptionItemSeats,
 BillingTotals,
} from '@clerk/shared/types';

import {
 billingMoneyAmountFromJSON,
 billingPerUnitTotalsFromJSON,
 billingSubscriptionItemSeatsFromJSON,
 billingTotalsFromJSON,
} from '../../util/billing';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

Expand All@@ -12,6 +23,8 @@ export class BillingSubscriptionItem {
 constructor(
 /** The unique identifier for the Subscription Item. */
 readonly id: string,
 /** The ID of the instance this Subscription Item belongs to. */
 readonly instanceId: string,
 /** The status of the Subscription Item. */
 readonly status: BillingSubscriptionItemJSON['status'],
 /** The period of the Plan associated with this Subscription Item. */
Expand All@@ -22,9 +35,13 @@ export class BillingSubscriptionItem {
 readonly nextPayment:
 | {
 /** The amount of the next payment. */
 amount: number;
 amount: BillingMoneyAmount;
 /** The Unix timestamp (milliseconds) of when the next payment is scheduled. */
 date: number;
 /** The per-unit cost breakdown for the next payment. */
 perUnitTotals?: BillingPerUnitTotal[];
 /** The full cost breakdown for the next payment. */
 totals?: BillingTotals;
 }
 | null
 | undefined,
Expand All@@ -34,6 +51,8 @@ export class BillingSubscriptionItem {
 readonly plan: BillingPlan | null,
 /** The ID of the Plan associated with this Subscription Item. */
 readonly planId: string | null,
 /** The ID of the price associated with this Subscription Item. */
 readonly priceId: string | null,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was created. */
 readonly createdAt: number,
 /** The Unix timestamp (milliseconds) of when the Subscription Item was last updated. */
Expand All@@ -49,36 +68,36 @@ export class BillingSubscriptionItem {
 /** The ID of the payer for this Subscription Item. */
 readonly payerId: string | undefined,
 /** Whether this Subscription Item is currently in a free trial period. */
 readonly isFreeTrial?: boolean,
 readonly isFreeTrial: boolean,
 /** The lifetime amount paid for this Subscription Item. */
 readonly lifetimePaid?: BillingMoneyAmount,
 /** Seat entitlement details for organization subscription items with seat-based billing. */
 readonly seats?: BillingSubscriptionItemSeats,
 ) {}

 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
 if (!amount) {
 return amount;
 }

 return {
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
 };
 }
 const nextPayment = data.next_payment
 ? {
 amount: billingMoneyAmountFromJSON(data.next_payment.amount),
 date: data.next_payment.date,
 perUnitTotals: data.next_payment.per_unit_totals
 ? billingPerUnitTotalsFromJSON(data.next_payment.per_unit_totals)
 : undefined,
 totals: data.next_payment.totals ? billingTotalsFromJSON(data.next_payment.totals) : undefined,
 }
 : data.next_payment;

 return new BillingSubscriptionItem(
 data.id,
 data.instance_id,
 data.status,
 data.plan_period,
 data.period_start,
data.next_payment,
formatAmountJSON(data.amount) ?? undefined,
nextPayment,
data.amount ? billingMoneyAmountFromJSON(data.amount) : undefined,
 data.plan ? BillingPlan.fromJSON(data.plan) : null,
 data.plan_id ?? null,
 data.price_id ?? null,
 data.created_at,
 data.updated_at,
 data.period_end,
Expand All@@ -87,7 +106,8 @@ export class BillingSubscriptionItem {
 data.ended_at,
 data.payer_id,
 data.is_free_trial,
 formatAmountJSON(data.lifetime_paid) ?? undefined,
 data.lifetime_paid ? billingMoneyAmountFromJSON(data.lifetime_paid) : undefined,
 data.seats ? billingSubscriptionItemSeatsFromJSON(data.seats) : undefined,
 );
 }
}

27 changes: 19 additions & 8 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import type { LastAuthenticationStrategy, SignUpStatus, VerificationStatus } from '@clerk/shared/types';
import type {
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemNextPaymentJSON,
 BillingSubscriptionItemSeatsJSON,
 BillingTotalsJSON as SharedBillingTotalsJSON,
 LastAuthenticationStrategy,
 SignUpStatus,
 VerificationStatus,
} from '@clerk/shared/types';

import type {
 ActorTokenStatus,
Expand DownExpand Up@@ -1006,25 +1014,25 @@ type BillingSubscriptionItemStatus =
 */
export interface BillingSubscriptionItemJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscriptionItem;
 instance_id: string;
 status: BillingSubscriptionItemStatus;
 plan_period: 'month' | 'annual';
 payer_id?: string;
 price_id?: string;
 period_start: number;
 period_end: number | null;
 is_free_trial?: boolean;
 is_free_trial: boolean;
 ended_at: number | null;
 created_at: number;
 updated_at: number;
 canceled_at: number | null;
 past_due_at: number | null;
 lifetime_paid: BillingMoneyAmountJSON | null;
 next_payment?: {
 amount: number;
 date: number;
 } | null;
 amount: BillingMoneyAmountJSON;
 lifetime_paid?: BillingMoneyAmountJSON | null;
 next_payment?: BillingSubscriptionItemNextPaymentJSON | null;
 amount?: BillingMoneyAmountJSON | null;
 plan?: BillingPlanJSON | null;
 plan_id?: string | null;
 seats?: BillingSubscriptionItemSeatsJSON;
}

/**
Expand DownExpand Up@@ -1127,6 +1135,7 @@ export interface BillingSubscriptionWebhookEventJSON extends ClerkResourceJSON {

export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 object: typeof ObjectType.BillingSubscription;
 instance_id: string;
 status: 'active' | 'past_due' | 'canceled' | 'ended' | 'abandoned' | 'incomplete';
 payer_id: string;
 created_at: number;
Expand All@@ -1137,6 +1146,8 @@ export interface BillingSubscriptionJSON extends ClerkResourceJSON {
 next_payment?: {
 date: number;
 amount: BillingMoneyAmountJSON;
 per_unit_totals?: BillingPerUnitTotalJSON[];
 totals?: SharedBillingTotalsJSON;
 };
 eligible_for_free_trial?: boolean;
}
Expand Down

105 changes: 105 additions & 0 deletions
packages/backend/src/util/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type {
 BillingCredits,
 BillingCreditsJSON,
 BillingDiscounts,
 BillingDiscountsJSON,
 BillingMoneyAmount,
 BillingMoneyAmountJSON,
 BillingPeriodTotals,
 BillingPeriodTotalsJSON,
 BillingPerUnitTotal,
 BillingPerUnitTotalJSON,
 BillingSubscriptionItemSeats,
 BillingSubscriptionItemSeatsJSON,
 BillingTotals,
 BillingTotalsJSON,
} from '@clerk/shared/types';

export const billingMoneyAmountFromJSON = (amount: BillingMoneyAmountJSON): BillingMoneyAmount => ({
 amount: amount.amount,
 amountFormatted: amount.amount_formatted,
 currency: amount.currency,
 currencySymbol: amount.currency_symbol,
});

export const billingPerUnitTotalsFromJSON = (perUnitTotals: BillingPerUnitTotalJSON[]): BillingPerUnitTotal[] =>
 perUnitTotals.map(perUnitTotal => ({
 name: perUnitTotal.name,
 blockSize: perUnitTotal.block_size,
 tiers: perUnitTotal.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 })),
 }));

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

const billingDiscountsFromJSON = (discounts: BillingDiscountsJSON): BillingDiscounts => ({
 proration: discounts.proration
 ? {
 amount: billingMoneyAmountFromJSON(discounts.proration.amount),
 cycleDaysPassed: discounts.proration.cycle_days_passed,
 cycleDaysTotal: discounts.proration.cycle_days_total,
 cyclePassedPercent: discounts.proration.cycle_passed_percent,
 }
 : null,
 total: billingMoneyAmountFromJSON(discounts.total),
});

const billingPeriodTotalsFromJSON = (totals: BillingPeriodTotalsJSON): BillingPeriodTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: billingMoneyAmountFromJSON(totals.base_fee),
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
});

export const billingTotalsFromJSON = (totals: BillingTotalsJSON): BillingTotals => ({
 subtotal: billingMoneyAmountFromJSON(totals.subtotal),
 baseFee: totals.base_fee ? billingMoneyAmountFromJSON(totals.base_fee) : null,
 taxTotal: billingMoneyAmountFromJSON(totals.tax_total),
 grandTotal: billingMoneyAmountFromJSON(totals.grand_total),
 totalDueAfterFreeTrial: totals.total_due_after_free_trial
 ? billingMoneyAmountFromJSON(totals.total_due_after_free_trial)
 : totals.total_due_after_free_trial,
 credit: totals.credit ? billingMoneyAmountFromJSON(totals.credit) : totals.credit,
 credits: totals.credits ? billingCreditsFromJSON(totals.credits) : null,
 discounts: totals.discounts ? billingDiscountsFromJSON(totals.discounts) : null,
 pastDue: totals.past_due ? billingMoneyAmountFromJSON(totals.past_due) : totals.past_due,
 totalDueNow: totals.total_due_now ? billingMoneyAmountFromJSON(totals.total_due_now) : undefined,
 perUnitTotals: totals.per_unit_totals ? billingPerUnitTotalsFromJSON(totals.per_unit_totals) : undefined,
 totalsDuePerPeriod: totals.totals_due_per_period
 ? billingPeriodTotalsFromJSON(totals.totals_due_per_period)
 : undefined,
 totalDuePerPeriod: totals.total_due_per_period ? billingMoneyAmountFromJSON(totals.total_due_per_period) : undefined,
});

export const billingSubscriptionItemSeatsFromJSON = (
 seats: BillingSubscriptionItemSeatsJSON,
): BillingSubscriptionItemSeats => ({
 quantity: seats.quantity,
 tiers: seats.tiers
 ? seats.tiers.map(tier => ({
 quantity: tier.quantity,
 feePerBlock: billingMoneyAmountFromJSON(tier.fee_per_block),
 total: billingMoneyAmountFromJSON(tier.total),
 }))
 : undefined,
});
Loading