stripe
Version:
Stripe API wrapper
562 lines (550 loc) • 26.3 kB
TypeScript
///<reference path='./lib.d.ts' />
///<reference path='./crypto/crypto.d.ts' />
///<reference path='./net/net.d.ts' />
///<reference path='./shared.d.ts' />
///<reference path='./Errors.d.ts' />
///<reference path='./OAuth.d.ts' />
///<reference path='./Webhooks.d.ts' />
///<reference path='./EventTypes.d.ts' />
///<reference path='./UpcomingInvoices.d.ts' />
///<reference path='./ThinEvent.d.ts' />
///<reference path='./crypto/crypto.d.ts' />
// Imports: The beginning of the section generated from our OpenAPI spec
///<reference path='./AccountLinksResource.d.ts' />
///<reference path='./AccountSessionsResource.d.ts' />
///<reference path='./AccountsResource.d.ts' />
///<reference path='./ApplePayDomainsResource.d.ts' />
///<reference path='./ApplicationFeesResource.d.ts' />
///<reference path='./Apps/SecretsResource.d.ts' />
///<reference path='./BalanceResource.d.ts' />
///<reference path='./BalanceTransactionsResource.d.ts' />
///<reference path='./Billing/AlertsResource.d.ts' />
///<reference path='./Billing/CreditBalanceSummaryResource.d.ts' />
///<reference path='./Billing/CreditBalanceTransactionsResource.d.ts' />
///<reference path='./Billing/CreditGrantsResource.d.ts' />
///<reference path='./Billing/MeterEventAdjustmentsResource.d.ts' />
///<reference path='./Billing/MeterEventsResource.d.ts' />
///<reference path='./Billing/MetersResource.d.ts' />
///<reference path='./BillingPortal/ConfigurationsResource.d.ts' />
///<reference path='./BillingPortal/SessionsResource.d.ts' />
///<reference path='./ChargesResource.d.ts' />
///<reference path='./Checkout/SessionsResource.d.ts' />
///<reference path='./Climate/OrdersResource.d.ts' />
///<reference path='./Climate/ProductsResource.d.ts' />
///<reference path='./Climate/SuppliersResource.d.ts' />
///<reference path='./ConfirmationTokensResource.d.ts' />
///<reference path='./CountrySpecsResource.d.ts' />
///<reference path='./CouponsResource.d.ts' />
///<reference path='./CreditNotesResource.d.ts' />
///<reference path='./CustomerSessionsResource.d.ts' />
///<reference path='./CustomersResource.d.ts' />
///<reference path='./DisputesResource.d.ts' />
///<reference path='./Entitlements/ActiveEntitlementsResource.d.ts' />
///<reference path='./Entitlements/FeaturesResource.d.ts' />
///<reference path='./EphemeralKeysResource.d.ts' />
///<reference path='./EventsResource.d.ts' />
///<reference path='./ExchangeRatesResource.d.ts' />
///<reference path='./FileLinksResource.d.ts' />
///<reference path='./FilesResource.d.ts' />
///<reference path='./FinancialConnections/AccountsResource.d.ts' />
///<reference path='./FinancialConnections/SessionsResource.d.ts' />
///<reference path='./FinancialConnections/TransactionsResource.d.ts' />
///<reference path='./Forwarding/RequestsResource.d.ts' />
///<reference path='./Identity/VerificationReportsResource.d.ts' />
///<reference path='./Identity/VerificationSessionsResource.d.ts' />
///<reference path='./InvoiceItemsResource.d.ts' />
///<reference path='./InvoicePaymentsResource.d.ts' />
///<reference path='./InvoiceRenderingTemplatesResource.d.ts' />
///<reference path='./InvoicesResource.d.ts' />
///<reference path='./Issuing/AuthorizationsResource.d.ts' />
///<reference path='./Issuing/CardholdersResource.d.ts' />
///<reference path='./Issuing/CardsResource.d.ts' />
///<reference path='./Issuing/DisputesResource.d.ts' />
///<reference path='./Issuing/PersonalizationDesignsResource.d.ts' />
///<reference path='./Issuing/PhysicalBundlesResource.d.ts' />
///<reference path='./Issuing/TokensResource.d.ts' />
///<reference path='./Issuing/TransactionsResource.d.ts' />
///<reference path='./MandatesResource.d.ts' />
///<reference path='./PaymentIntentsResource.d.ts' />
///<reference path='./PaymentLinksResource.d.ts' />
///<reference path='./PaymentMethodConfigurationsResource.d.ts' />
///<reference path='./PaymentMethodDomainsResource.d.ts' />
///<reference path='./PaymentMethodsResource.d.ts' />
///<reference path='./PayoutsResource.d.ts' />
///<reference path='./PlansResource.d.ts' />
///<reference path='./PricesResource.d.ts' />
///<reference path='./ProductsResource.d.ts' />
///<reference path='./PromotionCodesResource.d.ts' />
///<reference path='./QuotesResource.d.ts' />
///<reference path='./Radar/EarlyFraudWarningsResource.d.ts' />
///<reference path='./Radar/ValueListItemsResource.d.ts' />
///<reference path='./Radar/ValueListsResource.d.ts' />
///<reference path='./RefundsResource.d.ts' />
///<reference path='./Reporting/ReportRunsResource.d.ts' />
///<reference path='./Reporting/ReportTypesResource.d.ts' />
///<reference path='./ReviewsResource.d.ts' />
///<reference path='./SetupAttemptsResource.d.ts' />
///<reference path='./SetupIntentsResource.d.ts' />
///<reference path='./ShippingRatesResource.d.ts' />
///<reference path='./Sigma/ScheduledQueryRunsResource.d.ts' />
///<reference path='./SourcesResource.d.ts' />
///<reference path='./SubscriptionItemsResource.d.ts' />
///<reference path='./SubscriptionSchedulesResource.d.ts' />
///<reference path='./SubscriptionsResource.d.ts' />
///<reference path='./Tax/CalculationsResource.d.ts' />
///<reference path='./Tax/RegistrationsResource.d.ts' />
///<reference path='./Tax/SettingsResource.d.ts' />
///<reference path='./Tax/TransactionsResource.d.ts' />
///<reference path='./TaxCodesResource.d.ts' />
///<reference path='./TaxIdsResource.d.ts' />
///<reference path='./TaxRatesResource.d.ts' />
///<reference path='./Terminal/ConfigurationsResource.d.ts' />
///<reference path='./Terminal/ConnectionTokensResource.d.ts' />
///<reference path='./Terminal/LocationsResource.d.ts' />
///<reference path='./Terminal/ReadersResource.d.ts' />
///<reference path='./TestHelpers/ConfirmationTokensResource.d.ts' />
///<reference path='./TestHelpers/CustomersResource.d.ts' />
///<reference path='./TestHelpers/Issuing/AuthorizationsResource.d.ts' />
///<reference path='./TestHelpers/Issuing/CardsResource.d.ts' />
///<reference path='./TestHelpers/Issuing/PersonalizationDesignsResource.d.ts' />
///<reference path='./TestHelpers/Issuing/TransactionsResource.d.ts' />
///<reference path='./TestHelpers/RefundsResource.d.ts' />
///<reference path='./TestHelpers/Terminal/ReadersResource.d.ts' />
///<reference path='./TestHelpers/TestClocksResource.d.ts' />
///<reference path='./TestHelpers/Treasury/InboundTransfersResource.d.ts' />
///<reference path='./TestHelpers/Treasury/OutboundPaymentsResource.d.ts' />
///<reference path='./TestHelpers/Treasury/OutboundTransfersResource.d.ts' />
///<reference path='./TestHelpers/Treasury/ReceivedCreditsResource.d.ts' />
///<reference path='./TestHelpers/Treasury/ReceivedDebitsResource.d.ts' />
///<reference path='./TokensResource.d.ts' />
///<reference path='./TopupsResource.d.ts' />
///<reference path='./TransfersResource.d.ts' />
///<reference path='./Treasury/CreditReversalsResource.d.ts' />
///<reference path='./Treasury/DebitReversalsResource.d.ts' />
///<reference path='./Treasury/FinancialAccountsResource.d.ts' />
///<reference path='./Treasury/InboundTransfersResource.d.ts' />
///<reference path='./Treasury/OutboundPaymentsResource.d.ts' />
///<reference path='./Treasury/OutboundTransfersResource.d.ts' />
///<reference path='./Treasury/ReceivedCreditsResource.d.ts' />
///<reference path='./Treasury/ReceivedDebitsResource.d.ts' />
///<reference path='./Treasury/TransactionEntriesResource.d.ts' />
///<reference path='./Treasury/TransactionsResource.d.ts' />
///<reference path='./V2/Billing/MeterEventAdjustmentsResource.d.ts' />
///<reference path='./V2/Billing/MeterEventSessionResource.d.ts' />
///<reference path='./V2/Billing/MeterEventStreamResource.d.ts' />
///<reference path='./V2/Billing/MeterEventsResource.d.ts' />
///<reference path='./V2/Core/EventDestinationsResource.d.ts' />
///<reference path='./V2/Core/EventsResource.d.ts' />
///<reference path='./WebhookEndpointsResource.d.ts' />
///<reference path='./AccountLinks.d.ts' />
///<reference path='./AccountSessions.d.ts' />
///<reference path='./Accounts.d.ts' />
///<reference path='./ApplePayDomains.d.ts' />
///<reference path='./ApplicationFees.d.ts' />
///<reference path='./Applications.d.ts' />
///<reference path='./Apps/Secrets.d.ts' />
///<reference path='./Balance.d.ts' />
///<reference path='./BalanceTransactionSources.d.ts' />
///<reference path='./BalanceTransactions.d.ts' />
///<reference path='./BankAccounts.d.ts' />
///<reference path='./Billing/AlertTriggereds.d.ts' />
///<reference path='./Billing/Alerts.d.ts' />
///<reference path='./Billing/CreditBalanceSummary.d.ts' />
///<reference path='./Billing/CreditBalanceTransactions.d.ts' />
///<reference path='./Billing/CreditGrants.d.ts' />
///<reference path='./Billing/MeterEventAdjustments.d.ts' />
///<reference path='./Billing/MeterEventSummaries.d.ts' />
///<reference path='./Billing/MeterEvents.d.ts' />
///<reference path='./Billing/Meters.d.ts' />
///<reference path='./BillingPortal/Configurations.d.ts' />
///<reference path='./BillingPortal/Sessions.d.ts' />
///<reference path='./Capabilities.d.ts' />
///<reference path='./Cards.d.ts' />
///<reference path='./CashBalances.d.ts' />
///<reference path='./Charges.d.ts' />
///<reference path='./Checkout/Sessions.d.ts' />
///<reference path='./Climate/Orders.d.ts' />
///<reference path='./Climate/Products.d.ts' />
///<reference path='./Climate/Suppliers.d.ts' />
///<reference path='./ConfirmationTokens.d.ts' />
///<reference path='./ConnectCollectionTransfers.d.ts' />
///<reference path='./CountrySpecs.d.ts' />
///<reference path='./Coupons.d.ts' />
///<reference path='./CreditNoteLineItems.d.ts' />
///<reference path='./CreditNotes.d.ts' />
///<reference path='./CustomerBalanceTransactions.d.ts' />
///<reference path='./CustomerCashBalanceTransactions.d.ts' />
///<reference path='./CustomerSessions.d.ts' />
///<reference path='./CustomerSources.d.ts' />
///<reference path='./Customers.d.ts' />
///<reference path='./Discounts.d.ts' />
///<reference path='./Disputes.d.ts' />
///<reference path='./Entitlements/ActiveEntitlementSummaries.d.ts' />
///<reference path='./Entitlements/ActiveEntitlements.d.ts' />
///<reference path='./Entitlements/Features.d.ts' />
///<reference path='./EphemeralKeys.d.ts' />
///<reference path='./Events.d.ts' />
///<reference path='./ExchangeRates.d.ts' />
///<reference path='./ExternalAccounts.d.ts' />
///<reference path='./FeeRefunds.d.ts' />
///<reference path='./FileLinks.d.ts' />
///<reference path='./Files.d.ts' />
///<reference path='./FinancialConnections/AccountOwners.d.ts' />
///<reference path='./FinancialConnections/AccountOwnerships.d.ts' />
///<reference path='./FinancialConnections/Accounts.d.ts' />
///<reference path='./FinancialConnections/Sessions.d.ts' />
///<reference path='./FinancialConnections/Transactions.d.ts' />
///<reference path='./Forwarding/Requests.d.ts' />
///<reference path='./FundingInstructions.d.ts' />
///<reference path='./Identity/VerificationReports.d.ts' />
///<reference path='./Identity/VerificationSessions.d.ts' />
///<reference path='./InvoiceItems.d.ts' />
///<reference path='./InvoiceLineItems.d.ts' />
///<reference path='./InvoicePayments.d.ts' />
///<reference path='./InvoiceRenderingTemplates.d.ts' />
///<reference path='./Invoices.d.ts' />
///<reference path='./Issuing/Authorizations.d.ts' />
///<reference path='./Issuing/Cardholders.d.ts' />
///<reference path='./Issuing/Cards.d.ts' />
///<reference path='./Issuing/Disputes.d.ts' />
///<reference path='./Issuing/PersonalizationDesigns.d.ts' />
///<reference path='./Issuing/PhysicalBundles.d.ts' />
///<reference path='./Issuing/Tokens.d.ts' />
///<reference path='./Issuing/Transactions.d.ts' />
///<reference path='./LineItems.d.ts' />
///<reference path='./LoginLinks.d.ts' />
///<reference path='./Mandates.d.ts' />
///<reference path='./PaymentIntents.d.ts' />
///<reference path='./PaymentLinks.d.ts' />
///<reference path='./PaymentMethodConfigurations.d.ts' />
///<reference path='./PaymentMethodDomains.d.ts' />
///<reference path='./PaymentMethods.d.ts' />
///<reference path='./Payouts.d.ts' />
///<reference path='./Persons.d.ts' />
///<reference path='./Plans.d.ts' />
///<reference path='./Prices.d.ts' />
///<reference path='./ProductFeatures.d.ts' />
///<reference path='./Products.d.ts' />
///<reference path='./PromotionCodes.d.ts' />
///<reference path='./Quotes.d.ts' />
///<reference path='./Radar/EarlyFraudWarnings.d.ts' />
///<reference path='./Radar/ValueListItems.d.ts' />
///<reference path='./Radar/ValueLists.d.ts' />
///<reference path='./Refunds.d.ts' />
///<reference path='./Reporting/ReportRuns.d.ts' />
///<reference path='./Reporting/ReportTypes.d.ts' />
///<reference path='./ReserveTransactions.d.ts' />
///<reference path='./Reviews.d.ts' />
///<reference path='./SetupAttempts.d.ts' />
///<reference path='./SetupIntents.d.ts' />
///<reference path='./ShippingRates.d.ts' />
///<reference path='./Sigma/ScheduledQueryRuns.d.ts' />
///<reference path='./SourceMandateNotifications.d.ts' />
///<reference path='./SourceTransactions.d.ts' />
///<reference path='./Sources.d.ts' />
///<reference path='./SubscriptionItems.d.ts' />
///<reference path='./SubscriptionSchedules.d.ts' />
///<reference path='./Subscriptions.d.ts' />
///<reference path='./Tax/CalculationLineItems.d.ts' />
///<reference path='./Tax/Calculations.d.ts' />
///<reference path='./Tax/Registrations.d.ts' />
///<reference path='./Tax/Settings.d.ts' />
///<reference path='./Tax/TransactionLineItems.d.ts' />
///<reference path='./Tax/Transactions.d.ts' />
///<reference path='./TaxCodes.d.ts' />
///<reference path='./TaxDeductedAtSources.d.ts' />
///<reference path='./TaxIds.d.ts' />
///<reference path='./TaxRates.d.ts' />
///<reference path='./Terminal/Configurations.d.ts' />
///<reference path='./Terminal/ConnectionTokens.d.ts' />
///<reference path='./Terminal/Locations.d.ts' />
///<reference path='./Terminal/Readers.d.ts' />
///<reference path='./TestHelpers/TestClocks.d.ts' />
///<reference path='./Tokens.d.ts' />
///<reference path='./Topups.d.ts' />
///<reference path='./TransferReversals.d.ts' />
///<reference path='./Transfers.d.ts' />
///<reference path='./Treasury/CreditReversals.d.ts' />
///<reference path='./Treasury/DebitReversals.d.ts' />
///<reference path='./Treasury/FinancialAccountFeatures.d.ts' />
///<reference path='./Treasury/FinancialAccounts.d.ts' />
///<reference path='./Treasury/InboundTransfers.d.ts' />
///<reference path='./Treasury/OutboundPayments.d.ts' />
///<reference path='./Treasury/OutboundTransfers.d.ts' />
///<reference path='./Treasury/ReceivedCredits.d.ts' />
///<reference path='./Treasury/ReceivedDebits.d.ts' />
///<reference path='./Treasury/TransactionEntries.d.ts' />
///<reference path='./Treasury/Transactions.d.ts' />
///<reference path='./V2/Billing/MeterEventAdjustments.d.ts' />
///<reference path='./V2/Billing/MeterEventSessions.d.ts' />
///<reference path='./V2/Billing/MeterEvents.d.ts' />
///<reference path='./V2/EventDestinations.d.ts' />
///<reference path='./V2/Events.d.ts' />
///<reference path='./WebhookEndpoints.d.ts' />
// Imports: The end of the section generated from our OpenAPI spec
declare module 'stripe' {
// Added to in other modules, referenced above.
export namespace Stripe {}
export class Stripe {
static Stripe: typeof Stripe;
// Actually has the signature `Stripe.Webhooks & ((platformFunctions?: PlatformFunctions) => Stripe.Webhooks)`
// However the factory function signature was never public in the typings and
// will be removed in the next major version so it is omitted
// See https://github.com/stripe/stripe-node/issues/1956
static webhooks: Stripe.Webhooks;
constructor(apiKey: string, config?: Stripe.StripeConfig);
StripeResource: Stripe.StripeResource;
// Fields: The beginning of the section generated from our OpenAPI spec
accountLinks: Stripe.AccountLinksResource;
accountSessions: Stripe.AccountSessionsResource;
accounts: Stripe.AccountsResource;
applePayDomains: Stripe.ApplePayDomainsResource;
applicationFees: Stripe.ApplicationFeesResource;
balance: Stripe.BalanceResource;
balanceTransactions: Stripe.BalanceTransactionsResource;
charges: Stripe.ChargesResource;
confirmationTokens: Stripe.ConfirmationTokensResource;
countrySpecs: Stripe.CountrySpecsResource;
coupons: Stripe.CouponsResource;
creditNotes: Stripe.CreditNotesResource;
customerSessions: Stripe.CustomerSessionsResource;
customers: Stripe.CustomersResource;
disputes: Stripe.DisputesResource;
ephemeralKeys: Stripe.EphemeralKeysResource;
events: Stripe.EventsResource;
exchangeRates: Stripe.ExchangeRatesResource;
fileLinks: Stripe.FileLinksResource;
files: Stripe.FilesResource;
invoiceItems: Stripe.InvoiceItemsResource;
invoicePayments: Stripe.InvoicePaymentsResource;
invoiceRenderingTemplates: Stripe.InvoiceRenderingTemplatesResource;
invoices: Stripe.InvoicesResource;
mandates: Stripe.MandatesResource;
paymentIntents: Stripe.PaymentIntentsResource;
paymentLinks: Stripe.PaymentLinksResource;
paymentMethodConfigurations: Stripe.PaymentMethodConfigurationsResource;
paymentMethodDomains: Stripe.PaymentMethodDomainsResource;
paymentMethods: Stripe.PaymentMethodsResource;
payouts: Stripe.PayoutsResource;
plans: Stripe.PlansResource;
prices: Stripe.PricesResource;
products: Stripe.ProductsResource;
promotionCodes: Stripe.PromotionCodesResource;
quotes: Stripe.QuotesResource;
refunds: Stripe.RefundsResource;
reviews: Stripe.ReviewsResource;
setupAttempts: Stripe.SetupAttemptsResource;
setupIntents: Stripe.SetupIntentsResource;
shippingRates: Stripe.ShippingRatesResource;
sources: Stripe.SourcesResource;
subscriptionItems: Stripe.SubscriptionItemsResource;
subscriptionSchedules: Stripe.SubscriptionSchedulesResource;
subscriptions: Stripe.SubscriptionsResource;
taxCodes: Stripe.TaxCodesResource;
taxIds: Stripe.TaxIdsResource;
taxRates: Stripe.TaxRatesResource;
tokens: Stripe.TokensResource;
topups: Stripe.TopupsResource;
transfers: Stripe.TransfersResource;
webhookEndpoints: Stripe.WebhookEndpointsResource;
apps: {
secrets: Stripe.Apps.SecretsResource;
};
billing: {
alerts: Stripe.Billing.AlertsResource;
creditBalanceSummary: Stripe.Billing.CreditBalanceSummaryResource;
creditBalanceTransactions: Stripe.Billing.CreditBalanceTransactionsResource;
creditGrants: Stripe.Billing.CreditGrantsResource;
meters: Stripe.Billing.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: Stripe.Climate.OrdersResource;
products: Stripe.Climate.ProductsResource;
suppliers: Stripe.Climate.SuppliersResource;
};
entitlements: {
activeEntitlements: Stripe.Entitlements.ActiveEntitlementsResource;
features: Stripe.Entitlements.FeaturesResource;
};
financialConnections: {
accounts: Stripe.FinancialConnections.AccountsResource;
sessions: Stripe.FinancialConnections.SessionsResource;
transactions: Stripe.FinancialConnections.TransactionsResource;
};
forwarding: {
requests: Stripe.Forwarding.RequestsResource;
};
identity: {
verificationReports: Stripe.Identity.VerificationReportsResource;
verificationSessions: Stripe.Identity.VerificationSessionsResource;
};
issuing: {
authorizations: Stripe.Issuing.AuthorizationsResource;
cards: Stripe.Issuing.CardsResource;
cardholders: Stripe.Issuing.CardholdersResource;
disputes: Stripe.Issuing.DisputesResource;
personalizationDesigns: Stripe.Issuing.PersonalizationDesignsResource;
physicalBundles: Stripe.Issuing.PhysicalBundlesResource;
tokens: Stripe.Issuing.TokensResource;
transactions: Stripe.Issuing.TransactionsResource;
};
radar: {
earlyFraudWarnings: Stripe.Radar.EarlyFraudWarningsResource;
valueLists: Stripe.Radar.ValueListsResource;
valueListItems: Stripe.Radar.ValueListItemsResource;
};
reporting: {
reportRuns: Stripe.Reporting.ReportRunsResource;
reportTypes: Stripe.Reporting.ReportTypesResource;
};
sigma: {
scheduledQueryRuns: Stripe.Sigma.ScheduledQueryRunsResource;
};
tax: {
calculations: Stripe.Tax.CalculationsResource;
registrations: Stripe.Tax.RegistrationsResource;
settings: Stripe.Tax.SettingsResource;
transactions: Stripe.Tax.TransactionsResource;
};
terminal: {
configurations: Stripe.Terminal.ConfigurationsResource;
connectionTokens: Stripe.Terminal.ConnectionTokensResource;
locations: Stripe.Terminal.LocationsResource;
readers: Stripe.Terminal.ReadersResource;
};
testHelpers: {
confirmationTokens: Stripe.TestHelpers.ConfirmationTokensResource;
customers: Stripe.TestHelpers.CustomersResource;
refunds: Stripe.TestHelpers.RefundsResource;
testClocks: Stripe.TestHelpers.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: Stripe.Treasury.CreditReversalsResource;
debitReversals: Stripe.Treasury.DebitReversalsResource;
financialAccounts: Stripe.Treasury.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: Stripe.Treasury.TransactionEntriesResource;
};
v2: {
billing: {
meterEvents: Stripe.V2.Billing.MeterEventsResource;
meterEventAdjustments: Stripe.V2.Billing.MeterEventAdjustmentsResource;
meterEventSession: Stripe.V2.Billing.MeterEventSessionResource;
meterEventStream: Stripe.V2.Billing.MeterEventStreamResource;
};
core: {
events: Stripe.V2.Core.EventsResource;
eventDestinations: Stripe.V2.Core.EventDestinationsResource;
};
};
// Fields: The end of the section generated from our OpenAPI spec
webhooks: Stripe.Webhooks;
oauth: Stripe.OAuthResource;
/**
* API Errors
*/
errors: typeof Stripe.errors;
on(event: 'request', handler: (event: Stripe.RequestEvent) => void): void;
on(event: 'response', handler: (event: Stripe.ResponseEvent) => void): void;
once(event: 'request', handler: (event: Stripe.RequestEvent) => void): void;
once(
event: 'response',
handler: (event: Stripe.ResponseEvent) => void
): void;
off(event: 'request', handler: (event: Stripe.RequestEvent) => void): void;
off(
event: 'response',
handler: (event: Stripe.ResponseEvent) => void
): 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.
*
* @param method - HTTP request method, 'GET', 'POST', or 'DELETE'
* @param path - The path of the request, e.g. '/v1/beta_endpoint'
* @param params - The parameters to include in the request body.
* @param options - Additional request options.
*/
rawRequest(
method: string,
path: string,
params?: {[key: string]: unknown},
options?: Stripe.RawRequestOptions
): Promise<Stripe.Response<unknown>>;
/**
* Parses webhook event payload into a ThinEvent and verifies webhook signature.
* To get more information on the event, pass the id from the returned object to
* `stripe.v2.core.events.retrieve()`
*
* @throws Stripe.errors.StripeSignatureVerificationError
*/
parseThinEvent: (
/**
* Raw text body payload received from Stripe.
*/
payload: string | Buffer,
/**
* 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.
*/
header: string | Buffer | Array<string>,
/**
* Your Webhook Signing Secret for this endpoint (e.g., 'whsec_...').
* You can get this [in your dashboard](https://dashboard.stripe.com/webhooks).
*/
secret: string,
/**
* Seconds of tolerance on timestamps.
*/
tolerance?: number,
/**
* Optional CryptoProvider to use for computing HMAC signatures.
*/
cryptoProvider?: Stripe.CryptoProvider,
/**
* Optional: timestamp to use when checking signature validity. Defaults to Date.now().
*/
receivedAt?: number
) => Stripe.ThinEvent;
}
export default Stripe;
}