chore(clerk-js,shared): Removal of experimental getSubscriptions (#6738)

Co-authored-by: panteliselef <[email protected]>

Author: mauricioabreu

.changeset/chilly-dots-heal.md

@@ -0,0 +1,6 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/types': minor
+---
+
+[Billing Beta] Removal of Billing experimental methods: `organization.getSubscriptions()` and `billing.getSubscriptions()`

.changeset/upset-masks-ask.md

@@ -0,0 +1,13 @@
+---
+'@clerk/shared': minor
+'@clerk/astro': minor
+'@clerk/chrome-extension': minor
+'@clerk/clerk-expo': minor
+'@clerk/nextjs': minor
+'@clerk/clerk-react': minor
+'@clerk/react-router': minor
+'@clerk/remix': minor
+'@clerk/tanstack-react-start': minor
+---
+
+[Billing Beta] Drop experimental `subscriptions` property from params of `useOrganization()`. Use [`useSubscription()`](https://clerk.com/docs/nextjs/hooks/use-subscription) instead.

.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap

@@ -75,7 +75,6 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
   "types/get-plans-params.mdx",
   "types/get-statements-params.mdx",
   "types/get-subscription-params.mdx",
-  "types/get-subscriptions-params.mdx",
   "types/get-token.mdx",
   "types/id-selectors.mdx",
   "types/initialize-payment-source-params.mdx",

packages/clerk-js/src/core/modules/commerce/CommerceBilling.ts

@@ -8,16 +8,13 @@ import type {
   CommercePlanResource,
   CommerceStatementJSON,
   CommerceStatementResource,
-  CommerceSubscriptionItemJSON,
-  CommerceSubscriptionItemResource,
   CommerceSubscriptionJSON,
   CommerceSubscriptionResource,
   CreateCheckoutParams,
   GetPaymentAttemptsParams,
   GetPlansParams,
   GetStatementsParams,
   GetSubscriptionParams,
-  GetSubscriptionsParams,
 } from '@clerk/types';
 
 import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
@@ -28,7 +25,6 @@ import {
   CommercePlan,
   CommerceStatement,
   CommerceSubscription,
-  CommerceSubscriptionItem,
 } from '../../resources/internal';
 
 export class CommerceBilling implements CommerceBillingNamespace {
@@ -65,26 +61,6 @@ export class CommerceBilling implements CommerceBillingNamespace {
     }).then(res => new CommerceSubscription(res?.response as CommerceSubscriptionJSON));
   };
 
-  getSubscriptions = async (
-    params: GetSubscriptionsParams,
-  ): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
-    const { orgId, ...rest } = params;
-
-    return await BaseResource._fetch({
-      path: orgId ? `/organizations/${orgId}/commerce/subscriptions` : `/me/commerce/subscriptions`,
-      method: 'GET',
-      search: convertPageToOffsetSearchParams(rest),
-    }).then(res => {
-      const { data: subscriptions, total_count } =
-        res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;
-
-      return {
-        total_count,
-        data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
-      };
-    });
-  };
-
   getStatements = async (params: GetStatementsParams): Promise<ClerkPaginatedResponse<CommerceStatementResource>> => {
     const { orgId, ...rest } = params;
 

packages/clerk-js/src/core/resources/Organization.ts

@@ -2,15 +2,12 @@ import type {
   AddMemberParams,
   ClerkPaginatedResponse,
   ClerkResourceReloadParams,
-  CommerceSubscriptionItemJSON,
-  CommerceSubscriptionItemResource,
   CreateOrganizationParams,
   GetDomainsParams,
   GetInvitationsParams,
   GetMembershipRequestParams,
   GetMemberships,
   GetRolesParams,
-  GetSubscriptionsParams,
   InviteMemberParams,
   InviteMembersParams,
   OrganizationDomainJSON,
@@ -32,7 +29,7 @@ import type {
 import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
 import { unixEpochToDate } from '../../utils/date';
 import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
-import { BaseResource, CommerceSubscriptionItem, OrganizationInvitation, OrganizationMembership } from './internal';
+import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
 import { OrganizationDomain } from './OrganizationDomain';
 import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
 import { Role } from './Role';
@@ -233,24 +230,6 @@ export class Organization extends BaseResource implements OrganizationResource {
     }).then(res => new OrganizationMembership(res?.response as OrganizationMembershipJSON));
   };
 
-  getSubscriptions = async (
-    getSubscriptionsParams?: GetSubscriptionsParams,
-  ): Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>> => {
-    return await BaseResource._fetch({
-      path: `/organizations/${this.id}/commerce/subscriptions`,
-      method: 'GET',
-      search: convertPageToOffsetSearchParams(getSubscriptionsParams),
-    }).then(res => {
-      const { data: subscriptions, total_count } =
-        res?.response as unknown as ClerkPaginatedResponse<CommerceSubscriptionItemJSON>;
-
-      return {
-        total_count,
-        data: subscriptions.map(subscription => new CommerceSubscriptionItem(subscription)),
-      };
-    });
-  };
-
   destroy = async (): Promise<void> => {
     return this._baseDelete();
   };

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

@@ -1,12 +1,10 @@
 /* eslint-disable jsdoc/require-description-complete-sentence */
 import type {
   ClerkPaginatedResponse,
-  CommerceSubscriptionItemResource,
   GetDomainsParams,
   GetInvitationsParams,
   GetMembershipRequestParams,
   GetMembersParams,
-  GetSubscriptionsParams,
   OrganizationDomainResource,
   OrganizationInvitationResource,
   OrganizationMembershipRequestResource,
@@ -66,16 +64,6 @@ export type UseOrganizationParams = {
    * </ul>
    */
   invitations?: true | PaginatedHookConfig<GetInvitationsParams>;
-  /**
-   * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
-   * If set to `true`, all default properties will be used.<br />
-   * Otherwise, accepts an object with the following optional properties:
-   * <ul>
-   *  <li>`orgId`: A string that filters the subscriptions by the provided organization ID.</li>
-   *  <li>Any of the properties described in [Shared properties](#shared-properties).</li>
-   * </ul>
-   */
-  subscriptions?: true | PaginatedHookConfig<GetSubscriptionsParams>;
 };
 
 /**
@@ -111,11 +99,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
        * Includes a paginated list of the organization's invitations.
        */
       invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
-      /**
-       * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
-       * Includes a paginated list of the organization's subscriptions.
-       */
-      subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
     }
   | {
       isLoaded: true;
@@ -125,7 +108,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
       membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
       memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
       invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
-      subscriptions: PaginatedResourcesWithDefault<CommerceSubscriptionItemResource>;
     }
   | {
       isLoaded: boolean;
@@ -147,10 +129,6 @@ export type UseOrganizationReturn<T extends UseOrganizationParams> =
         OrganizationInvitationResource,
         T['invitations'] extends { infinite: true } ? true : false
       > | null;
-      subscriptions: PaginatedResources<
-        CommerceSubscriptionItemResource,
-        T['subscriptions'] extends { infinite: true } ? true : false
-      > | null;
     };
 
 const undefinedPaginatedResource = {
@@ -300,7 +278,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
     membershipRequests: membershipRequestsListParams,
     memberships: membersListParams,
     invitations: invitationsListParams,
-    subscriptions: subscriptionsListParams,
   } = params || {};
 
   useAssertWrappedByClerkProvider('useOrganization');
@@ -341,13 +318,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
     infinite: false,
   });
 
