stripe 19.2.0 → 19.3.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1471 -12
- package/README.md +1 -0
- package/VERSION +1 -1
- package/cjs/Error.js +115 -1
- package/cjs/apiVersion.js +2 -3
- package/cjs/resources/AccountNotices.js +21 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js +12 -0
- package/cjs/resources/Capital/FinancingOffers.js +21 -0
- package/cjs/resources/Capital/FinancingSummary.js +12 -0
- package/cjs/resources/Capital/FinancingTransactions.js +17 -0
- package/cjs/resources/ExternalAccounts.js +23 -0
- package/cjs/resources/FinancialConnections/Accounts.js +5 -0
- package/cjs/resources/FinancialConnections/Institutions.js +17 -0
- package/cjs/resources/FxQuotes.js +15 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
- package/cjs/resources/Mandates.js +5 -0
- package/cjs/resources/Margins.js +22 -0
- package/cjs/resources/Orders.js +24 -0
- package/cjs/resources/PaymentIntents.js +8 -0
- package/cjs/resources/Privacy/RedactionJobs.js +42 -0
- package/cjs/resources/Quotes.js +32 -0
- package/cjs/resources/SubscriptionSchedules.js +4 -0
- package/cjs/resources/Subscriptions.js +4 -0
- package/cjs/resources/Tax/Associations.js +9 -0
- package/cjs/resources/Tax/Forms.js +20 -0
- package/cjs/resources/Terminal/OnboardingLinks.js +12 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +17 -0
- package/cjs/resources/V2/Billing/BillSettings.js +27 -0
- package/cjs/resources/V2/Billing/Cadences.js +23 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +17 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js +30 -0
- package/cjs/resources/V2/Billing/Profiles.js +19 -0
- package/cjs/resources/V2/Core/AccountLinks.js +9 -0
- package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
- package/cjs/resources/V2/Core/Accounts.js +25 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +33 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +37 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +29 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +16 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js +29 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
- package/cjs/resources.js +106 -8
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +100 -0
- package/esm/apiVersion.js +1 -2
- package/esm/resources/AccountNotices.js +18 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js +9 -0
- package/esm/resources/Capital/FinancingOffers.js +18 -0
- package/esm/resources/Capital/FinancingSummary.js +9 -0
- package/esm/resources/Capital/FinancingTransactions.js +14 -0
- package/esm/resources/ExternalAccounts.js +20 -0
- package/esm/resources/FinancialConnections/Accounts.js +5 -0
- package/esm/resources/FinancialConnections/Institutions.js +14 -0
- package/esm/resources/FxQuotes.js +12 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
- package/esm/resources/Mandates.js +5 -0
- package/esm/resources/Margins.js +19 -0
- package/esm/resources/Orders.js +21 -0
- package/esm/resources/PaymentIntents.js +8 -0
- package/esm/resources/Privacy/RedactionJobs.js +39 -0
- package/esm/resources/Quotes.js +32 -0
- package/esm/resources/SubscriptionSchedules.js +4 -0
- package/esm/resources/Subscriptions.js +4 -0
- package/esm/resources/Tax/Associations.js +6 -0
- package/esm/resources/Tax/Forms.js +17 -0
- package/esm/resources/Terminal/OnboardingLinks.js +9 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js +14 -0
- package/esm/resources/V2/Billing/BillSettings.js +24 -0
- package/esm/resources/V2/Billing/Cadences.js +20 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +14 -0
- package/esm/resources/V2/Billing/CollectionSettings.js +27 -0
- package/esm/resources/V2/Billing/Profiles.js +16 -0
- package/esm/resources/V2/Core/AccountLinks.js +6 -0
- package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
- package/esm/resources/V2/Core/Accounts.js +22 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +30 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +34 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +26 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +13 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js +26 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
- package/esm/resources.js +93 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +5 -1
- package/types/AccountNotices.d.ts +113 -0
- package/types/AccountNoticesResource.d.ts +98 -0
- package/types/AccountSessions.d.ts +45 -0
- package/types/AccountSessionsResource.d.ts +264 -0
- package/types/Accounts.d.ts +214 -1
- package/types/AccountsResource.d.ts +544 -0
- package/types/BankAccounts.d.ts +2 -0
- package/types/Billing/AlertTriggereds.d.ts +1 -1
- package/types/Billing/Analytics/MeterUsage.d.ts +31 -0
- package/types/Billing/Analytics/MeterUsageResource.d.ts +689 -0
- package/types/Billing/Analytics/MeterUsageRows.d.ts +51 -0
- package/types/Billing/CreditBalanceSummary.d.ts +5 -0
- package/types/Billing/CreditBalanceSummaryResource.d.ts +8 -3
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +12 -4
- package/types/Billing/CreditGrants.d.ts +5 -0
- package/types/Billing/CreditGrantsResource.d.ts +13 -3
- package/types/BillingPortal/Sessions.d.ts +5 -0
- package/types/BillingPortal/SessionsResource.d.ts +12 -4
- package/types/Capabilities.d.ts +2 -0
- package/types/Capital/FinancingOffers.d.ts +188 -0
- package/types/Capital/FinancingOffersResource.d.ts +97 -0
- package/types/Capital/FinancingSummary.d.ts +106 -0
- package/types/Capital/FinancingSummaryResource.d.ts +27 -0
- package/types/Capital/FinancingTransactions.d.ts +135 -0
- package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
- package/types/Cards.d.ts +5 -0
- package/types/CashBalances.d.ts +5 -0
- package/types/Charges.d.ts +176 -0
- package/types/ChargesResource.d.ts +1418 -0
- package/types/Checkout/Sessions.d.ts +369 -2
- package/types/Checkout/SessionsResource.d.ts +632 -2
- package/types/ConfirmationTokens.d.ts +125 -0
- package/types/Coupons.d.ts +33 -0
- package/types/CouponsResource.d.ts +21 -0
- package/types/CreditNoteLineItems.d.ts +17 -0
- package/types/CreditNotes.d.ts +5 -0
- package/types/CreditNotesResource.d.ts +5 -0
- package/types/CustomerBalanceTransactions.d.ts +2 -0
- package/types/CustomerCashBalanceTransactions.d.ts +2 -0
- package/types/CustomerSessions.d.ts +46 -0
- package/types/CustomerSessionsResource.d.ts +47 -1
- package/types/Customers.d.ts +2 -0
- package/types/CustomersResource.d.ts +8 -0
- package/types/Discounts.d.ts +10 -0
- package/types/Disputes.d.ts +40 -0
- package/types/DisputesResource.d.ts +11 -0
- package/types/Errors.d.ts +85 -0
- package/types/EventTypes.d.ts +630 -0
- package/types/Events.d.ts +95 -0
- package/types/ExternalAccountsResource.d.ts +304 -0
- package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
- package/types/FinancialConnections/Accounts.d.ts +36 -1
- package/types/FinancialConnections/AccountsResource.d.ts +40 -3
- package/types/FinancialConnections/Institutions.d.ts +98 -0
- package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
- package/types/FinancialConnections/Sessions.d.ts +51 -1
- package/types/FinancialConnections/SessionsResource.d.ts +43 -1
- package/types/FxQuotes.d.ts +155 -0
- package/types/FxQuotesResource.d.ts +130 -0
- package/types/Identity/VerificationSessions.d.ts +5 -0
- package/types/Identity/VerificationSessionsResource.d.ts +7 -0
- package/types/InvoiceItems.d.ts +10 -0
- package/types/InvoiceItemsResource.d.ts +117 -6
- package/types/InvoiceLineItems.d.ts +45 -1
- package/types/Invoices.d.ts +203 -4
- package/types/InvoicesResource.d.ts +1620 -2
- package/types/Issuing/CardholdersResource.d.ts +2 -1
- package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
- package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
- package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
- package/types/Issuing/Settlements.d.ts +113 -0
- package/types/Issuing/Transactions.d.ts +5 -0
- package/types/Issuing/TransactionsResource.d.ts +5 -0
- package/types/LineItems.d.ts +49 -0
- package/types/Mandates.d.ts +135 -1
- package/types/MandatesResource.d.ts +31 -0
- package/types/Margins.d.ts +56 -0
- package/types/MarginsResource.d.ts +114 -0
- package/types/Orders.d.ts +1163 -0
- package/types/OrdersResource.d.ts +3139 -0
- package/types/PaymentAttemptRecords.d.ts +141 -0
- package/types/PaymentIntents.d.ts +773 -3
- package/types/PaymentIntentsResource.d.ts +9628 -4805
- package/types/PaymentLinks.d.ts +6 -0
- package/types/PaymentLinksResource.d.ts +12 -0
- package/types/PaymentMethodConfigurations.d.ts +216 -0
- package/types/PaymentMethodConfigurationsResource.d.ts +300 -0
- package/types/PaymentMethods.d.ts +130 -0
- package/types/PaymentMethodsResource.d.ts +167 -2
- package/types/PaymentRecords.d.ts +141 -0
- package/types/Persons.d.ts +2 -0
- package/types/Prices.d.ts +22 -0
- package/types/PricesResource.d.ts +22 -0
- package/types/Privacy/RedactionJobValidationErrors.d.ts +60 -0
- package/types/Privacy/RedactionJobs.d.ts +111 -0
- package/types/Privacy/RedactionJobsResource.d.ts +230 -0
- package/types/PromotionCodes.d.ts +5 -0
- package/types/PromotionCodesResource.d.ts +10 -0
- package/types/QuoteLines.d.ts +634 -0
- package/types/QuotePreviewInvoices.d.ts +1771 -0
- package/types/QuotePreviewSubscriptionSchedules.d.ts +908 -0
- package/types/Quotes.d.ts +594 -1
- package/types/QuotesResource.d.ts +2588 -243
- package/types/Refunds.d.ts +14 -0
- package/types/SetupAttempts.d.ts +51 -1
- package/types/SetupIntents.d.ts +218 -2
- package/types/SetupIntentsResource.d.ts +954 -4
- package/types/Sources.d.ts +29 -0
- package/types/SubscriptionItems.d.ts +26 -0
- package/types/SubscriptionItemsResource.d.ts +109 -0
- package/types/SubscriptionSchedules.d.ts +205 -0
- package/types/SubscriptionSchedulesResource.d.ts +1233 -5
- package/types/Subscriptions.d.ts +262 -1
- package/types/SubscriptionsResource.d.ts +745 -8
- package/types/Tax/Associations.d.ts +82 -0
- package/types/Tax/AssociationsResource.d.ts +29 -0
- package/types/Tax/Forms.d.ts +220 -0
- package/types/Tax/FormsResource.d.ts +107 -0
- package/types/TaxIds.d.ts +10 -0
- package/types/TaxIdsResource.d.ts +10 -0
- package/types/Terminal/Configurations.d.ts +9 -0
- package/types/Terminal/ConfigurationsResource.d.ts +28 -0
- package/types/Terminal/OnboardingLinks.d.ts +57 -0
- package/types/Terminal/OnboardingLinksResource.d.ts +62 -0
- package/types/Terminal/ReaderCollectedData.d.ts +51 -0
- package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
- package/types/Terminal/Readers.d.ts +20 -0
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +126 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
- package/types/Transfers.d.ts +5 -0
- package/types/TransfersResource.d.ts +5 -0
- package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
- package/types/Treasury/FinancialAccounts.d.ts +5 -0
- package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
- package/types/Treasury/OutboundTransfers.d.ts +26 -0
- package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
- package/types/Treasury/ReceivedCredits.d.ts +26 -0
- package/types/Treasury/ReceivedDebits.d.ts +31 -0
- package/types/V2/Billing/BillSettingVersions.d.ts +97 -0
- package/types/V2/Billing/BillSettings/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/BillSettings.d.ts +120 -0
- package/types/V2/Billing/BillSettingsResource.d.ts +241 -0
- package/types/V2/Billing/Cadences.d.ts +686 -0
- package/types/V2/Billing/CadencesResource.d.ts +487 -0
- package/types/V2/Billing/CollectionSettingVersions.d.ts +314 -0
- package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
- package/types/V2/Billing/CollectionSettings.d.ts +337 -0
- package/types/V2/Billing/CollectionSettingsResource.d.ts +675 -0
- package/types/V2/Billing/Profiles.d.ts +70 -0
- package/types/V2/Billing/ProfilesResource.d.ts +150 -0
- package/types/V2/Core/AccountLinks.d.ts +168 -0
- package/types/V2/Core/AccountLinksResource.d.ts +152 -0
- package/types/V2/Core/AccountPersons.d.ts +615 -0
- package/types/V2/Core/Accounts/PersonsResource.d.ts +1153 -0
- package/types/V2/Core/Accounts.d.ts +6010 -0
- package/types/V2/Core/AccountsResource.d.ts +5104 -0
- package/types/V2/Core/EventTypes.d.ts +1623 -9
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
- package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +194 -0
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +116 -0
- package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +198 -0
- package/types/V2/FinancialAddressCreditSimulations.d.ts +27 -0
- package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +32 -0
- package/types/V2/MoneyManagement/Adjustments.d.ts +110 -0
- package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +148 -0
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +172 -0
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +178 -0
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +112 -0
- package/types/V2/MoneyManagement/InboundTransfers.d.ts +206 -0
- package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +144 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +170 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +115 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +278 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +242 -0
- package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +296 -0
- package/types/V2/MoneyManagement/OutboundTransfers.d.ts +251 -0
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +208 -0
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +160 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +93 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +302 -0
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +176 -0
- package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
- package/types/V2/MoneyManagement/TransactionEntries.d.ts +162 -0
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
- package/types/V2/MoneyManagement/Transactions.d.ts +177 -0
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
- package/types/V2/Payments/OffSessionPayments.d.ts +326 -0
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +401 -0
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +68 -0
- package/types/WebhookEndpointsResource.d.ts +74 -0
- package/types/apiVersion.d.ts +1 -2
- package/types/index.d.ts +153 -0
- package/types/lib.d.ts +10 -0
|
@@ -3,11 +3,6 @@
|
|
|
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
|
-
|
|
11
6
|
/**
|
|
12
7
|
* 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.
|
|
13
8
|
*/
|
|
@@ -28,6 +23,11 @@ declare module 'stripe' {
|
|
|
28
23
|
*/
|
|
29
24
|
backdate_start_date?: number;
|
|
30
25
|
|
|
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,6 +43,11 @@ 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
|
+
|
|
46
51
|
/**
|
|
47
52
|
* 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.
|
|
48
53
|
*/
|
|
@@ -70,6 +75,16 @@ declare module 'stripe' {
|
|
|
70
75
|
*/
|
|
71
76
|
currency?: string;
|
|
72
77
|
|
|
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
|
+
|
|
73
88
|
/**
|
|
74
89
|
* 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`.
|
|
75
90
|
*/
|
|
@@ -157,6 +172,11 @@ declare module 'stripe' {
|
|
|
157
172
|
SubscriptionCreateParams.PendingInvoiceItemInterval
|
|
158
173
|
>;
|
|
159
174
|
|
|
175
|
+
/**
|
|
176
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
177
|
+
*/
|
|
178
|
+
prebilling?: SubscriptionCreateParams.Prebilling;
|
|
179
|
+
|
|
160
180
|
/**
|
|
161
181
|
* 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`.
|
|
162
182
|
*/
|
|
@@ -238,12 +258,56 @@ declare module 'stripe' {
|
|
|
238
258
|
*/
|
|
239
259
|
discount?: string;
|
|
240
260
|
|
|
261
|
+
/**
|
|
262
|
+
* Details to determine how long the discount should be applied for.
|
|
263
|
+
*/
|
|
264
|
+
discount_end?: Discount.DiscountEnd;
|
|
265
|
+
|
|
241
266
|
/**
|
|
242
267
|
* ID of the promotion code to create a new discount for.
|
|
243
268
|
*/
|
|
244
269
|
promotion_code?: string;
|
|
245
270
|
}
|
|
246
271
|
|
|
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
|
+
|
|
247
311
|
interface Period {
|
|
248
312
|
/**
|
|
249
313
|
* End of the invoice item period.
|
|
@@ -406,6 +470,74 @@ declare module 'stripe' {
|
|
|
406
470
|
type Type = 'classic' | 'flexible';
|
|
407
471
|
}
|
|
408
472
|
|
|
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
|
+
|
|
409
541
|
interface BillingThresholds {
|
|
410
542
|
/**
|
|
411
543
|
* Monetary threshold that triggers the subscription to advance to a new billing period
|
|
@@ -433,12 +565,56 @@ declare module 'stripe' {
|
|
|
433
565
|
*/
|
|
434
566
|
discount?: string;
|
|
435
567
|
|
|
568
|
+
/**
|
|
569
|
+
* Details to determine how long the discount should be applied for.
|
|
570
|
+
*/
|
|
571
|
+
discount_end?: Discount.DiscountEnd;
|
|
572
|
+
|
|
436
573
|
/**
|
|
437
574
|
* ID of the promotion code to create a new discount for.
|
|
438
575
|
*/
|
|
439
576
|
promotion_code?: string;
|
|
440
577
|
}
|
|
441
578
|
|
|
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
|
+
|
|
442
618
|
interface InvoiceSettings {
|
|
443
619
|
/**
|
|
444
620
|
* The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
|
|
@@ -509,6 +685,11 @@ declare module 'stripe' {
|
|
|
509
685
|
* 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.
|
|
510
686
|
*/
|
|
511
687
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
688
|
+
|
|
689
|
+
/**
|
|
690
|
+
* Define options to configure the trial on the subscription item.
|
|
691
|
+
*/
|
|
692
|
+
trial?: Item.Trial;
|
|
512
693
|
}
|
|
513
694
|
|
|
514
695
|
namespace Item {
|
|
@@ -530,12 +711,56 @@ declare module 'stripe' {
|
|
|
530
711
|
*/
|
|
531
712
|
discount?: string;
|
|
532
713
|
|
|
714
|
+
/**
|
|
715
|
+
* Details to determine how long the discount should be applied for.
|
|
716
|
+
*/
|
|
717
|
+
discount_end?: Discount.DiscountEnd;
|
|
718
|
+
|
|
533
719
|
/**
|
|
534
720
|
* ID of the promotion code to create a new discount for.
|
|
535
721
|
*/
|
|
536
722
|
promotion_code?: string;
|
|
537
723
|
}
|
|
538
724
|
|
|
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
|
+
|
|
539
764
|
interface PriceData {
|
|
540
765
|
/**
|
|
541
766
|
* 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).
|
|
@@ -587,6 +812,22 @@ declare module 'stripe' {
|
|
|
587
812
|
|
|
588
813
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
589
814
|
}
|
|
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
|
+
}
|
|
590
831
|
}
|
|
591
832
|
|
|
592
833
|
type PaymentBehavior =
|
|
@@ -638,16 +879,33 @@ declare module 'stripe' {
|
|
|
638
879
|
PaymentMethodOptions.CustomerBalance
|
|
639
880
|
>;
|
|
640
881
|
|
|
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
|
+
|
|
641
889
|
/**
|
|
642
890
|
* This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
643
891
|
*/
|
|
644
892
|
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
|
|
645
893
|
|
|
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
|
+
|
|
646
899
|
/**
|
|
647
900
|
* This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
|
|
648
901
|
*/
|
|
649
902
|
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
|
|
650
903
|
|
|
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
|
+
|
|
651
909
|
/**
|
|
652
910
|
* This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
653
911
|
*/
|
|
@@ -787,10 +1045,89 @@ declare module 'stripe' {
|
|
|
787
1045
|
}
|
|
788
1046
|
}
|
|
789
1047
|
|
|
1048
|
+
interface IdBankTransfer {}
|
|
1049
|
+
|
|
790
1050
|
interface Konbini {}
|
|
791
1051
|
|
|
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
|
+
|
|
792
1094
|
interface SepaDebit {}
|
|
793
1095
|
|
|
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
|
+
|
|
794
1131
|
interface UsBankAccount {
|
|
795
1132
|
/**
|
|
796
1133
|
* Additional fields for Financial Connections Session creation
|
|
@@ -827,6 +1164,11 @@ declare module 'stripe' {
|
|
|
827
1164
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
828
1165
|
*/
|
|
829
1166
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1167
|
+
|
|
1168
|
+
/**
|
|
1169
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
1170
|
+
*/
|
|
1171
|
+
institution?: string;
|
|
830
1172
|
}
|
|
831
1173
|
|
|
832
1174
|
namespace Filters {
|
|
@@ -839,7 +1181,11 @@ declare module 'stripe' {
|
|
|
839
1181
|
| 'payment_method'
|
|
840
1182
|
| 'transactions';
|
|
841
1183
|
|
|
842
|
-
type Prefetch =
|
|
1184
|
+
type Prefetch =
|
|
1185
|
+
| 'balances'
|
|
1186
|
+
| 'inferred_balances'
|
|
1187
|
+
| 'ownership'
|
|
1188
|
+
| 'transactions';
|
|
843
1189
|
}
|
|
844
1190
|
|
|
845
1191
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
@@ -865,6 +1211,7 @@ declare module 'stripe' {
|
|
|
865
1211
|
| 'fpx'
|
|
866
1212
|
| 'giropay'
|
|
867
1213
|
| 'grabpay'
|
|
1214
|
+
| 'id_bank_transfer'
|
|
868
1215
|
| 'ideal'
|
|
869
1216
|
| 'jp_credit_transfer'
|
|
870
1217
|
| 'kakao_pay'
|
|
@@ -879,12 +1226,15 @@ declare module 'stripe' {
|
|
|
879
1226
|
| 'payco'
|
|
880
1227
|
| 'paynow'
|
|
881
1228
|
| 'paypal'
|
|
1229
|
+
| 'pix'
|
|
882
1230
|
| 'promptpay'
|
|
883
1231
|
| 'revolut_pay'
|
|
884
1232
|
| 'sepa_credit_transfer'
|
|
885
1233
|
| 'sepa_debit'
|
|
886
1234
|
| 'sofort'
|
|
1235
|
+
| 'stripe_balance'
|
|
887
1236
|
| 'swish'
|
|
1237
|
+
| 'upi'
|
|
888
1238
|
| 'us_bank_account'
|
|
889
1239
|
| 'wechat_pay';
|
|
890
1240
|
|
|
@@ -907,6 +1257,22 @@ declare module 'stripe' {
|
|
|
907
1257
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
908
1258
|
}
|
|
909
1259
|
|
|
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
|
+
|
|
910
1276
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
911
1277
|
|
|
912
1278
|
interface TransferData {
|
|
@@ -965,11 +1331,23 @@ declare module 'stripe' {
|
|
|
965
1331
|
*/
|
|
966
1332
|
automatic_tax?: SubscriptionUpdateParams.AutomaticTax;
|
|
967
1333
|
|
|
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
|
+
|
|
968
1339
|
/**
|
|
969
1340
|
* 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).
|
|
970
1341
|
*/
|
|
971
1342
|
billing_cycle_anchor?: SubscriptionUpdateParams.BillingCycleAnchor;
|
|
972
1343
|
|
|
1344
|
+
/**
|
|
1345
|
+
* Sets the billing schedules for the subscription.
|
|
1346
|
+
*/
|
|
1347
|
+
billing_schedules?: Stripe.Emptyable<
|
|
1348
|
+
Array<SubscriptionUpdateParams.BillingSchedule>
|
|
1349
|
+
>;
|
|
1350
|
+
|
|
973
1351
|
/**
|
|
974
1352
|
* 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.
|
|
975
1353
|
*/
|
|
@@ -1087,6 +1465,11 @@ declare module 'stripe' {
|
|
|
1087
1465
|
SubscriptionUpdateParams.PendingInvoiceItemInterval
|
|
1088
1466
|
>;
|
|
1089
1467
|
|
|
1468
|
+
/**
|
|
1469
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
1470
|
+
*/
|
|
1471
|
+
prebilling?: SubscriptionUpdateParams.Prebilling;
|
|
1472
|
+
|
|
1090
1473
|
/**
|
|
1091
1474
|
* 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`.
|
|
1092
1475
|
*/
|
|
@@ -1168,12 +1551,56 @@ declare module 'stripe' {
|
|
|
1168
1551
|
*/
|
|
1169
1552
|
discount?: string;
|
|
1170
1553
|
|
|
1554
|
+
/**
|
|
1555
|
+
* Details to determine how long the discount should be applied for.
|
|
1556
|
+
*/
|
|
1557
|
+
discount_end?: Discount.DiscountEnd;
|
|
1558
|
+
|
|
1171
1559
|
/**
|
|
1172
1560
|
* ID of the promotion code to create a new discount for.
|
|
1173
1561
|
*/
|
|
1174
1562
|
promotion_code?: string;
|
|
1175
1563
|
}
|
|
1176
1564
|
|
|
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
|
+
|
|
1177
1604
|
interface Period {
|
|
1178
1605
|
/**
|
|
1179
1606
|
* End of the invoice item period.
|
|
@@ -1284,6 +1711,74 @@ declare module 'stripe' {
|
|
|
1284
1711
|
|
|
1285
1712
|
type BillingCycleAnchor = 'now' | 'unchanged';
|
|
1286
1713
|
|
|
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
|
+
|
|
1287
1782
|
interface BillingThresholds {
|
|
1288
1783
|
/**
|
|
1289
1784
|
* Monetary threshold that triggers the subscription to advance to a new billing period
|
|
@@ -1335,12 +1830,56 @@ declare module 'stripe' {
|
|
|
1335
1830
|
*/
|
|
1336
1831
|
discount?: string;
|
|
1337
1832
|
|
|
1833
|
+
/**
|
|
1834
|
+
* Details to determine how long the discount should be applied for.
|
|
1835
|
+
*/
|
|
1836
|
+
discount_end?: Discount.DiscountEnd;
|
|
1837
|
+
|
|
1338
1838
|
/**
|
|
1339
1839
|
* ID of the promotion code to create a new discount for.
|
|
1340
1840
|
*/
|
|
1341
1841
|
promotion_code?: string;
|
|
1342
1842
|
}
|
|
1343
1843
|
|
|
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
|
+
|
|
1344
1883
|
interface InvoiceSettings {
|
|
1345
1884
|
/**
|
|
1346
1885
|
* The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
|
|
@@ -1447,12 +1986,56 @@ declare module 'stripe' {
|
|
|
1447
1986
|
*/
|
|
1448
1987
|
discount?: string;
|
|
1449
1988
|
|
|
1989
|
+
/**
|
|
1990
|
+
* Details to determine how long the discount should be applied for.
|
|
1991
|
+
*/
|
|
1992
|
+
discount_end?: Discount.DiscountEnd;
|
|
1993
|
+
|
|
1450
1994
|
/**
|
|
1451
1995
|
* ID of the promotion code to create a new discount for.
|
|
1452
1996
|
*/
|
|
1453
1997
|
promotion_code?: string;
|
|
1454
1998
|
}
|
|
1455
1999
|
|
|
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
|
+
|
|
1456
2039
|
interface PriceData {
|
|
1457
2040
|
/**
|
|
1458
2041
|
* 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).
|
|
@@ -1571,16 +2154,33 @@ declare module 'stripe' {
|
|
|
1571
2154
|
PaymentMethodOptions.CustomerBalance
|
|
1572
2155
|
>;
|
|
1573
2156
|
|
|
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
|
+
|
|
1574
2164
|
/**
|
|
1575
2165
|
* This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
1576
2166
|
*/
|
|
1577
2167
|
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
|
|
1578
2168
|
|
|
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
|
+
|
|
1579
2174
|
/**
|
|
1580
2175
|
* This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
|
|
1581
2176
|
*/
|
|
1582
2177
|
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
|
|
1583
2178
|
|
|
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
|
+
|
|
1584
2184
|
/**
|
|
1585
2185
|
* This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
1586
2186
|
*/
|
|
@@ -1720,10 +2320,89 @@ declare module 'stripe' {
|
|
|
1720
2320
|
}
|
|
1721
2321
|
}
|
|
1722
2322
|
|
|
2323
|
+
interface IdBankTransfer {}
|
|
2324
|
+
|
|
1723
2325
|
interface Konbini {}
|
|
1724
2326
|
|
|
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
|
+
|
|
1725
2369
|
interface SepaDebit {}
|
|
1726
2370
|
|
|
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
|
+
|
|
1727
2406
|
interface UsBankAccount {
|
|
1728
2407
|
/**
|
|
1729
2408
|
* Additional fields for Financial Connections Session creation
|
|
@@ -1760,6 +2439,11 @@ declare module 'stripe' {
|
|
|
1760
2439
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1761
2440
|
*/
|
|
1762
2441
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
2442
|
+
|
|
2443
|
+
/**
|
|
2444
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
2445
|
+
*/
|
|
2446
|
+
institution?: string;
|
|
1763
2447
|
}
|
|
1764
2448
|
|
|
1765
2449
|
namespace Filters {
|
|
@@ -1772,7 +2456,11 @@ declare module 'stripe' {
|
|
|
1772
2456
|
| 'payment_method'
|
|
1773
2457
|
| 'transactions';
|
|
1774
2458
|
|
|
1775
|
-
type Prefetch =
|
|
2459
|
+
type Prefetch =
|
|
2460
|
+
| 'balances'
|
|
2461
|
+
| 'inferred_balances'
|
|
2462
|
+
| 'ownership'
|
|
2463
|
+
| 'transactions';
|
|
1776
2464
|
}
|
|
1777
2465
|
|
|
1778
2466
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
@@ -1798,6 +2486,7 @@ declare module 'stripe' {
|
|
|
1798
2486
|
| 'fpx'
|
|
1799
2487
|
| 'giropay'
|
|
1800
2488
|
| 'grabpay'
|
|
2489
|
+
| 'id_bank_transfer'
|
|
1801
2490
|
| 'ideal'
|
|
1802
2491
|
| 'jp_credit_transfer'
|
|
1803
2492
|
| 'kakao_pay'
|
|
@@ -1812,12 +2501,15 @@ declare module 'stripe' {
|
|
|
1812
2501
|
| 'payco'
|
|
1813
2502
|
| 'paynow'
|
|
1814
2503
|
| 'paypal'
|
|
2504
|
+
| 'pix'
|
|
1815
2505
|
| 'promptpay'
|
|
1816
2506
|
| 'revolut_pay'
|
|
1817
2507
|
| 'sepa_credit_transfer'
|
|
1818
2508
|
| 'sepa_debit'
|
|
1819
2509
|
| 'sofort'
|
|
2510
|
+
| 'stripe_balance'
|
|
1820
2511
|
| 'swish'
|
|
2512
|
+
| 'upi'
|
|
1821
2513
|
| 'us_bank_account'
|
|
1822
2514
|
| 'wechat_pay';
|
|
1823
2515
|
|
|
@@ -1840,6 +2532,22 @@ declare module 'stripe' {
|
|
|
1840
2532
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1841
2533
|
}
|
|
1842
2534
|
|
|
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
|
+
|
|
1843
2551
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1844
2552
|
|
|
1845
2553
|
interface TransferData {
|
|
@@ -1906,6 +2614,11 @@ declare module 'stripe' {
|
|
|
1906
2614
|
*/
|
|
1907
2615
|
customer?: string;
|
|
1908
2616
|
|
|
2617
|
+
/**
|
|
2618
|
+
* The ID of the account whose subscriptions will be retrieved.
|
|
2619
|
+
*/
|
|
2620
|
+
customer_account?: string;
|
|
2621
|
+
|
|
1909
2622
|
/**
|
|
1910
2623
|
* Specifies which fields in the response should be expanded.
|
|
1911
2624
|
*/
|
|
@@ -1955,6 +2668,18 @@ declare module 'stripe' {
|
|
|
1955
2668
|
| 'unpaid';
|
|
1956
2669
|
}
|
|
1957
2670
|
|
|
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
|
+
|
|
1958
2683
|
interface SubscriptionCancelParams {
|
|
1959
2684
|
/**
|
|
1960
2685
|
* Details about why this subscription was cancelled
|
|
@@ -2105,7 +2830,10 @@ declare module 'stripe' {
|
|
|
2105
2830
|
* Schedules provide the flexibility to model more complex billing configurations that change over time.
|
|
2106
2831
|
*/
|
|
2107
2832
|
create(
|
|
2108
|
-
params
|
|
2833
|
+
params?: SubscriptionCreateParams,
|
|
2834
|
+
options?: RequestOptions
|
|
2835
|
+
): Promise<Stripe.Response<Stripe.Subscription>>;
|
|
2836
|
+
create(
|
|
2109
2837
|
options?: RequestOptions
|
|
2110
2838
|
): Promise<Stripe.Response<Stripe.Subscription>>;
|
|
2111
2839
|
|
|
@@ -2160,6 +2888,15 @@ declare module 'stripe' {
|
|
|
2160
2888
|
): ApiListPromise<Stripe.Subscription>;
|
|
2161
2889
|
list(options?: RequestOptions): ApiListPromise<Stripe.Subscription>;
|
|
2162
2890
|
|
|
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
|
+
|
|
2163
2900
|
/**
|
|
2164
2901
|
* 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).
|
|
2165
2902
|
*
|