stripe 18.3.0-beta.1 → 18.3.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 +59 -1246
- package/OPENAPI_VERSION +1 -1
- package/README.md +0 -1
- package/VERSION +1 -1
- package/cjs/Error.js +1 -91
- package/cjs/RequestSender.js +1 -1
- 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 +10 -98
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +0 -79
- package/esm/RequestSender.js +1 -1
- 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 +1 -82
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +1 -5
- package/types/AccountSessions.d.ts +31 -76
- package/types/AccountSessionsResource.d.ts +48 -312
- package/types/Accounts.d.ts +30 -213
- package/types/AccountsResource.d.ts +85 -540
- 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/BillingPortal/Sessions.d.ts +1 -6
- package/types/BillingPortal/SessionsResource.d.ts +5 -13
- package/types/Cards.d.ts +0 -5
- package/types/CashBalances.d.ts +0 -5
- package/types/Charges.d.ts +52 -182
- package/types/ChargesResource.d.ts +0 -1406
- package/types/Checkout/Sessions.d.ts +1 -314
- package/types/Checkout/SessionsResource.d.ts +62 -340
- package/types/ConfirmationTokens.d.ts +22 -136
- 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 +9 -14
- package/types/CustomerBalanceTransactions.d.ts +0 -2
- package/types/CustomerCashBalanceTransactions.d.ts +0 -2
- package/types/CustomerSessions.d.ts +1 -6
- package/types/CustomerSessionsResource.d.ts +2 -7
- package/types/Customers.d.ts +0 -2
- package/types/CustomersResource.d.ts +1 -8
- package/types/Discounts.d.ts +0 -10
- package/types/Disputes.d.ts +6 -2
- package/types/Errors.d.ts +2 -69
- package/types/EventTypes.d.ts +0 -664
- package/types/Events.d.ts +1 -98
- 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 +33 -4
- package/types/Identity/VerificationSessionsResource.d.ts +14 -4
- package/types/InvoiceItems.d.ts +1 -14
- 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 +4 -133
- package/types/InvoicesResource.d.ts +37 -1446
- package/types/Issuing/CardholdersResource.d.ts +1 -2
- 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 +4 -77
- package/types/PaymentIntents.d.ts +35 -770
- package/types/PaymentIntentsResource.d.ts +4268 -8619
- package/types/PaymentLinks.d.ts +0 -6
- package/types/PaymentLinksResource.d.ts +0 -12
- package/types/PaymentMethodConfigurations.d.ts +0 -180
- package/types/PaymentMethodConfigurationsResource.d.ts +0 -250
- package/types/PaymentMethods.d.ts +16 -134
- package/types/PaymentMethodsResource.d.ts +12 -167
- package/types/Payouts.d.ts +0 -5
- package/types/PayoutsResource.d.ts +0 -5
- package/types/Prices.d.ts +0 -22
- package/types/PricesResource.d.ts +0 -22
- package/types/PromotionCodes.d.ts +0 -5
- package/types/PromotionCodesResource.d.ts +0 -10
- package/types/Quotes.d.ts +8 -592
- package/types/QuotesResource.d.ts +278 -2617
- package/types/Refunds.d.ts +0 -14
- package/types/SetupAttempts.d.ts +4 -48
- package/types/SetupIntents.d.ts +17 -119
- package/types/SetupIntentsResource.d.ts +413 -660
- package/types/Sources.d.ts +0 -29
- package/types/SubscriptionItems.d.ts +0 -30
- package/types/SubscriptionItemsResource.d.ts +0 -109
- package/types/SubscriptionSchedules.d.ts +16 -207
- package/types/SubscriptionSchedulesResource.d.ts +14 -1236
- package/types/Subscriptions.d.ts +15 -108
- package/types/SubscriptionsResource.d.ts +30 -402
- package/types/Tax/Registrations.d.ts +9 -0
- package/types/Tax/RegistrationsResource.d.ts +12 -0
- package/types/TaxIds.d.ts +0 -10
- package/types/TaxIdsResource.d.ts +0 -10
- package/types/Terminal/Configurations.d.ts +1 -0
- package/types/Terminal/LocationsResource.d.ts +1 -1
- package/types/Terminal/Readers.d.ts +6 -26
- package/types/Terminal/ReadersResource.d.ts +4 -4
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +15 -128
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
- package/types/TokensResource.d.ts +3 -0
- 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 +9 -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 -906
- package/types/WebhookEndpointsResource.d.ts +2 -79
- package/types/index.d.ts +6 -142
- package/types/lib.d.ts +11 -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/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/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 -17
- 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/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/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 -14
- 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 -89
- package/types/BalanceSettingsResource.d.ts +0 -108
- 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 -153
- 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 -1159
- package/types/OrdersResource.d.ts +0 -2967
- package/types/PaymentAttemptRecords.d.ts +0 -2132
- package/types/PaymentAttemptRecordsResource.d.ts +0 -47
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -116
- package/types/PaymentRecords.d.ts +0 -2125
- 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 -1695
- package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -831
- 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/ReaderCollectedData.d.ts +0 -51
- package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
- package/types/V2/Core/AccountLinks.d.ts +0 -106
- package/types/V2/Core/AccountLinksResource.d.ts +0 -90
- package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3770
- package/types/V2/Core/Accounts.d.ts +0 -8169
- package/types/V2/Core/AccountsResource.d.ts +0 -10203
- package/types/V2/Core/Persons.d.ts +0 -1867
- 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 -546
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -52
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -314
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -288
- 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 -207
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -151
- 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 -243
- 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 -167
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -159
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -66
package/types/Sources.d.ts
CHANGED
|
@@ -105,8 +105,6 @@ declare module 'stripe' {
|
|
|
105
105
|
|
|
106
106
|
p24?: Source.P24;
|
|
107
107
|
|
|
108
|
-
paypal?: Source.Paypal;
|
|
109
|
-
|
|
110
108
|
receiver?: Source.Receiver;
|
|
111
109
|
|
|
112
110
|
redirect?: Source.Redirect;
|
|
@@ -238,8 +236,6 @@ declare module 'stripe' {
|
|
|
238
236
|
|
|
239
237
|
brand?: string | null;
|
|
240
238
|
|
|
241
|
-
brand_product?: string | null;
|
|
242
|
-
|
|
243
239
|
country?: string | null;
|
|
244
240
|
|
|
245
241
|
cvc_check?: string | null;
|
|
@@ -280,8 +276,6 @@ declare module 'stripe' {
|
|
|
280
276
|
|
|
281
277
|
brand?: string | null;
|
|
282
278
|
|
|
283
|
-
brand_product?: string | null;
|
|
284
|
-
|
|
285
279
|
country?: string | null;
|
|
286
280
|
|
|
287
281
|
cvm_type?: string;
|
|
@@ -485,26 +479,6 @@ declare module 'stripe' {
|
|
|
485
479
|
reference?: string | null;
|
|
486
480
|
}
|
|
487
481
|
|
|
488
|
-
interface Paypal {
|
|
489
|
-
billing_agreement?: string | null;
|
|
490
|
-
|
|
491
|
-
fingerprint?: string | null;
|
|
492
|
-
|
|
493
|
-
payer_id?: string | null;
|
|
494
|
-
|
|
495
|
-
reference_id?: string;
|
|
496
|
-
|
|
497
|
-
reference_transaction_amount?: string;
|
|
498
|
-
|
|
499
|
-
reference_transaction_charged?: boolean;
|
|
500
|
-
|
|
501
|
-
statement_descriptor?: string | null;
|
|
502
|
-
|
|
503
|
-
transaction_id?: string;
|
|
504
|
-
|
|
505
|
-
verified_email?: string | null;
|
|
506
|
-
}
|
|
507
|
-
|
|
508
482
|
interface Receiver {
|
|
509
483
|
/**
|
|
510
484
|
* The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
|
|
@@ -706,8 +680,6 @@ declare module 'stripe' {
|
|
|
706
680
|
|
|
707
681
|
brand?: string | null;
|
|
708
682
|
|
|
709
|
-
brand_product?: string | null;
|
|
710
|
-
|
|
711
683
|
card?: string | null;
|
|
712
684
|
|
|
713
685
|
country?: string | null;
|
|
@@ -756,7 +728,6 @@ declare module 'stripe' {
|
|
|
756
728
|
| 'klarna'
|
|
757
729
|
| 'multibanco'
|
|
758
730
|
| 'p24'
|
|
759
|
-
| 'paypal'
|
|
760
731
|
| 'sepa_credit_transfer'
|
|
761
732
|
| 'sepa_debit'
|
|
762
733
|
| 'sofort'
|
|
@@ -108,36 +108,6 @@ declare module 'stripe' {
|
|
|
108
108
|
* The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
|
|
109
109
|
*/
|
|
110
110
|
tax_rates: Array<Stripe.TaxRate> | null;
|
|
111
|
-
|
|
112
|
-
/**
|
|
113
|
-
* Options that configure the trial on the subscription item.
|
|
114
|
-
*/
|
|
115
|
-
trial?: SubscriptionItem.Trial | null;
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
namespace SubscriptionItem {
|
|
119
|
-
interface BillingThresholds {
|
|
120
|
-
/**
|
|
121
|
-
* Usage threshold that triggers the subscription to create an invoice
|
|
122
|
-
*/
|
|
123
|
-
usage_gte: number | null;
|
|
124
|
-
}
|
|
125
|
-
|
|
126
|
-
interface Trial {
|
|
127
|
-
/**
|
|
128
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
129
|
-
*/
|
|
130
|
-
converts_to?: Array<string> | null;
|
|
131
|
-
|
|
132
|
-
/**
|
|
133
|
-
* Determines the type of trial for this item.
|
|
134
|
-
*/
|
|
135
|
-
type: Trial.Type;
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
namespace Trial {
|
|
139
|
-
type Type = 'free' | 'paid';
|
|
140
|
-
}
|
|
141
111
|
}
|
|
142
112
|
|
|
143
113
|
namespace SubscriptionItem {
|
|
@@ -77,11 +77,6 @@ declare module 'stripe' {
|
|
|
77
77
|
* 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.
|
|
78
78
|
*/
|
|
79
79
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* Options that configure the trial on the subscription item.
|
|
83
|
-
*/
|
|
84
|
-
trial?: SubscriptionItemCreateParams.Trial;
|
|
85
80
|
}
|
|
86
81
|
|
|
87
82
|
namespace SubscriptionItemCreateParams {
|
|
@@ -103,56 +98,12 @@ declare module 'stripe' {
|
|
|
103
98
|
*/
|
|
104
99
|
discount?: string;
|
|
105
100
|
|
|
106
|
-
/**
|
|
107
|
-
* Details to determine how long the discount should be applied for.
|
|
108
|
-
*/
|
|
109
|
-
discount_end?: Discount.DiscountEnd;
|
|
110
|
-
|
|
111
101
|
/**
|
|
112
102
|
* ID of the promotion code to create a new discount for.
|
|
113
103
|
*/
|
|
114
104
|
promotion_code?: string;
|
|
115
105
|
}
|
|
116
106
|
|
|
117
|
-
namespace Discount {
|
|
118
|
-
interface DiscountEnd {
|
|
119
|
-
/**
|
|
120
|
-
* Time span for the redeemed discount.
|
|
121
|
-
*/
|
|
122
|
-
duration?: DiscountEnd.Duration;
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
126
|
-
*/
|
|
127
|
-
timestamp?: number;
|
|
128
|
-
|
|
129
|
-
/**
|
|
130
|
-
* The type of calculation made to determine when the discount ends.
|
|
131
|
-
*/
|
|
132
|
-
type: DiscountEnd.Type;
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
namespace DiscountEnd {
|
|
136
|
-
interface Duration {
|
|
137
|
-
/**
|
|
138
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
139
|
-
*/
|
|
140
|
-
interval: Duration.Interval;
|
|
141
|
-
|
|
142
|
-
/**
|
|
143
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
144
|
-
*/
|
|
145
|
-
interval_count: number;
|
|
146
|
-
}
|
|
147
|
-
|
|
148
|
-
namespace Duration {
|
|
149
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
type Type = 'duration' | 'timestamp';
|
|
153
|
-
}
|
|
154
|
-
}
|
|
155
|
-
|
|
156
107
|
type PaymentBehavior =
|
|
157
108
|
| 'allow_incomplete'
|
|
158
109
|
| 'default_incomplete'
|
|
@@ -212,22 +163,6 @@ declare module 'stripe' {
|
|
|
212
163
|
}
|
|
213
164
|
|
|
214
165
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
215
|
-
|
|
216
|
-
interface Trial {
|
|
217
|
-
/**
|
|
218
|
-
* 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.
|
|
219
|
-
*/
|
|
220
|
-
converts_to?: Array<string>;
|
|
221
|
-
|
|
222
|
-
/**
|
|
223
|
-
* Determines the type of trial for this item.
|
|
224
|
-
*/
|
|
225
|
-
type: Trial.Type;
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
namespace Trial {
|
|
229
|
-
type Type = 'free' | 'paid';
|
|
230
|
-
}
|
|
231
166
|
}
|
|
232
167
|
|
|
233
168
|
interface SubscriptionItemRetrieveParams {
|
|
@@ -333,56 +268,12 @@ declare module 'stripe' {
|
|
|
333
268
|
*/
|
|
334
269
|
discount?: string;
|
|
335
270
|
|
|
336
|
-
/**
|
|
337
|
-
* Details to determine how long the discount should be applied for.
|
|
338
|
-
*/
|
|
339
|
-
discount_end?: Discount.DiscountEnd;
|
|
340
|
-
|
|
341
271
|
/**
|
|
342
272
|
* ID of the promotion code to create a new discount for.
|
|
343
273
|
*/
|
|
344
274
|
promotion_code?: string;
|
|
345
275
|
}
|
|
346
276
|
|
|
347
|
-
namespace Discount {
|
|
348
|
-
interface DiscountEnd {
|
|
349
|
-
/**
|
|
350
|
-
* Time span for the redeemed discount.
|
|
351
|
-
*/
|
|
352
|
-
duration?: DiscountEnd.Duration;
|
|
353
|
-
|
|
354
|
-
/**
|
|
355
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
356
|
-
*/
|
|
357
|
-
timestamp?: number;
|
|
358
|
-
|
|
359
|
-
/**
|
|
360
|
-
* The type of calculation made to determine when the discount ends.
|
|
361
|
-
*/
|
|
362
|
-
type: DiscountEnd.Type;
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
namespace DiscountEnd {
|
|
366
|
-
interface Duration {
|
|
367
|
-
/**
|
|
368
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
369
|
-
*/
|
|
370
|
-
interval: Duration.Interval;
|
|
371
|
-
|
|
372
|
-
/**
|
|
373
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
374
|
-
*/
|
|
375
|
-
interval_count: number;
|
|
376
|
-
}
|
|
377
|
-
|
|
378
|
-
namespace Duration {
|
|
379
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
380
|
-
}
|
|
381
|
-
|
|
382
|
-
type Type = 'duration' | 'timestamp';
|
|
383
|
-
}
|
|
384
|
-
}
|
|
385
|
-
|
|
386
277
|
type PaymentBehavior =
|
|
387
278
|
| 'allow_incomplete'
|
|
388
279
|
| 'default_incomplete'
|
|
@@ -28,14 +28,9 @@ declare module 'stripe' {
|
|
|
28
28
|
| null;
|
|
29
29
|
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* The billing mode of the subscription.
|
|
32
32
|
*/
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
/**
|
|
36
|
-
* The [billing mode](https://docs.stripe.com/api/subscriptions/create#create_subscription-billing_mode) that will be used to process all future operations for the subscription schedule.
|
|
37
|
-
*/
|
|
38
|
-
billing_mode?: SubscriptionSchedule.BillingMode;
|
|
33
|
+
billing_mode: SubscriptionSchedule.BillingMode;
|
|
39
34
|
|
|
40
35
|
/**
|
|
41
36
|
* Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
|
|
@@ -62,11 +57,6 @@ declare module 'stripe' {
|
|
|
62
57
|
*/
|
|
63
58
|
customer: string | Stripe.Customer | Stripe.DeletedCustomer;
|
|
64
59
|
|
|
65
|
-
/**
|
|
66
|
-
* ID of the account who owns the subscription schedule.
|
|
67
|
-
*/
|
|
68
|
-
customer_account?: string | null;
|
|
69
|
-
|
|
70
60
|
default_settings: SubscriptionSchedule.DefaultSettings;
|
|
71
61
|
|
|
72
62
|
/**
|
|
@@ -74,11 +64,6 @@ declare module 'stripe' {
|
|
|
74
64
|
*/
|
|
75
65
|
end_behavior: SubscriptionSchedule.EndBehavior;
|
|
76
66
|
|
|
77
|
-
/**
|
|
78
|
-
* Details of the most recent price migration that failed for the subscription schedule.
|
|
79
|
-
*/
|
|
80
|
-
last_price_migration_error?: SubscriptionSchedule.LastPriceMigrationError | null;
|
|
81
|
-
|
|
82
67
|
/**
|
|
83
68
|
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
84
69
|
*/
|
|
@@ -94,11 +79,6 @@ declare module 'stripe' {
|
|
|
94
79
|
*/
|
|
95
80
|
phases: Array<SubscriptionSchedule.Phase>;
|
|
96
81
|
|
|
97
|
-
/**
|
|
98
|
-
* Time period and invoice for a Subscription billed in advance.
|
|
99
|
-
*/
|
|
100
|
-
prebilling?: SubscriptionSchedule.Prebilling | null;
|
|
101
|
-
|
|
102
82
|
/**
|
|
103
83
|
* Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
|
|
104
84
|
*/
|
|
@@ -126,9 +106,21 @@ declare module 'stripe' {
|
|
|
126
106
|
}
|
|
127
107
|
|
|
128
108
|
namespace SubscriptionSchedule {
|
|
129
|
-
|
|
109
|
+
interface BillingMode {
|
|
110
|
+
/**
|
|
111
|
+
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
112
|
+
*/
|
|
113
|
+
type: BillingMode.Type;
|
|
130
114
|
|
|
131
|
-
|
|
115
|
+
/**
|
|
116
|
+
* Details on when the current billing_mode was adopted.
|
|
117
|
+
*/
|
|
118
|
+
updated_at?: number;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
namespace BillingMode {
|
|
122
|
+
type Type = 'classic' | 'flexible';
|
|
123
|
+
}
|
|
132
124
|
|
|
133
125
|
interface CurrentPhase {
|
|
134
126
|
/**
|
|
@@ -289,37 +281,6 @@ declare module 'stripe' {
|
|
|
289
281
|
|
|
290
282
|
type EndBehavior = 'cancel' | 'none' | 'release' | 'renew';
|
|
291
283
|
|
|
292
|
-
interface LastPriceMigrationError {
|
|
293
|
-
/**
|
|
294
|
-
* The time at which the price migration encountered an error.
|
|
295
|
-
*/
|
|
296
|
-
errored_at: number;
|
|
297
|
-
|
|
298
|
-
/**
|
|
299
|
-
* The involved price pairs in each failed transition.
|
|
300
|
-
*/
|
|
301
|
-
failed_transitions: Array<LastPriceMigrationError.FailedTransition>;
|
|
302
|
-
|
|
303
|
-
/**
|
|
304
|
-
* The type of error encountered by the price migration.
|
|
305
|
-
*/
|
|
306
|
-
type: 'price_uniqueness_violation';
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
namespace LastPriceMigrationError {
|
|
310
|
-
interface FailedTransition {
|
|
311
|
-
/**
|
|
312
|
-
* The original price to be migrated.
|
|
313
|
-
*/
|
|
314
|
-
source_price: string;
|
|
315
|
-
|
|
316
|
-
/**
|
|
317
|
-
* The intended resulting price of the migration.
|
|
318
|
-
*/
|
|
319
|
-
target_price: string;
|
|
320
|
-
}
|
|
321
|
-
}
|
|
322
|
-
|
|
323
284
|
interface Phase {
|
|
324
285
|
/**
|
|
325
286
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
|
|
@@ -398,11 +359,6 @@ declare module 'stripe' {
|
|
|
398
359
|
*/
|
|
399
360
|
on_behalf_of: string | Stripe.Account | null;
|
|
400
361
|
|
|
401
|
-
/**
|
|
402
|
-
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
|
403
|
-
*/
|
|
404
|
-
pause_collection?: Phase.PauseCollection | null;
|
|
405
|
-
|
|
406
362
|
/**
|
|
407
363
|
* When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
|
|
408
364
|
*/
|
|
@@ -418,20 +374,10 @@ declare module 'stripe' {
|
|
|
418
374
|
*/
|
|
419
375
|
transfer_data: Phase.TransferData | null;
|
|
420
376
|
|
|
421
|
-
/**
|
|
422
|
-
* Specify behavior of the trial when crossing schedule phase boundaries
|
|
423
|
-
*/
|
|
424
|
-
trial_continuation?: Phase.TrialContinuation | null;
|
|
425
|
-
|
|
426
377
|
/**
|
|
427
378
|
* When the trial ends within the phase.
|
|
428
379
|
*/
|
|
429
380
|
trial_end: number | null;
|
|
430
|
-
|
|
431
|
-
/**
|
|
432
|
-
* Settings related to any trials on the subscription during this phase.
|
|
433
|
-
*/
|
|
434
|
-
trial_settings?: Phase.TrialSettings | null;
|
|
435
381
|
}
|
|
436
382
|
|
|
437
383
|
namespace Phase {
|
|
@@ -469,30 +415,11 @@ declare module 'stripe' {
|
|
|
469
415
|
*/
|
|
470
416
|
discount: string | Stripe.Discount | null;
|
|
471
417
|
|
|
472
|
-
/**
|
|
473
|
-
* Details to determine how long the discount should be applied for.
|
|
474
|
-
*/
|
|
475
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
476
|
-
|
|
477
418
|
/**
|
|
478
419
|
* ID of the promotion code to create a new discount for.
|
|
479
420
|
*/
|
|
480
421
|
promotion_code: string | Stripe.PromotionCode | null;
|
|
481
422
|
}
|
|
482
|
-
|
|
483
|
-
namespace Discount {
|
|
484
|
-
interface DiscountEnd {
|
|
485
|
-
/**
|
|
486
|
-
* The discount end timestamp.
|
|
487
|
-
*/
|
|
488
|
-
timestamp: number | null;
|
|
489
|
-
|
|
490
|
-
/**
|
|
491
|
-
* The discount end type.
|
|
492
|
-
*/
|
|
493
|
-
type: 'timestamp';
|
|
494
|
-
}
|
|
495
|
-
}
|
|
496
423
|
}
|
|
497
424
|
|
|
498
425
|
interface AutomaticTax {
|
|
@@ -557,31 +484,12 @@ declare module 'stripe' {
|
|
|
557
484
|
*/
|
|
558
485
|
discount: string | Stripe.Discount | null;
|
|
559
486
|
|
|
560
|
-
/**
|
|
561
|
-
* Details to determine how long the discount should be applied for.
|
|
562
|
-
*/
|
|
563
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
564
|
-
|
|
565
487
|
/**
|
|
566
488
|
* ID of the promotion code to create a new discount for.
|
|
567
489
|
*/
|
|
568
490
|
promotion_code: string | Stripe.PromotionCode | null;
|
|
569
491
|
}
|
|
570
492
|
|
|
571
|
-
namespace Discount {
|
|
572
|
-
interface DiscountEnd {
|
|
573
|
-
/**
|
|
574
|
-
* The discount end timestamp.
|
|
575
|
-
*/
|
|
576
|
-
timestamp: number | null;
|
|
577
|
-
|
|
578
|
-
/**
|
|
579
|
-
* The discount end type.
|
|
580
|
-
*/
|
|
581
|
-
type: 'timestamp';
|
|
582
|
-
}
|
|
583
|
-
}
|
|
584
|
-
|
|
585
493
|
interface InvoiceSettings {
|
|
586
494
|
/**
|
|
587
495
|
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
|
@@ -654,11 +562,6 @@ declare module 'stripe' {
|
|
|
654
562
|
* The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
|
|
655
563
|
*/
|
|
656
564
|
tax_rates?: Array<Stripe.TaxRate> | null;
|
|
657
|
-
|
|
658
|
-
/**
|
|
659
|
-
* Options that configure the trial on the subscription item.
|
|
660
|
-
*/
|
|
661
|
-
trial?: Item.Trial | null;
|
|
662
565
|
}
|
|
663
566
|
|
|
664
567
|
namespace Item {
|
|
@@ -680,57 +583,11 @@ declare module 'stripe' {
|
|
|
680
583
|
*/
|
|
681
584
|
discount: string | Stripe.Discount | null;
|
|
682
585
|
|
|
683
|
-
/**
|
|
684
|
-
* Details to determine how long the discount should be applied for.
|
|
685
|
-
*/
|
|
686
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
687
|
-
|
|
688
586
|
/**
|
|
689
587
|
* ID of the promotion code to create a new discount for.
|
|
690
588
|
*/
|
|
691
589
|
promotion_code: string | Stripe.PromotionCode | null;
|
|
692
590
|
}
|
|
693
|
-
|
|
694
|
-
namespace Discount {
|
|
695
|
-
interface DiscountEnd {
|
|
696
|
-
/**
|
|
697
|
-
* The discount end timestamp.
|
|
698
|
-
*/
|
|
699
|
-
timestamp: number | null;
|
|
700
|
-
|
|
701
|
-
/**
|
|
702
|
-
* The discount end type.
|
|
703
|
-
*/
|
|
704
|
-
type: 'timestamp';
|
|
705
|
-
}
|
|
706
|
-
}
|
|
707
|
-
|
|
708
|
-
interface Trial {
|
|
709
|
-
/**
|
|
710
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
711
|
-
*/
|
|
712
|
-
converts_to?: Array<string> | null;
|
|
713
|
-
|
|
714
|
-
/**
|
|
715
|
-
* Determines the type of trial for this item.
|
|
716
|
-
*/
|
|
717
|
-
type: Trial.Type;
|
|
718
|
-
}
|
|
719
|
-
|
|
720
|
-
namespace Trial {
|
|
721
|
-
type Type = 'free' | 'paid';
|
|
722
|
-
}
|
|
723
|
-
}
|
|
724
|
-
|
|
725
|
-
interface PauseCollection {
|
|
726
|
-
/**
|
|
727
|
-
* The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
|
728
|
-
*/
|
|
729
|
-
behavior: PauseCollection.Behavior;
|
|
730
|
-
}
|
|
731
|
-
|
|
732
|
-
namespace PauseCollection {
|
|
733
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
734
591
|
}
|
|
735
592
|
|
|
736
593
|
type ProrationBehavior =
|
|
@@ -749,54 +606,6 @@ declare module 'stripe' {
|
|
|
749
606
|
*/
|
|
750
607
|
destination: string | Stripe.Account;
|
|
751
608
|
}
|
|
752
|
-
|
|
753
|
-
type TrialContinuation = 'continue' | 'none';
|
|
754
|
-
|
|
755
|
-
interface TrialSettings {
|
|
756
|
-
/**
|
|
757
|
-
* Defines how the subscription should behave when a trial ends.
|
|
758
|
-
*/
|
|
759
|
-
end_behavior: TrialSettings.EndBehavior | null;
|
|
760
|
-
}
|
|
761
|
-
|
|
762
|
-
namespace TrialSettings {
|
|
763
|
-
interface EndBehavior {
|
|
764
|
-
/**
|
|
765
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
766
|
-
*/
|
|
767
|
-
prorate_up_front: EndBehavior.ProrateUpFront | null;
|
|
768
|
-
}
|
|
769
|
-
|
|
770
|
-
namespace EndBehavior {
|
|
771
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
772
|
-
}
|
|
773
|
-
}
|
|
774
|
-
}
|
|
775
|
-
|
|
776
|
-
interface Prebilling {
|
|
777
|
-
/**
|
|
778
|
-
* ID of the prebilling invoice.
|
|
779
|
-
*/
|
|
780
|
-
invoice: string | Stripe.Invoice;
|
|
781
|
-
|
|
782
|
-
/**
|
|
783
|
-
* The end of the last period for which the invoice pre-bills.
|
|
784
|
-
*/
|
|
785
|
-
period_end: number;
|
|
786
|
-
|
|
787
|
-
/**
|
|
788
|
-
* The start of the first period for which the invoice pre-bills.
|
|
789
|
-
*/
|
|
790
|
-
period_start: number;
|
|
791
|
-
|
|
792
|
-
/**
|
|
793
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
|
794
|
-
*/
|
|
795
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
796
|
-
}
|
|
797
|
-
|
|
798
|
-
namespace Prebilling {
|
|
799
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
800
609
|
}
|
|
801
610
|
|
|
802
611
|
type Status =
|