stripe 19.2.0-beta.1 → 19.2.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 +71 -1433
- package/OPENAPI_VERSION +1 -1
- package/README.md +0 -1
- package/VERSION +1 -1
- package/cjs/Error.js +1 -115
- package/cjs/RequestSender.js +1 -1
- package/cjs/apiVersion.js +3 -2
- package/cjs/resources/FinancialConnections/Accounts.js +0 -5
- package/cjs/resources/Mandates.js +0 -5
- package/cjs/resources/PaymentIntents.js +0 -8
- package/cjs/resources/PaymentRecords.js +4 -0
- package/cjs/resources/Quotes.js +0 -32
- package/cjs/resources/SubscriptionSchedules.js +0 -4
- package/cjs/resources/Subscriptions.js +0 -4
- package/cjs/resources.js +8 -106
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +0 -100
- package/esm/RequestSender.js +1 -1
- package/esm/apiVersion.js +2 -1
- package/esm/resources/FinancialConnections/Accounts.js +0 -5
- package/esm/resources/Mandates.js +0 -5
- package/esm/resources/PaymentIntents.js +0 -8
- package/esm/resources/PaymentRecords.js +4 -0
- package/esm/resources/Quotes.js +0 -32
- package/esm/resources/SubscriptionSchedules.js +0 -4
- package/esm/resources/Subscriptions.js +0 -4
- package/esm/resources.js +0 -93
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +1 -5
- package/types/AccountSessions.d.ts +0 -45
- package/types/AccountSessionsResource.d.ts +0 -264
- package/types/Accounts.d.ts +23 -212
- package/types/AccountsResource.d.ts +44 -544
- package/types/Billing/AlertTriggereds.d.ts +1 -1
- 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 +3 -13
- package/types/BillingPortal/Configurations.d.ts +1 -1
- 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 +1 -172
- package/types/ChargesResource.d.ts +0 -1406
- package/types/Checkout/Sessions.d.ts +17 -369
- package/types/Checkout/SessionsResource.d.ts +23 -635
- package/types/ConfirmationTokens.d.ts +1 -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 +26 -5
- package/types/CreditNotesResource.d.ts +78 -5
- package/types/CustomerBalanceTransactions.d.ts +0 -2
- package/types/CustomerCashBalanceTransactions.d.ts +0 -2
- package/types/CustomerSessions.d.ts +120 -5
- package/types/CustomerSessionsResource.d.ts +121 -6
- package/types/Customers.d.ts +7 -2
- package/types/CustomersResource.d.ts +1 -8
- package/types/Discounts.d.ts +0 -10
- package/types/Disputes.d.ts +0 -40
- package/types/DisputesResource.d.ts +0 -11
- package/types/Errors.d.ts +0 -85
- package/types/EventTypes.d.ts +0 -630
- package/types/Events.d.ts +0 -95
- package/types/Files.d.ts +1 -0
- package/types/FilesResource.d.ts +2 -0
- package/types/FinancialConnections/Accounts.d.ts +1 -36
- package/types/FinancialConnections/AccountsResource.d.ts +4 -41
- 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 +1 -1
- package/types/Invoices.d.ts +5 -203
- package/types/InvoicesResource.d.ts +4 -1622
- 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 +1 -135
- package/types/MandatesResource.d.ts +0 -31
- package/types/PaymentAttemptRecords.d.ts +1 -137
- package/types/PaymentAttemptRecordsResource.d.ts +5 -0
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +17 -7
- package/types/PaymentIntents.d.ts +23 -782
- package/types/PaymentIntentsResource.d.ts +4783 -9501
- package/types/PaymentLinks.d.ts +34 -6
- package/types/PaymentLinksResource.d.ts +88 -12
- package/types/PaymentMethodConfigurations.d.ts +46 -190
- package/types/PaymentMethodConfigurationsResource.d.ts +100 -300
- package/types/PaymentMethods.d.ts +34 -130
- package/types/PaymentMethodsResource.d.ts +17 -168
- package/types/PaymentRecords.d.ts +1 -137
- package/types/PaymentRecordsResource.d.ts +89 -0
- package/types/PayoutsResource.d.ts +1 -1
- 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 +1 -594
- package/types/QuotesResource.d.ts +290 -2635
- package/types/Refunds.d.ts +9 -14
- package/types/SetupAttempts.d.ts +2 -51
- package/types/SetupIntents.d.ts +59 -209
- package/types/SetupIntentsResource.d.ts +132 -952
- package/types/Sources.d.ts +0 -29
- package/types/SubscriptionItems.d.ts +0 -26
- package/types/SubscriptionItemsResource.d.ts +0 -109
- package/types/SubscriptionSchedules.d.ts +0 -205
- package/types/SubscriptionSchedulesResource.d.ts +4 -1232
- package/types/Subscriptions.d.ts +1 -262
- package/types/SubscriptionsResource.d.ts +8 -745
- 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 +19 -9
- package/types/Terminal/ConfigurationsResource.d.ts +44 -28
- package/types/Terminal/Readers.d.ts +14 -29
- package/types/Terminal/ReadersResource.d.ts +30 -30
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -126
- package/types/TestHelpers/Terminal/ReadersResource.d.ts +1 -1
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
- package/types/TokensResource.d.ts +22 -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 +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/Core/EventTypes.d.ts +10 -1647
- package/types/V2/Core/EventsResource.d.ts +29 -3
- package/types/WebhookEndpointsResource.d.ts +2 -75
- package/types/apiVersion.d.ts +2 -1
- package/types/crypto/crypto.d.ts +1 -1
- package/types/index.d.ts +0 -153
- package/types/lib.d.ts +0 -10
- package/cjs/resources/AccountNotices.js +0 -21
- package/cjs/resources/Billing/Analytics/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/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/Billing/BillSettings/Versions.js +0 -17
- package/cjs/resources/V2/Billing/BillSettings.js +0 -27
- package/cjs/resources/V2/Billing/Cadences.js +0 -23
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -17
- package/cjs/resources/V2/Billing/CollectionSettings.js +0 -30
- package/cjs/resources/V2/Billing/Profiles.js +0 -19
- 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 -29
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
- package/esm/resources/AccountNotices.js +0 -18
- package/esm/resources/Billing/Analytics/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/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/Billing/BillSettings/Versions.js +0 -14
- package/esm/resources/V2/Billing/BillSettings.js +0 -24
- package/esm/resources/V2/Billing/Cadences.js +0 -20
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -14
- package/esm/resources/V2/Billing/CollectionSettings.js +0 -27
- package/esm/resources/V2/Billing/Profiles.js +0 -16
- 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 -26
- 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/Billing/Analytics/MeterUsage.d.ts +0 -31
- package/types/Billing/Analytics/MeterUsageResource.d.ts +0 -689
- package/types/Billing/Analytics/MeterUsageRows.d.ts +0 -51
- 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/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 -1770
- package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -908
- 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/Billing/BillSettingVersions.d.ts +0 -97
- package/types/V2/Billing/BillSettings/VersionsResource.d.ts +0 -58
- package/types/V2/Billing/BillSettings.d.ts +0 -120
- package/types/V2/Billing/BillSettingsResource.d.ts +0 -241
- package/types/V2/Billing/Cadences.d.ts +0 -686
- package/types/V2/Billing/CadencesResource.d.ts +0 -487
- package/types/V2/Billing/CollectionSettingVersions.d.ts +0 -314
- package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +0 -62
- package/types/V2/Billing/CollectionSettings.d.ts +0 -337
- package/types/V2/Billing/CollectionSettingsResource.d.ts +0 -675
- package/types/V2/Billing/Profiles.d.ts +0 -70
- package/types/V2/Billing/ProfilesResource.d.ts +0 -150
- package/types/V2/Core/AccountLinks.d.ts +0 -168
- package/types/V2/Core/AccountLinksResource.d.ts +0 -152
- package/types/V2/Core/AccountPersons.d.ts +0 -615
- package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -1153
- package/types/V2/Core/Accounts.d.ts +0 -5919
- package/types/V2/Core/AccountsResource.d.ts +0 -4999
- 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 -148
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -147
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -178
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -112
- 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 -170
- 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/PayoutMethodsBankAccountSpec.d.ts +0 -93
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -302
- 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 -162
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
- package/types/V2/MoneyManagement/Transactions.d.ts +0 -177
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
- package/types/V2/Payments/OffSessionPayments.d.ts +0 -326
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -401
- 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
|
*/
|
|
@@ -23,11 +28,6 @@ declare module 'stripe' {
|
|
|
23
28
|
*/
|
|
24
29
|
backdate_start_date?: number;
|
|
25
30
|
|
|
26
|
-
/**
|
|
27
|
-
* The Billing Cadence which controls the timing of recurring invoice generation for this subscription. If unset, the subscription will bill according to its own configured schedule and create its own invoices. If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
|
|
28
|
-
*/
|
|
29
|
-
billing_cadence?: string;
|
|
30
|
-
|
|
31
31
|
/**
|
|
32
32
|
* A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
|
|
33
33
|
*/
|
|
@@ -43,11 +43,6 @@ declare module 'stripe' {
|
|
|
43
43
|
*/
|
|
44
44
|
billing_mode?: SubscriptionCreateParams.BillingMode;
|
|
45
45
|
|
|
46
|
-
/**
|
|
47
|
-
* Sets the billing schedules for the subscription.
|
|
48
|
-
*/
|
|
49
|
-
billing_schedules?: Array<SubscriptionCreateParams.BillingSchedule>;
|
|
50
|
-
|
|
51
46
|
/**
|
|
52
47
|
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
|
|
53
48
|
*/
|
|
@@ -75,16 +70,6 @@ declare module 'stripe' {
|
|
|
75
70
|
*/
|
|
76
71
|
currency?: string;
|
|
77
72
|
|
|
78
|
-
/**
|
|
79
|
-
* The identifier of the customer to subscribe.
|
|
80
|
-
*/
|
|
81
|
-
customer?: string;
|
|
82
|
-
|
|
83
|
-
/**
|
|
84
|
-
* The identifier of the account to subscribe.
|
|
85
|
-
*/
|
|
86
|
-
customer_account?: string;
|
|
87
|
-
|
|
88
73
|
/**
|
|
89
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`.
|
|
90
75
|
*/
|
|
@@ -172,11 +157,6 @@ declare module 'stripe' {
|
|
|
172
157
|
SubscriptionCreateParams.PendingInvoiceItemInterval
|
|
173
158
|
>;
|
|
174
159
|
|
|
175
|
-
/**
|
|
176
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
177
|
-
*/
|
|
178
|
-
prebilling?: SubscriptionCreateParams.Prebilling;
|
|
179
|
-
|
|
180
160
|
/**
|
|
181
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`.
|
|
182
162
|
*/
|
|
@@ -258,56 +238,12 @@ declare module 'stripe' {
|
|
|
258
238
|
*/
|
|
259
239
|
discount?: string;
|
|
260
240
|
|
|
261
|
-
/**
|
|
262
|
-
* Details to determine how long the discount should be applied for.
|
|
263
|
-
*/
|
|
264
|
-
discount_end?: Discount.DiscountEnd;
|
|
265
|
-
|
|
266
241
|
/**
|
|
267
242
|
* ID of the promotion code to create a new discount for.
|
|
268
243
|
*/
|
|
269
244
|
promotion_code?: string;
|
|
270
245
|
}
|
|
271
246
|
|
|
272
|
-
namespace Discount {
|
|
273
|
-
interface DiscountEnd {
|
|
274
|
-
/**
|
|
275
|
-
* Time span for the redeemed discount.
|
|
276
|
-
*/
|
|
277
|
-
duration?: DiscountEnd.Duration;
|
|
278
|
-
|
|
279
|
-
/**
|
|
280
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
281
|
-
*/
|
|
282
|
-
timestamp?: number;
|
|
283
|
-
|
|
284
|
-
/**
|
|
285
|
-
* The type of calculation made to determine when the discount ends.
|
|
286
|
-
*/
|
|
287
|
-
type: DiscountEnd.Type;
|
|
288
|
-
}
|
|
289
|
-
|
|
290
|
-
namespace DiscountEnd {
|
|
291
|
-
interface Duration {
|
|
292
|
-
/**
|
|
293
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
294
|
-
*/
|
|
295
|
-
interval: Duration.Interval;
|
|
296
|
-
|
|
297
|
-
/**
|
|
298
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
299
|
-
*/
|
|
300
|
-
interval_count: number;
|
|
301
|
-
}
|
|
302
|
-
|
|
303
|
-
namespace Duration {
|
|
304
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
type Type = 'duration' | 'timestamp';
|
|
308
|
-
}
|
|
309
|
-
}
|
|
310
|
-
|
|
311
247
|
interface Period {
|
|
312
248
|
/**
|
|
313
249
|
* End of the invoice item period.
|
|
@@ -470,74 +406,6 @@ declare module 'stripe' {
|
|
|
470
406
|
type Type = 'classic' | 'flexible';
|
|
471
407
|
}
|
|
472
408
|
|
|
473
|
-
interface BillingSchedule {
|
|
474
|
-
/**
|
|
475
|
-
* Configure billing schedule differently for individual subscription items.
|
|
476
|
-
*/
|
|
477
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
478
|
-
|
|
479
|
-
/**
|
|
480
|
-
* The end date for the billing schedule.
|
|
481
|
-
*/
|
|
482
|
-
bill_until: BillingSchedule.BillUntil;
|
|
483
|
-
|
|
484
|
-
/**
|
|
485
|
-
* Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
|
|
486
|
-
*/
|
|
487
|
-
key?: string;
|
|
488
|
-
}
|
|
489
|
-
|
|
490
|
-
namespace BillingSchedule {
|
|
491
|
-
interface AppliesTo {
|
|
492
|
-
/**
|
|
493
|
-
* The ID of the price object.
|
|
494
|
-
*/
|
|
495
|
-
price?: string;
|
|
496
|
-
|
|
497
|
-
/**
|
|
498
|
-
* Controls which subscription items the billing schedule applies to.
|
|
499
|
-
*/
|
|
500
|
-
type: 'price';
|
|
501
|
-
}
|
|
502
|
-
|
|
503
|
-
interface BillUntil {
|
|
504
|
-
/**
|
|
505
|
-
* Specifies the billing period.
|
|
506
|
-
*/
|
|
507
|
-
duration?: BillUntil.Duration;
|
|
508
|
-
|
|
509
|
-
/**
|
|
510
|
-
* The end date of the billing schedule.
|
|
511
|
-
*/
|
|
512
|
-
timestamp?: number;
|
|
513
|
-
|
|
514
|
-
/**
|
|
515
|
-
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
516
|
-
*/
|
|
517
|
-
type: BillUntil.Type;
|
|
518
|
-
}
|
|
519
|
-
|
|
520
|
-
namespace BillUntil {
|
|
521
|
-
interface Duration {
|
|
522
|
-
/**
|
|
523
|
-
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
524
|
-
*/
|
|
525
|
-
interval: Duration.Interval;
|
|
526
|
-
|
|
527
|
-
/**
|
|
528
|
-
* The multiplier applied to the interval.
|
|
529
|
-
*/
|
|
530
|
-
interval_count?: number;
|
|
531
|
-
}
|
|
532
|
-
|
|
533
|
-
namespace Duration {
|
|
534
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
535
|
-
}
|
|
536
|
-
|
|
537
|
-
type Type = 'duration' | 'timestamp';
|
|
538
|
-
}
|
|
539
|
-
}
|
|
540
|
-
|
|
541
409
|
interface BillingThresholds {
|
|
542
410
|
/**
|
|
543
411
|
* Monetary threshold that triggers the subscription to advance to a new billing period
|
|
@@ -565,56 +433,12 @@ declare module 'stripe' {
|
|
|
565
433
|
*/
|
|
566
434
|
discount?: string;
|
|
567
435
|
|
|
568
|
-
/**
|
|
569
|
-
* Details to determine how long the discount should be applied for.
|
|
570
|
-
*/
|
|
571
|
-
discount_end?: Discount.DiscountEnd;
|
|
572
|
-
|
|
573
436
|
/**
|
|
574
437
|
* ID of the promotion code to create a new discount for.
|
|
575
438
|
*/
|
|
576
439
|
promotion_code?: string;
|
|
577
440
|
}
|
|
578
441
|
|
|
579
|
-
namespace Discount {
|
|
580
|
-
interface DiscountEnd {
|
|
581
|
-
/**
|
|
582
|
-
* Time span for the redeemed discount.
|
|
583
|
-
*/
|
|
584
|
-
duration?: DiscountEnd.Duration;
|
|
585
|
-
|
|
586
|
-
/**
|
|
587
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
588
|
-
*/
|
|
589
|
-
timestamp?: number;
|
|
590
|
-
|
|
591
|
-
/**
|
|
592
|
-
* The type of calculation made to determine when the discount ends.
|
|
593
|
-
*/
|
|
594
|
-
type: DiscountEnd.Type;
|
|
595
|
-
}
|
|
596
|
-
|
|
597
|
-
namespace DiscountEnd {
|
|
598
|
-
interface Duration {
|
|
599
|
-
/**
|
|
600
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
601
|
-
*/
|
|
602
|
-
interval: Duration.Interval;
|
|
603
|
-
|
|
604
|
-
/**
|
|
605
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
606
|
-
*/
|
|
607
|
-
interval_count: number;
|
|
608
|
-
}
|
|
609
|
-
|
|
610
|
-
namespace Duration {
|
|
611
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
612
|
-
}
|
|
613
|
-
|
|
614
|
-
type Type = 'duration' | 'timestamp';
|
|
615
|
-
}
|
|
616
|
-
}
|
|
617
|
-
|
|
618
442
|
interface InvoiceSettings {
|
|
619
443
|
/**
|
|
620
444
|
* The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
|
|
@@ -685,11 +509,6 @@ declare module 'stripe' {
|
|
|
685
509
|
* 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.
|
|
686
510
|
*/
|
|
687
511
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
688
|
-
|
|
689
|
-
/**
|
|
690
|
-
* Define options to configure the trial on the subscription item.
|
|
691
|
-
*/
|
|
692
|
-
trial?: Item.Trial;
|
|
693
512
|
}
|
|
694
513
|
|
|
695
514
|
namespace Item {
|
|
@@ -711,56 +530,12 @@ declare module 'stripe' {
|
|
|
711
530
|
*/
|
|
712
531
|
discount?: string;
|
|
713
532
|
|
|
714
|
-
/**
|
|
715
|
-
* Details to determine how long the discount should be applied for.
|
|
716
|
-
*/
|
|
717
|
-
discount_end?: Discount.DiscountEnd;
|
|
718
|
-
|
|
719
533
|
/**
|
|
720
534
|
* ID of the promotion code to create a new discount for.
|
|
721
535
|
*/
|
|
722
536
|
promotion_code?: string;
|
|
723
537
|
}
|
|
724
538
|
|
|
725
|
-
namespace Discount {
|
|
726
|
-
interface DiscountEnd {
|
|
727
|
-
/**
|
|
728
|
-
* Time span for the redeemed discount.
|
|
729
|
-
*/
|
|
730
|
-
duration?: DiscountEnd.Duration;
|
|
731
|
-
|
|
732
|
-
/**
|
|
733
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
734
|
-
*/
|
|
735
|
-
timestamp?: number;
|
|
736
|
-
|
|
737
|
-
/**
|
|
738
|
-
* The type of calculation made to determine when the discount ends.
|
|
739
|
-
*/
|
|
740
|
-
type: DiscountEnd.Type;
|
|
741
|
-
}
|
|
742
|
-
|
|
743
|
-
namespace DiscountEnd {
|
|
744
|
-
interface Duration {
|
|
745
|
-
/**
|
|
746
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
747
|
-
*/
|
|
748
|
-
interval: Duration.Interval;
|
|
749
|
-
|
|
750
|
-
/**
|
|
751
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
752
|
-
*/
|
|
753
|
-
interval_count: number;
|
|
754
|
-
}
|
|
755
|
-
|
|
756
|
-
namespace Duration {
|
|
757
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
758
|
-
}
|
|
759
|
-
|
|
760
|
-
type Type = 'duration' | 'timestamp';
|
|
761
|
-
}
|
|
762
|
-
}
|
|
763
|
-
|
|
764
539
|
interface PriceData {
|
|
765
540
|
/**
|
|
766
541
|
* 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).
|
|
@@ -812,22 +587,6 @@ declare module 'stripe' {
|
|
|
812
587
|
|
|
813
588
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
814
589
|
}
|
|
815
|
-
|
|
816
|
-
interface Trial {
|
|
817
|
-
/**
|
|
818
|
-
* 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.
|
|
819
|
-
*/
|
|
820
|
-
converts_to?: Array<string>;
|
|
821
|
-
|
|
822
|
-
/**
|
|
823
|
-
* Determines the type of trial for this item.
|
|
824
|
-
*/
|
|
825
|
-
type: Trial.Type;
|
|
826
|
-
}
|
|
827
|
-
|
|
828
|
-
namespace Trial {
|
|
829
|
-
type Type = 'free' | 'paid';
|
|
830
|
-
}
|
|
831
590
|
}
|
|
832
591
|
|
|
833
592
|
type PaymentBehavior =
|
|
@@ -879,33 +638,16 @@ declare module 'stripe' {
|
|
|
879
638
|
PaymentMethodOptions.CustomerBalance
|
|
880
639
|
>;
|
|
881
640
|
|
|
882
|
-
/**
|
|
883
|
-
* This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
884
|
-
*/
|
|
885
|
-
id_bank_transfer?: Stripe.Emptyable<
|
|
886
|
-
PaymentMethodOptions.IdBankTransfer
|
|
887
|
-
>;
|
|
888
|
-
|
|
889
641
|
/**
|
|
890
642
|
* This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
891
643
|
*/
|
|
892
644
|
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
|
|
893
645
|
|
|
894
|
-
/**
|
|
895
|
-
* This sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
|
|
896
|
-
*/
|
|
897
|
-
pix?: Stripe.Emptyable<PaymentMethodOptions.Pix>;
|
|
898
|
-
|
|
899
646
|
/**
|
|
900
647
|
* This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
|
|
901
648
|
*/
|
|
902
649
|
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
|
|
903
650
|
|
|
904
|
-
/**
|
|
905
|
-
* This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
|
|
906
|
-
*/
|
|
907
|
-
upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
|
|
908
|
-
|
|
909
651
|
/**
|
|
910
652
|
* This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
911
653
|
*/
|
|
@@ -1045,89 +787,10 @@ declare module 'stripe' {
|
|
|
1045
787
|
}
|
|
1046
788
|
}
|
|
1047
789
|
|
|
1048
|
-
interface IdBankTransfer {}
|
|
1049
|
-
|
|
1050
790
|
interface Konbini {}
|
|
1051
791
|
|
|
1052
|
-
interface Pix {
|
|
1053
|
-
/**
|
|
1054
|
-
* Configuration options for setting up a mandate
|
|
1055
|
-
*/
|
|
1056
|
-
mandate_options?: Pix.MandateOptions;
|
|
1057
|
-
}
|
|
1058
|
-
|
|
1059
|
-
namespace Pix {
|
|
1060
|
-
interface MandateOptions {
|
|
1061
|
-
/**
|
|
1062
|
-
* Amount to be charged for future payments. If not provided, defaults to 40000.
|
|
1063
|
-
*/
|
|
1064
|
-
amount?: number;
|
|
1065
|
-
|
|
1066
|
-
/**
|
|
1067
|
-
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
1068
|
-
*/
|
|
1069
|
-
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
1070
|
-
|
|
1071
|
-
/**
|
|
1072
|
-
* Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled.
|
|
1073
|
-
*/
|
|
1074
|
-
end_date?: string;
|
|
1075
|
-
|
|
1076
|
-
/**
|
|
1077
|
-
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
1078
|
-
*/
|
|
1079
|
-
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
1080
|
-
}
|
|
1081
|
-
|
|
1082
|
-
namespace MandateOptions {
|
|
1083
|
-
type AmountIncludesIof = 'always' | 'never';
|
|
1084
|
-
|
|
1085
|
-
type PaymentSchedule =
|
|
1086
|
-
| 'halfyearly'
|
|
1087
|
-
| 'monthly'
|
|
1088
|
-
| 'quarterly'
|
|
1089
|
-
| 'weekly'
|
|
1090
|
-
| 'yearly';
|
|
1091
|
-
}
|
|
1092
|
-
}
|
|
1093
|
-
|
|
1094
792
|
interface SepaDebit {}
|
|
1095
793
|
|
|
1096
|
-
interface Upi {
|
|
1097
|
-
/**
|
|
1098
|
-
* Configuration options for setting up an eMandate
|
|
1099
|
-
*/
|
|
1100
|
-
mandate_options?: Upi.MandateOptions;
|
|
1101
|
-
}
|
|
1102
|
-
|
|
1103
|
-
namespace Upi {
|
|
1104
|
-
interface MandateOptions {
|
|
1105
|
-
/**
|
|
1106
|
-
* Amount to be charged for future payments.
|
|
1107
|
-
*/
|
|
1108
|
-
amount?: number;
|
|
1109
|
-
|
|
1110
|
-
/**
|
|
1111
|
-
* 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.
|
|
1112
|
-
*/
|
|
1113
|
-
amount_type?: MandateOptions.AmountType;
|
|
1114
|
-
|
|
1115
|
-
/**
|
|
1116
|
-
* A description of the mandate or subscription that is meant to be displayed to the customer.
|
|
1117
|
-
*/
|
|
1118
|
-
description?: string;
|
|
1119
|
-
|
|
1120
|
-
/**
|
|
1121
|
-
* 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.
|
|
1122
|
-
*/
|
|
1123
|
-
end_date?: number;
|
|
1124
|
-
}
|
|
1125
|
-
|
|
1126
|
-
namespace MandateOptions {
|
|
1127
|
-
type AmountType = 'fixed' | 'maximum';
|
|
1128
|
-
}
|
|
1129
|
-
}
|
|
1130
|
-
|
|
1131
794
|
interface UsBankAccount {
|
|
1132
795
|
/**
|
|
1133
796
|
* Additional fields for Financial Connections Session creation
|
|
@@ -1164,11 +827,6 @@ declare module 'stripe' {
|
|
|
1164
827
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1165
828
|
*/
|
|
1166
829
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1167
|
-
|
|
1168
|
-
/**
|
|
1169
|
-
* ID of the institution to use to filter for selectable accounts.
|
|
1170
|
-
*/
|
|
1171
|
-
institution?: string;
|
|
1172
830
|
}
|
|
1173
831
|
|
|
1174
832
|
namespace Filters {
|
|
@@ -1181,11 +839,7 @@ declare module 'stripe' {
|
|
|
1181
839
|
| 'payment_method'
|
|
1182
840
|
| 'transactions';
|
|
1183
841
|
|
|
1184
|
-
type Prefetch =
|
|
1185
|
-
| 'balances'
|
|
1186
|
-
| 'inferred_balances'
|
|
1187
|
-
| 'ownership'
|
|
1188
|
-
| 'transactions';
|
|
842
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
1189
843
|
}
|
|
1190
844
|
|
|
1191
845
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
@@ -1211,7 +865,6 @@ declare module 'stripe' {
|
|
|
1211
865
|
| 'fpx'
|
|
1212
866
|
| 'giropay'
|
|
1213
867
|
| 'grabpay'
|
|
1214
|
-
| 'id_bank_transfer'
|
|
1215
868
|
| 'ideal'
|
|
1216
869
|
| 'jp_credit_transfer'
|
|
1217
870
|
| 'kakao_pay'
|
|
@@ -1226,15 +879,12 @@ declare module 'stripe' {
|
|
|
1226
879
|
| 'payco'
|
|
1227
880
|
| 'paynow'
|
|
1228
881
|
| 'paypal'
|
|
1229
|
-
| 'pix'
|
|
1230
882
|
| 'promptpay'
|
|
1231
883
|
| 'revolut_pay'
|
|
1232
884
|
| 'sepa_credit_transfer'
|
|
1233
885
|
| 'sepa_debit'
|
|
1234
886
|
| 'sofort'
|
|
1235
|
-
| 'stripe_balance'
|
|
1236
887
|
| 'swish'
|
|
1237
|
-
| 'upi'
|
|
1238
888
|
| 'us_bank_account'
|
|
1239
889
|
| 'wechat_pay';
|
|
1240
890
|
|
|
@@ -1257,22 +907,6 @@ declare module 'stripe' {
|
|
|
1257
907
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1258
908
|
}
|
|
1259
909
|
|
|
1260
|
-
interface Prebilling {
|
|
1261
|
-
/**
|
|
1262
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
1263
|
-
*/
|
|
1264
|
-
iterations: number;
|
|
1265
|
-
|
|
1266
|
-
/**
|
|
1267
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
1268
|
-
*/
|
|
1269
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
1270
|
-
}
|
|
1271
|
-
|
|
1272
|
-
namespace Prebilling {
|
|
1273
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
1274
|
-
}
|
|
1275
|
-
|
|
1276
910
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1277
911
|
|
|
1278
912
|
interface TransferData {
|
|
@@ -1331,23 +965,11 @@ declare module 'stripe' {
|
|
|
1331
965
|
*/
|
|
1332
966
|
automatic_tax?: SubscriptionUpdateParams.AutomaticTax;
|
|
1333
967
|
|
|
1334
|
-
/**
|
|
1335
|
-
* The Billing Cadence which controls the timing of recurring invoice generation for this subscription. If unset, the subscription will bill according to its own configured schedule and create its own invoices. If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
|
|
1336
|
-
*/
|
|
1337
|
-
billing_cadence?: string;
|
|
1338
|
-
|
|
1339
968
|
/**
|
|
1340
969
|
* Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
|
1341
970
|
*/
|
|
1342
971
|
billing_cycle_anchor?: SubscriptionUpdateParams.BillingCycleAnchor;
|
|
1343
972
|
|
|
1344
|
-
/**
|
|
1345
|
-
* Sets the billing schedules for the subscription.
|
|
1346
|
-
*/
|
|
1347
|
-
billing_schedules?: Stripe.Emptyable<
|
|
1348
|
-
Array<SubscriptionUpdateParams.BillingSchedule>
|
|
1349
|
-
>;
|
|
1350
|
-
|
|
1351
973
|
/**
|
|
1352
974
|
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
|
|
1353
975
|
*/
|
|
@@ -1465,11 +1087,6 @@ declare module 'stripe' {
|
|
|
1465
1087
|
SubscriptionUpdateParams.PendingInvoiceItemInterval
|
|
1466
1088
|
>;
|
|
1467
1089
|
|
|
1468
|
-
/**
|
|
1469
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
1470
|
-
*/
|
|
1471
|
-
prebilling?: SubscriptionUpdateParams.Prebilling;
|
|
1472
|
-
|
|
1473
1090
|
/**
|
|
1474
1091
|
* 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`.
|
|
1475
1092
|
*/
|
|
@@ -1551,56 +1168,12 @@ declare module 'stripe' {
|
|
|
1551
1168
|
*/
|
|
1552
1169
|
discount?: string;
|
|
1553
1170
|
|
|
1554
|
-
/**
|
|
1555
|
-
* Details to determine how long the discount should be applied for.
|
|
1556
|
-
*/
|
|
1557
|
-
discount_end?: Discount.DiscountEnd;
|
|
1558
|
-
|
|
1559
1171
|
/**
|
|
1560
1172
|
* ID of the promotion code to create a new discount for.
|
|
1561
1173
|
*/
|
|
1562
1174
|
promotion_code?: string;
|
|
1563
1175
|
}
|
|
1564
1176
|
|
|
1565
|
-
namespace Discount {
|
|
1566
|
-
interface DiscountEnd {
|
|
1567
|
-
/**
|
|
1568
|
-
* Time span for the redeemed discount.
|
|
1569
|
-
*/
|
|
1570
|
-
duration?: DiscountEnd.Duration;
|
|
1571
|
-
|
|
1572
|
-
/**
|
|
1573
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1574
|
-
*/
|
|
1575
|
-
timestamp?: number;
|
|
1576
|
-
|
|
1577
|
-
/**
|
|
1578
|
-
* The type of calculation made to determine when the discount ends.
|
|
1579
|
-
*/
|
|
1580
|
-
type: DiscountEnd.Type;
|
|
1581
|
-
}
|
|
1582
|
-
|
|
1583
|
-
namespace DiscountEnd {
|
|
1584
|
-
interface Duration {
|
|
1585
|
-
/**
|
|
1586
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1587
|
-
*/
|
|
1588
|
-
interval: Duration.Interval;
|
|
1589
|
-
|
|
1590
|
-
/**
|
|
1591
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1592
|
-
*/
|
|
1593
|
-
interval_count: number;
|
|
1594
|
-
}
|
|
1595
|
-
|
|
1596
|
-
namespace Duration {
|
|
1597
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1598
|
-
}
|
|
1599
|
-
|
|
1600
|
-
type Type = 'duration' | 'timestamp';
|
|
1601
|
-
}
|
|
1602
|
-
}
|
|
1603
|
-
|
|
1604
1177
|
interface Period {
|
|
1605
1178
|
/**
|
|
1606
1179
|
* End of the invoice item period.
|
|
@@ -1711,74 +1284,6 @@ declare module 'stripe' {
|
|
|
1711
1284
|
|
|
1712
1285
|
type BillingCycleAnchor = 'now' | 'unchanged';
|
|
1713
1286
|
|
|
1714
|
-
interface BillingSchedule {
|
|
1715
|
-
/**
|
|
1716
|
-
* Configure billing schedule differently for individual subscription items.
|
|
1717
|
-
*/
|
|
1718
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
1719
|
-
|
|
1720
|
-
/**
|
|
1721
|
-
* The end date for the billing schedule.
|
|
1722
|
-
*/
|
|
1723
|
-
bill_until?: BillingSchedule.BillUntil;
|
|
1724
|
-
|
|
1725
|
-
/**
|
|
1726
|
-
* Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
|
|
1727
|
-
*/
|
|
1728
|
-
key?: string;
|
|
1729
|
-
}
|
|
1730
|
-
|
|
1731
|
-
namespace BillingSchedule {
|
|
1732
|
-
interface AppliesTo {
|
|
1733
|
-
/**
|
|
1734
|
-
* The ID of the price object.
|
|
1735
|
-
*/
|
|
1736
|
-
price?: string;
|
|
1737
|
-
|
|
1738
|
-
/**
|
|
1739
|
-
* Controls which subscription items the billing schedule applies to.
|
|
1740
|
-
*/
|
|
1741
|
-
type: 'price';
|
|
1742
|
-
}
|
|
1743
|
-
|
|
1744
|
-
interface BillUntil {
|
|
1745
|
-
/**
|
|
1746
|
-
* Specifies the billing period.
|
|
1747
|
-
*/
|
|
1748
|
-
duration?: BillUntil.Duration;
|
|
1749
|
-
|
|
1750
|
-
/**
|
|
1751
|
-
* The end date of the billing schedule.
|
|
1752
|
-
*/
|
|
1753
|
-
timestamp?: number;
|
|
1754
|
-
|
|
1755
|
-
/**
|
|
1756
|
-
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
1757
|
-
*/
|
|
1758
|
-
type: BillUntil.Type;
|
|
1759
|
-
}
|
|
1760
|
-
|
|
1761
|
-
namespace BillUntil {
|
|
1762
|
-
interface Duration {
|
|
1763
|
-
/**
|
|
1764
|
-
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
1765
|
-
*/
|
|
1766
|
-
interval: Duration.Interval;
|
|
1767
|
-
|
|
1768
|
-
/**
|
|
1769
|
-
* The multiplier applied to the interval.
|
|
1770
|
-
*/
|
|
1771
|
-
interval_count?: number;
|
|
1772
|
-
}
|
|
1773
|
-
|
|
1774
|
-
namespace Duration {
|
|
1775
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1776
|
-
}
|
|
1777
|
-
|
|
1778
|
-
type Type = 'duration' | 'timestamp';
|
|
1779
|
-
}
|
|
1780
|
-
}
|
|
1781
|
-
|
|
1782
1287
|
interface BillingThresholds {
|
|
1783
1288
|
/**
|
|
1784
1289
|
* Monetary threshold that triggers the subscription to advance to a new billing period
|
|
@@ -1830,56 +1335,12 @@ declare module 'stripe' {
|
|
|
1830
1335
|
*/
|
|
1831
1336
|
discount?: string;
|
|
1832
1337
|
|
|
1833
|
-
/**
|
|
1834
|
-
* Details to determine how long the discount should be applied for.
|
|
1835
|
-
*/
|
|
1836
|
-
discount_end?: Discount.DiscountEnd;
|
|
1837
|
-
|
|
1838
1338
|
/**
|
|
1839
1339
|
* ID of the promotion code to create a new discount for.
|
|
1840
1340
|
*/
|
|
1841
1341
|
promotion_code?: string;
|
|
1842
1342
|
}
|
|
1843
1343
|
|
|
1844
|
-
namespace Discount {
|
|
1845
|
-
interface DiscountEnd {
|
|
1846
|
-
/**
|
|
1847
|
-
* Time span for the redeemed discount.
|
|
1848
|
-
*/
|
|
1849
|
-
duration?: DiscountEnd.Duration;
|
|
1850
|
-
|
|
1851
|
-
/**
|
|
1852
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1853
|
-
*/
|
|
1854
|
-
timestamp?: number;
|
|
1855
|
-
|
|
1856
|
-
/**
|
|
1857
|
-
* The type of calculation made to determine when the discount ends.
|
|
1858
|
-
*/
|
|
1859
|
-
type: DiscountEnd.Type;
|
|
1860
|
-
}
|
|
1861
|
-
|
|
1862
|
-
namespace DiscountEnd {
|
|
1863
|
-
interface Duration {
|
|
1864
|
-
/**
|
|
1865
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1866
|
-
*/
|
|
1867
|
-
interval: Duration.Interval;
|
|
1868
|
-
|
|
1869
|
-
/**
|
|
1870
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1871
|
-
*/
|
|
1872
|
-
interval_count: number;
|
|
1873
|
-
}
|
|
1874
|
-
|
|
1875
|
-
namespace Duration {
|
|
1876
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1877
|
-
}
|
|
1878
|
-
|
|
1879
|
-
type Type = 'duration' | 'timestamp';
|
|
1880
|
-
}
|
|
1881
|
-
}
|
|
1882
|
-
|
|
1883
1344
|
interface InvoiceSettings {
|
|
1884
1345
|
/**
|
|
1885
1346
|
* The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
|
|
@@ -1986,56 +1447,12 @@ declare module 'stripe' {
|
|
|
1986
1447
|
*/
|
|
1987
1448
|
discount?: string;
|
|
1988
1449
|
|
|
1989
|
-
/**
|
|
1990
|
-
* Details to determine how long the discount should be applied for.
|
|
1991
|
-
*/
|
|
1992
|
-
discount_end?: Discount.DiscountEnd;
|
|
1993
|
-
|
|
1994
1450
|
/**
|
|
1995
1451
|
* ID of the promotion code to create a new discount for.
|
|
1996
1452
|
*/
|
|
1997
1453
|
promotion_code?: string;
|
|
1998
1454
|
}
|
|
1999
1455
|
|
|
2000
|
-
namespace Discount {
|
|
2001
|
-
interface DiscountEnd {
|
|
2002
|
-
/**
|
|
2003
|
-
* Time span for the redeemed discount.
|
|
2004
|
-
*/
|
|
2005
|
-
duration?: DiscountEnd.Duration;
|
|
2006
|
-
|
|
2007
|
-
/**
|
|
2008
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2009
|
-
*/
|
|
2010
|
-
timestamp?: number;
|
|
2011
|
-
|
|
2012
|
-
/**
|
|
2013
|
-
* The type of calculation made to determine when the discount ends.
|
|
2014
|
-
*/
|
|
2015
|
-
type: DiscountEnd.Type;
|
|
2016
|
-
}
|
|
2017
|
-
|
|
2018
|
-
namespace DiscountEnd {
|
|
2019
|
-
interface Duration {
|
|
2020
|
-
/**
|
|
2021
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2022
|
-
*/
|
|
2023
|
-
interval: Duration.Interval;
|
|
2024
|
-
|
|
2025
|
-
/**
|
|
2026
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2027
|
-
*/
|
|
2028
|
-
interval_count: number;
|
|
2029
|
-
}
|
|
2030
|
-
|
|
2031
|
-
namespace Duration {
|
|
2032
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2033
|
-
}
|
|
2034
|
-
|
|
2035
|
-
type Type = 'duration' | 'timestamp';
|
|
2036
|
-
}
|
|
2037
|
-
}
|
|
2038
|
-
|
|
2039
1456
|
interface PriceData {
|
|
2040
1457
|
/**
|
|
2041
1458
|
* 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).
|
|
@@ -2154,33 +1571,16 @@ declare module 'stripe' {
|
|
|
2154
1571
|
PaymentMethodOptions.CustomerBalance
|
|
2155
1572
|
>;
|
|
2156
1573
|
|
|
2157
|
-
/**
|
|
2158
|
-
* This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
2159
|
-
*/
|
|
2160
|
-
id_bank_transfer?: Stripe.Emptyable<
|
|
2161
|
-
PaymentMethodOptions.IdBankTransfer
|
|
2162
|
-
>;
|
|
2163
|
-
|
|
2164
1574
|
/**
|
|
2165
1575
|
* This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
2166
1576
|
*/
|
|
2167
1577
|
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
|
|
2168
1578
|
|
|
2169
|
-
/**
|
|
2170
|
-
* This sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
|
|
2171
|
-
*/
|
|
2172
|
-
pix?: Stripe.Emptyable<PaymentMethodOptions.Pix>;
|
|
2173
|
-
|
|
2174
1579
|
/**
|
|
2175
1580
|
* This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
|
|
2176
1581
|
*/
|
|
2177
1582
|
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
|
|
2178
1583
|
|
|
2179
|
-
/**
|
|
2180
|
-
* This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
|
|
2181
|
-
*/
|
|
2182
|
-
upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
|
|
2183
|
-
|
|
2184
1584
|
/**
|
|
2185
1585
|
* This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
2186
1586
|
*/
|
|
@@ -2320,89 +1720,10 @@ declare module 'stripe' {
|
|
|
2320
1720
|
}
|
|
2321
1721
|
}
|
|
2322
1722
|
|
|
2323
|
-
interface IdBankTransfer {}
|
|
2324
|
-
|
|
2325
1723
|
interface Konbini {}
|
|
2326
1724
|
|
|
2327
|
-
interface Pix {
|
|
2328
|
-
/**
|
|
2329
|
-
* Configuration options for setting up a mandate
|
|
2330
|
-
*/
|
|
2331
|
-
mandate_options?: Pix.MandateOptions;
|
|
2332
|
-
}
|
|
2333
|
-
|
|
2334
|
-
namespace Pix {
|
|
2335
|
-
interface MandateOptions {
|
|
2336
|
-
/**
|
|
2337
|
-
* Amount to be charged for future payments. If not provided, defaults to 40000.
|
|
2338
|
-
*/
|
|
2339
|
-
amount?: number;
|
|
2340
|
-
|
|
2341
|
-
/**
|
|
2342
|
-
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
2343
|
-
*/
|
|
2344
|
-
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
2345
|
-
|
|
2346
|
-
/**
|
|
2347
|
-
* Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled.
|
|
2348
|
-
*/
|
|
2349
|
-
end_date?: string;
|
|
2350
|
-
|
|
2351
|
-
/**
|
|
2352
|
-
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
2353
|
-
*/
|
|
2354
|
-
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
2355
|
-
}
|
|
2356
|
-
|
|
2357
|
-
namespace MandateOptions {
|
|
2358
|
-
type AmountIncludesIof = 'always' | 'never';
|
|
2359
|
-
|
|
2360
|
-
type PaymentSchedule =
|
|
2361
|
-
| 'halfyearly'
|
|
2362
|
-
| 'monthly'
|
|
2363
|
-
| 'quarterly'
|
|
2364
|
-
| 'weekly'
|
|
2365
|
-
| 'yearly';
|
|
2366
|
-
}
|
|
2367
|
-
}
|
|
2368
|
-
|
|
2369
1725
|
interface SepaDebit {}
|
|
2370
1726
|
|
|
2371
|
-
interface Upi {
|
|
2372
|
-
/**
|
|
2373
|
-
* Configuration options for setting up an eMandate
|
|
2374
|
-
*/
|
|
2375
|
-
mandate_options?: Upi.MandateOptions;
|
|
2376
|
-
}
|
|
2377
|
-
|
|
2378
|
-
namespace Upi {
|
|
2379
|
-
interface MandateOptions {
|
|
2380
|
-
/**
|
|
2381
|
-
* Amount to be charged for future payments.
|
|
2382
|
-
*/
|
|
2383
|
-
amount?: number;
|
|
2384
|
-
|
|
2385
|
-
/**
|
|
2386
|
-
* 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.
|
|
2387
|
-
*/
|
|
2388
|
-
amount_type?: MandateOptions.AmountType;
|
|
2389
|
-
|
|
2390
|
-
/**
|
|
2391
|
-
* A description of the mandate or subscription that is meant to be displayed to the customer.
|
|
2392
|
-
*/
|
|
2393
|
-
description?: string;
|
|
2394
|
-
|
|
2395
|
-
/**
|
|
2396
|
-
* 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.
|
|
2397
|
-
*/
|
|
2398
|
-
end_date?: number;
|
|
2399
|
-
}
|
|
2400
|
-
|
|
2401
|
-
namespace MandateOptions {
|
|
2402
|
-
type AmountType = 'fixed' | 'maximum';
|
|
2403
|
-
}
|
|
2404
|
-
}
|
|
2405
|
-
|
|
2406
1727
|
interface UsBankAccount {
|
|
2407
1728
|
/**
|
|
2408
1729
|
* Additional fields for Financial Connections Session creation
|
|
@@ -2439,11 +1760,6 @@ declare module 'stripe' {
|
|
|
2439
1760
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
2440
1761
|
*/
|
|
2441
1762
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
2442
|
-
|
|
2443
|
-
/**
|
|
2444
|
-
* ID of the institution to use to filter for selectable accounts.
|
|
2445
|
-
*/
|
|
2446
|
-
institution?: string;
|
|
2447
1763
|
}
|
|
2448
1764
|
|
|
2449
1765
|
namespace Filters {
|
|
@@ -2456,11 +1772,7 @@ declare module 'stripe' {
|
|
|
2456
1772
|
| 'payment_method'
|
|
2457
1773
|
| 'transactions';
|
|
2458
1774
|
|
|
2459
|
-
type Prefetch =
|
|
2460
|
-
| 'balances'
|
|
2461
|
-
| 'inferred_balances'
|
|
2462
|
-
| 'ownership'
|
|
2463
|
-
| 'transactions';
|
|
1775
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
2464
1776
|
}
|
|
2465
1777
|
|
|
2466
1778
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
@@ -2486,7 +1798,6 @@ declare module 'stripe' {
|
|
|
2486
1798
|
| 'fpx'
|
|
2487
1799
|
| 'giropay'
|
|
2488
1800
|
| 'grabpay'
|
|
2489
|
-
| 'id_bank_transfer'
|
|
2490
1801
|
| 'ideal'
|
|
2491
1802
|
| 'jp_credit_transfer'
|
|
2492
1803
|
| 'kakao_pay'
|
|
@@ -2501,15 +1812,12 @@ declare module 'stripe' {
|
|
|
2501
1812
|
| 'payco'
|
|
2502
1813
|
| 'paynow'
|
|
2503
1814
|
| 'paypal'
|
|
2504
|
-
| 'pix'
|
|
2505
1815
|
| 'promptpay'
|
|
2506
1816
|
| 'revolut_pay'
|
|
2507
1817
|
| 'sepa_credit_transfer'
|
|
2508
1818
|
| 'sepa_debit'
|
|
2509
1819
|
| 'sofort'
|
|
2510
|
-
| 'stripe_balance'
|
|
2511
1820
|
| 'swish'
|
|
2512
|
-
| 'upi'
|
|
2513
1821
|
| 'us_bank_account'
|
|
2514
1822
|
| 'wechat_pay';
|
|
2515
1823
|
|
|
@@ -2532,22 +1840,6 @@ declare module 'stripe' {
|
|
|
2532
1840
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2533
1841
|
}
|
|
2534
1842
|
|
|
2535
|
-
interface Prebilling {
|
|
2536
|
-
/**
|
|
2537
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
2538
|
-
*/
|
|
2539
|
-
iterations: number;
|
|
2540
|
-
|
|
2541
|
-
/**
|
|
2542
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
2543
|
-
*/
|
|
2544
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
2545
|
-
}
|
|
2546
|
-
|
|
2547
|
-
namespace Prebilling {
|
|
2548
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
2549
|
-
}
|
|
2550
|
-
|
|
2551
1843
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2552
1844
|
|
|
2553
1845
|
interface TransferData {
|
|
@@ -2614,11 +1906,6 @@ declare module 'stripe' {
|
|
|
2614
1906
|
*/
|
|
2615
1907
|
customer?: string;
|
|
2616
1908
|
|
|
2617
|
-
/**
|
|
2618
|
-
* The ID of the account whose subscriptions will be retrieved.
|
|
2619
|
-
*/
|
|
2620
|
-
customer_account?: string;
|
|
2621
|
-
|
|
2622
1909
|
/**
|
|
2623
1910
|
* Specifies which fields in the response should be expanded.
|
|
2624
1911
|
*/
|
|
@@ -2668,18 +1955,6 @@ declare module 'stripe' {
|
|
|
2668
1955
|
| 'unpaid';
|
|
2669
1956
|
}
|
|
2670
1957
|
|
|
2671
|
-
interface SubscriptionAttachCadenceParams {
|
|
2672
|
-
/**
|
|
2673
|
-
* The Billing Cadence which controls the timing of recurring invoice generation for this subscription. If unset, the subscription will bill according to its own configured schedule and create its own invoices. If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
|
|
2674
|
-
*/
|
|
2675
|
-
billing_cadence: string;
|
|
2676
|
-
|
|
2677
|
-
/**
|
|
2678
|
-
* Specifies which fields in the response should be expanded.
|
|
2679
|
-
*/
|
|
2680
|
-
expand?: Array<string>;
|
|
2681
|
-
}
|
|
2682
|
-
|
|
2683
1958
|
interface SubscriptionCancelParams {
|
|
2684
1959
|
/**
|
|
2685
1960
|
* Details about why this subscription was cancelled
|
|
@@ -2830,10 +2105,7 @@ declare module 'stripe' {
|
|
|
2830
2105
|
* Schedules provide the flexibility to model more complex billing configurations that change over time.
|
|
2831
2106
|
*/
|
|
2832
2107
|
create(
|
|
2833
|
-
params
|
|
2834
|
-
options?: RequestOptions
|
|
2835
|
-
): Promise<Stripe.Response<Stripe.Subscription>>;
|
|
2836
|
-
create(
|
|
2108
|
+
params: SubscriptionCreateParams,
|
|
2837
2109
|
options?: RequestOptions
|
|
2838
2110
|
): Promise<Stripe.Response<Stripe.Subscription>>;
|
|
2839
2111
|
|
|
@@ -2888,15 +2160,6 @@ declare module 'stripe' {
|
|
|
2888
2160
|
): ApiListPromise<Stripe.Subscription>;
|
|
2889
2161
|
list(options?: RequestOptions): ApiListPromise<Stripe.Subscription>;
|
|
2890
2162
|
|
|
2891
|
-
/**
|
|
2892
|
-
* Attach a Billing Cadence to an existing subscription. When attached, the subscription is billed by the Billing Cadence, potentially sharing invoices with the other subscriptions linked to the Billing Cadence.
|
|
2893
|
-
*/
|
|
2894
|
-
attachCadence(
|
|
2895
|
-
id: string,
|
|
2896
|
-
params: SubscriptionAttachCadenceParams,
|
|
2897
|
-
options?: RequestOptions
|
|
2898
|
-
): Promise<Stripe.Response<Stripe.Subscription>>;
|
|
2899
|
-
|
|
2900
2163
|
/**
|
|
2901
2164
|
* Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
|
|
2902
2165
|
*
|