@clerk/types/dist/index.d.ts

Typings for Clerk libraries.

import * as CSS from 'csstype';

/**
 * An interface that represents an error returned by the Clerk API.
 */
interface ClerkAPIError {
    /**
     * A string code that represents the error, such as `username_exists_code`.
     */
    code: string;
    /**
     * A message that describes the error.
     */
    message: string;
    /**
     * A more detailed message that describes the error.
     */
    longMessage?: string;
    /**
     * Additional information about the error.
     */
    meta?: {
        paramName?: string;
        sessionId?: string;
        emailAddresses?: string[];
        identifiers?: string[];
        zxcvbn?: {
            suggestions: {
                code: string;
                message: string;
            }[];
        };
        permissions?: string[];
        plan?: {
            amount_formatted: string;
            annual_monthly_amount_formatted: string;
            currency_symbol: string;
            id: string;
            name: string;
        };
        isPlanUpgradePossible?: boolean;
    };
}
interface ClerkRuntimeError {
    code: string;
    message: string;
}
/**
 * Interface representing a Clerk API Response Error.
 */
interface ClerkAPIResponseError extends Error {
    clerkError: true;
    status: number;
    message: string;
    clerkTraceId?: string;
    retryAfter?: number;
    errors: ClerkAPIError[];
}

type AlertId = 'danger' | 'warning' | 'info';
type FieldId = 'firstName' | 'lastName' | 'name' | 'slug' | 'emailAddress' | 'phoneNumber' | 'currentPassword' | 'newPassword' | 'signOutOfOtherSessions' | 'passkeyName' | 'password' | 'confirmPassword' | 'identifier' | 'username' | 'code' | 'role' | 'deleteConfirmation' | 'deleteOrganizationConfirmation' | 'enrollmentMode' | 'affiliationEmailAddress' | 'deleteExistingInvitationsSuggestions' | 'legalAccepted' | 'apiKeyDescription' | 'apiKeyExpirationDate' | 'apiKeyRevokeConfirmation';
type ProfileSectionId = 'profile' | 'username' | 'emailAddresses' | 'phoneNumbers' | 'connectedAccounts' | 'enterpriseAccounts' | 'web3Wallets' | 'password' | 'passkeys' | 'mfa' | 'danger' | 'activeDevices' | 'organizationProfile' | 'organizationDanger' | 'organizationDomains' | 'manageVerifiedDomains' | 'subscriptionsList' | 'paymentSources';
type ProfilePageId = 'account' | 'security' | 'organizationGeneral' | 'organizationMembers' | 'billing';
type UserPreviewId = 'userButton' | 'personalWorkspace';
type OrganizationPreviewId = 'organizationSwitcherTrigger' | 'organizationList' | 'organizationSwitcherListedOrganization' | 'organizationSwitcherActiveOrganization' | 'taskChooseOrganization';
type CardActionId = 'havingTrouble' | 'alternativeMethods' | 'signUp' | 'signIn' | 'usePasskey' | 'waitlist' | 'signOut';
type MenuId = 'invitation' | 'member' | ProfileSectionId;
type SelectId = 'countryCode' | 'role' | 'paymentSource' | 'apiKeyExpiration';

interface Web3ProviderData {
    provider: Web3Provider;
    strategy: Web3Strategy;
    name: string;
}
type MetamaskWeb3Provider = 'metamask';
type CoinbaseWalletWeb3Provider = 'coinbase_wallet';
type OKXWalletWeb3Provider = 'okx_wallet';
type BaseWeb3Provider = 'base';
type Web3Provider = MetamaskWeb3Provider | BaseWeb3Provider | CoinbaseWalletWeb3Provider | OKXWalletWeb3Provider;

type GoogleOneTapStrategy = 'google_one_tap';
type PasskeyStrategy = 'passkey';
type PasswordStrategy = 'password';
type PhoneCodeStrategy = 'phone_code';
type EmailCodeStrategy = 'email_code';
type EmailLinkStrategy = 'email_link';
type TicketStrategy = 'ticket';
type TOTPStrategy = 'totp';
type BackupCodeStrategy = 'backup_code';
type ResetPasswordPhoneCodeStrategy = 'reset_password_phone_code';
type ResetPasswordEmailCodeStrategy = 'reset_password_email_code';
type CustomOAuthStrategy = `oauth_custom_${string}`;
type EnterpriseSSOStrategy = 'enterprise_sso';
type OAuthStrategy = `oauth_${OAuthProvider}` | CustomOAuthStrategy;
type Web3Strategy = `web3_${Web3Provider}_signature`;
/**
 * @deprecated Use `EnterpriseSSOStrategy` instead.
 */
