stripe 22.2.0 → 22.3.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1753 -76
- package/README.md +57 -65
- package/VERSION +1 -1
- package/cjs/Error.d.ts +50 -0
- package/cjs/Error.js +125 -1
- package/cjs/Error.js.map +1 -1
- package/cjs/RequestSender.d.ts +0 -1
- package/cjs/RequestSender.js +0 -8
- package/cjs/RequestSender.js.map +1 -1
- package/cjs/StripeEventNotificationHandler.d.ts +19 -0
- package/cjs/StripeEventNotificationHandler.js +148 -0
- package/cjs/StripeEventNotificationHandler.js.map +1 -0
- package/cjs/Types.d.ts +4 -2
- package/cjs/Types.js.map +1 -1
- package/cjs/apiVersion.d.ts +1 -2
- package/cjs/apiVersion.js +2 -3
- package/cjs/apiVersion.js.map +1 -1
- package/cjs/resources/AccountLinks.d.ts +1 -1
- package/cjs/resources/AccountNotices.d.ts +140 -0
- package/cjs/resources/AccountNotices.js +29 -0
- package/cjs/resources/AccountNotices.js.map +1 -0
- package/cjs/resources/AccountSessions.d.ts +262 -0
- package/cjs/resources/AccountSessions.js.map +1 -1
- package/cjs/resources/Accounts.d.ts +827 -3
- package/cjs/resources/Accounts.js +14 -0
- package/cjs/resources/Accounts.js.map +1 -1
- package/cjs/resources/Balance.d.ts +67 -0
- package/cjs/resources/BankAccounts.d.ts +2 -2
- package/cjs/resources/Billing/AlertTriggereds.d.ts +2 -1
- package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +84 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js +15 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js.map +1 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +32 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js +4 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
- package/cjs/resources/Billing/Analytics/index.d.ts +15 -0
- package/cjs/resources/Billing/Analytics/index.js +13 -0
- package/cjs/resources/Billing/Analytics/index.js.map +1 -0
- package/cjs/resources/Billing/index.d.ts +3 -0
- package/cjs/resources/Billing/index.js +2 -0
- package/cjs/resources/Billing/index.js.map +1 -1
- package/cjs/resources/Capabilities.d.ts +2 -2
- package/cjs/resources/Capital/FinancingOffers.d.ts +191 -0
- package/cjs/resources/Capital/FinancingOffers.js +30 -0
- package/cjs/resources/Capital/FinancingOffers.js.map +1 -0
- package/cjs/resources/Capital/FinancingSummary.d.ts +98 -0
- package/cjs/resources/Capital/FinancingSummary.js +15 -0
- package/cjs/resources/Capital/FinancingSummary.js.map +1 -0
- package/cjs/resources/Capital/FinancingTransactions.d.ts +143 -0
- package/cjs/resources/Capital/FinancingTransactions.js +24 -0
- package/cjs/resources/Capital/FinancingTransactions.js.map +1 -0
- package/cjs/resources/Capital/index.d.ts +25 -0
- package/cjs/resources/Capital/index.js +17 -0
- package/cjs/resources/Capital/index.js.map +1 -0
- package/cjs/resources/Cards.d.ts +4 -0
- package/cjs/resources/Charges.d.ts +3064 -70
- package/cjs/resources/Checkout/Sessions.d.ts +390 -4
- package/cjs/resources/ConfirmationTokens.d.ts +67 -1
- package/cjs/resources/Coupons.d.ts +53 -0
- package/cjs/resources/Coupons.js +13 -0
- package/cjs/resources/Coupons.js.map +1 -1
- package/cjs/resources/CreditNoteLineItems.d.ts +15 -1
- package/cjs/resources/CreditNotes.d.ts +1 -1
- package/cjs/resources/CustomerSessions.d.ts +68 -0
- package/cjs/resources/Customers.d.ts +7 -1
- package/cjs/resources/Customers.js +14 -0
- package/cjs/resources/Customers.js.map +1 -1
- package/cjs/resources/Disputes.d.ts +29 -0
- package/cjs/resources/Events.d.ts +547 -2
- package/cjs/resources/ExternalAccounts.d.ts +212 -1
- package/cjs/resources/ExternalAccounts.js +44 -0
- package/cjs/resources/ExternalAccounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js +4 -0
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
- package/cjs/resources/FinancialConnections/Accounts.d.ts +74 -4
- package/cjs/resources/FinancialConnections/Accounts.js +8 -0
- package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/Authorizations.d.ts +87 -0
- package/cjs/resources/FinancialConnections/Authorizations.js +15 -0
- package/cjs/resources/FinancialConnections/Authorizations.js.map +1 -0
- package/cjs/resources/FinancialConnections/Institutions.d.ts +101 -0
- package/cjs/resources/FinancialConnections/Institutions.js +23 -0
- package/cjs/resources/FinancialConnections/Institutions.js.map +1 -0
- package/cjs/resources/FinancialConnections/Sessions.d.ts +155 -7
- package/cjs/resources/FinancialConnections/index.d.ts +21 -6
- package/cjs/resources/FinancialConnections/index.js +4 -0
- package/cjs/resources/FinancialConnections/index.js.map +1 -1
- package/cjs/resources/FxQuotes.d.ts +212 -0
- package/cjs/resources/FxQuotes.js +29 -0
- package/cjs/resources/FxQuotes.js.map +1 -0
- package/cjs/resources/InvoiceItems.d.ts +85 -0
- package/cjs/resources/InvoiceItems.js.map +1 -1
- package/cjs/resources/InvoiceLineItems.d.ts +40 -2
- package/cjs/resources/Invoices.d.ts +1337 -19
- package/cjs/resources/Invoices.js +41 -0
- package/cjs/resources/Invoices.js.map +1 -1
- package/cjs/resources/Issuing/Cardholders.d.ts +2 -1
- package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +640 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +47 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +95 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +23 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +23 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
- package/cjs/resources/Issuing/Settlements.d.ts +85 -0
- package/cjs/resources/Issuing/Settlements.js +4 -0
- package/cjs/resources/Issuing/Settlements.js.map +1 -0
- package/cjs/resources/Issuing/Transactions.d.ts +9 -0
- package/cjs/resources/Issuing/Transactions.js.map +1 -1
- package/cjs/resources/Issuing/index.d.ts +47 -22
- package/cjs/resources/Issuing/index.js +6 -0
- package/cjs/resources/Issuing/index.js.map +1 -1
- package/cjs/resources/LineItems.d.ts +29 -2
- package/cjs/resources/Mandates.d.ts +33 -1
- package/cjs/resources/Mandates.js +8 -0
- package/cjs/resources/Mandates.js.map +1 -1
- package/cjs/resources/Margins.d.ts +115 -0
- package/cjs/resources/Margins.js +35 -0
- package/cjs/resources/Margins.js.map +1 -0
- package/cjs/resources/Orders.d.ts +4693 -0
- package/cjs/resources/Orders.js +457 -0
- package/cjs/resources/Orders.js.map +1 -0
- package/cjs/resources/PaymentAttemptRecords.d.ts +82 -0
- package/cjs/resources/PaymentIntents.d.ts +13239 -2321
- package/cjs/resources/PaymentIntents.js +27 -0
- package/cjs/resources/PaymentIntents.js.map +1 -1
- package/cjs/resources/PaymentLinks.d.ts +19 -3
- package/cjs/resources/PaymentMethodConfigurations.d.ts +350 -0
- package/cjs/resources/PaymentMethods.d.ts +151 -3
- package/cjs/resources/PaymentMethods.js.map +1 -1
- package/cjs/resources/PaymentRecords.d.ts +82 -0
- package/cjs/resources/Persons.d.ts +2 -2
- package/cjs/resources/Plans.d.ts +16 -0
- package/cjs/resources/Prices.d.ts +52 -0
- package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +37 -0
- package/cjs/resources/Privacy/RedactionJobValidationErrors.js +4 -0
- package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
- package/cjs/resources/Privacy/RedactionJobs.d.ts +229 -0
- package/cjs/resources/Privacy/RedactionJobs.js +73 -0
- package/cjs/resources/Privacy/RedactionJobs.js.map +1 -0
- package/cjs/resources/Privacy/index.d.ts +22 -0
- package/cjs/resources/Privacy/index.js +13 -0
- package/cjs/resources/Privacy/index.js.map +1 -0
- package/cjs/resources/ProductCatalog/TrialOffers.d.ts +127 -0
- package/cjs/resources/ProductCatalog/TrialOffers.js +15 -0
- package/cjs/resources/ProductCatalog/TrialOffers.js.map +1 -0
- package/cjs/resources/ProductCatalog/index.d.ts +12 -0
- package/cjs/resources/ProductCatalog/index.js +13 -0
- package/cjs/resources/ProductCatalog/index.js.map +1 -0
- package/cjs/resources/Products.d.ts +42 -0
- package/cjs/resources/PromotionCodes.d.ts +12 -0
- package/cjs/resources/PromotionCodes.js +27 -0
- package/cjs/resources/PromotionCodes.js.map +1 -1
- package/cjs/resources/QuoteLines.d.ts +507 -0
- package/cjs/resources/QuoteLines.js +4 -0
- package/cjs/resources/QuoteLines.js.map +1 -0
- package/cjs/resources/QuotePreviewInvoices.d.ts +1120 -0
- package/cjs/resources/QuotePreviewInvoices.js +4 -0
- package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +737 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js +4 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/cjs/resources/Quotes.d.ts +2266 -57
- package/cjs/resources/Quotes.js +1184 -16
- package/cjs/resources/Quotes.js.map +1 -1
- package/cjs/resources/Radar/PaymentEvaluations.d.ts +1 -1
- package/cjs/resources/Refunds.d.ts +11 -0
- package/cjs/resources/Reserve/Holds.d.ts +53 -1
- package/cjs/resources/Reserve/Holds.js +19 -0
- package/cjs/resources/Reserve/Holds.js.map +1 -1
- package/cjs/resources/Reserve/Plans.d.ts +16 -0
- package/cjs/resources/Reserve/Plans.js +11 -0
- package/cjs/resources/Reserve/Plans.js.map +1 -1
- package/cjs/resources/Reserve/Releases.d.ts +41 -1
- package/cjs/resources/Reserve/Releases.js +19 -0
- package/cjs/resources/Reserve/Releases.js.map +1 -1
- package/cjs/resources/Reserve/index.d.ts +14 -3
- package/cjs/resources/Reserve/index.js +10 -2
- package/cjs/resources/Reserve/index.js.map +1 -1
- package/cjs/resources/SetupAttempts.d.ts +26 -1
- package/cjs/resources/SetupIntents.d.ts +330 -11
- package/cjs/resources/SharedPayment/GrantedTokens.d.ts +1095 -0
- package/cjs/resources/SharedPayment/GrantedTokens.js +15 -0
- package/cjs/resources/SharedPayment/GrantedTokens.js.map +1 -0
- package/cjs/resources/SharedPayment/IssuedTokens.d.ts +308 -0
- package/cjs/resources/SharedPayment/IssuedTokens.js +27 -0
- package/cjs/resources/SharedPayment/IssuedTokens.js.map +1 -0
- package/cjs/resources/SharedPayment/index.d.ts +19 -0
- package/cjs/resources/SharedPayment/index.js +15 -0
- package/cjs/resources/SharedPayment/index.js.map +1 -0
- package/cjs/resources/Sources.d.ts +16 -1
- package/cjs/resources/SubscriptionItems.d.ts +143 -0
- package/cjs/resources/SubscriptionSchedules.d.ts +1152 -0
- package/cjs/resources/SubscriptionSchedules.js +6 -0
- package/cjs/resources/SubscriptionSchedules.js.map +1 -1
- package/cjs/resources/Subscriptions.d.ts +571 -6
- package/cjs/resources/Subscriptions.js +145 -0
- package/cjs/resources/Subscriptions.js.map +1 -1
- package/cjs/resources/Tax/CalculationLineItems.d.ts +6 -2
- package/cjs/resources/Tax/Calculations.d.ts +7 -3
- package/cjs/resources/Tax/Forms.d.ts +230 -0
- package/cjs/resources/Tax/Forms.js +32 -0
- package/cjs/resources/Tax/Forms.js.map +1 -0
- package/cjs/resources/Tax/Locations.d.ts +108 -0
- package/cjs/resources/Tax/Locations.js +33 -0
- package/cjs/resources/Tax/Locations.js.map +1 -0
- package/cjs/resources/Tax/Registrations.d.ts +138 -2
- package/cjs/resources/Tax/Transactions.d.ts +2 -2
- package/cjs/resources/Tax/index.d.ts +27 -13
- package/cjs/resources/Tax/index.js +4 -0
- package/cjs/resources/Tax/index.js.map +1 -1
- package/cjs/resources/TaxCodes.d.ts +15 -0
- package/cjs/resources/Terminal/Configurations.d.ts +27 -0
- package/cjs/resources/Terminal/ReaderCollectedData.d.ts +52 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +15 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js.map +1 -0
- package/cjs/resources/Terminal/Readers.d.ts +17 -1
- package/cjs/resources/Terminal/index.d.ts +5 -0
- package/cjs/resources/Terminal/index.js +2 -0
- package/cjs/resources/Terminal/index.js.map +1 -1
- package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +78 -1
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +68 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +21 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.js +13 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.js.map +1 -0
- package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
- package/cjs/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
- package/cjs/resources/TestHelpers/index.d.ts +3 -0
- package/cjs/resources/TestHelpers/index.js +6 -4
- package/cjs/resources/TestHelpers/index.js.map +1 -1
- package/cjs/resources/Transfers.d.ts +8 -0
- package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
- package/cjs/resources/Treasury/FinancialAccounts.d.ts +34 -1
- package/cjs/resources/Treasury/OutboundPayments.d.ts +8 -0
- package/cjs/resources/Treasury/OutboundTransfers.d.ts +44 -0
- package/cjs/resources/Treasury/ReceivedCredits.d.ts +22 -0
- package/cjs/resources/Treasury/ReceivedDebits.d.ts +26 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +75 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.js +4 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +23 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/BillSettings.d.ts +284 -0
- package/cjs/resources/V2/Billing/BillSettings.js +41 -0
- package/cjs/resources/V2/Billing/BillSettings.js.map +1 -0
- package/cjs/resources/V2/Billing/Cadences.d.ts +951 -0
- package/cjs/resources/V2/Billing/Cadences.js +198 -0
- package/cjs/resources/V2/Billing/Cadences.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.d.ts +240 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.js +4 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +70 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettings.d.ts +779 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js +166 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js.map +1 -0
- package/cjs/resources/V2/Billing/Profiles.d.ts +166 -0
- package/cjs/resources/V2/Billing/Profiles.js +35 -0
- package/cjs/resources/V2/Billing/Profiles.js.map +1 -0
- package/cjs/resources/V2/Billing/index.d.ts +45 -6
- package/cjs/resources/V2/Billing/index.js +8 -0
- package/cjs/resources/V2/Billing/index.js.map +1 -1
- package/cjs/resources/V2/Core/AccountLinks.d.ts +4 -4
- package/cjs/resources/V2/Core/AccountTokens.d.ts +10 -0
- package/cjs/resources/V2/Core/Accounts.d.ts +1177 -167
- package/cjs/resources/V2/Core/BatchJobs.d.ts +373 -0
- package/cjs/resources/V2/Core/BatchJobs.js +225 -0
- package/cjs/resources/V2/Core/BatchJobs.js.map +1 -0
- package/cjs/resources/V2/Core/Events.d.ts +1123 -4
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +285 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +54 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.d.ts +254 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +62 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/index.d.ts +28 -0
- package/cjs/resources/V2/Core/Vault/index.js +15 -0
- package/cjs/resources/V2/Core/Vault/index.js.map +1 -0
- package/cjs/resources/V2/Core/index.d.ts +19 -9
- package/cjs/resources/V2/Core/index.js +4 -0
- package/cjs/resources/V2/Core/index.js.map +1 -1
- package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts +156 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.js +46 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
- package/cjs/resources/V2/Data/Reporting/index.d.ts +13 -0
- package/cjs/resources/V2/Data/Reporting/index.js +13 -0
- package/cjs/resources/V2/Data/Reporting/index.js.map +1 -0
- package/cjs/resources/V2/Data/index.d.ts +10 -0
- package/cjs/resources/V2/Data/index.js +13 -0
- package/cjs/resources/V2/Data/index.js.map +1 -0
- package/cjs/resources/V2/EventMisc.d.ts +0 -0
- package/cjs/resources/V2/EventMisc.js +2 -0
- package/cjs/resources/V2/EventMisc.js.map +1 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.d.ts +166 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.js +23 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.js.map +1 -0
- package/cjs/resources/V2/Extend/Workflows.d.ts +123 -0
- package/cjs/resources/V2/Extend/Workflows.js +30 -0
- package/cjs/resources/V2/Extend/Workflows.js.map +1 -0
- package/cjs/resources/V2/Extend/index.d.ts +20 -0
- package/cjs/resources/V2/Extend/index.js +15 -0
- package/cjs/resources/V2/Extend/index.js.map +1 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.js +4 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js +4 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
- package/cjs/resources/V2/Iam/ActivityLogs.d.ts +214 -0
- package/cjs/resources/V2/Iam/ActivityLogs.js +23 -0
- package/cjs/resources/V2/Iam/ActivityLogs.js.map +1 -0
- package/cjs/resources/V2/Iam/index.d.ts +13 -0
- package/cjs/resources/V2/Iam/index.js +13 -0
- package/cjs/resources/V2/Iam/index.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +135 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +23 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +244 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +44 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +215 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +31 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.d.ts +254 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +30 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +212 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +22 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.d.ts +388 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +41 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +300 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +49 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.d.ts +330 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +39 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +243 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +44 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +96 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +17 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +295 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +23 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +161 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +23 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +165 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +23 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.d.ts +196 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +23 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/index.d.ts +104 -0
- package/cjs/resources/V2/MoneyManagement/index.js +39 -0
- package/cjs/resources/V2/MoneyManagement/index.js.map +1 -0
- package/cjs/resources/V2/Network/BusinessProfiles.d.ts +96 -0
- package/cjs/resources/V2/Network/BusinessProfiles.js +21 -0
- package/cjs/resources/V2/Network/BusinessProfiles.js.map +1 -0
- package/cjs/resources/V2/Network/index.d.ts +13 -0
- package/cjs/resources/V2/Network/index.js +13 -0
- package/cjs/resources/V2/Network/index.js.map +1 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.d.ts +147 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.js +41 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.js +13 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +23 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/index.d.ts +8 -0
- package/cjs/resources/V2/TestHelpers/index.js +13 -0
- package/cjs/resources/V2/TestHelpers/index.js.map +1 -0
- package/cjs/resources/V2/index.d.ts +27 -0
- package/cjs/resources/V2/index.js +14 -0
- package/cjs/resources/V2/index.js.map +1 -1
- package/cjs/resources/WebhookEndpoints.d.ts +2 -2
- package/cjs/resources.d.ts +10 -0
- package/cjs/resources.js +146 -10
- package/cjs/resources.js.map +1 -1
- package/cjs/stripe.core.d.ts +61 -24
- package/cjs/stripe.core.js +55 -31
- package/cjs/stripe.core.js.map +1 -1
- package/esm/Error.d.ts +50 -0
- package/esm/Error.js +109 -0
- package/esm/Error.js.map +1 -1
- package/esm/RequestSender.d.ts +0 -1
- package/esm/RequestSender.js +0 -8
- package/esm/RequestSender.js.map +1 -1
- package/esm/StripeEventNotificationHandler.d.ts +19 -0
- package/esm/StripeEventNotificationHandler.js +144 -0
- package/esm/StripeEventNotificationHandler.js.map +1 -0
- package/esm/Types.d.ts +4 -2
- package/esm/Types.js.map +1 -1
- package/esm/apiVersion.d.ts +1 -2
- package/esm/apiVersion.js +1 -2
- package/esm/apiVersion.js.map +1 -1
- package/esm/resources/AccountLinks.d.ts +1 -1
- package/esm/resources/AccountNotices.d.ts +140 -0
- package/esm/resources/AccountNotices.js +25 -0
- package/esm/resources/AccountNotices.js.map +1 -0
- package/esm/resources/AccountSessions.d.ts +262 -0
- package/esm/resources/AccountSessions.js.map +1 -1
- package/esm/resources/Accounts.d.ts +827 -3
- package/esm/resources/Accounts.js +14 -0
- package/esm/resources/Accounts.js.map +1 -1
- package/esm/resources/Balance.d.ts +67 -0
- package/esm/resources/BankAccounts.d.ts +2 -2
- package/esm/resources/Billing/AlertTriggereds.d.ts +2 -1
- package/esm/resources/Billing/Analytics/MeterUsage.d.ts +84 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js +11 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js.map +1 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +32 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.js +3 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
- package/esm/resources/Billing/Analytics/index.d.ts +15 -0
- package/esm/resources/Billing/Analytics/index.js +9 -0
- package/esm/resources/Billing/Analytics/index.js.map +1 -0
- package/esm/resources/Billing/index.d.ts +3 -0
- package/esm/resources/Billing/index.js +2 -0
- package/esm/resources/Billing/index.js.map +1 -1
- package/esm/resources/Capabilities.d.ts +2 -2
- package/esm/resources/Capital/FinancingOffers.d.ts +191 -0
- package/esm/resources/Capital/FinancingOffers.js +26 -0
- package/esm/resources/Capital/FinancingOffers.js.map +1 -0
- package/esm/resources/Capital/FinancingSummary.d.ts +98 -0
- package/esm/resources/Capital/FinancingSummary.js +11 -0
- package/esm/resources/Capital/FinancingSummary.js.map +1 -0
- package/esm/resources/Capital/FinancingTransactions.d.ts +143 -0
- package/esm/resources/Capital/FinancingTransactions.js +20 -0
- package/esm/resources/Capital/FinancingTransactions.js.map +1 -0
- package/esm/resources/Capital/index.d.ts +25 -0
- package/esm/resources/Capital/index.js +13 -0
- package/esm/resources/Capital/index.js.map +1 -0
- package/esm/resources/Cards.d.ts +4 -0
- package/esm/resources/Charges.d.ts +3064 -70
- package/esm/resources/Checkout/Sessions.d.ts +390 -4
- package/esm/resources/ConfirmationTokens.d.ts +67 -1
- package/esm/resources/Coupons.d.ts +53 -0
- package/esm/resources/Coupons.js +13 -0
- package/esm/resources/Coupons.js.map +1 -1
- package/esm/resources/CreditNoteLineItems.d.ts +15 -1
- package/esm/resources/CreditNotes.d.ts +1 -1
- package/esm/resources/CustomerSessions.d.ts +68 -0
- package/esm/resources/Customers.d.ts +7 -1
- package/esm/resources/Customers.js +14 -0
- package/esm/resources/Customers.js.map +1 -1
- package/esm/resources/Disputes.d.ts +29 -0
- package/esm/resources/Events.d.ts +547 -2
- package/esm/resources/ExternalAccounts.d.ts +212 -1
- package/esm/resources/ExternalAccounts.js +42 -1
- package/esm/resources/ExternalAccounts.js.map +1 -1
- package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
- package/esm/resources/FinancialConnections/AccountInferredBalances.js +3 -0
- package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
- package/esm/resources/FinancialConnections/Accounts.d.ts +74 -4
- package/esm/resources/FinancialConnections/Accounts.js +8 -0
- package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
- package/esm/resources/FinancialConnections/Authorizations.d.ts +87 -0
- package/esm/resources/FinancialConnections/Authorizations.js +11 -0
- package/esm/resources/FinancialConnections/Authorizations.js.map +1 -0
- package/esm/resources/FinancialConnections/Institutions.d.ts +101 -0
- package/esm/resources/FinancialConnections/Institutions.js +19 -0
- package/esm/resources/FinancialConnections/Institutions.js.map +1 -0
- package/esm/resources/FinancialConnections/Sessions.d.ts +155 -7
- package/esm/resources/FinancialConnections/index.d.ts +21 -6
- package/esm/resources/FinancialConnections/index.js +4 -0
- package/esm/resources/FinancialConnections/index.js.map +1 -1
- package/esm/resources/FxQuotes.d.ts +212 -0
- package/esm/resources/FxQuotes.js +25 -0
- package/esm/resources/FxQuotes.js.map +1 -0
- package/esm/resources/InvoiceItems.d.ts +85 -0
- package/esm/resources/InvoiceItems.js.map +1 -1
- package/esm/resources/InvoiceLineItems.d.ts +40 -2
- package/esm/resources/Invoices.d.ts +1337 -19
- package/esm/resources/Invoices.js +41 -0
- package/esm/resources/Invoices.js.map +1 -1
- package/esm/resources/Issuing/Cardholders.d.ts +2 -1
- package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +640 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +43 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +95 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js +19 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js +19 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
- package/esm/resources/Issuing/Settlements.d.ts +85 -0
- package/esm/resources/Issuing/Settlements.js +3 -0
- package/esm/resources/Issuing/Settlements.js.map +1 -0
- package/esm/resources/Issuing/Transactions.d.ts +9 -0
- package/esm/resources/Issuing/Transactions.js.map +1 -1
- package/esm/resources/Issuing/index.d.ts +47 -22
- package/esm/resources/Issuing/index.js +6 -0
- package/esm/resources/Issuing/index.js.map +1 -1
- package/esm/resources/LineItems.d.ts +29 -2
- package/esm/resources/Mandates.d.ts +33 -1
- package/esm/resources/Mandates.js +8 -0
- package/esm/resources/Mandates.js.map +1 -1
- package/esm/resources/Margins.d.ts +115 -0
- package/esm/resources/Margins.js +31 -0
- package/esm/resources/Margins.js.map +1 -0
- package/esm/resources/Orders.d.ts +4693 -0
- package/esm/resources/Orders.js +453 -0
- package/esm/resources/Orders.js.map +1 -0
- package/esm/resources/PaymentAttemptRecords.d.ts +82 -0
- package/esm/resources/PaymentIntents.d.ts +13239 -2321
- package/esm/resources/PaymentIntents.js +27 -0
- package/esm/resources/PaymentIntents.js.map +1 -1
- package/esm/resources/PaymentLinks.d.ts +19 -3
- package/esm/resources/PaymentMethodConfigurations.d.ts +350 -0
- package/esm/resources/PaymentMethods.d.ts +151 -3
- package/esm/resources/PaymentMethods.js.map +1 -1
- package/esm/resources/PaymentRecords.d.ts +82 -0
- package/esm/resources/Persons.d.ts +2 -2
- package/esm/resources/Plans.d.ts +16 -0
- package/esm/resources/Prices.d.ts +52 -0
- package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +37 -0
- package/esm/resources/Privacy/RedactionJobValidationErrors.js +3 -0
- package/esm/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
- package/esm/resources/Privacy/RedactionJobs.d.ts +229 -0
- package/esm/resources/Privacy/RedactionJobs.js +69 -0
- package/esm/resources/Privacy/RedactionJobs.js.map +1 -0
- package/esm/resources/Privacy/index.d.ts +22 -0
- package/esm/resources/Privacy/index.js +9 -0
- package/esm/resources/Privacy/index.js.map +1 -0
- package/esm/resources/ProductCatalog/TrialOffers.d.ts +127 -0
- package/esm/resources/ProductCatalog/TrialOffers.js +11 -0
- package/esm/resources/ProductCatalog/TrialOffers.js.map +1 -0
- package/esm/resources/ProductCatalog/index.d.ts +12 -0
- package/esm/resources/ProductCatalog/index.js +9 -0
- package/esm/resources/ProductCatalog/index.js.map +1 -0
- package/esm/resources/Products.d.ts +42 -0
- package/esm/resources/PromotionCodes.d.ts +12 -0
- package/esm/resources/PromotionCodes.js +27 -0
- package/esm/resources/PromotionCodes.js.map +1 -1
- package/esm/resources/QuoteLines.d.ts +507 -0
- package/esm/resources/QuoteLines.js +3 -0
- package/esm/resources/QuoteLines.js.map +1 -0
- package/esm/resources/QuotePreviewInvoices.d.ts +1120 -0
- package/esm/resources/QuotePreviewInvoices.js +3 -0
- package/esm/resources/QuotePreviewInvoices.js.map +1 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +737 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js +3 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/esm/resources/Quotes.d.ts +2266 -57
- package/esm/resources/Quotes.js +1184 -16
- package/esm/resources/Quotes.js.map +1 -1
- package/esm/resources/Radar/PaymentEvaluations.d.ts +1 -1
- package/esm/resources/Refunds.d.ts +11 -0
- package/esm/resources/Reserve/Holds.d.ts +53 -1
- package/esm/resources/Reserve/Holds.js +17 -1
- package/esm/resources/Reserve/Holds.js.map +1 -1
- package/esm/resources/Reserve/Plans.d.ts +16 -0
- package/esm/resources/Reserve/Plans.js +9 -1
- package/esm/resources/Reserve/Plans.js.map +1 -1
- package/esm/resources/Reserve/Releases.d.ts +41 -1
- package/esm/resources/Reserve/Releases.js +17 -1
- package/esm/resources/Reserve/Releases.js.map +1 -1
- package/esm/resources/Reserve/index.d.ts +14 -3
- package/esm/resources/Reserve/index.js +10 -2
- package/esm/resources/Reserve/index.js.map +1 -1
- package/esm/resources/SetupAttempts.d.ts +26 -1
- package/esm/resources/SetupIntents.d.ts +330 -11
- package/esm/resources/SharedPayment/GrantedTokens.d.ts +1095 -0
- package/esm/resources/SharedPayment/GrantedTokens.js +11 -0
- package/esm/resources/SharedPayment/GrantedTokens.js.map +1 -0
- package/esm/resources/SharedPayment/IssuedTokens.d.ts +308 -0
- package/esm/resources/SharedPayment/IssuedTokens.js +23 -0
- package/esm/resources/SharedPayment/IssuedTokens.js.map +1 -0
- package/esm/resources/SharedPayment/index.d.ts +19 -0
- package/esm/resources/SharedPayment/index.js +11 -0
- package/esm/resources/SharedPayment/index.js.map +1 -0
- package/esm/resources/Sources.d.ts +16 -1
- package/esm/resources/SubscriptionItems.d.ts +143 -0
- package/esm/resources/SubscriptionSchedules.d.ts +1152 -0
- package/esm/resources/SubscriptionSchedules.js +6 -0
- package/esm/resources/SubscriptionSchedules.js.map +1 -1
- package/esm/resources/Subscriptions.d.ts +571 -6
- package/esm/resources/Subscriptions.js +145 -0
- package/esm/resources/Subscriptions.js.map +1 -1
- package/esm/resources/Tax/CalculationLineItems.d.ts +6 -2
- package/esm/resources/Tax/Calculations.d.ts +7 -3
- package/esm/resources/Tax/Forms.d.ts +230 -0
- package/esm/resources/Tax/Forms.js +28 -0
- package/esm/resources/Tax/Forms.js.map +1 -0
- package/esm/resources/Tax/Locations.d.ts +108 -0
- package/esm/resources/Tax/Locations.js +29 -0
- package/esm/resources/Tax/Locations.js.map +1 -0
- package/esm/resources/Tax/Registrations.d.ts +138 -2
- package/esm/resources/Tax/Transactions.d.ts +2 -2
- package/esm/resources/Tax/index.d.ts +27 -13
- package/esm/resources/Tax/index.js +4 -0
- package/esm/resources/Tax/index.js.map +1 -1
- package/esm/resources/TaxCodes.d.ts +15 -0
- package/esm/resources/Terminal/Configurations.d.ts +27 -0
- package/esm/resources/Terminal/ReaderCollectedData.d.ts +52 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +11 -0
- package/esm/resources/Terminal/ReaderCollectedData.js.map +1 -0
- package/esm/resources/Terminal/Readers.d.ts +17 -1
- package/esm/resources/Terminal/index.d.ts +5 -0
- package/esm/resources/Terminal/index.js +2 -0
- package/esm/resources/Terminal/index.js.map +1 -1
- package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +78 -1
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +68 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +17 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
- package/esm/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
- package/esm/resources/TestHelpers/SharedPayment/index.js +9 -0
- package/esm/resources/TestHelpers/SharedPayment/index.js.map +1 -0
- package/esm/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
- package/esm/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
- package/esm/resources/TestHelpers/index.d.ts +3 -0
- package/esm/resources/TestHelpers/index.js +2 -0
- package/esm/resources/TestHelpers/index.js.map +1 -1
- package/esm/resources/Transfers.d.ts +8 -0
- package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
- package/esm/resources/Treasury/FinancialAccounts.d.ts +34 -1
- package/esm/resources/Treasury/OutboundPayments.d.ts +8 -0
- package/esm/resources/Treasury/OutboundTransfers.d.ts +44 -0
- package/esm/resources/Treasury/ReceivedCredits.d.ts +22 -0
- package/esm/resources/Treasury/ReceivedDebits.d.ts +26 -0
- package/esm/resources/V2/Billing/BillSettingVersions.d.ts +75 -0
- package/esm/resources/V2/Billing/BillSettingVersions.js +3 -0
- package/esm/resources/V2/Billing/BillSettingVersions.js.map +1 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js +19 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/BillSettings.d.ts +284 -0
- package/esm/resources/V2/Billing/BillSettings.js +37 -0
- package/esm/resources/V2/Billing/BillSettings.js.map +1 -0
- package/esm/resources/V2/Billing/Cadences.d.ts +951 -0
- package/esm/resources/V2/Billing/Cadences.js +194 -0
- package/esm/resources/V2/Billing/Cadences.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.d.ts +240 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.js +3 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +66 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettings.d.ts +779 -0
- package/esm/resources/V2/Billing/CollectionSettings.js +162 -0
- package/esm/resources/V2/Billing/CollectionSettings.js.map +1 -0
- package/esm/resources/V2/Billing/Profiles.d.ts +166 -0
- package/esm/resources/V2/Billing/Profiles.js +31 -0
- package/esm/resources/V2/Billing/Profiles.js.map +1 -0
- package/esm/resources/V2/Billing/index.d.ts +45 -6
- package/esm/resources/V2/Billing/index.js +8 -0
- package/esm/resources/V2/Billing/index.js.map +1 -1
- package/esm/resources/V2/Core/AccountLinks.d.ts +4 -4
- package/esm/resources/V2/Core/AccountTokens.d.ts +10 -0
- package/esm/resources/V2/Core/Accounts.d.ts +1177 -167
- package/esm/resources/V2/Core/BatchJobs.d.ts +373 -0
- package/esm/resources/V2/Core/BatchJobs.js +221 -0
- package/esm/resources/V2/Core/BatchJobs.js.map +1 -0
- package/esm/resources/V2/Core/Events.d.ts +1123 -4
- package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +285 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +50 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.d.ts +254 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +58 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
- package/esm/resources/V2/Core/Vault/index.d.ts +28 -0
- package/esm/resources/V2/Core/Vault/index.js +11 -0
- package/esm/resources/V2/Core/Vault/index.js.map +1 -0
- package/esm/resources/V2/Core/index.d.ts +19 -9
- package/esm/resources/V2/Core/index.js +4 -0
- package/esm/resources/V2/Core/index.js.map +1 -1
- package/esm/resources/V2/Data/Reporting/QueryRuns.d.ts +156 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.js +42 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
- package/esm/resources/V2/Data/Reporting/index.d.ts +13 -0
- package/esm/resources/V2/Data/Reporting/index.js +9 -0
- package/esm/resources/V2/Data/Reporting/index.js.map +1 -0
- package/esm/resources/V2/Data/index.d.ts +10 -0
- package/esm/resources/V2/Data/index.js +9 -0
- package/esm/resources/V2/Data/index.js.map +1 -0
- package/esm/resources/V2/EventMisc.d.ts +0 -0
- package/esm/resources/V2/EventMisc.js +2 -0
- package/esm/resources/V2/EventMisc.js.map +1 -0
- package/esm/resources/V2/Extend/WorkflowRuns.d.ts +166 -0
- package/esm/resources/V2/Extend/WorkflowRuns.js +19 -0
- package/esm/resources/V2/Extend/WorkflowRuns.js.map +1 -0
- package/esm/resources/V2/Extend/Workflows.d.ts +123 -0
- package/esm/resources/V2/Extend/Workflows.js +26 -0
- package/esm/resources/V2/Extend/Workflows.js.map +1 -0
- package/esm/resources/V2/Extend/index.d.ts +20 -0
- package/esm/resources/V2/Extend/index.js +11 -0
- package/esm/resources/V2/Extend/index.js.map +1 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.js +3 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js +3 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
- package/esm/resources/V2/Iam/ActivityLogs.d.ts +214 -0
- package/esm/resources/V2/Iam/ActivityLogs.js +19 -0
- package/esm/resources/V2/Iam/ActivityLogs.js.map +1 -0
- package/esm/resources/V2/Iam/index.d.ts +13 -0
- package/esm/resources/V2/Iam/index.js +9 -0
- package/esm/resources/V2/Iam/index.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +135 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js +19 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +244 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +40 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +215 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +27 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.d.ts +254 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +26 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +212 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +18 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.d.ts +388 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +37 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +300 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +45 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.d.ts +330 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +35 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +243 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +40 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +96 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +13 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +295 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +19 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +161 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +19 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +165 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +19 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/Transactions.d.ts +196 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +19 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/index.d.ts +104 -0
- package/esm/resources/V2/MoneyManagement/index.js +35 -0
- package/esm/resources/V2/MoneyManagement/index.js.map +1 -0
- package/esm/resources/V2/Network/BusinessProfiles.d.ts +96 -0
- package/esm/resources/V2/Network/BusinessProfiles.js +17 -0
- package/esm/resources/V2/Network/BusinessProfiles.js.map +1 -0
- package/esm/resources/V2/Network/index.d.ts +13 -0
- package/esm/resources/V2/Network/index.js +9 -0
- package/esm/resources/V2/Network/index.js.map +1 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.d.ts +147 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.js +37 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
- package/esm/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
- package/esm/resources/V2/OrchestratedCommerce/index.js +9 -0
- package/esm/resources/V2/OrchestratedCommerce/index.js.map +1 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +19 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
- package/esm/resources/V2/TestHelpers/index.d.ts +8 -0
- package/esm/resources/V2/TestHelpers/index.js +9 -0
- package/esm/resources/V2/TestHelpers/index.js.map +1 -0
- package/esm/resources/V2/index.d.ts +27 -0
- package/esm/resources/V2/index.js +14 -0
- package/esm/resources/V2/index.js.map +1 -1
- package/esm/resources/WebhookEndpoints.d.ts +2 -2
- package/esm/resources.d.ts +10 -0
- package/esm/resources.js +131 -0
- package/esm/resources.js.map +1 -1
- package/esm/stripe.core.d.ts +61 -24
- package/esm/stripe.core.js +25 -1
- package/esm/stripe.core.js.map +1 -1
- package/esm/stripe.esm.node.d.ts +62 -24
- package/esm/stripe.esm.node.js +25 -1
- package/esm/stripe.esm.node.js.map +1 -1
- package/package.json +1 -1
|
@@ -11,7 +11,7 @@ import { CustomerSource } from './CustomerSources.js';
|
|
|
11
11
|
import { Transfer } from './Transfers.js';
|
|
12
12
|
import { PaymentMethod } from './PaymentMethods.js';
|
|
13
13
|
import { Mandate } from './Mandates.js';
|
|
14
|
-
import { Emptyable, MetadataParam, AddressParam, PaginationParams, RangeQueryParam, Metadata
|
|
14
|
+
import { Emptyable, MetadataParam, AddressParam, Address, PaginationParams, RangeQueryParam, Metadata } from '../shared.js';
|
|
15
15
|
import { RequestOptions, ApiListPromise, Response, ApiList, ApiSearchResultPromise } from '../lib.js';
|
|
16
16
|
export declare class ChargeResource extends StripeResource {
|
|
17
17
|
/**
|
|
@@ -342,7 +342,9 @@ export declare namespace Charge {
|
|
|
342
342
|
eps?: PaymentMethodDetails.Eps;
|
|
343
343
|
fpx?: PaymentMethodDetails.Fpx;
|
|
344
344
|
giropay?: PaymentMethodDetails.Giropay;
|
|
345
|
+
gopay?: PaymentMethodDetails.Gopay;
|
|
345
346
|
grabpay?: PaymentMethodDetails.Grabpay;
|
|
347
|
+
id_bank_transfer?: PaymentMethodDetails.IdBankTransfer;
|
|
346
348
|
ideal?: PaymentMethodDetails.Ideal;
|
|
347
349
|
interac_present?: PaymentMethodDetails.InteracPresent;
|
|
348
350
|
kakao_pay?: PaymentMethodDetails.KakaoPay;
|
|
@@ -361,17 +363,22 @@ export declare namespace Charge {
|
|
|
361
363
|
payco?: PaymentMethodDetails.Payco;
|
|
362
364
|
paynow?: PaymentMethodDetails.Paynow;
|
|
363
365
|
paypal?: PaymentMethodDetails.Paypal;
|
|
366
|
+
paypay?: PaymentMethodDetails.Paypay;
|
|
364
367
|
payto?: PaymentMethodDetails.Payto;
|
|
365
368
|
pix?: PaymentMethodDetails.Pix;
|
|
366
369
|
promptpay?: PaymentMethodDetails.Promptpay;
|
|
370
|
+
qris?: PaymentMethodDetails.Qris;
|
|
371
|
+
rechnung?: PaymentMethodDetails.Rechnung;
|
|
367
372
|
revolut_pay?: PaymentMethodDetails.RevolutPay;
|
|
368
373
|
samsung_pay?: PaymentMethodDetails.SamsungPay;
|
|
369
374
|
satispay?: PaymentMethodDetails.Satispay;
|
|
370
375
|
scalapay?: PaymentMethodDetails.Scalapay;
|
|
371
376
|
sepa_credit_transfer?: PaymentMethodDetails.SepaCreditTransfer;
|
|
372
377
|
sepa_debit?: PaymentMethodDetails.SepaDebit;
|
|
378
|
+
shopeepay?: PaymentMethodDetails.Shopeepay;
|
|
373
379
|
sofort?: PaymentMethodDetails.Sofort;
|
|
374
380
|
stripe_account?: PaymentMethodDetails.StripeAccount;
|
|
381
|
+
stripe_balance?: PaymentMethodDetails.StripeBalance;
|
|
375
382
|
sunbit?: PaymentMethodDetails.Sunbit;
|
|
376
383
|
swish?: PaymentMethodDetails.Swish;
|
|
377
384
|
twint?: PaymentMethodDetails.Twint;
|
|
@@ -696,6 +703,10 @@ export declare namespace Charge {
|
|
|
696
703
|
* The authorized amount.
|
|
697
704
|
*/
|
|
698
705
|
amount_authorized: number | null;
|
|
706
|
+
/**
|
|
707
|
+
* The latest amount intended to be authorized by this charge.
|
|
708
|
+
*/
|
|
709
|
+
amount_requested?: number | null;
|
|
699
710
|
/**
|
|
700
711
|
* Authorization code on the charge.
|
|
701
712
|
*/
|
|
@@ -716,6 +727,7 @@ export declare namespace Charge {
|
|
|
716
727
|
* Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
|
|
717
728
|
*/
|
|
718
729
|
country: string | null;
|
|
730
|
+
decremental_authorization?: Card.DecrementalAuthorization;
|
|
719
731
|
/**
|
|
720
732
|
* A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
|
|
721
733
|
*/
|
|
@@ -780,6 +792,7 @@ export declare namespace Charge {
|
|
|
780
792
|
*/
|
|
781
793
|
network_transaction_id: string | null;
|
|
782
794
|
overcapture?: Card.Overcapture;
|
|
795
|
+
partial_authorization?: Card.PartialAuthorization;
|
|
783
796
|
/**
|
|
784
797
|
* Status of a card based on the card issuer.
|
|
785
798
|
*/
|
|
@@ -982,12 +995,36 @@ export declare namespace Charge {
|
|
|
982
995
|
*/
|
|
983
996
|
verified_name: string | null;
|
|
984
997
|
}
|
|
998
|
+
interface Gopay {
|
|
999
|
+
}
|
|
985
1000
|
interface Grabpay {
|
|
986
1001
|
/**
|
|
987
1002
|
* Unique transaction id generated by GrabPay
|
|
988
1003
|
*/
|
|
989
1004
|
transaction_id: string | null;
|
|
990
1005
|
}
|
|
1006
|
+
interface IdBankTransfer {
|
|
1007
|
+
/**
|
|
1008
|
+
* Account number of the bank account to transfer funds to.
|
|
1009
|
+
*/
|
|
1010
|
+
account_number: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* Bank where the account is located.
|
|
1013
|
+
*/
|
|
1014
|
+
bank: IdBankTransfer.Bank;
|
|
1015
|
+
/**
|
|
1016
|
+
* Local bank code of the bank.
|
|
1017
|
+
*/
|
|
1018
|
+
bank_code?: string;
|
|
1019
|
+
/**
|
|
1020
|
+
* Name of the bank associated with the bank account.
|
|
1021
|
+
*/
|
|
1022
|
+
bank_name?: string;
|
|
1023
|
+
/**
|
|
1024
|
+
* Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
|
|
1025
|
+
*/
|
|
1026
|
+
display_name?: string;
|
|
1027
|
+
}
|
|
991
1028
|
interface Ideal {
|
|
992
1029
|
/**
|
|
993
1030
|
* The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
|
|
@@ -1297,10 +1334,34 @@ export declare namespace Charge {
|
|
|
1297
1334
|
* The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
|
|
1298
1335
|
*/
|
|
1299
1336
|
seller_protection: Paypal.SellerProtection | null;
|
|
1337
|
+
/**
|
|
1338
|
+
* The shipping address for the customer, as supplied by the merchant at the point of payment
|
|
1339
|
+
* execution. This shipping address will not be updated if the merchant updates the shipping
|
|
1340
|
+
* address on the PaymentIntent after the PaymentIntent was successfully confirmed.
|
|
1341
|
+
*/
|
|
1342
|
+
shipping?: Address | null;
|
|
1300
1343
|
/**
|
|
1301
1344
|
* A unique ID generated by PayPal for this transaction.
|
|
1302
1345
|
*/
|
|
1303
1346
|
transaction_id: string | null;
|
|
1347
|
+
/**
|
|
1348
|
+
* The shipping address for the customer, as supplied by the merchant at the point of payment
|
|
1349
|
+
* execution. This shipping address will not be updated if the merchant updates the shipping
|
|
1350
|
+
* address on the PaymentIntent after the PaymentIntent was successfully confirmed.
|
|
1351
|
+
*/
|
|
1352
|
+
verified_address?: Address | null;
|
|
1353
|
+
/**
|
|
1354
|
+
* Owner's verified email. Values are verified or provided by PayPal directly
|
|
1355
|
+
* (if supported) at the time of authorization or settlement. They cannot be set or mutated.
|
|
1356
|
+
*/
|
|
1357
|
+
verified_email?: string | null;
|
|
1358
|
+
/**
|
|
1359
|
+
* Owner's verified full name. Values are verified or provided by PayPal directly
|
|
1360
|
+
* (if supported) at the time of authorization or settlement. They cannot be set or mutated.
|
|
1361
|
+
*/
|
|
1362
|
+
verified_name?: string | null;
|
|
1363
|
+
}
|
|
1364
|
+
interface Paypay {
|
|
1304
1365
|
}
|
|
1305
1366
|
interface Payto {
|
|
1306
1367
|
/**
|
|
@@ -1336,6 +1397,14 @@ export declare namespace Charge {
|
|
|
1336
1397
|
*/
|
|
1337
1398
|
reference: string | null;
|
|
1338
1399
|
}
|
|
1400
|
+
interface Qris {
|
|
1401
|
+
}
|
|
1402
|
+
interface Rechnung {
|
|
1403
|
+
/**
|
|
1404
|
+
* Payment portal URL.
|
|
1405
|
+
*/
|
|
1406
|
+
payment_portal_url: string | null;
|
|
1407
|
+
}
|
|
1339
1408
|
interface RevolutPay {
|
|
1340
1409
|
funding?: RevolutPay.Funding;
|
|
1341
1410
|
/**
|
|
@@ -1409,6 +1478,8 @@ export declare namespace Charge {
|
|
|
1409
1478
|
*/
|
|
1410
1479
|
mandate: string | null;
|
|
1411
1480
|
}
|
|
1481
|
+
interface Shopeepay {
|
|
1482
|
+
}
|
|
1412
1483
|
interface Sofort {
|
|
1413
1484
|
/**
|
|
1414
1485
|
* Bank code of bank associated with the bank account.
|
|
@@ -1451,6 +1522,12 @@ export declare namespace Charge {
|
|
|
1451
1522
|
}
|
|
1452
1523
|
interface StripeAccount {
|
|
1453
1524
|
}
|
|
1525
|
+
interface StripeBalance {
|
|
1526
|
+
/**
|
|
1527
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
1528
|
+
*/
|
|
1529
|
+
account?: string | null;
|
|
1530
|
+
}
|
|
1454
1531
|
interface Sunbit {
|
|
1455
1532
|
/**
|
|
1456
1533
|
* The Sunbit transaction ID associated with this payment.
|
|
@@ -1568,6 +1645,10 @@ export declare namespace Charge {
|
|
|
1568
1645
|
* Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
|
|
1569
1646
|
*/
|
|
1570
1647
|
brand: string | null;
|
|
1648
|
+
/**
|
|
1649
|
+
* The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
|
|
1650
|
+
*/
|
|
1651
|
+
brand_product?: string | null;
|
|
1571
1652
|
/**
|
|
1572
1653
|
* Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
|
|
1573
1654
|
*/
|
|
@@ -1609,6 +1690,12 @@ export declare namespace Charge {
|
|
|
1609
1690
|
*/
|
|
1610
1691
|
cvc_check: string | null;
|
|
1611
1692
|
}
|
|
1693
|
+
interface DecrementalAuthorization {
|
|
1694
|
+
/**
|
|
1695
|
+
* Indicates whether or not the decremental authorization feature is supported.
|
|
1696
|
+
*/
|
|
1697
|
+
status: DecrementalAuthorization.Status;
|
|
1698
|
+
}
|
|
1612
1699
|
interface ExtendedAuthorization {
|
|
1613
1700
|
/**
|
|
1614
1701
|
* Indicates whether or not the capture window is extended beyond the standard authorization.
|
|
@@ -1649,6 +1736,12 @@ export declare namespace Charge {
|
|
|
1649
1736
|
*/
|
|
1650
1737
|
status: Overcapture.Status;
|
|
1651
1738
|
}
|
|
1739
|
+
interface PartialAuthorization {
|
|
1740
|
+
/**
|
|
1741
|
+
* Indicates whether the transaction requested for partial authorization feature and the authorization outcome.
|
|
1742
|
+
*/
|
|
1743
|
+
status: PartialAuthorization.Status;
|
|
1744
|
+
}
|
|
1652
1745
|
type RegulatedStatus = 'regulated' | 'unregulated';
|
|
1653
1746
|
interface ThreeDSecure {
|
|
1654
1747
|
/**
|
|
@@ -1706,6 +1799,9 @@ export declare namespace Charge {
|
|
|
1706
1799
|
type: Wallet.Type;
|
|
1707
1800
|
visa_checkout?: Wallet.VisaCheckout;
|
|
1708
1801
|
}
|
|
1802
|
+
namespace DecrementalAuthorization {
|
|
1803
|
+
type Status = 'available' | 'unavailable';
|
|
1804
|
+
}
|
|
1709
1805
|
namespace ExtendedAuthorization {
|
|
1710
1806
|
type Status = 'disabled' | 'enabled';
|
|
1711
1807
|
}
|
|
@@ -1738,6 +1834,9 @@ export declare namespace Charge {
|
|
|
1738
1834
|
namespace Overcapture {
|
|
1739
1835
|
type Status = 'available' | 'unavailable';
|
|
1740
1836
|
}
|
|
1837
|
+
namespace PartialAuthorization {
|
|
1838
|
+
type Status = 'declined' | 'fully_authorized' | 'not_requested' | 'partially_authorized';
|
|
1839
|
+
}
|
|
1741
1840
|
namespace ThreeDSecure {
|
|
1742
1841
|
type AuthenticationFlow = 'challenge' | 'frictionless';
|
|
1743
1842
|
type ElectronicCommerceIndicator = '01' | '02' | '05' | '06' | '07';
|
|
@@ -1870,6 +1969,9 @@ export declare namespace Charge {
|
|
|
1870
1969
|
type AccountHolderType = 'company' | 'individual';
|
|
1871
1970
|
type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bsn' | 'cimb' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob';
|
|
1872
1971
|
}
|
|
1972
|
+
namespace IdBankTransfer {
|
|
1973
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
1974
|
+
}
|
|
1873
1975
|
namespace Ideal {
|
|
1874
1976
|
type Bank = 'abn_amro' | 'adyen' | 'asn_bank' | 'bunq' | 'buut' | 'finom' | 'handelsbanken' | 'ing' | 'knab' | 'mollie' | 'moneyou' | 'n26' | 'nn' | 'rabobank' | 'regiobank' | 'revolut' | 'sns_bank' | 'triodos_bank' | 'van_lanschot' | 'yoursafe';
|
|
1875
1977
|
type Bic = 'ABNANL2A' | 'ADYBNL2A' | 'ASNBNL21' | 'BITSNL2A' | 'BUNQNL2A' | 'BUUTNL2A' | 'FNOMNL22' | 'FVLBNL22' | 'HANDNL2A' | 'INGBNL2A' | 'KNABNL2H' | 'MLLENL2A' | 'MOYONL21' | 'NNBANL2G' | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' | 'REVOLT21' | 'SNSBNL2A' | 'TRIONL2U';
|
|
@@ -2005,6 +2107,10 @@ export declare namespace Charge {
|
|
|
2005
2107
|
* Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
|
|
2006
2108
|
*/
|
|
2007
2109
|
brand: string | null;
|
|
2110
|
+
/**
|
|
2111
|
+
* The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
|
|
2112
|
+
*/
|
|
2113
|
+
brand_product?: string | null;
|
|
2008
2114
|
/**
|
|
2009
2115
|
* Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
|
|
2010
2116
|
*/
|
|
@@ -2192,6 +2298,10 @@ export interface ChargeUpdateParams {
|
|
|
2192
2298
|
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
2193
2299
|
*/
|
|
2194
2300
|
metadata?: Emptyable<MetadataParam>;
|
|
2301
|
+
/**
|
|
2302
|
+
* Provides industry-specific information about the charge.
|
|
2303
|
+
*/
|
|
2304
|
+
payment_details?: ChargeUpdateParams.PaymentDetails;
|
|
2195
2305
|
/**
|
|
2196
2306
|
* This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
|
|
2197
2307
|
*/
|
|
@@ -2212,6 +2322,52 @@ export declare namespace ChargeUpdateParams {
|
|
|
2212
2322
|
*/
|
|
2213
2323
|
user_report: Emptyable<FraudDetails.UserReport>;
|
|
2214
2324
|
}
|
|
2325
|
+
interface PaymentDetails {
|
|
2326
|
+
/**
|
|
2327
|
+
* Car rental details for this PaymentIntent.
|
|
2328
|
+
*/
|
|
2329
|
+
car_rental?: PaymentDetails.CarRental;
|
|
2330
|
+
/**
|
|
2331
|
+
* Car rental data for this PaymentIntent.
|
|
2332
|
+
*/
|
|
2333
|
+
car_rental_data?: Emptyable<Array<PaymentDetails.CarRentalDatum>>;
|
|
2334
|
+
/**
|
|
2335
|
+
* A unique value to identify the customer. This field is available only for card payments.
|
|
2336
|
+
*
|
|
2337
|
+
* This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
|
|
2338
|
+
*/
|
|
2339
|
+
customer_reference?: Emptyable<string>;
|
|
2340
|
+
/**
|
|
2341
|
+
* Event details for this PaymentIntent
|
|
2342
|
+
*/
|
|
2343
|
+
event_details?: PaymentDetails.EventDetails;
|
|
2344
|
+
/**
|
|
2345
|
+
* Flight reservation details for this PaymentIntent
|
|
2346
|
+
*/
|
|
2347
|
+
flight?: PaymentDetails.Flight;
|
|
2348
|
+
/**
|
|
2349
|
+
* Flight data for this PaymentIntent.
|
|
2350
|
+
*/
|
|
2351
|
+
flight_data?: Emptyable<Array<PaymentDetails.FlightDatum>>;
|
|
2352
|
+
/**
|
|
2353
|
+
* Lodging reservation details for this PaymentIntent
|
|
2354
|
+
*/
|
|
2355
|
+
lodging?: PaymentDetails.Lodging;
|
|
2356
|
+
/**
|
|
2357
|
+
* Lodging data for this PaymentIntent.
|
|
2358
|
+
*/
|
|
2359
|
+
lodging_data?: Emptyable<Array<PaymentDetails.LodgingDatum>>;
|
|
2360
|
+
/**
|
|
2361
|
+
* A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
|
|
2362
|
+
*
|
|
2363
|
+
* For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
|
|
2364
|
+
*/
|
|
2365
|
+
order_reference?: Emptyable<string>;
|
|
2366
|
+
/**
|
|
2367
|
+
* Subscription details for this PaymentIntent
|
|
2368
|
+
*/
|
|
2369
|
+
subscription?: PaymentDetails.Subscription;
|
|
2370
|
+
}
|
|
2215
2371
|
interface Shipping {
|
|
2216
2372
|
/**
|
|
2217
2373
|
* Shipping address.
|
|
@@ -2237,75 +2393,2913 @@ export declare namespace ChargeUpdateParams {
|
|
|
2237
2393
|
namespace FraudDetails {
|
|
2238
2394
|
type UserReport = 'fraudulent' | 'safe';
|
|
2239
2395
|
}
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
|
-
|
|
2246
|
-
|
|
2247
|
-
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
|
|
2288
|
-
|
|
2289
|
-
|
|
2290
|
-
|
|
2291
|
-
|
|
2292
|
-
|
|
2293
|
-
|
|
2294
|
-
|
|
2295
|
-
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
|
|
2300
|
-
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
|
|
2396
|
+
namespace PaymentDetails {
|
|
2397
|
+
interface CarRental {
|
|
2398
|
+
/**
|
|
2399
|
+
* Affiliate details for this purchase.
|
|
2400
|
+
*/
|
|
2401
|
+
affiliate?: CarRental.Affiliate;
|
|
2402
|
+
/**
|
|
2403
|
+
* The booking number associated with the car rental.
|
|
2404
|
+
*/
|
|
2405
|
+
booking_number: string;
|
|
2406
|
+
/**
|
|
2407
|
+
* Class code of the car.
|
|
2408
|
+
*/
|
|
2409
|
+
car_class_code?: string;
|
|
2410
|
+
/**
|
|
2411
|
+
* Make of the car.
|
|
2412
|
+
*/
|
|
2413
|
+
car_make?: string;
|
|
2414
|
+
/**
|
|
2415
|
+
* Model of the car.
|
|
2416
|
+
*/
|
|
2417
|
+
car_model?: string;
|
|
2418
|
+
/**
|
|
2419
|
+
* The name of the rental car company.
|
|
2420
|
+
*/
|
|
2421
|
+
company?: string;
|
|
2422
|
+
/**
|
|
2423
|
+
* The customer service phone number of the car rental company.
|
|
2424
|
+
*/
|
|
2425
|
+
customer_service_phone_number?: string;
|
|
2426
|
+
/**
|
|
2427
|
+
* Number of days the car is being rented.
|
|
2428
|
+
*/
|
|
2429
|
+
days_rented: number;
|
|
2430
|
+
/**
|
|
2431
|
+
* Delivery details for this purchase.
|
|
2432
|
+
*/
|
|
2433
|
+
delivery?: CarRental.Delivery;
|
|
2434
|
+
/**
|
|
2435
|
+
* The details of the distance traveled during the rental period.
|
|
2436
|
+
*/
|
|
2437
|
+
distance?: CarRental.Distance;
|
|
2438
|
+
/**
|
|
2439
|
+
* The details of the passengers in the travel reservation
|
|
2440
|
+
*/
|
|
2441
|
+
drivers?: Array<CarRental.Driver>;
|
|
2442
|
+
/**
|
|
2443
|
+
* List of additional charges being billed.
|
|
2444
|
+
*/
|
|
2445
|
+
extra_charges?: Array<CarRental.ExtraCharge>;
|
|
2446
|
+
/**
|
|
2447
|
+
* Indicates if the customer did not keep nor cancel their booking.
|
|
2448
|
+
*/
|
|
2449
|
+
no_show?: boolean;
|
|
2450
|
+
/**
|
|
2451
|
+
* Car pick-up address.
|
|
2452
|
+
*/
|
|
2453
|
+
pickup_address?: AddressParam;
|
|
2454
|
+
/**
|
|
2455
|
+
* Car pick-up time. Measured in seconds since the Unix epoch.
|
|
2456
|
+
*/
|
|
2457
|
+
pickup_at: number;
|
|
2458
|
+
/**
|
|
2459
|
+
* Name of the pickup location.
|
|
2460
|
+
*/
|
|
2461
|
+
pickup_location_name?: string;
|
|
2462
|
+
/**
|
|
2463
|
+
* Rental rate.
|
|
2464
|
+
*/
|
|
2465
|
+
rate_amount?: number;
|
|
2466
|
+
/**
|
|
2467
|
+
* The frequency at which the rate amount is applied. One of `day`, `week` or `month`
|
|
2468
|
+
*/
|
|
2469
|
+
rate_interval?: CarRental.RateInterval;
|
|
2470
|
+
/**
|
|
2471
|
+
* The name of the person or entity renting the car.
|
|
2472
|
+
*/
|
|
2473
|
+
renter_name?: string;
|
|
2474
|
+
/**
|
|
2475
|
+
* Car return address.
|
|
2476
|
+
*/
|
|
2477
|
+
return_address?: AddressParam;
|
|
2478
|
+
/**
|
|
2479
|
+
* Car return time. Measured in seconds since the Unix epoch.
|
|
2480
|
+
*/
|
|
2481
|
+
return_at: number;
|
|
2482
|
+
/**
|
|
2483
|
+
* Name of the return location.
|
|
2484
|
+
*/
|
|
2485
|
+
return_location_name?: string;
|
|
2486
|
+
/**
|
|
2487
|
+
* Indicates whether the goods or services are tax-exempt or tax is not collected.
|
|
2488
|
+
*/
|
|
2489
|
+
tax_exempt?: boolean;
|
|
2490
|
+
/**
|
|
2491
|
+
* The vehicle identification number.
|
|
2492
|
+
*/
|
|
2493
|
+
vehicle_identification_number?: string;
|
|
2494
|
+
}
|
|
2495
|
+
interface CarRentalDatum {
|
|
2496
|
+
/**
|
|
2497
|
+
* Affiliate (such as travel agency) details for the rental.
|
|
2498
|
+
*/
|
|
2499
|
+
affiliate?: CarRentalDatum.Affiliate;
|
|
2500
|
+
/**
|
|
2501
|
+
* Booking confirmation number for the car rental.
|
|
2502
|
+
*/
|
|
2503
|
+
booking_number?: string;
|
|
2504
|
+
/**
|
|
2505
|
+
* Name of the car rental company.
|
|
2506
|
+
*/
|
|
2507
|
+
carrier_name?: string;
|
|
2508
|
+
/**
|
|
2509
|
+
* Customer service phone number for the car rental company.
|
|
2510
|
+
*/
|
|
2511
|
+
customer_service_phone_number?: string;
|
|
2512
|
+
/**
|
|
2513
|
+
* Number of days the car is being rented.
|
|
2514
|
+
*/
|
|
2515
|
+
days_rented?: number;
|
|
2516
|
+
/**
|
|
2517
|
+
* Distance details for the rental.
|
|
2518
|
+
*/
|
|
2519
|
+
distance?: CarRentalDatum.Distance;
|
|
2520
|
+
/**
|
|
2521
|
+
* List of drivers for the rental.
|
|
2522
|
+
*/
|
|
2523
|
+
drivers?: Array<CarRentalDatum.Driver>;
|
|
2524
|
+
/**
|
|
2525
|
+
* Drop-off location details.
|
|
2526
|
+
*/
|
|
2527
|
+
drop_off: CarRentalDatum.DropOff;
|
|
2528
|
+
/**
|
|
2529
|
+
* Insurance details for the rental.
|
|
2530
|
+
*/
|
|
2531
|
+
insurances?: Array<CarRentalDatum.Insurance>;
|
|
2532
|
+
/**
|
|
2533
|
+
* Indicates if the customer was a no-show.
|
|
2534
|
+
*/
|
|
2535
|
+
no_show_indicator?: boolean;
|
|
2536
|
+
/**
|
|
2537
|
+
* Pickup location details.
|
|
2538
|
+
*/
|
|
2539
|
+
pickup: CarRentalDatum.Pickup;
|
|
2540
|
+
/**
|
|
2541
|
+
* Name of the person renting the vehicle.
|
|
2542
|
+
*/
|
|
2543
|
+
renter_name?: string;
|
|
2544
|
+
/**
|
|
2545
|
+
* Total cost breakdown for the rental.
|
|
2546
|
+
*/
|
|
2547
|
+
total: CarRentalDatum.Total;
|
|
2548
|
+
/**
|
|
2549
|
+
* Vehicle details for the rental.
|
|
2550
|
+
*/
|
|
2551
|
+
vehicle?: CarRentalDatum.Vehicle;
|
|
2552
|
+
}
|
|
2553
|
+
interface EventDetails {
|
|
2554
|
+
/**
|
|
2555
|
+
* Indicates if the tickets are digitally checked when entering the venue.
|
|
2556
|
+
*/
|
|
2557
|
+
access_controlled_venue?: boolean;
|
|
2558
|
+
/**
|
|
2559
|
+
* The event location's address.
|
|
2560
|
+
*/
|
|
2561
|
+
address?: AddressParam;
|
|
2562
|
+
/**
|
|
2563
|
+
* Affiliate details for this purchase.
|
|
2564
|
+
*/
|
|
2565
|
+
affiliate?: EventDetails.Affiliate;
|
|
2566
|
+
/**
|
|
2567
|
+
* The name of the company
|
|
2568
|
+
*/
|
|
2569
|
+
company?: string;
|
|
2570
|
+
/**
|
|
2571
|
+
* Delivery details for this purchase.
|
|
2572
|
+
*/
|
|
2573
|
+
delivery?: EventDetails.Delivery;
|
|
2574
|
+
/**
|
|
2575
|
+
* Event end time. Measured in seconds since the Unix epoch.
|
|
2576
|
+
*/
|
|
2577
|
+
ends_at?: number;
|
|
2578
|
+
/**
|
|
2579
|
+
* Type of the event entertainment (concert, sports event etc)
|
|
2580
|
+
*/
|
|
2581
|
+
genre?: string;
|
|
2582
|
+
/**
|
|
2583
|
+
* The name of the event.
|
|
2584
|
+
*/
|
|
2585
|
+
name: string;
|
|
2586
|
+
/**
|
|
2587
|
+
* Event start time. Measured in seconds since the Unix epoch.
|
|
2588
|
+
*/
|
|
2589
|
+
starts_at?: number;
|
|
2590
|
+
}
|
|
2591
|
+
interface Flight {
|
|
2592
|
+
/**
|
|
2593
|
+
* Affiliate details for this purchase.
|
|
2594
|
+
*/
|
|
2595
|
+
affiliate?: Flight.Affiliate;
|
|
2596
|
+
/**
|
|
2597
|
+
* The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
|
|
2598
|
+
*/
|
|
2599
|
+
agency_number?: string;
|
|
2600
|
+
/**
|
|
2601
|
+
* The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
|
|
2602
|
+
*/
|
|
2603
|
+
carrier?: string;
|
|
2604
|
+
/**
|
|
2605
|
+
* Delivery details for this purchase.
|
|
2606
|
+
*/
|
|
2607
|
+
delivery?: Flight.Delivery;
|
|
2608
|
+
/**
|
|
2609
|
+
* The name of the person or entity on the reservation.
|
|
2610
|
+
*/
|
|
2611
|
+
passenger_name?: string;
|
|
2612
|
+
/**
|
|
2613
|
+
* The details of the passengers in the travel reservation.
|
|
2614
|
+
*/
|
|
2615
|
+
passengers?: Array<Flight.Passenger>;
|
|
2616
|
+
/**
|
|
2617
|
+
* The individual flight segments associated with the trip.
|
|
2618
|
+
*/
|
|
2619
|
+
segments: Array<Flight.Segment>;
|
|
2620
|
+
/**
|
|
2621
|
+
* The ticket number associated with the travel reservation.
|
|
2622
|
+
*/
|
|
2623
|
+
ticket_number?: string;
|
|
2624
|
+
}
|
|
2625
|
+
interface FlightDatum {
|
|
2626
|
+
/**
|
|
2627
|
+
* Affiliate details if applicable.
|
|
2628
|
+
*/
|
|
2629
|
+
affiliate?: FlightDatum.Affiliate;
|
|
2630
|
+
/**
|
|
2631
|
+
* Reservation reference.
|
|
2632
|
+
*/
|
|
2633
|
+
booking_number?: string;
|
|
2634
|
+
/**
|
|
2635
|
+
* Computerized reservation system used to make the reservation and purchase the ticket.
|
|
2636
|
+
*/
|
|
2637
|
+
computerized_reservation_system?: string;
|
|
2638
|
+
/**
|
|
2639
|
+
* Ticket restrictions.
|
|
2640
|
+
*/
|
|
2641
|
+
endorsements_and_restrictions?: string;
|
|
2642
|
+
/**
|
|
2643
|
+
* List of insurances.
|
|
2644
|
+
*/
|
|
2645
|
+
insurances?: Array<FlightDatum.Insurance>;
|
|
2646
|
+
/**
|
|
2647
|
+
* List of passengers.
|
|
2648
|
+
*/
|
|
2649
|
+
passengers?: Array<FlightDatum.Passenger>;
|
|
2650
|
+
/**
|
|
2651
|
+
* List of flight segments.
|
|
2652
|
+
*/
|
|
2653
|
+
segments: Array<FlightDatum.Segment>;
|
|
2654
|
+
/**
|
|
2655
|
+
* Electronic ticket indicator.
|
|
2656
|
+
*/
|
|
2657
|
+
ticket_electronically_issued_indicator?: boolean;
|
|
2658
|
+
/**
|
|
2659
|
+
* Total cost breakdown.
|
|
2660
|
+
*/
|
|
2661
|
+
total: FlightDatum.Total;
|
|
2662
|
+
/**
|
|
2663
|
+
* Type of flight transaction.
|
|
2664
|
+
*/
|
|
2665
|
+
transaction_type?: FlightDatum.TransactionType;
|
|
2666
|
+
}
|
|
2667
|
+
interface Lodging {
|
|
2668
|
+
/**
|
|
2669
|
+
* The lodging location's address.
|
|
2670
|
+
*/
|
|
2671
|
+
address?: AddressParam;
|
|
2672
|
+
/**
|
|
2673
|
+
* The number of adults on the booking
|
|
2674
|
+
*/
|
|
2675
|
+
adults?: number;
|
|
2676
|
+
/**
|
|
2677
|
+
* Affiliate details for this purchase.
|
|
2678
|
+
*/
|
|
2679
|
+
affiliate?: Lodging.Affiliate;
|
|
2680
|
+
/**
|
|
2681
|
+
* The booking number associated with the lodging reservation.
|
|
2682
|
+
*/
|
|
2683
|
+
booking_number?: string;
|
|
2684
|
+
/**
|
|
2685
|
+
* The lodging category
|
|
2686
|
+
*/
|
|
2687
|
+
category?: Lodging.Category;
|
|
2688
|
+
/**
|
|
2689
|
+
* Lodging check-in time. Measured in seconds since the Unix epoch.
|
|
2690
|
+
*/
|
|
2691
|
+
checkin_at: number;
|
|
2692
|
+
/**
|
|
2693
|
+
* Lodging check-out time. Measured in seconds since the Unix epoch.
|
|
2694
|
+
*/
|
|
2695
|
+
checkout_at: number;
|
|
2696
|
+
/**
|
|
2697
|
+
* The customer service phone number of the lodging company.
|
|
2698
|
+
*/
|
|
2699
|
+
customer_service_phone_number?: string;
|
|
2700
|
+
/**
|
|
2701
|
+
* The daily lodging room rate.
|
|
2702
|
+
*/
|
|
2703
|
+
daily_room_rate_amount?: number;
|
|
2704
|
+
/**
|
|
2705
|
+
* Delivery details for this purchase.
|
|
2706
|
+
*/
|
|
2707
|
+
delivery?: Lodging.Delivery;
|
|
2708
|
+
/**
|
|
2709
|
+
* List of additional charges being billed.
|
|
2710
|
+
*/
|
|
2711
|
+
extra_charges?: Array<Lodging.ExtraCharge>;
|
|
2712
|
+
/**
|
|
2713
|
+
* Indicates whether the lodging location is compliant with the Fire Safety Act.
|
|
2714
|
+
*/
|
|
2715
|
+
fire_safety_act_compliance?: boolean;
|
|
2716
|
+
/**
|
|
2717
|
+
* The name of the lodging location.
|
|
2718
|
+
*/
|
|
2719
|
+
name?: string;
|
|
2720
|
+
/**
|
|
2721
|
+
* Indicates if the customer did not keep their booking while failing to cancel the reservation.
|
|
2722
|
+
*/
|
|
2723
|
+
no_show?: boolean;
|
|
2724
|
+
/**
|
|
2725
|
+
* The number of rooms on the booking
|
|
2726
|
+
*/
|
|
2727
|
+
number_of_rooms?: number;
|
|
2728
|
+
/**
|
|
2729
|
+
* The details of the passengers in the travel reservation
|
|
2730
|
+
*/
|
|
2731
|
+
passengers?: Array<Lodging.Passenger>;
|
|
2732
|
+
/**
|
|
2733
|
+
* The phone number of the lodging location.
|
|
2734
|
+
*/
|
|
2735
|
+
property_phone_number?: string;
|
|
2736
|
+
/**
|
|
2737
|
+
* The room class for this purchase.
|
|
2738
|
+
*/
|
|
2739
|
+
room_class?: string;
|
|
2740
|
+
/**
|
|
2741
|
+
* The number of room nights
|
|
2742
|
+
*/
|
|
2743
|
+
room_nights?: number;
|
|
2744
|
+
/**
|
|
2745
|
+
* The total tax amount associating with the room reservation.
|
|
2746
|
+
*/
|
|
2747
|
+
total_room_tax_amount?: number;
|
|
2748
|
+
/**
|
|
2749
|
+
* The total tax amount
|
|
2750
|
+
*/
|
|
2751
|
+
total_tax_amount?: number;
|
|
2752
|
+
}
|
|
2753
|
+
interface LodgingDatum {
|
|
2754
|
+
/**
|
|
2755
|
+
* Accommodation details for the lodging.
|
|
2756
|
+
*/
|
|
2757
|
+
accommodation?: LodgingDatum.Accommodation;
|
|
2758
|
+
/**
|
|
2759
|
+
* Affiliate details if applicable.
|
|
2760
|
+
*/
|
|
2761
|
+
affiliate?: LodgingDatum.Affiliate;
|
|
2762
|
+
/**
|
|
2763
|
+
* Booking confirmation number for the lodging.
|
|
2764
|
+
*/
|
|
2765
|
+
booking_number?: string;
|
|
2766
|
+
/**
|
|
2767
|
+
* Check-in date.
|
|
2768
|
+
*/
|
|
2769
|
+
checkin_at: number;
|
|
2770
|
+
/**
|
|
2771
|
+
* Check-out date.
|
|
2772
|
+
*/
|
|
2773
|
+
checkout_at: number;
|
|
2774
|
+
/**
|
|
2775
|
+
* Customer service phone number for the lodging company.
|
|
2776
|
+
*/
|
|
2777
|
+
customer_service_phone_number?: string;
|
|
2778
|
+
/**
|
|
2779
|
+
* Whether the lodging is compliant with any hotel fire safety regulations.
|
|
2780
|
+
*/
|
|
2781
|
+
fire_safety_act_compliance_indicator?: boolean;
|
|
2782
|
+
/**
|
|
2783
|
+
* List of guests for the lodging.
|
|
2784
|
+
*/
|
|
2785
|
+
guests?: Array<LodgingDatum.Guest>;
|
|
2786
|
+
/**
|
|
2787
|
+
* Host details for the lodging.
|
|
2788
|
+
*/
|
|
2789
|
+
host?: LodgingDatum.Host;
|
|
2790
|
+
/**
|
|
2791
|
+
* List of insurances for the lodging.
|
|
2792
|
+
*/
|
|
2793
|
+
insurances?: Array<LodgingDatum.Insurance>;
|
|
2794
|
+
/**
|
|
2795
|
+
* Whether the renter is a no-show.
|
|
2796
|
+
*/
|
|
2797
|
+
no_show_indicator?: boolean;
|
|
2798
|
+
/**
|
|
2799
|
+
* Renter ID number for the lodging.
|
|
2800
|
+
*/
|
|
2801
|
+
renter_id_number?: string;
|
|
2802
|
+
/**
|
|
2803
|
+
* Renter name for the lodging.
|
|
2804
|
+
*/
|
|
2805
|
+
renter_name?: string;
|
|
2806
|
+
/**
|
|
2807
|
+
* Total details for the lodging.
|
|
2808
|
+
*/
|
|
2809
|
+
total: LodgingDatum.Total;
|
|
2810
|
+
}
|
|
2811
|
+
interface Subscription {
|
|
2812
|
+
/**
|
|
2813
|
+
* Affiliate details for this purchase.
|
|
2814
|
+
*/
|
|
2815
|
+
affiliate?: Subscription.Affiliate;
|
|
2816
|
+
/**
|
|
2817
|
+
* Info whether the subscription will be auto renewed upon expiry.
|
|
2818
|
+
*/
|
|
2819
|
+
auto_renewal?: boolean;
|
|
2820
|
+
/**
|
|
2821
|
+
* Subscription billing details for this purchase.
|
|
2822
|
+
*/
|
|
2823
|
+
billing_interval?: Subscription.BillingInterval;
|
|
2824
|
+
/**
|
|
2825
|
+
* Subscription end time. Measured in seconds since the Unix epoch.
|
|
2826
|
+
*/
|
|
2827
|
+
ends_at?: number;
|
|
2828
|
+
/**
|
|
2829
|
+
* Name of the product on subscription. e.g. Apple Music Subscription
|
|
2830
|
+
*/
|
|
2831
|
+
name: string;
|
|
2832
|
+
/**
|
|
2833
|
+
* Subscription start time. Measured in seconds since the Unix epoch.
|
|
2834
|
+
*/
|
|
2835
|
+
starts_at?: number;
|
|
2836
|
+
}
|
|
2837
|
+
namespace CarRental {
|
|
2838
|
+
interface Affiliate {
|
|
2839
|
+
/**
|
|
2840
|
+
* The name of the affiliate that originated the purchase.
|
|
2841
|
+
*/
|
|
2842
|
+
name: string;
|
|
2843
|
+
}
|
|
2844
|
+
interface Delivery {
|
|
2845
|
+
/**
|
|
2846
|
+
* The delivery method for the payment
|
|
2847
|
+
*/
|
|
2848
|
+
mode?: Delivery.Mode;
|
|
2849
|
+
/**
|
|
2850
|
+
* Details of the recipient.
|
|
2851
|
+
*/
|
|
2852
|
+
recipient?: Delivery.Recipient;
|
|
2853
|
+
}
|
|
2854
|
+
interface Distance {
|
|
2855
|
+
/**
|
|
2856
|
+
* Distance traveled.
|
|
2857
|
+
*/
|
|
2858
|
+
amount?: number;
|
|
2859
|
+
/**
|
|
2860
|
+
* Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
|
|
2861
|
+
*/
|
|
2862
|
+
unit?: Distance.Unit;
|
|
2863
|
+
}
|
|
2864
|
+
interface Driver {
|
|
2865
|
+
/**
|
|
2866
|
+
* Driver's identification number.
|
|
2867
|
+
*/
|
|
2868
|
+
driver_identification_number?: string;
|
|
2869
|
+
/**
|
|
2870
|
+
* Driver's tax number.
|
|
2871
|
+
*/
|
|
2872
|
+
driver_tax_number?: string;
|
|
2873
|
+
/**
|
|
2874
|
+
* Full name of the person or entity on the car reservation.
|
|
2875
|
+
*/
|
|
2876
|
+
name: string;
|
|
2877
|
+
}
|
|
2878
|
+
type ExtraCharge = 'extra_mileage' | 'gas' | 'late_return' | 'one_way_service' | 'parking_violation';
|
|
2879
|
+
type RateInterval = 'day' | 'month' | 'week';
|
|
2880
|
+
namespace Delivery {
|
|
2881
|
+
type Mode = 'email' | 'phone' | 'pickup' | 'post';
|
|
2882
|
+
interface Recipient {
|
|
2883
|
+
/**
|
|
2884
|
+
* The email of the recipient the ticket is delivered to.
|
|
2885
|
+
*/
|
|
2886
|
+
email?: string;
|
|
2887
|
+
/**
|
|
2888
|
+
* The name of the recipient the ticket is delivered to.
|
|
2889
|
+
*/
|
|
2890
|
+
name?: string;
|
|
2891
|
+
/**
|
|
2892
|
+
* The phone number of the recipient the ticket is delivered to.
|
|
2893
|
+
*/
|
|
2894
|
+
phone?: string;
|
|
2895
|
+
}
|
|
2896
|
+
}
|
|
2897
|
+
namespace Distance {
|
|
2898
|
+
type Unit = 'kilometers' | 'miles';
|
|
2899
|
+
}
|
|
2900
|
+
}
|
|
2901
|
+
namespace CarRentalDatum {
|
|
2902
|
+
interface Affiliate {
|
|
2903
|
+
/**
|
|
2904
|
+
* Affiliate partner code.
|
|
2905
|
+
*/
|
|
2906
|
+
code?: string;
|
|
2907
|
+
/**
|
|
2908
|
+
* Name of affiliate partner.
|
|
2909
|
+
*/
|
|
2910
|
+
name?: string;
|
|
2911
|
+
}
|
|
2912
|
+
interface Distance {
|
|
2913
|
+
/**
|
|
2914
|
+
* Distance traveled.
|
|
2915
|
+
*/
|
|
2916
|
+
amount: number;
|
|
2917
|
+
/**
|
|
2918
|
+
* Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
|
|
2919
|
+
*/
|
|
2920
|
+
unit: Distance.Unit;
|
|
2921
|
+
}
|
|
2922
|
+
interface Driver {
|
|
2923
|
+
/**
|
|
2924
|
+
* Driver's date of birth.
|
|
2925
|
+
*/
|
|
2926
|
+
date_of_birth?: Driver.DateOfBirth;
|
|
2927
|
+
/**
|
|
2928
|
+
* Driver's identification number.
|
|
2929
|
+
*/
|
|
2930
|
+
driver_identification_number?: string;
|
|
2931
|
+
/**
|
|
2932
|
+
* Driver's tax number.
|
|
2933
|
+
*/
|
|
2934
|
+
driver_tax_number?: string;
|
|
2935
|
+
/**
|
|
2936
|
+
* Driver's full name.
|
|
2937
|
+
*/
|
|
2938
|
+
name: string;
|
|
2939
|
+
}
|
|
2940
|
+
interface DropOff {
|
|
2941
|
+
/**
|
|
2942
|
+
* Address of the rental location.
|
|
2943
|
+
*/
|
|
2944
|
+
address: DropOff.Address;
|
|
2945
|
+
/**
|
|
2946
|
+
* Location name.
|
|
2947
|
+
*/
|
|
2948
|
+
location_name?: string;
|
|
2949
|
+
/**
|
|
2950
|
+
* Timestamp for the location.
|
|
2951
|
+
*/
|
|
2952
|
+
time: number;
|
|
2953
|
+
}
|
|
2954
|
+
interface Insurance {
|
|
2955
|
+
/**
|
|
2956
|
+
* Amount of the insurance coverage in cents.
|
|
2957
|
+
*/
|
|
2958
|
+
amount: number;
|
|
2959
|
+
/**
|
|
2960
|
+
* Currency of the insurance amount.
|
|
2961
|
+
*/
|
|
2962
|
+
currency?: string;
|
|
2963
|
+
/**
|
|
2964
|
+
* Name of the insurance company.
|
|
2965
|
+
*/
|
|
2966
|
+
insurance_company_name?: string;
|
|
2967
|
+
/**
|
|
2968
|
+
* Type of insurance coverage.
|
|
2969
|
+
*/
|
|
2970
|
+
insurance_type: Insurance.InsuranceType;
|
|
2971
|
+
}
|
|
2972
|
+
interface Pickup {
|
|
2973
|
+
/**
|
|
2974
|
+
* Address of the rental location.
|
|
2975
|
+
*/
|
|
2976
|
+
address: Pickup.Address;
|
|
2977
|
+
/**
|
|
2978
|
+
* Location name.
|
|
2979
|
+
*/
|
|
2980
|
+
location_name?: string;
|
|
2981
|
+
/**
|
|
2982
|
+
* Timestamp for the location.
|
|
2983
|
+
*/
|
|
2984
|
+
time: number;
|
|
2985
|
+
}
|
|
2986
|
+
interface Total {
|
|
2987
|
+
/**
|
|
2988
|
+
* Total amount in cents.
|
|
2989
|
+
*/
|
|
2990
|
+
amount: number;
|
|
2991
|
+
/**
|
|
2992
|
+
* Currency of the amount.
|
|
2993
|
+
*/
|
|
2994
|
+
currency?: string;
|
|
2995
|
+
/**
|
|
2996
|
+
* Discount details for the rental.
|
|
2997
|
+
*/
|
|
2998
|
+
discounts?: Total.Discounts;
|
|
2999
|
+
/**
|
|
3000
|
+
* Additional charges for the rental.
|
|
3001
|
+
*/
|
|
3002
|
+
extra_charges?: Array<Total.ExtraCharge>;
|
|
3003
|
+
/**
|
|
3004
|
+
* Rate per unit for the rental.
|
|
3005
|
+
*/
|
|
3006
|
+
rate_per_unit?: number;
|
|
3007
|
+
/**
|
|
3008
|
+
* Unit of measurement for the rate.
|
|
3009
|
+
*/
|
|
3010
|
+
rate_unit?: Total.RateUnit;
|
|
3011
|
+
/**
|
|
3012
|
+
* Tax breakdown for the rental.
|
|
3013
|
+
*/
|
|
3014
|
+
tax?: Total.Tax;
|
|
3015
|
+
}
|
|
3016
|
+
interface Vehicle {
|
|
3017
|
+
/**
|
|
3018
|
+
* Make of the rental vehicle.
|
|
3019
|
+
*/
|
|
3020
|
+
make?: string;
|
|
3021
|
+
/**
|
|
3022
|
+
* Model of the rental vehicle.
|
|
3023
|
+
*/
|
|
3024
|
+
model?: string;
|
|
3025
|
+
/**
|
|
3026
|
+
* Odometer reading at the time of rental.
|
|
3027
|
+
*/
|
|
3028
|
+
odometer?: number;
|
|
3029
|
+
/**
|
|
3030
|
+
* Type of the rental vehicle.
|
|
3031
|
+
*/
|
|
3032
|
+
type?: Vehicle.Type;
|
|
3033
|
+
/**
|
|
3034
|
+
* Class of the rental vehicle.
|
|
3035
|
+
*/
|
|
3036
|
+
vehicle_class?: Vehicle.VehicleClass;
|
|
3037
|
+
/**
|
|
3038
|
+
* Vehicle identification number (VIN).
|
|
3039
|
+
*/
|
|
3040
|
+
vehicle_identification_number?: string;
|
|
3041
|
+
}
|
|
3042
|
+
namespace Distance {
|
|
3043
|
+
type Unit = 'kilometers' | 'miles';
|
|
3044
|
+
}
|
|
3045
|
+
namespace Driver {
|
|
3046
|
+
interface DateOfBirth {
|
|
3047
|
+
/**
|
|
3048
|
+
* Day of birth (1-31).
|
|
3049
|
+
*/
|
|
3050
|
+
day: number;
|
|
3051
|
+
/**
|
|
3052
|
+
* Month of birth (1-12).
|
|
3053
|
+
*/
|
|
3054
|
+
month: number;
|
|
3055
|
+
/**
|
|
3056
|
+
* Year of birth (must be greater than 1900).
|
|
3057
|
+
*/
|
|
3058
|
+
year: number;
|
|
3059
|
+
}
|
|
3060
|
+
}
|
|
3061
|
+
namespace DropOff {
|
|
3062
|
+
interface Address {
|
|
3063
|
+
/**
|
|
3064
|
+
* City, district, suburb, town, or village.
|
|
3065
|
+
*/
|
|
3066
|
+
city: string;
|
|
3067
|
+
/**
|
|
3068
|
+
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
3069
|
+
*/
|
|
3070
|
+
country: string;
|
|
3071
|
+
/**
|
|
3072
|
+
* Address line 1, such as the street, PO Box, or company name.
|
|
3073
|
+
*/
|
|
3074
|
+
line1: string;
|
|
3075
|
+
/**
|
|
3076
|
+
* Address line 2, such as the apartment, suite, unit, or building.
|
|
3077
|
+
*/
|
|
3078
|
+
line2?: string;
|
|
3079
|
+
/**
|
|
3080
|
+
* ZIP or postal code.
|
|
3081
|
+
*/
|
|
3082
|
+
postal_code: string;
|
|
3083
|
+
/**
|
|
3084
|
+
* State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
3085
|
+
*/
|
|
3086
|
+
state?: string;
|
|
3087
|
+
}
|
|
3088
|
+
}
|
|
3089
|
+
namespace Insurance {
|
|
3090
|
+
type InsuranceType = 'liability_supplement' | 'loss_damage_waiver' | 'other' | 'partial_damage_waiver' | 'personal_accident' | 'personal_effects';
|
|
3091
|
+
}
|
|
3092
|
+
namespace Pickup {
|
|
3093
|
+
interface Address {
|
|
3094
|
+
/**
|
|
3095
|
+
* City, district, suburb, town, or village.
|
|
3096
|
+
*/
|
|
3097
|
+
city: string;
|
|
3098
|
+
/**
|
|
3099
|
+
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
3100
|
+
*/
|
|
3101
|
+
country: string;
|
|
3102
|
+
/**
|
|
3103
|
+
* Address line 1, such as the street, PO Box, or company name.
|
|
3104
|
+
*/
|
|
3105
|
+
line1: string;
|
|
3106
|
+
/**
|
|
3107
|
+
* Address line 2, such as the apartment, suite, unit, or building.
|
|
3108
|
+
*/
|
|
3109
|
+
line2?: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* ZIP or postal code.
|
|
3112
|
+
*/
|
|
3113
|
+
postal_code: string;
|
|
3114
|
+
/**
|
|
3115
|
+
* State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
3116
|
+
*/
|
|
3117
|
+
state?: string;
|
|
3118
|
+
}
|
|
3119
|
+
}
|
|
3120
|
+
namespace Total {
|
|
3121
|
+
interface Discounts {
|
|
3122
|
+
/**
|
|
3123
|
+
* Corporate client discount code.
|
|
3124
|
+
*/
|
|
3125
|
+
corporate_client_code?: string;
|
|
3126
|
+
/**
|
|
3127
|
+
* Coupon code applied to the rental.
|
|
3128
|
+
*/
|
|
3129
|
+
coupon?: string;
|
|
3130
|
+
/**
|
|
3131
|
+
* Maximum number of free miles or kilometers included.
|
|
3132
|
+
*/
|
|
3133
|
+
maximum_free_miles_or_kilometers?: number;
|
|
3134
|
+
}
|
|
3135
|
+
interface ExtraCharge {
|
|
3136
|
+
/**
|
|
3137
|
+
* Amount of the extra charge in cents.
|
|
3138
|
+
*/
|
|
3139
|
+
amount: number;
|
|
3140
|
+
/**
|
|
3141
|
+
* Type of extra charge.
|
|
3142
|
+
*/
|
|
3143
|
+
type: ExtraCharge.Type;
|
|
3144
|
+
}
|
|
3145
|
+
type RateUnit = 'days' | 'kilometers' | 'miles' | 'months' | 'weeks';
|
|
3146
|
+
interface Tax {
|
|
3147
|
+
/**
|
|
3148
|
+
* Indicates if the transaction is tax exempt.
|
|
3149
|
+
*/
|
|
3150
|
+
tax_exempt_indicator?: boolean;
|
|
3151
|
+
/**
|
|
3152
|
+
* Array of tax details.
|
|
3153
|
+
*/
|
|
3154
|
+
taxes?: Array<Tax.Tax>;
|
|
3155
|
+
}
|
|
3156
|
+
namespace ExtraCharge {
|
|
3157
|
+
type Type = 'extra_mileage' | 'gas' | 'gps' | 'late_charge' | 'one_way_drop_off' | 'other' | 'parking' | 'phone' | 'regular_mileage' | 'towing';
|
|
3158
|
+
}
|
|
3159
|
+
namespace Tax {
|
|
3160
|
+
interface Tax {
|
|
3161
|
+
/**
|
|
3162
|
+
* Tax amount.
|
|
3163
|
+
*/
|
|
3164
|
+
amount?: number;
|
|
3165
|
+
/**
|
|
3166
|
+
* Tax rate applied.
|
|
3167
|
+
*/
|
|
3168
|
+
rate?: number;
|
|
3169
|
+
/**
|
|
3170
|
+
* Type of tax applied.
|
|
3171
|
+
*/
|
|
3172
|
+
type?: string;
|
|
3173
|
+
}
|
|
3174
|
+
}
|
|
3175
|
+
}
|
|
3176
|
+
namespace Vehicle {
|
|
3177
|
+
type Type = 'cargo_van' | 'compact' | 'economy' | 'exotic' | 'exotic_suv' | 'fifteen_passenger_van' | 'four_wheel_drive' | 'full_size' | 'intermediate' | 'large_suv' | 'large_truck' | 'luxury' | 'medium_suv' | 'midsize' | 'mini' | 'minivan' | 'miscellaneous' | 'moped' | 'moving_van' | 'premium' | 'regular' | 'small_medium_truck' | 'small_suv' | 'special' | 'standard' | 'stretch' | 'subcompact' | 'taxi' | 'twelve_foot_truck' | 'twelve_passenger_van' | 'twenty_foot_truck' | 'twenty_four_foot_truck' | 'twenty_six_foot_truck' | 'unique';
|
|
3178
|
+
type VehicleClass = 'business' | 'economy' | 'first_class' | 'premium_economy';
|
|
3179
|
+
}
|
|
3180
|
+
}
|
|
3181
|
+
namespace EventDetails {
|
|
3182
|
+
interface Affiliate {
|
|
3183
|
+
/**
|
|
3184
|
+
* The name of the affiliate that originated the purchase.
|
|
3185
|
+
*/
|
|
3186
|
+
name: string;
|
|
3187
|
+
}
|
|
3188
|
+
interface Delivery {
|
|
3189
|
+
/**
|
|
3190
|
+
* The delivery method for the payment
|
|
3191
|
+
*/
|
|
3192
|
+
mode?: Delivery.Mode;
|
|
3193
|
+
/**
|
|
3194
|
+
* Details of the recipient.
|
|
3195
|
+
*/
|
|
3196
|
+
recipient?: Delivery.Recipient;
|
|
3197
|
+
}
|
|
3198
|
+
namespace Delivery {
|
|
3199
|
+
type Mode = 'email' | 'phone' | 'pickup' | 'post';
|
|
3200
|
+
interface Recipient {
|
|
3201
|
+
/**
|
|
3202
|
+
* The email of the recipient the ticket is delivered to.
|
|
3203
|
+
*/
|
|
3204
|
+
email?: string;
|
|
3205
|
+
/**
|
|
3206
|
+
* The name of the recipient the ticket is delivered to.
|
|
3207
|
+
*/
|
|
3208
|
+
name?: string;
|
|
3209
|
+
/**
|
|
3210
|
+
* The phone number of the recipient the ticket is delivered to.
|
|
3211
|
+
*/
|
|
3212
|
+
phone?: string;
|
|
3213
|
+
}
|
|
3214
|
+
}
|
|
3215
|
+
}
|
|
3216
|
+
namespace Flight {
|
|
3217
|
+
interface Affiliate {
|
|
3218
|
+
/**
|
|
3219
|
+
* The name of the affiliate that originated the purchase.
|
|
3220
|
+
*/
|
|
3221
|
+
name: string;
|
|
3222
|
+
}
|
|
3223
|
+
interface Delivery {
|
|
3224
|
+
/**
|
|
3225
|
+
* The delivery method for the payment
|
|
3226
|
+
*/
|
|
3227
|
+
mode?: Delivery.Mode;
|
|
3228
|
+
/**
|
|
3229
|
+
* Details of the recipient.
|
|
3230
|
+
*/
|
|
3231
|
+
recipient?: Delivery.Recipient;
|
|
3232
|
+
}
|
|
3233
|
+
interface Passenger {
|
|
3234
|
+
/**
|
|
3235
|
+
* Full name of the person or entity on the flight reservation.
|
|
3236
|
+
*/
|
|
3237
|
+
name: string;
|
|
3238
|
+
}
|
|
3239
|
+
interface Segment {
|
|
3240
|
+
/**
|
|
3241
|
+
* The flight segment amount.
|
|
3242
|
+
*/
|
|
3243
|
+
amount?: number;
|
|
3244
|
+
/**
|
|
3245
|
+
* The International Air Transport Association (IATA) airport code for the arrival airport.
|
|
3246
|
+
*/
|
|
3247
|
+
arrival_airport?: string;
|
|
3248
|
+
/**
|
|
3249
|
+
* The arrival time for the flight segment. Measured in seconds since the Unix epoch.
|
|
3250
|
+
*/
|
|
3251
|
+
arrives_at?: number;
|
|
3252
|
+
/**
|
|
3253
|
+
* The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
|
|
3254
|
+
*/
|
|
3255
|
+
carrier?: string;
|
|
3256
|
+
/**
|
|
3257
|
+
* The departure time for the flight segment. Measured in seconds since the Unix epoch.
|
|
3258
|
+
*/
|
|
3259
|
+
departs_at: number;
|
|
3260
|
+
/**
|
|
3261
|
+
* The International Air Transport Association (IATA) airport code for the departure airport.
|
|
3262
|
+
*/
|
|
3263
|
+
departure_airport?: string;
|
|
3264
|
+
/**
|
|
3265
|
+
* The flight number associated with the segment
|
|
3266
|
+
*/
|
|
3267
|
+
flight_number?: string;
|
|
3268
|
+
/**
|
|
3269
|
+
* The fare class for the segment.
|
|
3270
|
+
*/
|
|
3271
|
+
service_class?: Segment.ServiceClass;
|
|
3272
|
+
}
|
|
3273
|
+
namespace Delivery {
|
|
3274
|
+
type Mode = 'email' | 'phone' | 'pickup' | 'post';
|
|
3275
|
+
interface Recipient {
|
|
3276
|
+
/**
|
|
3277
|
+
* The email of the recipient the ticket is delivered to.
|
|
3278
|
+
*/
|
|
3279
|
+
email?: string;
|
|
3280
|
+
/**
|
|
3281
|
+
* The name of the recipient the ticket is delivered to.
|
|
3282
|
+
*/
|
|
3283
|
+
name?: string;
|
|
3284
|
+
/**
|
|
3285
|
+
* The phone number of the recipient the ticket is delivered to.
|
|
3286
|
+
*/
|
|
3287
|
+
phone?: string;
|
|
3288
|
+
}
|
|
3289
|
+
}
|
|
3290
|
+
namespace Segment {
|
|
3291
|
+
type ServiceClass = 'business' | 'economy' | 'first' | 'premium_economy';
|
|
3292
|
+
}
|
|
3293
|
+
}
|
|
3294
|
+
namespace FlightDatum {
|
|
3295
|
+
interface Affiliate {
|
|
3296
|
+
/**
|
|
3297
|
+
* Affiliate partner code.
|
|
3298
|
+
*/
|
|
3299
|
+
code?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* Name of affiliate partner.
|
|
3302
|
+
*/
|
|
3303
|
+
name?: string;
|
|
3304
|
+
/**
|
|
3305
|
+
* Code provided by the company to a travel agent authorizing ticket issuance.
|
|
3306
|
+
*/
|
|
3307
|
+
travel_authorization_code?: string;
|
|
3308
|
+
}
|
|
3309
|
+
interface Insurance {
|
|
3310
|
+
/**
|
|
3311
|
+
* Insurance cost.
|
|
3312
|
+
*/
|
|
3313
|
+
amount: number;
|
|
3314
|
+
/**
|
|
3315
|
+
* Insurance currency.
|
|
3316
|
+
*/
|
|
3317
|
+
currency?: string;
|
|
3318
|
+
/**
|
|
3319
|
+
* Insurance company name.
|
|
3320
|
+
*/
|
|
3321
|
+
insurance_company_name?: string;
|
|
3322
|
+
/**
|
|
3323
|
+
* Type of insurance.
|
|
3324
|
+
*/
|
|
3325
|
+
insurance_type: Insurance.InsuranceType;
|
|
3326
|
+
}
|
|
3327
|
+
interface Passenger {
|
|
3328
|
+
/**
|
|
3329
|
+
* Passenger's full name.
|
|
3330
|
+
*/
|
|
3331
|
+
name: string;
|
|
3332
|
+
}
|
|
3333
|
+
interface Segment {
|
|
3334
|
+
/**
|
|
3335
|
+
* Segment fare amount.
|
|
3336
|
+
*/
|
|
3337
|
+
amount?: number;
|
|
3338
|
+
/**
|
|
3339
|
+
* Arrival details.
|
|
3340
|
+
*/
|
|
3341
|
+
arrival: Segment.Arrival;
|
|
3342
|
+
/**
|
|
3343
|
+
* Airline carrier code.
|
|
3344
|
+
*/
|
|
3345
|
+
carrier_code: string;
|
|
3346
|
+
/**
|
|
3347
|
+
* Carrier name.
|
|
3348
|
+
*/
|
|
3349
|
+
carrier_name?: string;
|
|
3350
|
+
/**
|
|
3351
|
+
* Segment currency.
|
|
3352
|
+
*/
|
|
3353
|
+
currency?: string;
|
|
3354
|
+
/**
|
|
3355
|
+
* Departure details.
|
|
3356
|
+
*/
|
|
3357
|
+
departure: Segment.Departure;
|
|
3358
|
+
/**
|
|
3359
|
+
* Exchange ticket number.
|
|
3360
|
+
*/
|
|
3361
|
+
exchange_ticket_number?: string;
|
|
3362
|
+
/**
|
|
3363
|
+
* Fare basis code.
|
|
3364
|
+
*/
|
|
3365
|
+
fare_basis_code?: string;
|
|
3366
|
+
/**
|
|
3367
|
+
* Additional fees.
|
|
3368
|
+
*/
|
|
3369
|
+
fees?: number;
|
|
3370
|
+
/**
|
|
3371
|
+
* Flight number.
|
|
3372
|
+
*/
|
|
3373
|
+
flight_number?: string;
|
|
3374
|
+
/**
|
|
3375
|
+
* Stopover indicator.
|
|
3376
|
+
*/
|
|
3377
|
+
is_stop_over_indicator?: boolean;
|
|
3378
|
+
/**
|
|
3379
|
+
* Refundable ticket indicator.
|
|
3380
|
+
*/
|
|
3381
|
+
refundable?: boolean;
|
|
3382
|
+
/**
|
|
3383
|
+
* Class of service.
|
|
3384
|
+
*/
|
|
3385
|
+
service_class: Segment.ServiceClass;
|
|
3386
|
+
/**
|
|
3387
|
+
* Tax amount for segment.
|
|
3388
|
+
*/
|
|
3389
|
+
tax_amount?: number;
|
|
3390
|
+
/**
|
|
3391
|
+
* Ticket number.
|
|
3392
|
+
*/
|
|
3393
|
+
ticket_number?: string;
|
|
3394
|
+
}
|
|
3395
|
+
interface Total {
|
|
3396
|
+
/**
|
|
3397
|
+
* Total flight amount.
|
|
3398
|
+
*/
|
|
3399
|
+
amount: number;
|
|
3400
|
+
/**
|
|
3401
|
+
* Reason for credit.
|
|
3402
|
+
*/
|
|
3403
|
+
credit_reason?: Total.CreditReason;
|
|
3404
|
+
/**
|
|
3405
|
+
* Total currency.
|
|
3406
|
+
*/
|
|
3407
|
+
currency?: string;
|
|
3408
|
+
/**
|
|
3409
|
+
* Discount details.
|
|
3410
|
+
*/
|
|
3411
|
+
discounts?: Total.Discounts;
|
|
3412
|
+
/**
|
|
3413
|
+
* Additional charges.
|
|
3414
|
+
*/
|
|
3415
|
+
extra_charges?: Array<Total.ExtraCharge>;
|
|
3416
|
+
/**
|
|
3417
|
+
* Tax breakdown.
|
|
3418
|
+
*/
|
|
3419
|
+
tax?: Total.Tax;
|
|
3420
|
+
}
|
|
3421
|
+
type TransactionType = 'exchange_ticket' | 'miscellaneous' | 'refund' | 'ticket_purchase';
|
|
3422
|
+
namespace Insurance {
|
|
3423
|
+
type InsuranceType = 'baggage' | 'bankruptcy' | 'cancelation' | 'emergency' | 'medical';
|
|
3424
|
+
}
|
|
3425
|
+
namespace Segment {
|
|
3426
|
+
interface Arrival {
|
|
3427
|
+
/**
|
|
3428
|
+
* Arrival airport IATA code.
|
|
3429
|
+
*/
|
|
3430
|
+
airport: string;
|
|
3431
|
+
/**
|
|
3432
|
+
* Arrival date/time.
|
|
3433
|
+
*/
|
|
3434
|
+
arrives_at?: number;
|
|
3435
|
+
/**
|
|
3436
|
+
* Arrival city.
|
|
3437
|
+
*/
|
|
3438
|
+
city?: string;
|
|
3439
|
+
/**
|
|
3440
|
+
* Arrival country.
|
|
3441
|
+
*/
|
|
3442
|
+
country?: string;
|
|
3443
|
+
}
|
|
3444
|
+
interface Departure {
|
|
3445
|
+
/**
|
|
3446
|
+
* Departure airport IATA code.
|
|
3447
|
+
*/
|
|
3448
|
+
airport: string;
|
|
3449
|
+
/**
|
|
3450
|
+
* Departure city.
|
|
3451
|
+
*/
|
|
3452
|
+
city?: string;
|
|
3453
|
+
/**
|
|
3454
|
+
* Departure country.
|
|
3455
|
+
*/
|
|
3456
|
+
country?: string;
|
|
3457
|
+
/**
|
|
3458
|
+
* Departure date/time.
|
|
3459
|
+
*/
|
|
3460
|
+
departs_at: number;
|
|
3461
|
+
}
|
|
3462
|
+
type ServiceClass = 'business' | 'economy' | 'first_class' | 'premium_economy';
|
|
3463
|
+
}
|
|
3464
|
+
namespace Total {
|
|
3465
|
+
type CreditReason = 'other' | 'partial_ticket_refund' | 'passenger_transport_ancillary_cancellation' | 'ticket_and_ancillary_cancellation' | 'ticket_cancellation';
|
|
3466
|
+
interface Discounts {
|
|
3467
|
+
/**
|
|
3468
|
+
* Corporate client discount code.
|
|
3469
|
+
*/
|
|
3470
|
+
corporate_client_code?: string;
|
|
3471
|
+
}
|
|
3472
|
+
interface ExtraCharge {
|
|
3473
|
+
/**
|
|
3474
|
+
* Amount of additional charges.
|
|
3475
|
+
*/
|
|
3476
|
+
amount?: number;
|
|
3477
|
+
/**
|
|
3478
|
+
* Type of additional charges.
|
|
3479
|
+
*/
|
|
3480
|
+
type?: ExtraCharge.Type;
|
|
3481
|
+
}
|
|
3482
|
+
interface Tax {
|
|
3483
|
+
/**
|
|
3484
|
+
* Array of tax details.
|
|
3485
|
+
*/
|
|
3486
|
+
taxes?: Array<Tax.Tax>;
|
|
3487
|
+
}
|
|
3488
|
+
namespace ExtraCharge {
|
|
3489
|
+
type Type = 'additional_fees' | 'ancillary_service_charges' | 'exchange_fee';
|
|
3490
|
+
}
|
|
3491
|
+
namespace Tax {
|
|
3492
|
+
interface Tax {
|
|
3493
|
+
/**
|
|
3494
|
+
* Tax amount.
|
|
3495
|
+
*/
|
|
3496
|
+
amount?: number;
|
|
3497
|
+
/**
|
|
3498
|
+
* Tax rate.
|
|
3499
|
+
*/
|
|
3500
|
+
rate?: number;
|
|
3501
|
+
/**
|
|
3502
|
+
* Type of tax.
|
|
3503
|
+
*/
|
|
3504
|
+
type?: string;
|
|
3505
|
+
}
|
|
3506
|
+
}
|
|
3507
|
+
}
|
|
3508
|
+
}
|
|
3509
|
+
namespace Lodging {
|
|
3510
|
+
interface Affiliate {
|
|
3511
|
+
/**
|
|
3512
|
+
* The name of the affiliate that originated the purchase.
|
|
3513
|
+
*/
|
|
3514
|
+
name: string;
|
|
3515
|
+
}
|
|
3516
|
+
type Category = 'hotel' | 'vacation_rental';
|
|
3517
|
+
interface Delivery {
|
|
3518
|
+
/**
|
|
3519
|
+
* The delivery method for the payment
|
|
3520
|
+
*/
|
|
3521
|
+
mode?: Delivery.Mode;
|
|
3522
|
+
/**
|
|
3523
|
+
* Details of the recipient.
|
|
3524
|
+
*/
|
|
3525
|
+
recipient?: Delivery.Recipient;
|
|
3526
|
+
}
|
|
3527
|
+
type ExtraCharge = 'gift_shop' | 'laundry' | 'mini_bar' | 'other' | 'restaurant' | 'telephone';
|
|
3528
|
+
interface Passenger {
|
|
3529
|
+
/**
|
|
3530
|
+
* Full name of the person or entity on the lodging reservation.
|
|
3531
|
+
*/
|
|
3532
|
+
name: string;
|
|
3533
|
+
}
|
|
3534
|
+
namespace Delivery {
|
|
3535
|
+
type Mode = 'email' | 'phone' | 'pickup' | 'post';
|
|
3536
|
+
interface Recipient {
|
|
3537
|
+
/**
|
|
3538
|
+
* The email of the recipient the ticket is delivered to.
|
|
3539
|
+
*/
|
|
3540
|
+
email?: string;
|
|
3541
|
+
/**
|
|
3542
|
+
* The name of the recipient the ticket is delivered to.
|
|
3543
|
+
*/
|
|
3544
|
+
name?: string;
|
|
3545
|
+
/**
|
|
3546
|
+
* The phone number of the recipient the ticket is delivered to.
|
|
3547
|
+
*/
|
|
3548
|
+
phone?: string;
|
|
3549
|
+
}
|
|
3550
|
+
}
|
|
3551
|
+
}
|
|
3552
|
+
namespace LodgingDatum {
|
|
3553
|
+
interface Accommodation {
|
|
3554
|
+
/**
|
|
3555
|
+
* Type of accommodation.
|
|
3556
|
+
*/
|
|
3557
|
+
accommodation_type?: Accommodation.AccommodationType;
|
|
3558
|
+
/**
|
|
3559
|
+
* Bed type.
|
|
3560
|
+
*/
|
|
3561
|
+
bed_type?: string;
|
|
3562
|
+
/**
|
|
3563
|
+
* Daily accommodation rate in cents.
|
|
3564
|
+
*/
|
|
3565
|
+
daily_rate_amount?: number;
|
|
3566
|
+
/**
|
|
3567
|
+
* Number of nights.
|
|
3568
|
+
*/
|
|
3569
|
+
nights?: number;
|
|
3570
|
+
/**
|
|
3571
|
+
* Number of rooms, cabanas, apartments, and so on.
|
|
3572
|
+
*/
|
|
3573
|
+
number_of_rooms?: number;
|
|
3574
|
+
/**
|
|
3575
|
+
* Rate type.
|
|
3576
|
+
*/
|
|
3577
|
+
rate_type?: string;
|
|
3578
|
+
/**
|
|
3579
|
+
* Whether smoking is allowed.
|
|
3580
|
+
*/
|
|
3581
|
+
smoking_indicator?: boolean;
|
|
3582
|
+
}
|
|
3583
|
+
interface Affiliate {
|
|
3584
|
+
/**
|
|
3585
|
+
* Affiliate partner code.
|
|
3586
|
+
*/
|
|
3587
|
+
code?: string;
|
|
3588
|
+
/**
|
|
3589
|
+
* Affiliate partner name.
|
|
3590
|
+
*/
|
|
3591
|
+
name?: string;
|
|
3592
|
+
}
|
|
3593
|
+
interface Guest {
|
|
3594
|
+
/**
|
|
3595
|
+
* Guest's full name.
|
|
3596
|
+
*/
|
|
3597
|
+
name: string;
|
|
3598
|
+
}
|
|
3599
|
+
interface Host {
|
|
3600
|
+
/**
|
|
3601
|
+
* Address of the host.
|
|
3602
|
+
*/
|
|
3603
|
+
address?: Host.Address;
|
|
3604
|
+
/**
|
|
3605
|
+
* Host's country of domicile.
|
|
3606
|
+
*/
|
|
3607
|
+
country_of_domicile?: string;
|
|
3608
|
+
/**
|
|
3609
|
+
* Reference number for the host.
|
|
3610
|
+
*/
|
|
3611
|
+
host_reference?: string;
|
|
3612
|
+
/**
|
|
3613
|
+
* Type of host.
|
|
3614
|
+
*/
|
|
3615
|
+
host_type?: Host.HostType;
|
|
3616
|
+
/**
|
|
3617
|
+
* Name of the lodging property or host.
|
|
3618
|
+
*/
|
|
3619
|
+
name?: string;
|
|
3620
|
+
/**
|
|
3621
|
+
* Total number of reservations for the host.
|
|
3622
|
+
*/
|
|
3623
|
+
number_of_reservations?: number;
|
|
3624
|
+
/**
|
|
3625
|
+
* Property phone number.
|
|
3626
|
+
*/
|
|
3627
|
+
property_phone_number?: string;
|
|
3628
|
+
/**
|
|
3629
|
+
* Host's registration date.
|
|
3630
|
+
*/
|
|
3631
|
+
registered_at?: number;
|
|
3632
|
+
}
|
|
3633
|
+
interface Insurance {
|
|
3634
|
+
/**
|
|
3635
|
+
* Price of the insurance coverage in cents.
|
|
3636
|
+
*/
|
|
3637
|
+
amount: number;
|
|
3638
|
+
/**
|
|
3639
|
+
* Currency of the insurance amount.
|
|
3640
|
+
*/
|
|
3641
|
+
currency?: string;
|
|
3642
|
+
/**
|
|
3643
|
+
* Name of the insurance company.
|
|
3644
|
+
*/
|
|
3645
|
+
insurance_company_name?: string;
|
|
3646
|
+
/**
|
|
3647
|
+
* Type of insurance coverage.
|
|
3648
|
+
*/
|
|
3649
|
+
insurance_type: Insurance.InsuranceType;
|
|
3650
|
+
}
|
|
3651
|
+
interface Total {
|
|
3652
|
+
/**
|
|
3653
|
+
* Total price of the lodging reservation in cents.
|
|
3654
|
+
*/
|
|
3655
|
+
amount: number;
|
|
3656
|
+
/**
|
|
3657
|
+
* Cash advances in cents.
|
|
3658
|
+
*/
|
|
3659
|
+
cash_advances?: number;
|
|
3660
|
+
/**
|
|
3661
|
+
* Currency of the total amount.
|
|
3662
|
+
*/
|
|
3663
|
+
currency?: string;
|
|
3664
|
+
/**
|
|
3665
|
+
* Discount details for the lodging.
|
|
3666
|
+
*/
|
|
3667
|
+
discounts?: Total.Discounts;
|
|
3668
|
+
/**
|
|
3669
|
+
* Additional charges for the lodging.
|
|
3670
|
+
*/
|
|
3671
|
+
extra_charges?: Array<Total.ExtraCharge>;
|
|
3672
|
+
/**
|
|
3673
|
+
* Prepaid amount in cents.
|
|
3674
|
+
*/
|
|
3675
|
+
prepaid_amount?: number;
|
|
3676
|
+
/**
|
|
3677
|
+
* Tax breakdown for the lodging reservation.
|
|
3678
|
+
*/
|
|
3679
|
+
tax?: Total.Tax;
|
|
3680
|
+
}
|
|
3681
|
+
namespace Accommodation {
|
|
3682
|
+
type AccommodationType = 'apartment' | 'cabana' | 'house' | 'penthouse' | 'room' | 'standard' | 'suite' | 'villa';
|
|
3683
|
+
}
|
|
3684
|
+
namespace Host {
|
|
3685
|
+
interface Address {
|
|
3686
|
+
/**
|
|
3687
|
+
* City, district, suburb, town, or village.
|
|
3688
|
+
*/
|
|
3689
|
+
city: string;
|
|
3690
|
+
/**
|
|
3691
|
+
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
3692
|
+
*/
|
|
3693
|
+
country: string;
|
|
3694
|
+
/**
|
|
3695
|
+
* Address line 1, such as the street, PO Box, or company name.
|
|
3696
|
+
*/
|
|
3697
|
+
line1: string;
|
|
3698
|
+
/**
|
|
3699
|
+
* Address line 2, such as the apartment, suite, unit, or building.
|
|
3700
|
+
*/
|
|
3701
|
+
line2?: string;
|
|
3702
|
+
/**
|
|
3703
|
+
* ZIP or postal code.
|
|
3704
|
+
*/
|
|
3705
|
+
postal_code: string;
|
|
3706
|
+
/**
|
|
3707
|
+
* State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
3708
|
+
*/
|
|
3709
|
+
state?: string;
|
|
3710
|
+
}
|
|
3711
|
+
type HostType = 'hostel' | 'hotel' | 'owner' | 'rental_agency';
|
|
3712
|
+
}
|
|
3713
|
+
namespace Insurance {
|
|
3714
|
+
type InsuranceType = 'bankruptcy' | 'cancelation' | 'emergency' | 'medical';
|
|
3715
|
+
}
|
|
3716
|
+
namespace Total {
|
|
3717
|
+
interface Discounts {
|
|
3718
|
+
/**
|
|
3719
|
+
* Corporate client discount code.
|
|
3720
|
+
*/
|
|
3721
|
+
corporate_client_code?: string;
|
|
3722
|
+
/**
|
|
3723
|
+
* Coupon code.
|
|
3724
|
+
*/
|
|
3725
|
+
coupon?: string;
|
|
3726
|
+
}
|
|
3727
|
+
interface ExtraCharge {
|
|
3728
|
+
/**
|
|
3729
|
+
* Amount of the extra charge in cents.
|
|
3730
|
+
*/
|
|
3731
|
+
amount?: number;
|
|
3732
|
+
/**
|
|
3733
|
+
* Type of extra charge.
|
|
3734
|
+
*/
|
|
3735
|
+
type?: ExtraCharge.Type;
|
|
3736
|
+
}
|
|
3737
|
+
interface Tax {
|
|
3738
|
+
/**
|
|
3739
|
+
* Indicates whether the transaction is tax exempt.
|
|
3740
|
+
*/
|
|
3741
|
+
tax_exempt_indicator?: boolean;
|
|
3742
|
+
/**
|
|
3743
|
+
* Tax details.
|
|
3744
|
+
*/
|
|
3745
|
+
taxes?: Array<Tax.Tax>;
|
|
3746
|
+
}
|
|
3747
|
+
namespace ExtraCharge {
|
|
3748
|
+
type Type = 'gift_shop' | 'laundry' | 'mini_bar' | 'other' | 'phone' | 'restaurant';
|
|
3749
|
+
}
|
|
3750
|
+
namespace Tax {
|
|
3751
|
+
interface Tax {
|
|
3752
|
+
/**
|
|
3753
|
+
* Tax amount in cents.
|
|
3754
|
+
*/
|
|
3755
|
+
amount?: number;
|
|
3756
|
+
/**
|
|
3757
|
+
* Tax rate.
|
|
3758
|
+
*/
|
|
3759
|
+
rate?: number;
|
|
3760
|
+
/**
|
|
3761
|
+
* Type of tax applied.
|
|
3762
|
+
*/
|
|
3763
|
+
type?: string;
|
|
3764
|
+
}
|
|
3765
|
+
}
|
|
3766
|
+
}
|
|
3767
|
+
}
|
|
3768
|
+
namespace Subscription {
|
|
3769
|
+
interface Affiliate {
|
|
3770
|
+
/**
|
|
3771
|
+
* The name of the affiliate that originated the purchase.
|
|
3772
|
+
*/
|
|
3773
|
+
name: string;
|
|
3774
|
+
}
|
|
3775
|
+
interface BillingInterval {
|
|
3776
|
+
/**
|
|
3777
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3778
|
+
*/
|
|
3779
|
+
count: number;
|
|
3780
|
+
/**
|
|
3781
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3782
|
+
*/
|
|
3783
|
+
interval: BillingInterval.Interval;
|
|
3784
|
+
}
|
|
3785
|
+
namespace BillingInterval {
|
|
3786
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3787
|
+
}
|
|
3788
|
+
}
|
|
3789
|
+
}
|
|
3790
|
+
}
|
|
3791
|
+
export interface ChargeListParams extends PaginationParams {
|
|
3792
|
+
/**
|
|
3793
|
+
* Only return charges that were created during the given date interval.
|
|
3794
|
+
*/
|
|
3795
|
+
created?: RangeQueryParam | number;
|
|
3796
|
+
/**
|
|
3797
|
+
* Only return charges for the customer specified by this customer ID.
|
|
3798
|
+
*/
|
|
3799
|
+
customer?: string;
|
|
3800
|
+
/**
|
|
3801
|
+
* Specifies which fields in the response should be expanded.
|
|
3802
|
+
*/
|
|
3803
|
+
expand?: Array<string>;
|
|
3804
|
+
/**
|
|
3805
|
+
* Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
|
|
3806
|
+
*/
|
|
3807
|
+
payment_intent?: string;
|
|
3808
|
+
/**
|
|
3809
|
+
* Only return charges for this transfer group, limited to 100.
|
|
3810
|
+
*/
|
|
3811
|
+
transfer_group?: string;
|
|
3812
|
+
}
|
|
3813
|
+
export interface ChargeCaptureParams {
|
|
3814
|
+
/**
|
|
3815
|
+
* The amount to capture, which must be less than or equal to the original amount.
|
|
3816
|
+
*/
|
|
3817
|
+
amount?: number;
|
|
3818
|
+
/**
|
|
3819
|
+
* An application fee to add on to this charge.
|
|
3820
|
+
*/
|
|
3821
|
+
application_fee?: number;
|
|
3822
|
+
/**
|
|
3823
|
+
* An application fee amount to add on to this charge, which must be less than or equal to the original amount.
|
|
3824
|
+
*/
|
|
3825
|
+
application_fee_amount?: number;
|
|
3826
|
+
/**
|
|
3827
|
+
* Specifies which fields in the response should be expanded.
|
|
3828
|
+
*/
|
|
3829
|
+
expand?: Array<string>;
|
|
3830
|
+
/**
|
|
3831
|
+
* Provides industry-specific information about the charge.
|
|
3832
|
+
*/
|
|
3833
|
+
payment_details?: ChargeCaptureParams.PaymentDetails;
|
|
3834
|
+
/**
|
|
3835
|
+
* The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
|
|
3836
|
+
*/
|
|
3837
|
+
receipt_email?: string;
|
|
3838
|
+
/**
|
|
3839
|
+
* For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
|
|
3840
|
+
*
|
|
3841
|
+
* For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
|
|
3842
|
+
*/
|
|
3843
|
+
statement_descriptor?: string;
|
|
3844
|
+
/**
|
|
3845
|
+
* Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
|
|
3846
|
+
*/
|
|
3847
|
+
statement_descriptor_suffix?: string;
|
|
3848
|
+
/**
|
|
3849
|
+
* An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
|
|
3850
|
+
*/
|
|
3851
|
+
transfer_data?: ChargeCaptureParams.TransferData;
|
|
3852
|
+
/**
|
|
3853
|
+
* A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.
|
|
3854
|
+
*/
|
|
3855
|
+
transfer_group?: string;
|
|
3856
|
+
}
|
|
3857
|
+
export declare namespace ChargeCaptureParams {
|
|
3858
|
+
interface PaymentDetails {
|
|
3859
|
+
/**
|
|
3860
|
+
* Car rental details for this PaymentIntent.
|
|
3861
|
+
*/
|
|
3862
|
+
car_rental?: PaymentDetails.CarRental;
|
|
3863
|
+
/**
|
|
3864
|
+
* Car rental data for this PaymentIntent.
|
|
3865
|
+
*/
|
|
3866
|
+
car_rental_data?: Emptyable<Array<PaymentDetails.CarRentalDatum>>;
|
|
3867
|
+
/**
|
|
3868
|
+
* A unique value to identify the customer. This field is available only for card payments.
|
|
3869
|
+
*
|
|
3870
|
+
* This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
|
|
3871
|
+
*/
|
|
3872
|
+
customer_reference?: Emptyable<string>;
|
|
3873
|
+
/**
|
|
3874
|
+
* Event details for this PaymentIntent
|
|
3875
|
+
*/
|
|
3876
|
+
event_details?: PaymentDetails.EventDetails;
|
|
3877
|
+
/**
|
|
3878
|
+
* Flight reservation details for this PaymentIntent
|
|
3879
|
+
*/
|
|
3880
|
+
flight?: PaymentDetails.Flight;
|
|
3881
|
+
/**
|
|
3882
|
+
* Flight data for this PaymentIntent.
|
|
3883
|
+
*/
|
|
3884
|
+
flight_data?: Emptyable<Array<PaymentDetails.FlightDatum>>;
|
|
3885
|
+
/**
|
|
3886
|
+
* Lodging reservation details for this PaymentIntent
|
|
3887
|
+
*/
|
|
3888
|
+
lodging?: PaymentDetails.Lodging;
|
|
3889
|
+
/**
|
|
3890
|
+
* Lodging data for this PaymentIntent.
|
|
3891
|
+
*/
|
|
3892
|
+
lodging_data?: Emptyable<Array<PaymentDetails.LodgingDatum>>;
|
|
3893
|
+
/**
|
|
3894
|
+
* A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
|
|
3895
|
+
*
|
|
3896
|
+
* For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
|
|
3897
|
+
*/
|
|
3898
|
+
order_reference?: Emptyable<string>;
|
|
3899
|
+
/**
|
|
3900
|
+
* Subscription details for this PaymentIntent
|
|
3901
|
+
*/
|
|
3902
|
+
subscription?: PaymentDetails.Subscription;
|
|
3903
|
+
}
|
|
3904
|
+
interface TransferData {
|
|
3905
|
+
/**
|
|
3906
|
+
* The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
|
|
3907
|
+
*/
|
|
3908
|
+
amount?: number;
|
|
3909
|
+
}
|
|
3910
|
+
namespace PaymentDetails {
|
|
3911
|
+
interface CarRental {
|
|
3912
|
+
/**
|
|
3913
|
+
* Affiliate details for this purchase.
|
|
3914
|
+
*/
|
|
3915
|
+
affiliate?: CarRental.Affiliate;
|
|
3916
|
+
/**
|
|
3917
|
+
* The booking number associated with the car rental.
|
|
3918
|
+
*/
|
|
3919
|
+
booking_number: string;
|
|
3920
|
+
/**
|
|
3921
|
+
* Class code of the car.
|
|
3922
|
+
*/
|
|
3923
|
+
car_class_code?: string;
|
|
3924
|
+
/**
|
|
3925
|
+
* Make of the car.
|
|
3926
|
+
*/
|
|
3927
|
+
car_make?: string;
|
|
3928
|
+
/**
|
|
3929
|
+
* Model of the car.
|
|
3930
|
+
*/
|
|
3931
|
+
car_model?: string;
|
|
3932
|
+
/**
|
|
3933
|
+
* The name of the rental car company.
|
|
3934
|
+
*/
|
|
3935
|
+
company?: string;
|
|
3936
|
+
/**
|
|
3937
|
+
* The customer service phone number of the car rental company.
|
|
3938
|
+
*/
|
|
3939
|
+
customer_service_phone_number?: string;
|
|
3940
|
+
/**
|
|
3941
|
+
* Number of days the car is being rented.
|
|
3942
|
+
*/
|
|
3943
|
+
days_rented: number;
|
|
3944
|
+
/**
|
|
3945
|
+
* Delivery details for this purchase.
|
|
3946
|
+
*/
|
|
3947
|
+
delivery?: CarRental.Delivery;
|
|
3948
|
+
/**
|
|
3949
|
+
* The details of the distance traveled during the rental period.
|
|
3950
|
+
*/
|
|
3951
|
+
distance?: CarRental.Distance;
|
|
3952
|
+
/**
|
|
3953
|
+
* The details of the passengers in the travel reservation
|
|
3954
|
+
*/
|
|
3955
|
+
drivers?: Array<CarRental.Driver>;
|
|
3956
|
+
/**
|
|
3957
|
+
* List of additional charges being billed.
|
|
3958
|
+
*/
|
|
3959
|
+
extra_charges?: Array<CarRental.ExtraCharge>;
|
|
3960
|
+
/**
|
|
3961
|
+
* Indicates if the customer did not keep nor cancel their booking.
|
|
3962
|
+
*/
|
|
3963
|
+
no_show?: boolean;
|
|
3964
|
+
/**
|
|
3965
|
+
* Car pick-up address.
|
|
3966
|
+
*/
|
|
3967
|
+
pickup_address?: AddressParam;
|
|
3968
|
+
/**
|
|
3969
|
+
* Car pick-up time. Measured in seconds since the Unix epoch.
|
|
3970
|
+
*/
|
|
3971
|
+
pickup_at: number;
|
|
3972
|
+
/**
|
|
3973
|
+
* Name of the pickup location.
|
|
3974
|
+
*/
|
|
3975
|
+
pickup_location_name?: string;
|
|
3976
|
+
/**
|
|
3977
|
+
* Rental rate.
|
|
3978
|
+
*/
|
|
3979
|
+
rate_amount?: number;
|
|
3980
|
+
/**
|
|
3981
|
+
* The frequency at which the rate amount is applied. One of `day`, `week` or `month`
|
|
3982
|
+
*/
|
|
3983
|
+
rate_interval?: CarRental.RateInterval;
|
|
3984
|
+
/**
|
|
3985
|
+
* The name of the person or entity renting the car.
|
|
3986
|
+
*/
|
|
3987
|
+
renter_name?: string;
|
|
3988
|
+
/**
|
|
3989
|
+
* Car return address.
|
|
3990
|
+
*/
|
|
3991
|
+
return_address?: AddressParam;
|
|
3992
|
+
/**
|
|
3993
|
+
* Car return time. Measured in seconds since the Unix epoch.
|
|
3994
|
+
*/
|
|
3995
|
+
return_at: number;
|
|
3996
|
+
/**
|
|
3997
|
+
* Name of the return location.
|
|
3998
|
+
*/
|
|
3999
|
+
return_location_name?: string;
|
|
4000
|
+
/**
|
|
4001
|
+
* Indicates whether the goods or services are tax-exempt or tax is not collected.
|
|
4002
|
+
*/
|
|
4003
|
+
tax_exempt?: boolean;
|
|
4004
|
+
/**
|
|
4005
|
+
* The vehicle identification number.
|
|
4006
|
+
*/
|
|
4007
|
+
vehicle_identification_number?: string;
|
|
4008
|
+
}
|
|
4009
|
+
interface CarRentalDatum {
|
|
4010
|
+
/**
|
|
4011
|
+
* Affiliate (such as travel agency) details for the rental.
|
|
4012
|
+
*/
|
|
4013
|
+
affiliate?: CarRentalDatum.Affiliate;
|
|
4014
|
+
/**
|
|
4015
|
+
* Booking confirmation number for the car rental.
|
|
4016
|
+
*/
|
|
4017
|
+
booking_number?: string;
|
|
4018
|
+
/**
|
|
4019
|
+
* Name of the car rental company.
|
|
4020
|
+
*/
|
|
4021
|
+
carrier_name?: string;
|
|
4022
|
+
/**
|
|
4023
|
+
* Customer service phone number for the car rental company.
|
|
4024
|
+
*/
|
|
4025
|
+
customer_service_phone_number?: string;
|
|
4026
|
+
/**
|
|
4027
|
+
* Number of days the car is being rented.
|
|
4028
|
+
*/
|
|
4029
|
+
days_rented?: number;
|
|
4030
|
+
/**
|
|
4031
|
+
* Distance details for the rental.
|
|
4032
|
+
*/
|
|
4033
|
+
distance?: CarRentalDatum.Distance;
|
|
4034
|
+
/**
|
|
4035
|
+
* List of drivers for the rental.
|
|
4036
|
+
*/
|
|
4037
|
+
drivers?: Array<CarRentalDatum.Driver>;
|
|
4038
|
+
/**
|
|
4039
|
+
* Drop-off location details.
|
|
4040
|
+
*/
|
|
4041
|
+
drop_off: CarRentalDatum.DropOff;
|
|
4042
|
+
/**
|
|
4043
|
+
* Insurance details for the rental.
|
|
4044
|
+
*/
|
|
4045
|
+
insurances?: Array<CarRentalDatum.Insurance>;
|
|
4046
|
+
/**
|
|
4047
|
+
* Indicates if the customer was a no-show.
|
|
4048
|
+
*/
|
|
4049
|
+
no_show_indicator?: boolean;
|
|
4050
|
+
/**
|
|
4051
|
+
* Pickup location details.
|
|
4052
|
+
*/
|
|
4053
|
+
pickup: CarRentalDatum.Pickup;
|
|
4054
|
+
/**
|
|
4055
|
+
* Name of the person renting the vehicle.
|
|
4056
|
+
*/
|
|
4057
|
+
renter_name?: string;
|
|
4058
|
+
/**
|
|
4059
|
+
* Total cost breakdown for the rental.
|
|
4060
|
+
*/
|
|
4061
|
+
total: CarRentalDatum.Total;
|
|
4062
|
+
/**
|
|
4063
|
+
* Vehicle details for the rental.
|
|
4064
|
+
*/
|
|
4065
|
+
vehicle?: CarRentalDatum.Vehicle;
|
|
4066
|
+
}
|
|
4067
|
+
interface EventDetails {
|
|
4068
|
+
/**
|
|
4069
|
+
* Indicates if the tickets are digitally checked when entering the venue.
|
|
4070
|
+
*/
|
|
4071
|
+
access_controlled_venue?: boolean;
|
|
4072
|
+
/**
|
|
4073
|
+
* The event location's address.
|
|
4074
|
+
*/
|
|
4075
|
+
address?: AddressParam;
|
|
4076
|
+
/**
|
|
4077
|
+
* Affiliate details for this purchase.
|
|
4078
|
+
*/
|
|
4079
|
+
affiliate?: EventDetails.Affiliate;
|
|
4080
|
+
/**
|
|
4081
|
+
* The name of the company
|
|
4082
|
+
*/
|
|
4083
|
+
company?: string;
|
|
4084
|
+
/**
|
|
4085
|
+
* Delivery details for this purchase.
|
|
4086
|
+
*/
|
|
4087
|
+
delivery?: EventDetails.Delivery;
|
|
4088
|
+
/**
|
|
4089
|
+
* Event end time. Measured in seconds since the Unix epoch.
|
|
4090
|
+
*/
|
|
4091
|
+
ends_at?: number;
|
|
4092
|
+
/**
|
|
4093
|
+
* Type of the event entertainment (concert, sports event etc)
|
|
4094
|
+
*/
|
|
4095
|
+
genre?: string;
|
|
4096
|
+
/**
|
|
4097
|
+
* The name of the event.
|
|
4098
|
+
*/
|
|
4099
|
+
name: string;
|
|
4100
|
+
/**
|
|
4101
|
+
* Event start time. Measured in seconds since the Unix epoch.
|
|
4102
|
+
*/
|
|
4103
|
+
starts_at?: number;
|
|
4104
|
+
}
|
|
4105
|
+
interface Flight {
|
|
4106
|
+
/**
|
|
4107
|
+
* Affiliate details for this purchase.
|
|
4108
|
+
*/
|
|
4109
|
+
affiliate?: Flight.Affiliate;
|
|
4110
|
+
/**
|
|
4111
|
+
* The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
|
|
4112
|
+
*/
|
|
4113
|
+
agency_number?: string;
|
|
4114
|
+
/**
|
|
4115
|
+
* The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
|
|
4116
|
+
*/
|
|
4117
|
+
carrier?: string;
|
|
4118
|
+
/**
|
|
4119
|
+
* Delivery details for this purchase.
|
|
4120
|
+
*/
|
|
4121
|
+
delivery?: Flight.Delivery;
|
|
4122
|
+
/**
|
|
4123
|
+
* The name of the person or entity on the reservation.
|
|
4124
|
+
*/
|
|
4125
|
+
passenger_name?: string;
|
|
4126
|
+
/**
|
|
4127
|
+
* The details of the passengers in the travel reservation.
|
|
4128
|
+
*/
|
|
4129
|
+
passengers?: Array<Flight.Passenger>;
|
|
4130
|
+
/**
|
|
4131
|
+
* The individual flight segments associated with the trip.
|
|
4132
|
+
*/
|
|
4133
|
+
segments: Array<Flight.Segment>;
|
|
4134
|
+
/**
|
|
4135
|
+
* The ticket number associated with the travel reservation.
|
|
4136
|
+
*/
|
|
4137
|
+
ticket_number?: string;
|
|
4138
|
+
}
|
|
4139
|
+
interface FlightDatum {
|
|
4140
|
+
/**
|
|
4141
|
+
* Affiliate details if applicable.
|
|
4142
|
+
*/
|
|
4143
|
+
affiliate?: FlightDatum.Affiliate;
|
|
4144
|
+
/**
|
|
4145
|
+
* Reservation reference.
|
|
4146
|
+
*/
|
|
4147
|
+
booking_number?: string;
|
|
4148
|
+
/**
|
|
4149
|
+
* Computerized reservation system used to make the reservation and purchase the ticket.
|
|
4150
|
+
*/
|
|
4151
|
+
computerized_reservation_system?: string;
|
|
4152
|
+
/**
|
|
4153
|
+
* Ticket restrictions.
|
|
4154
|
+
*/
|
|
4155
|
+
endorsements_and_restrictions?: string;
|
|
4156
|
+
/**
|
|
4157
|
+
* List of insurances.
|
|
4158
|
+
*/
|
|
4159
|
+
insurances?: Array<FlightDatum.Insurance>;
|
|
4160
|
+
/**
|
|
4161
|
+
* List of passengers.
|
|
4162
|
+
*/
|
|
4163
|
+
passengers?: Array<FlightDatum.Passenger>;
|
|
4164
|
+
/**
|
|
4165
|
+
* List of flight segments.
|
|
4166
|
+
*/
|
|
4167
|
+
segments: Array<FlightDatum.Segment>;
|
|
4168
|
+
/**
|
|
4169
|
+
* Electronic ticket indicator.
|
|
4170
|
+
*/
|
|
4171
|
+
ticket_electronically_issued_indicator?: boolean;
|
|
4172
|
+
/**
|
|
4173
|
+
* Total cost breakdown.
|
|
4174
|
+
*/
|
|
4175
|
+
total: FlightDatum.Total;
|
|
4176
|
+
/**
|
|
4177
|
+
* Type of flight transaction.
|
|
4178
|
+
*/
|
|
4179
|
+
transaction_type?: FlightDatum.TransactionType;
|
|
4180
|
+
}
|
|
4181
|
+
interface Lodging {
|
|
4182
|
+
/**
|
|
4183
|
+
* The lodging location's address.
|
|
4184
|
+
*/
|
|
4185
|
+
address?: AddressParam;
|
|
4186
|
+
/**
|
|
4187
|
+
* The number of adults on the booking
|
|
4188
|
+
*/
|
|
4189
|
+
adults?: number;
|
|
4190
|
+
/**
|
|
4191
|
+
* Affiliate details for this purchase.
|
|
4192
|
+
*/
|
|
4193
|
+
affiliate?: Lodging.Affiliate;
|
|
4194
|
+
/**
|
|
4195
|
+
* The booking number associated with the lodging reservation.
|
|
4196
|
+
*/
|
|
4197
|
+
booking_number?: string;
|
|
4198
|
+
/**
|
|
4199
|
+
* The lodging category
|
|
4200
|
+
*/
|
|
4201
|
+
category?: Lodging.Category;
|
|
4202
|
+
/**
|
|
4203
|
+
* Lodging check-in time. Measured in seconds since the Unix epoch.
|
|
4204
|
+
*/
|
|
4205
|
+
checkin_at: number;
|
|
4206
|
+
/**
|
|
4207
|
+
* Lodging check-out time. Measured in seconds since the Unix epoch.
|
|
4208
|
+
*/
|
|
4209
|
+
checkout_at: number;
|
|
4210
|
+
/**
|
|
4211
|
+
* The customer service phone number of the lodging company.
|
|
4212
|
+
*/
|
|
4213
|
+
customer_service_phone_number?: string;
|
|
4214
|
+
/**
|
|
4215
|
+
* The daily lodging room rate.
|
|
4216
|
+
*/
|
|
4217
|
+
daily_room_rate_amount?: number;
|
|
4218
|
+
/**
|
|
4219
|
+
* Delivery details for this purchase.
|
|
4220
|
+
*/
|
|
4221
|
+
delivery?: Lodging.Delivery;
|
|
4222
|
+
/**
|
|
4223
|
+
* List of additional charges being billed.
|
|
4224
|
+
*/
|
|
4225
|
+
extra_charges?: Array<Lodging.ExtraCharge>;
|
|
4226
|
+
/**
|
|
4227
|
+
* Indicates whether the lodging location is compliant with the Fire Safety Act.
|
|
4228
|
+
*/
|
|
4229
|
+
fire_safety_act_compliance?: boolean;
|
|
4230
|
+
/**
|
|
4231
|
+
* The name of the lodging location.
|
|
4232
|
+
*/
|
|
4233
|
+
name?: string;
|
|
4234
|
+
/**
|
|
4235
|
+
* Indicates if the customer did not keep their booking while failing to cancel the reservation.
|
|
4236
|
+
*/
|
|
4237
|
+
no_show?: boolean;
|
|
4238
|
+
/**
|
|
4239
|
+
* The number of rooms on the booking
|
|
4240
|
+
*/
|
|
4241
|
+
number_of_rooms?: number;
|
|
4242
|
+
/**
|
|
4243
|
+
* The details of the passengers in the travel reservation
|
|
4244
|
+
*/
|
|
4245
|
+
passengers?: Array<Lodging.Passenger>;
|
|
4246
|
+
/**
|
|
4247
|
+
* The phone number of the lodging location.
|
|
4248
|
+
*/
|
|
4249
|
+
property_phone_number?: string;
|
|
4250
|
+
/**
|
|
4251
|
+
* The room class for this purchase.
|
|
4252
|
+
*/
|
|
4253
|
+
room_class?: string;
|
|
4254
|
+
/**
|
|
4255
|
+
* The number of room nights
|
|
4256
|
+
*/
|
|
4257
|
+
room_nights?: number;
|
|
4258
|
+
/**
|
|
4259
|
+
* The total tax amount associating with the room reservation.
|
|
4260
|
+
*/
|
|
4261
|
+
total_room_tax_amount?: number;
|
|
4262
|
+
/**
|
|
4263
|
+
* The total tax amount
|
|
4264
|
+
*/
|
|
4265
|
+
total_tax_amount?: number;
|
|
4266
|
+
}
|
|
4267
|
+
interface LodgingDatum {
|
|
4268
|
+
/**
|
|
4269
|
+
* Accommodation details for the lodging.
|
|
4270
|
+
*/
|
|
4271
|
+
accommodation?: LodgingDatum.Accommodation;
|
|
4272
|
+
/**
|
|
4273
|
+
* Affiliate details if applicable.
|
|
4274
|
+
*/
|
|
4275
|
+
affiliate?: LodgingDatum.Affiliate;
|
|
4276
|
+
/**
|
|
4277
|
+
* Booking confirmation number for the lodging.
|
|
4278
|
+
*/
|
|
4279
|
+
booking_number?: string;
|
|
4280
|
+
/**
|
|
4281
|
+
* Check-in date.
|
|
4282
|
+
*/
|
|
4283
|
+
checkin_at: number;
|
|
4284
|
+
/**
|
|
4285
|
+
* Check-out date.
|
|
4286
|
+
*/
|
|
4287
|
+
checkout_at: number;
|
|
4288
|
+
/**
|
|
4289
|
+
* Customer service phone number for the lodging company.
|
|
4290
|
+
*/
|
|
4291
|
+
customer_service_phone_number?: string;
|
|
4292
|
+
/**
|
|
4293
|
+
* Whether the lodging is compliant with any hotel fire safety regulations.
|
|
4294
|
+
*/
|
|
4295
|
+
fire_safety_act_compliance_indicator?: boolean;
|
|
4296
|
+
/**
|
|
4297
|
+
* List of guests for the lodging.
|
|
4298
|
+
*/
|
|
4299
|
+
guests?: Array<LodgingDatum.Guest>;
|
|
4300
|
+
/**
|
|
4301
|
+
* Host details for the lodging.
|
|
4302
|
+
*/
|
|
4303
|
+
host?: LodgingDatum.Host;
|
|
4304
|
+
/**
|
|
4305
|
+
* List of insurances for the lodging.
|
|
4306
|
+
*/
|
|
4307
|
+
insurances?: Array<LodgingDatum.Insurance>;
|
|
4308
|
+
/**
|
|
4309
|
+
* Whether the renter is a no-show.
|
|
4310
|
+
*/
|
|
4311
|
+
no_show_indicator?: boolean;
|
|
4312
|
+
/**
|
|
4313
|
+
* Renter ID number for the lodging.
|
|
4314
|
+
*/
|
|
4315
|
+
renter_id_number?: string;
|
|
4316
|
+
/**
|
|
4317
|
+
* Renter name for the lodging.
|
|
4318
|
+
*/
|
|
4319
|
+
renter_name?: string;
|
|
4320
|
+
/**
|
|
4321
|
+
* Total details for the lodging.
|
|
4322
|
+
*/
|
|
4323
|
+
total: LodgingDatum.Total;
|
|
4324
|
+
}
|
|
4325
|
+
interface Subscription {
|
|
4326
|
+
/**
|
|
4327
|
+
* Affiliate details for this purchase.
|
|
4328
|
+
*/
|
|
4329
|
+
affiliate?: Subscription.Affiliate;
|
|
4330
|
+
/**
|
|
4331
|
+
* Info whether the subscription will be auto renewed upon expiry.
|
|
4332
|
+
*/
|
|
4333
|
+
auto_renewal?: boolean;
|
|
4334
|
+
/**
|
|
4335
|
+
* Subscription billing details for this purchase.
|
|
4336
|
+
*/
|
|
4337
|
+
billing_interval?: Subscription.BillingInterval;
|
|
4338
|
+
/**
|
|
4339
|
+
* Subscription end time. Measured in seconds since the Unix epoch.
|
|
4340
|
+
*/
|
|
4341
|
+
ends_at?: number;
|
|
4342
|
+
/**
|
|
4343
|
+
* Name of the product on subscription. e.g. Apple Music Subscription
|
|
4344
|
+
*/
|
|
4345
|
+
name: string;
|
|
4346
|
+
/**
|
|
4347
|
+
* Subscription start time. Measured in seconds since the Unix epoch.
|
|
4348
|
+
*/
|
|
4349
|
+
starts_at?: number;
|
|
4350
|
+
}
|
|
4351
|
+
namespace CarRental {
|
|
4352
|
+
interface Affiliate {
|
|
4353
|
+
/**
|
|
4354
|
+
* The name of the affiliate that originated the purchase.
|
|
4355
|
+
*/
|
|
4356
|
+
name: string;
|
|
4357
|
+
}
|
|
4358
|
+
interface Delivery {
|
|
4359
|
+
/**
|
|
4360
|
+
* The delivery method for the payment
|
|
4361
|
+
*/
|
|
4362
|
+
mode?: Delivery.Mode;
|
|
4363
|
+
/**
|
|
4364
|
+
* Details of the recipient.
|
|
4365
|
+
*/
|
|
4366
|
+
recipient?: Delivery.Recipient;
|
|
4367
|
+
}
|
|
4368
|
+
interface Distance {
|
|
4369
|
+
/**
|
|
4370
|
+
* Distance traveled.
|
|
4371
|
+
*/
|
|
4372
|
+
amount?: number;
|
|
4373
|
+
/**
|
|
4374
|
+
* Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
|
|
4375
|
+
*/
|
|
4376
|
+
unit?: Distance.Unit;
|
|
4377
|
+
}
|
|
4378
|
+
interface Driver {
|
|
4379
|
+
/**
|
|
4380
|
+
* Driver's identification number.
|
|
4381
|
+
*/
|
|
4382
|
+
driver_identification_number?: string;
|
|
4383
|
+
/**
|
|
4384
|
+
* Driver's tax number.
|
|
4385
|
+
*/
|
|
4386
|
+
driver_tax_number?: string;
|
|
4387
|
+
/**
|
|
4388
|
+
* Full name of the person or entity on the car reservation.
|
|
4389
|
+
*/
|
|
4390
|
+
name: string;
|
|
4391
|
+
}
|
|
4392
|
+
type ExtraCharge = 'extra_mileage' | 'gas' | 'late_return' | 'one_way_service' | 'parking_violation';
|
|
4393
|
+
type RateInterval = 'day' | 'month' | 'week';
|
|
4394
|
+
namespace Delivery {
|
|
4395
|
+
type Mode = 'email' | 'phone' | 'pickup' | 'post';
|
|
4396
|
+
interface Recipient {
|
|
4397
|
+
/**
|
|
4398
|
+
* The email of the recipient the ticket is delivered to.
|
|
4399
|
+
*/
|
|
4400
|
+
email?: string;
|
|
4401
|
+
/**
|
|
4402
|
+
* The name of the recipient the ticket is delivered to.
|
|
4403
|
+
*/
|
|
4404
|
+
name?: string;
|
|
4405
|
+
/**
|
|
4406
|
+
* The phone number of the recipient the ticket is delivered to.
|
|
4407
|
+
*/
|
|
4408
|
+
phone?: string;
|
|
4409
|
+
}
|
|
4410
|
+
}
|
|
4411
|
+
namespace Distance {
|
|
4412
|
+
type Unit = 'kilometers' | 'miles';
|
|
4413
|
+
}
|
|
4414
|
+
}
|
|
4415
|
+
namespace CarRentalDatum {
|
|
4416
|
+
interface Affiliate {
|
|
4417
|
+
/**
|
|
4418
|
+
* Affiliate partner code.
|
|
4419
|
+
*/
|
|
4420
|
+
code?: string;
|
|
4421
|
+
/**
|
|
4422
|
+
* Name of affiliate partner.
|
|
4423
|
+
*/
|
|
4424
|
+
name?: string;
|
|
4425
|
+
}
|
|
4426
|
+
interface Distance {
|
|
4427
|
+
/**
|
|
4428
|
+
* Distance traveled.
|
|
4429
|
+
*/
|
|
4430
|
+
amount: number;
|
|
4431
|
+
/**
|
|
4432
|
+
* Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
|
|
4433
|
+
*/
|
|
4434
|
+
unit: Distance.Unit;
|
|
4435
|
+
}
|
|
4436
|
+
interface Driver {
|
|
4437
|
+
/**
|
|
4438
|
+
* Driver's date of birth.
|
|
4439
|
+
*/
|
|
4440
|
+
date_of_birth?: Driver.DateOfBirth;
|
|
4441
|
+
/**
|
|
4442
|
+
* Driver's identification number.
|
|
4443
|
+
*/
|
|
4444
|
+
driver_identification_number?: string;
|
|
4445
|
+
/**
|
|
4446
|
+
* Driver's tax number.
|
|
4447
|
+
*/
|
|
4448
|
+
driver_tax_number?: string;
|
|
4449
|
+
/**
|
|
4450
|
+
* Driver's full name.
|
|
4451
|
+
*/
|
|
4452
|
+
name: string;
|
|
4453
|
+
}
|
|
4454
|
+
interface DropOff {
|
|
4455
|
+
/**
|
|
4456
|
+
* Address of the rental location.
|
|
4457
|
+
*/
|
|
4458
|
+
address: DropOff.Address;
|
|
4459
|
+
/**
|
|
4460
|
+
* Location name.
|
|
4461
|
+
*/
|
|
4462
|
+
location_name?: string;
|
|
4463
|
+
/**
|
|
4464
|
+
* Timestamp for the location.
|
|
4465
|
+
*/
|
|
4466
|
+
time: number;
|
|
4467
|
+
}
|
|
4468
|
+
interface Insurance {
|
|
4469
|
+
/**
|
|
4470
|
+
* Amount of the insurance coverage in cents.
|
|
4471
|
+
*/
|
|
4472
|
+
amount: number;
|
|
4473
|
+
/**
|
|
4474
|
+
* Currency of the insurance amount.
|
|
4475
|
+
*/
|
|
4476
|
+
currency?: string;
|
|
4477
|
+
/**
|
|
4478
|
+
* Name of the insurance company.
|
|
4479
|
+
*/
|
|
4480
|
+
insurance_company_name?: string;
|
|
4481
|
+
/**
|
|
4482
|
+
* Type of insurance coverage.
|
|
4483
|
+
*/
|
|
4484
|
+
insurance_type: Insurance.InsuranceType;
|
|
4485
|
+
}
|
|
4486
|
+
interface Pickup {
|
|
4487
|
+
/**
|
|
4488
|
+
* Address of the rental location.
|
|
4489
|
+
*/
|
|
4490
|
+
address: Pickup.Address;
|
|
4491
|
+
/**
|
|
4492
|
+
* Location name.
|
|
4493
|
+
*/
|
|
4494
|
+
location_name?: string;
|
|
4495
|
+
/**
|
|
4496
|
+
* Timestamp for the location.
|
|
4497
|
+
*/
|
|
4498
|
+
time: number;
|
|
4499
|
+
}
|
|
4500
|
+
interface Total {
|
|
4501
|
+
/**
|
|
4502
|
+
* Total amount in cents.
|
|
4503
|
+
*/
|
|
4504
|
+
amount: number;
|
|
4505
|
+
/**
|
|
4506
|
+
* Currency of the amount.
|
|
4507
|
+
*/
|
|
4508
|
+
currency?: string;
|
|
4509
|
+
/**
|
|
4510
|
+
* Discount details for the rental.
|
|
4511
|
+
*/
|
|
4512
|
+
discounts?: Total.Discounts;
|
|
4513
|
+
/**
|
|
4514
|
+
* Additional charges for the rental.
|
|
4515
|
+
*/
|
|
4516
|
+
extra_charges?: Array<Total.ExtraCharge>;
|
|
4517
|
+
/**
|
|
4518
|
+
* Rate per unit for the rental.
|
|
4519
|
+
*/
|
|
4520
|
+
rate_per_unit?: number;
|
|
4521
|
+
/**
|
|
4522
|
+
* Unit of measurement for the rate.
|
|
4523
|
+
*/
|
|
4524
|
+
rate_unit?: Total.RateUnit;
|
|
4525
|
+
/**
|
|
4526
|
+
* Tax breakdown for the rental.
|
|
4527
|
+
*/
|
|
4528
|
+
tax?: Total.Tax;
|
|
4529
|
+
}
|
|
4530
|
+
interface Vehicle {
|
|
4531
|
+
/**
|
|
4532
|
+
* Make of the rental vehicle.
|
|
4533
|
+
*/
|
|
4534
|
+
make?: string;
|
|
4535
|
+
/**
|
|
4536
|
+
* Model of the rental vehicle.
|
|
4537
|
+
*/
|
|
4538
|
+
model?: string;
|
|
4539
|
+
/**
|
|
4540
|
+
* Odometer reading at the time of rental.
|
|
4541
|
+
*/
|
|
4542
|
+
odometer?: number;
|
|
4543
|
+
/**
|
|
4544
|
+
* Type of the rental vehicle.
|
|
4545
|
+
*/
|
|
4546
|
+
type?: Vehicle.Type;
|
|
4547
|
+
/**
|
|
4548
|
+
* Class of the rental vehicle.
|
|
4549
|
+
*/
|
|
4550
|
+
vehicle_class?: Vehicle.VehicleClass;
|
|
4551
|
+
/**
|
|
4552
|
+
* Vehicle identification number (VIN).
|
|
4553
|
+
*/
|
|
4554
|
+
vehicle_identification_number?: string;
|
|
4555
|
+
}
|
|
4556
|
+
namespace Distance {
|
|
4557
|
+
type Unit = 'kilometers' | 'miles';
|
|
4558
|
+
}
|
|
4559
|
+
namespace Driver {
|
|
4560
|
+
interface DateOfBirth {
|
|
4561
|
+
/**
|
|
4562
|
+
* Day of birth (1-31).
|
|
4563
|
+
*/
|
|
4564
|
+
day: number;
|
|
4565
|
+
/**
|
|
4566
|
+
* Month of birth (1-12).
|
|
4567
|
+
*/
|
|
4568
|
+
month: number;
|
|
4569
|
+
/**
|
|
4570
|
+
* Year of birth (must be greater than 1900).
|
|
4571
|
+
*/
|
|
4572
|
+
year: number;
|
|
4573
|
+
}
|
|
4574
|
+
}
|
|
4575
|
+
namespace DropOff {
|
|
4576
|
+
interface Address {
|
|
4577
|
+
/**
|
|
4578
|
+
* City, district, suburb, town, or village.
|
|
4579
|
+
*/
|
|
4580
|
+
city: string;
|
|
4581
|
+
/**
|
|
4582
|
+
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
4583
|
+
*/
|
|
4584
|
+
country: string;
|
|
4585
|
+
/**
|
|
4586
|
+
* Address line 1, such as the street, PO Box, or company name.
|
|
4587
|
+
*/
|
|
4588
|
+
line1: string;
|
|
4589
|
+
/**
|
|
4590
|
+
* Address line 2, such as the apartment, suite, unit, or building.
|
|
4591
|
+
*/
|
|
4592
|
+
line2?: string;
|
|
4593
|
+
/**
|
|
4594
|
+
* ZIP or postal code.
|
|
4595
|
+
*/
|
|
4596
|
+
postal_code: string;
|
|
4597
|
+
/**
|
|
4598
|
+
* State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
4599
|
+
*/
|
|
4600
|
+
state?: string;
|
|
4601
|
+
}
|
|
4602
|
+
}
|
|
4603
|
+
namespace Insurance {
|
|
4604
|
+
type InsuranceType = 'liability_supplement' | 'loss_damage_waiver' | 'other' | 'partial_damage_waiver' | 'personal_accident' | 'personal_effects';
|
|
4605
|
+
}
|
|
4606
|
+
namespace Pickup {
|
|
4607
|
+
interface Address {
|
|
4608
|
+
/**
|
|
4609
|
+
* City, district, suburb, town, or village.
|
|
4610
|
+
*/
|
|
4611
|
+
city: string;
|
|
4612
|
+
/**
|
|
4613
|
+
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
4614
|
+
*/
|
|
4615
|
+
country: string;
|
|
4616
|
+
/**
|
|
4617
|
+
* Address line 1, such as the street, PO Box, or company name.
|
|
4618
|
+
*/
|
|
4619
|
+
line1: string;
|
|
4620
|
+
/**
|
|
4621
|
+
* Address line 2, such as the apartment, suite, unit, or building.
|
|
4622
|
+
*/
|
|
4623
|
+
line2?: string;
|
|
4624
|
+
/**
|
|
4625
|
+
* ZIP or postal code.
|
|
4626
|
+
*/
|
|
4627
|
+
postal_code: string;
|
|
4628
|
+
/**
|
|
4629
|
+
* State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
4630
|
+
*/
|
|
4631
|
+
state?: string;
|
|
4632
|
+
}
|
|
4633
|
+
}
|
|
4634
|
+
namespace Total {
|
|
4635
|
+
interface Discounts {
|
|
4636
|
+
/**
|
|
4637
|
+
* Corporate client discount code.
|
|
4638
|
+
*/
|
|
4639
|
+
corporate_client_code?: string;
|
|
4640
|
+
/**
|
|
4641
|
+
* Coupon code applied to the rental.
|
|
4642
|
+
*/
|
|
4643
|
+
coupon?: string;
|
|
4644
|
+
/**
|
|
4645
|
+
* Maximum number of free miles or kilometers included.
|
|
4646
|
+
*/
|
|
4647
|
+
maximum_free_miles_or_kilometers?: number;
|
|
4648
|
+
}
|
|
4649
|
+
interface ExtraCharge {
|
|
4650
|
+
/**
|
|
4651
|
+
* Amount of the extra charge in cents.
|
|
4652
|
+
*/
|
|
4653
|
+
amount: number;
|
|
4654
|
+
/**
|
|
4655
|
+
* Type of extra charge.
|
|
4656
|
+
*/
|
|
4657
|
+
type: ExtraCharge.Type;
|
|
4658
|
+
}
|
|
4659
|
+
type RateUnit = 'days' | 'kilometers' | 'miles' | 'months' | 'weeks';
|
|
4660
|
+
interface Tax {
|
|
4661
|
+
/**
|
|
4662
|
+
* Indicates if the transaction is tax exempt.
|
|
4663
|
+
*/
|
|
4664
|
+
tax_exempt_indicator?: boolean;
|
|
4665
|
+
/**
|
|
4666
|
+
* Array of tax details.
|
|
4667
|
+
*/
|
|
4668
|
+
taxes?: Array<Tax.Tax>;
|
|
4669
|
+
}
|
|
4670
|
+
namespace ExtraCharge {
|
|
4671
|
+
type Type = 'extra_mileage' | 'gas' | 'gps' | 'late_charge' | 'one_way_drop_off' | 'other' | 'parking' | 'phone' | 'regular_mileage' | 'towing';
|
|
4672
|
+
}
|
|
4673
|
+
namespace Tax {
|
|
4674
|
+
interface Tax {
|
|
4675
|
+
/**
|
|
4676
|
+
* Tax amount.
|
|
4677
|
+
*/
|
|
4678
|
+
amount?: number;
|
|
4679
|
+
/**
|
|
4680
|
+
* Tax rate applied.
|
|
4681
|
+
*/
|
|
4682
|
+
rate?: number;
|
|
4683
|
+
/**
|
|
4684
|
+
* Type of tax applied.
|
|
4685
|
+
*/
|
|
4686
|
+
type?: string;
|
|
4687
|
+
}
|
|
4688
|
+
}
|
|
4689
|
+
}
|
|
4690
|
+
namespace Vehicle {
|
|
4691
|
+
type Type = 'cargo_van' | 'compact' | 'economy' | 'exotic' | 'exotic_suv' | 'fifteen_passenger_van' | 'four_wheel_drive' | 'full_size' | 'intermediate' | 'large_suv' | 'large_truck' | 'luxury' | 'medium_suv' | 'midsize' | 'mini' | 'minivan' | 'miscellaneous' | 'moped' | 'moving_van' | 'premium' | 'regular' | 'small_medium_truck' | 'small_suv' | 'special' | 'standard' | 'stretch' | 'subcompact' | 'taxi' | 'twelve_foot_truck' | 'twelve_passenger_van' | 'twenty_foot_truck' | 'twenty_four_foot_truck' | 'twenty_six_foot_truck' | 'unique';
|
|
4692
|
+
type VehicleClass = 'business' | 'economy' | 'first_class' | 'premium_economy';
|
|
4693
|
+
}
|
|
4694
|
+
}
|
|
4695
|
+
namespace EventDetails {
|
|
4696
|
+
interface Affiliate {
|
|
4697
|
+
/**
|
|
4698
|
+
* The name of the affiliate that originated the purchase.
|
|
4699
|
+
*/
|
|
4700
|
+
name: string;
|
|
4701
|
+
}
|
|
4702
|
+
interface Delivery {
|
|
4703
|
+
/**
|
|
4704
|
+
* The delivery method for the payment
|
|
4705
|
+
*/
|
|
4706
|
+
mode?: Delivery.Mode;
|
|
4707
|
+
/**
|
|
4708
|
+
* Details of the recipient.
|
|
4709
|
+
*/
|
|
4710
|
+
recipient?: Delivery.Recipient;
|
|
4711
|
+
}
|
|
4712
|
+
namespace Delivery {
|
|
4713
|
+
type Mode = 'email' | 'phone' | 'pickup' | 'post';
|
|
4714
|
+
interface Recipient {
|
|
4715
|
+
/**
|
|
4716
|
+
* The email of the recipient the ticket is delivered to.
|
|
4717
|
+
*/
|
|
4718
|
+
email?: string;
|
|
4719
|
+
/**
|
|
4720
|
+
* The name of the recipient the ticket is delivered to.
|
|
4721
|
+
*/
|
|
4722
|
+
name?: string;
|
|
4723
|
+
/**
|
|
4724
|
+
* The phone number of the recipient the ticket is delivered to.
|
|
4725
|
+
*/
|
|
4726
|
+
phone?: string;
|
|
4727
|
+
}
|
|
4728
|
+
}
|
|
4729
|
+
}
|
|
4730
|
+
namespace Flight {
|
|
4731
|
+
interface Affiliate {
|
|
4732
|
+
/**
|
|
4733
|
+
* The name of the affiliate that originated the purchase.
|
|
4734
|
+
*/
|
|
4735
|
+
name: string;
|
|
4736
|
+
}
|
|
4737
|
+
interface Delivery {
|
|
4738
|
+
/**
|
|
4739
|
+
* The delivery method for the payment
|
|
4740
|
+
*/
|
|
4741
|
+
mode?: Delivery.Mode;
|
|
4742
|
+
/**
|
|
4743
|
+
* Details of the recipient.
|
|
4744
|
+
*/
|
|
4745
|
+
recipient?: Delivery.Recipient;
|
|
4746
|
+
}
|
|
4747
|
+
interface Passenger {
|
|
4748
|
+
/**
|
|
4749
|
+
* Full name of the person or entity on the flight reservation.
|
|
4750
|
+
*/
|
|
4751
|
+
name: string;
|
|
4752
|
+
}
|
|
4753
|
+
interface Segment {
|
|
4754
|
+
/**
|
|
4755
|
+
* The flight segment amount.
|
|
4756
|
+
*/
|
|
4757
|
+
amount?: number;
|
|
4758
|
+
/**
|
|
4759
|
+
* The International Air Transport Association (IATA) airport code for the arrival airport.
|
|
4760
|
+
*/
|
|
4761
|
+
arrival_airport?: string;
|
|
4762
|
+
/**
|
|
4763
|
+
* The arrival time for the flight segment. Measured in seconds since the Unix epoch.
|
|
4764
|
+
*/
|
|
4765
|
+
arrives_at?: number;
|
|
4766
|
+
/**
|
|
4767
|
+
* The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
|
|
4768
|
+
*/
|
|
4769
|
+
carrier?: string;
|
|
4770
|
+
/**
|
|
4771
|
+
* The departure time for the flight segment. Measured in seconds since the Unix epoch.
|
|
4772
|
+
*/
|
|
4773
|
+
departs_at: number;
|
|
4774
|
+
/**
|
|
4775
|
+
* The International Air Transport Association (IATA) airport code for the departure airport.
|
|
4776
|
+
*/
|
|
4777
|
+
departure_airport?: string;
|
|
4778
|
+
/**
|
|
4779
|
+
* The flight number associated with the segment
|
|
4780
|
+
*/
|
|
4781
|
+
flight_number?: string;
|
|
4782
|
+
/**
|
|
4783
|
+
* The fare class for the segment.
|
|
4784
|
+
*/
|
|
4785
|
+
service_class?: Segment.ServiceClass;
|
|
4786
|
+
}
|
|
4787
|
+
namespace Delivery {
|
|
4788
|
+
type Mode = 'email' | 'phone' | 'pickup' | 'post';
|
|
4789
|
+
interface Recipient {
|
|
4790
|
+
/**
|
|
4791
|
+
* The email of the recipient the ticket is delivered to.
|
|
4792
|
+
*/
|
|
4793
|
+
email?: string;
|
|
4794
|
+
/**
|
|
4795
|
+
* The name of the recipient the ticket is delivered to.
|
|
4796
|
+
*/
|
|
4797
|
+
name?: string;
|
|
4798
|
+
/**
|
|
4799
|
+
* The phone number of the recipient the ticket is delivered to.
|
|
4800
|
+
*/
|
|
4801
|
+
phone?: string;
|
|
4802
|
+
}
|
|
4803
|
+
}
|
|
4804
|
+
namespace Segment {
|
|
4805
|
+
type ServiceClass = 'business' | 'economy' | 'first' | 'premium_economy';
|
|
4806
|
+
}
|
|
4807
|
+
}
|
|
4808
|
+
namespace FlightDatum {
|
|
4809
|
+
interface Affiliate {
|
|
4810
|
+
/**
|
|
4811
|
+
* Affiliate partner code.
|
|
4812
|
+
*/
|
|
4813
|
+
code?: string;
|
|
4814
|
+
/**
|
|
4815
|
+
* Name of affiliate partner.
|
|
4816
|
+
*/
|
|
4817
|
+
name?: string;
|
|
4818
|
+
/**
|
|
4819
|
+
* Code provided by the company to a travel agent authorizing ticket issuance.
|
|
4820
|
+
*/
|
|
4821
|
+
travel_authorization_code?: string;
|
|
4822
|
+
}
|
|
4823
|
+
interface Insurance {
|
|
4824
|
+
/**
|
|
4825
|
+
* Insurance cost.
|
|
4826
|
+
*/
|
|
4827
|
+
amount: number;
|
|
4828
|
+
/**
|
|
4829
|
+
* Insurance currency.
|
|
4830
|
+
*/
|
|
4831
|
+
currency?: string;
|
|
4832
|
+
/**
|
|
4833
|
+
* Insurance company name.
|
|
4834
|
+
*/
|
|
4835
|
+
insurance_company_name?: string;
|
|
4836
|
+
/**
|
|
4837
|
+
* Type of insurance.
|
|
4838
|
+
*/
|
|
4839
|
+
insurance_type: Insurance.InsuranceType;
|
|
4840
|
+
}
|
|
4841
|
+
interface Passenger {
|
|
4842
|
+
/**
|
|
4843
|
+
* Passenger's full name.
|
|
4844
|
+
*/
|
|
4845
|
+
name: string;
|
|
4846
|
+
}
|
|
4847
|
+
interface Segment {
|
|
4848
|
+
/**
|
|
4849
|
+
* Segment fare amount.
|
|
4850
|
+
*/
|
|
4851
|
+
amount?: number;
|
|
4852
|
+
/**
|
|
4853
|
+
* Arrival details.
|
|
4854
|
+
*/
|
|
4855
|
+
arrival: Segment.Arrival;
|
|
4856
|
+
/**
|
|
4857
|
+
* Airline carrier code.
|
|
4858
|
+
*/
|
|
4859
|
+
carrier_code: string;
|
|
4860
|
+
/**
|
|
4861
|
+
* Carrier name.
|
|
4862
|
+
*/
|
|
4863
|
+
carrier_name?: string;
|
|
4864
|
+
/**
|
|
4865
|
+
* Segment currency.
|
|
4866
|
+
*/
|
|
4867
|
+
currency?: string;
|
|
4868
|
+
/**
|
|
4869
|
+
* Departure details.
|
|
4870
|
+
*/
|
|
4871
|
+
departure: Segment.Departure;
|
|
4872
|
+
/**
|
|
4873
|
+
* Exchange ticket number.
|
|
4874
|
+
*/
|
|
4875
|
+
exchange_ticket_number?: string;
|
|
4876
|
+
/**
|
|
4877
|
+
* Fare basis code.
|
|
4878
|
+
*/
|
|
4879
|
+
fare_basis_code?: string;
|
|
4880
|
+
/**
|
|
4881
|
+
* Additional fees.
|
|
4882
|
+
*/
|
|
4883
|
+
fees?: number;
|
|
4884
|
+
/**
|
|
4885
|
+
* Flight number.
|
|
4886
|
+
*/
|
|
4887
|
+
flight_number?: string;
|
|
4888
|
+
/**
|
|
4889
|
+
* Stopover indicator.
|
|
4890
|
+
*/
|
|
4891
|
+
is_stop_over_indicator?: boolean;
|
|
4892
|
+
/**
|
|
4893
|
+
* Refundable ticket indicator.
|
|
4894
|
+
*/
|
|
4895
|
+
refundable?: boolean;
|
|
4896
|
+
/**
|
|
4897
|
+
* Class of service.
|
|
4898
|
+
*/
|
|
4899
|
+
service_class: Segment.ServiceClass;
|
|
4900
|
+
/**
|
|
4901
|
+
* Tax amount for segment.
|
|
4902
|
+
*/
|
|
4903
|
+
tax_amount?: number;
|
|
4904
|
+
/**
|
|
4905
|
+
* Ticket number.
|
|
4906
|
+
*/
|
|
4907
|
+
ticket_number?: string;
|
|
4908
|
+
}
|
|
4909
|
+
interface Total {
|
|
4910
|
+
/**
|
|
4911
|
+
* Total flight amount.
|
|
4912
|
+
*/
|
|
4913
|
+
amount: number;
|
|
4914
|
+
/**
|
|
4915
|
+
* Reason for credit.
|
|
4916
|
+
*/
|
|
4917
|
+
credit_reason?: Total.CreditReason;
|
|
4918
|
+
/**
|
|
4919
|
+
* Total currency.
|
|
4920
|
+
*/
|
|
4921
|
+
currency?: string;
|
|
4922
|
+
/**
|
|
4923
|
+
* Discount details.
|
|
4924
|
+
*/
|
|
4925
|
+
discounts?: Total.Discounts;
|
|
4926
|
+
/**
|
|
4927
|
+
* Additional charges.
|
|
4928
|
+
*/
|
|
4929
|
+
extra_charges?: Array<Total.ExtraCharge>;
|
|
4930
|
+
/**
|
|
4931
|
+
* Tax breakdown.
|
|
4932
|
+
*/
|
|
4933
|
+
tax?: Total.Tax;
|
|
4934
|
+
}
|
|
4935
|
+
type TransactionType = 'exchange_ticket' | 'miscellaneous' | 'refund' | 'ticket_purchase';
|
|
4936
|
+
namespace Insurance {
|
|
4937
|
+
type InsuranceType = 'baggage' | 'bankruptcy' | 'cancelation' | 'emergency' | 'medical';
|
|
4938
|
+
}
|
|
4939
|
+
namespace Segment {
|
|
4940
|
+
interface Arrival {
|
|
4941
|
+
/**
|
|
4942
|
+
* Arrival airport IATA code.
|
|
4943
|
+
*/
|
|
4944
|
+
airport: string;
|
|
4945
|
+
/**
|
|
4946
|
+
* Arrival date/time.
|
|
4947
|
+
*/
|
|
4948
|
+
arrives_at?: number;
|
|
4949
|
+
/**
|
|
4950
|
+
* Arrival city.
|
|
4951
|
+
*/
|
|
4952
|
+
city?: string;
|
|
4953
|
+
/**
|
|
4954
|
+
* Arrival country.
|
|
4955
|
+
*/
|
|
4956
|
+
country?: string;
|
|
4957
|
+
}
|
|
4958
|
+
interface Departure {
|
|
4959
|
+
/**
|
|
4960
|
+
* Departure airport IATA code.
|
|
4961
|
+
*/
|
|
4962
|
+
airport: string;
|
|
4963
|
+
/**
|
|
4964
|
+
* Departure city.
|
|
4965
|
+
*/
|
|
4966
|
+
city?: string;
|
|
4967
|
+
/**
|
|
4968
|
+
* Departure country.
|
|
4969
|
+
*/
|
|
4970
|
+
country?: string;
|
|
4971
|
+
/**
|
|
4972
|
+
* Departure date/time.
|
|
4973
|
+
*/
|
|
4974
|
+
departs_at: number;
|
|
4975
|
+
}
|
|
4976
|
+
type ServiceClass = 'business' | 'economy' | 'first_class' | 'premium_economy';
|
|
4977
|
+
}
|
|
4978
|
+
namespace Total {
|
|
4979
|
+
type CreditReason = 'other' | 'partial_ticket_refund' | 'passenger_transport_ancillary_cancellation' | 'ticket_and_ancillary_cancellation' | 'ticket_cancellation';
|
|
4980
|
+
interface Discounts {
|
|
4981
|
+
/**
|
|
4982
|
+
* Corporate client discount code.
|
|
4983
|
+
*/
|
|
4984
|
+
corporate_client_code?: string;
|
|
4985
|
+
}
|
|
4986
|
+
interface ExtraCharge {
|
|
4987
|
+
/**
|
|
4988
|
+
* Amount of additional charges.
|
|
4989
|
+
*/
|
|
4990
|
+
amount?: number;
|
|
4991
|
+
/**
|
|
4992
|
+
* Type of additional charges.
|
|
4993
|
+
*/
|
|
4994
|
+
type?: ExtraCharge.Type;
|
|
4995
|
+
}
|
|
4996
|
+
interface Tax {
|
|
4997
|
+
/**
|
|
4998
|
+
* Array of tax details.
|
|
4999
|
+
*/
|
|
5000
|
+
taxes?: Array<Tax.Tax>;
|
|
5001
|
+
}
|
|
5002
|
+
namespace ExtraCharge {
|
|
5003
|
+
type Type = 'additional_fees' | 'ancillary_service_charges' | 'exchange_fee';
|
|
5004
|
+
}
|
|
5005
|
+
namespace Tax {
|
|
5006
|
+
interface Tax {
|
|
5007
|
+
/**
|
|
5008
|
+
* Tax amount.
|
|
5009
|
+
*/
|
|
5010
|
+
amount?: number;
|
|
5011
|
+
/**
|
|
5012
|
+
* Tax rate.
|
|
5013
|
+
*/
|
|
5014
|
+
rate?: number;
|
|
5015
|
+
/**
|
|
5016
|
+
* Type of tax.
|
|
5017
|
+
*/
|
|
5018
|
+
type?: string;
|
|
5019
|
+
}
|
|
5020
|
+
}
|
|
5021
|
+
}
|
|
5022
|
+
}
|
|
5023
|
+
namespace Lodging {
|
|
5024
|
+
interface Affiliate {
|
|
5025
|
+
/**
|
|
5026
|
+
* The name of the affiliate that originated the purchase.
|
|
5027
|
+
*/
|
|
5028
|
+
name: string;
|
|
5029
|
+
}
|
|
5030
|
+
type Category = 'hotel' | 'vacation_rental';
|
|
5031
|
+
interface Delivery {
|
|
5032
|
+
/**
|
|
5033
|
+
* The delivery method for the payment
|
|
5034
|
+
*/
|
|
5035
|
+
mode?: Delivery.Mode;
|
|
5036
|
+
/**
|
|
5037
|
+
* Details of the recipient.
|
|
5038
|
+
*/
|
|
5039
|
+
recipient?: Delivery.Recipient;
|
|
5040
|
+
}
|
|
5041
|
+
type ExtraCharge = 'gift_shop' | 'laundry' | 'mini_bar' | 'other' | 'restaurant' | 'telephone';
|
|
5042
|
+
interface Passenger {
|
|
5043
|
+
/**
|
|
5044
|
+
* Full name of the person or entity on the lodging reservation.
|
|
5045
|
+
*/
|
|
5046
|
+
name: string;
|
|
5047
|
+
}
|
|
5048
|
+
namespace Delivery {
|
|
5049
|
+
type Mode = 'email' | 'phone' | 'pickup' | 'post';
|
|
5050
|
+
interface Recipient {
|
|
5051
|
+
/**
|
|
5052
|
+
* The email of the recipient the ticket is delivered to.
|
|
5053
|
+
*/
|
|
5054
|
+
email?: string;
|
|
5055
|
+
/**
|
|
5056
|
+
* The name of the recipient the ticket is delivered to.
|
|
5057
|
+
*/
|
|
5058
|
+
name?: string;
|
|
5059
|
+
/**
|
|
5060
|
+
* The phone number of the recipient the ticket is delivered to.
|
|
5061
|
+
*/
|
|
5062
|
+
phone?: string;
|
|
5063
|
+
}
|
|
5064
|
+
}
|
|
5065
|
+
}
|
|
5066
|
+
namespace LodgingDatum {
|
|
5067
|
+
interface Accommodation {
|
|
5068
|
+
/**
|
|
5069
|
+
* Type of accommodation.
|
|
5070
|
+
*/
|
|
5071
|
+
accommodation_type?: Accommodation.AccommodationType;
|
|
5072
|
+
/**
|
|
5073
|
+
* Bed type.
|
|
5074
|
+
*/
|
|
5075
|
+
bed_type?: string;
|
|
5076
|
+
/**
|
|
5077
|
+
* Daily accommodation rate in cents.
|
|
5078
|
+
*/
|
|
5079
|
+
daily_rate_amount?: number;
|
|
5080
|
+
/**
|
|
5081
|
+
* Number of nights.
|
|
5082
|
+
*/
|
|
5083
|
+
nights?: number;
|
|
5084
|
+
/**
|
|
5085
|
+
* Number of rooms, cabanas, apartments, and so on.
|
|
5086
|
+
*/
|
|
5087
|
+
number_of_rooms?: number;
|
|
5088
|
+
/**
|
|
5089
|
+
* Rate type.
|
|
5090
|
+
*/
|
|
5091
|
+
rate_type?: string;
|
|
5092
|
+
/**
|
|
5093
|
+
* Whether smoking is allowed.
|
|
5094
|
+
*/
|
|
5095
|
+
smoking_indicator?: boolean;
|
|
5096
|
+
}
|
|
5097
|
+
interface Affiliate {
|
|
5098
|
+
/**
|
|
5099
|
+
* Affiliate partner code.
|
|
5100
|
+
*/
|
|
5101
|
+
code?: string;
|
|
5102
|
+
/**
|
|
5103
|
+
* Affiliate partner name.
|
|
5104
|
+
*/
|
|
5105
|
+
name?: string;
|
|
5106
|
+
}
|
|
5107
|
+
interface Guest {
|
|
5108
|
+
/**
|
|
5109
|
+
* Guest's full name.
|
|
5110
|
+
*/
|
|
5111
|
+
name: string;
|
|
5112
|
+
}
|
|
5113
|
+
interface Host {
|
|
5114
|
+
/**
|
|
5115
|
+
* Address of the host.
|
|
5116
|
+
*/
|
|
5117
|
+
address?: Host.Address;
|
|
5118
|
+
/**
|
|
5119
|
+
* Host's country of domicile.
|
|
5120
|
+
*/
|
|
5121
|
+
country_of_domicile?: string;
|
|
5122
|
+
/**
|
|
5123
|
+
* Reference number for the host.
|
|
5124
|
+
*/
|
|
5125
|
+
host_reference?: string;
|
|
5126
|
+
/**
|
|
5127
|
+
* Type of host.
|
|
5128
|
+
*/
|
|
5129
|
+
host_type?: Host.HostType;
|
|
5130
|
+
/**
|
|
5131
|
+
* Name of the lodging property or host.
|
|
5132
|
+
*/
|
|
5133
|
+
name?: string;
|
|
5134
|
+
/**
|
|
5135
|
+
* Total number of reservations for the host.
|
|
5136
|
+
*/
|
|
5137
|
+
number_of_reservations?: number;
|
|
5138
|
+
/**
|
|
5139
|
+
* Property phone number.
|
|
5140
|
+
*/
|
|
5141
|
+
property_phone_number?: string;
|
|
5142
|
+
/**
|
|
5143
|
+
* Host's registration date.
|
|
5144
|
+
*/
|
|
5145
|
+
registered_at?: number;
|
|
5146
|
+
}
|
|
5147
|
+
interface Insurance {
|
|
5148
|
+
/**
|
|
5149
|
+
* Price of the insurance coverage in cents.
|
|
5150
|
+
*/
|
|
5151
|
+
amount: number;
|
|
5152
|
+
/**
|
|
5153
|
+
* Currency of the insurance amount.
|
|
5154
|
+
*/
|
|
5155
|
+
currency?: string;
|
|
5156
|
+
/**
|
|
5157
|
+
* Name of the insurance company.
|
|
5158
|
+
*/
|
|
5159
|
+
insurance_company_name?: string;
|
|
5160
|
+
/**
|
|
5161
|
+
* Type of insurance coverage.
|
|
5162
|
+
*/
|
|
5163
|
+
insurance_type: Insurance.InsuranceType;
|
|
5164
|
+
}
|
|
5165
|
+
interface Total {
|
|
5166
|
+
/**
|
|
5167
|
+
* Total price of the lodging reservation in cents.
|
|
5168
|
+
*/
|
|
5169
|
+
amount: number;
|
|
5170
|
+
/**
|
|
5171
|
+
* Cash advances in cents.
|
|
5172
|
+
*/
|
|
5173
|
+
cash_advances?: number;
|
|
5174
|
+
/**
|
|
5175
|
+
* Currency of the total amount.
|
|
5176
|
+
*/
|
|
5177
|
+
currency?: string;
|
|
5178
|
+
/**
|
|
5179
|
+
* Discount details for the lodging.
|
|
5180
|
+
*/
|
|
5181
|
+
discounts?: Total.Discounts;
|
|
5182
|
+
/**
|
|
5183
|
+
* Additional charges for the lodging.
|
|
5184
|
+
*/
|
|
5185
|
+
extra_charges?: Array<Total.ExtraCharge>;
|
|
5186
|
+
/**
|
|
5187
|
+
* Prepaid amount in cents.
|
|
5188
|
+
*/
|
|
5189
|
+
prepaid_amount?: number;
|
|
5190
|
+
/**
|
|
5191
|
+
* Tax breakdown for the lodging reservation.
|
|
5192
|
+
*/
|
|
5193
|
+
tax?: Total.Tax;
|
|
5194
|
+
}
|
|
5195
|
+
namespace Accommodation {
|
|
5196
|
+
type AccommodationType = 'apartment' | 'cabana' | 'house' | 'penthouse' | 'room' | 'standard' | 'suite' | 'villa';
|
|
5197
|
+
}
|
|
5198
|
+
namespace Host {
|
|
5199
|
+
interface Address {
|
|
5200
|
+
/**
|
|
5201
|
+
* City, district, suburb, town, or village.
|
|
5202
|
+
*/
|
|
5203
|
+
city: string;
|
|
5204
|
+
/**
|
|
5205
|
+
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
5206
|
+
*/
|
|
5207
|
+
country: string;
|
|
5208
|
+
/**
|
|
5209
|
+
* Address line 1, such as the street, PO Box, or company name.
|
|
5210
|
+
*/
|
|
5211
|
+
line1: string;
|
|
5212
|
+
/**
|
|
5213
|
+
* Address line 2, such as the apartment, suite, unit, or building.
|
|
5214
|
+
*/
|
|
5215
|
+
line2?: string;
|
|
5216
|
+
/**
|
|
5217
|
+
* ZIP or postal code.
|
|
5218
|
+
*/
|
|
5219
|
+
postal_code: string;
|
|
5220
|
+
/**
|
|
5221
|
+
* State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
5222
|
+
*/
|
|
5223
|
+
state?: string;
|
|
5224
|
+
}
|
|
5225
|
+
type HostType = 'hostel' | 'hotel' | 'owner' | 'rental_agency';
|
|
5226
|
+
}
|
|
5227
|
+
namespace Insurance {
|
|
5228
|
+
type InsuranceType = 'bankruptcy' | 'cancelation' | 'emergency' | 'medical';
|
|
5229
|
+
}
|
|
5230
|
+
namespace Total {
|
|
5231
|
+
interface Discounts {
|
|
5232
|
+
/**
|
|
5233
|
+
* Corporate client discount code.
|
|
5234
|
+
*/
|
|
5235
|
+
corporate_client_code?: string;
|
|
5236
|
+
/**
|
|
5237
|
+
* Coupon code.
|
|
5238
|
+
*/
|
|
5239
|
+
coupon?: string;
|
|
5240
|
+
}
|
|
5241
|
+
interface ExtraCharge {
|
|
5242
|
+
/**
|
|
5243
|
+
* Amount of the extra charge in cents.
|
|
5244
|
+
*/
|
|
5245
|
+
amount?: number;
|
|
5246
|
+
/**
|
|
5247
|
+
* Type of extra charge.
|
|
5248
|
+
*/
|
|
5249
|
+
type?: ExtraCharge.Type;
|
|
5250
|
+
}
|
|
5251
|
+
interface Tax {
|
|
5252
|
+
/**
|
|
5253
|
+
* Indicates whether the transaction is tax exempt.
|
|
5254
|
+
*/
|
|
5255
|
+
tax_exempt_indicator?: boolean;
|
|
5256
|
+
/**
|
|
5257
|
+
* Tax details.
|
|
5258
|
+
*/
|
|
5259
|
+
taxes?: Array<Tax.Tax>;
|
|
5260
|
+
}
|
|
5261
|
+
namespace ExtraCharge {
|
|
5262
|
+
type Type = 'gift_shop' | 'laundry' | 'mini_bar' | 'other' | 'phone' | 'restaurant';
|
|
5263
|
+
}
|
|
5264
|
+
namespace Tax {
|
|
5265
|
+
interface Tax {
|
|
5266
|
+
/**
|
|
5267
|
+
* Tax amount in cents.
|
|
5268
|
+
*/
|
|
5269
|
+
amount?: number;
|
|
5270
|
+
/**
|
|
5271
|
+
* Tax rate.
|
|
5272
|
+
*/
|
|
5273
|
+
rate?: number;
|
|
5274
|
+
/**
|
|
5275
|
+
* Type of tax applied.
|
|
5276
|
+
*/
|
|
5277
|
+
type?: string;
|
|
5278
|
+
}
|
|
5279
|
+
}
|
|
5280
|
+
}
|
|
5281
|
+
}
|
|
5282
|
+
namespace Subscription {
|
|
5283
|
+
interface Affiliate {
|
|
5284
|
+
/**
|
|
5285
|
+
* The name of the affiliate that originated the purchase.
|
|
5286
|
+
*/
|
|
5287
|
+
name: string;
|
|
5288
|
+
}
|
|
5289
|
+
interface BillingInterval {
|
|
5290
|
+
/**
|
|
5291
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5292
|
+
*/
|
|
5293
|
+
count: number;
|
|
5294
|
+
/**
|
|
5295
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5296
|
+
*/
|
|
5297
|
+
interval: BillingInterval.Interval;
|
|
5298
|
+
}
|
|
5299
|
+
namespace BillingInterval {
|
|
5300
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5301
|
+
}
|
|
5302
|
+
}
|
|
2309
5303
|
}
|
|
2310
5304
|
}
|
|
2311
5305
|
export interface ChargeSearchParams {
|