chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data#6159

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
panteliselef merged 16 commits into from
Jun 25, 2025
Merged

chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data #6159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
07fcccf
wip add hooks for attempts, methods, statements
panteliselef Jun 19, 2025
f35fb2b
add subscription items
panteliselef Jun 19, 2025
b17c2e1
Create a factory
panteliselef Jun 19, 2025
1cf74f0
cleanup
panteliselef Jun 23, 2025
8a3d87c
cleanup of swr fetchOnMount logic
panteliselef Jun 23, 2025
ac26c47
add changesets
panteliselef Jun 23, 2025
c971964
Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…
panteliselef Jun 23, 2025
6991ac0
remove type change
panteliselef Jun 23, 2025
59731cc
add internal jsdoc comments
panteliselef Jun 23, 2025
e693842
improve dx and add comments
panteliselef Jun 24, 2025
d13a64c
Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…
panteliselef Jun 24, 2025
99fe9d3
remove ts-ignore comment
panteliselef Jun 24, 2025
4c8e43e
update jsdoc for `__experimental_mode`
panteliselef Jun 24, 2025
13b2a1c
remove wrong types
panteliselef Jun 24, 2025
ed63fb2
revert type change
panteliselef Jun 25, 2025
27a6c17
Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…
panteliselef Jun 25, 2025
File filter

Filter by extension

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

Use hooks exported from `@clerk/shared` to query commerce data.
10 changes: 10 additions & 0 deletions .changeset/violet-terms-fix.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
---
'@clerk/shared': minor
'@clerk/types': minor
---

Introduce experimental paginated hooks for commerce data.
- `useStatements`
- `usePaymentAttempts`
- `usePaymentMethods`
Prefixed with `__experimental_`
5 changes: 2 additions & 3 deletions packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';

import { DevOnly } from '../../common/DevOnly';
import { useCheckoutContext, usePaymentSources } from '../../contexts';
import { useCheckoutContext, usePaymentMethods } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, localizationKeys, Text } from '../../customizables';
import { ChevronUpDown, InformationCircle } from '../../icons';
import { handleError } from '../../utils';
Expand DownExpand Up@@ -191,8 +191,7 @@ const useCheckoutMutations = () => {
};