type SamlStrategy = 'saml';

type OAuthScope = string;
interface OAuthProviderData {
    provider: OAuthProvider;
    strategy: OAuthStrategy;
    name: string;
    docsUrl: string;
}
type FacebookOauthProvider = 'facebook';
type GoogleOauthProvider = 'google';
type HubspotOauthProvider = 'hubspot';
type GithubOauthProvider = 'github';
type TiktokOauthProvider = 'tiktok';
type GitlabOauthProvider = 'gitlab';
type DiscordOauthProvider = 'discord';
type TwitterOauthProvider = 'twitter';
type TwitchOauthProvider = 'twitch';
type LinkedinOauthProvider = 'linkedin';
type LinkedinOIDCOauthProvider = 'linkedin_oidc';
type DropboxOauthProvider = 'dropbox';
type AtlassianOauthProvider = 'atlassian';
type BitbucketOauthProvider = 'bitbucket';
type MicrosoftOauthProvider = 'microsoft';
type NotionOauthProvider = 'notion';
type AppleOauthProvider = 'apple';
type LineOauthProvider = 'line';
type InstagramOauthProvider = 'instagram';
type CoinbaseOauthProvider = 'coinbase';
type SpotifyOauthProvider = 'spotify';
type XeroOauthProvider = 'xero';
type BoxOauthProvider = 'box';
type SlackOauthProvider = 'slack';
type LinearOauthProvider = 'linear';
type XOauthProvider = 'x';
type EnstallOauthProvider = 'enstall';
type HuggingfaceOAuthProvider = 'huggingface';
type CustomOauthProvider = `custom_${string}`;
type OAuthProvider = FacebookOauthProvider | GoogleOauthProvider | HubspotOauthProvider | GithubOauthProvider | TiktokOauthProvider | GitlabOauthProvider | DiscordOauthProvider | TwitterOauthProvider | TwitchOauthProvider | LinkedinOauthProvider | LinkedinOIDCOauthProvider | DropboxOauthProvider | AtlassianOauthProvider | BitbucketOauthProvider | MicrosoftOauthProvider | NotionOauthProvider | AppleOauthProvider | LineOauthProvider | InstagramOauthProvider | CoinbaseOauthProvider | SpotifyOauthProvider | XeroOauthProvider | BoxOauthProvider | SlackOauthProvider | LinearOauthProvider | XOauthProvider | EnstallOauthProvider | HuggingfaceOAuthProvider | CustomOauthProvider;

type ClerkResourceReloadParams = {
    rotatingTokenNonce?: string;
};
/**
 * Defines common properties and methods that all Clerk resources must implement.
 */
interface ClerkResource {
    /**
     * The unique identifier of the resource.
     */
    readonly id?: string | undefined;
    /**
     * The root path of the resource.
     */
    pathRoot: string;
    /**
     * Reload the resource and return the resource itself.
     */
    reload(p?: ClerkResourceReloadParams): Promise<this>;
}

type SamlIdpSlug = 'saml_okta' | 'saml_google' | 'saml_microsoft' | 'saml_custom';
type SamlIdp = {
    name: string;
    logo: string;
};
type SamlIdpMap = Record<SamlIdpSlug, SamlIdp>;

interface DeletedObjectResource {
    object: string;
    id?: string;
    slug?: string;
    deleted: boolean;
}

/**
 * Pagination params in request
 */
type ClerkPaginationRequest<T = object> = {
    /**
     * Maximum number of items returned per request.
     */
    limit?: number;
    /**
     * This is the starting point for your fetched results.
     */
    offset?: number;
} & T;
/**
 * An interface that describes the response of a method that returns a paginated list of resources.
 *
 * > [!TIP]
 * > Clerk's SDKs always use `Promise<ClerkPaginatedResponse<T>>`. If the promise resolves, you will get back the properties. If the promise is rejected, you will receive a `ClerkAPIResponseError` or network error.
 */
