Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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