-  const subscriptionsSafeValues = useWithSafeValues(subscriptionsListParams, {
-    initialPage: 1,
-    pageSize: 10,
-    keepPreviousData: false,
-    infinite: false,
-  });
-
   const clerk = useClerkInstanceContext();
 
   clerk.telemetry?.record(eventMethodCalled('useOrganization'));
@@ -389,15 +359,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
           status: invitationsSafeValues.status,
         };
 
-  const subscriptionsParams =
-    typeof subscriptionsListParams === 'undefined'
-      ? undefined
-      : {
-          initialPage: subscriptionsSafeValues.initialPage,
-          pageSize: subscriptionsSafeValues.pageSize,
-          orgId: organization?.id,
-        };
-
   const domains = usePagesOrInfinite<GetDomainsParams, ClerkPaginatedResponse<OrganizationDomainResource>>(
     {
       ...domainParams,
@@ -463,25 +424,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
     },
   );
 
-  const subscriptions = usePagesOrInfinite<
-    GetSubscriptionsParams,
-    ClerkPaginatedResponse<CommerceSubscriptionItemResource>
-  >(
-    {
-      ...subscriptionsParams,
-    },
-    organization?.getSubscriptions,
-    {
-      keepPreviousData: subscriptionsSafeValues.keepPreviousData,
-      infinite: subscriptionsSafeValues.infinite,
-      enabled: !!subscriptionsParams,
-    },
-    {
-      type: 'subscriptions',
-      organizationId: organization?.id,
-    },
-  );
-
   if (organization === undefined) {
     return {
       isLoaded: false,
@@ -491,7 +433,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
       membershipRequests: undefinedPaginatedResource,
       memberships: undefinedPaginatedResource,
       invitations: undefinedPaginatedResource,
-      subscriptions: undefinedPaginatedResource,
     };
   }
 