interface ClerkPaginatedResponse<T> {
    /**
     * An array that contains the fetched data.
     */
    data: T[];
    /**
     * The total count of data that exist remotely.
     */
    total_count: number;
}
/**
 * @interface
 */
type ClerkPaginationParams<T = object> = {
    /**
     * A number that specifies which page to fetch. For example, if `initialPage` is set to `10`, it will skip the first 9 pages and fetch the 10th page.
     * @default 1
     */
    initialPage?: number;
    /**
     * A number that specifies the maximum number of results to return per page.
     * @default 10
     */
    pageSize?: number;
} & T;

type WithOptionalOrgType<T> = T & {
    /**
     * The organization ID to perform the request on.
     */
    orgId?: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
 * @example
 * ```tsx
 * <ClerkProvider clerkJsVersion="x.x.x" />
 * ```
 */
interface CommerceBillingNamespace {
    /**
     * @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" />
     * ```
     */
    getPaymentAttempts: (params: GetPaymentAttemptsParams) => Promise<ClerkPaginatedResponse<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" />
     * ```
     */
    getPaymentAttempt: (params: {
        id: string;
        orgId?: string;
    }) => Promise<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" />
     * ```
     */
    getPlans: (params?: GetPlansParams) => Promise<ClerkPaginatedResponse<CommercePlanResource>>;
    /**
     * @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" />
     * ```
     */
    getPlan: (params: {
        id: string;
    }) => Promise<CommercePlanResource>;
    /**
     * @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" />
     * ```
     */
    getSubscription: (params: GetSubscriptionParams) => Promise<CommerceSubscriptionResource>;
    /**
     * @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" />
     * ```
     */
    getStatements: (params: GetStatementsParams) => Promise<ClerkPaginatedResponse<CommerceStatementResource>>;
    /**
     * @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" />
     * ```
     */
    getStatement: (params: {
        id: string;
        orgId?: string;
    }) => Promise<CommerceStatementResource>;
    /**
     * @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" />
     * ```
     */
    startCheckout: (params: CreateCheckoutParams) => Promise<CommerceCheckoutResource>;
}
/**
 * @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" />
 * ```
 */
type CommercePayerResourceType = 'org' | 'user';
/**
 * @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" />
 * ```
 */
type ForPayerType = 'organization' | 'user';
/**
 * @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" />
 * ```
 */
type CommerceSubscriptionStatus = 'active' | 'ended' | 'upcoming' | 'past_due';
/**
 * The billing period for the plan.
 *
 * @inline
 */
type CommerceSubscriptionPlanPeriod = 'month' | 'annual';
/**
 * @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" />
 * ```
 */
interface CommercePaymentSourceMethods {
    /**
     * @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" />
     * ```
     */
    initializePaymentSource: (params: Exclude<InitializePaymentSourceParams, 'orgId'>) => Promise<CommerceInitializedPaymentSourceResource>;
    /**
     * @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" />
     * ```
     */
    addPaymentSource: (params: Exclude<AddPaymentSourceParams, 'orgId'>) => Promise<CommercePaymentSourceResource>;
    /**
     * @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" />
     * ```
     */
    getPaymentSources: (params: Exclude<GetPaymentSourcesParams, 'orgId'>) => Promise<ClerkPaginatedResponse<CommercePaymentSourceResource>>;
}
/**
 * @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" />
 * ```
 */
type GetPlansParams = 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.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    for?: ForPayerType;
}>;
/**
 * @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" />
 * ```
 */
interface CommercePlanResource extends ClerkResource {
    id: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    name: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    fee: CommerceMoneyAmount;
    /**
     * @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" />
     * ```
     */
    annualFee: CommerceMoneyAmount;
    /**
     * @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" />
     * ```
     */
    annualMonthlyFee: CommerceMoneyAmount;
    /**
     * @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" />
     * ```
     */
    description: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    isDefault: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    isRecurring: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    hasBaseFee: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     *
     * Specifies the subscriber type this plan is designed for.
     *
     * Each plan is exclusively created for either individual users or organizations,
     * and cannot be used interchangeably.
     */
    forPayerType: CommercePayerResourceType;
    /**
     * @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" />
     * ```
     */
    publiclyVisible: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    slug: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    avatarUrl: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    features: CommerceFeatureResource[];
    /**
     * @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" />
     * ```
     */
    freeTrialDays: number | null;
    /**
     * @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" />
     * ```
     */
    freeTrialEnabled: boolean;
}
/**
 * The `CommerceFeatureResource` type represents a feature of a subscription plan.
 *
 * @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 to avoid breaking changes.
 */
