From e2ba9e92a793ba74c3e562701b788b3ddeda90ea Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Wed, 29 Oct 2025 17:16:52 +0000
Subject: [PATCH] docs: update TypeDoc documentation from
clerk/javascript@fb49d29
---
.../backend/verify-machine-auth-token.mdx | 17 ++++++---
clerk-typedoc/backend/verify-token.mdx | 31 +++++++++++-----
.../types/add-payment-method-params.mdx | 8 +++++
.../types/billing-checkout-resource.mdx | 1 +
clerk-typedoc/types/billing-payer-methods.mdx | 10 +++---
.../billing-subscription-item-resource.mdx | 35 +++++++++----------
.../types/confirm-checkout-params.mdx | 4 +--
.../initialize-payment-method-params.mdx | 7 ++++
clerk-typedoc/types/organization-resource.mdx | 14 ++++----
.../types/sign-in-future-resource.mdx | 1 +
clerk-typedoc/types/user-resource.mdx | 16 ++++-----
11 files changed, 92 insertions(+), 52 deletions(-)
diff --git a/clerk-typedoc/backend/verify-machine-auth-token.mdx b/clerk-typedoc/backend/verify-machine-auth-token.mdx
index 43fc12b40b..003154b7b8 100644
--- a/clerk-typedoc/backend/verify-machine-auth-token.mdx
+++ b/clerk-typedoc/backend/verify-machine-auth-token.mdx
@@ -2,10 +2,19 @@ Verifies any type of machine token by detecting its type from the prefix.
## Parameters
-| Parameter | Type | Description |
-| --------- | --------------------------------------------- | ------------------------------------------------------------------------- |
-| `token` | `string` | The token to verify (e.g. starts with "m2m*", "oauth*", "api*key*", etc.) |
-| `options` | [`VerifyTokenOptions`](#verify-token-options) | Options including secretKey for BAPI authorization |
+| Parameter | Type | Description |
+| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `token` | `string` | The token to verify (e.g. starts with "m2m*", "oauth*", "api*key*", etc.) |
+| `options` | \{ apiUrl?: string; apiVersion?: string; audience?: string \| string[]; authorizedParties?: string[]; clockSkewInMs?: number; jwksCacheTtlInMs?: number; jwtKey?: string; secretKey?: string; skipJwksCache?: boolean; \} | Options including secretKey for BAPI authorization |
+| `options.apiUrl?` | `string` | The [Clerk Backend API](/docs/reference/backend-api){{ target: '_blank' }} endpoint. Defaults to `'https://api.clerk.com'`. |
+| `options.apiVersion?` | `string` | The version passed to the Clerk API. Defaults to `'v1'`. |
+| `options.audience?` | string \| string[] | A string or list of [audiences](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3). If passed, it is checked against the `aud` claim in the token. |
+| `options.authorizedParties?` | string[] | An allowlist of origins to verify against, to protect your application from the subdomain cookie leaking attack. Example: `['http://localhost:3000', 'https://example.com']`. |
+| `options.clockSkewInMs?` | `number` | Specifies the allowed time difference (in milliseconds) between the Clerk server (which generates the token) and the clock of the user's application server when validating a token. Defaults to `5000`. |
+| `options.jwksCacheTtlInMs?` | `number` | **Deprecated.** This cache TTL will be removed in the next major version. Specifying a cache TTL is a no-op. |
+| `options.jwtKey?` | `string` | Used to verify the session token in a networkless manner. Supply the PEM public key from the **[**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page -> Show JWT public key -> PEM Public Key** section in the Clerk Dashboard. **It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables) instead.** For more information, refer to [Manual JWT verification](/docs/guides/sessions/manual-jwt-verification). |
+| `options.secretKey?` | `string` | The Clerk Secret Key from the [**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page in the Clerk Dashboard. |
+| `options.skipJwksCache?` | `boolean` | A flag to ignore the JWKS cache and always fetch JWKS before each JWT verification. |
## Returns
diff --git a/clerk-typedoc/backend/verify-token.mdx b/clerk-typedoc/backend/verify-token.mdx
index f723647902..32206d3d9d 100644
--- a/clerk-typedoc/backend/verify-token.mdx
+++ b/clerk-typedoc/backend/verify-token.mdx
@@ -2,20 +2,35 @@
> This is a lower-level method intended for more advanced use-cases. It's recommended to use [`authenticateRequest()`](/docs/reference/backend/authenticate-request), which fully authenticates a token passed from the `request` object.
```ts
-function verifyToken(
- token: string,
- options: VerifyTokenOptions,
-): Promise>;
+function verifyToken(token: string, options: { apiUrl?: string; apiVersion?: string; audience?: string | string[]; authorizedParties?: string[]; clockSkewInMs?: number; jwksCacheTtlInMs?: number; jwtKey?: string; secretKey?: string; skipJwksCache?: boolean; }): Promise>
```
Verifies a Clerk-generated token signature. Networkless if the `jwtKey` is provided. Otherwise, performs a network call to retrieve the JWKS from the [Backend API](/docs/reference/backend-api/tag/JWKS#operation/GetJWKS){{ target: '_blank' }}.
## Parameters
-| Parameter | Type | Description |
-| --------- | --------------------------------------------- | -------------------------------- |
-| `token` | `string` | The token to verify. |
-| `options` | [`VerifyTokenOptions`](#verify-token-options) | Options for verifying the token. |
+| Parameter | Type | Description |
+| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `token` | `string` | The token to verify. |
+| `options` | \{ apiUrl?: string; apiVersion?: string; audience?: string \| string[]; authorizedParties?: string[]; clockSkewInMs?: number; jwksCacheTtlInMs?: number; jwtKey?: string; secretKey?: string; skipJwksCache?: boolean; \} | Options for verifying the token. |
+| `options.apiUrl?` | `string` | The [Clerk Backend API](/docs/reference/backend-api){{ target: '_blank' }} endpoint. Defaults to `'https://api.clerk.com'`. |
+| `options.apiVersion?` | `string` | The version passed to the Clerk API. Defaults to `'v1'`. |
+| `options.audience?` | string \| string[] | A string or list of [audiences](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3). If passed, it is checked against the `aud` claim in the token. |
+| `options.authorizedParties?` | string[] | An allowlist of origins to verify against, to protect your application from the subdomain cookie leaking attack. Example: `['http://localhost:3000', 'https://example.com']`. |
+| `options.clockSkewInMs?` | `number` | Specifies the allowed time difference (in milliseconds) between the Clerk server (which generates the token) and the clock of the user's application server when validating a token. Defaults to `5000`. |
+| `options.jwksCacheTtlInMs?` | `number` | **Deprecated.** This cache TTL will be removed in the next major version. Specifying a cache TTL is a no-op. |
+| `options.jwtKey?` | `string` | Used to verify the session token in a networkless manner. Supply the PEM public key from the **[**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page -> Show JWT public key -> PEM Public Key** section in the Clerk Dashboard. **It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables) instead.** For more information, refer to [Manual JWT verification](/docs/guides/sessions/manual-jwt-verification). |
+| `options.secretKey?` | `string` | The Clerk Secret Key from the [**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page in the Clerk Dashboard. |
+| `options.skipJwksCache?` | `boolean` | A flag to ignore the JWKS cache and always fetch JWKS before each JWT verification. |
+
+### `VerifyTokenOptions`
+
+It is recommended to set these options as [environment variables](/docs/guides/development/clerk-environment-variables#api-and-sdk-configuration) where possible, and then pass them to the function. For example, you can set the `secretKey` option using the `CLERK_SECRET_KEY` environment variable, and then pass it to the function like this: `createClerkClient({ secretKey: process.env.CLERK_SECRET_KEY })`.
+
+> [!WARNING]
+> You must provide either `jwtKey` or `secretKey`.
+
+
## Example
diff --git a/clerk-typedoc/types/add-payment-method-params.mdx b/clerk-typedoc/types/add-payment-method-params.mdx
index e69de29bb2..1ec15dddde 100644
--- a/clerk-typedoc/types/add-payment-method-params.mdx
+++ b/clerk-typedoc/types/add-payment-method-params.mdx
@@ -0,0 +1,8 @@
+> **AddPaymentMethodParams** = \{ gateway: "stripe"; paymentToken: string; \}
+
+## Properties
+
+| Property | Type | Description |
+| ---------------------------------------- | ---------- | ------------------------------------------------------------------ |
+| `gateway` | `"stripe"` | The payment gateway to use. |
+| `paymentToken` | `string` | A token representing payment details, usually from a payment form. |
diff --git a/clerk-typedoc/types/billing-checkout-resource.mdx b/clerk-typedoc/types/billing-checkout-resource.mdx
index fab74d72ac..55582ef7a8 100644
--- a/clerk-typedoc/types/billing-checkout-resource.mdx
+++ b/clerk-typedoc/types/billing-checkout-resource.mdx
@@ -10,6 +10,7 @@ The `BillingCheckoutResource` type represents information about a checkout sessi
| `freeTrialEndsAt` | null \| Date | Unix timestamp (milliseconds) of when the free trial ends. |
| `id` | `string` | The unique identifier for the checkout session. |
| `isImmediatePlanChange` | `boolean` | Whether the plan change will take effect immediately after checkout. |
+| `needsPaymentMethod` | `boolean` | Whether a payment method is required for this checkout. |
| `pathRoot` | `string` | The root path of the resource. |
| `payer` | [`BillingPayerResource`](/docs/reference/javascript/types/billing-payer-resource) | The payer associated with the checkout. |
| `paymentMethod?` | [`BillingPaymentMethodResource`](/docs/reference/javascript/types/billing-payment-method-resource) | The payment method being used for the checkout, such as a credit card or bank account. |
diff --git a/clerk-typedoc/types/billing-payer-methods.mdx b/clerk-typedoc/types/billing-payer-methods.mdx
index 3222a1b37c..8e347196ab 100644
--- a/clerk-typedoc/types/billing-payer-methods.mdx
+++ b/clerk-typedoc/types/billing-payer-methods.mdx
@@ -1,7 +1,7 @@
## Properties
-| Property | Type |
-| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `addPaymentMethod` | (params: [AddPaymentMethodParams](add-payment-method-params.mdx)) => Promise\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\> |
-| `getPaymentMethods` | (params: [GetPaymentMethodsParams](get-payment-methods-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\>\> |
-| `initializePaymentMethod` | (params: [InitializePaymentMethodParams](initialize-payment-method-params.mdx)) => Promise\<[BillingInitializedPaymentMethodResource](billing-initialized-payment-method-resource.mdx)\> |
+| Property | Type |
+| -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `addPaymentMethod` | (params: [AddPaymentMethodParams](add-payment-method-params.mdx)) => Promise\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\> |
+| `getPaymentMethods` | (params?: [GetPaymentMethodsParams](get-payment-methods-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\>\> |
+| `initializePaymentMethod` | (params: [InitializePaymentMethodParams](initialize-payment-method-params.mdx)) => Promise\<[BillingInitializedPaymentMethodResource](billing-initialized-payment-method-resource.mdx)\> |
diff --git a/clerk-typedoc/types/billing-subscription-item-resource.mdx b/clerk-typedoc/types/billing-subscription-item-resource.mdx
index ab0be5d63c..271787e001 100644
--- a/clerk-typedoc/types/billing-subscription-item-resource.mdx
+++ b/clerk-typedoc/types/billing-subscription-item-resource.mdx
@@ -2,21 +2,20 @@ The `BillingSubscriptionItemResource` type represents an item in a subscription.
## Properties
-| Property | Type | Description |
-| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `amount?` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The amount charged for the subscription item. |
-| `cancel` | (params: \{ orgId?: string; \}) => Promise\<[DeletedObjectResource](/docs/reference/javascript/types/deleted-object-resource)\> | A function to cancel the subscription item. Accepts the following parameters: - `orgId?` (`string`): The ID of the organization to cancel the subscription item from.
|
-| `canceledAt` | null \| Date | The date and time when the subscription item was canceled. `null` if the subscription item is not canceled. |
-| `createdAt` | `Date` | The date and time when the subscription item was created. |
-| `credit?` | \{ amount: [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount); \} | The credit from a previous purchase that is being applied to the subscription item. |
-| `credit.amount` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The amount of credit from a previous purchase that is being applied to the subscription item. |
-| `id` | `string` | The unique identifier for the subscription item. |
-| `isFreeTrial` | `boolean` | Whether the subscription item is for a free trial. |
-| `pastDueAt` | null \| Date | The date and time when the subscription item became past due. `null` if the subscription item is not past due. |
-| `pathRoot` | `string` | The root path of the resource. |
-| `paymentMethodId` | `string` | The unique identifier for the payment method being used for the subscription item. |
-| `periodEnd` | null \| Date | The date and time when the current billing period ends. `null` if not set. |
-| `periodStart` | `Date` | The date and time when the current billing period starts. |
-| `plan` | [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) | The plan associated with the subscription item. |
-| `planPeriod` | "month" \| "annual" | The billing period for the subscription item. |
-| `status` | "active" \| "ended" \| "upcoming" \| "past_due" | The status of the subscription item. |
+| Property | Type | Description |
+| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `amount?` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The amount charged for the subscription item. |
+| `cancel` | (params: \{ orgId?: string; \}) => Promise\<[DeletedObjectResource](/docs/reference/javascript/types/deleted-object-resource)\> | A function to cancel the subscription item. Accepts the following parameters: - `orgId?` (`string`): The ID of the organization to cancel the subscription item from.
|
+| `canceledAt` | null \| Date | The date and time when the subscription item was canceled. `null` if the subscription item is not canceled. |
+| `createdAt` | `Date` | The date and time when the subscription item was created. |
+| `credit?` | \{ amount: [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount); \} | The credit from a previous purchase that is being applied to the subscription item. |
+| `credit.amount` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The amount of credit from a previous purchase that is being applied to the subscription item. |
+| `id` | `string` | The unique identifier for the subscription item. |
+| `isFreeTrial` | `boolean` | Whether the subscription item is for a free trial. |
+| `pastDueAt` | null \| Date | The date and time when the subscription item became past due. `null` if the subscription item is not past due. |
+| `pathRoot` | `string` | The root path of the resource. |
+| `periodEnd` | null \| Date | The date and time when the current billing period ends. `null` if not set. |
+| `periodStart` | `Date` | The date and time when the current billing period starts. |
+| `plan` | [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) | The plan associated with the subscription item. |
+| `planPeriod` | "month" \| "annual" | The billing period for the subscription item. |
+| `status` | "active" \| "ended" \| "upcoming" \| "past_due" | The status of the subscription item. |
diff --git a/clerk-typedoc/types/confirm-checkout-params.mdx b/clerk-typedoc/types/confirm-checkout-params.mdx
index f60f169d9b..0333701da2 100644
--- a/clerk-typedoc/types/confirm-checkout-params.mdx
+++ b/clerk-typedoc/types/confirm-checkout-params.mdx
@@ -11,13 +11,13 @@ There are multiple variants of this type available which you can select by click
| Name | Type | Description |
| ------ | ------ | ------ |
-| `gateway?` | "stripe" \| "paypal" | The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. |
+| `gateway?` | `"stripe"` | The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. |
| `paymentToken?` | `string` | A token representing payment details, usually from a payment form. **Requires** `gateway` to be provided. |
| Name | Type | Description |
| ------ | ------ | ------ |
-| `gateway?` | "stripe" \| "paypal" | The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. |
+| `gateway?` | `"stripe"` | The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. |
| `useTestCard?` | `boolean` | If true, uses a test card for the checkout. **Requires** `gateway` to be provided. |
diff --git a/clerk-typedoc/types/initialize-payment-method-params.mdx b/clerk-typedoc/types/initialize-payment-method-params.mdx
index e69de29bb2..2eb26e27b4 100644
--- a/clerk-typedoc/types/initialize-payment-method-params.mdx
+++ b/clerk-typedoc/types/initialize-payment-method-params.mdx
@@ -0,0 +1,7 @@
+> **InitializePaymentMethodParams** = \{ gateway: "stripe"; \}
+
+## Properties
+
+| Property | Type | Description |
+| ------------------------------ | ---------- | --------------------------- |
+| `gateway` | `"stripe"` | The payment gateway to use. |
diff --git a/clerk-typedoc/types/organization-resource.mdx b/clerk-typedoc/types/organization-resource.mdx
index 06983d809a..b5128e2f6a 100644
--- a/clerk-typedoc/types/organization-resource.mdx
+++ b/clerk-typedoc/types/organization-resource.mdx
@@ -4,10 +4,10 @@ To use these methods, you must have the **Organizations** feature [enabled in yo
## Properties
-| Property | Type | Description |
-| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
-| `addPaymentMethod` | (params: [AddPaymentMethodParams](add-payment-method-params.mdx)) => Promise\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\> | - |
-| `getPaymentMethods` | (params: [GetPaymentMethodsParams](get-payment-methods-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\>\> | - |
-| `id` | `string` | The unique identifier of the resource. |
-| `initializePaymentMethod` | (params: [InitializePaymentMethodParams](initialize-payment-method-params.mdx)) => Promise\<[BillingInitializedPaymentMethodResource](billing-initialized-payment-method-resource.mdx)\> | - |
-| `pathRoot` | `string` | The root path of the resource. |
+| Property | Type | Description |
+| -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
+| `addPaymentMethod` | (params: [AddPaymentMethodParams](add-payment-method-params.mdx)) => Promise\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\> | - |
+| `getPaymentMethods` | (params?: [GetPaymentMethodsParams](get-payment-methods-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\>\> | - |
+| `id` | `string` | The unique identifier of the resource. |
+| `initializePaymentMethod` | (params: [InitializePaymentMethodParams](initialize-payment-method-params.mdx)) => Promise\<[BillingInitializedPaymentMethodResource](billing-initialized-payment-method-resource.mdx)\> | - |
+| `pathRoot` | `string` | The root path of the resource. |
diff --git a/clerk-typedoc/types/sign-in-future-resource.mdx b/clerk-typedoc/types/sign-in-future-resource.mdx
index b98a5fe064..a19c5433ac 100644
--- a/clerk-typedoc/types/sign-in-future-resource.mdx
+++ b/clerk-typedoc/types/sign-in-future-resource.mdx
@@ -25,6 +25,7 @@ and the creation of a new session.
| `mfa.verifyBackupCode` | (params: SignInFutureBackupCodeVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a backup code as a second factor to sign-in |
| `mfa.verifyPhoneCode` | (params: SignInFutureMFAPhoneCodeVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a phone code sent as a second factor to sign-in |
| `mfa.verifyTOTP` | (params: SignInFutureTOTPVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a TOTP code as a second factor to sign-in |
+| `passkey` | (params?: SignInFuturePasskeyParams) => Promise\<\{ error: unknown; \}\> | Initiates a passkey-based authentication flow, enabling users to authenticate using a previously registered passkey. When called without parameters, this method requires a prior call to `SignIn.create({ strategy: 'passkey' })` to initialize the sign-in context. This pattern is particularly useful in scenarios where the authentication strategy needs to be determined dynamically at runtime. |
| `password` | (params: SignInFuturePasswordParams) => Promise\<\{ error: unknown; \}\> | Used to submit a password to sign-in. |
| `phoneCode` | \{ sendCode: (params: SignInFuturePhoneCodeSendParams) => Promise\<\{ error: unknown; \}\>; verifyCode: (params: SignInFuturePhoneCodeVerifyParams) => Promise\<\{ error: unknown; \}\>; \} | - |
| `phoneCode.sendCode` | (params: SignInFuturePhoneCodeSendParams) => Promise\<\{ error: unknown; \}\> | Used to send a phone code to sign-in |
diff --git a/clerk-typedoc/types/user-resource.mdx b/clerk-typedoc/types/user-resource.mdx
index 10fe99e936..efe5b80a36 100644
--- a/clerk-typedoc/types/user-resource.mdx
+++ b/clerk-typedoc/types/user-resource.mdx
@@ -8,11 +8,11 @@ The ClerkJS SDK provides some helper [methods](#methods) on the `User` object to
## Properties
-| Property | Type | Description |
-| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
-| `addPaymentMethod` | (params: [AddPaymentMethodParams](add-payment-method-params.mdx)) => Promise\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\> | - |
-| `getPaymentMethods` | (params: [GetPaymentMethodsParams](get-payment-methods-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\>\> | - |
-| `id` | `string` | The unique identifier of the resource. |
-| `initializePaymentMethod` | (params: [InitializePaymentMethodParams](initialize-payment-method-params.mdx)) => Promise\<[BillingInitializedPaymentMethodResource](billing-initialized-payment-method-resource.mdx)\> | - |
-| `pathRoot` | `string` | The root path of the resource. |
-| ~~`samlAccounts`~~ | SamlAccountResource[] | **Deprecated.** Use `enterpriseAccounts` instead. |
+| Property | Type | Description |
+| -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
+| `addPaymentMethod` | (params: [AddPaymentMethodParams](add-payment-method-params.mdx)) => Promise\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\> | - |
+| `getPaymentMethods` | (params?: [GetPaymentMethodsParams](get-payment-methods-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\>\> | - |
+| `id` | `string` | The unique identifier of the resource. |
+| `initializePaymentMethod` | (params: [InitializePaymentMethodParams](initialize-payment-method-params.mdx)) => Promise\<[BillingInitializedPaymentMethodResource](billing-initialized-payment-method-resource.mdx)\> | - |
+| `pathRoot` | `string` | The root path of the resource. |
+| ~~`samlAccounts`~~ | SamlAccountResource[] | **Deprecated.** Use `enterpriseAccounts` instead. |