@@ -504,7 +445,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
       membershipRequests: null,
       memberships: null,
       invitations: null,
-      subscriptions: null,
     };
   }
 
@@ -518,7 +458,6 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
       membershipRequests: undefinedPaginatedResource,
       memberships: undefinedPaginatedResource,
       invitations: undefinedPaginatedResource,
-      subscriptions: undefinedPaginatedResource,
     };
   }
 
@@ -531,6 +470,5 @@ export function useOrganization<T extends UseOrganizationParams>(params?: T): Us
     membershipRequests,
     memberships,
     invitations,
-    subscriptions,
   };
 }

packages/types/src/commerce.ts

@@ -69,19 +69,6 @@ export interface CommerceBillingNamespace {
    */
   getSubscription: (params: GetSubscriptionParams) => Promise<CommerceSubscriptionResource>;
 
-  /**
-   * @deprecated Use `getSubscription` to fetch a single subscription with its items
-   * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
-   * It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
-   * @example
-   * ```tsx
-   * <ClerkProvider clerkJsVersion="x.x.x" />
-   * ```
-   */
-  getSubscriptions: (
-    params: GetSubscriptionsParams,
-  ) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;
-
   /**
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
    * It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
@@ -792,16 +779,6 @@ export interface CommerceStatementGroup {
   items: CommercePaymentResource[];
 }
 
-/**
- * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
- * It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
- * @example
- * ```tsx
- * <ClerkProvider clerkJsVersion="x.x.x" />
- * ```
- */
-export type GetSubscriptionsParams = WithOptionalOrgType<ClerkPaginationParams>;
-
 /**
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
  * It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.

packages/types/src/organization.ts

@@ -1,8 +1,4 @@
-import type {
-  CommercePaymentSourceMethods,
-  CommerceSubscriptionItemResource,
-  GetSubscriptionsParams,
-} from './commerce';
+import type { CommercePaymentSourceMethods } from './commerce';
 import type { OrganizationDomainResource, OrganizationEnrollmentMode } from './organizationDomain';
 import type { OrganizationInvitationResource, OrganizationInvitationStatus } from './organizationInvitation';
 import type { OrganizationCustomRoleKey, OrganizationMembershipResource } from './organizationMembership';
@@ -60,12 +56,6 @@ export interface OrganizationResource extends ClerkResource, CommercePaymentSour
   getMembershipRequests: (
     params?: GetMembershipRequestParams,
   ) => Promise<ClerkPaginatedResponse<OrganizationMembershipRequestResource>>;
-  /**
-   * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
-   */
-  getSubscriptions: (
-    params?: GetSubscriptionsParams,
-  ) => Promise<ClerkPaginatedResponse<CommerceSubscriptionItemResource>>;
   addMember: (params: AddMemberParams) => Promise<OrganizationMembershipResource>;
   inviteMember: (params: InviteMemberParams) => Promise<OrganizationInvitationResource>;
   inviteMembers: (params: InviteMembersParams) => Promise<OrganizationInvitationResource[]>;