Skip to content

Commit a5e92aa

Browse files
panteliselefjacekradko
authored andcommitted
chore(shared): Add experimental JSDoc for org.getSubscriptions (#6318)
1 parent 1d00ec8 commit a5e92aa

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

.changeset/happy-apes-open.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@clerk/shared': patch
3+
'@clerk/types': patch
4+
---
5+
6+
[Billing Beta] Add experimental JSDoc for `org.getSubscriptions`.

packages/shared/src/react/hooks/useOrganization.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ export type UseOrganizationParams = {
6767
*/
6868
invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
6969
/**
70+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
7071
* If set to `true`, all default properties will be used.<br />
7172
* Otherwise, accepts an object with the following optional properties:
7273
* <ul>
@@ -111,6 +112,7 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
111112
*/
112113
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
113114
/**
115+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
114116
* Includes a paginated list of the organization's subscriptions.
115117
*/
116118
subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionResource>;

packages/types/src/organization.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
5656
getMembershipRequests: (
5757
params?: GetMembershipRequestParams,
5858
) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
59+
/**
60+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
61+
*/
5962
getSubscriptions: (params?: GetSubscriptionsParams) => Promise<ClerkPaginatedResponse<CommerceSubscriptionResource>>;
6063
addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
6164
inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;

0 commit comments

Comments
 (0)