Skip to content

chore(shared): Add experimental JSDoc for org.getSubscriptions #6318

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.

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
merged 5 commits into from
Jul 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/happy-apes-open.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/types': patch
---

[Billing Beta] Add experimental JSDoc for `org.getSubscriptions`.
2 changes: 2 additions & 0 deletions packages/shared/src/react/hooks/useOrganization.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ export type UseOrganizationParams = {
*/
invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* If set to `true`, all default properties will be used.<br />
* Otherwise, accepts an object with the following optional properties:
* <ul>
Expand Down Expand Up @@ -111,6 +112,7 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
*/
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
* Includes a paginated list of the organization's subscriptions.
*/
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionResource>;
Expand Down
3 changes: 3 additions & 0 deletions packages/types/src/organization.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
getMembershipRequests: (
params?: GetMembershipRequestParams,
) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
/**
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
*/
getSubscriptions: (params?: GetSubscriptionsParams) => Promise<ClerkPaginatedResponse<CommerceSubscriptionResource>>;
addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;
Expand Down
Loading