stripe 20.1.0-alpha.4 → 20.2.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/OPENAPI_VERSION +1 -1
- package/VERSION +1 -1
- package/cjs/Error.js +9 -1
- package/cjs/apiVersion.js +1 -1
- package/cjs/resources/SharedPayment/GrantedTokens.js +12 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +16 -0
- package/cjs/resources/V2/Iam/ApiKeys.js +24 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +20 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +33 -0
- package/cjs/resources/V2/Tax/ManualRules.js +23 -0
- package/cjs/resources.js +15 -1
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +7 -0
- package/esm/apiVersion.js +1 -1
- package/esm/resources/SharedPayment/GrantedTokens.js +9 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +13 -0
- package/esm/resources/V2/Iam/ApiKeys.js +21 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +17 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.js +30 -0
- package/esm/resources/V2/Tax/ManualRules.js +20 -0
- package/esm/resources.js +14 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinks.d.ts +1 -1
- package/types/AccountNotices.d.ts +6 -6
- package/types/AccountNoticesResource.d.ts +1 -1
- package/types/AccountSessions.d.ts +7 -7
- package/types/AccountSessionsResource.d.ts +21 -0
- package/types/Accounts.d.ts +25 -25
- package/types/AccountsResource.d.ts +107 -63
- package/types/ApplicationFeesResource.d.ts +2 -2
- package/types/Apps/Secrets.d.ts +1 -1
- package/types/Balance.d.ts +2 -2
- package/types/BalanceSettings.d.ts +1 -1
- package/types/BalanceTransactions.d.ts +1 -1
- package/types/BalanceTransfers.d.ts +3 -3
- package/types/BalanceTransfersResource.d.ts +1 -1
- package/types/BankAccounts.d.ts +10 -10
- package/types/Billing/Alerts.d.ts +2 -2
- package/types/Billing/CreditBalanceSummary.d.ts +3 -3
- package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactions.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
- package/types/Billing/CreditGrants.d.ts +4 -4
- package/types/Billing/CreditGrantsResource.d.ts +3 -3
- package/types/Billing/MeterEvents.d.ts +1 -1
- package/types/Billing/MeterEventsResource.d.ts +1 -1
- package/types/BillingPortal/Configurations.d.ts +10 -3
- package/types/BillingPortal/ConfigurationsResource.d.ts +20 -6
- package/types/BillingPortal/Sessions.d.ts +7 -7
- package/types/BillingPortal/SessionsResource.d.ts +7 -7
- package/types/Capabilities.d.ts +16 -16
- package/types/Capital/FinancingOffers.d.ts +2 -2
- package/types/Capital/FinancingSummary.d.ts +7 -4
- package/types/Capital/FinancingSummaryResource.d.ts +1 -1
- package/types/Cards.d.ts +2 -2
- package/types/CashBalances.d.ts +3 -3
- package/types/Charges.d.ts +59 -27
- package/types/ChargesResource.d.ts +22 -22
- package/types/Checkout/Sessions.d.ts +18 -18
- package/types/Checkout/SessionsResource.d.ts +90 -60
- package/types/Climate/Orders.d.ts +1 -1
- package/types/Climate/OrdersResource.d.ts +2 -2
- package/types/ConfirmationTokens.d.ts +8 -6
- package/types/Coupons.d.ts +3 -3
- package/types/CouponsResource.d.ts +2 -2
- package/types/CreditNoteLineItems.d.ts +3 -0
- package/types/CreditNotes.d.ts +8 -5
- package/types/CreditNotesResource.d.ts +5 -5
- package/types/CustomerBalanceTransactions.d.ts +9 -6
- package/types/CustomerCashBalanceTransactions.d.ts +13 -10
- package/types/CustomerSessions.d.ts +1 -1
- package/types/Customers.d.ts +8 -5
- package/types/CustomersResource.d.ts +21 -16
- package/types/DelegatedCheckout/RequestedSessions.d.ts +83 -17
- package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +102 -0
- package/types/Discounts.d.ts +6 -6
- package/types/Disputes.d.ts +3 -3
- package/types/DisputesResource.d.ts +1 -1
- package/types/Entitlements/ActiveEntitlements.d.ts +1 -1
- package/types/Errors.d.ts +6 -0
- package/types/Events.d.ts +1 -1
- package/types/ExchangeRates.d.ts +2 -2
- package/types/ExternalAccountsResource.d.ts +4 -4
- package/types/FeeRefunds.d.ts +2 -2
- package/types/FileLinks.d.ts +1 -1
- package/types/FileLinksResource.d.ts +2 -2
- package/types/Files.d.ts +4 -4
- package/types/FilesResource.d.ts +3 -3
- package/types/FinancialConnections/Accounts.d.ts +3 -3
- package/types/FinancialConnections/AccountsResource.d.ts +3 -3
- package/types/FinancialConnections/Sessions.d.ts +2 -2
- package/types/FinancialConnections/SessionsResource.d.ts +3 -3
- package/types/Forwarding/Requests.d.ts +1 -1
- package/types/Forwarding/RequestsResource.d.ts +1 -1
- package/types/FundingInstructions.d.ts +2 -2
- package/types/Identity/BlocklistEntries.d.ts +1 -1
- package/types/Identity/VerificationReports.d.ts +8 -8
- package/types/Identity/VerificationSessions.d.ts +11 -11
- package/types/Identity/VerificationSessionsResource.d.ts +18 -12
- package/types/InvoiceItems.d.ts +12 -12
- package/types/InvoiceItemsResource.d.ts +16 -16
- package/types/InvoiceLineItems.d.ts +11 -8
- package/types/InvoicePayments.d.ts +1 -1
- package/types/InvoiceRenderingTemplates.d.ts +1 -1
- package/types/Invoices.d.ts +83 -33
- package/types/InvoicesResource.d.ts +237 -111
- package/types/Issuing/Authorizations.d.ts +20 -20
- package/types/Issuing/AuthorizationsResource.d.ts +4 -4
- package/types/Issuing/Cardholders.d.ts +13 -13
- package/types/Issuing/CardholdersResource.d.ts +21 -21
- package/types/Issuing/Cards.d.ts +20 -10
- package/types/Issuing/CardsResource.d.ts +46 -13
- package/types/Issuing/CreditUnderwritingRecords.d.ts +5 -5
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +15 -15
- package/types/Issuing/Disputes.d.ts +7 -7
- package/types/Issuing/DisputesResource.d.ts +5 -5
- package/types/Issuing/FraudLiabilityDebits.d.ts +1 -1
- package/types/Issuing/PersonalizationDesigns.d.ts +1 -1
- package/types/Issuing/PersonalizationDesignsResource.d.ts +2 -2
- package/types/Issuing/Programs.d.ts +1 -1
- package/types/Issuing/ProgramsResource.d.ts +1 -1
- package/types/Issuing/Settlements.d.ts +2 -2
- package/types/Issuing/Tokens.d.ts +1 -1
- package/types/Issuing/Transactions.d.ts +13 -13
- package/types/Issuing/TransactionsResource.d.ts +1 -1
- package/types/LineItems.d.ts +3 -3
- package/types/LoginLinks.d.ts +1 -1
- package/types/MandatesResource.d.ts +1 -1
- package/types/Margins.d.ts +1 -1
- package/types/MarginsResource.d.ts +2 -2
- package/types/Orders.d.ts +11 -11
- package/types/OrdersResource.d.ts +24 -24
- package/types/PaymentAttemptRecords.d.ts +119 -18
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +3 -3
- package/types/PaymentIntents.d.ts +72 -44
- package/types/PaymentIntentsResource.d.ts +172 -159
- package/types/PaymentLinks.d.ts +7 -7
- package/types/PaymentLinksResource.d.ts +42 -28
- package/types/PaymentMethodConfigurations.d.ts +4 -4
- package/types/PaymentMethodConfigurationsResource.d.ts +80 -80
- package/types/PaymentMethodDomains.d.ts +1 -1
- package/types/PaymentMethods.d.ts +10 -8
- package/types/PaymentMethodsResource.d.ts +7 -6
- package/types/PaymentRecords.d.ts +126 -18
- package/types/PaymentRecordsResource.d.ts +7 -7
- package/types/Payouts.d.ts +7 -7
- package/types/PayoutsResource.d.ts +3 -3
- package/types/Persons.d.ts +21 -21
- package/types/Plans.d.ts +5 -5
- package/types/PlansResource.d.ts +6 -6
- package/types/Prices.d.ts +6 -6
- package/types/PricesResource.d.ts +10 -10
- package/types/ProductCatalog/TrialOffers.d.ts +1 -1
- package/types/Products.d.ts +10 -10
- package/types/ProductsResource.d.ts +38 -14
- package/types/PromotionCodes.d.ts +5 -5
- package/types/PromotionCodesResource.d.ts +5 -5
- package/types/QuoteLines.d.ts +3 -3
- package/types/QuotePreviewInvoices.d.ts +81 -31
- package/types/QuotePreviewSubscriptionSchedules.d.ts +18 -18
- package/types/Quotes.d.ts +16 -16
- package/types/QuotesResource.d.ts +30 -30
- package/types/Radar/EarlyFraudWarnings.d.ts +1 -1
- package/types/Radar/ValueListItems.d.ts +1 -1
- package/types/Radar/ValueLists.d.ts +2 -2
- package/types/Radar/ValueListsResource.d.ts +2 -2
- package/types/Refunds.d.ts +3 -3
- package/types/RefundsResource.d.ts +3 -3
- package/types/Reporting/ReportRuns.d.ts +3 -3
- package/types/Reporting/ReportRunsResource.d.ts +2 -2
- package/types/Reporting/ReportTypes.d.ts +3 -3
- package/types/Reviews.d.ts +1 -1
- package/types/SetupAttempts.d.ts +21 -18
- package/types/SetupIntents.d.ts +20 -19
- package/types/SetupIntentsResource.d.ts +47 -44
- package/types/SharedPayment/GrantedTokens.d.ts +102 -0
- package/types/SharedPayment/GrantedTokensResource.d.ts +29 -0
- package/types/ShippingRates.d.ts +3 -3
- package/types/ShippingRatesResource.d.ts +3 -3
- package/types/Sigma/ScheduledQueryRuns.d.ts +1 -1
- package/types/SourceMandateNotifications.d.ts +3 -3
- package/types/Sources.d.ts +5 -5
- package/types/SourcesResource.d.ts +2 -2
- package/types/SubscriptionItems.d.ts +7 -7
- package/types/SubscriptionItemsResource.d.ts +22 -22
- package/types/SubscriptionSchedules.d.ts +19 -19
- package/types/SubscriptionSchedulesResource.d.ts +61 -61
- package/types/Subscriptions.d.ts +61 -15
- package/types/SubscriptionsResource.d.ts +142 -58
- package/types/Tax/Associations.d.ts +3 -3
- package/types/Tax/AssociationsResource.d.ts +1 -1
- package/types/Tax/CalculationLineItems.d.ts +7 -7
- package/types/Tax/Calculations.d.ts +12 -12
- package/types/Tax/CalculationsResource.d.ts +7 -7
- package/types/Tax/Registrations.d.ts +3 -3
- package/types/Tax/Settings.d.ts +1 -1
- package/types/Tax/SettingsResource.d.ts +1 -1
- package/types/Tax/TransactionLineItems.d.ts +5 -5
- package/types/Tax/Transactions.d.ts +9 -9
- package/types/Tax/TransactionsResource.d.ts +10 -10
- package/types/TaxIds.d.ts +6 -6
- package/types/TaxIdsResource.d.ts +4 -4
- package/types/TaxRates.d.ts +1 -1
- package/types/TaxRatesResource.d.ts +2 -2
- package/types/Terminal/ConnectionTokens.d.ts +1 -1
- package/types/Terminal/Locations.d.ts +2 -2
- package/types/Terminal/LocationsResource.d.ts +3 -3
- package/types/Terminal/Readers.d.ts +10 -10
- package/types/Terminal/ReadersResource.d.ts +7 -7
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +5 -4
- package/types/TestHelpers/CustomersResource.d.ts +2 -2
- package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +10 -10
- package/types/TestHelpers/Issuing/TransactionsResource.d.ts +5 -5
- package/types/TestHelpers/SharedPayment/GrantedTokensResource.d.ts +87 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +1 -1
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +1 -1
- package/types/Tokens.d.ts +4 -4
- package/types/TokensResource.d.ts +17 -17
- package/types/Topups.d.ts +3 -3
- package/types/TopupsResource.d.ts +3 -3
- package/types/TransferReversals.d.ts +4 -4
- package/types/Transfers.d.ts +5 -5
- package/types/TransfersResource.d.ts +6 -6
- package/types/Treasury/CreditReversals.d.ts +3 -3
- package/types/Treasury/CreditReversalsResource.d.ts +1 -1
- package/types/Treasury/DebitReversals.d.ts +3 -3
- package/types/Treasury/DebitReversalsResource.d.ts +1 -1
- package/types/Treasury/FinancialAccounts.d.ts +1 -1
- package/types/Treasury/FinancialAccountsResource.d.ts +2 -2
- package/types/Treasury/InboundTransfers.d.ts +4 -4
- package/types/Treasury/InboundTransfersResource.d.ts +2 -2
- package/types/Treasury/OutboundPayments.d.ts +5 -5
- package/types/Treasury/OutboundPaymentsResource.d.ts +4 -4
- package/types/Treasury/OutboundTransfers.d.ts +4 -4
- package/types/Treasury/OutboundTransfersResource.d.ts +3 -3
- package/types/Treasury/ReceivedCredits.d.ts +9 -9
- package/types/Treasury/ReceivedDebits.d.ts +6 -6
- package/types/Treasury/TransactionEntries.d.ts +11 -11
- package/types/Treasury/Transactions.d.ts +11 -11
- package/types/V2/Billing/IntentActions.d.ts +141 -36
- package/types/V2/Billing/IntentsResource.d.ts +141 -42
- package/types/V2/Core/AccountLinks.d.ts +11 -11
- package/types/V2/Core/AccountLinksResource.d.ts +6 -6
- package/types/V2/Core/AccountPersons.d.ts +55 -10
- package/types/V2/Core/AccountTokensResource.d.ts +99 -10
- package/types/V2/Core/Accounts/PersonTokensResource.d.ts +48 -3
- package/types/V2/Core/Accounts/PersonsResource.d.ts +101 -11
- package/types/V2/Core/Accounts.d.ts +298 -509
- package/types/V2/Core/AccountsResource.d.ts +256 -51
- package/types/V2/Core/ClaimableSandboxesResource.d.ts +1 -1
- package/types/V2/Core/EventTypes.d.ts +601 -0
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +21 -0
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +26 -0
- package/types/V2/Iam/ApiKeys.d.ts +154 -0
- package/types/V2/Iam/ApiKeysResource.d.ts +215 -0
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +31 -1
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +8 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +2 -0
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +26 -0
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +2 -0
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +10 -1
- package/types/V2/Payments/SettlementAllocationIntentSplits.d.ts +111 -0
- package/types/V2/Payments/SettlementAllocationIntents/SplitsResource.d.ts +126 -0
- package/types/V2/Payments/SettlementAllocationIntents.d.ts +122 -0
- package/types/V2/Payments/SettlementAllocationIntentsResource.d.ts +168 -0
- package/types/V2/Tax/ManualRules.d.ts +142 -0
- package/types/V2/Tax/ManualRulesResource.d.ts +292 -0
- package/types/WebhookEndpoints.d.ts +1 -1
- package/types/WebhookEndpointsResource.d.ts +4 -3
- package/types/apiVersion.d.ts +1 -1
- package/types/index.d.ts +24 -0
|
@@ -72,7 +72,7 @@ declare module 'stripe' {
|
|
|
72
72
|
/**
|
|
73
73
|
* ID of the account who owns the subscription schedule.
|
|
74
74
|
*/
|
|
75
|
-
customer_account
|
|
75
|
+
customer_account: string | null;
|
|
76
76
|
|
|
77
77
|
default_settings: QuotePreviewSubscriptionSchedule.DefaultSettings;
|
|
78
78
|
|
|
@@ -97,7 +97,7 @@ declare module 'stripe' {
|
|
|
97
97
|
livemode: boolean;
|
|
98
98
|
|
|
99
99
|
/**
|
|
100
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
100
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
101
101
|
*/
|
|
102
102
|
metadata: Stripe.Metadata | null;
|
|
103
103
|
|
|
@@ -122,7 +122,7 @@ declare module 'stripe' {
|
|
|
122
122
|
released_subscription: string | null;
|
|
123
123
|
|
|
124
124
|
/**
|
|
125
|
-
* The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/
|
|
125
|
+
* The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://docs.stripe.com/billing/subscriptions/subscription-schedules).
|
|
126
126
|
*/
|
|
127
127
|
status: QuotePreviewSubscriptionSchedule.Status;
|
|
128
128
|
|
|
@@ -309,7 +309,7 @@ declare module 'stripe' {
|
|
|
309
309
|
automatic_tax?: DefaultSettings.AutomaticTax;
|
|
310
310
|
|
|
311
311
|
/**
|
|
312
|
-
* Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/
|
|
312
|
+
* Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
313
313
|
*/
|
|
314
314
|
billing_cycle_anchor: DefaultSettings.BillingCycleAnchor;
|
|
315
315
|
|
|
@@ -341,14 +341,14 @@ declare module 'stripe' {
|
|
|
341
341
|
on_behalf_of: string | Stripe.Account | null;
|
|
342
342
|
|
|
343
343
|
/**
|
|
344
|
-
*
|
|
344
|
+
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
345
345
|
*/
|
|
346
|
-
|
|
346
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
347
347
|
|
|
348
348
|
/**
|
|
349
|
-
*
|
|
349
|
+
* The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
|
350
350
|
*/
|
|
351
|
-
|
|
351
|
+
transfer_data: DefaultSettings.TransferData | null;
|
|
352
352
|
}
|
|
353
353
|
|
|
354
354
|
namespace DefaultSettings {
|
|
@@ -499,7 +499,7 @@ declare module 'stripe' {
|
|
|
499
499
|
automatic_tax?: Phase.AutomaticTax;
|
|
500
500
|
|
|
501
501
|
/**
|
|
502
|
-
* Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/
|
|
502
|
+
* Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
503
503
|
*/
|
|
504
504
|
billing_cycle_anchor: Phase.BillingCycleAnchor | null;
|
|
505
505
|
|
|
@@ -538,6 +538,11 @@ declare module 'stripe' {
|
|
|
538
538
|
*/
|
|
539
539
|
discounts: Array<Phase.Discount>;
|
|
540
540
|
|
|
541
|
+
/**
|
|
542
|
+
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
543
|
+
*/
|
|
544
|
+
effective_at?: Phase.EffectiveAt | null;
|
|
545
|
+
|
|
541
546
|
/**
|
|
542
547
|
* The end of this phase of the subscription schedule.
|
|
543
548
|
*/
|
|
@@ -554,7 +559,7 @@ declare module 'stripe' {
|
|
|
554
559
|
items: Array<Phase.Item>;
|
|
555
560
|
|
|
556
561
|
/**
|
|
557
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
562
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
|
|
558
563
|
*/
|
|
559
564
|
metadata: Stripe.Metadata | null;
|
|
560
565
|
|
|
@@ -564,7 +569,7 @@ declare module 'stripe' {
|
|
|
564
569
|
on_behalf_of: string | Stripe.Account | null;
|
|
565
570
|
|
|
566
571
|
/**
|
|
567
|
-
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/
|
|
572
|
+
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
568
573
|
*/
|
|
569
574
|
pause_collection?: Phase.PauseCollection | null;
|
|
570
575
|
|
|
@@ -597,11 +602,6 @@ declare module 'stripe' {
|
|
|
597
602
|
* Settings related to any trials on the subscription during this phase.
|
|
598
603
|
*/
|
|
599
604
|
trial_settings?: Phase.TrialSettings | null;
|
|
600
|
-
|
|
601
|
-
/**
|
|
602
|
-
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
603
|
-
*/
|
|
604
|
-
effective_at?: Phase.EffectiveAt | null;
|
|
605
605
|
}
|
|
606
606
|
|
|
607
607
|
namespace Phase {
|
|
@@ -612,7 +612,7 @@ declare module 'stripe' {
|
|
|
612
612
|
discounts: Array<AddInvoiceItem.Discount>;
|
|
613
613
|
|
|
614
614
|
/**
|
|
615
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
615
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
616
616
|
*/
|
|
617
617
|
metadata: Stripe.Metadata | null;
|
|
618
618
|
|
|
@@ -850,7 +850,7 @@ declare module 'stripe' {
|
|
|
850
850
|
discounts: Array<Item.Discount>;
|
|
851
851
|
|
|
852
852
|
/**
|
|
853
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
853
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
|
|
854
854
|
*/
|
|
855
855
|
metadata: Stripe.Metadata | null;
|
|
856
856
|
|
package/types/Quotes.d.ts
CHANGED
|
@@ -71,14 +71,14 @@ declare module 'stripe' {
|
|
|
71
71
|
currency: string | null;
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
|
-
* The customer
|
|
74
|
+
* The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.
|
|
75
75
|
*/
|
|
76
76
|
customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
* The account
|
|
79
|
+
* The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it.
|
|
80
80
|
*/
|
|
81
|
-
customer_account
|
|
81
|
+
customer_account: string | null;
|
|
82
82
|
|
|
83
83
|
/**
|
|
84
84
|
* The tax rates applied to this quote.
|
|
@@ -106,7 +106,7 @@ declare module 'stripe' {
|
|
|
106
106
|
footer: string | null;
|
|
107
107
|
|
|
108
108
|
/**
|
|
109
|
-
* Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/
|
|
109
|
+
* Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details.
|
|
110
110
|
*/
|
|
111
111
|
from_quote: Quote.FromQuote | null;
|
|
112
112
|
|
|
@@ -138,12 +138,12 @@ declare module 'stripe' {
|
|
|
138
138
|
livemode: boolean;
|
|
139
139
|
|
|
140
140
|
/**
|
|
141
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
141
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
142
142
|
*/
|
|
143
143
|
metadata: Stripe.Metadata;
|
|
144
144
|
|
|
145
145
|
/**
|
|
146
|
-
* A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/
|
|
146
|
+
* A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize).
|
|
147
147
|
*/
|
|
148
148
|
number: string | null;
|
|
149
149
|
|
|
@@ -370,10 +370,10 @@ declare module 'stripe' {
|
|
|
370
370
|
amount: number;
|
|
371
371
|
|
|
372
372
|
/**
|
|
373
|
-
* A discount represents the actual application of a [coupon](https://stripe.com
|
|
373
|
+
* A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
|
|
374
374
|
* It contains information about when the discount began, when it will end, and what it is applied to.
|
|
375
375
|
*
|
|
376
|
-
* Related guide: [Applying discounts to subscriptions](https://stripe.com/
|
|
376
|
+
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
377
377
|
*/
|
|
378
378
|
discount: Stripe.Discount;
|
|
379
379
|
}
|
|
@@ -484,10 +484,10 @@ declare module 'stripe' {
|
|
|
484
484
|
amount: number;
|
|
485
485
|
|
|
486
486
|
/**
|
|
487
|
-
* A discount represents the actual application of a [coupon](https://stripe.com
|
|
487
|
+
* A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
|
|
488
488
|
* It contains information about when the discount began, when it will end, and what it is applied to.
|
|
489
489
|
*
|
|
490
|
-
* Related guide: [Applying discounts to subscriptions](https://stripe.com/
|
|
490
|
+
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
491
491
|
*/
|
|
492
492
|
discount: Stripe.Discount;
|
|
493
493
|
}
|
|
@@ -790,7 +790,7 @@ declare module 'stripe' {
|
|
|
790
790
|
from_subscription?: string | Stripe.Subscription | null;
|
|
791
791
|
|
|
792
792
|
/**
|
|
793
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
793
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
794
794
|
*/
|
|
795
795
|
metadata: Stripe.Metadata | null;
|
|
796
796
|
|
|
@@ -805,7 +805,7 @@ declare module 'stripe' {
|
|
|
805
805
|
prebilling?: SubscriptionData.Prebilling | null;
|
|
806
806
|
|
|
807
807
|
/**
|
|
808
|
-
* Determines how to handle [prorations](https://stripe.com/
|
|
808
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
|
|
809
809
|
*/
|
|
810
810
|
proration_behavior?: SubscriptionData.ProrationBehavior;
|
|
811
811
|
|
|
@@ -1115,7 +1115,7 @@ declare module 'stripe' {
|
|
|
1115
1115
|
billing_schedules?: Array<SubscriptionDataOverride.BillingSchedule>;
|
|
1116
1116
|
|
|
1117
1117
|
/**
|
|
1118
|
-
* The customer
|
|
1118
|
+
* The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.
|
|
1119
1119
|
*/
|
|
1120
1120
|
customer: string | null;
|
|
1121
1121
|
|
|
@@ -1135,7 +1135,7 @@ declare module 'stripe' {
|
|
|
1135
1135
|
phase_effective_at?: SubscriptionDataOverride.PhaseEffectiveAt;
|
|
1136
1136
|
|
|
1137
1137
|
/**
|
|
1138
|
-
* Determines how to handle [prorations](https://stripe.com/
|
|
1138
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
|
|
1139
1139
|
*/
|
|
1140
1140
|
proration_behavior?: SubscriptionDataOverride.ProrationBehavior | null;
|
|
1141
1141
|
}
|
|
@@ -1486,10 +1486,10 @@ declare module 'stripe' {
|
|
|
1486
1486
|
amount: number;
|
|
1487
1487
|
|
|
1488
1488
|
/**
|
|
1489
|
-
* A discount represents the actual application of a [coupon](https://stripe.com
|
|
1489
|
+
* A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
|
|
1490
1490
|
* It contains information about when the discount began, when it will end, and what it is applied to.
|
|
1491
1491
|
*
|
|
1492
|
-
* Related guide: [Applying discounts to subscriptions](https://stripe.com/
|
|
1492
|
+
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
1493
1493
|
*/
|
|
1494
1494
|
discount: Stripe.Discount;
|
|
1495
1495
|
}
|
|
@@ -94,7 +94,7 @@ declare module 'stripe' {
|
|
|
94
94
|
lines?: Array<QuoteCreateParams.Line>;
|
|
95
95
|
|
|
96
96
|
/**
|
|
97
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
97
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
98
98
|
*/
|
|
99
99
|
metadata?: Stripe.MetadataParam;
|
|
100
100
|
|
|
@@ -283,6 +283,11 @@ declare module 'stripe' {
|
|
|
283
283
|
*/
|
|
284
284
|
cancel_subscription_schedule?: Line.CancelSubscriptionSchedule;
|
|
285
285
|
|
|
286
|
+
/**
|
|
287
|
+
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
288
|
+
*/
|
|
289
|
+
effective_at?: Line.EffectiveAt;
|
|
290
|
+
|
|
286
291
|
/**
|
|
287
292
|
* Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
|
|
288
293
|
*/
|
|
@@ -312,11 +317,6 @@ declare module 'stripe' {
|
|
|
312
317
|
* Settings related to subscription trials.
|
|
313
318
|
*/
|
|
314
319
|
trial_settings?: Line.TrialSettings;
|
|
315
|
-
|
|
316
|
-
/**
|
|
317
|
-
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
318
|
-
*/
|
|
319
|
-
effective_at?: Line.EffectiveAt;
|
|
320
320
|
}
|
|
321
321
|
|
|
322
322
|
namespace Line {
|
|
@@ -420,7 +420,7 @@ declare module 'stripe' {
|
|
|
420
420
|
discounts?: Array<AddItem.Discount>;
|
|
421
421
|
|
|
422
422
|
/**
|
|
423
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
423
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
424
424
|
*/
|
|
425
425
|
metadata?: Stripe.MetadataParam;
|
|
426
426
|
|
|
@@ -912,7 +912,7 @@ declare module 'stripe' {
|
|
|
912
912
|
price?: string;
|
|
913
913
|
|
|
914
914
|
/**
|
|
915
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
915
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
916
916
|
*/
|
|
917
917
|
price_data?: LineItem.PriceData;
|
|
918
918
|
|
|
@@ -1006,7 +1006,7 @@ declare module 'stripe' {
|
|
|
1006
1006
|
recurring?: PriceData.Recurring;
|
|
1007
1007
|
|
|
1008
1008
|
/**
|
|
1009
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
1009
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
1010
1010
|
*/
|
|
1011
1011
|
tax_behavior?: PriceData.TaxBehavior;
|
|
1012
1012
|
|
|
@@ -1089,7 +1089,7 @@ declare module 'stripe' {
|
|
|
1089
1089
|
from_subscription?: string;
|
|
1090
1090
|
|
|
1091
1091
|
/**
|
|
1092
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1092
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
1093
1093
|
*/
|
|
1094
1094
|
metadata?: Stripe.MetadataParam;
|
|
1095
1095
|
|
|
@@ -1104,11 +1104,11 @@ declare module 'stripe' {
|
|
|
1104
1104
|
prebilling?: Stripe.Emptyable<SubscriptionData.Prebilling>;
|
|
1105
1105
|
|
|
1106
1106
|
/**
|
|
1107
|
-
* Determines how to handle [prorations](https://stripe.com/
|
|
1107
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
1108
1108
|
*
|
|
1109
1109
|
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
1110
1110
|
*
|
|
1111
|
-
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/
|
|
1111
|
+
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
|
|
1112
1112
|
*
|
|
1113
1113
|
* Prorations can be disabled by passing `none`.
|
|
1114
1114
|
*/
|
|
@@ -1453,11 +1453,11 @@ declare module 'stripe' {
|
|
|
1453
1453
|
phase_effective_at?: SubscriptionDataOverride.PhaseEffectiveAt;
|
|
1454
1454
|
|
|
1455
1455
|
/**
|
|
1456
|
-
* Determines how to handle [prorations](https://stripe.com/
|
|
1456
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
1457
1457
|
*
|
|
1458
1458
|
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
1459
1459
|
*
|
|
1460
|
-
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/
|
|
1460
|
+
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
|
|
1461
1461
|
*
|
|
1462
1462
|
* Prorations can be disabled by passing `none`.
|
|
1463
1463
|
*/
|
|
@@ -1854,7 +1854,7 @@ declare module 'stripe' {
|
|
|
1854
1854
|
lines?: Array<QuoteUpdateParams.Line>;
|
|
1855
1855
|
|
|
1856
1856
|
/**
|
|
1857
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1857
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
1858
1858
|
*/
|
|
1859
1859
|
metadata?: Stripe.MetadataParam;
|
|
1860
1860
|
|
|
@@ -2026,6 +2026,11 @@ declare module 'stripe' {
|
|
|
2026
2026
|
*/
|
|
2027
2027
|
cancel_subscription_schedule?: Line.CancelSubscriptionSchedule;
|
|
2028
2028
|
|
|
2029
|
+
/**
|
|
2030
|
+
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
2031
|
+
*/
|
|
2032
|
+
effective_at?: Line.EffectiveAt;
|
|
2033
|
+
|
|
2029
2034
|
/**
|
|
2030
2035
|
* Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
|
|
2031
2036
|
*/
|
|
@@ -2060,11 +2065,6 @@ declare module 'stripe' {
|
|
|
2060
2065
|
* Settings related to subscription trials.
|
|
2061
2066
|
*/
|
|
2062
2067
|
trial_settings?: Line.TrialSettings;
|
|
2063
|
-
|
|
2064
|
-
/**
|
|
2065
|
-
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
2066
|
-
*/
|
|
2067
|
-
effective_at?: Line.EffectiveAt;
|
|
2068
2068
|
}
|
|
2069
2069
|
|
|
2070
2070
|
namespace Line {
|
|
@@ -2168,7 +2168,7 @@ declare module 'stripe' {
|
|
|
2168
2168
|
discounts?: Array<AddItem.Discount>;
|
|
2169
2169
|
|
|
2170
2170
|
/**
|
|
2171
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
2171
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
2172
2172
|
*/
|
|
2173
2173
|
metadata?: Stripe.MetadataParam;
|
|
2174
2174
|
|
|
@@ -2670,7 +2670,7 @@ declare module 'stripe' {
|
|
|
2670
2670
|
price?: string;
|
|
2671
2671
|
|
|
2672
2672
|
/**
|
|
2673
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
2673
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
2674
2674
|
*/
|
|
2675
2675
|
price_data?: LineItem.PriceData;
|
|
2676
2676
|
|
|
@@ -2764,7 +2764,7 @@ declare module 'stripe' {
|
|
|
2764
2764
|
recurring?: PriceData.Recurring;
|
|
2765
2765
|
|
|
2766
2766
|
/**
|
|
2767
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
2767
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
2768
2768
|
*/
|
|
2769
2769
|
tax_behavior?: PriceData.TaxBehavior;
|
|
2770
2770
|
|
|
@@ -2841,7 +2841,7 @@ declare module 'stripe' {
|
|
|
2841
2841
|
end_behavior?: SubscriptionData.EndBehavior;
|
|
2842
2842
|
|
|
2843
2843
|
/**
|
|
2844
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
2844
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
2845
2845
|
*/
|
|
2846
2846
|
metadata?: Stripe.MetadataParam;
|
|
2847
2847
|
|
|
@@ -2856,11 +2856,11 @@ declare module 'stripe' {
|
|
|
2856
2856
|
prebilling?: Stripe.Emptyable<SubscriptionData.Prebilling>;
|
|
2857
2857
|
|
|
2858
2858
|
/**
|
|
2859
|
-
* Determines how to handle [prorations](https://stripe.com/
|
|
2859
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
2860
2860
|
*
|
|
2861
2861
|
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
2862
2862
|
*
|
|
2863
|
-
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/
|
|
2863
|
+
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
|
|
2864
2864
|
*
|
|
2865
2865
|
* Prorations can be disabled by passing `none`.
|
|
2866
2866
|
*/
|
|
@@ -3182,11 +3182,11 @@ declare module 'stripe' {
|
|
|
3182
3182
|
phase_effective_at?: SubscriptionDataOverride.PhaseEffectiveAt;
|
|
3183
3183
|
|
|
3184
3184
|
/**
|
|
3185
|
-
* Determines how to handle [prorations](https://stripe.com/
|
|
3185
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
3186
3186
|
*
|
|
3187
3187
|
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
3188
3188
|
*
|
|
3189
|
-
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/
|
|
3189
|
+
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
|
|
3190
3190
|
*
|
|
3191
3191
|
* Prorations can be disabled by passing `none`.
|
|
3192
3192
|
*/
|
|
@@ -3491,12 +3491,12 @@ declare module 'stripe' {
|
|
|
3491
3491
|
|
|
3492
3492
|
interface QuoteListParams extends PaginationParams {
|
|
3493
3493
|
/**
|
|
3494
|
-
* The ID of the customer whose quotes
|
|
3494
|
+
* The ID of the customer whose quotes you're retrieving.
|
|
3495
3495
|
*/
|
|
3496
3496
|
customer?: string;
|
|
3497
3497
|
|
|
3498
3498
|
/**
|
|
3499
|
-
* The ID of the account whose quotes
|
|
3499
|
+
* The ID of the account representing the customer whose quotes you're retrieving.
|
|
3500
3500
|
*/
|
|
3501
3501
|
customer_account?: string;
|
|
3502
3502
|
|
|
@@ -7,7 +7,7 @@ declare module 'stripe' {
|
|
|
7
7
|
* An early fraud warning indicates that the card issuer has notified us that a
|
|
8
8
|
* charge may be fraudulent.
|
|
9
9
|
*
|
|
10
|
-
* Related guide: [Early fraud warnings](https://stripe.com/
|
|
10
|
+
* Related guide: [Early fraud warnings](https://docs.stripe.com/disputes/measuring#early-fraud-warnings)
|
|
11
11
|
*/
|
|
12
12
|
interface EarlyFraudWarning {
|
|
13
13
|
/**
|
|
@@ -26,7 +26,7 @@ declare module 'stripe' {
|
|
|
26
26
|
/**
|
|
27
27
|
* Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
|
|
28
28
|
*
|
|
29
|
-
* Related guide: [Managing list items](https://stripe.com/
|
|
29
|
+
* Related guide: [Managing list items](https://docs.stripe.com/radar/lists#managing-list-items)
|
|
30
30
|
*/
|
|
31
31
|
interface ValueListItem {
|
|
32
32
|
/**
|
|
@@ -26,7 +26,7 @@ declare module 'stripe' {
|
|
|
26
26
|
/**
|
|
27
27
|
* Value lists allow you to group values together which can then be referenced in rules.
|
|
28
28
|
*
|
|
29
|
-
* Related guide: [Default Stripe lists](https://stripe.com/
|
|
29
|
+
* Related guide: [Default Stripe lists](https://docs.stripe.com/radar/lists#managing-list-items)
|
|
30
30
|
*/
|
|
31
31
|
interface ValueList {
|
|
32
32
|
/**
|
|
@@ -75,7 +75,7 @@ declare module 'stripe' {
|
|
|
75
75
|
livemode: boolean;
|
|
76
76
|
|
|
77
77
|
/**
|
|
78
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
78
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
79
79
|
*/
|
|
80
80
|
metadata: Stripe.Metadata;
|
|
81
81
|
|
|
@@ -25,7 +25,7 @@ declare module 'stripe' {
|
|
|
25
25
|
item_type?: ValueListCreateParams.ItemType;
|
|
26
26
|
|
|
27
27
|
/**
|
|
28
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
28
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
29
29
|
*/
|
|
30
30
|
metadata?: Stripe.MetadataParam;
|
|
31
31
|
}
|
|
@@ -63,7 +63,7 @@ declare module 'stripe' {
|
|
|
63
63
|
expand?: Array<string>;
|
|
64
64
|
|
|
65
65
|
/**
|
|
66
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
66
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
67
67
|
*/
|
|
68
68
|
metadata?: Stripe.MetadataParam;
|
|
69
69
|
|
package/types/Refunds.d.ts
CHANGED
|
@@ -7,7 +7,7 @@ declare module 'stripe' {
|
|
|
7
7
|
* refunded yet. Funds are refunded to the credit or debit card that's
|
|
8
8
|
* initially charged.
|
|
9
9
|
*
|
|
10
|
-
* Related guide: [Refunds](https://stripe.com/
|
|
10
|
+
* Related guide: [Refunds](https://docs.stripe.com/refunds)
|
|
11
11
|
*/
|
|
12
12
|
interface Refund {
|
|
13
13
|
/**
|
|
@@ -68,7 +68,7 @@ declare module 'stripe' {
|
|
|
68
68
|
instructions_email?: string;
|
|
69
69
|
|
|
70
70
|
/**
|
|
71
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
71
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
72
72
|
*/
|
|
73
73
|
metadata: Stripe.Metadata | null;
|
|
74
74
|
|
|
@@ -102,7 +102,7 @@ declare module 'stripe' {
|
|
|
102
102
|
source_transfer_reversal: string | Stripe.TransferReversal | null;
|
|
103
103
|
|
|
104
104
|
/**
|
|
105
|
-
* Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/
|
|
105
|
+
* Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://docs.stripe.com/refunds#failed-refunds).
|
|
106
106
|
*/
|
|
107
107
|
status: string | null;
|
|
108
108
|
|
|
@@ -31,7 +31,7 @@ declare module 'stripe' {
|
|
|
31
31
|
instructions_email?: string;
|
|
32
32
|
|
|
33
33
|
/**
|
|
34
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
34
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
35
35
|
*/
|
|
36
36
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
37
37
|
|
|
@@ -46,7 +46,7 @@ declare module 'stripe' {
|
|
|
46
46
|
payment_intent?: string;
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
|
-
* String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/
|
|
49
|
+
* String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms.
|
|
50
50
|
*/
|
|
51
51
|
reason?: RefundCreateParams.Reason;
|
|
52
52
|
|
|
@@ -81,7 +81,7 @@ declare module 'stripe' {
|
|
|
81
81
|
expand?: Array<string>;
|
|
82
82
|
|
|
83
83
|
/**
|
|
84
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
84
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
85
85
|
*/
|
|
86
86
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
87
87
|
}
|
|
@@ -8,10 +8,10 @@ declare module 'stripe' {
|
|
|
8
8
|
* specific run parameters. Once the object is created, Stripe begins processing the report.
|
|
9
9
|
* When the report has finished running, it will give you a reference to a file
|
|
10
10
|
* where you can retrieve your results. For an overview, see
|
|
11
|
-
* [API Access to Reports](https://stripe.com/
|
|
11
|
+
* [API Access to Reports](https://docs.stripe.com/reporting/statements/api).
|
|
12
12
|
*
|
|
13
13
|
* Note that certain report types can only be run based on your live-mode data (not test-mode
|
|
14
|
-
* data), and will error when queried without a [live-mode API key](https://stripe.com/
|
|
14
|
+
* data), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes).
|
|
15
15
|
*/
|
|
16
16
|
interface ReportRun {
|
|
17
17
|
/**
|
|
@@ -43,7 +43,7 @@ declare module 'stripe' {
|
|
|
43
43
|
parameters: ReportRun.Parameters;
|
|
44
44
|
|
|
45
45
|
/**
|
|
46
|
-
* The ID of the [report type](https://stripe.com/
|
|
46
|
+
* The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `"balance.summary.1"`.
|
|
47
47
|
*/
|
|
48
48
|
report_type: string;
|
|
49
49
|
|
|
@@ -5,7 +5,7 @@ declare module 'stripe' {
|
|
|
5
5
|
namespace Reporting {
|
|
6
6
|
interface ReportRunCreateParams {
|
|
7
7
|
/**
|
|
8
|
-
* The ID of the [report type](https://stripe.com/
|
|
8
|
+
* The ID of the [report type](https://docs.stripe.com/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`.
|
|
9
9
|
*/
|
|
10
10
|
report_type: string;
|
|
11
11
|
|
|
@@ -15,7 +15,7 @@ declare module 'stripe' {
|
|
|
15
15
|
expand?: Array<string>;
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/
|
|
18
|
+
* Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://docs.stripe.com/reporting/statements/api) documentation.
|
|
19
19
|
*/
|
|
20
20
|
parameters?: ReportRunCreateParams.Parameters;
|
|
21
21
|
}
|