stripe 20.1.0-alpha.4 → 20.2.0-alpha.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 +39 -0
- package/OPENAPI_VERSION +1 -1
- package/VERSION +1 -1
- package/cjs/Error.js +9 -1
- package/cjs/apiVersion.js +1 -1
- package/cjs/resources/SharedPayment/GrantedTokens.js +12 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +16 -0
- package/cjs/resources/V2/Iam/ApiKeys.js +24 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +20 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +33 -0
- package/cjs/resources/V2/Tax/ManualRules.js +23 -0
- package/cjs/resources.js +15 -1
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +7 -0
- package/esm/apiVersion.js +1 -1
- package/esm/resources/SharedPayment/GrantedTokens.js +9 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +13 -0
- package/esm/resources/V2/Iam/ApiKeys.js +21 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +17 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.js +30 -0
- package/esm/resources/V2/Tax/ManualRules.js +20 -0
- package/esm/resources.js +14 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinks.d.ts +1 -1
- package/types/AccountNotices.d.ts +6 -6
- package/types/AccountNoticesResource.d.ts +1 -1
- package/types/AccountSessions.d.ts +7 -7
- package/types/AccountSessionsResource.d.ts +21 -0
- package/types/Accounts.d.ts +25 -25
- package/types/AccountsResource.d.ts +107 -63
- package/types/ApplicationFeesResource.d.ts +2 -2
- package/types/Apps/Secrets.d.ts +1 -1
- package/types/Balance.d.ts +2 -2
- package/types/BalanceSettings.d.ts +1 -1
- package/types/BalanceTransactions.d.ts +1 -1
- package/types/BalanceTransfers.d.ts +3 -3
- package/types/BalanceTransfersResource.d.ts +1 -1
- package/types/BankAccounts.d.ts +10 -10
- package/types/Billing/Alerts.d.ts +2 -2
- package/types/Billing/CreditBalanceSummary.d.ts +3 -3
- package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactions.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
- package/types/Billing/CreditGrants.d.ts +4 -4
- package/types/Billing/CreditGrantsResource.d.ts +3 -3
- package/types/Billing/MeterEvents.d.ts +1 -1
- package/types/Billing/MeterEventsResource.d.ts +1 -1
- package/types/BillingPortal/Configurations.d.ts +10 -3
- package/types/BillingPortal/ConfigurationsResource.d.ts +20 -6
- package/types/BillingPortal/Sessions.d.ts +7 -7
- package/types/BillingPortal/SessionsResource.d.ts +7 -7
- package/types/Capabilities.d.ts +16 -16
- package/types/Capital/FinancingOffers.d.ts +2 -2
- package/types/Capital/FinancingSummary.d.ts +7 -4
- package/types/Capital/FinancingSummaryResource.d.ts +1 -1
- package/types/Cards.d.ts +2 -2
- package/types/CashBalances.d.ts +3 -3
- package/types/Charges.d.ts +59 -27
- package/types/ChargesResource.d.ts +22 -22
- package/types/Checkout/Sessions.d.ts +18 -18
- package/types/Checkout/SessionsResource.d.ts +90 -60
- package/types/Climate/Orders.d.ts +1 -1
- package/types/Climate/OrdersResource.d.ts +2 -2
- package/types/ConfirmationTokens.d.ts +8 -6
- package/types/Coupons.d.ts +3 -3
- package/types/CouponsResource.d.ts +2 -2
- package/types/CreditNoteLineItems.d.ts +3 -0
- package/types/CreditNotes.d.ts +8 -5
- package/types/CreditNotesResource.d.ts +5 -5
- package/types/CustomerBalanceTransactions.d.ts +9 -6
- package/types/CustomerCashBalanceTransactions.d.ts +13 -10
- package/types/CustomerSessions.d.ts +1 -1
- package/types/Customers.d.ts +8 -5
- package/types/CustomersResource.d.ts +21 -16
- package/types/DelegatedCheckout/RequestedSessions.d.ts +83 -17
- package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +102 -0
- package/types/Discounts.d.ts +6 -6
- package/types/Disputes.d.ts +3 -3
- package/types/DisputesResource.d.ts +1 -1
- package/types/Entitlements/ActiveEntitlements.d.ts +1 -1
- package/types/Errors.d.ts +6 -0
- package/types/Events.d.ts +1 -1
- package/types/ExchangeRates.d.ts +2 -2
- package/types/ExternalAccountsResource.d.ts +4 -4
- package/types/FeeRefunds.d.ts +2 -2
- package/types/FileLinks.d.ts +1 -1
- package/types/FileLinksResource.d.ts +2 -2
- package/types/Files.d.ts +4 -4
- package/types/FilesResource.d.ts +3 -3
- package/types/FinancialConnections/Accounts.d.ts +3 -3
- package/types/FinancialConnections/AccountsResource.d.ts +3 -3
- package/types/FinancialConnections/Sessions.d.ts +2 -2
- package/types/FinancialConnections/SessionsResource.d.ts +3 -3
- package/types/Forwarding/Requests.d.ts +1 -1
- package/types/Forwarding/RequestsResource.d.ts +1 -1
- package/types/FundingInstructions.d.ts +2 -2
- package/types/Identity/BlocklistEntries.d.ts +1 -1
- package/types/Identity/VerificationReports.d.ts +8 -8
- package/types/Identity/VerificationSessions.d.ts +11 -11
- package/types/Identity/VerificationSessionsResource.d.ts +18 -12
- package/types/InvoiceItems.d.ts +12 -12
- package/types/InvoiceItemsResource.d.ts +16 -16
- package/types/InvoiceLineItems.d.ts +11 -8
- package/types/InvoicePayments.d.ts +1 -1
- package/types/InvoiceRenderingTemplates.d.ts +1 -1
- package/types/Invoices.d.ts +83 -33
- package/types/InvoicesResource.d.ts +237 -111
- package/types/Issuing/Authorizations.d.ts +20 -20
- package/types/Issuing/AuthorizationsResource.d.ts +4 -4
- package/types/Issuing/Cardholders.d.ts +13 -13
- package/types/Issuing/CardholdersResource.d.ts +21 -21
- package/types/Issuing/Cards.d.ts +20 -10
- package/types/Issuing/CardsResource.d.ts +46 -13
- package/types/Issuing/CreditUnderwritingRecords.d.ts +5 -5
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +15 -15
- package/types/Issuing/Disputes.d.ts +7 -7
- package/types/Issuing/DisputesResource.d.ts +5 -5
- package/types/Issuing/FraudLiabilityDebits.d.ts +1 -1
- package/types/Issuing/PersonalizationDesigns.d.ts +1 -1
- package/types/Issuing/PersonalizationDesignsResource.d.ts +2 -2
- package/types/Issuing/Programs.d.ts +1 -1
- package/types/Issuing/ProgramsResource.d.ts +1 -1
- package/types/Issuing/Settlements.d.ts +2 -2
- package/types/Issuing/Tokens.d.ts +1 -1
- package/types/Issuing/Transactions.d.ts +13 -13
- package/types/Issuing/TransactionsResource.d.ts +1 -1
- package/types/LineItems.d.ts +3 -3
- package/types/LoginLinks.d.ts +1 -1
- package/types/MandatesResource.d.ts +1 -1
- package/types/Margins.d.ts +1 -1
- package/types/MarginsResource.d.ts +2 -2
- package/types/Orders.d.ts +11 -11
- package/types/OrdersResource.d.ts +24 -24
- package/types/PaymentAttemptRecords.d.ts +119 -18
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +3 -3
- package/types/PaymentIntents.d.ts +72 -44
- package/types/PaymentIntentsResource.d.ts +172 -159
- package/types/PaymentLinks.d.ts +7 -7
- package/types/PaymentLinksResource.d.ts +42 -28
- package/types/PaymentMethodConfigurations.d.ts +4 -4
- package/types/PaymentMethodConfigurationsResource.d.ts +80 -80
- package/types/PaymentMethodDomains.d.ts +1 -1
- package/types/PaymentMethods.d.ts +10 -8
- package/types/PaymentMethodsResource.d.ts +7 -6
- package/types/PaymentRecords.d.ts +126 -18
- package/types/PaymentRecordsResource.d.ts +7 -7
- package/types/Payouts.d.ts +7 -7
- package/types/PayoutsResource.d.ts +3 -3
- package/types/Persons.d.ts +21 -21
- package/types/Plans.d.ts +5 -5
- package/types/PlansResource.d.ts +6 -6
- package/types/Prices.d.ts +6 -6
- package/types/PricesResource.d.ts +10 -10
- package/types/ProductCatalog/TrialOffers.d.ts +1 -1
- package/types/Products.d.ts +10 -10
- package/types/ProductsResource.d.ts +38 -14
- package/types/PromotionCodes.d.ts +5 -5
- package/types/PromotionCodesResource.d.ts +5 -5
- package/types/QuoteLines.d.ts +3 -3
- package/types/QuotePreviewInvoices.d.ts +81 -31
- package/types/QuotePreviewSubscriptionSchedules.d.ts +18 -18
- package/types/Quotes.d.ts +16 -16
- package/types/QuotesResource.d.ts +30 -30
- package/types/Radar/EarlyFraudWarnings.d.ts +1 -1
- package/types/Radar/ValueListItems.d.ts +1 -1
- package/types/Radar/ValueLists.d.ts +2 -2
- package/types/Radar/ValueListsResource.d.ts +2 -2
- package/types/Refunds.d.ts +3 -3
- package/types/RefundsResource.d.ts +3 -3
- package/types/Reporting/ReportRuns.d.ts +3 -3
- package/types/Reporting/ReportRunsResource.d.ts +2 -2
- package/types/Reporting/ReportTypes.d.ts +3 -3
- package/types/Reviews.d.ts +1 -1
- package/types/SetupAttempts.d.ts +21 -18
- package/types/SetupIntents.d.ts +20 -19
- package/types/SetupIntentsResource.d.ts +47 -44
- package/types/SharedPayment/GrantedTokens.d.ts +102 -0
- package/types/SharedPayment/GrantedTokensResource.d.ts +29 -0
- package/types/ShippingRates.d.ts +3 -3
- package/types/ShippingRatesResource.d.ts +3 -3
- package/types/Sigma/ScheduledQueryRuns.d.ts +1 -1
- package/types/SourceMandateNotifications.d.ts +3 -3
- package/types/Sources.d.ts +5 -5
- package/types/SourcesResource.d.ts +2 -2
- package/types/SubscriptionItems.d.ts +7 -7
- package/types/SubscriptionItemsResource.d.ts +22 -22
- package/types/SubscriptionSchedules.d.ts +19 -19
- package/types/SubscriptionSchedulesResource.d.ts +61 -61
- package/types/Subscriptions.d.ts +61 -15
- package/types/SubscriptionsResource.d.ts +142 -58
- package/types/Tax/Associations.d.ts +3 -3
- package/types/Tax/AssociationsResource.d.ts +1 -1
- package/types/Tax/CalculationLineItems.d.ts +7 -7
- package/types/Tax/Calculations.d.ts +12 -12
- package/types/Tax/CalculationsResource.d.ts +7 -7
- package/types/Tax/Registrations.d.ts +3 -3
- package/types/Tax/Settings.d.ts +1 -1
- package/types/Tax/SettingsResource.d.ts +1 -1
- package/types/Tax/TransactionLineItems.d.ts +5 -5
- package/types/Tax/Transactions.d.ts +9 -9
- package/types/Tax/TransactionsResource.d.ts +10 -10
- package/types/TaxIds.d.ts +6 -6
- package/types/TaxIdsResource.d.ts +4 -4
- package/types/TaxRates.d.ts +1 -1
- package/types/TaxRatesResource.d.ts +2 -2
- package/types/Terminal/ConnectionTokens.d.ts +1 -1
- package/types/Terminal/Locations.d.ts +2 -2
- package/types/Terminal/LocationsResource.d.ts +3 -3
- package/types/Terminal/Readers.d.ts +10 -10
- package/types/Terminal/ReadersResource.d.ts +7 -7
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +5 -4
- package/types/TestHelpers/CustomersResource.d.ts +2 -2
- package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +10 -10
- package/types/TestHelpers/Issuing/TransactionsResource.d.ts +5 -5
- package/types/TestHelpers/SharedPayment/GrantedTokensResource.d.ts +87 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +1 -1
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +1 -1
- package/types/Tokens.d.ts +4 -4
- package/types/TokensResource.d.ts +17 -17
- package/types/Topups.d.ts +3 -3
- package/types/TopupsResource.d.ts +3 -3
- package/types/TransferReversals.d.ts +4 -4
- package/types/Transfers.d.ts +5 -5
- package/types/TransfersResource.d.ts +6 -6
- package/types/Treasury/CreditReversals.d.ts +3 -3
- package/types/Treasury/CreditReversalsResource.d.ts +1 -1
- package/types/Treasury/DebitReversals.d.ts +3 -3
- package/types/Treasury/DebitReversalsResource.d.ts +1 -1
- package/types/Treasury/FinancialAccounts.d.ts +1 -1
- package/types/Treasury/FinancialAccountsResource.d.ts +2 -2
- package/types/Treasury/InboundTransfers.d.ts +4 -4
- package/types/Treasury/InboundTransfersResource.d.ts +2 -2
- package/types/Treasury/OutboundPayments.d.ts +5 -5
- package/types/Treasury/OutboundPaymentsResource.d.ts +4 -4
- package/types/Treasury/OutboundTransfers.d.ts +4 -4
- package/types/Treasury/OutboundTransfersResource.d.ts +3 -3
- package/types/Treasury/ReceivedCredits.d.ts +9 -9
- package/types/Treasury/ReceivedDebits.d.ts +6 -6
- package/types/Treasury/TransactionEntries.d.ts +11 -11
- package/types/Treasury/Transactions.d.ts +11 -11
- package/types/V2/Billing/IntentActions.d.ts +141 -36
- package/types/V2/Billing/IntentsResource.d.ts +141 -42
- package/types/V2/Core/AccountLinks.d.ts +11 -11
- package/types/V2/Core/AccountLinksResource.d.ts +6 -6
- package/types/V2/Core/AccountPersons.d.ts +55 -10
- package/types/V2/Core/AccountTokensResource.d.ts +99 -10
- package/types/V2/Core/Accounts/PersonTokensResource.d.ts +48 -3
- package/types/V2/Core/Accounts/PersonsResource.d.ts +101 -11
- package/types/V2/Core/Accounts.d.ts +298 -509
- package/types/V2/Core/AccountsResource.d.ts +256 -51
- package/types/V2/Core/ClaimableSandboxesResource.d.ts +1 -1
- package/types/V2/Core/EventTypes.d.ts +601 -0
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +21 -0
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +26 -0
- package/types/V2/Iam/ApiKeys.d.ts +154 -0
- package/types/V2/Iam/ApiKeysResource.d.ts +215 -0
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +31 -1
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +8 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +2 -0
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +26 -0
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +2 -0
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +10 -1
- package/types/V2/Payments/SettlementAllocationIntentSplits.d.ts +111 -0
- package/types/V2/Payments/SettlementAllocationIntents/SplitsResource.d.ts +126 -0
- package/types/V2/Payments/SettlementAllocationIntents.d.ts +122 -0
- package/types/V2/Payments/SettlementAllocationIntentsResource.d.ts +168 -0
- package/types/V2/Tax/ManualRules.d.ts +142 -0
- package/types/V2/Tax/ManualRulesResource.d.ts +292 -0
- package/types/WebhookEndpoints.d.ts +1 -1
- package/types/WebhookEndpointsResource.d.ts +4 -3
- package/types/apiVersion.d.ts +1 -1
- package/types/index.d.ts +24 -0
package/types/PaymentLinks.d.ts
CHANGED
|
@@ -5,9 +5,9 @@ declare module 'stripe' {
|
|
|
5
5
|
/**
|
|
6
6
|
* A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.
|
|
7
7
|
*
|
|
8
|
-
* When a customer opens a payment link it will open a new [checkout session](https://stripe.com/
|
|
8
|
+
* When a customer opens a payment link it will open a new [checkout session](https://docs.stripe.com/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://docs.stripe.com/api/events/types#event_types-checkout.session.completed) to track payments through payment links.
|
|
9
9
|
*
|
|
10
|
-
* Related guide: [Payment Links API](https://stripe.com/
|
|
10
|
+
* Related guide: [Payment Links API](https://docs.stripe.com/payment-links)
|
|
11
11
|
*/
|
|
12
12
|
interface PaymentLink {
|
|
13
13
|
/**
|
|
@@ -101,7 +101,7 @@ declare module 'stripe' {
|
|
|
101
101
|
livemode: boolean;
|
|
102
102
|
|
|
103
103
|
/**
|
|
104
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
104
|
+
* 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.
|
|
105
105
|
*/
|
|
106
106
|
metadata: Stripe.Metadata;
|
|
107
107
|
|
|
@@ -467,7 +467,7 @@ declare module 'stripe' {
|
|
|
467
467
|
issuer: InvoiceData.Issuer | null;
|
|
468
468
|
|
|
469
469
|
/**
|
|
470
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
470
|
+
* 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.
|
|
471
471
|
*/
|
|
472
472
|
metadata: Stripe.Metadata | null;
|
|
473
473
|
|
|
@@ -591,7 +591,7 @@ declare module 'stripe' {
|
|
|
591
591
|
description: string | null;
|
|
592
592
|
|
|
593
593
|
/**
|
|
594
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
594
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link.
|
|
595
595
|
*/
|
|
596
596
|
metadata: Stripe.Metadata;
|
|
597
597
|
|
|
@@ -611,7 +611,7 @@ declare module 'stripe' {
|
|
|
611
611
|
statement_descriptor_suffix: string | null;
|
|
612
612
|
|
|
613
613
|
/**
|
|
614
|
-
* A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/
|
|
614
|
+
* A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.
|
|
615
615
|
*/
|
|
616
616
|
transfer_group: string | null;
|
|
617
617
|
}
|
|
@@ -967,7 +967,7 @@ declare module 'stripe' {
|
|
|
967
967
|
invoice_settings: SubscriptionData.InvoiceSettings;
|
|
968
968
|
|
|
969
969
|
/**
|
|
970
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
970
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link.
|
|
971
971
|
*/
|
|
972
972
|
metadata: Stripe.Metadata;
|
|
973
973
|
|
|
@@ -59,7 +59,7 @@ declare module 'stripe' {
|
|
|
59
59
|
custom_text?: PaymentLinkCreateParams.CustomText;
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
|
-
* Configures whether [checkout sessions](https://stripe.com/
|
|
62
|
+
* Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers).
|
|
63
63
|
*/
|
|
64
64
|
customer_creation?: PaymentLinkCreateParams.CustomerCreation;
|
|
65
65
|
|
|
@@ -79,7 +79,7 @@ declare module 'stripe' {
|
|
|
79
79
|
invoice_creation?: PaymentLinkCreateParams.InvoiceCreation;
|
|
80
80
|
|
|
81
81
|
/**
|
|
82
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
82
|
+
* 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link.
|
|
83
83
|
*/
|
|
84
84
|
metadata?: Stripe.MetadataParam;
|
|
85
85
|
|
|
@@ -94,7 +94,7 @@ declare module 'stripe' {
|
|
|
94
94
|
on_behalf_of?: string;
|
|
95
95
|
|
|
96
96
|
/**
|
|
97
|
-
* A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/
|
|
97
|
+
* A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices).
|
|
98
98
|
* There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.
|
|
99
99
|
* There is a maximum of 20 combined line items and optional items.
|
|
100
100
|
*/
|
|
@@ -110,12 +110,12 @@ declare module 'stripe' {
|
|
|
110
110
|
*
|
|
111
111
|
* Can only be set in `subscription` mode. Defaults to `always`.
|
|
112
112
|
*
|
|
113
|
-
* If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/
|
|
113
|
+
* If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://docs.stripe.com/payments/checkout/free-trials).
|
|
114
114
|
*/
|
|
115
115
|
payment_method_collection?: PaymentLinkCreateParams.PaymentMethodCollection;
|
|
116
116
|
|
|
117
117
|
/**
|
|
118
|
-
* The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/
|
|
118
|
+
* The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://docs.stripe.com/payments/payment-methods/integration-options#payment-method-product-support)).
|
|
119
119
|
*/
|
|
120
120
|
payment_method_types?: Array<PaymentLinkCreateParams.PaymentMethodType>;
|
|
121
121
|
|
|
@@ -137,12 +137,12 @@ declare module 'stripe' {
|
|
|
137
137
|
shipping_address_collection?: PaymentLinkCreateParams.ShippingAddressCollection;
|
|
138
138
|
|
|
139
139
|
/**
|
|
140
|
-
* The shipping rate options to apply to [checkout sessions](https://stripe.com/
|
|
140
|
+
* The shipping rate options to apply to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link.
|
|
141
141
|
*/
|
|
142
142
|
shipping_options?: Array<PaymentLinkCreateParams.ShippingOption>;
|
|
143
143
|
|
|
144
144
|
/**
|
|
145
|
-
* Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/
|
|
145
|
+
* Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
|
|
146
146
|
*/
|
|
147
147
|
submit_type?: PaymentLinkCreateParams.SubmitType;
|
|
148
148
|
|
|
@@ -190,7 +190,7 @@ declare module 'stripe' {
|
|
|
190
190
|
|
|
191
191
|
interface Redirect {
|
|
192
192
|
/**
|
|
193
|
-
* The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/
|
|
193
|
+
* The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id) included.
|
|
194
194
|
*/
|
|
195
195
|
url: string;
|
|
196
196
|
}
|
|
@@ -479,7 +479,7 @@ declare module 'stripe' {
|
|
|
479
479
|
issuer?: InvoiceData.Issuer;
|
|
480
480
|
|
|
481
481
|
/**
|
|
482
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
482
|
+
* 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`.
|
|
483
483
|
*/
|
|
484
484
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
485
485
|
|
|
@@ -545,12 +545,12 @@ declare module 'stripe' {
|
|
|
545
545
|
adjustable_quantity?: LineItem.AdjustableQuantity;
|
|
546
546
|
|
|
547
547
|
/**
|
|
548
|
-
* The ID of the [Price](https://stripe.com/
|
|
548
|
+
* The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. One of `price` or `price_data` is required.
|
|
549
549
|
*/
|
|
550
550
|
price?: string;
|
|
551
551
|
|
|
552
552
|
/**
|
|
553
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
553
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
554
554
|
*/
|
|
555
555
|
price_data?: LineItem.PriceData;
|
|
556
556
|
|
|
@@ -600,7 +600,7 @@ declare module 'stripe' {
|
|
|
600
600
|
recurring?: PriceData.Recurring;
|
|
601
601
|
|
|
602
602
|
/**
|
|
603
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
603
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
604
604
|
*/
|
|
605
605
|
tax_behavior?: PriceData.TaxBehavior;
|
|
606
606
|
|
|
@@ -628,7 +628,7 @@ declare module 'stripe' {
|
|
|
628
628
|
images?: Array<string>;
|
|
629
629
|
|
|
630
630
|
/**
|
|
631
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
631
|
+
* 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`.
|
|
632
632
|
*/
|
|
633
633
|
metadata?: Stripe.MetadataParam;
|
|
634
634
|
|
|
@@ -638,7 +638,7 @@ declare module 'stripe' {
|
|
|
638
638
|
name: string;
|
|
639
639
|
|
|
640
640
|
/**
|
|
641
|
-
* A [tax code](https://stripe.com/
|
|
641
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
642
642
|
*/
|
|
643
643
|
tax_code?: string;
|
|
644
644
|
|
|
@@ -646,6 +646,20 @@ declare module 'stripe' {
|
|
|
646
646
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
647
647
|
*/
|
|
648
648
|
unit_label?: string;
|
|
649
|
+
|
|
650
|
+
/**
|
|
651
|
+
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
652
|
+
*/
|
|
653
|
+
tax_details?: ProductData.TaxDetails;
|
|
654
|
+
}
|
|
655
|
+
|
|
656
|
+
namespace ProductData {
|
|
657
|
+
interface TaxDetails {
|
|
658
|
+
/**
|
|
659
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
660
|
+
*/
|
|
661
|
+
tax_code: string;
|
|
662
|
+
}
|
|
649
663
|
}
|
|
650
664
|
|
|
651
665
|
interface Recurring {
|
|
@@ -713,7 +727,7 @@ declare module 'stripe' {
|
|
|
713
727
|
adjustable_quantity?: OptionalItem.AdjustableQuantity;
|
|
714
728
|
|
|
715
729
|
/**
|
|
716
|
-
* The ID of the [Price](https://stripe.com/
|
|
730
|
+
* The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object.
|
|
717
731
|
*/
|
|
718
732
|
price: string;
|
|
719
733
|
|
|
@@ -754,12 +768,12 @@ declare module 'stripe' {
|
|
|
754
768
|
description?: string;
|
|
755
769
|
|
|
756
770
|
/**
|
|
757
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
771
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
758
772
|
*/
|
|
759
773
|
metadata?: Stripe.MetadataParam;
|
|
760
774
|
|
|
761
775
|
/**
|
|
762
|
-
* Indicates that you intend to [make future payments](https://stripe.com/
|
|
776
|
+
* Indicates that you intend to [make future payments](https://docs.stripe.com/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.
|
|
763
777
|
*
|
|
764
778
|
* When setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.
|
|
765
779
|
*
|
|
@@ -786,7 +800,7 @@ declare module 'stripe' {
|
|
|
786
800
|
statement_descriptor_suffix?: string;
|
|
787
801
|
|
|
788
802
|
/**
|
|
789
|
-
* A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/
|
|
803
|
+
* A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.
|
|
790
804
|
*/
|
|
791
805
|
transfer_group?: string;
|
|
792
806
|
}
|
|
@@ -1139,7 +1153,7 @@ declare module 'stripe' {
|
|
|
1139
1153
|
invoice_settings?: SubscriptionData.InvoiceSettings;
|
|
1140
1154
|
|
|
1141
1155
|
/**
|
|
1142
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1156
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
1143
1157
|
*/
|
|
1144
1158
|
metadata?: Stripe.MetadataParam;
|
|
1145
1159
|
|
|
@@ -1279,7 +1293,7 @@ declare module 'stripe' {
|
|
|
1279
1293
|
custom_text?: PaymentLinkUpdateParams.CustomText;
|
|
1280
1294
|
|
|
1281
1295
|
/**
|
|
1282
|
-
* Configures whether [checkout sessions](https://stripe.com/
|
|
1296
|
+
* Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers).
|
|
1283
1297
|
*/
|
|
1284
1298
|
customer_creation?: PaymentLinkUpdateParams.CustomerCreation;
|
|
1285
1299
|
|
|
@@ -1304,7 +1318,7 @@ declare module 'stripe' {
|
|
|
1304
1318
|
line_items?: Array<PaymentLinkUpdateParams.LineItem>;
|
|
1305
1319
|
|
|
1306
1320
|
/**
|
|
1307
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1321
|
+
* 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link.
|
|
1308
1322
|
*/
|
|
1309
1323
|
metadata?: Stripe.MetadataParam;
|
|
1310
1324
|
|
|
@@ -1325,7 +1339,7 @@ declare module 'stripe' {
|
|
|
1325
1339
|
*
|
|
1326
1340
|
* Can only be set in `subscription` mode. Defaults to `always`.
|
|
1327
1341
|
*
|
|
1328
|
-
* If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/
|
|
1342
|
+
* If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://docs.stripe.com/payments/checkout/free-trials).
|
|
1329
1343
|
*/
|
|
1330
1344
|
payment_method_collection?: PaymentLinkUpdateParams.PaymentMethodCollection;
|
|
1331
1345
|
|
|
@@ -1356,7 +1370,7 @@ declare module 'stripe' {
|
|
|
1356
1370
|
>;
|
|
1357
1371
|
|
|
1358
1372
|
/**
|
|
1359
|
-
* Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/
|
|
1373
|
+
* Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
|
|
1360
1374
|
*/
|
|
1361
1375
|
submit_type?: PaymentLinkUpdateParams.SubmitType;
|
|
1362
1376
|
|
|
@@ -1399,7 +1413,7 @@ declare module 'stripe' {
|
|
|
1399
1413
|
|
|
1400
1414
|
interface Redirect {
|
|
1401
1415
|
/**
|
|
1402
|
-
* The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/
|
|
1416
|
+
* The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id) included.
|
|
1403
1417
|
*/
|
|
1404
1418
|
url: string;
|
|
1405
1419
|
}
|
|
@@ -1650,7 +1664,7 @@ declare module 'stripe' {
|
|
|
1650
1664
|
issuer?: InvoiceData.Issuer;
|
|
1651
1665
|
|
|
1652
1666
|
/**
|
|
1653
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1667
|
+
* 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`.
|
|
1654
1668
|
*/
|
|
1655
1669
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
1656
1670
|
|
|
@@ -1790,7 +1804,7 @@ declare module 'stripe' {
|
|
|
1790
1804
|
description?: Stripe.Emptyable<string>;
|
|
1791
1805
|
|
|
1792
1806
|
/**
|
|
1793
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1807
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
1794
1808
|
*/
|
|
1795
1809
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
1796
1810
|
|
|
@@ -1807,7 +1821,7 @@ declare module 'stripe' {
|
|
|
1807
1821
|
statement_descriptor_suffix?: Stripe.Emptyable<string>;
|
|
1808
1822
|
|
|
1809
1823
|
/**
|
|
1810
|
-
* A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/
|
|
1824
|
+
* A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.
|
|
1811
1825
|
*/
|
|
1812
1826
|
transfer_group?: Stripe.Emptyable<string>;
|
|
1813
1827
|
}
|
|
@@ -2142,7 +2156,7 @@ declare module 'stripe' {
|
|
|
2142
2156
|
invoice_settings?: SubscriptionData.InvoiceSettings;
|
|
2143
2157
|
|
|
2144
2158
|
/**
|
|
2145
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
2159
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
2146
2160
|
*/
|
|
2147
2161
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
2148
2162
|
|
|
@@ -5,7 +5,7 @@ declare module 'stripe' {
|
|
|
5
5
|
/**
|
|
6
6
|
* PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.
|
|
7
7
|
*
|
|
8
|
-
* There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/
|
|
8
|
+
* There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://docs.stripe.com/connect/charges):
|
|
9
9
|
*
|
|
10
10
|
* **Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.
|
|
11
11
|
*
|
|
@@ -14,9 +14,9 @@ declare module 'stripe' {
|
|
|
14
14
|
* Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account's associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.
|
|
15
15
|
*
|
|
16
16
|
* Related guides:
|
|
17
|
-
* - [Payment Method Configurations API](https://stripe.com/
|
|
18
|
-
* - [Multiple configurations on dynamic payment methods](https://stripe.com/
|
|
19
|
-
* - [Multiple configurations for your Connect accounts](https://stripe.com/
|
|
17
|
+
* - [Payment Method Configurations API](https://docs.stripe.com/connect/payment-method-configurations)
|
|
18
|
+
* - [Multiple configurations on dynamic payment methods](https://docs.stripe.com/payments/multiple-payment-method-configs)
|
|
19
|
+
* - [Multiple configurations for your Connect accounts](https://docs.stripe.com/connect/multiple-payment-method-configurations)
|
|
20
20
|
*/
|
|
21
21
|
interface PaymentMethodConfiguration {
|
|
22
22
|
/**
|