@clerk/types 4.95.1 → 4.96.0-canary.v20251028231233

package/dist/index.d.mts

@@ -257,15 +257,15 @@ 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'>) => Promise<ClerkPaginatedResponse<BillingPaymentMethodResource>>;
+    getPaymentMethods: (params?: GetPaymentMethodsParams) => Promise<ClerkPaginatedResponse<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.
@@ -384,26 +384,26 @@ 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.
  */
-type GetPaymentMethodsParams = WithOptionalOrgType<ClerkPaginationParams>;
+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.
  */
-type PaymentGateway = 'stripe' | 'paypal';
+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.
  */
-type InitializePaymentMethodParams = WithOptionalOrgType<{
+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.
  */
-type AddPaymentMethodParams = WithOptionalOrgType<{
+type AddPaymentMethodParams = {
     /**
      * The payment gateway to use.
      */
@@ -412,7 +412,7 @@ 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.
  */
@@ -906,6 +906,10 @@ interface BillingCheckoutResource extends ClerkResource {
      * The payer associated with the checkout.
      */
     payer: BillingPayerResource;
+    /**
+     * Whether a payment method is required for this checkout.
+     */
+    needsPaymentMethod: boolean;
 }
 /**
  * The `BillingPayerResource` type represents a payer associated with a billing subscription.
@@ -4360,6 +4364,7 @@ interface BillingCheckoutJSON extends ClerkResourceJSON {
     is_immediate_plan_change: boolean;
     free_trial_ends_at: number | null;
     payer: BillingPayerJSON;
+    needs_payment_method: boolean;
 }
 /**
  * @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.

package/dist/index.d.ts

@@ -257,15 +257,15 @@ 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'>) => Promise<ClerkPaginatedResponse<BillingPaymentMethodResource>>;
+    getPaymentMethods: (params?: GetPaymentMethodsParams) => Promise<ClerkPaginatedResponse<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.
@@ -384,26 +384,26 @@ 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.
  */
-type GetPaymentMethodsParams = WithOptionalOrgType<ClerkPaginationParams>;
+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.
  */
-type PaymentGateway = 'stripe' | 'paypal';
+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.
  */
-type InitializePaymentMethodParams = WithOptionalOrgType<{
+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.
  */
-type AddPaymentMethodParams = WithOptionalOrgType<{
+type AddPaymentMethodParams = {
     /**
      * The payment gateway to use.
      */
@@ -412,7 +412,7 @@ 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.
  */
@@ -906,6 +906,10 @@ interface BillingCheckoutResource extends ClerkResource {
      * The payer associated with the checkout.
      */
     payer: BillingPayerResource;
+    /**
+     * Whether a payment method is required for this checkout.
+     */
+    needsPaymentMethod: boolean;
 }
 /**
  * The `BillingPayerResource` type represents a payer associated with a billing subscription.
@@ -4360,6 +4364,7 @@ interface BillingCheckoutJSON extends ClerkResourceJSON {
     is_immediate_plan_change: boolean;
     free_trial_ends_at: number | null;
     payer: BillingPayerJSON;
+    needs_payment_method: boolean;
 }
 /**
  * @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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerk/types",
-  "version": "4.95.1",
+  "version": "4.96.0-canary.v20251028231233",
   "description": "Typings for Clerk libraries.",
   "keywords": [
     "clerk",