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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/chilly-dots-heal.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Removal of Billing experimental methods: `organization.getSubscriptions()` and `billing.getSubscriptions()`
13 changes: 13 additions & 0 deletions .changeset/upset-masks-ask.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'@clerk/shared': minor
'@clerk/astro': minor
'@clerk/chrome-extension': minor
'@clerk/clerk-expo': minor
'@clerk/nextjs': minor
'@clerk/clerk-react': minor
'@clerk/react-router': minor
'@clerk/remix': minor
'@clerk/tanstack-react-start': minor
---

[Billing Beta] Drop experimental `subscriptions` property from params of `useOrganization()`. Use [`useSubscription()`](https://clerk.com/docs/nextjs/hooks/use-subscription) instead.
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,6 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"types/get-plans-params.mdx",
"types/get-statements-params.mdx",
"types/get-subscription-params.mdx",
"types/get-subscriptions-params.mdx",
"types/get-token.mdx",
"types/id-selectors.mdx",
"types/initialize-payment-source-params.mdx",
Expand Down
24 changes: 0 additions & 24 deletions packages/clerk-js/src/core/modules/commerce/CommerceBilling.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,13 @@ import type {
CommercePlanResource,
CommerceStatementJSON,
CommerceStatementResource,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CommerceSubscriptionJSON,
CommerceSubscriptionResource,
CreateCheckoutParams,
GetPaymentAttemptsParams,
GetPlansParams,
GetStatementsParams,
GetSubscriptionParams,
GetSubscriptionsParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
Expand All@@ -28,7 +25,6 @@ import {
CommercePlan,
CommerceStatement,
CommerceSubscription,
CommerceSubscriptionItem,
} from '../../resources/internal';

export class CommerceBilling implements CommerceBillingNamespace {
Expand DownExpand Up@@ -65,26 +61,6 @@ export class CommerceBilling implements CommerceBillingNamespace {
}).then(res => new CommerceSubscription(res?.response as CommerceSubscriptionJSON));
};

getSubscriptions = async (
params: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
const { orgId, ...rest } = params;

return await BaseResource._fetch({
path: orgId ? `/organizations/${orgId}/commerce/subscriptions` : `/me/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(rest),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

getStatements = async (params: GetStatementsParams): Promise<ClerkPaginatedResponse<CommerceStatementResource>> => {
const { orgId, ...rest } = params;

Expand Down
23 changes: 1 addition & 22 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,15 +2,12 @@ import type {
AddMemberParams,
ClerkPaginatedResponse,
ClerkResourceReloadParams,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CreateOrganizationParams,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMemberships,
GetRolesParams,
GetSubscriptionsParams,
InviteMemberParams,
InviteMembersParams,
OrganizationDomainJSON,
Expand All@@ -32,7 +29,7 @@ import type {
import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscriptionItem, OrganizationInvitation, OrganizationMembership } from './internal';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';
Expand DownExpand Up@@ -233,24 +230,6 @@ export class Organization extends BaseResource implements OrganizationResource {
}).then(res => new OrganizationMembership(res?.response as OrganizationMembershipJSON));
};

getSubscriptions = async (
getSubscriptionsParams?: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(getSubscriptionsParams),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

destroy = async (): Promise<void> => {
return this._baseDelete();
};
Expand Down
62 changes: 0 additions & 62 deletions packages/shared/src/react/hooks/useOrganization.tsx
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
/* eslint-disable jsdoc/require-description-complete-sentence */
import type {
ClerkPaginatedResponse,
CommerceSubscriptionItemResource,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMembersParams,
GetSubscriptionsParams,
OrganizationDomainResource,
OrganizationInvitationResource,
OrganizationMembershipRequestResource,
Expand DownExpand Up@@ -66,16 +64,6 @@ export type UseOrganizationParams = {
* </ul>
*/
invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* If set to `true`, all default properties will be used.<br />
* Otherwise, accepts an object with the following optional properties:
* <ul>
* <li>`orgId`: A string that filters the subscriptions by the provided organization ID.</li>
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
* </ul>
*/
subscriptions?: true | PaginatedHookConfig<GetSubscriptionsParams>;
};

/**
Expand DownExpand Up@@ -111,11 +99,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
* Includes a paginated list of the organization's invitations.
*/
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* Includes a paginated list of the organization's subscriptions.
*/
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: true;
Expand All@@ -125,7 +108,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: boolean;
Expand All@@ -147,10 +129,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
OrganizationInvitationResource,
T['invitations'] extends { infinite: true } ? true : false
> | null;
subscriptions: PaginatedResources<
CommerceSubscriptionItemResource,
T['subscriptions'] extends { infinite: true } ? true : false
> | null;
};

const undefinedPaginatedResource = {
Expand DownExpand Up@@ -300,7 +278,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: membershipRequestsListParams,
memberships: membersListParams,
invitations: invitationsListParams,
subscriptions: subscriptionsListParams,
} = params || {};

useAssertWrappedByClerkProvider('useOrganization');
Expand DownExpand Up@@ -341,13 +318,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
infinite: false,
});

const subscriptionsSafeValues = useWithSafeValues(subscriptionsListParams, {
initialPage: 1,
pageSize: 10,
keepPreviousData: false,
infinite: false,
});

const clerk = useClerkInstanceContext();

clerk.telemetry?.record(eventMethodCalled('useOrganization'));
Expand DownExpand Up@@ -389,15 +359,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
status: invitationsSafeValues.status,
};

const subscriptionsParams =
typeof subscriptionsListParams === 'undefined'
? undefined
: {
initialPage: subscriptionsSafeValues.initialPage,
pageSize: subscriptionsSafeValues.pageSize,
orgId: organization?.id,
};

const domains = usePagesOrInfinite<GetDomainsParams, ClerkPaginatedResponse<OrganizationDomainResource>>(
{
...domainParams,
Expand DownExpand Up@@ -463,25 +424,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
},
);

const subscriptions = usePagesOrInfinite<
GetSubscriptionsParams,
ClerkPaginatedResponse<CommerceSubscriptionItemResource>
>(
{
...subscriptionsParams,
},
organization?.getSubscriptions,
{
keepPreviousData: subscriptionsSafeValues.keepPreviousData,
infinite: subscriptionsSafeValues.infinite,
enabled: !!subscriptionsParams,
},
{
type: 'subscriptions',
organizationId: organization?.id,
},
);

if (organization === undefined) {
return {
isLoaded: false,
Expand All@@ -491,7 +433,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -504,7 +445,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: null,
memberships: null,
invitations: null,
subscriptions: null,
};
}

Expand All@@ -518,7 +458,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -531,6 +470,5 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests,
memberships,
invitations,
subscriptions,
};
}
23 changes: 0 additions & 23 deletions packages/types/src/commerce.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,19 +69,6 @@ export interface CommerceBillingNamespace {
*/
getSubscription: (params: GetSubscriptionParams) => Promise<CommerceSubscriptionResource>;

/**
* @deprecated Use `getSubscription` to fetch a single subscription with its items
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
getSubscriptions: (
params: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand DownExpand Up@@ -792,16 +779,6 @@ export interface CommerceStatementGroup {
items: CommercePaymentResource[];
}

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
export type GetSubscriptionsParams = WithOptionalOrgType<ClerkPaginationParams>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand Down
12 changes: 1 addition & 11 deletions packages/types/src/organization.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
import type {
CommercePaymentSourceMethods,
CommerceSubscriptionItemResource,
GetSubscriptionsParams,
} from './commerce';
import type { CommercePaymentSourceMethods } from './commerce';
import type { OrganizationDomainResource, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationResource, OrganizationInvitationStatus } from './organizationInvitation';
import type { OrganizationCustomRoleKey, OrganizationMembershipResource } from './organizationMembership';
Expand DownExpand Up@@ -60,12 +56,6 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
getMembershipRequests: (
params?: GetMembershipRequestParams,
) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
*/
getSubscriptions: (
params?: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;
addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;
inviteMembers: (params: InviteMembersParams) => Promise<OrganizationInvitationResource[]>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/chilly-dots-heal.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Removal of Billing experimental methods: `organization.getSubscriptions()` and `billing.getSubscriptions()`
13 changes: 13 additions & 0 deletions .changeset/upset-masks-ask.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'@clerk/shared': minor
'@clerk/astro': minor
'@clerk/chrome-extension': minor
'@clerk/clerk-expo': minor
'@clerk/nextjs': minor
'@clerk/clerk-react': minor
'@clerk/react-router': minor
'@clerk/remix': minor
'@clerk/tanstack-react-start': minor
---

[Billing Beta] Drop experimental `subscriptions` property from params of `useOrganization()`. Use [`useSubscription()`](https://clerk.com/docs/nextjs/hooks/use-subscription) instead.
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,6 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"types/get-plans-params.mdx",
"types/get-statements-params.mdx",
"types/get-subscription-params.mdx",
"types/get-subscriptions-params.mdx",
"types/get-token.mdx",
"types/id-selectors.mdx",
"types/initialize-payment-source-params.mdx",
Expand Down
24 changes: 0 additions & 24 deletions packages/clerk-js/src/core/modules/commerce/CommerceBilling.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,13 @@ import type {
CommercePlanResource,
CommerceStatementJSON,
CommerceStatementResource,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CommerceSubscriptionJSON,
CommerceSubscriptionResource,
CreateCheckoutParams,
GetPaymentAttemptsParams,
GetPlansParams,
GetStatementsParams,
GetSubscriptionParams,
GetSubscriptionsParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
Expand All@@ -28,7 +25,6 @@ import {
CommercePlan,
CommerceStatement,
CommerceSubscription,
CommerceSubscriptionItem,
} from '../../resources/internal';

export class CommerceBilling implements CommerceBillingNamespace {
Expand DownExpand Up@@ -65,26 +61,6 @@ export class CommerceBilling implements CommerceBillingNamespace {
}).then(res => new CommerceSubscription(res?.response as CommerceSubscriptionJSON));
};

getSubscriptions = async (
params: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
const { orgId, ...rest } = params;

return await BaseResource._fetch({
path: orgId ? `/organizations/${orgId}/commerce/subscriptions` : `/me/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(rest),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

getStatements = async (params: GetStatementsParams): Promise<ClerkPaginatedResponse<CommerceStatementResource>> => {
const { orgId, ...rest } = params;

Expand Down
23 changes: 1 addition & 22 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,15 +2,12 @@ import type {
AddMemberParams,
ClerkPaginatedResponse,
ClerkResourceReloadParams,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CreateOrganizationParams,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMemberships,
GetRolesParams,
GetSubscriptionsParams,
InviteMemberParams,
InviteMembersParams,
OrganizationDomainJSON,
Expand All@@ -32,7 +29,7 @@ import type {
import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscriptionItem, OrganizationInvitation, OrganizationMembership } from './internal';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';
Expand DownExpand Up@@ -233,24 +230,6 @@ export class Organization extends BaseResource implements OrganizationResource {
}).then(res => new OrganizationMembership(res?.response as OrganizationMembershipJSON));
};

getSubscriptions = async (
getSubscriptionsParams?: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(getSubscriptionsParams),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

destroy = async (): Promise<void> => {
return this._baseDelete();
};
Expand Down
62 changes: 0 additions & 62 deletions packages/shared/src/react/hooks/useOrganization.tsx
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
/* eslint-disable jsdoc/require-description-complete-sentence */
import type {
ClerkPaginatedResponse,
CommerceSubscriptionItemResource,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMembersParams,
GetSubscriptionsParams,
OrganizationDomainResource,
OrganizationInvitationResource,
OrganizationMembershipRequestResource,
Expand DownExpand Up@@ -66,16 +64,6 @@ export type UseOrganizationParams = {
* </ul>
*/
invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* If set to `true`, all default properties will be used.<br />
* Otherwise, accepts an object with the following optional properties:
* <ul>
* <li>`orgId`: A string that filters the subscriptions by the provided organization ID.</li>
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
* </ul>
*/
subscriptions?: true | PaginatedHookConfig<GetSubscriptionsParams>;
};

/**
Expand DownExpand Up@@ -111,11 +99,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
* Includes a paginated list of the organization's invitations.
*/
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* Includes a paginated list of the organization's subscriptions.
*/
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: true;
Expand All@@ -125,7 +108,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: boolean;
Expand All@@ -147,10 +129,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
OrganizationInvitationResource,
T['invitations'] extends { infinite: true } ? true : false
> | null;
subscriptions: PaginatedResources<
CommerceSubscriptionItemResource,
T['subscriptions'] extends { infinite: true } ? true : false
> | null;
};

const undefinedPaginatedResource = {
Expand DownExpand Up@@ -300,7 +278,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: membershipRequestsListParams,
memberships: membersListParams,
invitations: invitationsListParams,
subscriptions: subscriptionsListParams,
} = params || {};

useAssertWrappedByClerkProvider('useOrganization');
Expand DownExpand Up@@ -341,13 +318,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
infinite: false,
});

const subscriptionsSafeValues = useWithSafeValues(subscriptionsListParams, {
initialPage: 1,
pageSize: 10,
keepPreviousData: false,
infinite: false,
});

const clerk = useClerkInstanceContext();

clerk.telemetry?.record(eventMethodCalled('useOrganization'));
Expand DownExpand Up@@ -389,15 +359,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
status: invitationsSafeValues.status,
};

const subscriptionsParams =
typeof subscriptionsListParams === 'undefined'
? undefined
: {
initialPage: subscriptionsSafeValues.initialPage,
pageSize: subscriptionsSafeValues.pageSize,
orgId: organization?.id,
};

const domains = usePagesOrInfinite<GetDomainsParams, ClerkPaginatedResponse<OrganizationDomainResource>>(
{
...domainParams,
Expand DownExpand Up@@ -463,25 +424,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
},
);

const subscriptions = usePagesOrInfinite<
GetSubscriptionsParams,
ClerkPaginatedResponse<CommerceSubscriptionItemResource>
>(
{
...subscriptionsParams,
},
organization?.getSubscriptions,
{
keepPreviousData: subscriptionsSafeValues.keepPreviousData,
infinite: subscriptionsSafeValues.infinite,
enabled: !!subscriptionsParams,
},
{
type: 'subscriptions',
organizationId: organization?.id,
},
);

if (organization === undefined) {
return {
isLoaded: false,
Expand All@@ -491,7 +433,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -504,7 +445,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: null,
memberships: null,
invitations: null,
subscriptions: null,
};
}

Expand All@@ -518,7 +458,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -531,6 +470,5 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests,
memberships,
invitations,
subscriptions,
};
}
23 changes: 0 additions & 23 deletions packages/types/src/commerce.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,19 +69,6 @@ export interface CommerceBillingNamespace {
*/
getSubscription: (params: GetSubscriptionParams) => Promise<CommerceSubscriptionResource>;

/**
* @deprecated Use `getSubscription` to fetch a single subscription with its items
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
getSubscriptions: (
params: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand DownExpand Up@@ -792,16 +779,6 @@ export interface CommerceStatementGroup {
items: CommercePaymentResource[];
}

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
export type GetSubscriptionsParams = WithOptionalOrgType<ClerkPaginationParams>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand Down
12 changes: 1 addition & 11 deletions packages/types/src/organization.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
import type {
CommercePaymentSourceMethods,
CommerceSubscriptionItemResource,
GetSubscriptionsParams,
} from './commerce';
import type { CommercePaymentSourceMethods } from './commerce';
import type { OrganizationDomainResource, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationResource, OrganizationInvitationStatus } from './organizationInvitation';
import type { OrganizationCustomRoleKey, OrganizationMembershipResource } from './organizationMembership';
Expand DownExpand Up@@ -60,12 +56,6 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
getMembershipRequests: (
params?: GetMembershipRequestParams,
) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
*/
getSubscriptions: (
params?: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;
addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;
inviteMembers: (params: InviteMembersParams) => Promise<OrganizationInvitationResource[]>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/chilly-dots-heal.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Removal of Billing experimental methods: `organization.getSubscriptions()` and `billing.getSubscriptions()`
13 changes: 13 additions & 0 deletions .changeset/upset-masks-ask.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'@clerk/shared': minor
'@clerk/astro': minor
'@clerk/chrome-extension': minor
'@clerk/clerk-expo': minor
'@clerk/nextjs': minor
'@clerk/clerk-react': minor
'@clerk/react-router': minor
'@clerk/remix': minor
'@clerk/tanstack-react-start': minor
---

[Billing Beta] Drop experimental `subscriptions` property from params of `useOrganization()`. Use [`useSubscription()`](https://clerk.com/docs/nextjs/hooks/use-subscription) instead.
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,6 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"types/get-plans-params.mdx",
"types/get-statements-params.mdx",
"types/get-subscription-params.mdx",
"types/get-subscriptions-params.mdx",
"types/get-token.mdx",
"types/id-selectors.mdx",
"types/initialize-payment-source-params.mdx",
Expand Down
24 changes: 0 additions & 24 deletions packages/clerk-js/src/core/modules/commerce/CommerceBilling.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,13 @@ import type {
CommercePlanResource,
CommerceStatementJSON,
CommerceStatementResource,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CommerceSubscriptionJSON,
CommerceSubscriptionResource,
CreateCheckoutParams,
GetPaymentAttemptsParams,
GetPlansParams,
GetStatementsParams,
GetSubscriptionParams,
GetSubscriptionsParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
Expand All@@ -28,7 +25,6 @@ import {
CommercePlan,
CommerceStatement,
CommerceSubscription,
CommerceSubscriptionItem,
} from '../../resources/internal';

export class CommerceBilling implements CommerceBillingNamespace {
Expand DownExpand Up@@ -65,26 +61,6 @@ export class CommerceBilling implements CommerceBillingNamespace {
}).then(res => new CommerceSubscription(res?.response as CommerceSubscriptionJSON));
};

getSubscriptions = async (
params: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
const { orgId, ...rest } = params;

return await BaseResource._fetch({
path: orgId ? `/organizations/${orgId}/commerce/subscriptions` : `/me/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(rest),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

getStatements = async (params: GetStatementsParams): Promise<ClerkPaginatedResponse<CommerceStatementResource>> => {
const { orgId, ...rest } = params;

Expand Down
23 changes: 1 addition & 22 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,15 +2,12 @@ import type {
AddMemberParams,
ClerkPaginatedResponse,
ClerkResourceReloadParams,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CreateOrganizationParams,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMemberships,
GetRolesParams,
GetSubscriptionsParams,
InviteMemberParams,
InviteMembersParams,
OrganizationDomainJSON,
Expand All@@ -32,7 +29,7 @@ import type {
import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscriptionItem, OrganizationInvitation, OrganizationMembership } from './internal';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';
Expand DownExpand Up@@ -233,24 +230,6 @@ export class Organization extends BaseResource implements OrganizationResource {
}).then(res => new OrganizationMembership(res?.response as OrganizationMembershipJSON));
};

getSubscriptions = async (
getSubscriptionsParams?: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(getSubscriptionsParams),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

destroy = async (): Promise<void> => {
return this._baseDelete();
};
Expand Down
62 changes: 0 additions & 62 deletions packages/shared/src/react/hooks/useOrganization.tsx
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
/* eslint-disable jsdoc/require-description-complete-sentence */
import type {
ClerkPaginatedResponse,
CommerceSubscriptionItemResource,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMembersParams,
GetSubscriptionsParams,
OrganizationDomainResource,
OrganizationInvitationResource,
OrganizationMembershipRequestResource,
Expand DownExpand Up@@ -66,16 +64,6 @@ export type UseOrganizationParams = {
* </ul>
*/
invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* If set to `true`, all default properties will be used.<br />
* Otherwise, accepts an object with the following optional properties:
* <ul>
* <li>`orgId`: A string that filters the subscriptions by the provided organization ID.</li>
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
* </ul>
*/
subscriptions?: true | PaginatedHookConfig<GetSubscriptionsParams>;
};

/**
Expand DownExpand Up@@ -111,11 +99,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
* Includes a paginated list of the organization's invitations.
*/
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* Includes a paginated list of the organization's subscriptions.
*/
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: true;
Expand All@@ -125,7 +108,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: boolean;
Expand All@@ -147,10 +129,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
OrganizationInvitationResource,
T['invitations'] extends { infinite: true } ? true : false
> | null;
subscriptions: PaginatedResources<
CommerceSubscriptionItemResource,
T['subscriptions'] extends { infinite: true } ? true : false
> | null;
};

const undefinedPaginatedResource = {
Expand DownExpand Up@@ -300,7 +278,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: membershipRequestsListParams,
memberships: membersListParams,
invitations: invitationsListParams,
subscriptions: subscriptionsListParams,
} = params || {};

useAssertWrappedByClerkProvider('useOrganization');
Expand DownExpand Up@@ -341,13 +318,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
infinite: false,
});

const subscriptionsSafeValues = useWithSafeValues(subscriptionsListParams, {
initialPage: 1,
pageSize: 10,
keepPreviousData: false,
infinite: false,
});

const clerk = useClerkInstanceContext();

clerk.telemetry?.record(eventMethodCalled('useOrganization'));
Expand DownExpand Up@@ -389,15 +359,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
status: invitationsSafeValues.status,
};

const subscriptionsParams =
typeof subscriptionsListParams === 'undefined'
? undefined
: {
initialPage: subscriptionsSafeValues.initialPage,
pageSize: subscriptionsSafeValues.pageSize,
orgId: organization?.id,
};

const domains = usePagesOrInfinite<GetDomainsParams, ClerkPaginatedResponse<OrganizationDomainResource>>(
{
...domainParams,
Expand DownExpand Up@@ -463,25 +424,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
},
);

const subscriptions = usePagesOrInfinite<
GetSubscriptionsParams,
ClerkPaginatedResponse<CommerceSubscriptionItemResource>
>(
{
...subscriptionsParams,
},
organization?.getSubscriptions,
{
keepPreviousData: subscriptionsSafeValues.keepPreviousData,
infinite: subscriptionsSafeValues.infinite,
enabled: !!subscriptionsParams,
},
{
type: 'subscriptions',
organizationId: organization?.id,
},
);

if (organization === undefined) {
return {
isLoaded: false,
Expand All@@ -491,7 +433,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -504,7 +445,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: null,
memberships: null,
invitations: null,
subscriptions: null,
};
}

Expand All@@ -518,7 +458,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -531,6 +470,5 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests,
memberships,
invitations,
subscriptions,
};
}
23 changes: 0 additions & 23 deletions packages/types/src/commerce.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,19 +69,6 @@ export interface CommerceBillingNamespace {
*/
getSubscription: (params: GetSubscriptionParams) => Promise<CommerceSubscriptionResource>;

/**
* @deprecated Use `getSubscription` to fetch a single subscription with its items
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
getSubscriptions: (
params: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand DownExpand Up@@ -792,16 +779,6 @@ export interface CommerceStatementGroup {
items: CommercePaymentResource[];
}

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
export type GetSubscriptionsParams = WithOptionalOrgType<ClerkPaginationParams>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand Down
12 changes: 1 addition & 11 deletions packages/types/src/organization.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
import type {
CommercePaymentSourceMethods,
CommerceSubscriptionItemResource,
GetSubscriptionsParams,
} from './commerce';
import type { CommercePaymentSourceMethods } from './commerce';
import type { OrganizationDomainResource, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationResource, OrganizationInvitationStatus } from './organizationInvitation';
import type { OrganizationCustomRoleKey, OrganizationMembershipResource } from './organizationMembership';
Expand DownExpand Up@@ -60,12 +56,6 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
getMembershipRequests: (
params?: GetMembershipRequestParams,
) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
*/
getSubscriptions: (
params?: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;
addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;
inviteMembers: (params: InviteMembersParams) => Promise<OrganizationInvitationResource[]>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/chilly-dots-heal.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Removal of Billing experimental methods: `organization.getSubscriptions()` and `billing.getSubscriptions()`
13 changes: 13 additions & 0 deletions .changeset/upset-masks-ask.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'@clerk/shared': minor
'@clerk/astro': minor
'@clerk/chrome-extension': minor
'@clerk/clerk-expo': minor
'@clerk/nextjs': minor
'@clerk/clerk-react': minor
'@clerk/react-router': minor
'@clerk/remix': minor
'@clerk/tanstack-react-start': minor
---

[Billing Beta] Drop experimental `subscriptions` property from params of `useOrganization()`. Use [`useSubscription()`](https://clerk.com/docs/nextjs/hooks/use-subscription) instead.
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,6 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"types/get-plans-params.mdx",
"types/get-statements-params.mdx",
"types/get-subscription-params.mdx",
"types/get-subscriptions-params.mdx",
"types/get-token.mdx",
"types/id-selectors.mdx",
"types/initialize-payment-source-params.mdx",
Expand Down
24 changes: 0 additions & 24 deletions packages/clerk-js/src/core/modules/commerce/CommerceBilling.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,13 @@ import type {
CommercePlanResource,
CommerceStatementJSON,
CommerceStatementResource,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CommerceSubscriptionJSON,
CommerceSubscriptionResource,
CreateCheckoutParams,
GetPaymentAttemptsParams,
GetPlansParams,
GetStatementsParams,
GetSubscriptionParams,
GetSubscriptionsParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
Expand All@@ -28,7 +25,6 @@ import {
CommercePlan,
CommerceStatement,
CommerceSubscription,
CommerceSubscriptionItem,
} from '../../resources/internal';

export class CommerceBilling implements CommerceBillingNamespace {
Expand DownExpand Up@@ -65,26 +61,6 @@ export class CommerceBilling implements CommerceBillingNamespace {
}).then(res => new CommerceSubscription(res?.response as CommerceSubscriptionJSON));
};

getSubscriptions = async (
params: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
const { orgId, ...rest } = params;

return await BaseResource._fetch({
path: orgId ? `/organizations/${orgId}/commerce/subscriptions` : `/me/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(rest),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

getStatements = async (params: GetStatementsParams): Promise<ClerkPaginatedResponse<CommerceStatementResource>> => {
const { orgId, ...rest } = params;

Expand Down
23 changes: 1 addition & 22 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,15 +2,12 @@ import type {
AddMemberParams,
ClerkPaginatedResponse,
ClerkResourceReloadParams,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CreateOrganizationParams,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMemberships,
GetRolesParams,
GetSubscriptionsParams,
InviteMemberParams,
InviteMembersParams,
OrganizationDomainJSON,
Expand All@@ -32,7 +29,7 @@ import type {
import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscriptionItem, OrganizationInvitation, OrganizationMembership } from './internal';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';
Expand DownExpand Up@@ -233,24 +230,6 @@ export class Organization extends BaseResource implements OrganizationResource {
}).then(res => new OrganizationMembership(res?.response as OrganizationMembershipJSON));
};

getSubscriptions = async (
getSubscriptionsParams?: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(getSubscriptionsParams),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

destroy = async (): Promise<void> => {
return this._baseDelete();
};
Expand Down
62 changes: 0 additions & 62 deletions packages/shared/src/react/hooks/useOrganization.tsx
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
/* eslint-disable jsdoc/require-description-complete-sentence */
import type {
ClerkPaginatedResponse,
CommerceSubscriptionItemResource,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMembersParams,
GetSubscriptionsParams,
OrganizationDomainResource,
OrganizationInvitationResource,
OrganizationMembershipRequestResource,
Expand DownExpand Up@@ -66,16 +64,6 @@ export type UseOrganizationParams = {
* </ul>
*/
invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* If set to `true`, all default properties will be used.<br />
* Otherwise, accepts an object with the following optional properties:
* <ul>
* <li>`orgId`: A string that filters the subscriptions by the provided organization ID.</li>
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
* </ul>
*/
subscriptions?: true | PaginatedHookConfig<GetSubscriptionsParams>;
};

/**
Expand DownExpand Up@@ -111,11 +99,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
* Includes a paginated list of the organization's invitations.
*/
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* Includes a paginated list of the organization's subscriptions.
*/
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: true;
Expand All@@ -125,7 +108,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: boolean;
Expand All@@ -147,10 +129,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
OrganizationInvitationResource,
T['invitations'] extends { infinite: true } ? true : false
> | null;
subscriptions: PaginatedResources<
CommerceSubscriptionItemResource,
T['subscriptions'] extends { infinite: true } ? true : false
> | null;
};

const undefinedPaginatedResource = {
Expand DownExpand Up@@ -300,7 +278,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: membershipRequestsListParams,
memberships: membersListParams,
invitations: invitationsListParams,
subscriptions: subscriptionsListParams,
} = params || {};

useAssertWrappedByClerkProvider('useOrganization');
Expand DownExpand Up@@ -341,13 +318,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
infinite: false,
});

const subscriptionsSafeValues = useWithSafeValues(subscriptionsListParams, {
initialPage: 1,
pageSize: 10,
keepPreviousData: false,
infinite: false,
});

const clerk = useClerkInstanceContext();

clerk.telemetry?.record(eventMethodCalled('useOrganization'));
Expand DownExpand Up@@ -389,15 +359,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
status: invitationsSafeValues.status,
};

const subscriptionsParams =
typeof subscriptionsListParams === 'undefined'
? undefined
: {
initialPage: subscriptionsSafeValues.initialPage,
pageSize: subscriptionsSafeValues.pageSize,
orgId: organization?.id,
};

const domains = usePagesOrInfinite<GetDomainsParams, ClerkPaginatedResponse<OrganizationDomainResource>>(
{
...domainParams,
Expand DownExpand Up@@ -463,25 +424,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
},
);

const subscriptions = usePagesOrInfinite<
GetSubscriptionsParams,
ClerkPaginatedResponse<CommerceSubscriptionItemResource>
>(
{
...subscriptionsParams,
},
organization?.getSubscriptions,
{
keepPreviousData: subscriptionsSafeValues.keepPreviousData,
infinite: subscriptionsSafeValues.infinite,
enabled: !!subscriptionsParams,
},
{
type: 'subscriptions',
organizationId: organization?.id,
},
);

if (organization === undefined) {
return {
isLoaded: false,
Expand All@@ -491,7 +433,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -504,7 +445,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: null,
memberships: null,
invitations: null,
subscriptions: null,
};
}

Expand All@@ -518,7 +458,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -531,6 +470,5 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests,
memberships,
invitations,
subscriptions,
};
}
23 changes: 0 additions & 23 deletions packages/types/src/commerce.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,19 +69,6 @@ export interface CommerceBillingNamespace {
*/
getSubscription: (params: GetSubscriptionParams) => Promise<CommerceSubscriptionResource>;

/**
* @deprecated Use `getSubscription` to fetch a single subscription with its items
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
getSubscriptions: (
params: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand DownExpand Up@@ -792,16 +779,6 @@ export interface CommerceStatementGroup {
items: CommercePaymentResource[];
}

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
export type GetSubscriptionsParams = WithOptionalOrgType<ClerkPaginationParams>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand Down
12 changes: 1 addition & 11 deletions packages/types/src/organization.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
import type {
CommercePaymentSourceMethods,
CommerceSubscriptionItemResource,
GetSubscriptionsParams,
} from './commerce';
import type { CommercePaymentSourceMethods } from './commerce';
import type { OrganizationDomainResource, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationResource, OrganizationInvitationStatus } from './organizationInvitation';
import type { OrganizationCustomRoleKey, OrganizationMembershipResource } from './organizationMembership';
Expand DownExpand Up@@ -60,12 +56,6 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
getMembershipRequests: (
params?: GetMembershipRequestParams,
) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
*/
getSubscriptions: (
params?: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;
addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;
inviteMembers: (params: InviteMembersParams) => Promise<OrganizationInvitationResource[]>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/chilly-dots-heal.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Removal of Billing experimental methods: `organization.getSubscriptions()` and `billing.getSubscriptions()`
13 changes: 13 additions & 0 deletions .changeset/upset-masks-ask.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'@clerk/shared': minor
'@clerk/astro': minor
'@clerk/chrome-extension': minor
'@clerk/clerk-expo': minor
'@clerk/nextjs': minor
'@clerk/clerk-react': minor
'@clerk/react-router': minor
'@clerk/remix': minor
'@clerk/tanstack-react-start': minor
---

[Billing Beta] Drop experimental `subscriptions` property from params of `useOrganization()`. Use [`useSubscription()`](https://clerk.com/docs/nextjs/hooks/use-subscription) instead.
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,6 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"types/get-plans-params.mdx",
"types/get-statements-params.mdx",
"types/get-subscription-params.mdx",
"types/get-subscriptions-params.mdx",
"types/get-token.mdx",
"types/id-selectors.mdx",
"types/initialize-payment-source-params.mdx",
Expand Down
24 changes: 0 additions & 24 deletions packages/clerk-js/src/core/modules/commerce/CommerceBilling.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,13 @@ import type {
CommercePlanResource,
CommerceStatementJSON,
CommerceStatementResource,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CommerceSubscriptionJSON,
CommerceSubscriptionResource,
CreateCheckoutParams,
GetPaymentAttemptsParams,
GetPlansParams,
GetStatementsParams,
GetSubscriptionParams,
GetSubscriptionsParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
Expand All@@ -28,7 +25,6 @@ import {
CommercePlan,
CommerceStatement,
CommerceSubscription,
CommerceSubscriptionItem,
} from '../../resources/internal';

export class CommerceBilling implements CommerceBillingNamespace {
Expand DownExpand Up@@ -65,26 +61,6 @@ export class CommerceBilling implements CommerceBillingNamespace {
}).then(res => new CommerceSubscription(res?.response as CommerceSubscriptionJSON));
};

getSubscriptions = async (
params: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
const { orgId, ...rest } = params;

return await BaseResource._fetch({
path: orgId ? `/organizations/${orgId}/commerce/subscriptions` : `/me/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(rest),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

getStatements = async (params: GetStatementsParams): Promise<ClerkPaginatedResponse<CommerceStatementResource>> => {
const { orgId, ...rest } = params;

Expand Down
23 changes: 1 addition & 22 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,15 +2,12 @@ import type {
AddMemberParams,
ClerkPaginatedResponse,
ClerkResourceReloadParams,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CreateOrganizationParams,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMemberships,
GetRolesParams,
GetSubscriptionsParams,
InviteMemberParams,
InviteMembersParams,
OrganizationDomainJSON,
Expand All@@ -32,7 +29,7 @@ import type {
import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscriptionItem, OrganizationInvitation, OrganizationMembership } from './internal';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';
Expand DownExpand Up@@ -233,24 +230,6 @@ export class Organization extends BaseResource implements OrganizationResource {
}).then(res => new OrganizationMembership(res?.response as OrganizationMembershipJSON));
};

getSubscriptions = async (
getSubscriptionsParams?: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(getSubscriptionsParams),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

destroy = async (): Promise<void> => {
return this._baseDelete();
};
Expand Down
62 changes: 0 additions & 62 deletions packages/shared/src/react/hooks/useOrganization.tsx
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
/* eslint-disable jsdoc/require-description-complete-sentence */
import type {
ClerkPaginatedResponse,
CommerceSubscriptionItemResource,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMembersParams,
GetSubscriptionsParams,
OrganizationDomainResource,
OrganizationInvitationResource,
OrganizationMembershipRequestResource,
Expand DownExpand Up@@ -66,16 +64,6 @@ export type UseOrganizationParams = {
* </ul>
*/
invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* If set to `true`, all default properties will be used.<br />
* Otherwise, accepts an object with the following optional properties:
* <ul>
* <li>`orgId`: A string that filters the subscriptions by the provided organization ID.</li>
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
* </ul>
*/
subscriptions?: true | PaginatedHookConfig<GetSubscriptionsParams>;
};

/**
Expand DownExpand Up@@ -111,11 +99,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
* Includes a paginated list of the organization's invitations.
*/
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* Includes a paginated list of the organization's subscriptions.
*/
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: true;
Expand All@@ -125,7 +108,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: boolean;
Expand All@@ -147,10 +129,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
OrganizationInvitationResource,
T['invitations'] extends { infinite: true } ? true : false
> | null;
subscriptions: PaginatedResources<
CommerceSubscriptionItemResource,
T['subscriptions'] extends { infinite: true } ? true : false
> | null;
};

const undefinedPaginatedResource = {
Expand DownExpand Up@@ -300,7 +278,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: membershipRequestsListParams,
memberships: membersListParams,
invitations: invitationsListParams,
subscriptions: subscriptionsListParams,
} = params || {};

useAssertWrappedByClerkProvider('useOrganization');
Expand DownExpand Up@@ -341,13 +318,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
infinite: false,
});

const subscriptionsSafeValues = useWithSafeValues(subscriptionsListParams, {
initialPage: 1,
pageSize: 10,
keepPreviousData: false,
infinite: false,
});

const clerk = useClerkInstanceContext();

clerk.telemetry?.record(eventMethodCalled('useOrganization'));
Expand DownExpand Up@@ -389,15 +359,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
status: invitationsSafeValues.status,
};

const subscriptionsParams =
typeof subscriptionsListParams === 'undefined'
? undefined
: {
initialPage: subscriptionsSafeValues.initialPage,
pageSize: subscriptionsSafeValues.pageSize,
orgId: organization?.id,
};

const domains = usePagesOrInfinite<GetDomainsParams, ClerkPaginatedResponse<OrganizationDomainResource>>(
{
...domainParams,
Expand DownExpand Up@@ -463,25 +424,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
},
);

const subscriptions = usePagesOrInfinite<
GetSubscriptionsParams,
ClerkPaginatedResponse<CommerceSubscriptionItemResource>
>(
{
...subscriptionsParams,
},
organization?.getSubscriptions,
{
keepPreviousData: subscriptionsSafeValues.keepPreviousData,
infinite: subscriptionsSafeValues.infinite,
enabled: !!subscriptionsParams,
},
{
type: 'subscriptions',
organizationId: organization?.id,
},
);

if (organization === undefined) {
return {
isLoaded: false,
Expand All@@ -491,7 +433,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -504,7 +445,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: null,
memberships: null,
invitations: null,
subscriptions: null,
};
}

Expand All@@ -518,7 +458,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -531,6 +470,5 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests,
memberships,
invitations,
subscriptions,
};
}
23 changes: 0 additions & 23 deletions packages/types/src/commerce.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,19 +69,6 @@ export interface CommerceBillingNamespace {
*/
getSubscription: (params: GetSubscriptionParams) => Promise<CommerceSubscriptionResource>;

/**
* @deprecated Use `getSubscription` to fetch a single subscription with its items
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
getSubscriptions: (
params: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand DownExpand Up@@ -792,16 +779,6 @@ export interface CommerceStatementGroup {
items: CommercePaymentResource[];
}

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
export type GetSubscriptionsParams = WithOptionalOrgType<ClerkPaginationParams>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand Down
12 changes: 1 addition & 11 deletions packages/types/src/organization.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
import type {
CommercePaymentSourceMethods,
CommerceSubscriptionItemResource,
GetSubscriptionsParams,
} from './commerce';
import type { CommercePaymentSourceMethods } from './commerce';
import type { OrganizationDomainResource, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationResource, OrganizationInvitationStatus } from './organizationInvitation';
import type { OrganizationCustomRoleKey, OrganizationMembershipResource } from './organizationMembership';
Expand DownExpand Up@@ -60,12 +56,6 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
getMembershipRequests: (
params?: GetMembershipRequestParams,
) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
*/
getSubscriptions: (
params?: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;
addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;
inviteMembers: (params: InviteMembersParams) => Promise<OrganizationInvitationResource[]>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/chilly-dots-heal.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Removal of Billing experimental methods: `organization.getSubscriptions()` and `billing.getSubscriptions()`
13 changes: 13 additions & 0 deletions .changeset/upset-masks-ask.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'@clerk/shared': minor
'@clerk/astro': minor
'@clerk/chrome-extension': minor
'@clerk/clerk-expo': minor
'@clerk/nextjs': minor
'@clerk/clerk-react': minor
'@clerk/react-router': minor
'@clerk/remix': minor
'@clerk/tanstack-react-start': minor
---

[Billing Beta] Drop experimental `subscriptions` property from params of `useOrganization()`. Use [`useSubscription()`](https://clerk.com/docs/nextjs/hooks/use-subscription) instead.
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,6 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"types/get-plans-params.mdx",
"types/get-statements-params.mdx",
"types/get-subscription-params.mdx",
"types/get-subscriptions-params.mdx",
"types/get-token.mdx",
"types/id-selectors.mdx",
"types/initialize-payment-source-params.mdx",
Expand Down
24 changes: 0 additions & 24 deletions packages/clerk-js/src/core/modules/commerce/CommerceBilling.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,13 @@ import type {
CommercePlanResource,
CommerceStatementJSON,
CommerceStatementResource,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CommerceSubscriptionJSON,
CommerceSubscriptionResource,
CreateCheckoutParams,
GetPaymentAttemptsParams,
GetPlansParams,
GetStatementsParams,
GetSubscriptionParams,
GetSubscriptionsParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
Expand All@@ -28,7 +25,6 @@ import {
CommercePlan,
CommerceStatement,
CommerceSubscription,
CommerceSubscriptionItem,
} from '../../resources/internal';

export class CommerceBilling implements CommerceBillingNamespace {
Expand DownExpand Up@@ -65,26 +61,6 @@ export class CommerceBilling implements CommerceBillingNamespace {
}).then(res => new CommerceSubscription(res?.response as CommerceSubscriptionJSON));
};

getSubscriptions = async (
params: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
const { orgId, ...rest } = params;

return await BaseResource._fetch({
path: orgId ? `/organizations/${orgId}/commerce/subscriptions` : `/me/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(rest),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

getStatements = async (params: GetStatementsParams): Promise<ClerkPaginatedResponse<CommerceStatementResource>> => {
const { orgId, ...rest } = params;

Expand Down
23 changes: 1 addition & 22 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,15 +2,12 @@ import type {
AddMemberParams,
ClerkPaginatedResponse,
ClerkResourceReloadParams,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CreateOrganizationParams,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMemberships,
GetRolesParams,
GetSubscriptionsParams,
InviteMemberParams,
InviteMembersParams,
OrganizationDomainJSON,
Expand All@@ -32,7 +29,7 @@ import type {
import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscriptionItem, OrganizationInvitation, OrganizationMembership } from './internal';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';
Expand DownExpand Up@@ -233,24 +230,6 @@ export class Organization extends BaseResource implements OrganizationResource {
}).then(res => new OrganizationMembership(res?.response as OrganizationMembershipJSON));
};

getSubscriptions = async (
getSubscriptionsParams?: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(getSubscriptionsParams),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

destroy = async (): Promise<void> => {
return this._baseDelete();
};
Expand Down
62 changes: 0 additions & 62 deletions packages/shared/src/react/hooks/useOrganization.tsx
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
/* eslint-disable jsdoc/require-description-complete-sentence */
import type {
ClerkPaginatedResponse,
CommerceSubscriptionItemResource,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMembersParams,
GetSubscriptionsParams,
OrganizationDomainResource,
OrganizationInvitationResource,
OrganizationMembershipRequestResource,
Expand DownExpand Up@@ -66,16 +64,6 @@ export type UseOrganizationParams = {
* </ul>
*/
invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* If set to `true`, all default properties will be used.<br />
* Otherwise, accepts an object with the following optional properties:
* <ul>
* <li>`orgId`: A string that filters the subscriptions by the provided organization ID.</li>
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
* </ul>
*/
subscriptions?: true | PaginatedHookConfig<GetSubscriptionsParams>;
};

/**
Expand DownExpand Up@@ -111,11 +99,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
* Includes a paginated list of the organization's invitations.
*/
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* Includes a paginated list of the organization's subscriptions.
*/
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: true;
Expand All@@ -125,7 +108,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: boolean;
Expand All@@ -147,10 +129,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
OrganizationInvitationResource,
T['invitations'] extends { infinite: true } ? true : false
> | null;
subscriptions: PaginatedResources<
CommerceSubscriptionItemResource,
T['subscriptions'] extends { infinite: true } ? true : false
> | null;
};

const undefinedPaginatedResource = {
Expand DownExpand Up@@ -300,7 +278,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: membershipRequestsListParams,
memberships: membersListParams,
invitations: invitationsListParams,
subscriptions: subscriptionsListParams,
} = params || {};

useAssertWrappedByClerkProvider('useOrganization');
Expand DownExpand Up@@ -341,13 +318,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
infinite: false,
});

const subscriptionsSafeValues = useWithSafeValues(subscriptionsListParams, {
initialPage: 1,
pageSize: 10,
keepPreviousData: false,
infinite: false,
});

const clerk = useClerkInstanceContext();

clerk.telemetry?.record(eventMethodCalled('useOrganization'));
Expand DownExpand Up@@ -389,15 +359,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
status: invitationsSafeValues.status,
};

const subscriptionsParams =
typeof subscriptionsListParams === 'undefined'
? undefined
: {
initialPage: subscriptionsSafeValues.initialPage,
pageSize: subscriptionsSafeValues.pageSize,
orgId: organization?.id,
};

const domains = usePagesOrInfinite<GetDomainsParams, ClerkPaginatedResponse<OrganizationDomainResource>>(
{
...domainParams,
Expand DownExpand Up@@ -463,25 +424,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
},
);

const subscriptions = usePagesOrInfinite<
GetSubscriptionsParams,
ClerkPaginatedResponse<CommerceSubscriptionItemResource>
>(
{
...subscriptionsParams,
},
organization?.getSubscriptions,
{
keepPreviousData: subscriptionsSafeValues.keepPreviousData,
infinite: subscriptionsSafeValues.infinite,
enabled: !!subscriptionsParams,
},
{
type: 'subscriptions',
organizationId: organization?.id,
},
);

if (organization === undefined) {
return {
isLoaded: false,
Expand All@@ -491,7 +433,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -504,7 +445,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: null,
memberships: null,
invitations: null,
subscriptions: null,
};
}

Expand All@@ -518,7 +458,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -531,6 +470,5 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests,
memberships,
invitations,
subscriptions,
};
}
23 changes: 0 additions & 23 deletions packages/types/src/commerce.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,19 +69,6 @@ export interface CommerceBillingNamespace {
*/
getSubscription: (params: GetSubscriptionParams) => Promise<CommerceSubscriptionResource>;

/**
* @deprecated Use `getSubscription` to fetch a single subscription with its items
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
getSubscriptions: (
params: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand DownExpand Up@@ -792,16 +779,6 @@ export interface CommerceStatementGroup {
items: CommercePaymentResource[];
}

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
export type GetSubscriptionsParams = WithOptionalOrgType<ClerkPaginationParams>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand Down
12 changes: 1 addition & 11 deletions packages/types/src/organization.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
import type {
CommercePaymentSourceMethods,
CommerceSubscriptionItemResource,
GetSubscriptionsParams,
} from './commerce';
import type { CommercePaymentSourceMethods } from './commerce';
import type { OrganizationDomainResource, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationResource, OrganizationInvitationStatus } from './organizationInvitation';
import type { OrganizationCustomRoleKey, OrganizationMembershipResource } from './organizationMembership';
Expand DownExpand Up@@ -60,12 +56,6 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
getMembershipRequests: (
params?: GetMembershipRequestParams,
) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
*/
getSubscriptions: (
params?: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;
addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;
inviteMembers: (params: InviteMembersParams) => Promise<OrganizationInvitationResource[]>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/chilly-dots-heal.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Removal of Billing experimental methods: `organization.getSubscriptions()` and `billing.getSubscriptions()`
13 changes: 13 additions & 0 deletions .changeset/upset-masks-ask.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'@clerk/shared': minor
'@clerk/astro': minor
'@clerk/chrome-extension': minor
'@clerk/clerk-expo': minor
'@clerk/nextjs': minor
'@clerk/clerk-react': minor
'@clerk/react-router': minor
'@clerk/remix': minor
'@clerk/tanstack-react-start': minor
---

[Billing Beta] Drop experimental `subscriptions` property from params of `useOrganization()`. Use [`useSubscription()`](https://clerk.com/docs/nextjs/hooks/use-subscription) instead.
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,6 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"types/get-plans-params.mdx",
"types/get-statements-params.mdx",
"types/get-subscription-params.mdx",
"types/get-subscriptions-params.mdx",
"types/get-token.mdx",
"types/id-selectors.mdx",
"types/initialize-payment-source-params.mdx",
Expand Down
24 changes: 0 additions & 24 deletions packages/clerk-js/src/core/modules/commerce/CommerceBilling.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,13 @@ import type {
CommercePlanResource,
CommerceStatementJSON,
CommerceStatementResource,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CommerceSubscriptionJSON,
CommerceSubscriptionResource,
CreateCheckoutParams,
GetPaymentAttemptsParams,
GetPlansParams,
GetStatementsParams,
GetSubscriptionParams,
GetSubscriptionsParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
Expand All@@ -28,7 +25,6 @@ import {
CommercePlan,
CommerceStatement,
CommerceSubscription,
CommerceSubscriptionItem,
} from '../../resources/internal';

export class CommerceBilling implements CommerceBillingNamespace {
Expand DownExpand Up@@ -65,26 +61,6 @@ export class CommerceBilling implements CommerceBillingNamespace {
}).then(res => new CommerceSubscription(res?.response as CommerceSubscriptionJSON));
};

getSubscriptions = async (
params: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
const { orgId, ...rest } = params;

return await BaseResource._fetch({
path: orgId ? `/organizations/${orgId}/commerce/subscriptions` : `/me/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(rest),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

getStatements = async (params: GetStatementsParams): Promise<ClerkPaginatedResponse<CommerceStatementResource>> => {
const { orgId, ...rest } = params;

Expand Down
23 changes: 1 addition & 22 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,15 +2,12 @@ import type {
AddMemberParams,
ClerkPaginatedResponse,
ClerkResourceReloadParams,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CreateOrganizationParams,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMemberships,
GetRolesParams,
GetSubscriptionsParams,
InviteMemberParams,
InviteMembersParams,
OrganizationDomainJSON,
Expand All@@ -32,7 +29,7 @@ import type {
import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscriptionItem, OrganizationInvitation, OrganizationMembership } from './internal';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';
Expand DownExpand Up@@ -233,24 +230,6 @@ export class Organization extends BaseResource implements OrganizationResource {
}).then(res => new OrganizationMembership(res?.response as OrganizationMembershipJSON));
};

getSubscriptions = async (
getSubscriptionsParams?: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(getSubscriptionsParams),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

destroy = async (): Promise<void> => {
return this._baseDelete();
};
Expand Down
62 changes: 0 additions & 62 deletions packages/shared/src/react/hooks/useOrganization.tsx
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
/* eslint-disable jsdoc/require-description-complete-sentence */
import type {
ClerkPaginatedResponse,
CommerceSubscriptionItemResource,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMembersParams,
GetSubscriptionsParams,
OrganizationDomainResource,
OrganizationInvitationResource,
OrganizationMembershipRequestResource,
Expand DownExpand Up@@ -66,16 +64,6 @@ export type UseOrganizationParams = {
* </ul>
*/
invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* If set to `true`, all default properties will be used.<br />
* Otherwise, accepts an object with the following optional properties:
* <ul>
* <li>`orgId`: A string that filters the subscriptions by the provided organization ID.</li>
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
* </ul>
*/
subscriptions?: true | PaginatedHookConfig<GetSubscriptionsParams>;
};

/**
Expand DownExpand Up@@ -111,11 +99,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
* Includes a paginated list of the organization's invitations.
*/
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* Includes a paginated list of the organization's subscriptions.
*/
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: true;
Expand All@@ -125,7 +108,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: boolean;
Expand All@@ -147,10 +129,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
OrganizationInvitationResource,
T['invitations'] extends { infinite: true } ? true : false
> | null;
subscriptions: PaginatedResources<
CommerceSubscriptionItemResource,
T['subscriptions'] extends { infinite: true } ? true : false
> | null;
};

const undefinedPaginatedResource = {
Expand DownExpand Up@@ -300,7 +278,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: membershipRequestsListParams,
memberships: membersListParams,
invitations: invitationsListParams,
subscriptions: subscriptionsListParams,
} = params || {};

useAssertWrappedByClerkProvider('useOrganization');
Expand DownExpand Up@@ -341,13 +318,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
infinite: false,
});

const subscriptionsSafeValues = useWithSafeValues(subscriptionsListParams, {
initialPage: 1,
pageSize: 10,
keepPreviousData: false,
infinite: false,
});

const clerk = useClerkInstanceContext();

clerk.telemetry?.record(eventMethodCalled('useOrganization'));
Expand DownExpand Up@@ -389,15 +359,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
status: invitationsSafeValues.status,
};

const subscriptionsParams =
typeof subscriptionsListParams === 'undefined'
? undefined
: {
initialPage: subscriptionsSafeValues.initialPage,
pageSize: subscriptionsSafeValues.pageSize,
orgId: organization?.id,
};

const domains = usePagesOrInfinite<GetDomainsParams, ClerkPaginatedResponse<OrganizationDomainResource>>(
{
...domainParams,
Expand DownExpand Up@@ -463,25 +424,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
},
);

const subscriptions = usePagesOrInfinite<
GetSubscriptionsParams,
ClerkPaginatedResponse<CommerceSubscriptionItemResource>
>(
{
...subscriptionsParams,
},
organization?.getSubscriptions,
{
keepPreviousData: subscriptionsSafeValues.keepPreviousData,
infinite: subscriptionsSafeValues.infinite,
enabled: !!subscriptionsParams,
},
{
type: 'subscriptions',
organizationId: organization?.id,
},
);

if (organization === undefined) {
return {
isLoaded: false,
Expand All@@ -491,7 +433,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -504,7 +445,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: null,
memberships: null,
invitations: null,
subscriptions: null,
};
}

Expand All@@ -518,7 +458,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -531,6 +470,5 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests,
memberships,
invitations,
subscriptions,
};
}
23 changes: 0 additions & 23 deletions packages/types/src/commerce.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,19 +69,6 @@ export interface CommerceBillingNamespace {
*/
getSubscription: (params: GetSubscriptionParams) => Promise<CommerceSubscriptionResource>;

/**
* @deprecated Use `getSubscription` to fetch a single subscription with its items
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
getSubscriptions: (
params: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand DownExpand Up@@ -792,16 +779,6 @@ export interface CommerceStatementGroup {
items: CommercePaymentResource[];
}

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
export type GetSubscriptionsParams = WithOptionalOrgType<ClerkPaginationParams>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand Down
12 changes: 1 addition & 11 deletions packages/types/src/organization.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
import type {
CommercePaymentSourceMethods,
CommerceSubscriptionItemResource,
GetSubscriptionsParams,
} from './commerce';
import type { CommercePaymentSourceMethods } from './commerce';
import type { OrganizationDomainResource, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationResource, OrganizationInvitationStatus } from './organizationInvitation';
import type { OrganizationCustomRoleKey, OrganizationMembershipResource } from './organizationMembership';
Expand DownExpand Up@@ -60,12 +56,6 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
getMembershipRequests: (
params?: GetMembershipRequestParams,
) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
*/
getSubscriptions: (
params?: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;
addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;
inviteMembers: (params: InviteMembersParams) => Promise<OrganizationInvitationResource[]>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/chilly-dots-heal.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Billing Beta] Removal of Billing experimental methods: `organization.getSubscriptions()` and `billing.getSubscriptions()`
13 changes: 13 additions & 0 deletions .changeset/upset-masks-ask.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
---
'@clerk/shared': minor
'@clerk/astro': minor
'@clerk/chrome-extension': minor
'@clerk/clerk-expo': minor
'@clerk/nextjs': minor
'@clerk/clerk-react': minor
'@clerk/react-router': minor
'@clerk/remix': minor
'@clerk/tanstack-react-start': minor
---

[Billing Beta] Drop experimental `subscriptions` property from params of `useOrganization()`. Use [`useSubscription()`](https://clerk.com/docs/nextjs/hooks/use-subscription) instead.
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,6 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"types/get-plans-params.mdx",
"types/get-statements-params.mdx",
"types/get-subscription-params.mdx",
"types/get-subscriptions-params.mdx",
"types/get-token.mdx",
"types/id-selectors.mdx",
"types/initialize-payment-source-params.mdx",
Expand Down
24 changes: 0 additions & 24 deletions packages/clerk-js/src/core/modules/commerce/CommerceBilling.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,13 @@ import type {
CommercePlanResource,
CommerceStatementJSON,
CommerceStatementResource,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CommerceSubscriptionJSON,
CommerceSubscriptionResource,
CreateCheckoutParams,
GetPaymentAttemptsParams,
GetPlansParams,
GetStatementsParams,
GetSubscriptionParams,
GetSubscriptionsParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
Expand All@@ -28,7 +25,6 @@ import {
CommercePlan,
CommerceStatement,
CommerceSubscription,
CommerceSubscriptionItem,
} from '../../resources/internal';

export class CommerceBilling implements CommerceBillingNamespace {
Expand DownExpand Up@@ -65,26 +61,6 @@ export class CommerceBilling implements CommerceBillingNamespace {
}).then(res => new CommerceSubscription(res?.response as CommerceSubscriptionJSON));
};

getSubscriptions = async (
params: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
const { orgId, ...rest } = params;

return await BaseResource._fetch({
path: orgId ? `/organizations/${orgId}/commerce/subscriptions` : `/me/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(rest),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

getStatements = async (params: GetStatementsParams): Promise<ClerkPaginatedResponse<CommerceStatementResource>> => {
const { orgId, ...rest } = params;

Expand Down
23 changes: 1 addition & 22 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,15 +2,12 @@ import type {
AddMemberParams,
ClerkPaginatedResponse,
ClerkResourceReloadParams,
CommerceSubscriptionItemJSON,
CommerceSubscriptionItemResource,
CreateOrganizationParams,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMemberships,
GetRolesParams,
GetSubscriptionsParams,
InviteMemberParams,
InviteMembersParams,
OrganizationDomainJSON,
Expand All@@ -32,7 +29,7 @@ import type {
import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscriptionItem, OrganizationInvitation, OrganizationMembership } from './internal';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';
Expand DownExpand Up@@ -233,24 +230,6 @@ export class Organization extends BaseResource implements OrganizationResource {
}).then(res => new OrganizationMembership(res?.response as OrganizationMembershipJSON));
};

getSubscriptions = async (
getSubscriptionsParams?: GetSubscriptionsParams,
): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/commerce/subscriptions`,
method: 'GET',
search: convertPageToOffsetSearchParams(getSubscriptionsParams),
}).then(res => {
const { data: subscriptions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;

return {
total_count,
data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
};
});
};

destroy = async (): Promise<void> => {
return this._baseDelete();
};
Expand Down
62 changes: 0 additions & 62 deletions packages/shared/src/react/hooks/useOrganization.tsx
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
/* eslint-disable jsdoc/require-description-complete-sentence */
import type {
ClerkPaginatedResponse,
CommerceSubscriptionItemResource,
GetDomainsParams,
GetInvitationsParams,
GetMembershipRequestParams,
GetMembersParams,
GetSubscriptionsParams,
OrganizationDomainResource,
OrganizationInvitationResource,
OrganizationMembershipRequestResource,
Expand DownExpand Up@@ -66,16 +64,6 @@ export type UseOrganizationParams = {
* </ul>
*/
invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* If set to `true`, all default properties will be used.<br />
* Otherwise, accepts an object with the following optional properties:
* <ul>
* <li>`orgId`: A string that filters the subscriptions by the provided organization ID.</li>
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
* </ul>
*/
subscriptions?: true | PaginatedHookConfig<GetSubscriptionsParams>;
};

/**
Expand DownExpand Up@@ -111,11 +99,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
* Includes a paginated list of the organization's invitations.
*/
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* Includes a paginated list of the organization's subscriptions.
*/
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: true;
Expand All@@ -125,7 +108,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
}
| {
isLoaded: boolean;
Expand All@@ -147,10 +129,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
OrganizationInvitationResource,
T['invitations'] extends { infinite: true } ? true : false
> | null;
subscriptions: PaginatedResources<
CommerceSubscriptionItemResource,
T['subscriptions'] extends { infinite: true } ? true : false
> | null;
};

const undefinedPaginatedResource = {
Expand DownExpand Up@@ -300,7 +278,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: membershipRequestsListParams,
memberships: membersListParams,
invitations: invitationsListParams,
subscriptions: subscriptionsListParams,
} = params || {};

useAssertWrappedByClerkProvider('useOrganization');
Expand DownExpand Up@@ -341,13 +318,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
infinite: false,
});

const subscriptionsSafeValues = useWithSafeValues(subscriptionsListParams, {
initialPage: 1,
pageSize: 10,
keepPreviousData: false,
infinite: false,
});

const clerk = useClerkInstanceContext();

clerk.telemetry?.record(eventMethodCalled('useOrganization'));
Expand DownExpand Up@@ -389,15 +359,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
status: invitationsSafeValues.status,
};

const subscriptionsParams =
typeof subscriptionsListParams === 'undefined'
? undefined
: {
initialPage: subscriptionsSafeValues.initialPage,
pageSize: subscriptionsSafeValues.pageSize,
orgId: organization?.id,
};

const domains = usePagesOrInfinite<GetDomainsParams, ClerkPaginatedResponse<OrganizationDomainResource>>(
{
...domainParams,
Expand DownExpand Up@@ -463,25 +424,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
},
);

const subscriptions = usePagesOrInfinite<
GetSubscriptionsParams,
ClerkPaginatedResponse<CommerceSubscriptionItemResource>
>(
{
...subscriptionsParams,
},
organization?.getSubscriptions,
{
keepPreviousData: subscriptionsSafeValues.keepPreviousData,
infinite: subscriptionsSafeValues.infinite,
enabled: !!subscriptionsParams,
},
{
type: 'subscriptions',
organizationId: organization?.id,
},
);

if (organization === undefined) {
return {
isLoaded: false,
Expand All@@ -491,7 +433,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -504,7 +445,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: null,
memberships: null,
invitations: null,
subscriptions: null,
};
}

Expand All@@ -518,7 +458,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests: undefinedPaginatedResource,
memberships: undefinedPaginatedResource,
invitations: undefinedPaginatedResource,
subscriptions: undefinedPaginatedResource,
};
}

Expand All@@ -531,6 +470,5 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
membershipRequests,
memberships,
invitations,
subscriptions,
};
}
23 changes: 0 additions & 23 deletions packages/types/src/commerce.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,19 +69,6 @@ export interface CommerceBillingNamespace {
*/
getSubscription: (params: GetSubscriptionParams) => Promise<CommerceSubscriptionResource>;

/**
* @deprecated Use `getSubscription` to fetch a single subscription with its items
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
getSubscriptions: (
params: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand DownExpand Up@@ -792,16 +779,6 @@ export interface CommerceStatementGroup {
items: CommercePaymentResource[];
}

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
* @example
* ```tsx
* <ClerkProvider clerkJsVersion="x.x.x" />
* ```
*/
export type GetSubscriptionsParams = WithOptionalOrgType<ClerkPaginationParams>;

/**
* @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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
Expand Down
12 changes: 1 addition & 11 deletions packages/types/src/organization.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
import type {
CommercePaymentSourceMethods,
CommerceSubscriptionItemResource,
GetSubscriptionsParams,
} from './commerce';
import type { CommercePaymentSourceMethods } from './commerce';
import type { OrganizationDomainResource, OrganizationEnrollmentMode } from './organizationDomain';
import type { OrganizationInvitationResource, OrganizationInvitationStatus } from './organizationInvitation';
import type { OrganizationCustomRoleKey, OrganizationMembershipResource } from './organizationMembership';
Expand DownExpand Up@@ -60,12 +56,6 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
getMembershipRequests: (
params?: GetMembershipRequestParams,
) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
*/
getSubscriptions: (
params?: GetSubscriptionsParams,
) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;
addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;
inviteMembers: (params: InviteMembersParams) => Promise<OrganizationInvitationResource[]>;
Expand Down
Loading