stripe 17.5.0-beta.2 → 17.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +132 -996
- package/README.md +33 -1
- package/VERSION +1 -1
- package/cjs/apiVersion.js +1 -1
- package/cjs/resources/FinancialConnections/Accounts.js +0 -5
- package/cjs/resources/Invoices.js +0 -17
- package/cjs/resources/PaymentIntents.js +0 -8
- package/cjs/resources/Quotes.js +0 -32
- package/cjs/resources/SubscriptionSchedules.js +0 -4
- package/cjs/resources/Terminal/Readers.js +0 -12
- package/cjs/resources.js +10 -48
- package/cjs/stripe.core.js +1 -1
- package/esm/apiVersion.js +1 -1
- package/esm/resources/FinancialConnections/Accounts.js +0 -5
- package/esm/resources/Invoices.js +0 -17
- package/esm/resources/PaymentIntents.js +0 -8
- package/esm/resources/Quotes.js +0 -32
- package/esm/resources/SubscriptionSchedules.js +0 -4
- package/esm/resources/Terminal/Readers.js +0 -12
- package/esm/resources.js +0 -33
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +1 -5
- package/types/AccountSessions.d.ts +5 -50
- package/types/AccountSessionsResource.d.ts +5 -360
- package/types/Accounts.d.ts +5 -194
- package/types/AccountsResource.d.ts +0 -520
- package/types/Billing/CreditBalanceTransactions.d.ts +20 -1
- package/types/Capabilities.d.ts +2 -2
- package/types/Cards.d.ts +14 -0
- package/types/Charges.d.ts +10 -136
- package/types/ChargesResource.d.ts +0 -1294
- package/types/Checkout/Sessions.d.ts +25 -323
- package/types/Checkout/SessionsResource.d.ts +5 -445
- package/types/ConfirmationTokens.d.ts +7 -99
- package/types/Coupons.d.ts +1 -1
- package/types/CouponsResource.d.ts +1 -1
- package/types/CreditNotes.d.ts +0 -21
- package/types/CreditNotesResource.d.ts +0 -51
- package/types/CustomersResource.d.ts +42 -11
- package/types/Disputes.d.ts +22 -0
- package/types/DisputesResource.d.ts +12 -0
- package/types/EventTypes.d.ts +0 -596
- package/types/Events.d.ts +0 -93
- package/types/FinancialConnections/Accounts.d.ts +1 -29
- package/types/FinancialConnections/AccountsResource.d.ts +3 -35
- package/types/FinancialConnections/Sessions.d.ts +1 -49
- package/types/FinancialConnections/SessionsResource.d.ts +1 -38
- package/types/Forwarding/Requests.d.ts +2 -1
- package/types/Forwarding/RequestsResource.d.ts +2 -1
- package/types/InvoiceItems.d.ts +0 -5
- package/types/InvoiceItemsResource.d.ts +0 -98
- package/types/InvoiceLineItems.d.ts +1 -28
- package/types/Invoices.d.ts +23 -139
- package/types/InvoicesResource.d.ts +1907 -5535
- package/types/Issuing/Authorizations.d.ts +5 -0
- package/types/Issuing/CardholdersResource.d.ts +1 -2
- package/types/Issuing/Transactions.d.ts +5 -2
- package/types/Issuing/TransactionsResource.d.ts +0 -5
- package/types/LineItems.d.ts +0 -32
- package/types/Mandates.d.ts +0 -77
- package/types/PaymentIntents.d.ts +1 -644
- package/types/PaymentIntentsResource.d.ts +3768 -8055
- package/types/PaymentLinks.d.ts +0 -6
- package/types/PaymentLinksResource.d.ts +0 -12
- package/types/PaymentMethodConfigurations.d.ts +0 -180
- package/types/PaymentMethodConfigurationsResource.d.ts +0 -250
- package/types/PaymentMethods.d.ts +7 -99
- package/types/PaymentMethodsResource.d.ts +0 -133
- package/types/Payouts.d.ts +1 -1
- package/types/Persons.d.ts +2 -2
- package/types/Prices.d.ts +0 -22
- package/types/PricesResource.d.ts +0 -22
- package/types/Products.d.ts +0 -39
- package/types/ProductsResource.d.ts +0 -36
- package/types/Quotes.d.ts +1 -591
- package/types/QuotesResource.d.ts +199 -2531
- package/types/Refunds.d.ts +0 -14
- package/types/SetupAttempts.d.ts +0 -38
- package/types/SetupIntents.d.ts +1 -111
- package/types/SetupIntentsResource.d.ts +3 -645
- package/types/Sources.d.ts +7 -23
- package/types/SubscriptionItems.d.ts +0 -21
- package/types/SubscriptionItemsResource.d.ts +0 -109
- package/types/SubscriptionSchedules.d.ts +0 -200
- package/types/SubscriptionSchedulesResource.d.ts +13 -1231
- package/types/Subscriptions.d.ts +1 -91
- package/types/SubscriptionsResource.d.ts +2 -369
- package/types/Tax/Calculations.d.ts +21 -2
- package/types/Tax/CalculationsResource.d.ts +21 -2
- package/types/Tax/Registrations.d.ts +189 -0
- package/types/Tax/RegistrationsResource.d.ts +252 -0
- package/types/Tax/Transactions.d.ts +21 -2
- package/types/TaxIds.d.ts +21 -2
- package/types/TaxIdsResource.d.ts +21 -2
- package/types/Terminal/Readers.d.ts +0 -278
- package/types/Terminal/ReadersResource.d.ts +0 -215
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -104
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
- package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
- package/types/Treasury/FinancialAccounts.d.ts +0 -5
- package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
- package/types/Treasury/OutboundTransfers.d.ts +0 -26
- package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
- package/types/Treasury/ReceivedCredits.d.ts +0 -26
- package/types/Treasury/ReceivedDebits.d.ts +0 -31
- package/types/WebhookEndpointsResource.d.ts +2 -71
- package/types/index.d.ts +0 -62
- package/types/lib.d.ts +1 -1
- package/types/test/typescriptTest.ts +3 -3
- package/cjs/resources/AccountNotices.js +0 -21
- package/cjs/resources/Capital/FinancingOffers.js +0 -21
- package/cjs/resources/Capital/FinancingSummary.js +0 -12
- package/cjs/resources/Capital/FinancingTransactions.js +0 -17
- package/cjs/resources/FinancialConnections/Institutions.js +0 -17
- package/cjs/resources/GiftCards/Cards.js +0 -23
- package/cjs/resources/GiftCards/Transactions.js +0 -33
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
- package/cjs/resources/Margins.js +0 -22
- package/cjs/resources/Orders.js +0 -24
- package/cjs/resources/PaymentAttemptRecords.js +0 -17
- package/cjs/resources/PaymentRecords.js +0 -29
- package/cjs/resources/Tax/Associations.js +0 -9
- package/cjs/resources/Tax/Forms.js +0 -20
- package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
- package/esm/resources/AccountNotices.js +0 -18
- package/esm/resources/Capital/FinancingOffers.js +0 -18
- package/esm/resources/Capital/FinancingSummary.js +0 -9
- package/esm/resources/Capital/FinancingTransactions.js +0 -14
- package/esm/resources/FinancialConnections/Institutions.js +0 -14
- package/esm/resources/GiftCards/Cards.js +0 -20
- package/esm/resources/GiftCards/Transactions.js +0 -30
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
- package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
- package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
- package/esm/resources/Margins.js +0 -19
- package/esm/resources/Orders.js +0 -21
- package/esm/resources/PaymentAttemptRecords.js +0 -14
- package/esm/resources/PaymentRecords.js +0 -26
- package/esm/resources/Tax/Associations.js +0 -6
- package/esm/resources/Tax/Forms.js +0 -17
- package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
- package/types/AccountNotices.d.ts +0 -113
- package/types/AccountNoticesResource.d.ts +0 -98
- package/types/Billing/MeterErrorReports.d.ts +0 -106
- package/types/Capital/FinancingOffers.d.ts +0 -188
- package/types/Capital/FinancingOffersResource.d.ts +0 -97
- package/types/Capital/FinancingSummary.d.ts +0 -106
- package/types/Capital/FinancingSummaryResource.d.ts +0 -27
- package/types/Capital/FinancingTransactions.d.ts +0 -135
- package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
- package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
- package/types/FinancialConnections/Institutions.d.ts +0 -93
- package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
- package/types/GiftCards/Cards.d.ts +0 -118
- package/types/GiftCards/CardsResource.d.ts +0 -159
- package/types/GiftCards/Transactions.d.ts +0 -129
- package/types/GiftCards/TransactionsResource.d.ts +0 -201
- package/types/InvoicePayments.d.ts +0 -113
- package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
- package/types/Issuing/DisputeSettlementDetails.d.ts +0 -73
- package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
- package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
- package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
- package/types/Issuing/Settlements.d.ts +0 -103
- package/types/Margins.d.ts +0 -56
- package/types/MarginsResource.d.ts +0 -114
- package/types/Orders.d.ts +0 -1160
- package/types/OrdersResource.d.ts +0 -2923
- package/types/PaymentAttemptRecords.d.ts +0 -242
- package/types/PaymentAttemptRecordsResource.d.ts +0 -47
- package/types/PaymentRecords.d.ts +0 -259
- package/types/PaymentRecordsResource.d.ts +0 -455
- package/types/QuoteLines.d.ts +0 -634
- package/types/QuotePreviewInvoices.d.ts +0 -1634
- package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -824
- package/types/Tax/Associations.d.ts +0 -126
- package/types/Tax/AssociationsResource.d.ts +0 -29
- package/types/Tax/Forms.d.ts +0 -220
- package/types/Tax/FormsResource.d.ts +0 -107
- package/types/Terminal/ReaderCollectedData.d.ts +0 -51
- package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
package/types/Sources.d.ts
CHANGED
|
@@ -33,6 +33,11 @@ declare module 'stripe' {
|
|
|
33
33
|
|
|
34
34
|
alipay?: Source.Alipay;
|
|
35
35
|
|
|
36
|
+
/**
|
|
37
|
+
* This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
|
|
38
|
+
*/
|
|
39
|
+
allow_redisplay: Source.AllowRedisplay | null;
|
|
40
|
+
|
|
36
41
|
/**
|
|
37
42
|
* A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.
|
|
38
43
|
*/
|
|
@@ -100,8 +105,6 @@ declare module 'stripe' {
|
|
|
100
105
|
|
|
101
106
|
p24?: Source.P24;
|
|
102
107
|
|
|
103
|
-
paypal?: Source.Paypal;
|
|
104
|
-
|
|
105
108
|
receiver?: Source.Receiver;
|
|
106
109
|
|
|
107
110
|
redirect?: Source.Redirect;
|
|
@@ -202,6 +205,8 @@ declare module 'stripe' {
|
|
|
202
205
|
statement_descriptor?: string | null;
|
|
203
206
|
}
|
|
204
207
|
|
|
208
|
+
type AllowRedisplay = 'always' | 'limited' | 'unspecified';
|
|
209
|
+
|
|
205
210
|
interface AuBecsDebit {
|
|
206
211
|
bsb_number?: string | null;
|
|
207
212
|
|
|
@@ -474,26 +479,6 @@ declare module 'stripe' {
|
|
|
474
479
|
reference?: string | null;
|
|
475
480
|
}
|
|
476
481
|
|
|
477
|
-
interface Paypal {
|
|
478
|
-
billing_agreement?: string | null;
|
|
479
|
-
|
|
480
|
-
fingerprint?: string | null;
|
|
481
|
-
|
|
482
|
-
payer_id?: string | null;
|
|
483
|
-
|
|
484
|
-
reference_id?: string;
|
|
485
|
-
|
|
486
|
-
reference_transaction_amount?: string;
|
|
487
|
-
|
|
488
|
-
reference_transaction_charged?: boolean;
|
|
489
|
-
|
|
490
|
-
statement_descriptor?: string | null;
|
|
491
|
-
|
|
492
|
-
transaction_id?: string;
|
|
493
|
-
|
|
494
|
-
verified_email?: string | null;
|
|
495
|
-
}
|
|
496
|
-
|
|
497
482
|
interface Receiver {
|
|
498
483
|
/**
|
|
499
484
|
* The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
|
|
@@ -743,7 +728,6 @@ declare module 'stripe' {
|
|
|
743
728
|
| 'klarna'
|
|
744
729
|
| 'multibanco'
|
|
745
730
|
| 'p24'
|
|
746
|
-
| 'paypal'
|
|
747
731
|
| 'sepa_credit_transfer'
|
|
748
732
|
| 'sepa_debit'
|
|
749
733
|
| 'sofort'
|
|
@@ -98,11 +98,6 @@ declare module 'stripe' {
|
|
|
98
98
|
* The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
|
|
99
99
|
*/
|
|
100
100
|
tax_rates: Array<Stripe.TaxRate> | null;
|
|
101
|
-
|
|
102
|
-
/**
|
|
103
|
-
* Options that configure the trial on the subscription item.
|
|
104
|
-
*/
|
|
105
|
-
trial?: SubscriptionItem.Trial | null;
|
|
106
101
|
}
|
|
107
102
|
|
|
108
103
|
namespace SubscriptionItem {
|
|
@@ -112,22 +107,6 @@ declare module 'stripe' {
|
|
|
112
107
|
*/
|
|
113
108
|
usage_gte: number | null;
|
|
114
109
|
}
|
|
115
|
-
|
|
116
|
-
interface Trial {
|
|
117
|
-
/**
|
|
118
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
119
|
-
*/
|
|
120
|
-
converts_to?: Array<string> | null;
|
|
121
|
-
|
|
122
|
-
/**
|
|
123
|
-
* Determines the type of trial for this item.
|
|
124
|
-
*/
|
|
125
|
-
type: Trial.Type;
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
namespace Trial {
|
|
129
|
-
type Type = 'free' | 'paid';
|
|
130
|
-
}
|
|
131
110
|
}
|
|
132
111
|
}
|
|
133
112
|
}
|
|
@@ -77,11 +77,6 @@ declare module 'stripe' {
|
|
|
77
77
|
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
78
78
|
*/
|
|
79
79
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* Options that configure the trial on the subscription item.
|
|
83
|
-
*/
|
|
84
|
-
trial?: SubscriptionItemCreateParams.Trial;
|
|
85
80
|
}
|
|
86
81
|
|
|
87
82
|
namespace SubscriptionItemCreateParams {
|
|
@@ -103,56 +98,12 @@ declare module 'stripe' {
|
|
|
103
98
|
*/
|
|
104
99
|
discount?: string;
|
|
105
100
|
|
|
106
|
-
/**
|
|
107
|
-
* Details to determine how long the discount should be applied for.
|
|
108
|
-
*/
|
|
109
|
-
discount_end?: Discount.DiscountEnd;
|
|
110
|
-
|
|
111
101
|
/**
|
|
112
102
|
* ID of the promotion code to create a new discount for.
|
|
113
103
|
*/
|
|
114
104
|
promotion_code?: string;
|
|
115
105
|
}
|
|
116
106
|
|
|
117
|
-
namespace Discount {
|
|
118
|
-
interface DiscountEnd {
|
|
119
|
-
/**
|
|
120
|
-
* Time span for the redeemed discount.
|
|
121
|
-
*/
|
|
122
|
-
duration?: DiscountEnd.Duration;
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
126
|
-
*/
|
|
127
|
-
timestamp?: number;
|
|
128
|
-
|
|
129
|
-
/**
|
|
130
|
-
* The type of calculation made to determine when the discount ends.
|
|
131
|
-
*/
|
|
132
|
-
type: DiscountEnd.Type;
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
namespace DiscountEnd {
|
|
136
|
-
interface Duration {
|
|
137
|
-
/**
|
|
138
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
139
|
-
*/
|
|
140
|
-
interval: Duration.Interval;
|
|
141
|
-
|
|
142
|
-
/**
|
|
143
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
144
|
-
*/
|
|
145
|
-
interval_count: number;
|
|
146
|
-
}
|
|
147
|
-
|
|
148
|
-
namespace Duration {
|
|
149
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
type Type = 'duration' | 'timestamp';
|
|
153
|
-
}
|
|
154
|
-
}
|
|
155
|
-
|
|
156
107
|
type PaymentBehavior =
|
|
157
108
|
| 'allow_incomplete'
|
|
158
109
|
| 'default_incomplete'
|
|
@@ -212,22 +163,6 @@ declare module 'stripe' {
|
|
|
212
163
|
}
|
|
213
164
|
|
|
214
165
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
215
|
-
|
|
216
|
-
interface Trial {
|
|
217
|
-
/**
|
|
218
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
|
|
219
|
-
*/
|
|
220
|
-
converts_to?: Array<string>;
|
|
221
|
-
|
|
222
|
-
/**
|
|
223
|
-
* Determines the type of trial for this item.
|
|
224
|
-
*/
|
|
225
|
-
type: Trial.Type;
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
namespace Trial {
|
|
229
|
-
type Type = 'free' | 'paid';
|
|
230
|
-
}
|
|
231
166
|
}
|
|
232
167
|
|
|
233
168
|
interface SubscriptionItemRetrieveParams {
|
|
@@ -333,56 +268,12 @@ declare module 'stripe' {
|
|
|
333
268
|
*/
|
|
334
269
|
discount?: string;
|
|
335
270
|
|
|
336
|
-
/**
|
|
337
|
-
* Details to determine how long the discount should be applied for.
|
|
338
|
-
*/
|
|
339
|
-
discount_end?: Discount.DiscountEnd;
|
|
340
|
-
|
|
341
271
|
/**
|
|
342
272
|
* ID of the promotion code to create a new discount for.
|
|
343
273
|
*/
|
|
344
274
|
promotion_code?: string;
|
|
345
275
|
}
|
|
346
276
|
|
|
347
|
-
namespace Discount {
|
|
348
|
-
interface DiscountEnd {
|
|
349
|
-
/**
|
|
350
|
-
* Time span for the redeemed discount.
|
|
351
|
-
*/
|
|
352
|
-
duration?: DiscountEnd.Duration;
|
|
353
|
-
|
|
354
|
-
/**
|
|
355
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
356
|
-
*/
|
|
357
|
-
timestamp?: number;
|
|
358
|
-
|
|
359
|
-
/**
|
|
360
|
-
* The type of calculation made to determine when the discount ends.
|
|
361
|
-
*/
|
|
362
|
-
type: DiscountEnd.Type;
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
namespace DiscountEnd {
|
|
366
|
-
interface Duration {
|
|
367
|
-
/**
|
|
368
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
369
|
-
*/
|
|
370
|
-
interval: Duration.Interval;
|
|
371
|
-
|
|
372
|
-
/**
|
|
373
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
374
|
-
*/
|
|
375
|
-
interval_count: number;
|
|
376
|
-
}
|
|
377
|
-
|
|
378
|
-
namespace Duration {
|
|
379
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
380
|
-
}
|
|
381
|
-
|
|
382
|
-
type Type = 'duration' | 'timestamp';
|
|
383
|
-
}
|
|
384
|
-
}
|
|
385
|
-
|
|
386
277
|
type PaymentBehavior =
|
|
387
278
|
| 'allow_incomplete'
|
|
388
279
|
| 'default_incomplete'
|
|
@@ -27,11 +27,6 @@ declare module 'stripe' {
|
|
|
27
27
|
| Stripe.DeletedApplication
|
|
28
28
|
| null;
|
|
29
29
|
|
|
30
|
-
/**
|
|
31
|
-
* Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
|
|
32
|
-
*/
|
|
33
|
-
billing_behavior?: SubscriptionSchedule.BillingBehavior;
|
|
34
|
-
|
|
35
30
|
/**
|
|
36
31
|
* Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
|
|
37
32
|
*/
|
|
@@ -64,11 +59,6 @@ declare module 'stripe' {
|
|
|
64
59
|
*/
|
|
65
60
|
end_behavior: SubscriptionSchedule.EndBehavior;
|
|
66
61
|
|
|
67
|
-
/**
|
|
68
|
-
* Details of the most recent price migration that failed for the subscription schedule.
|
|
69
|
-
*/
|
|
70
|
-
last_price_migration_error?: SubscriptionSchedule.LastPriceMigrationError | null;
|
|
71
|
-
|
|
72
62
|
/**
|
|
73
63
|
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
74
64
|
*/
|
|
@@ -84,11 +74,6 @@ declare module 'stripe' {
|
|
|
84
74
|
*/
|
|
85
75
|
phases: Array<SubscriptionSchedule.Phase>;
|
|
86
76
|
|
|
87
|
-
/**
|
|
88
|
-
* Time period and invoice for a Subscription billed in advance.
|
|
89
|
-
*/
|
|
90
|
-
prebilling?: SubscriptionSchedule.Prebilling | null;
|
|
91
|
-
|
|
92
77
|
/**
|
|
93
78
|
* Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
|
|
94
79
|
*/
|
|
@@ -116,8 +101,6 @@ declare module 'stripe' {
|
|
|
116
101
|
}
|
|
117
102
|
|
|
118
103
|
namespace SubscriptionSchedule {
|
|
119
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
120
|
-
|
|
121
104
|
interface CurrentPhase {
|
|
122
105
|
/**
|
|
123
106
|
* The end of this phase of the subscription schedule.
|
|
@@ -277,37 +260,6 @@ declare module 'stripe' {
|
|
|
277
260
|
|
|
278
261
|
type EndBehavior = 'cancel' | 'none' | 'release' | 'renew';
|
|
279
262
|
|
|
280
|
-
interface LastPriceMigrationError {
|
|
281
|
-
/**
|
|
282
|
-
* The time at which the price migration encountered an error.
|
|
283
|
-
*/
|
|
284
|
-
errored_at: number;
|
|
285
|
-
|
|
286
|
-
/**
|
|
287
|
-
* The involved price pairs in each failed transition.
|
|
288
|
-
*/
|
|
289
|
-
failed_transitions: Array<LastPriceMigrationError.FailedTransition>;
|
|
290
|
-
|
|
291
|
-
/**
|
|
292
|
-
* The type of error encountered by the price migration.
|
|
293
|
-
*/
|
|
294
|
-
type: 'price_uniqueness_violation';
|
|
295
|
-
}
|
|
296
|
-
|
|
297
|
-
namespace LastPriceMigrationError {
|
|
298
|
-
interface FailedTransition {
|
|
299
|
-
/**
|
|
300
|
-
* The original price to be migrated.
|
|
301
|
-
*/
|
|
302
|
-
source_price: string;
|
|
303
|
-
|
|
304
|
-
/**
|
|
305
|
-
* The intended resulting price of the migration.
|
|
306
|
-
*/
|
|
307
|
-
target_price: string;
|
|
308
|
-
}
|
|
309
|
-
}
|
|
310
|
-
|
|
311
263
|
interface Phase {
|
|
312
264
|
/**
|
|
313
265
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
|
|
@@ -391,11 +343,6 @@ declare module 'stripe' {
|
|
|
391
343
|
*/
|
|
392
344
|
on_behalf_of: string | Stripe.Account | null;
|
|
393
345
|
|
|
394
|
-
/**
|
|
395
|
-
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
|
396
|
-
*/
|
|
397
|
-
pause_collection?: Phase.PauseCollection | null;
|
|
398
|
-
|
|
399
346
|
/**
|
|
400
347
|
* If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.
|
|
401
348
|
*/
|
|
@@ -411,20 +358,10 @@ declare module 'stripe' {
|
|
|
411
358
|
*/
|
|
412
359
|
transfer_data: Phase.TransferData | null;
|
|
413
360
|
|
|
414
|
-
/**
|
|
415
|
-
* Specify behavior of the trial when crossing schedule phase boundaries
|
|
416
|
-
*/
|
|
417
|
-
trial_continuation?: Phase.TrialContinuation | null;
|
|
418
|
-
|
|
419
361
|
/**
|
|
420
362
|
* When the trial ends within the phase.
|
|
421
363
|
*/
|
|
422
364
|
trial_end: number | null;
|
|
423
|
-
|
|
424
|
-
/**
|
|
425
|
-
* Settings related to any trials on the subscription during this phase.
|
|
426
|
-
*/
|
|
427
|
-
trial_settings?: Phase.TrialSettings | null;
|
|
428
365
|
}
|
|
429
366
|
|
|
430
367
|
namespace Phase {
|
|
@@ -462,30 +399,11 @@ declare module 'stripe' {
|
|
|
462
399
|
*/
|
|
463
400
|
discount: string | Stripe.Discount | null;
|
|
464
401
|
|
|
465
|
-
/**
|
|
466
|
-
* Details to determine how long the discount should be applied for.
|
|
467
|
-
*/
|
|
468
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
469
|
-
|
|
470
402
|
/**
|
|
471
403
|
* ID of the promotion code to create a new discount for.
|
|
472
404
|
*/
|
|
473
405
|
promotion_code: string | Stripe.PromotionCode | null;
|
|
474
406
|
}
|
|
475
|
-
|
|
476
|
-
namespace Discount {
|
|
477
|
-
interface DiscountEnd {
|
|
478
|
-
/**
|
|
479
|
-
* The discount end timestamp.
|
|
480
|
-
*/
|
|
481
|
-
timestamp: number | null;
|
|
482
|
-
|
|
483
|
-
/**
|
|
484
|
-
* The discount end type.
|
|
485
|
-
*/
|
|
486
|
-
type: 'timestamp';
|
|
487
|
-
}
|
|
488
|
-
}
|
|
489
407
|
}
|
|
490
408
|
|
|
491
409
|
interface AutomaticTax {
|
|
@@ -550,31 +468,12 @@ declare module 'stripe' {
|
|
|
550
468
|
*/
|
|
551
469
|
discount: string | Stripe.Discount | null;
|
|
552
470
|
|
|
553
|
-
/**
|
|
554
|
-
* Details to determine how long the discount should be applied for.
|
|
555
|
-
*/
|
|
556
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
557
|
-
|
|
558
471
|
/**
|
|
559
472
|
* ID of the promotion code to create a new discount for.
|
|
560
473
|
*/
|
|
561
474
|
promotion_code: string | Stripe.PromotionCode | null;
|
|
562
475
|
}
|
|
563
476
|
|
|
564
|
-
namespace Discount {
|
|
565
|
-
interface DiscountEnd {
|
|
566
|
-
/**
|
|
567
|
-
* The discount end timestamp.
|
|
568
|
-
*/
|
|
569
|
-
timestamp: number | null;
|
|
570
|
-
|
|
571
|
-
/**
|
|
572
|
-
* The discount end type.
|
|
573
|
-
*/
|
|
574
|
-
type: 'timestamp';
|
|
575
|
-
}
|
|
576
|
-
}
|
|
577
|
-
|
|
578
477
|
interface InvoiceSettings {
|
|
579
478
|
/**
|
|
580
479
|
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
|
@@ -647,11 +546,6 @@ declare module 'stripe' {
|
|
|
647
546
|
* The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
|
|
648
547
|
*/
|
|
649
548
|
tax_rates?: Array<Stripe.TaxRate> | null;
|
|
650
|
-
|
|
651
|
-
/**
|
|
652
|
-
* Options that configure the trial on the subscription item.
|
|
653
|
-
*/
|
|
654
|
-
trial?: Item.Trial | null;
|
|
655
549
|
}
|
|
656
550
|
|
|
657
551
|
namespace Item {
|
|
@@ -673,57 +567,11 @@ declare module 'stripe' {
|
|
|
673
567
|
*/
|
|
674
568
|
discount: string | Stripe.Discount | null;
|
|
675
569
|
|
|
676
|
-
/**
|
|
677
|
-
* Details to determine how long the discount should be applied for.
|
|
678
|
-
*/
|
|
679
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
680
|
-
|
|
681
570
|
/**
|
|
682
571
|
* ID of the promotion code to create a new discount for.
|
|
683
572
|
*/
|
|
684
573
|
promotion_code: string | Stripe.PromotionCode | null;
|
|
685
574
|
}
|
|
686
|
-
|
|
687
|
-
namespace Discount {
|
|
688
|
-
interface DiscountEnd {
|
|
689
|
-
/**
|
|
690
|
-
* The discount end timestamp.
|
|
691
|
-
*/
|
|
692
|
-
timestamp: number | null;
|
|
693
|
-
|
|
694
|
-
/**
|
|
695
|
-
* The discount end type.
|
|
696
|
-
*/
|
|
697
|
-
type: 'timestamp';
|
|
698
|
-
}
|
|
699
|
-
}
|
|
700
|
-
|
|
701
|
-
interface Trial {
|
|
702
|
-
/**
|
|
703
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
704
|
-
*/
|
|
705
|
-
converts_to?: Array<string> | null;
|
|
706
|
-
|
|
707
|
-
/**
|
|
708
|
-
* Determines the type of trial for this item.
|
|
709
|
-
*/
|
|
710
|
-
type: Trial.Type;
|
|
711
|
-
}
|
|
712
|
-
|
|
713
|
-
namespace Trial {
|
|
714
|
-
type Type = 'free' | 'paid';
|
|
715
|
-
}
|
|
716
|
-
}
|
|
717
|
-
|
|
718
|
-
interface PauseCollection {
|
|
719
|
-
/**
|
|
720
|
-
* The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
|
721
|
-
*/
|
|
722
|
-
behavior: PauseCollection.Behavior;
|
|
723
|
-
}
|
|
724
|
-
|
|
725
|
-
namespace PauseCollection {
|
|
726
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
727
575
|
}
|
|
728
576
|
|
|
729
577
|
type ProrationBehavior =
|
|
@@ -742,54 +590,6 @@ declare module 'stripe' {
|
|
|
742
590
|
*/
|
|
743
591
|
destination: string | Stripe.Account;
|
|
744
592
|
}
|
|
745
|
-
|
|
746
|
-
type TrialContinuation = 'continue' | 'none';
|
|
747
|
-
|
|
748
|
-
interface TrialSettings {
|
|
749
|
-
/**
|
|
750
|
-
* Defines how the subscription should behave when a trial ends.
|
|
751
|
-
*/
|
|
752
|
-
end_behavior: TrialSettings.EndBehavior | null;
|
|
753
|
-
}
|
|
754
|
-
|
|
755
|
-
namespace TrialSettings {
|
|
756
|
-
interface EndBehavior {
|
|
757
|
-
/**
|
|
758
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
759
|
-
*/
|
|
760
|
-
prorate_up_front: EndBehavior.ProrateUpFront | null;
|
|
761
|
-
}
|
|
762
|
-
|
|
763
|
-
namespace EndBehavior {
|
|
764
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
765
|
-
}
|
|
766
|
-
}
|
|
767
|
-
}
|
|
768
|
-
|
|
769
|
-
interface Prebilling {
|
|
770
|
-
/**
|
|
771
|
-
* ID of the prebilling invoice.
|
|
772
|
-
*/
|
|
773
|
-
invoice: string | Stripe.Invoice;
|
|
774
|
-
|
|
775
|
-
/**
|
|
776
|
-
* The end of the last period for which the invoice pre-bills.
|
|
777
|
-
*/
|
|
778
|
-
period_end: number;
|
|
779
|
-
|
|
780
|
-
/**
|
|
781
|
-
* The start of the first period for which the invoice pre-bills.
|
|
782
|
-
*/
|
|
783
|
-
period_start: number;
|
|
784
|
-
|
|
785
|
-
/**
|
|
786
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
|
787
|
-
*/
|
|
788
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
789
|
-
}
|
|
790
|
-
|
|
791
|
-
namespace Prebilling {
|
|
792
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
793
593
|
}
|
|
794
594
|
|
|
795
595
|
type Status =
|