fix(clerk-js, types): Remove orgId from BillingPayerMethods interface (#7087)

Author: panteliselef

.changeset/great-bees-fix.md

@@ -0,0 +1,7 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/types': minor
+---
+
+[Billing Beta] Remove unnecessary `orgId` from BillingPayerMethods interface.

packages/clerk-js/src/core/modules/billing/payment-source-methods.ts

@@ -13,7 +13,11 @@ import { Billing } from './namespace';
 
 const PAYMENT_METHODS_PATH = '/payment_methods';
 
-export const initializePaymentMethod = async (params: InitializePaymentMethodParams) => {
+type WithOptionalOrgType<T> = T & {
+  orgId?: string;
+};
+
+export const initializePaymentMethod = async (params: WithOptionalOrgType<InitializePaymentMethodParams>) => {
   const { orgId, ...rest } = params;
   const json = (
     await BaseResource._fetch({
@@ -25,7 +29,7 @@ export const initializePaymentMethod = async (params: InitializePaymentMethodPar
   return new BillingInitializedPaymentMethod(json);
 };
 
-export const addPaymentMethod = async (params: AddPaymentMethodParams) => {
+export const addPaymentMethod = async (params: WithOptionalOrgType<AddPaymentMethodParams>) => {
   const { orgId, ...rest } = params;
 
   const json = (
@@ -38,8 +42,8 @@ export const addPaymentMethod = async (params: AddPaymentMethodParams) => {
   return new BillingPaymentMethod(json);
 };
 
-export const getPaymentMethods = async (params: GetPaymentMethodsParams) => {
-  const { orgId, ...rest } = params;
+export const getPaymentMethods = async (params?: WithOptionalOrgType<GetPaymentMethodsParams>) => {
+  const { orgId, ...rest } = params ?? {};
 
   return await BaseResource._fetch({
     path: Billing.path(PAYMENT_METHODS_PATH, { orgId }),

packages/types/src/billing.ts

@@ -89,18 +89,16 @@ export interface BillingPayerMethods {
   /**
    * @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](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
-  initializePaymentMethod: (
-    params: Exclude<InitializePaymentMethodParams, 'orgId'>,
-  ) => Promise<BillingInitializedPaymentMethodResource>;
+  initializePaymentMethod: (params: InitializePaymentMethodParams) => Promise<BillingInitializedPaymentMethodResource>;
   /**
    * @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](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
-  addPaymentMethod: (params: Exclude<AddPaymentMethodParams, 'orgId'>) => Promise<BillingPaymentMethodResource>;
+  addPaymentMethod: (params: AddPaymentMethodParams) => Promise<BillingPaymentMethodResource>;
   /**
    * @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](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
   getPaymentMethods: (
-    params: Exclude<GetPaymentMethodsParams, 'orgId'>,
+    params?: GetPaymentMethodsParams,
   ) => Promise<ClerkPaginatedResponse<BillingPaymentMethodResource>>;
 }
 
@@ -226,29 +224,29 @@ export type BillingPaymentMethodStatus = 'active' | 'expired' | 'disconnected';
 /**
  * @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](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */
-export type GetPaymentMethodsParams = WithOptionalOrgType<ClerkPaginationParams>;
+export type GetPaymentMethodsParams = ClerkPaginationParams;
 
 /**
  * @inline
  *
  * @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](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */
-export type PaymentGateway = 'stripe' | 'paypal';
+export type PaymentGateway = 'stripe';
 
 /**
  * @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](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */
-export type InitializePaymentMethodParams = WithOptionalOrgType<{
+export type InitializePaymentMethodParams = {
   /**
    * The payment gateway to use.
    */
   gateway: PaymentGateway;
-}>;
+};
 
 /**
  * @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](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */
-export type AddPaymentMethodParams = WithOptionalOrgType<{
+export type AddPaymentMethodParams = {
   /**
    * The payment gateway to use.
    */
@@ -257,7 +255,7 @@ export type AddPaymentMethodParams = WithOptionalOrgType<{
    * A token representing payment details, usually from a payment form.
    */
   paymentToken: string;
-}>;
+};
 
 /**
  * @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](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.