Mayson Monorepo Documentation
    Preparing search index...

    Interface RequestOptions

    interface RequestOptions {
        apiKey?: string;
        idempotencyKey?: string;
        stripeAccount?: string;
        stripeContext?: string | StripeContext;
        apiVersion?: string;
        maxNetworkRetries?: number;
        timeout?: number;
        host?: string;
    }
    Index

    Properties

    apiKey? idempotencyKey? stripeAccount? stripeContext? apiVersion? maxNetworkRetries? timeout? host?

    Properties

    apiKey?: string

    Use a specific API Key for this request. For Connect, we recommend using stripeAccount instead.

    idempotencyKey?: string

    See the idempotency key docs.

    stripeAccount?: string

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

    stripeContext?: string | StripeContext

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

    apiVersion?: string

    The API Version to use for a given request (e.g., '2020-03-02').

    maxNetworkRetries?: number

    Specify the number of requests to retry in event of error. This overrides a default set on the Stripe object's config argument.

    timeout?: number

    Specify a timeout for this request in milliseconds.

    host?: string

    Specify the host for this request.

    Settings

    Member Visibility

    On This Page

    Properties