Mayson Monorepo Documentation
    Preparing search index...

    Class Stripe

    Index

    Constructors

    constructor

    Properties

    Stripe webhooks StripeResource accountLinks accountSessions accounts applePayDomains applicationFees balance balanceSettings balanceTransactions charges confirmationTokens countrySpecs coupons creditNotes customerSessions customers disputes ephemeralKeys events exchangeRates fileLinks files invoiceItems invoicePayments invoiceRenderingTemplates invoices mandates paymentAttemptRecords paymentIntents paymentLinks paymentMethodConfigurations paymentMethodDomains paymentMethods paymentRecords payouts plans prices products promotionCodes quotes refunds reviews setupAttempts setupIntents shippingRates sources subscriptionItems subscriptionSchedules subscriptions taxCodes taxIds taxRates tokens topups transfers webhookEndpoints apps billing billingPortal checkout climate entitlements financialConnections forwarding identity issuing radar reporting sigma tax terminal testHelpers treasury v2 webhooks oauth errors parseEventNotification

    Methods

    on once off rawRequest

    Constructors

    Properties

    Stripe: typeof Stripe
    webhooks: Webhooks
    StripeResource: StripeResource
    accountLinks: Stripe.AccountLinksResource
    accountSessions: AccountSessionsResource
    accounts: Stripe.AccountsResource
    applePayDomains: ApplePayDomainsResource
    applicationFees: ApplicationFeesResource
    balance: BalanceResource
    balanceSettings: BalanceSettingsResource
    balanceTransactions: BalanceTransactionsResource
    charges: ChargesResource
    confirmationTokens: Stripe.ConfirmationTokensResource
    countrySpecs: CountrySpecsResource
    coupons: CouponsResource
    creditNotes: CreditNotesResource
    customerSessions: CustomerSessionsResource
    customers: Stripe.CustomersResource
    disputes: Stripe.DisputesResource
    ephemeralKeys: EphemeralKeysResource
    events: Stripe.EventsResource
    exchangeRates: ExchangeRatesResource
    fileLinks: FileLinksResource
    files: FilesResource
    invoiceItems: InvoiceItemsResource
    invoicePayments: InvoicePaymentsResource
    invoiceRenderingTemplates: InvoiceRenderingTemplatesResource
    invoices: InvoicesResource
    mandates: MandatesResource
    paymentAttemptRecords: PaymentAttemptRecordsResource
    paymentIntents: PaymentIntentsResource
    paymentLinks: PaymentLinksResource
    paymentMethodConfigurations: PaymentMethodConfigurationsResource
    paymentMethodDomains: PaymentMethodDomainsResource
    paymentMethods: PaymentMethodsResource
    paymentRecords: PaymentRecordsResource
    payouts: PayoutsResource
    plans: PlansResource
    prices: PricesResource
    products: Stripe.ProductsResource
    promotionCodes: PromotionCodesResource
    quotes: QuotesResource
    refunds: Stripe.RefundsResource
    reviews: ReviewsResource
    setupAttempts: SetupAttemptsResource
    setupIntents: SetupIntentsResource
    shippingRates: ShippingRatesResource
    sources: SourcesResource
    subscriptionItems: SubscriptionItemsResource
    subscriptionSchedules: SubscriptionSchedulesResource
    subscriptions: SubscriptionsResource
    taxCodes: TaxCodesResource
    taxIds: TaxIdsResource
    taxRates: TaxRatesResource
    tokens: Stripe.TokensResource
    topups: TopupsResource
    transfers: TransfersResource
    webhookEndpoints: WebhookEndpointsResource
    apps: { secrets: SecretsResource }
    billing: {
        alerts: AlertsResource;
        creditBalanceSummary: CreditBalanceSummaryResource;
        creditBalanceTransactions: CreditBalanceTransactionsResource;
        creditGrants: CreditGrantsResource;
        meters: MetersResource;
        meterEvents: Stripe.Billing.MeterEventsResource;
        meterEventAdjustments: Stripe.Billing.MeterEventAdjustmentsResource;
    }
    billingPortal: {
        configurations: Stripe.BillingPortal.ConfigurationsResource;
        sessions: Stripe.BillingPortal.SessionsResource;
    }
    checkout: { sessions: Stripe.Checkout.SessionsResource }
    climate: {
        orders: OrdersResource;
        products: Stripe.Climate.ProductsResource;
        suppliers: SuppliersResource;
    }
    entitlements: {
        activeEntitlements: ActiveEntitlementsResource;
        features: FeaturesResource;
    }
    financialConnections: {
        accounts: Stripe.FinancialConnections.AccountsResource;
        sessions: Stripe.FinancialConnections.SessionsResource;
        transactions: Stripe.FinancialConnections.TransactionsResource;
    }
    forwarding: { requests: RequestsResource }
    identity: {
        verificationReports: VerificationReportsResource;
        verificationSessions: VerificationSessionsResource;
    }
    issuing: {
        authorizations: Stripe.Issuing.AuthorizationsResource;
        cards: Stripe.Issuing.CardsResource;
        cardholders: CardholdersResource;
        disputes: Stripe.Issuing.DisputesResource;
        personalizationDesigns: Stripe.Issuing.PersonalizationDesignsResource;
        physicalBundles: PhysicalBundlesResource;
        tokens: Stripe.Issuing.TokensResource;
        transactions: Stripe.Issuing.TransactionsResource;
    }
    radar: {
        earlyFraudWarnings: EarlyFraudWarningsResource;
        paymentEvaluations: PaymentEvaluationsResource;
        valueLists: ValueListsResource;
        valueListItems: ValueListItemsResource;
    }
    reporting: { reportRuns: ReportRunsResource; reportTypes: ReportTypesResource }
    sigma: { scheduledQueryRuns: ScheduledQueryRunsResource }
    tax: {
        associations: AssociationsResource;
        calculations: CalculationsResource;
        registrations: RegistrationsResource;
        settings: SettingsResource;
        transactions: Stripe.Tax.TransactionsResource;
    }
    terminal: {
        configurations: Stripe.Terminal.ConfigurationsResource;
        connectionTokens: ConnectionTokensResource;
        locations: LocationsResource;
        onboardingLinks: OnboardingLinksResource;
        readers: Stripe.Terminal.ReadersResource;
    }
    testHelpers: {
        confirmationTokens: Stripe.TestHelpers.ConfirmationTokensResource;
        customers: Stripe.TestHelpers.CustomersResource;
        refunds: Stripe.TestHelpers.RefundsResource;
        testClocks: TestClocksResource;
        issuing: {
            authorizations: Stripe.TestHelpers.Issuing.AuthorizationsResource;
            cards: Stripe.TestHelpers.Issuing.CardsResource;
            personalizationDesigns: Stripe.TestHelpers.Issuing.PersonalizationDesignsResource;
            transactions: Stripe.TestHelpers.Issuing.TransactionsResource;
        };
        terminal: { readers: Stripe.TestHelpers.Terminal.ReadersResource };
        treasury: {
            inboundTransfers: Stripe.TestHelpers.Treasury.InboundTransfersResource;
            outboundPayments: Stripe.TestHelpers.Treasury.OutboundPaymentsResource;
            outboundTransfers: Stripe.TestHelpers.Treasury.OutboundTransfersResource;
            receivedCredits: Stripe.TestHelpers.Treasury.ReceivedCreditsResource;
            receivedDebits: Stripe.TestHelpers.Treasury.ReceivedDebitsResource;
        };
    }
    treasury: {
        creditReversals: CreditReversalsResource;
        debitReversals: DebitReversalsResource;
        financialAccounts: FinancialAccountsResource;
        inboundTransfers: Stripe.Treasury.InboundTransfersResource;
        outboundPayments: Stripe.Treasury.OutboundPaymentsResource;
        outboundTransfers: Stripe.Treasury.OutboundTransfersResource;
        receivedCredits: Stripe.Treasury.ReceivedCreditsResource;
        receivedDebits: Stripe.Treasury.ReceivedDebitsResource;
        transactions: Stripe.Treasury.TransactionsResource;
        transactionEntries: TransactionEntriesResource;
    }
    v2: {
        billing: {
            meterEvents: Stripe.V2.Billing.MeterEventsResource;
            meterEventAdjustments: Stripe.V2.Billing.MeterEventAdjustmentsResource;
            meterEventSession: MeterEventSessionResource;
            meterEventStream: MeterEventStreamResource;
        };
        core: {
            accounts: Stripe.V2.Core.AccountsResource;
            accountLinks: Stripe.V2.Core.AccountLinksResource;
            accountTokens: AccountTokensResource;
            events: Stripe.V2.Core.EventsResource;
            eventDestinations: EventDestinationsResource;
        };
    }
    webhooks: Webhooks
    oauth: OAuthResource
    errors: typeof errors

    API Errors

    parseEventNotification: (
        payload: string | Buffer<ArrayBufferLike>,
        header: string | string[] | Buffer<ArrayBufferLike>,
        secret: string,
        tolerance?: number,
        cryptoProvider?: CryptoProvider,
        receivedAt?: number,
    ) => EventNotification

    Parses webhook event payload into a EventNotification and verifies webhook signature. To get more information on the event, call .fetchEvent(). You can also cast to a Stripe.V2.UnknownEventNotification to represent event notifications we don't have types for. It's not included in the return type of this function because it breaks narrowing.

    Type Declaration

      • (
            payload: string | Buffer<ArrayBufferLike>,
            header: string | string[] | Buffer<ArrayBufferLike>,
            secret: string,
            tolerance?: number,
            cryptoProvider?: CryptoProvider,
            receivedAt?: number,
        ): EventNotification

      • Parameters

        • payload: string | Buffer<ArrayBufferLike>

          Raw text body payload received from Stripe.

        • header: string | string[] | Buffer<ArrayBufferLike>

          Value of the stripe-signature header from Stripe. Typically a string.

          Note that this is typed to accept an array of strings so that it works seamlessly with express's types, but will throw if an array is passed in practice since express should never return this header as an array, only a string.

        • secret: string

          Your Webhook Signing Secret for this endpoint (e.g., 'whsec_...'). You can get this in your dashboard.

        • Optionaltolerance: number

          Seconds of tolerance on timestamps.

        • OptionalcryptoProvider: CryptoProvider

          Optional CryptoProvider to use for computing HMAC signatures.

        • OptionalreceivedAt: number

          Optional: timestamp to use when checking signature validity. Defaults to Date.now().

        Returns EventNotification

    Stripe.errors.StripeSignatureVerificationError

    Methods

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Allows for sending "raw" requests to the Stripe API, which can be used for testing new API endpoints or performing requests that the library does not support yet.

      This is an experimental interface and is not yet stable.

      Parameters

      • method: string

        HTTP request method, 'GET', 'POST', or 'DELETE'

      • path: string

        The path of the request, e.g. '/v1/beta_endpoint'

      • Optionalparams: { [key: string]: unknown }

        The parameters to include in the request body.

      • Optionaloptions: RawRequestOptions

        Additional request options.

      Returns Promise<
          {
              lastResponse: {
                  headers: { [key: string]: string };
                  requestId: string;
                  statusCode: number;
                  apiVersion?: string;
                  idempotencyKey?: string;
                  stripeAccount?: string;
              };
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    StripewebhooksStripeResourceaccountLinksaccountSessionsaccountsapplePayDomainsapplicationFeesbalancebalanceSettingsbalanceTransactionschargesconfirmationTokenscountrySpecscouponscreditNotescustomerSessionscustomersdisputesephemeralKeyseventsexchangeRatesfileLinksfilesinvoiceItemsinvoicePaymentsinvoiceRenderingTemplatesinvoicesmandatespaymentAttemptRecordspaymentIntentspaymentLinkspaymentMethodConfigurationspaymentMethodDomainspaymentMethodspaymentRecordspayoutsplanspricesproductspromotionCodesquotesrefundsreviewssetupAttemptssetupIntentsshippingRatessourcessubscriptionItemssubscriptionSchedulessubscriptionstaxCodestaxIdstaxRatestokenstopupstransferswebhookEndpointsappsbillingbillingPortalcheckoutclimateentitlementsfinancialConnectionsforwardingidentityissuingradarreportingsigmataxterminaltestHelperstreasuryv2webhooksoautherrorsparseEventNotification
    Methods