stripe 18.5.0-beta.1 → 18.5.0
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 +60 -1322
- package/OPENAPI_VERSION +1 -1
- package/README.md +5 -4
- package/VERSION +1 -1
- package/cjs/Error.js +1 -107
- package/cjs/apiVersion.js +3 -2
- package/cjs/resources/FinancialConnections/Accounts.js +0 -5
- package/cjs/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +4 -4
- package/cjs/resources/PaymentIntents.js +0 -13
- package/cjs/resources/Quotes.js +0 -32
- package/cjs/resources/SubscriptionSchedules.js +0 -4
- package/cjs/resources.js +34 -126
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +0 -93
- package/esm/apiVersion.js +2 -1
- package/esm/resources/FinancialConnections/Accounts.js +0 -5
- package/esm/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +3 -3
- package/esm/resources/PaymentIntents.js +0 -13
- package/esm/resources/Quotes.js +0 -32
- package/esm/resources/SubscriptionSchedules.js +0 -4
- package/esm/resources.js +6 -91
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +1 -5
- package/types/AccountSessions.d.ts +45 -45
- package/types/AccountSessionsResource.d.ts +51 -252
- package/types/Accounts.d.ts +3 -214
- package/types/AccountsResource.d.ts +0 -544
- package/types/Balance.d.ts +2 -7
- package/types/Billing/CreditBalanceSummary.d.ts +0 -5
- package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
- package/types/Billing/CreditGrants.d.ts +0 -5
- package/types/Billing/CreditGrantsResource.d.ts +1 -11
- package/types/Billing/Meters.d.ts +1 -1
- package/types/Billing/MetersResource.d.ts +1 -1
- package/types/BillingPortal/Configurations.d.ts +5 -0
- package/types/BillingPortal/ConfigurationsResource.d.ts +10 -0
- package/types/BillingPortal/Sessions.d.ts +0 -5
- package/types/BillingPortal/SessionsResource.d.ts +4 -12
- package/types/Cards.d.ts +0 -5
- package/types/CashBalances.d.ts +0 -5
- package/types/Charges.d.ts +76 -171
- package/types/ChargesResource.d.ts +0 -1406
- package/types/Checkout/Sessions.d.ts +9 -313
- package/types/Checkout/SessionsResource.d.ts +10 -414
- package/types/ConfirmationTokens.d.ts +0 -125
- package/types/Coupons.d.ts +0 -33
- package/types/CouponsResource.d.ts +0 -21
- package/types/CreditNoteLineItems.d.ts +0 -17
- package/types/CreditNotes.d.ts +0 -5
- package/types/CreditNotesResource.d.ts +3 -8
- package/types/CustomerBalanceTransactions.d.ts +0 -2
- package/types/CustomerCashBalanceTransactions.d.ts +0 -2
- package/types/CustomerSessions.d.ts +0 -5
- package/types/CustomerSessionsResource.d.ts +1 -6
- package/types/Customers.d.ts +0 -2
- package/types/CustomersResource.d.ts +0 -8
- package/types/Discounts.d.ts +0 -10
- package/types/Disputes.d.ts +7 -31
- package/types/Errors.d.ts +2 -81
- package/types/EventTypes.d.ts +0 -664
- package/types/Events.d.ts +0 -97
- package/types/FileLinksResource.d.ts +1 -1
- package/types/Files.d.ts +1 -0
- package/types/FilesResource.d.ts +3 -1
- package/types/FinancialConnections/Accounts.d.ts +1 -36
- package/types/FinancialConnections/AccountsResource.d.ts +3 -40
- package/types/FinancialConnections/Sessions.d.ts +1 -51
- package/types/FinancialConnections/SessionsResource.d.ts +1 -43
- package/types/Identity/VerificationSessions.d.ts +0 -5
- package/types/Identity/VerificationSessionsResource.d.ts +0 -7
- package/types/InvoiceItems.d.ts +0 -10
- package/types/InvoiceItemsResource.d.ts +6 -117
- package/types/InvoiceLineItems.d.ts +1 -45
- package/types/InvoicePayments.d.ts +0 -5
- package/types/InvoicePaymentsResource.d.ts +74 -0
- package/types/Invoices.d.ts +6 -172
- package/types/InvoicesResource.d.ts +61 -1513
- package/types/Issuing/CardholdersResource.d.ts +1 -2
- package/types/Issuing/CardsResource.d.ts +10 -0
- package/types/Issuing/Transactions.d.ts +0 -5
- package/types/Issuing/TransactionsResource.d.ts +0 -5
- package/types/LineItems.d.ts +0 -49
- package/types/Mandates.d.ts +0 -77
- package/types/PaymentIntents.d.ts +63 -762
- package/types/PaymentIntentsResource.d.ts +5567 -11125
- package/types/PaymentLinks.d.ts +0 -6
- package/types/PaymentLinksResource.d.ts +1 -13
- package/types/PaymentMethodConfigurations.d.ts +0 -180
- package/types/PaymentMethodConfigurationsResource.d.ts +0 -250
- package/types/PaymentMethods.d.ts +0 -125
- package/types/PaymentMethodsResource.d.ts +2 -167
- package/types/Payouts.d.ts +1 -1
- package/types/Prices.d.ts +0 -22
- package/types/PricesResource.d.ts +0 -22
- package/types/PromotionCodes.d.ts +5 -7
- package/types/PromotionCodesResource.d.ts +0 -10
- package/types/Quotes.d.ts +1 -594
- package/types/QuotesResource.d.ts +281 -2626
- package/types/Refunds.d.ts +0 -14
- package/types/SetupAttempts.d.ts +4 -48
- package/types/SetupIntents.d.ts +5 -119
- package/types/SetupIntentsResource.d.ts +3 -730
- package/types/Sources.d.ts +0 -29
- package/types/SubscriptionItems.d.ts +0 -21
- package/types/SubscriptionItemsResource.d.ts +0 -109
- package/types/SubscriptionSchedules.d.ts +39 -197
- package/types/SubscriptionSchedulesResource.d.ts +83 -1199
- package/types/Subscriptions.d.ts +1 -135
- package/types/SubscriptionsResource.d.ts +97 -449
- package/types/TaxIds.d.ts +0 -10
- package/types/TaxIdsResource.d.ts +0 -10
- package/types/Terminal/Configurations.d.ts +19 -0
- package/types/Terminal/ConfigurationsResource.d.ts +44 -0
- package/types/Terminal/Readers.d.ts +0 -20
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -126
- package/types/TestHelpers/Terminal/ReadersResource.d.ts +28 -1
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
- package/types/Transfers.d.ts +0 -5
- package/types/TransfersResource.d.ts +0 -5
- package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
- package/types/Treasury/FinancialAccounts.d.ts +0 -5
- package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
- package/types/Treasury/OutboundTransfers.d.ts +0 -26
- package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
- package/types/Treasury/ReceivedCredits.d.ts +0 -26
- package/types/Treasury/ReceivedDebits.d.ts +0 -31
- package/types/V2/EventTypes.d.ts +4 -964
- package/types/WebhookEndpointsResource.d.ts +2 -79
- package/types/index.d.ts +4 -147
- package/types/lib.d.ts +1 -11
- package/types/test/typescriptTest.ts +3 -3
- package/cjs/resources/AccountNotices.js +0 -21
- package/cjs/resources/BalanceSettings.js +0 -10
- package/cjs/resources/Billing/MeterUsage.js +0 -12
- package/cjs/resources/Capital/FinancingOffers.js +0 -21
- package/cjs/resources/Capital/FinancingSummary.js +0 -12
- package/cjs/resources/Capital/FinancingTransactions.js +0 -17
- package/cjs/resources/ExternalAccounts.js +0 -23
- package/cjs/resources/FinancialConnections/Institutions.js +0 -17
- package/cjs/resources/FxQuotes.js +0 -15
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
- package/cjs/resources/Margins.js +0 -22
- package/cjs/resources/Orders.js +0 -24
- package/cjs/resources/PaymentRecords.js +0 -29
- package/cjs/resources/Privacy/RedactionJobs.js +0 -42
- package/cjs/resources/Tax/Associations.js +0 -9
- package/cjs/resources/Tax/Forms.js +0 -20
- package/cjs/resources/Terminal/OnboardingLinks.js +0 -12
- package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
- package/cjs/resources/V2/Core/AccountLinks.js +0 -9
- package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
- package/cjs/resources/V2/Core/Accounts.js +0 -25
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -25
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
- package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
- package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -25
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
- package/esm/resources/AccountNotices.js +0 -18
- package/esm/resources/BalanceSettings.js +0 -7
- package/esm/resources/Billing/MeterUsage.js +0 -9
- package/esm/resources/Capital/FinancingOffers.js +0 -18
- package/esm/resources/Capital/FinancingSummary.js +0 -9
- package/esm/resources/Capital/FinancingTransactions.js +0 -14
- package/esm/resources/ExternalAccounts.js +0 -20
- package/esm/resources/FinancialConnections/Institutions.js +0 -14
- package/esm/resources/FxQuotes.js +0 -12
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
- package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
- package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
- package/esm/resources/Margins.js +0 -19
- package/esm/resources/Orders.js +0 -21
- package/esm/resources/PaymentRecords.js +0 -26
- package/esm/resources/Privacy/RedactionJobs.js +0 -39
- package/esm/resources/Tax/Associations.js +0 -6
- package/esm/resources/Tax/Forms.js +0 -17
- package/esm/resources/Terminal/OnboardingLinks.js +0 -9
- package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
- package/esm/resources/V2/Core/AccountLinks.js +0 -6
- package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
- package/esm/resources/V2/Core/Accounts.js +0 -22
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
- package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -22
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
- package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
- package/esm/resources/V2/Payments/OffSessionPayments.js +0 -22
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
- package/types/AccountNotices.d.ts +0 -113
- package/types/AccountNoticesResource.d.ts +0 -98
- package/types/BalanceSettings.d.ts +0 -91
- package/types/BalanceSettingsResource.d.ts +0 -110
- package/types/Billing/MeterUsage.d.ts +0 -32
- package/types/Billing/MeterUsageResource.d.ts +0 -685
- package/types/Billing/MeterUsageRows.d.ts +0 -49
- package/types/Capital/FinancingOffers.d.ts +0 -188
- package/types/Capital/FinancingOffersResource.d.ts +0 -97
- package/types/Capital/FinancingSummary.d.ts +0 -106
- package/types/Capital/FinancingSummaryResource.d.ts +0 -27
- package/types/Capital/FinancingTransactions.d.ts +0 -135
- package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
- package/types/ExternalAccountsResource.d.ts +0 -304
- package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
- package/types/FinancialConnections/Institutions.d.ts +0 -98
- package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
- package/types/FxQuotes.d.ts +0 -155
- package/types/FxQuotesResource.d.ts +0 -130
- package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
- package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
- package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
- package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
- package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
- package/types/Issuing/Settlements.d.ts +0 -113
- package/types/Margins.d.ts +0 -56
- package/types/MarginsResource.d.ts +0 -114
- package/types/Orders.d.ts +0 -1163
- package/types/OrdersResource.d.ts +0 -3139
- package/types/PaymentAttemptRecords.d.ts +0 -2166
- package/types/PaymentAttemptRecordsResource.d.ts +0 -47
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -116
- package/types/PaymentRecords.d.ts +0 -2159
- package/types/PaymentRecordsResource.d.ts +0 -455
- package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
- package/types/Privacy/RedactionJobs.d.ts +0 -111
- package/types/Privacy/RedactionJobsResource.d.ts +0 -230
- package/types/QuoteLines.d.ts +0 -634
- package/types/QuotePreviewInvoices.d.ts +0 -1734
- package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -845
- package/types/Tax/Associations.d.ts +0 -82
- package/types/Tax/AssociationsResource.d.ts +0 -29
- package/types/Tax/Forms.d.ts +0 -220
- package/types/Tax/FormsResource.d.ts +0 -107
- package/types/Terminal/OnboardingLinks.d.ts +0 -57
- package/types/Terminal/OnboardingLinksResource.d.ts +0 -62
- package/types/Terminal/ReaderCollectedData.d.ts +0 -51
- package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
- package/types/V2/Core/AccountLinks.d.ts +0 -168
- package/types/V2/Core/AccountLinksResource.d.ts +0 -152
- package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3780
- package/types/V2/Core/Accounts.d.ts +0 -8813
- package/types/V2/Core/AccountsResource.d.ts +0 -10626
- package/types/V2/Core/Persons.d.ts +0 -1872
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
- package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
- package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
- package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
- package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
- package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
- package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -580
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -326
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -314
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -289
- package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
- package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -168
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
- package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
- package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -208
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -160
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -87
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -262
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
- package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
- package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -155
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
- package/types/V2/MoneyManagement/Transactions.d.ts +0 -170
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
- package/types/V2/Payments/OffSessionPayments.d.ts +0 -179
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -174
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -68
|
@@ -3,6 +3,11 @@
|
|
|
3
3
|
declare module 'stripe' {
|
|
4
4
|
namespace Stripe {
|
|
5
5
|
interface SubscriptionCreateParams {
|
|
6
|
+
/**
|
|
7
|
+
* The identifier of the customer to subscribe.
|
|
8
|
+
*/
|
|
9
|
+
customer: string;
|
|
10
|
+
|
|
6
11
|
/**
|
|
7
12
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
|
|
8
13
|
*/
|
|
@@ -65,16 +70,6 @@ declare module 'stripe' {
|
|
|
65
70
|
*/
|
|
66
71
|
currency?: string;
|
|
67
72
|
|
|
68
|
-
/**
|
|
69
|
-
* The identifier of the customer to subscribe.
|
|
70
|
-
*/
|
|
71
|
-
customer?: string;
|
|
72
|
-
|
|
73
|
-
/**
|
|
74
|
-
* The identifier of the account to subscribe.
|
|
75
|
-
*/
|
|
76
|
-
customer_account?: string;
|
|
77
|
-
|
|
78
73
|
/**
|
|
79
74
|
* Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
|
|
80
75
|
*/
|
|
@@ -162,11 +157,6 @@ declare module 'stripe' {
|
|
|
162
157
|
SubscriptionCreateParams.PendingInvoiceItemInterval
|
|
163
158
|
>;
|
|
164
159
|
|
|
165
|
-
/**
|
|
166
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
167
|
-
*/
|
|
168
|
-
prebilling?: SubscriptionCreateParams.Prebilling;
|
|
169
|
-
|
|
170
160
|
/**
|
|
171
161
|
* Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
|
|
172
162
|
*/
|
|
@@ -205,6 +195,16 @@ declare module 'stripe' {
|
|
|
205
195
|
*/
|
|
206
196
|
discounts?: Array<AddInvoiceItem.Discount>;
|
|
207
197
|
|
|
198
|
+
/**
|
|
199
|
+
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
200
|
+
*/
|
|
201
|
+
metadata?: Stripe.MetadataParam;
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* The period associated with this invoice item. Defaults to the current period of the subscription.
|
|
205
|
+
*/
|
|
206
|
+
period?: AddInvoiceItem.Period;
|
|
207
|
+
|
|
208
208
|
/**
|
|
209
209
|
* The ID of the price object. One of `price` or `price_data` is required.
|
|
210
210
|
*/
|
|
@@ -238,53 +238,55 @@ declare module 'stripe' {
|
|
|
238
238
|
*/
|
|
239
239
|
discount?: string;
|
|
240
240
|
|
|
241
|
-
/**
|
|
242
|
-
* Details to determine how long the discount should be applied for.
|
|
243
|
-
*/
|
|
244
|
-
discount_end?: Discount.DiscountEnd;
|
|
245
|
-
|
|
246
241
|
/**
|
|
247
242
|
* ID of the promotion code to create a new discount for.
|
|
248
243
|
*/
|
|
249
244
|
promotion_code?: string;
|
|
250
245
|
}
|
|
251
246
|
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
duration?: DiscountEnd.Duration;
|
|
247
|
+
interface Period {
|
|
248
|
+
/**
|
|
249
|
+
* End of the invoice item period.
|
|
250
|
+
*/
|
|
251
|
+
end: Period.End;
|
|
258
252
|
|
|
253
|
+
/**
|
|
254
|
+
* Start of the invoice item period.
|
|
255
|
+
*/
|
|
256
|
+
start: Period.Start;
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
namespace Period {
|
|
260
|
+
interface End {
|
|
259
261
|
/**
|
|
260
|
-
* A precise Unix timestamp for the
|
|
262
|
+
* A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
|
|
261
263
|
*/
|
|
262
264
|
timestamp?: number;
|
|
263
265
|
|
|
264
266
|
/**
|
|
265
|
-
*
|
|
267
|
+
* Select how to calculate the end of the invoice item period.
|
|
266
268
|
*/
|
|
267
|
-
type:
|
|
269
|
+
type: End.Type;
|
|
268
270
|
}
|
|
269
271
|
|
|
270
|
-
namespace
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
274
|
-
*/
|
|
275
|
-
interval: Duration.Interval;
|
|
272
|
+
namespace End {
|
|
273
|
+
type Type = 'min_item_period_end' | 'timestamp';
|
|
274
|
+
}
|
|
276
275
|
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
276
|
+
interface Start {
|
|
277
|
+
/**
|
|
278
|
+
* A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
|
|
279
|
+
*/
|
|
280
|
+
timestamp?: number;
|
|
282
281
|
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
282
|
+
/**
|
|
283
|
+
* Select how to calculate the start of the invoice item period.
|
|
284
|
+
*/
|
|
285
|
+
type: Start.Type;
|
|
286
|
+
}
|
|
286
287
|
|
|
287
|
-
|
|
288
|
+
namespace Start {
|
|
289
|
+
type Type = 'max_item_period_start' | 'now' | 'timestamp';
|
|
288
290
|
}
|
|
289
291
|
}
|
|
290
292
|
|
|
@@ -352,27 +354,27 @@ declare module 'stripe' {
|
|
|
352
354
|
|
|
353
355
|
interface BillingCycleAnchorConfig {
|
|
354
356
|
/**
|
|
355
|
-
* The day of the month the
|
|
357
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
356
358
|
*/
|
|
357
359
|
day_of_month: number;
|
|
358
360
|
|
|
359
361
|
/**
|
|
360
|
-
* The hour of the day the
|
|
362
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
361
363
|
*/
|
|
362
364
|
hour?: number;
|
|
363
365
|
|
|
364
366
|
/**
|
|
365
|
-
* The minute of the hour the
|
|
367
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
366
368
|
*/
|
|
367
369
|
minute?: number;
|
|
368
370
|
|
|
369
371
|
/**
|
|
370
|
-
* The month to start full cycle
|
|
372
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
371
373
|
*/
|
|
372
374
|
month?: number;
|
|
373
375
|
|
|
374
376
|
/**
|
|
375
|
-
* The second of the minute the
|
|
377
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
376
378
|
*/
|
|
377
379
|
second?: number;
|
|
378
380
|
}
|
|
@@ -415,56 +417,12 @@ declare module 'stripe' {
|
|
|
415
417
|
*/
|
|
416
418
|
discount?: string;
|
|
417
419
|
|
|
418
|
-
/**
|
|
419
|
-
* Details to determine how long the discount should be applied for.
|
|
420
|
-
*/
|
|
421
|
-
discount_end?: Discount.DiscountEnd;
|
|
422
|
-
|
|
423
420
|
/**
|
|
424
421
|
* ID of the promotion code to create a new discount for.
|
|
425
422
|
*/
|
|
426
423
|
promotion_code?: string;
|
|
427
424
|
}
|
|
428
425
|
|
|
429
|
-
namespace Discount {
|
|
430
|
-
interface DiscountEnd {
|
|
431
|
-
/**
|
|
432
|
-
* Time span for the redeemed discount.
|
|
433
|
-
*/
|
|
434
|
-
duration?: DiscountEnd.Duration;
|
|
435
|
-
|
|
436
|
-
/**
|
|
437
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
438
|
-
*/
|
|
439
|
-
timestamp?: number;
|
|
440
|
-
|
|
441
|
-
/**
|
|
442
|
-
* The type of calculation made to determine when the discount ends.
|
|
443
|
-
*/
|
|
444
|
-
type: DiscountEnd.Type;
|
|
445
|
-
}
|
|
446
|
-
|
|
447
|
-
namespace DiscountEnd {
|
|
448
|
-
interface Duration {
|
|
449
|
-
/**
|
|
450
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
451
|
-
*/
|
|
452
|
-
interval: Duration.Interval;
|
|
453
|
-
|
|
454
|
-
/**
|
|
455
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
456
|
-
*/
|
|
457
|
-
interval_count: number;
|
|
458
|
-
}
|
|
459
|
-
|
|
460
|
-
namespace Duration {
|
|
461
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
462
|
-
}
|
|
463
|
-
|
|
464
|
-
type Type = 'duration' | 'timestamp';
|
|
465
|
-
}
|
|
466
|
-
}
|
|
467
|
-
|
|
468
426
|
interface InvoiceSettings {
|
|
469
427
|
/**
|
|
470
428
|
* The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
|
|
@@ -535,11 +493,6 @@ declare module 'stripe' {
|
|
|
535
493
|
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
536
494
|
*/
|
|
537
495
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
538
|
-
|
|
539
|
-
/**
|
|
540
|
-
* Define options to configure the trial on the subscription item.
|
|
541
|
-
*/
|
|
542
|
-
trial?: Item.Trial;
|
|
543
496
|
}
|
|
544
497
|
|
|
545
498
|
namespace Item {
|
|
@@ -561,56 +514,12 @@ declare module 'stripe' {
|
|
|
561
514
|
*/
|
|
562
515
|
discount?: string;
|
|
563
516
|
|
|
564
|
-
/**
|
|
565
|
-
* Details to determine how long the discount should be applied for.
|
|
566
|
-
*/
|
|
567
|
-
discount_end?: Discount.DiscountEnd;
|
|
568
|
-
|
|
569
517
|
/**
|
|
570
518
|
* ID of the promotion code to create a new discount for.
|
|
571
519
|
*/
|
|
572
520
|
promotion_code?: string;
|
|
573
521
|
}
|
|
574
522
|
|
|
575
|
-
namespace Discount {
|
|
576
|
-
interface DiscountEnd {
|
|
577
|
-
/**
|
|
578
|
-
* Time span for the redeemed discount.
|
|
579
|
-
*/
|
|
580
|
-
duration?: DiscountEnd.Duration;
|
|
581
|
-
|
|
582
|
-
/**
|
|
583
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
584
|
-
*/
|
|
585
|
-
timestamp?: number;
|
|
586
|
-
|
|
587
|
-
/**
|
|
588
|
-
* The type of calculation made to determine when the discount ends.
|
|
589
|
-
*/
|
|
590
|
-
type: DiscountEnd.Type;
|
|
591
|
-
}
|
|
592
|
-
|
|
593
|
-
namespace DiscountEnd {
|
|
594
|
-
interface Duration {
|
|
595
|
-
/**
|
|
596
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
597
|
-
*/
|
|
598
|
-
interval: Duration.Interval;
|
|
599
|
-
|
|
600
|
-
/**
|
|
601
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
602
|
-
*/
|
|
603
|
-
interval_count: number;
|
|
604
|
-
}
|
|
605
|
-
|
|
606
|
-
namespace Duration {
|
|
607
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
608
|
-
}
|
|
609
|
-
|
|
610
|
-
type Type = 'duration' | 'timestamp';
|
|
611
|
-
}
|
|
612
|
-
}
|
|
613
|
-
|
|
614
523
|
interface PriceData {
|
|
615
524
|
/**
|
|
616
525
|
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
@@ -662,22 +571,6 @@ declare module 'stripe' {
|
|
|
662
571
|
|
|
663
572
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
664
573
|
}
|
|
665
|
-
|
|
666
|
-
interface Trial {
|
|
667
|
-
/**
|
|
668
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
|
|
669
|
-
*/
|
|
670
|
-
converts_to?: Array<string>;
|
|
671
|
-
|
|
672
|
-
/**
|
|
673
|
-
* Determines the type of trial for this item.
|
|
674
|
-
*/
|
|
675
|
-
type: Trial.Type;
|
|
676
|
-
}
|
|
677
|
-
|
|
678
|
-
namespace Trial {
|
|
679
|
-
type Type = 'free' | 'paid';
|
|
680
|
-
}
|
|
681
574
|
}
|
|
682
575
|
|
|
683
576
|
type PaymentBehavior =
|
|
@@ -729,13 +622,6 @@ declare module 'stripe' {
|
|
|
729
622
|
PaymentMethodOptions.CustomerBalance
|
|
730
623
|
>;
|
|
731
624
|
|
|
732
|
-
/**
|
|
733
|
-
* This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
734
|
-
*/
|
|
735
|
-
id_bank_transfer?: Stripe.Emptyable<
|
|
736
|
-
PaymentMethodOptions.IdBankTransfer
|
|
737
|
-
>;
|
|
738
|
-
|
|
739
625
|
/**
|
|
740
626
|
* This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
741
627
|
*/
|
|
@@ -746,11 +632,6 @@ declare module 'stripe' {
|
|
|
746
632
|
*/
|
|
747
633
|
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
|
|
748
634
|
|
|
749
|
-
/**
|
|
750
|
-
* This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
|
|
751
|
-
*/
|
|
752
|
-
upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
|
|
753
|
-
|
|
754
635
|
/**
|
|
755
636
|
* This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
756
637
|
*/
|
|
@@ -890,47 +771,10 @@ declare module 'stripe' {
|
|
|
890
771
|
}
|
|
891
772
|
}
|
|
892
773
|
|
|
893
|
-
interface IdBankTransfer {}
|
|
894
|
-
|
|
895
774
|
interface Konbini {}
|
|
896
775
|
|
|
897
776
|
interface SepaDebit {}
|
|
898
777
|
|
|
899
|
-
interface Upi {
|
|
900
|
-
/**
|
|
901
|
-
* Configuration options for setting up an eMandate
|
|
902
|
-
*/
|
|
903
|
-
mandate_options?: Upi.MandateOptions;
|
|
904
|
-
}
|
|
905
|
-
|
|
906
|
-
namespace Upi {
|
|
907
|
-
interface MandateOptions {
|
|
908
|
-
/**
|
|
909
|
-
* Amount to be charged for future payments.
|
|
910
|
-
*/
|
|
911
|
-
amount?: number;
|
|
912
|
-
|
|
913
|
-
/**
|
|
914
|
-
* One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
|
|
915
|
-
*/
|
|
916
|
-
amount_type?: MandateOptions.AmountType;
|
|
917
|
-
|
|
918
|
-
/**
|
|
919
|
-
* A description of the mandate or subscription that is meant to be displayed to the customer.
|
|
920
|
-
*/
|
|
921
|
-
description?: string;
|
|
922
|
-
|
|
923
|
-
/**
|
|
924
|
-
* End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
|
925
|
-
*/
|
|
926
|
-
end_date?: number;
|
|
927
|
-
}
|
|
928
|
-
|
|
929
|
-
namespace MandateOptions {
|
|
930
|
-
type AmountType = 'fixed' | 'maximum';
|
|
931
|
-
}
|
|
932
|
-
}
|
|
933
|
-
|
|
934
778
|
interface UsBankAccount {
|
|
935
779
|
/**
|
|
936
780
|
* Additional fields for Financial Connections Session creation
|
|
@@ -967,11 +811,6 @@ declare module 'stripe' {
|
|
|
967
811
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
968
812
|
*/
|
|
969
813
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
970
|
-
|
|
971
|
-
/**
|
|
972
|
-
* ID of the institution to use to filter for selectable accounts.
|
|
973
|
-
*/
|
|
974
|
-
institution?: string;
|
|
975
814
|
}
|
|
976
815
|
|
|
977
816
|
namespace Filters {
|
|
@@ -984,11 +823,7 @@ declare module 'stripe' {
|
|
|
984
823
|
| 'payment_method'
|
|
985
824
|
| 'transactions';
|
|
986
825
|
|
|
987
|
-
type Prefetch =
|
|
988
|
-
| 'balances'
|
|
989
|
-
| 'inferred_balances'
|
|
990
|
-
| 'ownership'
|
|
991
|
-
| 'transactions';
|
|
826
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
992
827
|
}
|
|
993
828
|
|
|
994
829
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
@@ -1008,13 +843,11 @@ declare module 'stripe' {
|
|
|
1008
843
|
| 'card'
|
|
1009
844
|
| 'cashapp'
|
|
1010
845
|
| 'crypto'
|
|
1011
|
-
| 'custom'
|
|
1012
846
|
| 'customer_balance'
|
|
1013
847
|
| 'eps'
|
|
1014
848
|
| 'fpx'
|
|
1015
849
|
| 'giropay'
|
|
1016
850
|
| 'grabpay'
|
|
1017
|
-
| 'id_bank_transfer'
|
|
1018
851
|
| 'ideal'
|
|
1019
852
|
| 'jp_credit_transfer'
|
|
1020
853
|
| 'kakao_pay'
|
|
@@ -1034,9 +867,7 @@ declare module 'stripe' {
|
|
|
1034
867
|
| 'sepa_credit_transfer'
|
|
1035
868
|
| 'sepa_debit'
|
|
1036
869
|
| 'sofort'
|
|
1037
|
-
| 'stripe_balance'
|
|
1038
870
|
| 'swish'
|
|
1039
|
-
| 'upi'
|
|
1040
871
|
| 'us_bank_account'
|
|
1041
872
|
| 'wechat_pay';
|
|
1042
873
|
|
|
@@ -1059,22 +890,6 @@ declare module 'stripe' {
|
|
|
1059
890
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1060
891
|
}
|
|
1061
892
|
|
|
1062
|
-
interface Prebilling {
|
|
1063
|
-
/**
|
|
1064
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
1065
|
-
*/
|
|
1066
|
-
iterations: number;
|
|
1067
|
-
|
|
1068
|
-
/**
|
|
1069
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
1070
|
-
*/
|
|
1071
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
1072
|
-
}
|
|
1073
|
-
|
|
1074
|
-
namespace Prebilling {
|
|
1075
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
1076
|
-
}
|
|
1077
|
-
|
|
1078
893
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1079
894
|
|
|
1080
895
|
interface TransferData {
|
|
@@ -1255,11 +1070,6 @@ declare module 'stripe' {
|
|
|
1255
1070
|
SubscriptionUpdateParams.PendingInvoiceItemInterval
|
|
1256
1071
|
>;
|
|
1257
1072
|
|
|
1258
|
-
/**
|
|
1259
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
1260
|
-
*/
|
|
1261
|
-
prebilling?: SubscriptionUpdateParams.Prebilling;
|
|
1262
|
-
|
|
1263
1073
|
/**
|
|
1264
1074
|
* Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
1265
1075
|
*/
|
|
@@ -1298,6 +1108,16 @@ declare module 'stripe' {
|
|
|
1298
1108
|
*/
|
|
1299
1109
|
discounts?: Array<AddInvoiceItem.Discount>;
|
|
1300
1110
|
|
|
1111
|
+
/**
|
|
1112
|
+
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
1113
|
+
*/
|
|
1114
|
+
metadata?: Stripe.MetadataParam;
|
|
1115
|
+
|
|
1116
|
+
/**
|
|
1117
|
+
* The period associated with this invoice item. Defaults to the current period of the subscription.
|
|
1118
|
+
*/
|
|
1119
|
+
period?: AddInvoiceItem.Period;
|
|
1120
|
+
|
|
1301
1121
|
/**
|
|
1302
1122
|
* The ID of the price object. One of `price` or `price_data` is required.
|
|
1303
1123
|
*/
|
|
@@ -1331,53 +1151,55 @@ declare module 'stripe' {
|
|
|
1331
1151
|
*/
|
|
1332
1152
|
discount?: string;
|
|
1333
1153
|
|
|
1334
|
-
/**
|
|
1335
|
-
* Details to determine how long the discount should be applied for.
|
|
1336
|
-
*/
|
|
1337
|
-
discount_end?: Discount.DiscountEnd;
|
|
1338
|
-
|
|
1339
1154
|
/**
|
|
1340
1155
|
* ID of the promotion code to create a new discount for.
|
|
1341
1156
|
*/
|
|
1342
1157
|
promotion_code?: string;
|
|
1343
1158
|
}
|
|
1344
1159
|
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
duration?: DiscountEnd.Duration;
|
|
1160
|
+
interface Period {
|
|
1161
|
+
/**
|
|
1162
|
+
* End of the invoice item period.
|
|
1163
|
+
*/
|
|
1164
|
+
end: Period.End;
|
|
1351
1165
|
|
|
1166
|
+
/**
|
|
1167
|
+
* Start of the invoice item period.
|
|
1168
|
+
*/
|
|
1169
|
+
start: Period.Start;
|
|
1170
|
+
}
|
|
1171
|
+
|
|
1172
|
+
namespace Period {
|
|
1173
|
+
interface End {
|
|
1352
1174
|
/**
|
|
1353
|
-
* A precise Unix timestamp for the
|
|
1175
|
+
* A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
|
|
1354
1176
|
*/
|
|
1355
1177
|
timestamp?: number;
|
|
1356
1178
|
|
|
1357
1179
|
/**
|
|
1358
|
-
*
|
|
1180
|
+
* Select how to calculate the end of the invoice item period.
|
|
1359
1181
|
*/
|
|
1360
|
-
type:
|
|
1182
|
+
type: End.Type;
|
|
1361
1183
|
}
|
|
1362
1184
|
|
|
1363
|
-
namespace
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1367
|
-
*/
|
|
1368
|
-
interval: Duration.Interval;
|
|
1185
|
+
namespace End {
|
|
1186
|
+
type Type = 'min_item_period_end' | 'timestamp';
|
|
1187
|
+
}
|
|
1369
1188
|
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
|
|
1189
|
+
interface Start {
|
|
1190
|
+
/**
|
|
1191
|
+
* A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
|
|
1192
|
+
*/
|
|
1193
|
+
timestamp?: number;
|
|
1375
1194
|
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1195
|
+
/**
|
|
1196
|
+
* Select how to calculate the start of the invoice item period.
|
|
1197
|
+
*/
|
|
1198
|
+
type: Start.Type;
|
|
1199
|
+
}
|
|
1379
1200
|
|
|
1380
|
-
|
|
1201
|
+
namespace Start {
|
|
1202
|
+
type Type = 'max_item_period_start' | 'now' | 'timestamp';
|
|
1381
1203
|
}
|
|
1382
1204
|
}
|
|
1383
1205
|
|
|
@@ -1496,56 +1318,12 @@ declare module 'stripe' {
|
|
|
1496
1318
|
*/
|
|
1497
1319
|
discount?: string;
|
|
1498
1320
|
|
|
1499
|
-
/**
|
|
1500
|
-
* Details to determine how long the discount should be applied for.
|
|
1501
|
-
*/
|
|
1502
|
-
discount_end?: Discount.DiscountEnd;
|
|
1503
|
-
|
|
1504
1321
|
/**
|
|
1505
1322
|
* ID of the promotion code to create a new discount for.
|
|
1506
1323
|
*/
|
|
1507
1324
|
promotion_code?: string;
|
|
1508
1325
|
}
|
|
1509
1326
|
|
|
1510
|
-
namespace Discount {
|
|
1511
|
-
interface DiscountEnd {
|
|
1512
|
-
/**
|
|
1513
|
-
* Time span for the redeemed discount.
|
|
1514
|
-
*/
|
|
1515
|
-
duration?: DiscountEnd.Duration;
|
|
1516
|
-
|
|
1517
|
-
/**
|
|
1518
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1519
|
-
*/
|
|
1520
|
-
timestamp?: number;
|
|
1521
|
-
|
|
1522
|
-
/**
|
|
1523
|
-
* The type of calculation made to determine when the discount ends.
|
|
1524
|
-
*/
|
|
1525
|
-
type: DiscountEnd.Type;
|
|
1526
|
-
}
|
|
1527
|
-
|
|
1528
|
-
namespace DiscountEnd {
|
|
1529
|
-
interface Duration {
|
|
1530
|
-
/**
|
|
1531
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1532
|
-
*/
|
|
1533
|
-
interval: Duration.Interval;
|
|
1534
|
-
|
|
1535
|
-
/**
|
|
1536
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1537
|
-
*/
|
|
1538
|
-
interval_count: number;
|
|
1539
|
-
}
|
|
1540
|
-
|
|
1541
|
-
namespace Duration {
|
|
1542
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1543
|
-
}
|
|
1544
|
-
|
|
1545
|
-
type Type = 'duration' | 'timestamp';
|
|
1546
|
-
}
|
|
1547
|
-
}
|
|
1548
|
-
|
|
1549
1327
|
interface InvoiceSettings {
|
|
1550
1328
|
/**
|
|
1551
1329
|
* The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
|
|
@@ -1652,56 +1430,12 @@ declare module 'stripe' {
|
|
|
1652
1430
|
*/
|
|
1653
1431
|
discount?: string;
|
|
1654
1432
|
|
|
1655
|
-
/**
|
|
1656
|
-
* Details to determine how long the discount should be applied for.
|
|
1657
|
-
*/
|
|
1658
|
-
discount_end?: Discount.DiscountEnd;
|
|
1659
|
-
|
|
1660
1433
|
/**
|
|
1661
1434
|
* ID of the promotion code to create a new discount for.
|
|
1662
1435
|
*/
|
|
1663
1436
|
promotion_code?: string;
|
|
1664
1437
|
}
|
|
1665
1438
|
|
|
1666
|
-
namespace Discount {
|
|
1667
|
-
interface DiscountEnd {
|
|
1668
|
-
/**
|
|
1669
|
-
* Time span for the redeemed discount.
|
|
1670
|
-
*/
|
|
1671
|
-
duration?: DiscountEnd.Duration;
|
|
1672
|
-
|
|
1673
|
-
/**
|
|
1674
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1675
|
-
*/
|
|
1676
|
-
timestamp?: number;
|
|
1677
|
-
|
|
1678
|
-
/**
|
|
1679
|
-
* The type of calculation made to determine when the discount ends.
|
|
1680
|
-
*/
|
|
1681
|
-
type: DiscountEnd.Type;
|
|
1682
|
-
}
|
|
1683
|
-
|
|
1684
|
-
namespace DiscountEnd {
|
|
1685
|
-
interface Duration {
|
|
1686
|
-
/**
|
|
1687
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1688
|
-
*/
|
|
1689
|
-
interval: Duration.Interval;
|
|
1690
|
-
|
|
1691
|
-
/**
|
|
1692
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1693
|
-
*/
|
|
1694
|
-
interval_count: number;
|
|
1695
|
-
}
|
|
1696
|
-
|
|
1697
|
-
namespace Duration {
|
|
1698
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1699
|
-
}
|
|
1700
|
-
|
|
1701
|
-
type Type = 'duration' | 'timestamp';
|
|
1702
|
-
}
|
|
1703
|
-
}
|
|
1704
|
-
|
|
1705
1439
|
interface PriceData {
|
|
1706
1440
|
/**
|
|
1707
1441
|
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
@@ -1820,13 +1554,6 @@ declare module 'stripe' {
|
|
|
1820
1554
|
PaymentMethodOptions.CustomerBalance
|
|
1821
1555
|
>;
|
|
1822
1556
|
|
|
1823
|
-
/**
|
|
1824
|
-
* This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
1825
|
-
*/
|
|
1826
|
-
id_bank_transfer?: Stripe.Emptyable<
|
|
1827
|
-
PaymentMethodOptions.IdBankTransfer
|
|
1828
|
-
>;
|
|
1829
|
-
|
|
1830
1557
|
/**
|
|
1831
1558
|
* This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
1832
1559
|
*/
|
|
@@ -1837,11 +1564,6 @@ declare module 'stripe' {
|
|
|
1837
1564
|
*/
|
|
1838
1565
|
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
|
|
1839
1566
|
|
|
1840
|
-
/**
|
|
1841
|
-
* This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
|
|
1842
|
-
*/
|
|
1843
|
-
upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
|
|
1844
|
-
|
|
1845
1567
|
/**
|
|
1846
1568
|
* This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
1847
1569
|
*/
|
|
@@ -1981,47 +1703,10 @@ declare module 'stripe' {
|
|
|
1981
1703
|
}
|
|
1982
1704
|
}
|
|
1983
1705
|
|
|
1984
|
-
interface IdBankTransfer {}
|
|
1985
|
-
|
|
1986
1706
|
interface Konbini {}
|
|
1987
1707
|
|
|
1988
1708
|
interface SepaDebit {}
|
|
1989
1709
|
|
|
1990
|
-
interface Upi {
|
|
1991
|
-
/**
|
|
1992
|
-
* Configuration options for setting up an eMandate
|
|
1993
|
-
*/
|
|
1994
|
-
mandate_options?: Upi.MandateOptions;
|
|
1995
|
-
}
|
|
1996
|
-
|
|
1997
|
-
namespace Upi {
|
|
1998
|
-
interface MandateOptions {
|
|
1999
|
-
/**
|
|
2000
|
-
* Amount to be charged for future payments.
|
|
2001
|
-
*/
|
|
2002
|
-
amount?: number;
|
|
2003
|
-
|
|
2004
|
-
/**
|
|
2005
|
-
* One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
|
|
2006
|
-
*/
|
|
2007
|
-
amount_type?: MandateOptions.AmountType;
|
|
2008
|
-
|
|
2009
|
-
/**
|
|
2010
|
-
* A description of the mandate or subscription that is meant to be displayed to the customer.
|
|
2011
|
-
*/
|
|
2012
|
-
description?: string;
|
|
2013
|
-
|
|
2014
|
-
/**
|
|
2015
|
-
* End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
|
2016
|
-
*/
|
|
2017
|
-
end_date?: number;
|
|
2018
|
-
}
|
|
2019
|
-
|
|
2020
|
-
namespace MandateOptions {
|
|
2021
|
-
type AmountType = 'fixed' | 'maximum';
|
|
2022
|
-
}
|
|
2023
|
-
}
|
|
2024
|
-
|
|
2025
1710
|
interface UsBankAccount {
|
|
2026
1711
|
/**
|
|
2027
1712
|
* Additional fields for Financial Connections Session creation
|
|
@@ -2058,11 +1743,6 @@ declare module 'stripe' {
|
|
|
2058
1743
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
2059
1744
|
*/
|
|
2060
1745
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
2061
|
-
|
|
2062
|
-
/**
|
|
2063
|
-
* ID of the institution to use to filter for selectable accounts.
|
|
2064
|
-
*/
|
|
2065
|
-
institution?: string;
|
|
2066
1746
|
}
|
|
2067
1747
|
|
|
2068
1748
|
namespace Filters {
|
|
@@ -2075,11 +1755,7 @@ declare module 'stripe' {
|
|
|
2075
1755
|
| 'payment_method'
|
|
2076
1756
|
| 'transactions';
|
|
2077
1757
|
|
|
2078
|
-
type Prefetch =
|
|
2079
|
-
| 'balances'
|
|
2080
|
-
| 'inferred_balances'
|
|
2081
|
-
| 'ownership'
|
|
2082
|
-
| 'transactions';
|
|
1758
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
2083
1759
|
}
|
|
2084
1760
|
|
|
2085
1761
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
@@ -2099,13 +1775,11 @@ declare module 'stripe' {
|
|
|
2099
1775
|
| 'card'
|
|
2100
1776
|
| 'cashapp'
|
|
2101
1777
|
| 'crypto'
|
|
2102
|
-
| 'custom'
|
|
2103
1778
|
| 'customer_balance'
|
|
2104
1779
|
| 'eps'
|
|
2105
1780
|
| 'fpx'
|
|
2106
1781
|
| 'giropay'
|
|
2107
1782
|
| 'grabpay'
|
|
2108
|
-
| 'id_bank_transfer'
|
|
2109
1783
|
| 'ideal'
|
|
2110
1784
|
| 'jp_credit_transfer'
|
|
2111
1785
|
| 'kakao_pay'
|
|
@@ -2125,9 +1799,7 @@ declare module 'stripe' {
|
|
|
2125
1799
|
| 'sepa_credit_transfer'
|
|
2126
1800
|
| 'sepa_debit'
|
|
2127
1801
|
| 'sofort'
|
|
2128
|
-
| 'stripe_balance'
|
|
2129
1802
|
| 'swish'
|
|
2130
|
-
| 'upi'
|
|
2131
1803
|
| 'us_bank_account'
|
|
2132
1804
|
| 'wechat_pay';
|
|
2133
1805
|
|
|
@@ -2150,22 +1822,6 @@ declare module 'stripe' {
|
|
|
2150
1822
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2151
1823
|
}
|
|
2152
1824
|
|
|
2153
|
-
interface Prebilling {
|
|
2154
|
-
/**
|
|
2155
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
2156
|
-
*/
|
|
2157
|
-
iterations: number;
|
|
2158
|
-
|
|
2159
|
-
/**
|
|
2160
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
2161
|
-
*/
|
|
2162
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
2163
|
-
}
|
|
2164
|
-
|
|
2165
|
-
namespace Prebilling {
|
|
2166
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
2167
|
-
}
|
|
2168
|
-
|
|
2169
1825
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2170
1826
|
|
|
2171
1827
|
interface TransferData {
|
|
@@ -2218,12 +1874,12 @@ declare module 'stripe' {
|
|
|
2218
1874
|
created?: Stripe.RangeQueryParam | number;
|
|
2219
1875
|
|
|
2220
1876
|
/**
|
|
2221
|
-
* Only return subscriptions whose current_period_end falls within the given date interval.
|
|
1877
|
+
* Only return subscriptions whose minimum item current_period_end falls within the given date interval.
|
|
2222
1878
|
*/
|
|
2223
1879
|
current_period_end?: Stripe.RangeQueryParam | number;
|
|
2224
1880
|
|
|
2225
1881
|
/**
|
|
2226
|
-
* Only return subscriptions whose current_period_start falls within the given date interval.
|
|
1882
|
+
* Only return subscriptions whose maximum item current_period_start falls within the given date interval.
|
|
2227
1883
|
*/
|
|
2228
1884
|
current_period_start?: Stripe.RangeQueryParam | number;
|
|
2229
1885
|
|
|
@@ -2232,11 +1888,6 @@ declare module 'stripe' {
|
|
|
2232
1888
|
*/
|
|
2233
1889
|
customer?: string;
|
|
2234
1890
|
|
|
2235
|
-
/**
|
|
2236
|
-
* The ID of the account whose subscriptions will be retrieved.
|
|
2237
|
-
*/
|
|
2238
|
-
customer_account?: string;
|
|
2239
|
-
|
|
2240
1891
|
/**
|
|
2241
1892
|
* Specifies which fields in the response should be expanded.
|
|
2242
1893
|
*/
|
|
@@ -2415,10 +2066,7 @@ declare module 'stripe' {
|
|
|
2415
2066
|
* Schedules provide the flexibility to model more complex billing configurations that change over time.
|
|
2416
2067
|
*/
|
|
2417
2068
|
create(
|
|
2418
|
-
params
|
|
2419
|
-
options?: RequestOptions
|
|
2420
|
-
): Promise<Stripe.Response<Stripe.Subscription>>;
|
|
2421
|
-
create(
|
|
2069
|
+
params: SubscriptionCreateParams,
|
|
2422
2070
|
options?: RequestOptions
|
|
2423
2071
|
): Promise<Stripe.Response<Stripe.Subscription>>;
|
|
2424
2072
|
|