const CheckoutFormElements = ({ checkout }: { checkout: CommerceCheckoutResource }) => {
const { data } = usePaymentSources();
const { data: paymentSources } = data || { data: [] };
const { data: paymentSources } = usePaymentMethods();

const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() =>
paymentSources.length > 0 ? 'existing' : 'new',
Expand Down
6 changes: 3 additions & 3 deletions packages/clerk-js/src/ui/components/PaymentAttempts/PaymentAttemptsList.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,14 @@ import { formatDate, truncateWithEndVisible } from '../../utils';
* -----------------------------------------------------------------------------------------------*/

export const PaymentAttemptsList = () => {
const { data: paymentAttempts, isLoading } = usePaymentAttempts();
const { data: paymentAttempts, isLoading, count } = usePaymentAttempts();
const localizationRoot = useSubscriberTypeLocalizationRoot();

return (
<DataTable
page={1}
onPageChange={_ => {}}
itemCount={paymentAttempts?.total_count || 0}
itemCount={count}
pageCount={1}
itemsPerPage={10}
isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const PaymentAttemptsList = () => {
localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__amount`),
localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__status`),
]}
rows={(paymentAttempts?.data || []).map(i => (
rows={paymentAttempts.map(i => (
<PaymentAttemptsListRow
key={i.id}
paymentAttempt={i}
Expand Down
20 changes: 8 additions & 12 deletions packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import type { CommercePaymentSourceResource } from '@clerk/types';
import type { SetupIntent } from '@stripe/stripe-js';
import { Fragment, useCallback, useMemo, useRef } from 'react';
import { Fragment, useMemo, useRef } from 'react';

import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { FullHeightLoader } from '@/ui/elements/FullHeightLoader';
Expand All@@ -10,7 +10,7 @@ import { ThreeDotsMenu } from '@/ui/elements/ThreeDotsMenu';

import { RemoveResourceForm } from '../../common';
import { DevOnly } from '../../common/DevOnly';
import { usePaymentSources, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { usePaymentMethods, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
Expand DownExpand Up@@ -114,17 +114,13 @@ export const PaymentSources = withCardStateProvider(() => {
const localizationRoot = useSubscriberTypeLocalizationRoot();
const resource = subscriberType === 'org' ? clerk?.organization : clerk.user;

const { data, isLoading, mutate: mutatePaymentSources } = usePaymentSources();

const { data: paymentSources = [] } = data || {};
const { data: paymentMethods, isLoading, revalidate: revalidatePaymentMethods } = usePaymentMethods();

const sortedPaymentSources = useMemo(
() => paymentSources.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
[paymentSources],
() => paymentMethods.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
[paymentMethods],
);

const revalidatePaymentSources = useCallback(() => void mutatePaymentSources(), [mutatePaymentSources]);

if (!resource) {
return null;
}
Expand DownExpand Up@@ -156,15 +152,15 @@ export const PaymentSources = withCardStateProvider(() => {
<PaymentSourceRow paymentSource={paymentSource} />
<PaymentSourceMenu
paymentSource={paymentSource}
revalidate={revalidatePaymentSources}
revalidate={revalidatePaymentMethods}
/>
</ProfileSection.Item>

<Action.Open value={`remove-${paymentSource.id}`}>
<Action.Card variant='destructive'>
<RemoveScreen
paymentSource={paymentSource}
revalidate={revalidatePaymentSources}
revalidate={revalidatePaymentMethods}
/>
</Action.Card>
</Action.Open>
Expand All@@ -178,7 +174,7 @@ export const PaymentSources = withCardStateProvider(() => {
</Action.Trigger>
<Action.Open value='add'>
<Action.Card>
<AddScreen onSuccess={revalidatePaymentSources} />
<AddScreen onSuccess={revalidatePaymentMethods} />
</Action.Card>
</Action.Open>
</>
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useClerk } from '@clerk/shared/react';
import type { CommercePlanResource, CommerceSubscriptionPlanPeriod, PricingTableProps } from '@clerk/types';
import { useEffect, useMemo, useState } from 'react';

import { usePaymentSources, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { usePaymentMethods, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { Flow } from '../../customizables';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
Expand DownExpand Up@@ -60,7 +60,7 @@ const PricingTableRoot = (props: PricingTableProps) => {
};

// Pre-fetch payment sources
usePaymentSources();
usePaymentMethods();

return (
<Flow.Root
Expand Down
6 changes: 3 additions & 3 deletions packages/clerk-js/src/ui/components/Statements/StatementsList.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { truncateWithEndVisible } from '../../utils/truncateTextWithEndVisible';
* -----------------------------------------------------------------------------------------------*/

export const StatementsList = () => {
const { data: statements, isLoading } = useStatements();
const { data: statements, isLoading, count } = useStatements();
const localizationRoot = useSubscriberTypeLocalizationRoot();

return (
<DataTable
page={1}
onPageChange={_ => {}}
itemCount={statements?.total_count || 0}
itemCount={count}
pageCount={1}
itemsPerPage={10}
isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const StatementsList = () => {
localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__date`),
localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__amount`),
]}
rows={(statements?.data || []).map(i => (
rows={statements.map(i => (
<StatementsListRow
key={i.id}
statement={i}
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/ui/contexts/components/PaymentAttempts.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const usePaymentAttemptsContext = () => {
const { data: payments } = usePaymentAttempts();
const getPaymentAttemptById = useCallback(
(paymentAttemptId: string) => {
return payments?.data.find(payment => payment.id === paymentAttemptId);
return payments.find(payment => payment.id === paymentAttemptId);
},
[payments?.data],
[payments],
);

return {
Expand Down
85 changes: 39 additions & 46 deletions packages/clerk-js/src/ui/contexts/components/Plans.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import { useClerk, useOrganization, useSession, useUser } from '@clerk/shared/react';
import {
__experimental_usePaymentAttempts,
__experimental_usePaymentMethods,
__experimental_useStatements,
useClerk,
useOrganization,
useSession,
useUser,
} from '@clerk/shared/react';
import type {
Appearance,
CommercePlanResource,
Expand All@@ -8,7 +16,8 @@ import type {
import { useCallback, useMemo } from 'react';
import useSWR from 'swr';

import { CommerceSubscription } from '../../../core/resources/internal';
import { CommerceSubscription } from '@/core/resources/CommerceSubscription';

import type { LocalizationKey } from '../../localization';
import { localizationKeys } from '../../localization';
import { getClosestProfileScrollBox } from '../../utils';
Expand All@@ -30,51 +39,36 @@ export const usePaymentSourcesCacheKey = () => {
};
};

export const usePaymentSources = () => {
const { organization } = useOrganization();
const { user } = useUser();
const subscriberType = useSubscriberTypeContext();
const cacheKey = usePaymentSourcesCacheKey();

return useSWR(cacheKey, () => (subscriberType === 'org' ? organization : user)?.getPaymentSources({}), dedupeOptions);
};

export const usePaymentAttemptsCacheKey = () => {
const { organization } = useOrganization();
const { user } = useUser();
// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-payment-history`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
};
return __experimental_usePaymentMethods({
for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
};

export const usePaymentAttempts = () => {
const { billing } = useClerk();
const cacheKey = usePaymentAttemptsCacheKey();

return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getPaymentAttempts(args) : undefined), dedupeOptions);
};

export const useStatementsCacheKey = () => {
const { organization } = useOrganization();
const { user } = useUser();
const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-statements`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
};
return __experimental_usePaymentAttempts({
for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
});
};

export const useStatements = () => {
const { billing } = useClerk();
const cacheKey = useStatementsCacheKey();

return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getStatements(args) : undefined), dedupeOptions);
export const useStatements = (params?: { mode: 'cache' }) => {
const subscriberType = useSubscriberTypeContext();
return __experimental_useStatements({
for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
__experimental_mode: params?.mode,
});
};

export const useSubscriptions = () => {
Expand DownExpand Up@@ -181,18 +175,17 @@ export const usePlansContext = () => {
});

// Invalidates cache but does not fetch immediately
const { mutate: mutateStatements } =
useSWR<Awaited<ReturnType<typeof clerk.billing.getStatements>>>(useStatementsCacheKey());
const { revalidate: revalidateStatements } = useStatements({ mode: 'cache' });

const { mutate: mutatePaymentSources } = usePaymentSources();
const { revalidate: revalidatePaymentSources } = usePaymentMethods();

const revalidateAll = useCallback(() => {
// Revalidate the plans and subscriptions
void mutateSubscriptions();
void mutatePlans();
void mutateStatements();
void mutatePaymentSources();
}, [mutateSubscriptions, mutatePlans, mutateStatements, mutatePaymentSources]);
void revalidateStatements();
void revalidatePaymentSources();
}, [mutateSubscriptions, mutatePlans, revalidateStatements, revalidatePaymentSources]);

// should the default plan be shown as active
const isDefaultPlanImplicitlyActiveOrUpcoming = useMemo(() => {
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/ui/contexts/components/Statements.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const useStatementsContext = () => {
const { data: statements } = useStatements();
const getStatementById = useCallback(
(statementId: string) => {
return statements?.data.find(statement => statement.id === statementId);
return statements.find(statement => statement.id === statementId);
},
[statements?.data],
[statements],
);

return {
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
chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data#6159

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 16 commits into

from

Jun 25, 2025
 Merged


chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data
#6159
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
07fcccf

wip add hooks for attempts, methods, statements


panteliselef Jun 19, 2025
f35fb2b

add subscription items


panteliselef Jun 19, 2025
b17c2e1

Create a factory


panteliselef Jun 19, 2025
1cf74f0

cleanup


panteliselef Jun 23, 2025
8a3d87c

cleanup of swr fetchOnMount logic


panteliselef Jun 23, 2025
ac26c47

add changesets


panteliselef Jun 23, 2025
c971964

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 23, 2025
6991ac0

remove type change


panteliselef Jun 23, 2025
59731cc

add internal jsdoc comments


panteliselef Jun 23, 2025
e693842

improve dx and add comments


panteliselef Jun 24, 2025
d13a64c

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 24, 2025
99fe9d3

remove ts-ignore comment


panteliselef Jun 24, 2025
4c8e43e

update jsdoc for `__experimental_mode`


panteliselef Jun 24, 2025
13b2a1c

remove wrong types


panteliselef Jun 24, 2025
ed63fb2

revert type change


panteliselef Jun 25, 2025
27a6c17

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smart-pandas-carry.md

View file


Open in desktop

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

Use hooks exported from `@clerk/shared` to query commerce data.

10 changes: 10 additions & 0 deletions
.changeset/violet-terms-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
---
'@clerk/shared': minor
'@clerk/types': minor
---

Introduce experimental paginated hooks for commerce data.
- `useStatements`
- `usePaymentAttempts`
- `usePaymentMethods`
Prefixed with `__experimental_`

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';

import { DevOnly } from '../../common/DevOnly';
import { useCheckoutContext, usePaymentSources } from '../../contexts';
import { useCheckoutContext, usePaymentMethods } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, localizationKeys, Text } from '../../customizables';
import { ChevronUpDown, InformationCircle } from '../../icons';
import { handleError } from '../../utils';
Expand DownExpand Up@@ -191,8 +191,7 @@ const useCheckoutMutations = () => {
};

const CheckoutFormElements = ({ checkout }: { checkout: CommerceCheckoutResource }) => {
 const { data } = usePaymentSources();
 const { data: paymentSources } = data || { data: [] };
 const { data: paymentSources } = usePaymentMethods();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() =>
 paymentSources.length > 0 ? 'existing' : 'new',
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/PaymentAttempts/PaymentAttemptsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,14 @@ import { formatDate, truncateWithEndVisible } from '../../utils';
 * -----------------------------------------------------------------------------------------------*/

export const PaymentAttemptsList = () => {
 const { data: paymentAttempts, isLoading } = usePaymentAttempts();
 const { data: paymentAttempts, isLoading, count } = usePaymentAttempts();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={paymentAttempts?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const PaymentAttemptsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__amount`),
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__status`),
 ]}
 rows={(paymentAttempts?.data || []).map(i => (
 rows={paymentAttempts.map(i => (
 <PaymentAttemptsListRow
 key={i.id}
 paymentAttempt={i}
Expand Down

20 changes: 8 additions & 12 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import type { CommercePaymentSourceResource } from '@clerk/types';
import type { SetupIntent } from '@stripe/stripe-js';
import { Fragment, useCallback, useMemo, useRef } from 'react';
import { Fragment, useMemo, useRef } from 'react';

import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { FullHeightLoader } from '@/ui/elements/FullHeightLoader';
Expand All@@ -10,7 +10,7 @@ import { ThreeDotsMenu } from '@/ui/elements/ThreeDotsMenu';

import { RemoveResourceForm } from '../../common';
import { DevOnly } from '../../common/DevOnly';
import { usePaymentSources, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { usePaymentMethods, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
Expand DownExpand Up@@ -114,17 +114,13 @@ export const PaymentSources = withCardStateProvider(() => {
 const localizationRoot = useSubscriberTypeLocalizationRoot();
 const resource = subscriberType === 'org' ? clerk?.organization : clerk.user;

 const { data, isLoading, mutate: mutatePaymentSources } = usePaymentSources();

 const { data: paymentSources = [] } = data || {};
 const { data: paymentMethods, isLoading, revalidate: revalidatePaymentMethods } = usePaymentMethods();

 const sortedPaymentSources = useMemo(
 () => paymentSources.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentSources],
 () => paymentMethods.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentMethods],
 );

 const revalidatePaymentSources = useCallback(() => void mutatePaymentSources(), [mutatePaymentSources]);

 if (!resource) {
 return null;
 }
Expand DownExpand Up@@ -156,15 +152,15 @@ export const PaymentSources = withCardStateProvider(() => {
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </ProfileSection.Item>

 <Action.Open value={`remove-${paymentSource.id}`}>
 <Action.Card variant='destructive'>
 <RemoveScreen
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </Action.Card>
 </Action.Open>
Expand All@@ -178,7 +174,7 @@ export const PaymentSources = withCardStateProvider(() => {
 </Action.Trigger>
 <Action.Open value='add'>
 <Action.Card>
 <AddScreen onSuccess={revalidatePaymentSources} />
 <AddScreen onSuccess={revalidatePaymentMethods} />
 </Action.Card>
 </Action.Open>
 </>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useClerk } from '@clerk/shared/react';
import type { CommercePlanResource, CommerceSubscriptionPlanPeriod, PricingTableProps } from '@clerk/types';
import { useEffect, useMemo, useState } from 'react';

import { usePaymentSources, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { usePaymentMethods, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { Flow } from '../../customizables';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
Expand DownExpand Up@@ -60,7 +60,7 @@ const PricingTableRoot = (props: PricingTableProps) => {
 };

 // Pre-fetch payment sources
usePaymentSources();
usePaymentMethods();

 return (
 <Flow.Root
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/Statements/StatementsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { truncateWithEndVisible } from '../../utils/truncateTextWithEndVisible';
 * -----------------------------------------------------------------------------------------------*/

export const StatementsList = () => {
 const { data: statements, isLoading } = useStatements();
 const { data: statements, isLoading, count } = useStatements();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={statements?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const StatementsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__date`),
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__amount`),
 ]}
 rows={(statements?.data || []).map(i => (
 rows={statements.map(i => (
 <StatementsListRow
 key={i.id}
 statement={i}
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/PaymentAttempts.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const usePaymentAttemptsContext = () => {
 const { data: payments } = usePaymentAttempts();
 const getPaymentAttemptById = useCallback(
 (paymentAttemptId: string) => {
 return payments?.data.find(payment => payment.id === paymentAttemptId);
 return payments.find(payment => payment.id === paymentAttemptId);
 },
 [payments?.data],
 [payments],
 );

 return {
Expand Down

85 changes: 39 additions & 46 deletions
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import { useClerk, useOrganization, useSession, useUser } from '@clerk/shared/react';
import {
 __experimental_usePaymentAttempts,
 __experimental_usePaymentMethods,
 __experimental_useStatements,
 useClerk,
 useOrganization,
 useSession,
 useUser,
} from '@clerk/shared/react';
import type {
 Appearance,
 CommercePlanResource,
Expand All@@ -8,7 +16,8 @@ import type {
import { useCallback, useMemo } from 'react';
import useSWR from 'swr';

import { CommerceSubscription } from '../../../core/resources/internal';
import { CommerceSubscription } from '@/core/resources/CommerceSubscription';

import type { LocalizationKey } from '../../localization';
import { localizationKeys } from '../../localization';
import { getClosestProfileScrollBox } from '../../utils';
Expand All@@ -30,51 +39,36 @@ export const usePaymentSourcesCacheKey = () => {
 };
};

export const usePaymentSources = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();
 const cacheKey = usePaymentSourcesCacheKey();

 return useSWR(cacheKey, () => (subscriberType === 'org' ? organization : user)?.getPaymentSources({}), dedupeOptions);
};

export const usePaymentAttemptsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-payment-history`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentMethods({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const usePaymentAttempts = () => {
 const { billing } = useClerk();
 const cacheKey = usePaymentAttemptsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getPaymentAttempts(args) : undefined), dedupeOptions);
};

export const useStatementsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-statements`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentAttempts({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const useStatements = () => {
 const { billing } = useClerk();
 const cacheKey = useStatementsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getStatements(args) : undefined), dedupeOptions);
export const useStatements = (params?: { mode: 'cache' }) => {
 const subscriberType = useSubscriberTypeContext();
 return __experimental_useStatements({
 for: subscriberType === 'org' ? 'organization' : 'user',
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: true,
 __experimental_mode: params?.mode,
 });
};

export const useSubscriptions = () => {
Expand DownExpand Up@@ -181,18 +175,17 @@ export const usePlansContext = () => {
 });

 // Invalidates cache but does not fetch immediately
 const { mutate: mutateStatements } =
 useSWR<Awaited<ReturnType<typeof clerk.billing.getStatements>>>(useStatementsCacheKey());
 const { revalidate: revalidateStatements } = useStatements({ mode: 'cache' });

 const { mutate: mutatePaymentSources } = usePaymentSources();
 const { revalidate: revalidatePaymentSources } = usePaymentMethods();

 const revalidateAll = useCallback(() => {
 // Revalidate the plans and subscriptions
 void mutateSubscriptions();
 void mutatePlans();
 void mutateStatements();
 void mutatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, mutateStatements, mutatePaymentSources]);
 void revalidateStatements();
 void revalidatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, revalidateStatements, revalidatePaymentSources]);

 // should the default plan be shown as active
 const isDefaultPlanImplicitlyActiveOrUpcoming = useMemo(() => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/Statements.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const useStatementsContext = () => {
 const { data: statements } = useStatements();
 const getStatementById = useCallback(
 (statementId: string) => {
 return statements?.data.find(statement => statement.id === statementId);
 return statements.find(statement => statement.id === statementId);
 },
 [statements?.data],
 [statements],
 );

 return {
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
chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data#6159

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 16 commits into

from

Jun 25, 2025
 Merged


chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data
#6159
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
07fcccf

wip add hooks for attempts, methods, statements


panteliselef Jun 19, 2025
f35fb2b

add subscription items


panteliselef Jun 19, 2025
b17c2e1

Create a factory


panteliselef Jun 19, 2025
1cf74f0

cleanup


panteliselef Jun 23, 2025
8a3d87c

cleanup of swr fetchOnMount logic


panteliselef Jun 23, 2025
ac26c47

add changesets


panteliselef Jun 23, 2025
c971964

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 23, 2025
6991ac0

remove type change


panteliselef Jun 23, 2025
59731cc

add internal jsdoc comments


panteliselef Jun 23, 2025
e693842

improve dx and add comments


panteliselef Jun 24, 2025
d13a64c

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 24, 2025
99fe9d3

remove ts-ignore comment


panteliselef Jun 24, 2025
4c8e43e

update jsdoc for `__experimental_mode`


panteliselef Jun 24, 2025
13b2a1c

remove wrong types


panteliselef Jun 24, 2025
ed63fb2

revert type change


panteliselef Jun 25, 2025
27a6c17

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smart-pandas-carry.md

View file


Open in desktop

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

Use hooks exported from `@clerk/shared` to query commerce data.

10 changes: 10 additions & 0 deletions
.changeset/violet-terms-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
---
'@clerk/shared': minor
'@clerk/types': minor
---

Introduce experimental paginated hooks for commerce data.
- `useStatements`
- `usePaymentAttempts`
- `usePaymentMethods`
Prefixed with `__experimental_`

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';

import { DevOnly } from '../../common/DevOnly';
import { useCheckoutContext, usePaymentSources } from '../../contexts';
import { useCheckoutContext, usePaymentMethods } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, localizationKeys, Text } from '../../customizables';
import { ChevronUpDown, InformationCircle } from '../../icons';
import { handleError } from '../../utils';
Expand DownExpand Up@@ -191,8 +191,7 @@ const useCheckoutMutations = () => {
};

const CheckoutFormElements = ({ checkout }: { checkout: CommerceCheckoutResource }) => {
 const { data } = usePaymentSources();
 const { data: paymentSources } = data || { data: [] };
 const { data: paymentSources } = usePaymentMethods();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() =>
 paymentSources.length > 0 ? 'existing' : 'new',
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/PaymentAttempts/PaymentAttemptsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,14 @@ import { formatDate, truncateWithEndVisible } from '../../utils';
 * -----------------------------------------------------------------------------------------------*/

export const PaymentAttemptsList = () => {
 const { data: paymentAttempts, isLoading } = usePaymentAttempts();
 const { data: paymentAttempts, isLoading, count } = usePaymentAttempts();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={paymentAttempts?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const PaymentAttemptsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__amount`),
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__status`),
 ]}
 rows={(paymentAttempts?.data || []).map(i => (
 rows={paymentAttempts.map(i => (
 <PaymentAttemptsListRow
 key={i.id}
 paymentAttempt={i}
Expand Down

20 changes: 8 additions & 12 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import type { CommercePaymentSourceResource } from '@clerk/types';
import type { SetupIntent } from '@stripe/stripe-js';
import { Fragment, useCallback, useMemo, useRef } from 'react';
import { Fragment, useMemo, useRef } from 'react';

import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { FullHeightLoader } from '@/ui/elements/FullHeightLoader';
Expand All@@ -10,7 +10,7 @@ import { ThreeDotsMenu } from '@/ui/elements/ThreeDotsMenu';

import { RemoveResourceForm } from '../../common';
import { DevOnly } from '../../common/DevOnly';
import { usePaymentSources, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { usePaymentMethods, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
Expand DownExpand Up@@ -114,17 +114,13 @@ export const PaymentSources = withCardStateProvider(() => {
 const localizationRoot = useSubscriberTypeLocalizationRoot();
 const resource = subscriberType === 'org' ? clerk?.organization : clerk.user;

 const { data, isLoading, mutate: mutatePaymentSources } = usePaymentSources();

 const { data: paymentSources = [] } = data || {};
 const { data: paymentMethods, isLoading, revalidate: revalidatePaymentMethods } = usePaymentMethods();

 const sortedPaymentSources = useMemo(
 () => paymentSources.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentSources],
 () => paymentMethods.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentMethods],
 );

 const revalidatePaymentSources = useCallback(() => void mutatePaymentSources(), [mutatePaymentSources]);

 if (!resource) {
 return null;
 }
Expand DownExpand Up@@ -156,15 +152,15 @@ export const PaymentSources = withCardStateProvider(() => {
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </ProfileSection.Item>

 <Action.Open value={`remove-${paymentSource.id}`}>
 <Action.Card variant='destructive'>
 <RemoveScreen
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </Action.Card>
 </Action.Open>
Expand All@@ -178,7 +174,7 @@ export const PaymentSources = withCardStateProvider(() => {
 </Action.Trigger>
 <Action.Open value='add'>
 <Action.Card>
 <AddScreen onSuccess={revalidatePaymentSources} />
 <AddScreen onSuccess={revalidatePaymentMethods} />
 </Action.Card>
 </Action.Open>
 </>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useClerk } from '@clerk/shared/react';
import type { CommercePlanResource, CommerceSubscriptionPlanPeriod, PricingTableProps } from '@clerk/types';
import { useEffect, useMemo, useState } from 'react';

import { usePaymentSources, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { usePaymentMethods, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { Flow } from '../../customizables';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
Expand DownExpand Up@@ -60,7 +60,7 @@ const PricingTableRoot = (props: PricingTableProps) => {
 };

 // Pre-fetch payment sources
usePaymentSources();
usePaymentMethods();

 return (
 <Flow.Root
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/Statements/StatementsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { truncateWithEndVisible } from '../../utils/truncateTextWithEndVisible';
 * -----------------------------------------------------------------------------------------------*/

export const StatementsList = () => {
 const { data: statements, isLoading } = useStatements();
 const { data: statements, isLoading, count } = useStatements();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={statements?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const StatementsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__date`),
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__amount`),
 ]}
 rows={(statements?.data || []).map(i => (
 rows={statements.map(i => (
 <StatementsListRow
 key={i.id}
 statement={i}
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/PaymentAttempts.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const usePaymentAttemptsContext = () => {
 const { data: payments } = usePaymentAttempts();
 const getPaymentAttemptById = useCallback(
 (paymentAttemptId: string) => {
 return payments?.data.find(payment => payment.id === paymentAttemptId);
 return payments.find(payment => payment.id === paymentAttemptId);
 },
 [payments?.data],
 [payments],
 );

 return {
Expand Down

85 changes: 39 additions & 46 deletions
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import { useClerk, useOrganization, useSession, useUser } from '@clerk/shared/react';
import {
 __experimental_usePaymentAttempts,
 __experimental_usePaymentMethods,
 __experimental_useStatements,
 useClerk,
 useOrganization,
 useSession,
 useUser,
} from '@clerk/shared/react';
import type {
 Appearance,
 CommercePlanResource,
Expand All@@ -8,7 +16,8 @@ import type {
import { useCallback, useMemo } from 'react';
import useSWR from 'swr';

import { CommerceSubscription } from '../../../core/resources/internal';
import { CommerceSubscription } from '@/core/resources/CommerceSubscription';

import type { LocalizationKey } from '../../localization';
import { localizationKeys } from '../../localization';
import { getClosestProfileScrollBox } from '../../utils';
Expand All@@ -30,51 +39,36 @@ export const usePaymentSourcesCacheKey = () => {
 };
};

export const usePaymentSources = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();
 const cacheKey = usePaymentSourcesCacheKey();

 return useSWR(cacheKey, () => (subscriberType === 'org' ? organization : user)?.getPaymentSources({}), dedupeOptions);
};

export const usePaymentAttemptsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-payment-history`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentMethods({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const usePaymentAttempts = () => {
 const { billing } = useClerk();
 const cacheKey = usePaymentAttemptsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getPaymentAttempts(args) : undefined), dedupeOptions);
};

export const useStatementsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-statements`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentAttempts({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const useStatements = () => {
 const { billing } = useClerk();
 const cacheKey = useStatementsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getStatements(args) : undefined), dedupeOptions);
export const useStatements = (params?: { mode: 'cache' }) => {
 const subscriberType = useSubscriberTypeContext();
 return __experimental_useStatements({
 for: subscriberType === 'org' ? 'organization' : 'user',
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: true,
 __experimental_mode: params?.mode,
 });
};

export const useSubscriptions = () => {
Expand DownExpand Up@@ -181,18 +175,17 @@ export const usePlansContext = () => {
 });

 // Invalidates cache but does not fetch immediately
 const { mutate: mutateStatements } =
 useSWR<Awaited<ReturnType<typeof clerk.billing.getStatements>>>(useStatementsCacheKey());
 const { revalidate: revalidateStatements } = useStatements({ mode: 'cache' });

 const { mutate: mutatePaymentSources } = usePaymentSources();
 const { revalidate: revalidatePaymentSources } = usePaymentMethods();

 const revalidateAll = useCallback(() => {
 // Revalidate the plans and subscriptions
 void mutateSubscriptions();
 void mutatePlans();
 void mutateStatements();
 void mutatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, mutateStatements, mutatePaymentSources]);
 void revalidateStatements();
 void revalidatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, revalidateStatements, revalidatePaymentSources]);

 // should the default plan be shown as active
 const isDefaultPlanImplicitlyActiveOrUpcoming = useMemo(() => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/Statements.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const useStatementsContext = () => {
 const { data: statements } = useStatements();
 const getStatementById = useCallback(
 (statementId: string) => {
 return statements?.data.find(statement => statement.id === statementId);
 return statements.find(statement => statement.id === statementId);
 },
 [statements?.data],
 [statements],
 );

 return {
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
chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data#6159

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 16 commits into

from

Jun 25, 2025
 Merged


chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data
#6159
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
07fcccf

wip add hooks for attempts, methods, statements


panteliselef Jun 19, 2025
f35fb2b

add subscription items


panteliselef Jun 19, 2025
b17c2e1

Create a factory


panteliselef Jun 19, 2025
1cf74f0

cleanup


panteliselef Jun 23, 2025
8a3d87c

cleanup of swr fetchOnMount logic


panteliselef Jun 23, 2025
ac26c47

add changesets


panteliselef Jun 23, 2025
c971964

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 23, 2025
6991ac0

remove type change


panteliselef Jun 23, 2025
59731cc

add internal jsdoc comments


panteliselef Jun 23, 2025
e693842

improve dx and add comments


panteliselef Jun 24, 2025
d13a64c

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 24, 2025
99fe9d3

remove ts-ignore comment


panteliselef Jun 24, 2025
4c8e43e

update jsdoc for `__experimental_mode`


panteliselef Jun 24, 2025
13b2a1c

remove wrong types


panteliselef Jun 24, 2025
ed63fb2

revert type change


panteliselef Jun 25, 2025
27a6c17

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smart-pandas-carry.md

View file


Open in desktop

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

Use hooks exported from `@clerk/shared` to query commerce data.

10 changes: 10 additions & 0 deletions
.changeset/violet-terms-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
---
'@clerk/shared': minor
'@clerk/types': minor
---

Introduce experimental paginated hooks for commerce data.
- `useStatements`
- `usePaymentAttempts`
- `usePaymentMethods`
Prefixed with `__experimental_`

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';

import { DevOnly } from '../../common/DevOnly';
import { useCheckoutContext, usePaymentSources } from '../../contexts';
import { useCheckoutContext, usePaymentMethods } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, localizationKeys, Text } from '../../customizables';
import { ChevronUpDown, InformationCircle } from '../../icons';
import { handleError } from '../../utils';
Expand DownExpand Up@@ -191,8 +191,7 @@ const useCheckoutMutations = () => {
};

const CheckoutFormElements = ({ checkout }: { checkout: CommerceCheckoutResource }) => {
 const { data } = usePaymentSources();
 const { data: paymentSources } = data || { data: [] };
 const { data: paymentSources } = usePaymentMethods();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() =>
 paymentSources.length > 0 ? 'existing' : 'new',
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/PaymentAttempts/PaymentAttemptsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,14 @@ import { formatDate, truncateWithEndVisible } from '../../utils';
 * -----------------------------------------------------------------------------------------------*/

export const PaymentAttemptsList = () => {
 const { data: paymentAttempts, isLoading } = usePaymentAttempts();
 const { data: paymentAttempts, isLoading, count } = usePaymentAttempts();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={paymentAttempts?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const PaymentAttemptsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__amount`),
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__status`),
 ]}
 rows={(paymentAttempts?.data || []).map(i => (
 rows={paymentAttempts.map(i => (
 <PaymentAttemptsListRow
 key={i.id}
 paymentAttempt={i}
Expand Down

20 changes: 8 additions & 12 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import type { CommercePaymentSourceResource } from '@clerk/types';
import type { SetupIntent } from '@stripe/stripe-js';
import { Fragment, useCallback, useMemo, useRef } from 'react';
import { Fragment, useMemo, useRef } from 'react';

import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { FullHeightLoader } from '@/ui/elements/FullHeightLoader';
Expand All@@ -10,7 +10,7 @@ import { ThreeDotsMenu } from '@/ui/elements/ThreeDotsMenu';

import { RemoveResourceForm } from '../../common';
import { DevOnly } from '../../common/DevOnly';
import { usePaymentSources, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { usePaymentMethods, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
Expand DownExpand Up@@ -114,17 +114,13 @@ export const PaymentSources = withCardStateProvider(() => {
 const localizationRoot = useSubscriberTypeLocalizationRoot();
 const resource = subscriberType === 'org' ? clerk?.organization : clerk.user;

 const { data, isLoading, mutate: mutatePaymentSources } = usePaymentSources();

 const { data: paymentSources = [] } = data || {};
 const { data: paymentMethods, isLoading, revalidate: revalidatePaymentMethods } = usePaymentMethods();

 const sortedPaymentSources = useMemo(
 () => paymentSources.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentSources],
 () => paymentMethods.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentMethods],
 );

 const revalidatePaymentSources = useCallback(() => void mutatePaymentSources(), [mutatePaymentSources]);

 if (!resource) {
 return null;
 }
Expand DownExpand Up@@ -156,15 +152,15 @@ export const PaymentSources = withCardStateProvider(() => {
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </ProfileSection.Item>

 <Action.Open value={`remove-${paymentSource.id}`}>
 <Action.Card variant='destructive'>
 <RemoveScreen
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </Action.Card>
 </Action.Open>
Expand All@@ -178,7 +174,7 @@ export const PaymentSources = withCardStateProvider(() => {
 </Action.Trigger>
 <Action.Open value='add'>
 <Action.Card>
 <AddScreen onSuccess={revalidatePaymentSources} />
 <AddScreen onSuccess={revalidatePaymentMethods} />
 </Action.Card>
 </Action.Open>
 </>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useClerk } from '@clerk/shared/react';
import type { CommercePlanResource, CommerceSubscriptionPlanPeriod, PricingTableProps } from '@clerk/types';
import { useEffect, useMemo, useState } from 'react';

import { usePaymentSources, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { usePaymentMethods, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { Flow } from '../../customizables';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
Expand DownExpand Up@@ -60,7 +60,7 @@ const PricingTableRoot = (props: PricingTableProps) => {
 };

 // Pre-fetch payment sources
usePaymentSources();
usePaymentMethods();

 return (
 <Flow.Root
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/Statements/StatementsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { truncateWithEndVisible } from '../../utils/truncateTextWithEndVisible';
 * -----------------------------------------------------------------------------------------------*/

export const StatementsList = () => {
 const { data: statements, isLoading } = useStatements();
 const { data: statements, isLoading, count } = useStatements();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={statements?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const StatementsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__date`),
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__amount`),
 ]}
 rows={(statements?.data || []).map(i => (
 rows={statements.map(i => (
 <StatementsListRow
 key={i.id}
 statement={i}
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/PaymentAttempts.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const usePaymentAttemptsContext = () => {
 const { data: payments } = usePaymentAttempts();
 const getPaymentAttemptById = useCallback(
 (paymentAttemptId: string) => {
 return payments?.data.find(payment => payment.id === paymentAttemptId);
 return payments.find(payment => payment.id === paymentAttemptId);
 },
 [payments?.data],
 [payments],
 );

 return {
Expand Down

85 changes: 39 additions & 46 deletions
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import { useClerk, useOrganization, useSession, useUser } from '@clerk/shared/react';
import {
 __experimental_usePaymentAttempts,
 __experimental_usePaymentMethods,
 __experimental_useStatements,
 useClerk,
 useOrganization,
 useSession,
 useUser,
} from '@clerk/shared/react';
import type {
 Appearance,
 CommercePlanResource,
Expand All@@ -8,7 +16,8 @@ import type {
import { useCallback, useMemo } from 'react';
import useSWR from 'swr';

import { CommerceSubscription } from '../../../core/resources/internal';
import { CommerceSubscription } from '@/core/resources/CommerceSubscription';

import type { LocalizationKey } from '../../localization';
import { localizationKeys } from '../../localization';
import { getClosestProfileScrollBox } from '../../utils';
Expand All@@ -30,51 +39,36 @@ export const usePaymentSourcesCacheKey = () => {
 };
};

export const usePaymentSources = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();
 const cacheKey = usePaymentSourcesCacheKey();

 return useSWR(cacheKey, () => (subscriberType === 'org' ? organization : user)?.getPaymentSources({}), dedupeOptions);
};

export const usePaymentAttemptsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-payment-history`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentMethods({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const usePaymentAttempts = () => {
 const { billing } = useClerk();
 const cacheKey = usePaymentAttemptsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getPaymentAttempts(args) : undefined), dedupeOptions);
};

export const useStatementsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-statements`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentAttempts({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const useStatements = () => {
 const { billing } = useClerk();
 const cacheKey = useStatementsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getStatements(args) : undefined), dedupeOptions);
export const useStatements = (params?: { mode: 'cache' }) => {
 const subscriberType = useSubscriberTypeContext();
 return __experimental_useStatements({
 for: subscriberType === 'org' ? 'organization' : 'user',
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: true,
 __experimental_mode: params?.mode,
 });
};

export const useSubscriptions = () => {
Expand DownExpand Up@@ -181,18 +175,17 @@ export const usePlansContext = () => {
 });

 // Invalidates cache but does not fetch immediately
 const { mutate: mutateStatements } =
 useSWR<Awaited<ReturnType<typeof clerk.billing.getStatements>>>(useStatementsCacheKey());
 const { revalidate: revalidateStatements } = useStatements({ mode: 'cache' });

 const { mutate: mutatePaymentSources } = usePaymentSources();
 const { revalidate: revalidatePaymentSources } = usePaymentMethods();

 const revalidateAll = useCallback(() => {
 // Revalidate the plans and subscriptions
 void mutateSubscriptions();
 void mutatePlans();
 void mutateStatements();
 void mutatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, mutateStatements, mutatePaymentSources]);
 void revalidateStatements();
 void revalidatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, revalidateStatements, revalidatePaymentSources]);

 // should the default plan be shown as active
 const isDefaultPlanImplicitlyActiveOrUpcoming = useMemo(() => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/Statements.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const useStatementsContext = () => {
 const { data: statements } = useStatements();
 const getStatementById = useCallback(
 (statementId: string) => {
 return statements?.data.find(statement => statement.id === statementId);
 return statements.find(statement => statement.id === statementId);
 },
 [statements?.data],
 [statements],
 );

 return {
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
chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data#6159

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 16 commits into

from

Jun 25, 2025
 Merged


chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data
#6159
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
07fcccf

wip add hooks for attempts, methods, statements


panteliselef Jun 19, 2025
f35fb2b

add subscription items


panteliselef Jun 19, 2025
b17c2e1

Create a factory


panteliselef Jun 19, 2025
1cf74f0

cleanup


panteliselef Jun 23, 2025
8a3d87c

cleanup of swr fetchOnMount logic


panteliselef Jun 23, 2025
ac26c47

add changesets


panteliselef Jun 23, 2025
c971964

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 23, 2025
6991ac0

remove type change


panteliselef Jun 23, 2025
59731cc

add internal jsdoc comments


panteliselef Jun 23, 2025
e693842

improve dx and add comments


panteliselef Jun 24, 2025
d13a64c

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 24, 2025
99fe9d3

remove ts-ignore comment


panteliselef Jun 24, 2025
4c8e43e

update jsdoc for `__experimental_mode`


panteliselef Jun 24, 2025
13b2a1c

remove wrong types


panteliselef Jun 24, 2025
ed63fb2

revert type change


panteliselef Jun 25, 2025
27a6c17

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smart-pandas-carry.md

View file


Open in desktop

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

Use hooks exported from `@clerk/shared` to query commerce data.

10 changes: 10 additions & 0 deletions
.changeset/violet-terms-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
---
'@clerk/shared': minor
'@clerk/types': minor
---

Introduce experimental paginated hooks for commerce data.
- `useStatements`
- `usePaymentAttempts`
- `usePaymentMethods`
Prefixed with `__experimental_`

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';

import { DevOnly } from '../../common/DevOnly';
import { useCheckoutContext, usePaymentSources } from '../../contexts';
import { useCheckoutContext, usePaymentMethods } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, localizationKeys, Text } from '../../customizables';
import { ChevronUpDown, InformationCircle } from '../../icons';
import { handleError } from '../../utils';
Expand DownExpand Up@@ -191,8 +191,7 @@ const useCheckoutMutations = () => {
};

const CheckoutFormElements = ({ checkout }: { checkout: CommerceCheckoutResource }) => {
 const { data } = usePaymentSources();
 const { data: paymentSources } = data || { data: [] };
 const { data: paymentSources } = usePaymentMethods();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() =>
 paymentSources.length > 0 ? 'existing' : 'new',
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/PaymentAttempts/PaymentAttemptsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,14 @@ import { formatDate, truncateWithEndVisible } from '../../utils';
 * -----------------------------------------------------------------------------------------------*/

export const PaymentAttemptsList = () => {
 const { data: paymentAttempts, isLoading } = usePaymentAttempts();
 const { data: paymentAttempts, isLoading, count } = usePaymentAttempts();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={paymentAttempts?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const PaymentAttemptsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__amount`),
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__status`),
 ]}
 rows={(paymentAttempts?.data || []).map(i => (
 rows={paymentAttempts.map(i => (
 <PaymentAttemptsListRow
 key={i.id}
 paymentAttempt={i}
Expand Down

20 changes: 8 additions & 12 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import type { CommercePaymentSourceResource } from '@clerk/types';
import type { SetupIntent } from '@stripe/stripe-js';
import { Fragment, useCallback, useMemo, useRef } from 'react';
import { Fragment, useMemo, useRef } from 'react';

import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { FullHeightLoader } from '@/ui/elements/FullHeightLoader';
Expand All@@ -10,7 +10,7 @@ import { ThreeDotsMenu } from '@/ui/elements/ThreeDotsMenu';

import { RemoveResourceForm } from '../../common';
import { DevOnly } from '../../common/DevOnly';
import { usePaymentSources, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { usePaymentMethods, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
Expand DownExpand Up@@ -114,17 +114,13 @@ export const PaymentSources = withCardStateProvider(() => {
 const localizationRoot = useSubscriberTypeLocalizationRoot();
 const resource = subscriberType === 'org' ? clerk?.organization : clerk.user;

 const { data, isLoading, mutate: mutatePaymentSources } = usePaymentSources();

 const { data: paymentSources = [] } = data || {};
 const { data: paymentMethods, isLoading, revalidate: revalidatePaymentMethods } = usePaymentMethods();

 const sortedPaymentSources = useMemo(
 () => paymentSources.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentSources],
 () => paymentMethods.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentMethods],
 );

 const revalidatePaymentSources = useCallback(() => void mutatePaymentSources(), [mutatePaymentSources]);

 if (!resource) {
 return null;
 }
Expand DownExpand Up@@ -156,15 +152,15 @@ export const PaymentSources = withCardStateProvider(() => {
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </ProfileSection.Item>

 <Action.Open value={`remove-${paymentSource.id}`}>
 <Action.Card variant='destructive'>
 <RemoveScreen
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </Action.Card>
 </Action.Open>
Expand All@@ -178,7 +174,7 @@ export const PaymentSources = withCardStateProvider(() => {
 </Action.Trigger>
 <Action.Open value='add'>
 <Action.Card>
 <AddScreen onSuccess={revalidatePaymentSources} />
 <AddScreen onSuccess={revalidatePaymentMethods} />
 </Action.Card>
 </Action.Open>
 </>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useClerk } from '@clerk/shared/react';
import type { CommercePlanResource, CommerceSubscriptionPlanPeriod, PricingTableProps } from '@clerk/types';
import { useEffect, useMemo, useState } from 'react';

import { usePaymentSources, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { usePaymentMethods, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { Flow } from '../../customizables';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
Expand DownExpand Up@@ -60,7 +60,7 @@ const PricingTableRoot = (props: PricingTableProps) => {
 };

 // Pre-fetch payment sources
usePaymentSources();
usePaymentMethods();

 return (
 <Flow.Root
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/Statements/StatementsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { truncateWithEndVisible } from '../../utils/truncateTextWithEndVisible';
 * -----------------------------------------------------------------------------------------------*/

export const StatementsList = () => {
 const { data: statements, isLoading } = useStatements();
 const { data: statements, isLoading, count } = useStatements();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={statements?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const StatementsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__date`),
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__amount`),
 ]}
 rows={(statements?.data || []).map(i => (
 rows={statements.map(i => (
 <StatementsListRow
 key={i.id}
 statement={i}
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/PaymentAttempts.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const usePaymentAttemptsContext = () => {
 const { data: payments } = usePaymentAttempts();
 const getPaymentAttemptById = useCallback(
 (paymentAttemptId: string) => {
 return payments?.data.find(payment => payment.id === paymentAttemptId);
 return payments.find(payment => payment.id === paymentAttemptId);
 },
 [payments?.data],
 [payments],
 );

 return {
Expand Down

85 changes: 39 additions & 46 deletions
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import { useClerk, useOrganization, useSession, useUser } from '@clerk/shared/react';
import {
 __experimental_usePaymentAttempts,
 __experimental_usePaymentMethods,
 __experimental_useStatements,
 useClerk,
 useOrganization,
 useSession,
 useUser,
} from '@clerk/shared/react';
import type {
 Appearance,
 CommercePlanResource,
Expand All@@ -8,7 +16,8 @@ import type {
import { useCallback, useMemo } from 'react';
import useSWR from 'swr';

import { CommerceSubscription } from '../../../core/resources/internal';
import { CommerceSubscription } from '@/core/resources/CommerceSubscription';

import type { LocalizationKey } from '../../localization';
import { localizationKeys } from '../../localization';
import { getClosestProfileScrollBox } from '../../utils';
Expand All@@ -30,51 +39,36 @@ export const usePaymentSourcesCacheKey = () => {
 };
};

export const usePaymentSources = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();
 const cacheKey = usePaymentSourcesCacheKey();

 return useSWR(cacheKey, () => (subscriberType === 'org' ? organization : user)?.getPaymentSources({}), dedupeOptions);
};

export const usePaymentAttemptsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-payment-history`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentMethods({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const usePaymentAttempts = () => {
 const { billing } = useClerk();
 const cacheKey = usePaymentAttemptsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getPaymentAttempts(args) : undefined), dedupeOptions);
};

export const useStatementsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-statements`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentAttempts({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const useStatements = () => {
 const { billing } = useClerk();
 const cacheKey = useStatementsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getStatements(args) : undefined), dedupeOptions);
export const useStatements = (params?: { mode: 'cache' }) => {
 const subscriberType = useSubscriberTypeContext();
 return __experimental_useStatements({
 for: subscriberType === 'org' ? 'organization' : 'user',
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: true,
 __experimental_mode: params?.mode,
 });
};

export const useSubscriptions = () => {
Expand DownExpand Up@@ -181,18 +175,17 @@ export const usePlansContext = () => {
 });

 // Invalidates cache but does not fetch immediately
 const { mutate: mutateStatements } =
 useSWR<Awaited<ReturnType<typeof clerk.billing.getStatements>>>(useStatementsCacheKey());
 const { revalidate: revalidateStatements } = useStatements({ mode: 'cache' });

 const { mutate: mutatePaymentSources } = usePaymentSources();
 const { revalidate: revalidatePaymentSources } = usePaymentMethods();

 const revalidateAll = useCallback(() => {
 // Revalidate the plans and subscriptions
 void mutateSubscriptions();
 void mutatePlans();
 void mutateStatements();
 void mutatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, mutateStatements, mutatePaymentSources]);
 void revalidateStatements();
 void revalidatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, revalidateStatements, revalidatePaymentSources]);

 // should the default plan be shown as active
 const isDefaultPlanImplicitlyActiveOrUpcoming = useMemo(() => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/Statements.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const useStatementsContext = () => {
 const { data: statements } = useStatements();
 const getStatementById = useCallback(
 (statementId: string) => {
 return statements?.data.find(statement => statement.id === statementId);
 return statements.find(statement => statement.id === statementId);
 },
 [statements?.data],
 [statements],
 );

 return {
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
chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data#6159

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 16 commits into

from

Jun 25, 2025
 Merged


chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data
#6159
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
07fcccf

wip add hooks for attempts, methods, statements


panteliselef Jun 19, 2025
f35fb2b

add subscription items


panteliselef Jun 19, 2025
b17c2e1

Create a factory


panteliselef Jun 19, 2025
1cf74f0

cleanup


panteliselef Jun 23, 2025
8a3d87c

cleanup of swr fetchOnMount logic


panteliselef Jun 23, 2025
ac26c47

add changesets


panteliselef Jun 23, 2025
c971964

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 23, 2025
6991ac0

remove type change


panteliselef Jun 23, 2025
59731cc

add internal jsdoc comments


panteliselef Jun 23, 2025
e693842

improve dx and add comments


panteliselef Jun 24, 2025
d13a64c

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 24, 2025
99fe9d3

remove ts-ignore comment


panteliselef Jun 24, 2025
4c8e43e

update jsdoc for `__experimental_mode`


panteliselef Jun 24, 2025
13b2a1c

remove wrong types


panteliselef Jun 24, 2025
ed63fb2

revert type change


panteliselef Jun 25, 2025
27a6c17

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smart-pandas-carry.md

View file


Open in desktop

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

Use hooks exported from `@clerk/shared` to query commerce data.

10 changes: 10 additions & 0 deletions
.changeset/violet-terms-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
---
'@clerk/shared': minor
'@clerk/types': minor
---

Introduce experimental paginated hooks for commerce data.
- `useStatements`
- `usePaymentAttempts`
- `usePaymentMethods`
Prefixed with `__experimental_`

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';

import { DevOnly } from '../../common/DevOnly';
import { useCheckoutContext, usePaymentSources } from '../../contexts';
import { useCheckoutContext, usePaymentMethods } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, localizationKeys, Text } from '../../customizables';
import { ChevronUpDown, InformationCircle } from '../../icons';
import { handleError } from '../../utils';
Expand DownExpand Up@@ -191,8 +191,7 @@ const useCheckoutMutations = () => {
};

const CheckoutFormElements = ({ checkout }: { checkout: CommerceCheckoutResource }) => {
 const { data } = usePaymentSources();
 const { data: paymentSources } = data || { data: [] };
 const { data: paymentSources } = usePaymentMethods();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() =>
 paymentSources.length > 0 ? 'existing' : 'new',
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/PaymentAttempts/PaymentAttemptsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,14 @@ import { formatDate, truncateWithEndVisible } from '../../utils';
 * -----------------------------------------------------------------------------------------------*/

export const PaymentAttemptsList = () => {
 const { data: paymentAttempts, isLoading } = usePaymentAttempts();
 const { data: paymentAttempts, isLoading, count } = usePaymentAttempts();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={paymentAttempts?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const PaymentAttemptsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__amount`),
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__status`),
 ]}
 rows={(paymentAttempts?.data || []).map(i => (
 rows={paymentAttempts.map(i => (
 <PaymentAttemptsListRow
 key={i.id}
 paymentAttempt={i}
Expand Down

20 changes: 8 additions & 12 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import type { CommercePaymentSourceResource } from '@clerk/types';
import type { SetupIntent } from '@stripe/stripe-js';
import { Fragment, useCallback, useMemo, useRef } from 'react';
import { Fragment, useMemo, useRef } from 'react';

import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { FullHeightLoader } from '@/ui/elements/FullHeightLoader';
Expand All@@ -10,7 +10,7 @@ import { ThreeDotsMenu } from '@/ui/elements/ThreeDotsMenu';

import { RemoveResourceForm } from '../../common';
import { DevOnly } from '../../common/DevOnly';
import { usePaymentSources, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { usePaymentMethods, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
Expand DownExpand Up@@ -114,17 +114,13 @@ export const PaymentSources = withCardStateProvider(() => {
 const localizationRoot = useSubscriberTypeLocalizationRoot();
 const resource = subscriberType === 'org' ? clerk?.organization : clerk.user;

 const { data, isLoading, mutate: mutatePaymentSources } = usePaymentSources();

 const { data: paymentSources = [] } = data || {};
 const { data: paymentMethods, isLoading, revalidate: revalidatePaymentMethods } = usePaymentMethods();

 const sortedPaymentSources = useMemo(
 () => paymentSources.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentSources],
 () => paymentMethods.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentMethods],
 );

 const revalidatePaymentSources = useCallback(() => void mutatePaymentSources(), [mutatePaymentSources]);

 if (!resource) {
 return null;
 }
Expand DownExpand Up@@ -156,15 +152,15 @@ export const PaymentSources = withCardStateProvider(() => {
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </ProfileSection.Item>

 <Action.Open value={`remove-${paymentSource.id}`}>
 <Action.Card variant='destructive'>
 <RemoveScreen
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </Action.Card>
 </Action.Open>
Expand All@@ -178,7 +174,7 @@ export const PaymentSources = withCardStateProvider(() => {
 </Action.Trigger>
 <Action.Open value='add'>
 <Action.Card>
 <AddScreen onSuccess={revalidatePaymentSources} />
 <AddScreen onSuccess={revalidatePaymentMethods} />
 </Action.Card>
 </Action.Open>
 </>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useClerk } from '@clerk/shared/react';
import type { CommercePlanResource, CommerceSubscriptionPlanPeriod, PricingTableProps } from '@clerk/types';
import { useEffect, useMemo, useState } from 'react';

import { usePaymentSources, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { usePaymentMethods, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { Flow } from '../../customizables';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
Expand DownExpand Up@@ -60,7 +60,7 @@ const PricingTableRoot = (props: PricingTableProps) => {
 };

 // Pre-fetch payment sources
usePaymentSources();
usePaymentMethods();

 return (
 <Flow.Root
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/Statements/StatementsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { truncateWithEndVisible } from '../../utils/truncateTextWithEndVisible';
 * -----------------------------------------------------------------------------------------------*/

export const StatementsList = () => {
 const { data: statements, isLoading } = useStatements();
 const { data: statements, isLoading, count } = useStatements();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={statements?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const StatementsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__date`),
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__amount`),
 ]}
 rows={(statements?.data || []).map(i => (
 rows={statements.map(i => (
 <StatementsListRow
 key={i.id}
 statement={i}
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/PaymentAttempts.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const usePaymentAttemptsContext = () => {
 const { data: payments } = usePaymentAttempts();
 const getPaymentAttemptById = useCallback(
 (paymentAttemptId: string) => {
 return payments?.data.find(payment => payment.id === paymentAttemptId);
 return payments.find(payment => payment.id === paymentAttemptId);
 },
 [payments?.data],
 [payments],
 );

 return {
Expand Down

85 changes: 39 additions & 46 deletions
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import { useClerk, useOrganization, useSession, useUser } from '@clerk/shared/react';
import {
 __experimental_usePaymentAttempts,
 __experimental_usePaymentMethods,
 __experimental_useStatements,
 useClerk,
 useOrganization,
 useSession,
 useUser,
} from '@clerk/shared/react';
import type {
 Appearance,
 CommercePlanResource,
Expand All@@ -8,7 +16,8 @@ import type {
import { useCallback, useMemo } from 'react';
import useSWR from 'swr';

import { CommerceSubscription } from '../../../core/resources/internal';
import { CommerceSubscription } from '@/core/resources/CommerceSubscription';

import type { LocalizationKey } from '../../localization';
import { localizationKeys } from '../../localization';
import { getClosestProfileScrollBox } from '../../utils';
Expand All@@ -30,51 +39,36 @@ export const usePaymentSourcesCacheKey = () => {
 };
};

export const usePaymentSources = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();
 const cacheKey = usePaymentSourcesCacheKey();

 return useSWR(cacheKey, () => (subscriberType === 'org' ? organization : user)?.getPaymentSources({}), dedupeOptions);
};

export const usePaymentAttemptsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-payment-history`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentMethods({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const usePaymentAttempts = () => {
 const { billing } = useClerk();
 const cacheKey = usePaymentAttemptsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getPaymentAttempts(args) : undefined), dedupeOptions);
};

export const useStatementsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-statements`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentAttempts({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const useStatements = () => {
 const { billing } = useClerk();
 const cacheKey = useStatementsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getStatements(args) : undefined), dedupeOptions);
export const useStatements = (params?: { mode: 'cache' }) => {
 const subscriberType = useSubscriberTypeContext();
 return __experimental_useStatements({
 for: subscriberType === 'org' ? 'organization' : 'user',
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: true,
 __experimental_mode: params?.mode,
 });
};

export const useSubscriptions = () => {
Expand DownExpand Up@@ -181,18 +175,17 @@ export const usePlansContext = () => {
 });

 // Invalidates cache but does not fetch immediately
 const { mutate: mutateStatements } =
 useSWR<Awaited<ReturnType<typeof clerk.billing.getStatements>>>(useStatementsCacheKey());
 const { revalidate: revalidateStatements } = useStatements({ mode: 'cache' });

 const { mutate: mutatePaymentSources } = usePaymentSources();
 const { revalidate: revalidatePaymentSources } = usePaymentMethods();

 const revalidateAll = useCallback(() => {
 // Revalidate the plans and subscriptions
 void mutateSubscriptions();
 void mutatePlans();
 void mutateStatements();
 void mutatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, mutateStatements, mutatePaymentSources]);
 void revalidateStatements();
 void revalidatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, revalidateStatements, revalidatePaymentSources]);

 // should the default plan be shown as active
 const isDefaultPlanImplicitlyActiveOrUpcoming = useMemo(() => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/Statements.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const useStatementsContext = () => {
 const { data: statements } = useStatements();
 const getStatementById = useCallback(
 (statementId: string) => {
 return statements?.data.find(statement => statement.id === statementId);
 return statements.find(statement => statement.id === statementId);
 },
 [statements?.data],
 [statements],
 );

 return {
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
chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data#6159

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 16 commits into

from

Jun 25, 2025
 Merged


chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data
#6159
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
07fcccf

wip add hooks for attempts, methods, statements


panteliselef Jun 19, 2025
f35fb2b

add subscription items


panteliselef Jun 19, 2025
b17c2e1

Create a factory


panteliselef Jun 19, 2025
1cf74f0

cleanup


panteliselef Jun 23, 2025
8a3d87c

cleanup of swr fetchOnMount logic


panteliselef Jun 23, 2025
ac26c47

add changesets


panteliselef Jun 23, 2025
c971964

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 23, 2025
6991ac0

remove type change


panteliselef Jun 23, 2025
59731cc

add internal jsdoc comments


panteliselef Jun 23, 2025
e693842

improve dx and add comments


panteliselef Jun 24, 2025
d13a64c

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 24, 2025
99fe9d3

remove ts-ignore comment


panteliselef Jun 24, 2025
4c8e43e

update jsdoc for `__experimental_mode`


panteliselef Jun 24, 2025
13b2a1c

remove wrong types


panteliselef Jun 24, 2025
ed63fb2

revert type change


panteliselef Jun 25, 2025
27a6c17

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smart-pandas-carry.md

View file


Open in desktop

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

Use hooks exported from `@clerk/shared` to query commerce data.

10 changes: 10 additions & 0 deletions
.changeset/violet-terms-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
---
'@clerk/shared': minor
'@clerk/types': minor
---

Introduce experimental paginated hooks for commerce data.
- `useStatements`
- `usePaymentAttempts`
- `usePaymentMethods`
Prefixed with `__experimental_`

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';

import { DevOnly } from '../../common/DevOnly';
import { useCheckoutContext, usePaymentSources } from '../../contexts';
import { useCheckoutContext, usePaymentMethods } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, localizationKeys, Text } from '../../customizables';
import { ChevronUpDown, InformationCircle } from '../../icons';
import { handleError } from '../../utils';
Expand DownExpand Up@@ -191,8 +191,7 @@ const useCheckoutMutations = () => {
};

const CheckoutFormElements = ({ checkout }: { checkout: CommerceCheckoutResource }) => {
 const { data } = usePaymentSources();
 const { data: paymentSources } = data || { data: [] };
 const { data: paymentSources } = usePaymentMethods();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() =>
 paymentSources.length > 0 ? 'existing' : 'new',
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/PaymentAttempts/PaymentAttemptsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,14 @@ import { formatDate, truncateWithEndVisible } from '../../utils';
 * -----------------------------------------------------------------------------------------------*/

export const PaymentAttemptsList = () => {
 const { data: paymentAttempts, isLoading } = usePaymentAttempts();
 const { data: paymentAttempts, isLoading, count } = usePaymentAttempts();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={paymentAttempts?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const PaymentAttemptsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__amount`),
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__status`),
 ]}
 rows={(paymentAttempts?.data || []).map(i => (
 rows={paymentAttempts.map(i => (
 <PaymentAttemptsListRow
 key={i.id}
 paymentAttempt={i}
Expand Down

20 changes: 8 additions & 12 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import type { CommercePaymentSourceResource } from '@clerk/types';
import type { SetupIntent } from '@stripe/stripe-js';
import { Fragment, useCallback, useMemo, useRef } from 'react';
import { Fragment, useMemo, useRef } from 'react';

import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { FullHeightLoader } from '@/ui/elements/FullHeightLoader';
Expand All@@ -10,7 +10,7 @@ import { ThreeDotsMenu } from '@/ui/elements/ThreeDotsMenu';

import { RemoveResourceForm } from '../../common';
import { DevOnly } from '../../common/DevOnly';
import { usePaymentSources, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { usePaymentMethods, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
Expand DownExpand Up@@ -114,17 +114,13 @@ export const PaymentSources = withCardStateProvider(() => {
 const localizationRoot = useSubscriberTypeLocalizationRoot();
 const resource = subscriberType === 'org' ? clerk?.organization : clerk.user;

 const { data, isLoading, mutate: mutatePaymentSources } = usePaymentSources();

 const { data: paymentSources = [] } = data || {};
 const { data: paymentMethods, isLoading, revalidate: revalidatePaymentMethods } = usePaymentMethods();

 const sortedPaymentSources = useMemo(
 () => paymentSources.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentSources],
 () => paymentMethods.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentMethods],
 );

 const revalidatePaymentSources = useCallback(() => void mutatePaymentSources(), [mutatePaymentSources]);

 if (!resource) {
 return null;
 }
Expand DownExpand Up@@ -156,15 +152,15 @@ export const PaymentSources = withCardStateProvider(() => {
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </ProfileSection.Item>

 <Action.Open value={`remove-${paymentSource.id}`}>
 <Action.Card variant='destructive'>
 <RemoveScreen
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </Action.Card>
 </Action.Open>
Expand All@@ -178,7 +174,7 @@ export const PaymentSources = withCardStateProvider(() => {
 </Action.Trigger>
 <Action.Open value='add'>
 <Action.Card>
 <AddScreen onSuccess={revalidatePaymentSources} />
 <AddScreen onSuccess={revalidatePaymentMethods} />
 </Action.Card>
 </Action.Open>
 </>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useClerk } from '@clerk/shared/react';
import type { CommercePlanResource, CommerceSubscriptionPlanPeriod, PricingTableProps } from '@clerk/types';
import { useEffect, useMemo, useState } from 'react';

import { usePaymentSources, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { usePaymentMethods, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { Flow } from '../../customizables';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
Expand DownExpand Up@@ -60,7 +60,7 @@ const PricingTableRoot = (props: PricingTableProps) => {
 };

 // Pre-fetch payment sources
usePaymentSources();
usePaymentMethods();

 return (
 <Flow.Root
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/Statements/StatementsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { truncateWithEndVisible } from '../../utils/truncateTextWithEndVisible';
 * -----------------------------------------------------------------------------------------------*/

export const StatementsList = () => {
 const { data: statements, isLoading } = useStatements();
 const { data: statements, isLoading, count } = useStatements();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={statements?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const StatementsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__date`),
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__amount`),
 ]}
 rows={(statements?.data || []).map(i => (
 rows={statements.map(i => (
 <StatementsListRow
 key={i.id}
 statement={i}
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/PaymentAttempts.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const usePaymentAttemptsContext = () => {
 const { data: payments } = usePaymentAttempts();
 const getPaymentAttemptById = useCallback(
 (paymentAttemptId: string) => {
 return payments?.data.find(payment => payment.id === paymentAttemptId);
 return payments.find(payment => payment.id === paymentAttemptId);
 },
 [payments?.data],
 [payments],
 );

 return {
Expand Down

85 changes: 39 additions & 46 deletions
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import { useClerk, useOrganization, useSession, useUser } from '@clerk/shared/react';
import {
 __experimental_usePaymentAttempts,
 __experimental_usePaymentMethods,
 __experimental_useStatements,
 useClerk,
 useOrganization,
 useSession,
 useUser,
} from '@clerk/shared/react';
import type {
 Appearance,
 CommercePlanResource,
Expand All@@ -8,7 +16,8 @@ import type {
import { useCallback, useMemo } from 'react';
import useSWR from 'swr';

import { CommerceSubscription } from '../../../core/resources/internal';
import { CommerceSubscription } from '@/core/resources/CommerceSubscription';

import type { LocalizationKey } from '../../localization';
import { localizationKeys } from '../../localization';
import { getClosestProfileScrollBox } from '../../utils';
Expand All@@ -30,51 +39,36 @@ export const usePaymentSourcesCacheKey = () => {
 };
};

export const usePaymentSources = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();
 const cacheKey = usePaymentSourcesCacheKey();

 return useSWR(cacheKey, () => (subscriberType === 'org' ? organization : user)?.getPaymentSources({}), dedupeOptions);
};

export const usePaymentAttemptsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-payment-history`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentMethods({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const usePaymentAttempts = () => {
 const { billing } = useClerk();
 const cacheKey = usePaymentAttemptsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getPaymentAttempts(args) : undefined), dedupeOptions);
};

export const useStatementsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-statements`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentAttempts({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const useStatements = () => {
 const { billing } = useClerk();
 const cacheKey = useStatementsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getStatements(args) : undefined), dedupeOptions);
export const useStatements = (params?: { mode: 'cache' }) => {
 const subscriberType = useSubscriberTypeContext();
 return __experimental_useStatements({
 for: subscriberType === 'org' ? 'organization' : 'user',
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: true,
 __experimental_mode: params?.mode,
 });
};

export const useSubscriptions = () => {
Expand DownExpand Up@@ -181,18 +175,17 @@ export const usePlansContext = () => {
 });

 // Invalidates cache but does not fetch immediately
 const { mutate: mutateStatements } =
 useSWR<Awaited<ReturnType<typeof clerk.billing.getStatements>>>(useStatementsCacheKey());
 const { revalidate: revalidateStatements } = useStatements({ mode: 'cache' });

 const { mutate: mutatePaymentSources } = usePaymentSources();
 const { revalidate: revalidatePaymentSources } = usePaymentMethods();

 const revalidateAll = useCallback(() => {
 // Revalidate the plans and subscriptions
 void mutateSubscriptions();
 void mutatePlans();
 void mutateStatements();
 void mutatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, mutateStatements, mutatePaymentSources]);
 void revalidateStatements();
 void revalidatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, revalidateStatements, revalidatePaymentSources]);

 // should the default plan be shown as active
 const isDefaultPlanImplicitlyActiveOrUpcoming = useMemo(() => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/Statements.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const useStatementsContext = () => {
 const { data: statements } = useStatements();
 const getStatementById = useCallback(
 (statementId: string) => {
 return statements?.data.find(statement => statement.id === statementId);
 return statements.find(statement => statement.id === statementId);
 },
 [statements?.data],
 [statements],
 );

 return {
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
chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data#6159

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 16 commits into

from

Jun 25, 2025
 Merged


chore(clerk-js, shared): Use experimental paginated hooks for querying commerce data
#6159
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
07fcccf

wip add hooks for attempts, methods, statements


panteliselef Jun 19, 2025
f35fb2b

add subscription items


panteliselef Jun 19, 2025
b17c2e1

Create a factory


panteliselef Jun 19, 2025
1cf74f0

cleanup


panteliselef Jun 23, 2025
8a3d87c

cleanup of swr fetchOnMount logic


panteliselef Jun 23, 2025
ac26c47

add changesets


panteliselef Jun 23, 2025
c971964

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 23, 2025
6991ac0

remove type change


panteliselef Jun 23, 2025
59731cc

add internal jsdoc comments


panteliselef Jun 23, 2025
e693842

improve dx and add comments


panteliselef Jun 24, 2025
d13a64c

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 24, 2025
99fe9d3

remove ts-ignore comment


panteliselef Jun 24, 2025
4c8e43e

update jsdoc for `__experimental_mode`


panteliselef Jun 24, 2025
13b2a1c

remove wrong types


panteliselef Jun 24, 2025
ed63fb2

revert type change


panteliselef Jun 25, 2025
27a6c17

Merge branch 'main' into elef/com-959-dx-guide-introduce-query-hooks-…


panteliselef Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/smart-pandas-carry.md

View file


Open in desktop

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

Use hooks exported from `@clerk/shared` to query commerce data.

10 changes: 10 additions & 0 deletions
.changeset/violet-terms-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
---
'@clerk/shared': minor
'@clerk/types': minor
---

Introduce experimental paginated hooks for commerce data.
- `useStatements`
- `usePaymentAttempts`
- `usePaymentMethods`
Prefixed with `__experimental_`

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import { Select, SelectButton, SelectOptionList } from '@/ui/elements/Select';
import { Tooltip } from '@/ui/elements/Tooltip';

import { DevOnly } from '../../common/DevOnly';
import { useCheckoutContext, usePaymentSources } from '../../contexts';
import { useCheckoutContext, usePaymentMethods } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, localizationKeys, Text } from '../../customizables';
import { ChevronUpDown, InformationCircle } from '../../icons';
import { handleError } from '../../utils';
Expand DownExpand Up@@ -191,8 +191,7 @@ const useCheckoutMutations = () => {
};

const CheckoutFormElements = ({ checkout }: { checkout: CommerceCheckoutResource }) => {
 const { data } = usePaymentSources();
 const { data: paymentSources } = data || { data: [] };
 const { data: paymentSources } = usePaymentMethods();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() =>
 paymentSources.length > 0 ? 'existing' : 'new',
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/PaymentAttempts/PaymentAttemptsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,14 @@ import { formatDate, truncateWithEndVisible } from '../../utils';
 * -----------------------------------------------------------------------------------------------*/

export const PaymentAttemptsList = () => {
 const { data: paymentAttempts, isLoading } = usePaymentAttempts();
 const { data: paymentAttempts, isLoading, count } = usePaymentAttempts();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={paymentAttempts?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const PaymentAttemptsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__amount`),
 localizationKeys(`${localizationRoot}.billingPage.paymentHistorySection.tableHeader__status`),
 ]}
 rows={(paymentAttempts?.data || []).map(i => (
 rows={paymentAttempts.map(i => (
 <PaymentAttemptsListRow
 key={i.id}
 paymentAttempt={i}
Expand Down

20 changes: 8 additions & 12 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import type { CommercePaymentSourceResource } from '@clerk/types';
import type { SetupIntent } from '@stripe/stripe-js';
import { Fragment, useCallback, useMemo, useRef } from 'react';
import { Fragment, useMemo, useRef } from 'react';

import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { FullHeightLoader } from '@/ui/elements/FullHeightLoader';
Expand All@@ -10,7 +10,7 @@ import { ThreeDotsMenu } from '@/ui/elements/ThreeDotsMenu';

import { RemoveResourceForm } from '../../common';
import { DevOnly } from '../../common/DevOnly';
import { usePaymentSources, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { usePaymentMethods, useSubscriberTypeContext, useSubscriberTypeLocalizationRoot } from '../../contexts';
import { localizationKeys } from '../../customizables';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
Expand DownExpand Up@@ -114,17 +114,13 @@ export const PaymentSources = withCardStateProvider(() => {
 const localizationRoot = useSubscriberTypeLocalizationRoot();
 const resource = subscriberType === 'org' ? clerk?.organization : clerk.user;

 const { data, isLoading, mutate: mutatePaymentSources } = usePaymentSources();

 const { data: paymentSources = [] } = data || {};
 const { data: paymentMethods, isLoading, revalidate: revalidatePaymentMethods } = usePaymentMethods();

 const sortedPaymentSources = useMemo(
 () => paymentSources.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentSources],
 () => paymentMethods.sort((a, b) => (a.isDefault && !b.isDefault ? -1 : 1)),
 [paymentMethods],
 );

 const revalidatePaymentSources = useCallback(() => void mutatePaymentSources(), [mutatePaymentSources]);

 if (!resource) {
 return null;
 }
Expand DownExpand Up@@ -156,15 +152,15 @@ export const PaymentSources = withCardStateProvider(() => {
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </ProfileSection.Item>

 <Action.Open value={`remove-${paymentSource.id}`}>
 <Action.Card variant='destructive'>
 <RemoveScreen
 paymentSource={paymentSource}
 revalidate={revalidatePaymentSources}
 revalidate={revalidatePaymentMethods}
 />
 </Action.Card>
 </Action.Open>
Expand All@@ -178,7 +174,7 @@ export const PaymentSources = withCardStateProvider(() => {
 </Action.Trigger>
 <Action.Open value='add'>
 <Action.Card>
 <AddScreen onSuccess={revalidatePaymentSources} />
 <AddScreen onSuccess={revalidatePaymentMethods} />
 </Action.Card>
 </Action.Open>
 </>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useClerk } from '@clerk/shared/react';
import type { CommercePlanResource, CommerceSubscriptionPlanPeriod, PricingTableProps } from '@clerk/types';
import { useEffect, useMemo, useState } from 'react';

import { usePaymentSources, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { usePaymentMethods, usePlans, usePlansContext, usePricingTableContext, useSubscriptions } from '../../contexts';
import { Flow } from '../../customizables';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
Expand DownExpand Up@@ -60,7 +60,7 @@ const PricingTableRoot = (props: PricingTableProps) => {
 };

 // Pre-fetch payment sources
usePaymentSources();
usePaymentMethods();

 return (
 <Flow.Root
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/Statements/StatementsList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,14 @@ import { truncateWithEndVisible } from '../../utils/truncateTextWithEndVisible';
 * -----------------------------------------------------------------------------------------------*/

export const StatementsList = () => {
 const { data: statements, isLoading } = useStatements();
 const { data: statements, isLoading, count } = useStatements();
 const localizationRoot = useSubscriberTypeLocalizationRoot();

 return (
 <DataTable
 page={1}
 onPageChange={_ => {}}
 itemCount={statements?.total_count || 0}
 itemCount={count}
 pageCount={1}
 itemsPerPage={10}
 isLoading={isLoading}
Expand All@@ -29,7 +29,7 @@ export const StatementsList = () => {
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__date`),
 localizationKeys(`${localizationRoot}.billingPage.statementsSection.tableHeader__amount`),
 ]}
 rows={(statements?.data || []).map(i => (
 rows={statements.map(i => (
 <StatementsListRow
 key={i.id}
 statement={i}
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/PaymentAttempts.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const usePaymentAttemptsContext = () => {
 const { data: payments } = usePaymentAttempts();
 const getPaymentAttemptById = useCallback(
 (paymentAttemptId: string) => {
 return payments?.data.find(payment => payment.id === paymentAttemptId);
 return payments.find(payment => payment.id === paymentAttemptId);
 },
 [payments?.data],
 [payments],
 );

 return {
Expand Down

85 changes: 39 additions & 46 deletions
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
import { useClerk, useOrganization, useSession, useUser } from '@clerk/shared/react';
import {
 __experimental_usePaymentAttempts,
 __experimental_usePaymentMethods,
 __experimental_useStatements,
 useClerk,
 useOrganization,
 useSession,
 useUser,
} from '@clerk/shared/react';
import type {
 Appearance,
 CommercePlanResource,
Expand All@@ -8,7 +16,8 @@ import type {
import { useCallback, useMemo } from 'react';
import useSWR from 'swr';

import { CommerceSubscription } from '../../../core/resources/internal';
import { CommerceSubscription } from '@/core/resources/CommerceSubscription';

import type { LocalizationKey } from '../../localization';
import { localizationKeys } from '../../localization';
import { getClosestProfileScrollBox } from '../../utils';
Expand All@@ -30,51 +39,36 @@ export const usePaymentSourcesCacheKey = () => {
 };
};

export const usePaymentSources = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();
 const cacheKey = usePaymentSourcesCacheKey();

 return useSWR(cacheKey, () => (subscriberType === 'org' ? organization : user)?.getPaymentSources({}), dedupeOptions);
};

export const usePaymentAttemptsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
// TODO(@COMMERCE): Rename payment sources to payment methods at the API level
export const usePaymentMethods = () => {
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-payment-history`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentMethods({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const usePaymentAttempts = () => {
 const { billing } = useClerk();
 const cacheKey = usePaymentAttemptsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getPaymentAttempts(args) : undefined), dedupeOptions);
};

export const useStatementsCacheKey = () => {
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

return {
key: `commerce-statements`,
userId: user?.id,
args: { orgId: subscriberType === 'org' ? organization?.id : undefined },
 };
 return __experimental_usePaymentAttempts({
 for: subscriberType === 'org' ? 'organization' : 'user',
initialPage: 1,
pageSize: 10,
keepPreviousData: true,
 });
};

export const useStatements = () => {
 const { billing } = useClerk();
 const cacheKey = useStatementsCacheKey();

 return useSWR(cacheKey, ({ args, userId }) => (userId ? billing.getStatements(args) : undefined), dedupeOptions);
export const useStatements = (params?: { mode: 'cache' }) => {
 const subscriberType = useSubscriberTypeContext();
 return __experimental_useStatements({
 for: subscriberType === 'org' ? 'organization' : 'user',
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: true,
 __experimental_mode: params?.mode,
 });
};

export const useSubscriptions = () => {
Expand DownExpand Up@@ -181,18 +175,17 @@ export const usePlansContext = () => {
 });

 // Invalidates cache but does not fetch immediately
 const { mutate: mutateStatements } =
 useSWR<Awaited<ReturnType<typeof clerk.billing.getStatements>>>(useStatementsCacheKey());
 const { revalidate: revalidateStatements } = useStatements({ mode: 'cache' });

 const { mutate: mutatePaymentSources } = usePaymentSources();
 const { revalidate: revalidatePaymentSources } = usePaymentMethods();

 const revalidateAll = useCallback(() => {
 // Revalidate the plans and subscriptions
 void mutateSubscriptions();
 void mutatePlans();
 void mutateStatements();
 void mutatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, mutateStatements, mutatePaymentSources]);
 void revalidateStatements();
 void revalidatePaymentSources();
 }, [mutateSubscriptions, mutatePlans, revalidateStatements, revalidatePaymentSources]);

 // should the default plan be shown as active
 const isDefaultPlanImplicitlyActiveOrUpcoming = useMemo(() => {
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/Statements.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,9 +6,9 @@ export const useStatementsContext = () => {
 const { data: statements } = useStatements();
 const getStatementById = useCallback(
 (statementId: string) => {
 return statements?.data.find(statement => statement.id === statementId);
 return statements.find(statement => statement.id === statementId);
 },
 [statements?.data],
 [statements],
 );

 return {
Expand Down
Loading