Mayson Monorepo Documentation
    Preparing search index...

    Interface StripeConfig

    interface StripeConfig {
        apiVersion?: "2026-01-28.clover";
        typescript?: true;
        maxNetworkRetries?: number;
        httpAgent?: Agent;
        httpClient?: HttpClient;
        timeout?: number;
        host?: string;
        port?: string | number;
        protocol?: HttpProtocol;
        telemetry?: boolean;
        appInfo?: AppInfo;
        stripeAccount?: string;
        stripeContext?: string | StripeContext;
    }
    Index

    Properties

    apiVersion? typescript? maxNetworkRetries? httpAgent? httpClient? timeout? host? port? protocol? telemetry? appInfo? stripeAccount? stripeContext?

    Properties

    apiVersion?: "2026-01-28.clover"

    This library's types only reflect the latest API version.

    We recommend upgrading your account's API Version to the latest version if you wish to use TypeScript with this library.

    If you wish to remain on your account's default API version, you may pass null or another version instead of the latest version, and add a @ts-ignore comment here and anywhere the types differ between API versions.

    https://stripe.com/docs/api/versioning

    typescript?: true

    Optionally indicate that you are using TypeScript. This currently has no runtime effect other than adding "TypeScript" to your user-agent.

    maxNetworkRetries?: number

    Specifies maximum number of automatic network retries (default 1). Retries will be attempted with exponential backoff. Retries can be disabled by setting this option to 0. Idempotency keys are added where appropriate to prevent duplication.

    https://github.com/stripe/stripe-node#network-retries

    httpAgent?: Agent

    Use a custom http(s) agent. Useful for making requests through a proxy.

    httpClient?: HttpClient

    Use a custom http client, rather than relying on Node libraries. Useful for making requests in contexts other than NodeJS (eg. using fetch).

    timeout?: number

    Request timeout in milliseconds. The default is 80000

    host?: string

    Specify the host to use for API Requests.

    port?: string | number

    Specify the port to use for API Requests.

    protocol?: HttpProtocol

    Specify the HTTP protool to use for API Requests.

    telemetry?: boolean

    Pass telemetry: false to disable headers that provide Stripe with data about usage of the API. Currently, the only telemetry we send is latency metrics.

    appInfo?: AppInfo

    For plugin authors to identify their code.

    https://stripe.com/docs/building-plugins?lang=node#setappinfo

    stripeAccount?: string

    An account id on whose behalf you wish to make every request. Prefer stripeContext for new code.

    stripeContext?: string | StripeContext

    An account on whose behalf you wish to make every request. See https://docs.corp.stripe.com/context for more information.

    Settings

    Member Visibility

    On This Page

    Properties