chore(backend): Rename commerce resources to billing resources#6812

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
panteliselef merged 1 commit into from
Sep 19, 2025
Merged

chore(backend): Rename commerce resources to billing resources #6812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/tricky-moments-film.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

[Billing Beta] Rename types and classes that contain commerce to use billing instead.
16 changes: 8 additions & 8 deletions .typedoc/__tests__/__snapshots__/file-structure.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -235,15 +235,15 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"backend/allowlist-identifier.mdx",
"backend/auth-object.mdx",
"backend/authenticate-request-options.mdx",
"backend/billing-payment-attempt-webhook-event-json.mdx",
"backend/billing-plan-json.mdx",
"backend/billing-plan.mdx",
"backend/billing-subscription-item-json.mdx",
"backend/billing-subscription-item-webhook-event-json.mdx",
"backend/billing-subscription-item.mdx",
"backend/billing-subscription-webhook-event-json.mdx",
"backend/billing-subscription.mdx",
"backend/client.mdx",
"backend/commerce-payment-attempt-webhook-event-json.mdx",
"backend/commerce-plan-json.mdx",
"backend/commerce-plan.mdx",
"backend/commerce-subscription-item-json.mdx",
"backend/commerce-subscription-item-webhook-event-json.mdx",
"backend/commerce-subscription-item.mdx",
"backend/commerce-subscription-webhook-event-json.mdx",
"backend/commerce-subscription.mdx",
"backend/email-address.mdx",
"backend/external-account.mdx",
"backend/feature.mdx",
Expand Down
16 changes: 8 additions & 8 deletions packages/backend/src/api/endpoints/BillingApi.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
import type { ClerkPaginationRequest } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { CommercePlan } from '../resources/CommercePlan';
import type { CommerceSubscription } from '../resources/CommerceSubscription';
import type { CommerceSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { BillingPlan } from '../resources/CommercePlan';
import type { BillingSubscription } from '../resources/CommerceSubscription';
import type { BillingSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import { AbstractAPI } from './AbstractApi';

Expand DownExpand Up@@ -36,7 +36,7 @@ export class BillingAPI extends AbstractAPI {
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
*/
public async getPlanList(params?: GetOrganizationListParams) {
return this.request<PaginatedResourceResponse<CommercePlan[]>>({
return this.request<PaginatedResourceResponse<BillingPlan[]>>({
method: 'GET',
path: joinPaths(basePath, 'plans'),
queryParams: params,
Expand All@@ -48,7 +48,7 @@ export class BillingAPI extends AbstractAPI {
*/
public async cancelSubscriptionItem(subscriptionItemId: string, params?: CancelSubscriptionItemParams) {
this.requireId(subscriptionItemId);
return this.request<CommerceSubscriptionItem>({
return this.request<BillingSubscriptionItem>({
method: 'DELETE',
path: joinPaths(basePath, 'subscription_items', subscriptionItemId),
queryParams: params,
Expand All@@ -63,7 +63,7 @@ export class BillingAPI extends AbstractAPI {
params: ExtendSubscriptionItemFreeTrialParams,
) {
this.requireId(subscriptionItemId);
return this.request<CommerceSubscriptionItem>({
return this.request<BillingSubscriptionItem>({
method: 'POST',
path: joinPaths('/billing', 'subscription_items', subscriptionItemId, 'extend_free_trial'),
bodyParams: params,
Expand All@@ -75,7 +75,7 @@ export class BillingAPI extends AbstractAPI {
*/
public async getOrganizationBillingSubscription(organizationId: string) {
this.requireId(organizationId);
return this.request<CommerceSubscription>({
return this.request<BillingSubscription>({
method: 'GET',
path: joinPaths(organizationBasePath, organizationId, 'billing', 'subscription'),
});
Expand All@@ -86,7 +86,7 @@ export class BillingAPI extends AbstractAPI {
*/
public async getUserBillingSubscription(userId: string) {
this.requireId(userId);
return this.request<CommerceSubscription>({
return this.request<BillingSubscription>({
method: 'GET',
path: joinPaths(userBasePath, userId, 'billing', 'subscription'),
});
Expand Down
12 changes: 6 additions & 6 deletions packages/backend/src/api/resources/CommercePlan.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount } from '@clerk/types';

import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';
import type { BillingPlanJSON } from './JSON';

/**
* The `CommercePlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
* The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
*
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
*/
export class CommercePlan {
export class BillingPlan {
constructor(
/**
* The unique identifier for the plan.
Expand DownExpand Up@@ -68,16 +68,16 @@ export class CommercePlan {
readonly features: Feature[],
) {}

static fromJSON(data: CommercePlanJSON): CommercePlan {
const formatAmountJSON = (fee: CommercePlanJSON['fee']) => {
static fromJSON(data: BillingPlanJSON): BillingPlan {
const formatAmountJSON = (fee: BillingPlanJSON['fee']) => {
return {
amount: fee.amount,
amountFormatted: fee.amount_formatted,
currency: fee.currency,
currencySymbol: fee.currency_symbol,
};
};
return new CommercePlan(
return new BillingPlan(
data.id,
data.product_id,
data.name,
Expand Down
22 changes: 11 additions & 11 deletions packages/backend/src/api/resources/CommerceSubscription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
import { type BillingMoneyAmount } from '@clerk/types';
import type { BillingMoneyAmount } from '@clerk/types';

import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import type { CommerceSubscriptionJSON } from './JSON';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

/**
* The `CommerceSubscription` object is similar to the [`CommerceSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `CommerceSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
* The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
*
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
*/
export class CommerceSubscription {
export class BillingSubscription {
constructor(
/**
* The unique identifier for the commerce subscription.
* The unique identifier for the billing subscription.
*/
readonly id: string,
/**
* The current status of the subscription.
*/
readonly status: CommerceSubscriptionJSON['status'],
readonly status: BillingSubscriptionJSON['status'],
/**
* The ID of the payer for this subscription.
*/
Expand All@@ -41,7 +41,7 @@ export class CommerceSubscription {
/**
* Array of subscription items in this subscription.
*/
readonly subscriptionItems: CommerceSubscriptionItem[],
readonly subscriptionItems: BillingSubscriptionItem[],
/**
* Information about the next scheduled payment.
*/
Expand All@@ -52,7 +52,7 @@ export class CommerceSubscription {
readonly eligibleForFreeTrial: boolean,
) {}

static fromJSON(data: CommerceSubscriptionJSON): CommerceSubscription {
static fromJSON(data: BillingSubscriptionJSON): BillingSubscription {
const nextPayment = data.next_payment
? {
date: data.next_payment.date,
Expand All@@ -65,15 +65,15 @@ export class CommerceSubscription {
}
: null;

return new CommerceSubscription(
return new BillingSubscription(
data.id,
data.status,
data.payer_id,
data.created_at,
data.updated_at,
data.active_at ?? null,
data.past_due_at ?? null,
data.subscription_items.map(item => CommerceSubscriptionItem.fromJSON(item)),
data.subscription_items.map(item => BillingSubscriptionItem.fromJSON(item)),
nextPayment,
data.eligible_for_free_trial ?? false,
);
Expand Down
18 changes: 9 additions & 9 deletions packages/backend/src/api/resources/CommerceSubscriptionItem.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/types';

import { CommercePlan } from './CommercePlan';
import type { CommerceSubscriptionItemJSON } from './JSON';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

/**
* The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `CommerceSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
* The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
*
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
*/
export class CommerceSubscriptionItem {
export class BillingSubscriptionItem {
constructor(
/**
* The unique identifier for the subscription item.
Expand All@@ -17,7 +17,7 @@ export class CommerceSubscriptionItem {
/**
* The status of the subscription item.
*/
readonly status: CommerceSubscriptionItemJSON['status'],
readonly status: BillingSubscriptionItemJSON['status'],
/**
* The plan period for the subscription item.
*/
Expand DownExpand Up@@ -46,7 +46,7 @@ export class CommerceSubscriptionItem {
/**
* The plan associated with this subscription item.
*/
readonly plan: CommercePlan,
readonly plan: BillingPlan,
/**
* The plan ID.
*/
Expand DownExpand Up@@ -89,7 +89,7 @@ export class CommerceSubscriptionItem {
readonly lifetimePaid?: BillingMoneyAmount | null,
) {}

static fromJSON(data: CommerceSubscriptionItemJSON): CommerceSubscriptionItem {
static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
function formatAmountJSON(
amount: BillingMoneyAmountJSON | null | undefined,
): BillingMoneyAmount | null | undefined {
Expand All@@ -105,14 +105,14 @@ export class CommerceSubscriptionItem {
};
}

return new CommerceSubscriptionItem(
return new BillingSubscriptionItem(
data.id,
data.status,
data.plan_period,
data.period_start,
data.next_payment,
formatAmountJSON(data.amount),
CommercePlan.fromJSON(data.plan),
BillingPlan.fromJSON(data.plan),
data.plan_id,
data.created_at,
data.updated_at,
Expand Down
18 changes: 9 additions & 9 deletions packages/backend/src/api/resources/Deserializer.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,9 @@ import {
User,
} from '.';
import { AccountlessApplication } from './AccountlessApplication';
import { CommercePlan } from './CommercePlan';
import { CommerceSubscription } from './CommerceSubscription';
import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import { BillingPlan } from './CommercePlan';
import { BillingSubscription } from './CommerceSubscription';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import { Feature } from './Feature';
import type { PaginatedResponseJSON } from './JSON';
import { ObjectType } from './JSON';
Expand DownExpand Up@@ -183,12 +183,12 @@ function jsonToObject(item: any): any {
return User.fromJSON(item);
case ObjectType.WaitlistEntry:
return WaitlistEntry.fromJSON(item);
case ObjectType.CommercePlan:
return CommercePlan.fromJSON(item);
case ObjectType.CommerceSubscription:
return CommerceSubscription.fromJSON(item);
case ObjectType.CommerceSubscriptionItem:
return CommerceSubscriptionItem.fromJSON(item);
case ObjectType.BillingPlan:
return BillingPlan.fromJSON(item);
case ObjectType.BillingSubscription:
return BillingSubscription.fromJSON(item);
case ObjectType.BillingSubscriptionItem:
return BillingSubscriptionItem.fromJSON(item);
case ObjectType.Feature:
return Feature.fromJSON(item);
default:
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
chore(backend): Rename commerce resources to billing resources#6812

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Sep 19, 2025
 Merged


chore(backend): Rename commerce resources to billing resources
#6812
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/tricky-moments-film.md

View file


Open in desktop

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

[Billing Beta] Rename types and classes that contain commerce to use billing instead.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -235,15 +235,15 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "backend/allowlist-identifier.mdx",
 "backend/auth-object.mdx",
 "backend/authenticate-request-options.mdx",
 "backend/billing-payment-attempt-webhook-event-json.mdx",
 "backend/billing-plan-json.mdx",
 "backend/billing-plan.mdx",
 "backend/billing-subscription-item-json.mdx",
 "backend/billing-subscription-item-webhook-event-json.mdx",
 "backend/billing-subscription-item.mdx",
 "backend/billing-subscription-webhook-event-json.mdx",
 "backend/billing-subscription.mdx",
 "backend/client.mdx",
 "backend/commerce-payment-attempt-webhook-event-json.mdx",
 "backend/commerce-plan-json.mdx",
 "backend/commerce-plan.mdx",
 "backend/commerce-subscription-item-json.mdx",
 "backend/commerce-subscription-item-webhook-event-json.mdx",
 "backend/commerce-subscription-item.mdx",
 "backend/commerce-subscription-webhook-event-json.mdx",
 "backend/commerce-subscription.mdx",
 "backend/email-address.mdx",
 "backend/external-account.mdx",
 "backend/feature.mdx",
Expand Down

16 changes: 8 additions & 8 deletions
packages/backend/src/api/endpoints/BillingApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
import type { ClerkPaginationRequest } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { CommercePlan } from '../resources/CommercePlan';
import type { CommerceSubscription } from '../resources/CommerceSubscription';
import type { CommerceSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { BillingPlan } from '../resources/CommercePlan';
import type { BillingSubscription } from '../resources/CommerceSubscription';
import type { BillingSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import { AbstractAPI } from './AbstractApi';

Expand DownExpand Up@@ -36,7 +36,7 @@ export class BillingAPI extends AbstractAPI {
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
 public async getPlanList(params?: GetOrganizationListParams) {
 return this.request<PaginatedResourceResponse<CommercePlan[]>>({
 return this.request<PaginatedResourceResponse<BillingPlan[]>>({
 method: 'GET',
 path: joinPaths(basePath, 'plans'),
 queryParams: params,
Expand All@@ -48,7 +48,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async cancelSubscriptionItem(subscriptionItemId: string, params?: CancelSubscriptionItemParams) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'DELETE',
 path: joinPaths(basePath, 'subscription_items', subscriptionItemId),
 queryParams: params,
Expand All@@ -63,7 +63,7 @@ export class BillingAPI extends AbstractAPI {
 params: ExtendSubscriptionItemFreeTrialParams,
 ) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'POST',
 path: joinPaths('/billing', 'subscription_items', subscriptionItemId, 'extend_free_trial'),
 bodyParams: params,
Expand All@@ -75,7 +75,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getOrganizationBillingSubscription(organizationId: string) {
 this.requireId(organizationId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(organizationBasePath, organizationId, 'billing', 'subscription'),
 });
Expand All@@ -86,7 +86,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getUserBillingSubscription(userId: string) {
 this.requireId(userId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(userBasePath, userId, 'billing', 'subscription'),
 });
Expand Down

12 changes: 6 additions & 6 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount } from '@clerk/types';

import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';
import type { BillingPlanJSON } from './JSON';

/**
 * The `CommercePlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommercePlan {
export class BillingPlan {
 constructor(
 /**
 * The unique identifier for the plan.
Expand DownExpand Up@@ -68,16 +68,16 @@ export class CommercePlan {
 readonly features: Feature[],
 ) {}

 static fromJSON(data: CommercePlanJSON): CommercePlan {
 const formatAmountJSON = (fee: CommercePlanJSON['fee']) => {
 static fromJSON(data: BillingPlanJSON): BillingPlan {
 const formatAmountJSON = (fee: BillingPlanJSON['fee']) => {
 return {
 amount: fee.amount,
 amountFormatted: fee.amount_formatted,
 currency: fee.currency,
 currencySymbol: fee.currency_symbol,
 };
 };
 return new CommercePlan(
 return new BillingPlan(
 data.id,
 data.product_id,
 data.name,
Expand Down

22 changes: 11 additions & 11 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
import { type BillingMoneyAmount } from '@clerk/types';
import type { BillingMoneyAmount } from '@clerk/types';

import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import type { CommerceSubscriptionJSON } from './JSON';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

/**
 * The `CommerceSubscription` object is similar to the [`CommerceSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `CommerceSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscription {
export class BillingSubscription {
 constructor(
 /**
 * The unique identifier for the commerce subscription.
 * The unique identifier for the billing subscription.
 */
 readonly id: string,
 /**
 * The current status of the subscription.
 */
 readonly status: CommerceSubscriptionJSON['status'],
 readonly status: BillingSubscriptionJSON['status'],
 /**
 * The ID of the payer for this subscription.
 */
Expand All@@ -41,7 +41,7 @@ export class CommerceSubscription {
 /**
 * Array of subscription items in this subscription.
 */
 readonly subscriptionItems: CommerceSubscriptionItem[],
 readonly subscriptionItems: BillingSubscriptionItem[],
 /**
 * Information about the next scheduled payment.
 */
Expand All@@ -52,7 +52,7 @@ export class CommerceSubscription {
 readonly eligibleForFreeTrial: boolean,
 ) {}

 static fromJSON(data: CommerceSubscriptionJSON): CommerceSubscription {
 static fromJSON(data: BillingSubscriptionJSON): BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
Expand All@@ -65,15 +65,15 @@ export class CommerceSubscription {
 }
 : null;

 return new CommerceSubscription(
 return new BillingSubscription(
 data.id,
 data.status,
 data.payer_id,
 data.created_at,
 data.updated_at,
 data.active_at ?? null,
 data.past_due_at ?? null,
 data.subscription_items.map(item => CommerceSubscriptionItem.fromJSON(item)),
 data.subscription_items.map(item => BillingSubscriptionItem.fromJSON(item)),
 nextPayment,
 data.eligible_for_free_trial ?? false,
 );
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/types';

import { CommercePlan } from './CommercePlan';
import type { CommerceSubscriptionItemJSON } from './JSON';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

/**
 * The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `CommerceSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscriptionItem {
export class BillingSubscriptionItem {
 constructor(
 /**
 * The unique identifier for the subscription item.
Expand All@@ -17,7 +17,7 @@ export class CommerceSubscriptionItem {
 /**
 * The status of the subscription item.
 */
 readonly status: CommerceSubscriptionItemJSON['status'],
 readonly status: BillingSubscriptionItemJSON['status'],
 /**
 * The plan period for the subscription item.
 */
Expand DownExpand Up@@ -46,7 +46,7 @@ export class CommerceSubscriptionItem {
 /**
 * The plan associated with this subscription item.
 */
 readonly plan: CommercePlan,
 readonly plan: BillingPlan,
 /**
 * The plan ID.
 */
Expand DownExpand Up@@ -89,7 +89,7 @@ export class CommerceSubscriptionItem {
 readonly lifetimePaid?: BillingMoneyAmount | null,
 ) {}

 static fromJSON(data: CommerceSubscriptionItemJSON): CommerceSubscriptionItem {
 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
Expand All@@ -105,14 +105,14 @@ export class CommerceSubscriptionItem {
 };
 }

 return new CommerceSubscriptionItem(
 return new BillingSubscriptionItem(
 data.id,
 data.status,
 data.plan_period,
 data.period_start,
 data.next_payment,
 formatAmountJSON(data.amount),
CommercePlan.fromJSON(data.plan),
BillingPlan.fromJSON(data.plan),
 data.plan_id,
 data.created_at,
 data.updated_at,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,9 @@ import {
 User,
} from '.';
import { AccountlessApplication } from './AccountlessApplication';
import { CommercePlan } from './CommercePlan';
import { CommerceSubscription } from './CommerceSubscription';
import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import { BillingPlan } from './CommercePlan';
import { BillingSubscription } from './CommerceSubscription';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import { Feature } from './Feature';
import type { PaginatedResponseJSON } from './JSON';
import { ObjectType } from './JSON';
Expand DownExpand Up@@ -183,12 +183,12 @@ function jsonToObject(item: any): any {
 return User.fromJSON(item);
 case ObjectType.WaitlistEntry:
 return WaitlistEntry.fromJSON(item);
 case ObjectType.CommercePlan:
 return CommercePlan.fromJSON(item);
 case ObjectType.CommerceSubscription:
 return CommerceSubscription.fromJSON(item);
 case ObjectType.CommerceSubscriptionItem:
 return CommerceSubscriptionItem.fromJSON(item);
 case ObjectType.BillingPlan:
 return BillingPlan.fromJSON(item);
 case ObjectType.BillingSubscription:
 return BillingSubscription.fromJSON(item);
 case ObjectType.BillingSubscriptionItem:
 return BillingSubscriptionItem.fromJSON(item);
 case ObjectType.Feature:
 return Feature.fromJSON(item);
 default:
Expand Down
Loading
Loading

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

Skip to content
chore(backend): Rename commerce resources to billing resources#6812

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Sep 19, 2025
 Merged


chore(backend): Rename commerce resources to billing resources
#6812
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/tricky-moments-film.md

View file


Open in desktop

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

[Billing Beta] Rename types and classes that contain commerce to use billing instead.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -235,15 +235,15 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "backend/allowlist-identifier.mdx",
 "backend/auth-object.mdx",
 "backend/authenticate-request-options.mdx",
 "backend/billing-payment-attempt-webhook-event-json.mdx",
 "backend/billing-plan-json.mdx",
 "backend/billing-plan.mdx",
 "backend/billing-subscription-item-json.mdx",
 "backend/billing-subscription-item-webhook-event-json.mdx",
 "backend/billing-subscription-item.mdx",
 "backend/billing-subscription-webhook-event-json.mdx",
 "backend/billing-subscription.mdx",
 "backend/client.mdx",
 "backend/commerce-payment-attempt-webhook-event-json.mdx",
 "backend/commerce-plan-json.mdx",
 "backend/commerce-plan.mdx",
 "backend/commerce-subscription-item-json.mdx",
 "backend/commerce-subscription-item-webhook-event-json.mdx",
 "backend/commerce-subscription-item.mdx",
 "backend/commerce-subscription-webhook-event-json.mdx",
 "backend/commerce-subscription.mdx",
 "backend/email-address.mdx",
 "backend/external-account.mdx",
 "backend/feature.mdx",
Expand Down

16 changes: 8 additions & 8 deletions
packages/backend/src/api/endpoints/BillingApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
import type { ClerkPaginationRequest } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { CommercePlan } from '../resources/CommercePlan';
import type { CommerceSubscription } from '../resources/CommerceSubscription';
import type { CommerceSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { BillingPlan } from '../resources/CommercePlan';
import type { BillingSubscription } from '../resources/CommerceSubscription';
import type { BillingSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import { AbstractAPI } from './AbstractApi';

Expand DownExpand Up@@ -36,7 +36,7 @@ export class BillingAPI extends AbstractAPI {
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
 public async getPlanList(params?: GetOrganizationListParams) {
 return this.request<PaginatedResourceResponse<CommercePlan[]>>({
 return this.request<PaginatedResourceResponse<BillingPlan[]>>({
 method: 'GET',
 path: joinPaths(basePath, 'plans'),
 queryParams: params,
Expand All@@ -48,7 +48,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async cancelSubscriptionItem(subscriptionItemId: string, params?: CancelSubscriptionItemParams) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'DELETE',
 path: joinPaths(basePath, 'subscription_items', subscriptionItemId),
 queryParams: params,
Expand All@@ -63,7 +63,7 @@ export class BillingAPI extends AbstractAPI {
 params: ExtendSubscriptionItemFreeTrialParams,
 ) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'POST',
 path: joinPaths('/billing', 'subscription_items', subscriptionItemId, 'extend_free_trial'),
 bodyParams: params,
Expand All@@ -75,7 +75,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getOrganizationBillingSubscription(organizationId: string) {
 this.requireId(organizationId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(organizationBasePath, organizationId, 'billing', 'subscription'),
 });
Expand All@@ -86,7 +86,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getUserBillingSubscription(userId: string) {
 this.requireId(userId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(userBasePath, userId, 'billing', 'subscription'),
 });
Expand Down

12 changes: 6 additions & 6 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount } from '@clerk/types';

import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';
import type { BillingPlanJSON } from './JSON';

/**
 * The `CommercePlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommercePlan {
export class BillingPlan {
 constructor(
 /**
 * The unique identifier for the plan.
Expand DownExpand Up@@ -68,16 +68,16 @@ export class CommercePlan {
 readonly features: Feature[],
 ) {}

 static fromJSON(data: CommercePlanJSON): CommercePlan {
 const formatAmountJSON = (fee: CommercePlanJSON['fee']) => {
 static fromJSON(data: BillingPlanJSON): BillingPlan {
 const formatAmountJSON = (fee: BillingPlanJSON['fee']) => {
 return {
 amount: fee.amount,
 amountFormatted: fee.amount_formatted,
 currency: fee.currency,
 currencySymbol: fee.currency_symbol,
 };
 };
 return new CommercePlan(
 return new BillingPlan(
 data.id,
 data.product_id,
 data.name,
Expand Down

22 changes: 11 additions & 11 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
import { type BillingMoneyAmount } from '@clerk/types';
import type { BillingMoneyAmount } from '@clerk/types';

import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import type { CommerceSubscriptionJSON } from './JSON';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

/**
 * The `CommerceSubscription` object is similar to the [`CommerceSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `CommerceSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscription {
export class BillingSubscription {
 constructor(
 /**
 * The unique identifier for the commerce subscription.
 * The unique identifier for the billing subscription.
 */
 readonly id: string,
 /**
 * The current status of the subscription.
 */
 readonly status: CommerceSubscriptionJSON['status'],
 readonly status: BillingSubscriptionJSON['status'],
 /**
 * The ID of the payer for this subscription.
 */
Expand All@@ -41,7 +41,7 @@ export class CommerceSubscription {
 /**
 * Array of subscription items in this subscription.
 */
 readonly subscriptionItems: CommerceSubscriptionItem[],
 readonly subscriptionItems: BillingSubscriptionItem[],
 /**
 * Information about the next scheduled payment.
 */
Expand All@@ -52,7 +52,7 @@ export class CommerceSubscription {
 readonly eligibleForFreeTrial: boolean,
 ) {}

 static fromJSON(data: CommerceSubscriptionJSON): CommerceSubscription {
 static fromJSON(data: BillingSubscriptionJSON): BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
Expand All@@ -65,15 +65,15 @@ export class CommerceSubscription {
 }
 : null;

 return new CommerceSubscription(
 return new BillingSubscription(
 data.id,
 data.status,
 data.payer_id,
 data.created_at,
 data.updated_at,
 data.active_at ?? null,
 data.past_due_at ?? null,
 data.subscription_items.map(item => CommerceSubscriptionItem.fromJSON(item)),
 data.subscription_items.map(item => BillingSubscriptionItem.fromJSON(item)),
 nextPayment,
 data.eligible_for_free_trial ?? false,
 );
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/types';

import { CommercePlan } from './CommercePlan';
import type { CommerceSubscriptionItemJSON } from './JSON';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

/**
 * The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `CommerceSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscriptionItem {
export class BillingSubscriptionItem {
 constructor(
 /**
 * The unique identifier for the subscription item.
Expand All@@ -17,7 +17,7 @@ export class CommerceSubscriptionItem {
 /**
 * The status of the subscription item.
 */
 readonly status: CommerceSubscriptionItemJSON['status'],
 readonly status: BillingSubscriptionItemJSON['status'],
 /**
 * The plan period for the subscription item.
 */
Expand DownExpand Up@@ -46,7 +46,7 @@ export class CommerceSubscriptionItem {
 /**
 * The plan associated with this subscription item.
 */
 readonly plan: CommercePlan,
 readonly plan: BillingPlan,
 /**
 * The plan ID.
 */
Expand DownExpand Up@@ -89,7 +89,7 @@ export class CommerceSubscriptionItem {
 readonly lifetimePaid?: BillingMoneyAmount | null,
 ) {}

 static fromJSON(data: CommerceSubscriptionItemJSON): CommerceSubscriptionItem {
 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
Expand All@@ -105,14 +105,14 @@ export class CommerceSubscriptionItem {
 };
 }

 return new CommerceSubscriptionItem(
 return new BillingSubscriptionItem(
 data.id,
 data.status,
 data.plan_period,
 data.period_start,
 data.next_payment,
 formatAmountJSON(data.amount),
CommercePlan.fromJSON(data.plan),
BillingPlan.fromJSON(data.plan),
 data.plan_id,
 data.created_at,
 data.updated_at,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,9 @@ import {
 User,
} from '.';
import { AccountlessApplication } from './AccountlessApplication';
import { CommercePlan } from './CommercePlan';
import { CommerceSubscription } from './CommerceSubscription';
import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import { BillingPlan } from './CommercePlan';
import { BillingSubscription } from './CommerceSubscription';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import { Feature } from './Feature';
import type { PaginatedResponseJSON } from './JSON';
import { ObjectType } from './JSON';
Expand DownExpand Up@@ -183,12 +183,12 @@ function jsonToObject(item: any): any {
 return User.fromJSON(item);
 case ObjectType.WaitlistEntry:
 return WaitlistEntry.fromJSON(item);
 case ObjectType.CommercePlan:
 return CommercePlan.fromJSON(item);
 case ObjectType.CommerceSubscription:
 return CommerceSubscription.fromJSON(item);
 case ObjectType.CommerceSubscriptionItem:
 return CommerceSubscriptionItem.fromJSON(item);
 case ObjectType.BillingPlan:
 return BillingPlan.fromJSON(item);
 case ObjectType.BillingSubscription:
 return BillingSubscription.fromJSON(item);
 case ObjectType.BillingSubscriptionItem:
 return BillingSubscriptionItem.fromJSON(item);
 case ObjectType.Feature:
 return Feature.fromJSON(item);
 default:
Expand Down
Loading
Loading

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

Skip to content
chore(backend): Rename commerce resources to billing resources#6812

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Sep 19, 2025
 Merged


chore(backend): Rename commerce resources to billing resources
#6812
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/tricky-moments-film.md

View file


Open in desktop

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

[Billing Beta] Rename types and classes that contain commerce to use billing instead.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -235,15 +235,15 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "backend/allowlist-identifier.mdx",
 "backend/auth-object.mdx",
 "backend/authenticate-request-options.mdx",
 "backend/billing-payment-attempt-webhook-event-json.mdx",
 "backend/billing-plan-json.mdx",
 "backend/billing-plan.mdx",
 "backend/billing-subscription-item-json.mdx",
 "backend/billing-subscription-item-webhook-event-json.mdx",
 "backend/billing-subscription-item.mdx",
 "backend/billing-subscription-webhook-event-json.mdx",
 "backend/billing-subscription.mdx",
 "backend/client.mdx",
 "backend/commerce-payment-attempt-webhook-event-json.mdx",
 "backend/commerce-plan-json.mdx",
 "backend/commerce-plan.mdx",
 "backend/commerce-subscription-item-json.mdx",
 "backend/commerce-subscription-item-webhook-event-json.mdx",
 "backend/commerce-subscription-item.mdx",
 "backend/commerce-subscription-webhook-event-json.mdx",
 "backend/commerce-subscription.mdx",
 "backend/email-address.mdx",
 "backend/external-account.mdx",
 "backend/feature.mdx",
Expand Down

16 changes: 8 additions & 8 deletions
packages/backend/src/api/endpoints/BillingApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
import type { ClerkPaginationRequest } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { CommercePlan } from '../resources/CommercePlan';
import type { CommerceSubscription } from '../resources/CommerceSubscription';
import type { CommerceSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { BillingPlan } from '../resources/CommercePlan';
import type { BillingSubscription } from '../resources/CommerceSubscription';
import type { BillingSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import { AbstractAPI } from './AbstractApi';

Expand DownExpand Up@@ -36,7 +36,7 @@ export class BillingAPI extends AbstractAPI {
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
 public async getPlanList(params?: GetOrganizationListParams) {
 return this.request<PaginatedResourceResponse<CommercePlan[]>>({
 return this.request<PaginatedResourceResponse<BillingPlan[]>>({
 method: 'GET',
 path: joinPaths(basePath, 'plans'),
 queryParams: params,
Expand All@@ -48,7 +48,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async cancelSubscriptionItem(subscriptionItemId: string, params?: CancelSubscriptionItemParams) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'DELETE',
 path: joinPaths(basePath, 'subscription_items', subscriptionItemId),
 queryParams: params,
Expand All@@ -63,7 +63,7 @@ export class BillingAPI extends AbstractAPI {
 params: ExtendSubscriptionItemFreeTrialParams,
 ) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'POST',
 path: joinPaths('/billing', 'subscription_items', subscriptionItemId, 'extend_free_trial'),
 bodyParams: params,
Expand All@@ -75,7 +75,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getOrganizationBillingSubscription(organizationId: string) {
 this.requireId(organizationId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(organizationBasePath, organizationId, 'billing', 'subscription'),
 });
Expand All@@ -86,7 +86,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getUserBillingSubscription(userId: string) {
 this.requireId(userId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(userBasePath, userId, 'billing', 'subscription'),
 });
Expand Down

12 changes: 6 additions & 6 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount } from '@clerk/types';

import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';
import type { BillingPlanJSON } from './JSON';

/**
 * The `CommercePlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommercePlan {
export class BillingPlan {
 constructor(
 /**
 * The unique identifier for the plan.
Expand DownExpand Up@@ -68,16 +68,16 @@ export class CommercePlan {
 readonly features: Feature[],
 ) {}

 static fromJSON(data: CommercePlanJSON): CommercePlan {
 const formatAmountJSON = (fee: CommercePlanJSON['fee']) => {
 static fromJSON(data: BillingPlanJSON): BillingPlan {
 const formatAmountJSON = (fee: BillingPlanJSON['fee']) => {
 return {
 amount: fee.amount,
 amountFormatted: fee.amount_formatted,
 currency: fee.currency,
 currencySymbol: fee.currency_symbol,
 };
 };
 return new CommercePlan(
 return new BillingPlan(
 data.id,
 data.product_id,
 data.name,
Expand Down

22 changes: 11 additions & 11 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
import { type BillingMoneyAmount } from '@clerk/types';
import type { BillingMoneyAmount } from '@clerk/types';

import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import type { CommerceSubscriptionJSON } from './JSON';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

/**
 * The `CommerceSubscription` object is similar to the [`CommerceSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `CommerceSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscription {
export class BillingSubscription {
 constructor(
 /**
 * The unique identifier for the commerce subscription.
 * The unique identifier for the billing subscription.
 */
 readonly id: string,
 /**
 * The current status of the subscription.
 */
 readonly status: CommerceSubscriptionJSON['status'],
 readonly status: BillingSubscriptionJSON['status'],
 /**
 * The ID of the payer for this subscription.
 */
Expand All@@ -41,7 +41,7 @@ export class CommerceSubscription {
 /**
 * Array of subscription items in this subscription.
 */
 readonly subscriptionItems: CommerceSubscriptionItem[],
 readonly subscriptionItems: BillingSubscriptionItem[],
 /**
 * Information about the next scheduled payment.
 */
Expand All@@ -52,7 +52,7 @@ export class CommerceSubscription {
 readonly eligibleForFreeTrial: boolean,
 ) {}

 static fromJSON(data: CommerceSubscriptionJSON): CommerceSubscription {
 static fromJSON(data: BillingSubscriptionJSON): BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
Expand All@@ -65,15 +65,15 @@ export class CommerceSubscription {
 }
 : null;

 return new CommerceSubscription(
 return new BillingSubscription(
 data.id,
 data.status,
 data.payer_id,
 data.created_at,
 data.updated_at,
 data.active_at ?? null,
 data.past_due_at ?? null,
 data.subscription_items.map(item => CommerceSubscriptionItem.fromJSON(item)),
 data.subscription_items.map(item => BillingSubscriptionItem.fromJSON(item)),
 nextPayment,
 data.eligible_for_free_trial ?? false,
 );
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/types';

import { CommercePlan } from './CommercePlan';
import type { CommerceSubscriptionItemJSON } from './JSON';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

/**
 * The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `CommerceSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscriptionItem {
export class BillingSubscriptionItem {
 constructor(
 /**
 * The unique identifier for the subscription item.
Expand All@@ -17,7 +17,7 @@ export class CommerceSubscriptionItem {
 /**
 * The status of the subscription item.
 */
 readonly status: CommerceSubscriptionItemJSON['status'],
 readonly status: BillingSubscriptionItemJSON['status'],
 /**
 * The plan period for the subscription item.
 */
Expand DownExpand Up@@ -46,7 +46,7 @@ export class CommerceSubscriptionItem {
 /**
 * The plan associated with this subscription item.
 */
 readonly plan: CommercePlan,
 readonly plan: BillingPlan,
 /**
 * The plan ID.
 */
Expand DownExpand Up@@ -89,7 +89,7 @@ export class CommerceSubscriptionItem {
 readonly lifetimePaid?: BillingMoneyAmount | null,
 ) {}

 static fromJSON(data: CommerceSubscriptionItemJSON): CommerceSubscriptionItem {
 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
Expand All@@ -105,14 +105,14 @@ export class CommerceSubscriptionItem {
 };
 }

 return new CommerceSubscriptionItem(
 return new BillingSubscriptionItem(
 data.id,
 data.status,
 data.plan_period,
 data.period_start,
 data.next_payment,
 formatAmountJSON(data.amount),
CommercePlan.fromJSON(data.plan),
BillingPlan.fromJSON(data.plan),
 data.plan_id,
 data.created_at,
 data.updated_at,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,9 @@ import {
 User,
} from '.';
import { AccountlessApplication } from './AccountlessApplication';
import { CommercePlan } from './CommercePlan';
import { CommerceSubscription } from './CommerceSubscription';
import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import { BillingPlan } from './CommercePlan';
import { BillingSubscription } from './CommerceSubscription';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import { Feature } from './Feature';
import type { PaginatedResponseJSON } from './JSON';
import { ObjectType } from './JSON';
Expand DownExpand Up@@ -183,12 +183,12 @@ function jsonToObject(item: any): any {
 return User.fromJSON(item);
 case ObjectType.WaitlistEntry:
 return WaitlistEntry.fromJSON(item);
 case ObjectType.CommercePlan:
 return CommercePlan.fromJSON(item);
 case ObjectType.CommerceSubscription:
 return CommerceSubscription.fromJSON(item);
 case ObjectType.CommerceSubscriptionItem:
 return CommerceSubscriptionItem.fromJSON(item);
 case ObjectType.BillingPlan:
 return BillingPlan.fromJSON(item);
 case ObjectType.BillingSubscription:
 return BillingSubscription.fromJSON(item);
 case ObjectType.BillingSubscriptionItem:
 return BillingSubscriptionItem.fromJSON(item);
 case ObjectType.Feature:
 return Feature.fromJSON(item);
 default:
Expand Down
Loading
Loading

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

Skip to content
chore(backend): Rename commerce resources to billing resources#6812

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Sep 19, 2025
 Merged


chore(backend): Rename commerce resources to billing resources
#6812
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/tricky-moments-film.md

View file


Open in desktop

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

[Billing Beta] Rename types and classes that contain commerce to use billing instead.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -235,15 +235,15 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "backend/allowlist-identifier.mdx",
 "backend/auth-object.mdx",
 "backend/authenticate-request-options.mdx",
 "backend/billing-payment-attempt-webhook-event-json.mdx",
 "backend/billing-plan-json.mdx",
 "backend/billing-plan.mdx",
 "backend/billing-subscription-item-json.mdx",
 "backend/billing-subscription-item-webhook-event-json.mdx",
 "backend/billing-subscription-item.mdx",
 "backend/billing-subscription-webhook-event-json.mdx",
 "backend/billing-subscription.mdx",
 "backend/client.mdx",
 "backend/commerce-payment-attempt-webhook-event-json.mdx",
 "backend/commerce-plan-json.mdx",
 "backend/commerce-plan.mdx",
 "backend/commerce-subscription-item-json.mdx",
 "backend/commerce-subscription-item-webhook-event-json.mdx",
 "backend/commerce-subscription-item.mdx",
 "backend/commerce-subscription-webhook-event-json.mdx",
 "backend/commerce-subscription.mdx",
 "backend/email-address.mdx",
 "backend/external-account.mdx",
 "backend/feature.mdx",
Expand Down

16 changes: 8 additions & 8 deletions
packages/backend/src/api/endpoints/BillingApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
import type { ClerkPaginationRequest } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { CommercePlan } from '../resources/CommercePlan';
import type { CommerceSubscription } from '../resources/CommerceSubscription';
import type { CommerceSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { BillingPlan } from '../resources/CommercePlan';
import type { BillingSubscription } from '../resources/CommerceSubscription';
import type { BillingSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import { AbstractAPI } from './AbstractApi';

Expand DownExpand Up@@ -36,7 +36,7 @@ export class BillingAPI extends AbstractAPI {
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
 public async getPlanList(params?: GetOrganizationListParams) {
 return this.request<PaginatedResourceResponse<CommercePlan[]>>({
 return this.request<PaginatedResourceResponse<BillingPlan[]>>({
 method: 'GET',
 path: joinPaths(basePath, 'plans'),
 queryParams: params,
Expand All@@ -48,7 +48,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async cancelSubscriptionItem(subscriptionItemId: string, params?: CancelSubscriptionItemParams) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'DELETE',
 path: joinPaths(basePath, 'subscription_items', subscriptionItemId),
 queryParams: params,
Expand All@@ -63,7 +63,7 @@ export class BillingAPI extends AbstractAPI {
 params: ExtendSubscriptionItemFreeTrialParams,
 ) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'POST',
 path: joinPaths('/billing', 'subscription_items', subscriptionItemId, 'extend_free_trial'),
 bodyParams: params,
Expand All@@ -75,7 +75,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getOrganizationBillingSubscription(organizationId: string) {
 this.requireId(organizationId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(organizationBasePath, organizationId, 'billing', 'subscription'),
 });
Expand All@@ -86,7 +86,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getUserBillingSubscription(userId: string) {
 this.requireId(userId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(userBasePath, userId, 'billing', 'subscription'),
 });
Expand Down

12 changes: 6 additions & 6 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount } from '@clerk/types';

import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';
import type { BillingPlanJSON } from './JSON';

/**
 * The `CommercePlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommercePlan {
export class BillingPlan {
 constructor(
 /**
 * The unique identifier for the plan.
Expand DownExpand Up@@ -68,16 +68,16 @@ export class CommercePlan {
 readonly features: Feature[],
 ) {}

 static fromJSON(data: CommercePlanJSON): CommercePlan {
 const formatAmountJSON = (fee: CommercePlanJSON['fee']) => {
 static fromJSON(data: BillingPlanJSON): BillingPlan {
 const formatAmountJSON = (fee: BillingPlanJSON['fee']) => {
 return {
 amount: fee.amount,
 amountFormatted: fee.amount_formatted,
 currency: fee.currency,
 currencySymbol: fee.currency_symbol,
 };
 };
 return new CommercePlan(
 return new BillingPlan(
 data.id,
 data.product_id,
 data.name,
Expand Down

22 changes: 11 additions & 11 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
import { type BillingMoneyAmount } from '@clerk/types';
import type { BillingMoneyAmount } from '@clerk/types';

import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import type { CommerceSubscriptionJSON } from './JSON';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

/**
 * The `CommerceSubscription` object is similar to the [`CommerceSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `CommerceSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscription {
export class BillingSubscription {
 constructor(
 /**
 * The unique identifier for the commerce subscription.
 * The unique identifier for the billing subscription.
 */
 readonly id: string,
 /**
 * The current status of the subscription.
 */
 readonly status: CommerceSubscriptionJSON['status'],
 readonly status: BillingSubscriptionJSON['status'],
 /**
 * The ID of the payer for this subscription.
 */
Expand All@@ -41,7 +41,7 @@ export class CommerceSubscription {
 /**
 * Array of subscription items in this subscription.
 */
 readonly subscriptionItems: CommerceSubscriptionItem[],
 readonly subscriptionItems: BillingSubscriptionItem[],
 /**
 * Information about the next scheduled payment.
 */
Expand All@@ -52,7 +52,7 @@ export class CommerceSubscription {
 readonly eligibleForFreeTrial: boolean,
 ) {}

 static fromJSON(data: CommerceSubscriptionJSON): CommerceSubscription {
 static fromJSON(data: BillingSubscriptionJSON): BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
Expand All@@ -65,15 +65,15 @@ export class CommerceSubscription {
 }
 : null;

 return new CommerceSubscription(
 return new BillingSubscription(
 data.id,
 data.status,
 data.payer_id,
 data.created_at,
 data.updated_at,
 data.active_at ?? null,
 data.past_due_at ?? null,
 data.subscription_items.map(item => CommerceSubscriptionItem.fromJSON(item)),
 data.subscription_items.map(item => BillingSubscriptionItem.fromJSON(item)),
 nextPayment,
 data.eligible_for_free_trial ?? false,
 );
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/types';

import { CommercePlan } from './CommercePlan';
import type { CommerceSubscriptionItemJSON } from './JSON';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

/**
 * The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `CommerceSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscriptionItem {
export class BillingSubscriptionItem {
 constructor(
 /**
 * The unique identifier for the subscription item.
Expand All@@ -17,7 +17,7 @@ export class CommerceSubscriptionItem {
 /**
 * The status of the subscription item.
 */
 readonly status: CommerceSubscriptionItemJSON['status'],
 readonly status: BillingSubscriptionItemJSON['status'],
 /**
 * The plan period for the subscription item.
 */
Expand DownExpand Up@@ -46,7 +46,7 @@ export class CommerceSubscriptionItem {
 /**
 * The plan associated with this subscription item.
 */
 readonly plan: CommercePlan,
 readonly plan: BillingPlan,
 /**
 * The plan ID.
 */
Expand DownExpand Up@@ -89,7 +89,7 @@ export class CommerceSubscriptionItem {
 readonly lifetimePaid?: BillingMoneyAmount | null,
 ) {}

 static fromJSON(data: CommerceSubscriptionItemJSON): CommerceSubscriptionItem {
 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
Expand All@@ -105,14 +105,14 @@ export class CommerceSubscriptionItem {
 };
 }

 return new CommerceSubscriptionItem(
 return new BillingSubscriptionItem(
 data.id,
 data.status,
 data.plan_period,
 data.period_start,
 data.next_payment,
 formatAmountJSON(data.amount),
CommercePlan.fromJSON(data.plan),
BillingPlan.fromJSON(data.plan),
 data.plan_id,
 data.created_at,
 data.updated_at,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,9 @@ import {
 User,
} from '.';
import { AccountlessApplication } from './AccountlessApplication';
import { CommercePlan } from './CommercePlan';
import { CommerceSubscription } from './CommerceSubscription';
import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import { BillingPlan } from './CommercePlan';
import { BillingSubscription } from './CommerceSubscription';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import { Feature } from './Feature';
import type { PaginatedResponseJSON } from './JSON';
import { ObjectType } from './JSON';
Expand DownExpand Up@@ -183,12 +183,12 @@ function jsonToObject(item: any): any {
 return User.fromJSON(item);
 case ObjectType.WaitlistEntry:
 return WaitlistEntry.fromJSON(item);
 case ObjectType.CommercePlan:
 return CommercePlan.fromJSON(item);
 case ObjectType.CommerceSubscription:
 return CommerceSubscription.fromJSON(item);
 case ObjectType.CommerceSubscriptionItem:
 return CommerceSubscriptionItem.fromJSON(item);
 case ObjectType.BillingPlan:
 return BillingPlan.fromJSON(item);
 case ObjectType.BillingSubscription:
 return BillingSubscription.fromJSON(item);
 case ObjectType.BillingSubscriptionItem:
 return BillingSubscriptionItem.fromJSON(item);
 case ObjectType.Feature:
 return Feature.fromJSON(item);
 default:
Expand Down
Loading
Loading

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

Skip to content
chore(backend): Rename commerce resources to billing resources#6812

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Sep 19, 2025
 Merged


chore(backend): Rename commerce resources to billing resources
#6812
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/tricky-moments-film.md

View file


Open in desktop

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

[Billing Beta] Rename types and classes that contain commerce to use billing instead.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -235,15 +235,15 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "backend/allowlist-identifier.mdx",
 "backend/auth-object.mdx",
 "backend/authenticate-request-options.mdx",
 "backend/billing-payment-attempt-webhook-event-json.mdx",
 "backend/billing-plan-json.mdx",
 "backend/billing-plan.mdx",
 "backend/billing-subscription-item-json.mdx",
 "backend/billing-subscription-item-webhook-event-json.mdx",
 "backend/billing-subscription-item.mdx",
 "backend/billing-subscription-webhook-event-json.mdx",
 "backend/billing-subscription.mdx",
 "backend/client.mdx",
 "backend/commerce-payment-attempt-webhook-event-json.mdx",
 "backend/commerce-plan-json.mdx",
 "backend/commerce-plan.mdx",
 "backend/commerce-subscription-item-json.mdx",
 "backend/commerce-subscription-item-webhook-event-json.mdx",
 "backend/commerce-subscription-item.mdx",
 "backend/commerce-subscription-webhook-event-json.mdx",
 "backend/commerce-subscription.mdx",
 "backend/email-address.mdx",
 "backend/external-account.mdx",
 "backend/feature.mdx",
Expand Down

16 changes: 8 additions & 8 deletions
packages/backend/src/api/endpoints/BillingApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
import type { ClerkPaginationRequest } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { CommercePlan } from '../resources/CommercePlan';
import type { CommerceSubscription } from '../resources/CommerceSubscription';
import type { CommerceSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { BillingPlan } from '../resources/CommercePlan';
import type { BillingSubscription } from '../resources/CommerceSubscription';
import type { BillingSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import { AbstractAPI } from './AbstractApi';

Expand DownExpand Up@@ -36,7 +36,7 @@ export class BillingAPI extends AbstractAPI {
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
 public async getPlanList(params?: GetOrganizationListParams) {
 return this.request<PaginatedResourceResponse<CommercePlan[]>>({
 return this.request<PaginatedResourceResponse<BillingPlan[]>>({
 method: 'GET',
 path: joinPaths(basePath, 'plans'),
 queryParams: params,
Expand All@@ -48,7 +48,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async cancelSubscriptionItem(subscriptionItemId: string, params?: CancelSubscriptionItemParams) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'DELETE',
 path: joinPaths(basePath, 'subscription_items', subscriptionItemId),
 queryParams: params,
Expand All@@ -63,7 +63,7 @@ export class BillingAPI extends AbstractAPI {
 params: ExtendSubscriptionItemFreeTrialParams,
 ) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'POST',
 path: joinPaths('/billing', 'subscription_items', subscriptionItemId, 'extend_free_trial'),
 bodyParams: params,
Expand All@@ -75,7 +75,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getOrganizationBillingSubscription(organizationId: string) {
 this.requireId(organizationId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(organizationBasePath, organizationId, 'billing', 'subscription'),
 });
Expand All@@ -86,7 +86,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getUserBillingSubscription(userId: string) {
 this.requireId(userId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(userBasePath, userId, 'billing', 'subscription'),
 });
Expand Down

12 changes: 6 additions & 6 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount } from '@clerk/types';

import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';
import type { BillingPlanJSON } from './JSON';

/**
 * The `CommercePlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommercePlan {
export class BillingPlan {
 constructor(
 /**
 * The unique identifier for the plan.
Expand DownExpand Up@@ -68,16 +68,16 @@ export class CommercePlan {
 readonly features: Feature[],
 ) {}

 static fromJSON(data: CommercePlanJSON): CommercePlan {
 const formatAmountJSON = (fee: CommercePlanJSON['fee']) => {
 static fromJSON(data: BillingPlanJSON): BillingPlan {
 const formatAmountJSON = (fee: BillingPlanJSON['fee']) => {
 return {
 amount: fee.amount,
 amountFormatted: fee.amount_formatted,
 currency: fee.currency,
 currencySymbol: fee.currency_symbol,
 };
 };
 return new CommercePlan(
 return new BillingPlan(
 data.id,
 data.product_id,
 data.name,
Expand Down

22 changes: 11 additions & 11 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
import { type BillingMoneyAmount } from '@clerk/types';
import type { BillingMoneyAmount } from '@clerk/types';

import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import type { CommerceSubscriptionJSON } from './JSON';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

/**
 * The `CommerceSubscription` object is similar to the [`CommerceSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `CommerceSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscription {
export class BillingSubscription {
 constructor(
 /**
 * The unique identifier for the commerce subscription.
 * The unique identifier for the billing subscription.
 */
 readonly id: string,
 /**
 * The current status of the subscription.
 */
 readonly status: CommerceSubscriptionJSON['status'],
 readonly status: BillingSubscriptionJSON['status'],
 /**
 * The ID of the payer for this subscription.
 */
Expand All@@ -41,7 +41,7 @@ export class CommerceSubscription {
 /**
 * Array of subscription items in this subscription.
 */
 readonly subscriptionItems: CommerceSubscriptionItem[],
 readonly subscriptionItems: BillingSubscriptionItem[],
 /**
 * Information about the next scheduled payment.
 */
Expand All@@ -52,7 +52,7 @@ export class CommerceSubscription {
 readonly eligibleForFreeTrial: boolean,
 ) {}

 static fromJSON(data: CommerceSubscriptionJSON): CommerceSubscription {
 static fromJSON(data: BillingSubscriptionJSON): BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
Expand All@@ -65,15 +65,15 @@ export class CommerceSubscription {
 }
 : null;

 return new CommerceSubscription(
 return new BillingSubscription(
 data.id,
 data.status,
 data.payer_id,
 data.created_at,
 data.updated_at,
 data.active_at ?? null,
 data.past_due_at ?? null,
 data.subscription_items.map(item => CommerceSubscriptionItem.fromJSON(item)),
 data.subscription_items.map(item => BillingSubscriptionItem.fromJSON(item)),
 nextPayment,
 data.eligible_for_free_trial ?? false,
 );
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/types';

import { CommercePlan } from './CommercePlan';
import type { CommerceSubscriptionItemJSON } from './JSON';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

/**
 * The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `CommerceSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscriptionItem {
export class BillingSubscriptionItem {
 constructor(
 /**
 * The unique identifier for the subscription item.
Expand All@@ -17,7 +17,7 @@ export class CommerceSubscriptionItem {
 /**
 * The status of the subscription item.
 */
 readonly status: CommerceSubscriptionItemJSON['status'],
 readonly status: BillingSubscriptionItemJSON['status'],
 /**
 * The plan period for the subscription item.
 */
Expand DownExpand Up@@ -46,7 +46,7 @@ export class CommerceSubscriptionItem {
 /**
 * The plan associated with this subscription item.
 */
 readonly plan: CommercePlan,
 readonly plan: BillingPlan,
 /**
 * The plan ID.
 */
Expand DownExpand Up@@ -89,7 +89,7 @@ export class CommerceSubscriptionItem {
 readonly lifetimePaid?: BillingMoneyAmount | null,
 ) {}

 static fromJSON(data: CommerceSubscriptionItemJSON): CommerceSubscriptionItem {
 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
Expand All@@ -105,14 +105,14 @@ export class CommerceSubscriptionItem {
 };
 }

 return new CommerceSubscriptionItem(
 return new BillingSubscriptionItem(
 data.id,
 data.status,
 data.plan_period,
 data.period_start,
 data.next_payment,
 formatAmountJSON(data.amount),
CommercePlan.fromJSON(data.plan),
BillingPlan.fromJSON(data.plan),
 data.plan_id,
 data.created_at,
 data.updated_at,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,9 @@ import {
 User,
} from '.';
import { AccountlessApplication } from './AccountlessApplication';
import { CommercePlan } from './CommercePlan';
import { CommerceSubscription } from './CommerceSubscription';
import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import { BillingPlan } from './CommercePlan';
import { BillingSubscription } from './CommerceSubscription';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import { Feature } from './Feature';
import type { PaginatedResponseJSON } from './JSON';
import { ObjectType } from './JSON';
Expand DownExpand Up@@ -183,12 +183,12 @@ function jsonToObject(item: any): any {
 return User.fromJSON(item);
 case ObjectType.WaitlistEntry:
 return WaitlistEntry.fromJSON(item);
 case ObjectType.CommercePlan:
 return CommercePlan.fromJSON(item);
 case ObjectType.CommerceSubscription:
 return CommerceSubscription.fromJSON(item);
 case ObjectType.CommerceSubscriptionItem:
 return CommerceSubscriptionItem.fromJSON(item);
 case ObjectType.BillingPlan:
 return BillingPlan.fromJSON(item);
 case ObjectType.BillingSubscription:
 return BillingSubscription.fromJSON(item);
 case ObjectType.BillingSubscriptionItem:
 return BillingSubscriptionItem.fromJSON(item);
 case ObjectType.Feature:
 return Feature.fromJSON(item);
 default:
Expand Down
Loading
Loading

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

Skip to content
chore(backend): Rename commerce resources to billing resources#6812

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Sep 19, 2025
 Merged


chore(backend): Rename commerce resources to billing resources
#6812
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/tricky-moments-film.md

View file


Open in desktop

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

[Billing Beta] Rename types and classes that contain commerce to use billing instead.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -235,15 +235,15 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "backend/allowlist-identifier.mdx",
 "backend/auth-object.mdx",
 "backend/authenticate-request-options.mdx",
 "backend/billing-payment-attempt-webhook-event-json.mdx",
 "backend/billing-plan-json.mdx",
 "backend/billing-plan.mdx",
 "backend/billing-subscription-item-json.mdx",
 "backend/billing-subscription-item-webhook-event-json.mdx",
 "backend/billing-subscription-item.mdx",
 "backend/billing-subscription-webhook-event-json.mdx",
 "backend/billing-subscription.mdx",
 "backend/client.mdx",
 "backend/commerce-payment-attempt-webhook-event-json.mdx",
 "backend/commerce-plan-json.mdx",
 "backend/commerce-plan.mdx",
 "backend/commerce-subscription-item-json.mdx",
 "backend/commerce-subscription-item-webhook-event-json.mdx",
 "backend/commerce-subscription-item.mdx",
 "backend/commerce-subscription-webhook-event-json.mdx",
 "backend/commerce-subscription.mdx",
 "backend/email-address.mdx",
 "backend/external-account.mdx",
 "backend/feature.mdx",
Expand Down

16 changes: 8 additions & 8 deletions
packages/backend/src/api/endpoints/BillingApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
import type { ClerkPaginationRequest } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { CommercePlan } from '../resources/CommercePlan';
import type { CommerceSubscription } from '../resources/CommerceSubscription';
import type { CommerceSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { BillingPlan } from '../resources/CommercePlan';
import type { BillingSubscription } from '../resources/CommerceSubscription';
import type { BillingSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import { AbstractAPI } from './AbstractApi';

Expand DownExpand Up@@ -36,7 +36,7 @@ export class BillingAPI extends AbstractAPI {
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
 public async getPlanList(params?: GetOrganizationListParams) {
 return this.request<PaginatedResourceResponse<CommercePlan[]>>({
 return this.request<PaginatedResourceResponse<BillingPlan[]>>({
 method: 'GET',
 path: joinPaths(basePath, 'plans'),
 queryParams: params,
Expand All@@ -48,7 +48,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async cancelSubscriptionItem(subscriptionItemId: string, params?: CancelSubscriptionItemParams) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'DELETE',
 path: joinPaths(basePath, 'subscription_items', subscriptionItemId),
 queryParams: params,
Expand All@@ -63,7 +63,7 @@ export class BillingAPI extends AbstractAPI {
 params: ExtendSubscriptionItemFreeTrialParams,
 ) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'POST',
 path: joinPaths('/billing', 'subscription_items', subscriptionItemId, 'extend_free_trial'),
 bodyParams: params,
Expand All@@ -75,7 +75,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getOrganizationBillingSubscription(organizationId: string) {
 this.requireId(organizationId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(organizationBasePath, organizationId, 'billing', 'subscription'),
 });
Expand All@@ -86,7 +86,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getUserBillingSubscription(userId: string) {
 this.requireId(userId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(userBasePath, userId, 'billing', 'subscription'),
 });
Expand Down

12 changes: 6 additions & 6 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount } from '@clerk/types';

import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';
import type { BillingPlanJSON } from './JSON';

/**
 * The `CommercePlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommercePlan {
export class BillingPlan {
 constructor(
 /**
 * The unique identifier for the plan.
Expand DownExpand Up@@ -68,16 +68,16 @@ export class CommercePlan {
 readonly features: Feature[],
 ) {}

 static fromJSON(data: CommercePlanJSON): CommercePlan {
 const formatAmountJSON = (fee: CommercePlanJSON['fee']) => {
 static fromJSON(data: BillingPlanJSON): BillingPlan {
 const formatAmountJSON = (fee: BillingPlanJSON['fee']) => {
 return {
 amount: fee.amount,
 amountFormatted: fee.amount_formatted,
 currency: fee.currency,
 currencySymbol: fee.currency_symbol,
 };
 };
 return new CommercePlan(
 return new BillingPlan(
 data.id,
 data.product_id,
 data.name,
Expand Down

22 changes: 11 additions & 11 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
import { type BillingMoneyAmount } from '@clerk/types';
import type { BillingMoneyAmount } from '@clerk/types';

import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import type { CommerceSubscriptionJSON } from './JSON';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

/**
 * The `CommerceSubscription` object is similar to the [`CommerceSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `CommerceSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscription {
export class BillingSubscription {
 constructor(
 /**
 * The unique identifier for the commerce subscription.
 * The unique identifier for the billing subscription.
 */
 readonly id: string,
 /**
 * The current status of the subscription.
 */
 readonly status: CommerceSubscriptionJSON['status'],
 readonly status: BillingSubscriptionJSON['status'],
 /**
 * The ID of the payer for this subscription.
 */
Expand All@@ -41,7 +41,7 @@ export class CommerceSubscription {
 /**
 * Array of subscription items in this subscription.
 */
 readonly subscriptionItems: CommerceSubscriptionItem[],
 readonly subscriptionItems: BillingSubscriptionItem[],
 /**
 * Information about the next scheduled payment.
 */
Expand All@@ -52,7 +52,7 @@ export class CommerceSubscription {
 readonly eligibleForFreeTrial: boolean,
 ) {}

 static fromJSON(data: CommerceSubscriptionJSON): CommerceSubscription {
 static fromJSON(data: BillingSubscriptionJSON): BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
Expand All@@ -65,15 +65,15 @@ export class CommerceSubscription {
 }
 : null;

 return new CommerceSubscription(
 return new BillingSubscription(
 data.id,
 data.status,
 data.payer_id,
 data.created_at,
 data.updated_at,
 data.active_at ?? null,
 data.past_due_at ?? null,
 data.subscription_items.map(item => CommerceSubscriptionItem.fromJSON(item)),
 data.subscription_items.map(item => BillingSubscriptionItem.fromJSON(item)),
 nextPayment,
 data.eligible_for_free_trial ?? false,
 );
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/types';

import { CommercePlan } from './CommercePlan';
import type { CommerceSubscriptionItemJSON } from './JSON';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

/**
 * The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `CommerceSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscriptionItem {
export class BillingSubscriptionItem {
 constructor(
 /**
 * The unique identifier for the subscription item.
Expand All@@ -17,7 +17,7 @@ export class CommerceSubscriptionItem {
 /**
 * The status of the subscription item.
 */
 readonly status: CommerceSubscriptionItemJSON['status'],
 readonly status: BillingSubscriptionItemJSON['status'],
 /**
 * The plan period for the subscription item.
 */
Expand DownExpand Up@@ -46,7 +46,7 @@ export class CommerceSubscriptionItem {
 /**
 * The plan associated with this subscription item.
 */
 readonly plan: CommercePlan,
 readonly plan: BillingPlan,
 /**
 * The plan ID.
 */
Expand DownExpand Up@@ -89,7 +89,7 @@ export class CommerceSubscriptionItem {
 readonly lifetimePaid?: BillingMoneyAmount | null,
 ) {}

 static fromJSON(data: CommerceSubscriptionItemJSON): CommerceSubscriptionItem {
 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
Expand All@@ -105,14 +105,14 @@ export class CommerceSubscriptionItem {
 };
 }

 return new CommerceSubscriptionItem(
 return new BillingSubscriptionItem(
 data.id,
 data.status,
 data.plan_period,
 data.period_start,
 data.next_payment,
 formatAmountJSON(data.amount),
CommercePlan.fromJSON(data.plan),
BillingPlan.fromJSON(data.plan),
 data.plan_id,
 data.created_at,
 data.updated_at,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,9 @@ import {
 User,
} from '.';
import { AccountlessApplication } from './AccountlessApplication';
import { CommercePlan } from './CommercePlan';
import { CommerceSubscription } from './CommerceSubscription';
import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import { BillingPlan } from './CommercePlan';
import { BillingSubscription } from './CommerceSubscription';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import { Feature } from './Feature';
import type { PaginatedResponseJSON } from './JSON';
import { ObjectType } from './JSON';
Expand DownExpand Up@@ -183,12 +183,12 @@ function jsonToObject(item: any): any {
 return User.fromJSON(item);
 case ObjectType.WaitlistEntry:
 return WaitlistEntry.fromJSON(item);
 case ObjectType.CommercePlan:
 return CommercePlan.fromJSON(item);
 case ObjectType.CommerceSubscription:
 return CommerceSubscription.fromJSON(item);
 case ObjectType.CommerceSubscriptionItem:
 return CommerceSubscriptionItem.fromJSON(item);
 case ObjectType.BillingPlan:
 return BillingPlan.fromJSON(item);
 case ObjectType.BillingSubscription:
 return BillingSubscription.fromJSON(item);
 case ObjectType.BillingSubscriptionItem:
 return BillingSubscriptionItem.fromJSON(item);
 case ObjectType.Feature:
 return Feature.fromJSON(item);
 default:
Expand Down
Loading
Loading

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

Skip to content
chore(backend): Rename commerce resources to billing resources#6812

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Sep 19, 2025
 Merged


chore(backend): Rename commerce resources to billing resources
#6812
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/tricky-moments-film.md

View file


Open in desktop

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

[Billing Beta] Rename types and classes that contain commerce to use billing instead.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -235,15 +235,15 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
 "backend/allowlist-identifier.mdx",
 "backend/auth-object.mdx",
 "backend/authenticate-request-options.mdx",
 "backend/billing-payment-attempt-webhook-event-json.mdx",
 "backend/billing-plan-json.mdx",
 "backend/billing-plan.mdx",
 "backend/billing-subscription-item-json.mdx",
 "backend/billing-subscription-item-webhook-event-json.mdx",
 "backend/billing-subscription-item.mdx",
 "backend/billing-subscription-webhook-event-json.mdx",
 "backend/billing-subscription.mdx",
 "backend/client.mdx",
 "backend/commerce-payment-attempt-webhook-event-json.mdx",
 "backend/commerce-plan-json.mdx",
 "backend/commerce-plan.mdx",
 "backend/commerce-subscription-item-json.mdx",
 "backend/commerce-subscription-item-webhook-event-json.mdx",
 "backend/commerce-subscription-item.mdx",
 "backend/commerce-subscription-webhook-event-json.mdx",
 "backend/commerce-subscription.mdx",
 "backend/email-address.mdx",
 "backend/external-account.mdx",
 "backend/feature.mdx",
Expand Down

16 changes: 8 additions & 8 deletions
packages/backend/src/api/endpoints/BillingApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
import type { ClerkPaginationRequest } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { CommercePlan } from '../resources/CommercePlan';
import type { CommerceSubscription } from '../resources/CommerceSubscription';
import type { CommerceSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { BillingPlan } from '../resources/CommercePlan';
import type { BillingSubscription } from '../resources/CommerceSubscription';
import type { BillingSubscriptionItem } from '../resources/CommerceSubscriptionItem';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import { AbstractAPI } from './AbstractApi';

Expand DownExpand Up@@ -36,7 +36,7 @@ export class BillingAPI extends AbstractAPI {
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
 public async getPlanList(params?: GetOrganizationListParams) {
 return this.request<PaginatedResourceResponse<CommercePlan[]>>({
 return this.request<PaginatedResourceResponse<BillingPlan[]>>({
 method: 'GET',
 path: joinPaths(basePath, 'plans'),
 queryParams: params,
Expand All@@ -48,7 +48,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async cancelSubscriptionItem(subscriptionItemId: string, params?: CancelSubscriptionItemParams) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'DELETE',
 path: joinPaths(basePath, 'subscription_items', subscriptionItemId),
 queryParams: params,
Expand All@@ -63,7 +63,7 @@ export class BillingAPI extends AbstractAPI {
 params: ExtendSubscriptionItemFreeTrialParams,
 ) {
 this.requireId(subscriptionItemId);
 return this.request<CommerceSubscriptionItem>({
 return this.request<BillingSubscriptionItem>({
 method: 'POST',
 path: joinPaths('/billing', 'subscription_items', subscriptionItemId, 'extend_free_trial'),
 bodyParams: params,
Expand All@@ -75,7 +75,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getOrganizationBillingSubscription(organizationId: string) {
 this.requireId(organizationId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(organizationBasePath, organizationId, 'billing', 'subscription'),
 });
Expand All@@ -86,7 +86,7 @@ export class BillingAPI extends AbstractAPI {
 */
 public async getUserBillingSubscription(userId: string) {
 this.requireId(userId);
 return this.request<CommerceSubscription>({
 return this.request<BillingSubscription>({
 method: 'GET',
 path: joinPaths(userBasePath, userId, 'billing', 'subscription'),
 });
Expand Down

12 changes: 6 additions & 6 deletions
packages/backend/src/api/resources/CommercePlan.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount } from '@clerk/types';

import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';
import type { BillingPlanJSON } from './JSON';

/**
 * The `CommercePlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommercePlan {
export class BillingPlan {
 constructor(
 /**
 * The unique identifier for the plan.
Expand DownExpand Up@@ -68,16 +68,16 @@ export class CommercePlan {
 readonly features: Feature[],
 ) {}

 static fromJSON(data: CommercePlanJSON): CommercePlan {
 const formatAmountJSON = (fee: CommercePlanJSON['fee']) => {
 static fromJSON(data: BillingPlanJSON): BillingPlan {
 const formatAmountJSON = (fee: BillingPlanJSON['fee']) => {
 return {
 amount: fee.amount,
 amountFormatted: fee.amount_formatted,
 currency: fee.currency,
 currencySymbol: fee.currency_symbol,
 };
 };
 return new CommercePlan(
 return new BillingPlan(
 data.id,
 data.product_id,
 data.name,
Expand Down

22 changes: 11 additions & 11 deletions
packages/backend/src/api/resources/CommerceSubscription.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
import { type BillingMoneyAmount } from '@clerk/types';
import type { BillingMoneyAmount } from '@clerk/types';

import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import type { CommerceSubscriptionJSON } from './JSON';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

/**
 * The `CommerceSubscription` object is similar to the [`CommerceSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `CommerceSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscription {
export class BillingSubscription {
 constructor(
 /**
 * The unique identifier for the commerce subscription.
 * The unique identifier for the billing subscription.
 */
 readonly id: string,
 /**
 * The current status of the subscription.
 */
 readonly status: CommerceSubscriptionJSON['status'],
 readonly status: BillingSubscriptionJSON['status'],
 /**
 * The ID of the payer for this subscription.
 */
Expand All@@ -41,7 +41,7 @@ export class CommerceSubscription {
 /**
 * Array of subscription items in this subscription.
 */
 readonly subscriptionItems: CommerceSubscriptionItem[],
 readonly subscriptionItems: BillingSubscriptionItem[],
 /**
 * Information about the next scheduled payment.
 */
Expand All@@ -52,7 +52,7 @@ export class CommerceSubscription {
 readonly eligibleForFreeTrial: boolean,
 ) {}

 static fromJSON(data: CommerceSubscriptionJSON): CommerceSubscription {
 static fromJSON(data: BillingSubscriptionJSON): BillingSubscription {
 const nextPayment = data.next_payment
 ? {
 date: data.next_payment.date,
Expand All@@ -65,15 +65,15 @@ export class CommerceSubscription {
 }
 : null;

 return new CommerceSubscription(
 return new BillingSubscription(
 data.id,
 data.status,
 data.payer_id,
 data.created_at,
 data.updated_at,
 data.active_at ?? null,
 data.past_due_at ?? null,
 data.subscription_items.map(item => CommerceSubscriptionItem.fromJSON(item)),
 data.subscription_items.map(item => BillingSubscriptionItem.fromJSON(item)),
 nextPayment,
 data.eligible_for_free_trial ?? false,
 );
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
import type { BillingMoneyAmount, BillingMoneyAmountJSON } from '@clerk/types';

import { CommercePlan } from './CommercePlan';
import type { CommerceSubscriptionItemJSON } from './JSON';
import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

/**
 * The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `CommerceSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export class CommerceSubscriptionItem {
export class BillingSubscriptionItem {
 constructor(
 /**
 * The unique identifier for the subscription item.
Expand All@@ -17,7 +17,7 @@ export class CommerceSubscriptionItem {
 /**
 * The status of the subscription item.
 */
 readonly status: CommerceSubscriptionItemJSON['status'],
 readonly status: BillingSubscriptionItemJSON['status'],
 /**
 * The plan period for the subscription item.
 */
Expand DownExpand Up@@ -46,7 +46,7 @@ export class CommerceSubscriptionItem {
 /**
 * The plan associated with this subscription item.
 */
 readonly plan: CommercePlan,
 readonly plan: BillingPlan,
 /**
 * The plan ID.
 */
Expand DownExpand Up@@ -89,7 +89,7 @@ export class CommerceSubscriptionItem {
 readonly lifetimePaid?: BillingMoneyAmount | null,
 ) {}

 static fromJSON(data: CommerceSubscriptionItemJSON): CommerceSubscriptionItem {
 static fromJSON(data: BillingSubscriptionItemJSON): BillingSubscriptionItem {
 function formatAmountJSON(
 amount: BillingMoneyAmountJSON | null | undefined,
 ): BillingMoneyAmount | null | undefined {
Expand All@@ -105,14 +105,14 @@ export class CommerceSubscriptionItem {
 };
 }

 return new CommerceSubscriptionItem(
 return new BillingSubscriptionItem(
 data.id,
 data.status,
 data.plan_period,
 data.period_start,
 data.next_payment,
 formatAmountJSON(data.amount),
CommercePlan.fromJSON(data.plan),
BillingPlan.fromJSON(data.plan),
 data.plan_id,
 data.created_at,
 data.updated_at,
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,9 @@ import {
 User,
} from '.';
import { AccountlessApplication } from './AccountlessApplication';
import { CommercePlan } from './CommercePlan';
import { CommerceSubscription } from './CommerceSubscription';
import { CommerceSubscriptionItem } from './CommerceSubscriptionItem';
import { BillingPlan } from './CommercePlan';
import { BillingSubscription } from './CommerceSubscription';
import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import { Feature } from './Feature';
import type { PaginatedResponseJSON } from './JSON';
import { ObjectType } from './JSON';
Expand DownExpand Up@@ -183,12 +183,12 @@ function jsonToObject(item: any): any {
 return User.fromJSON(item);
 case ObjectType.WaitlistEntry:
 return WaitlistEntry.fromJSON(item);
 case ObjectType.CommercePlan:
 return CommercePlan.fromJSON(item);
 case ObjectType.CommerceSubscription:
 return CommerceSubscription.fromJSON(item);
 case ObjectType.CommerceSubscriptionItem:
 return CommerceSubscriptionItem.fromJSON(item);
 case ObjectType.BillingPlan:
 return BillingPlan.fromJSON(item);
 case ObjectType.BillingSubscription:
 return BillingSubscription.fromJSON(item);
 case ObjectType.BillingSubscriptionItem:
 return BillingSubscriptionItem.fromJSON(item);
 case ObjectType.Feature:
 return Feature.fromJSON(item);
 default:
Expand Down
Loading
Loading