interface CommerceFeatureResource extends ClerkResource {
    /**
     * The unique identifier for the feature.
     */
    id: string;
    /**
     * The display name of the feature.
     */
    name: string;
    /**
     * A short description of what the feature provides.
     */
    description: string;
    /**
     * A unique, URL-friendly identifier for the feature.
     */
    slug: string;
    /**
     * The URL of the feature's avatar image.
     */
    avatarUrl: string;
    /**
     * @hidden
     */
    __internal_toSnapshot: () => CommerceFeatureJSONSnapshot;
}
/**
 * The status of a payment source.
 * @inline
 */
type CommercePaymentSourceStatus = '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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
 * @example
 * ```tsx
 * <ClerkProvider clerkJsVersion="x.x.x" />
 * ```
 */
type GetPaymentSourcesParams = 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.
 * @example
 * ```tsx
 * <ClerkProvider clerkJsVersion="x.x.x" />
 * ```
 */
type PaymentGateway = 'stripe' | 'paypal';
/**
 * @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" />
 * ```
 */
type InitializePaymentSourceParams = WithOptionalOrgType<{
    /**
     * @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" />
     * ```
     */
    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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
 * @example
 * ```tsx
 * <ClerkProvider clerkJsVersion="x.x.x" />
 * ```
 */
type AddPaymentSourceParams = WithOptionalOrgType<{
    /**
     * @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" />
     * ```
     */
    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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
 * @example
 * ```tsx
 * <ClerkProvider clerkJsVersion="x.x.x" />
 * ```
 */
type RemovePaymentSourceParams = WithOptionalOrgType<unknown>;
/**
 * @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" />
 * ```
 */
type MakeDefaultPaymentSourceParams = WithOptionalOrgType<unknown>;
/**
 * The `CommercePaymentSourceResource` type represents a payment source for a checkout session.
 *
 * @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 avoid breaking changes.
 */
interface CommercePaymentSourceResource extends ClerkResource {
    /**
     * The unique identifier for the payment method.
     */
    id: string;
    /**
     * The last four digits of the payment method.
     */
    last4: string;
    /**
     * The type of payment method. For example, `'card'` or `'bank_account'`.
     */
    paymentMethod: string;
    /**
     * The brand or type of card. For example, `'visa'` or `'mastercard'`.
     */
    cardType: string;
    /**
     * Whether the payment method is set as the default for the account.
     */
    isDefault: boolean;
    /**
     * Whether the payment method can be removed by the user.
     */
    isRemovable: boolean;
    /**
     * The current status of the payment method.
     */
    status: CommercePaymentSourceStatus;
    /**
     * The type of digital wallet, if applicable. For example, `'apple_pay'`, or `'google_pay'`.
     */
    walletType: string | undefined;
    /**
     * A function that removes this payment source from the account. Accepts the following parameters:
     * - `orgId?` (`string`): The ID of the organization to remove the payment source from.
     * @param params - The parameters for the remove operation.
     * @returns A promise that resolves to a `DeletedObjectResource` object.
     */
    remove: (params?: RemovePaymentSourceParams) => Promise<DeletedObjectResource>;
    /**
     * A function that sets this payment source as the default for the account. Accepts the following parameters:
     * - `orgId?` (`string`): The ID of the organization to set as the default.
     * @param params - The parameters for the make default operation.
     * @returns A promise that resolves to `null`.
     */
    makeDefault: (params?: MakeDefaultPaymentSourceParams) => Promise<null>;
}
/**
 * @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" />
 * ```
 */
interface CommerceInitializedPaymentSourceResource extends ClerkResource {
    /**
     * @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" />
     * ```
     */
    externalClientSecret: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    externalGatewayId: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    paymentMethodOrder: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
 * @example
 * ```tsx
 * <ClerkProvider clerkJsVersion="x.x.x" />
 * ```
 */
type CommercePaymentChargeType = 'checkout' | 'recurring';
/**
 * @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" />
 * ```
 */
type CommercePaymentStatus = 'pending' | 'paid' | 'failed';
/**
 * @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" />
 * ```
 */
interface CommercePaymentResource extends ClerkResource {
    id: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    amount: CommerceMoneyAmount;
    /**
     * @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" />
     * ```
     */
    paidAt?: Date;
    /**
     * @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" />
     * ```
     */
    failedAt?: Date;
    /**
     * @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" />
     * ```
     */
    updatedAt: Date;
    /**
     * @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" />
     * ```
     */
    paymentSource: CommercePaymentSourceResource;
    /**
     * @deprecated Use `subscriptionItem` instead.
     * @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" />
     * ```
     */
    subscription: 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.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    subscriptionItem: 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.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    chargeType: CommercePaymentChargeType;
    /**
     * @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" />
     * ```
     */
    status: CommercePaymentStatus;
}
/**
 * @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" />
 * ```
 */
type GetPaymentAttemptsParams = 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.
 * @example
 * ```tsx
 * <ClerkProvider clerkJsVersion="x.x.x" />
 * ```
 */
type GetStatementsParams = 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.
 * @example
 * ```tsx
 * <ClerkProvider clerkJsVersion="x.x.x" />
 * ```
 */
type CommerceStatementStatus = 'open' | 'closed';
/**
 * @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" />
 * ```
 */
interface CommerceStatementResource extends ClerkResource {
    id: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    totals: CommerceStatementTotals;
    /**
     * @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" />
     * ```
     */
    status: CommerceStatementStatus;
    /**
     * @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" />
     * ```
     */
    timestamp: Date;
    /**
     * @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" />
     * ```
     */
    groups: CommerceStatementGroup[];
}
/**
 * The `CommerceStatementGroup` type represents a group of payment items within a statement.
 *
 * @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 avoid breaking changes.
 */
interface CommerceStatementGroup {
    /**
     * The date and time when this group of payment items was created or last updated.
     */
    timestamp: Date;
    /**
     * An array of payment resources that belong to this group.
     */
    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" />
 * ```
 */
type GetSubscriptionParams = {
    orgId?: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
 * @example
 * ```tsx
 * <ClerkProvider clerkJsVersion="x.x.x" />
 * ```
 */
type CancelSubscriptionParams = WithOptionalOrgType<unknown>;
/**
 * @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" />
 * ```
 */
interface CommerceSubscriptionItemResource extends ClerkResource {
    id: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    paymentSourceId: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    plan: CommercePlanResource;
    /**
     * @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" />
     * ```
     */
    planPeriod: CommerceSubscriptionPlanPeriod;
    /**
     * @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" />
     * ```
     */
    status: CommerceSubscriptionStatus;
    /**
     * @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" />
     * ```
     */
    createdAt: Date;
    /**
     * @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" />
     * ```
     */
    pastDueAt: Date | null;
    /**
     * @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" />
     * ```
     */
    periodStart: Date;
    /**
     * @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" />
     * ```
     */
    periodEnd: Date | null;
    /**
     * @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" />
     * ```
     */
    canceledAt: Date | null;
    /**
     * @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" />
     * ```
     */
    amount?: CommerceMoneyAmount;
    /**
     * @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" />
     * ```
     */
    credit?: {
        /**
         * @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" />
         * ```
         */
        amount: CommerceMoneyAmount;
    };
    /**
     * @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" />
     * ```
     */
    cancel: (params: CancelSubscriptionParams) => Promise<DeletedObjectResource>;
    /**
     * @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" />
     * ```
     */
    isFreeTrial: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
 * @example
 * ```tsx
 * <ClerkProvider clerkJsVersion="x.x.x" />
 * ```
 */
interface CommerceSubscriptionResource extends ClerkResource {
    /**
     * @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" />
     * ```
     */
    id: 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 the SDK version and the clerk-js version to a specific version to avoid breaking changes.
     * @example
     * ```tsx
     * <ClerkProvider clerkJsVersion="x.x.x" />
     * ```
     */
    activeAt: Date;
    /**
     * @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" />
     * ```
     */
    createdAt: Date;
    /**
     * @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" />
     * ```
     */
    nextPayment: {
        /**
         * @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" />
         * ```
         */
        amount: CommerceMoneyAmount;
        /**
         * @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" />
         * ```
         */
        date: Date;
    } | null;
    /**
     * @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.