stripe 8.191.0 → 8.195.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 +30 -0
- package/README.md +0 -1
- package/VERSION +1 -1
- package/package.json +1 -2
- package/types/2020-08-27/BillingPortal/Configurations.d.ts +15 -0
- package/types/2020-08-27/Capabilities.d.ts +1 -1
- package/types/2020-08-27/Charges.d.ts +1 -1
- package/types/2020-08-27/Checkout/Sessions.d.ts +3 -1
- package/types/2020-08-27/Customers.d.ts +4 -2
- package/types/2020-08-27/Discounts.d.ts +2 -2
- package/types/2020-08-27/InvoiceLineItems.d.ts +4 -2
- package/types/2020-08-27/Invoices.d.ts +8 -4
- package/types/2020-08-27/Issuing/Cardholders.d.ts +1 -1
- package/types/2020-08-27/PaymentIntents.d.ts +133 -3
- package/types/2020-08-27/PaymentMethods.d.ts +2 -2
- package/types/2020-08-27/Persons.d.ts +3 -3
- package/types/2020-08-27/PromotionCodes.d.ts +2 -2
- package/types/2020-08-27/SetupAttempts.d.ts +4 -0
- package/types/2020-08-27/Subscriptions.d.ts +5 -5
- package/types/2020-08-27/TaxIds.d.ts +6 -2
- package/types/2020-08-27/Terminal/Locations.d.ts +1 -0
- package/types/2020-08-27/Terminal/Readers.d.ts +1 -1
- package/types/2020-08-27/Tokens.d.ts +1 -1
- package/types/lib.d.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
|
+
## 8.195.0 - 2021-12-22
|
|
4
|
+
* [#1314](https://github.com/stripe/stripe-node/pull/1314) API Updates
|
|
5
|
+
* Add support for `au_becs_debit` on `PaymentIntentCreateParams.payment_method_options`, `PaymentIntentUpdateParams.payment_method_options`, `PaymentIntentConfirmParams.payment_method_options`, and `PaymentIntent.payment_method_options`
|
|
6
|
+
* Change type of `PaymentIntent.processing.type` from `string` to `literal('card')`. This is not considered a breaking change as the field was added in the same release.
|
|
7
|
+
* [#1313](https://github.com/stripe/stripe-node/pull/1313) API Updates
|
|
8
|
+
* Add support for new values `en-FR`, `es-US`, and `fr-FR` on enums `PaymentIntentCreateParams.payment_method_options.klarna.preferred_locale`, `PaymentIntentUpdateParams.payment_method_options.klarna.preferred_locale`, and `PaymentIntentConfirmParams.payment_method_options.klarna.preferred_locale`
|
|
9
|
+
* Add support for `boleto` on `SetupAttempt.payment_method_details`
|
|
10
|
+
|
|
11
|
+
* [#1312](https://github.com/stripe/stripe-node/pull/1312) API Updates
|
|
12
|
+
* Add support for `processing` on `PaymentIntent`
|
|
13
|
+
|
|
14
|
+
## 8.194.0 - 2021-12-15
|
|
15
|
+
* [#1309](https://github.com/stripe/stripe-node/pull/1309) API Updates
|
|
16
|
+
* Add support for new resource `PaymentIntentTypeSpecificPaymentMethodOptionsClient`
|
|
17
|
+
* Add support for `setup_future_usage` on `PaymentIntentCreateParams.payment_method_options.card`, `PaymentIntentUpdateParams.payment_method_options.card`, `PaymentIntentConfirmParams.payment_method_options.card`, and `PaymentIntent.payment_method_options.card`
|
|
18
|
+
|
|
19
|
+
## 8.193.0 - 2021-12-09
|
|
20
|
+
* [#1308](https://github.com/stripe/stripe-node/pull/1308) API Updates
|
|
21
|
+
* Add support for `metadata` on `BillingPortalConfigurationCreateParams`, `BillingPortalConfigurationUpdateParams`, and `BillingPortal.Configuration`
|
|
22
|
+
|
|
23
|
+
## 8.192.0 - 2021-12-09
|
|
24
|
+
* [#1307](https://github.com/stripe/stripe-node/pull/1307) API Updates
|
|
25
|
+
* Add support for new values `ge_vat` and `ua_vat` on enums `Checkout.Session.customer_details.tax_ids[].type`, `Invoice.customer_tax_ids[].type`, and `TaxId.type`
|
|
26
|
+
* Add support for new values `ge_vat` and `ua_vat` on enums `CustomerCreateParams.tax_id_data[].type`, `InvoiceUpcomingParams.customer_details.tax_ids[].type`, `InvoiceUpcomingLinesParams.customer_details.tax_ids[].type`, and `TaxIdCreateParams.type`
|
|
27
|
+
* Change type of `PaymentIntentCreateParams.payment_method_data.billing_details.email`, `PaymentIntentUpdateParams.payment_method_data.billing_details.email`, `PaymentIntentConfirmParams.payment_method_data.billing_details.email`, `PaymentMethodCreateParams.billing_details.email`, and `PaymentMethodUpdateParams.billing_details.email` from `string` to `emptyStringable(string)`
|
|
28
|
+
* Add support for `giropay` on `PaymentIntentCreateParams.payment_method_options`, `PaymentIntentUpdateParams.payment_method_options`, `PaymentIntentConfirmParams.payment_method_options`, and `PaymentIntent.payment_method_options`
|
|
29
|
+
* Add support for new value `en-IE` on enums `PaymentIntentCreateParams.payment_method_options.klarna.preferred_locale`, `PaymentIntentUpdateParams.payment_method_options.klarna.preferred_locale`, and `PaymentIntentConfirmParams.payment_method_options.klarna.preferred_locale`
|
|
30
|
+
* [#1301](https://github.com/stripe/stripe-node/pull/1301) Remove coveralls from package.json
|
|
31
|
+
* [#1300](https://github.com/stripe/stripe-node/pull/1300) Fix broken link in docstring
|
|
32
|
+
|
|
3
33
|
## 8.191.0 - 2021-11-19
|
|
4
34
|
* [#1299](https://github.com/stripe/stripe-node/pull/1299) API Updates
|
|
5
35
|
* Add support for `wallets` on `Issuing.Card`
|
package/README.md
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.org/package/stripe)
|
|
4
4
|
[](https://travis-ci.org/stripe/stripe-node)
|
|
5
|
-
[](https://coveralls.io/github/stripe/stripe-node)
|
|
6
5
|
[](https://www.npmjs.com/package/stripe)
|
|
7
6
|
[](https://runkit.com/npm/stripe)
|
|
8
7
|
|
package/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
8.
|
|
1
|
+
8.195.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "stripe",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.195.0",
|
|
4
4
|
"description": "Stripe API wrapper",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"stripe",
|
|
@@ -31,7 +31,6 @@
|
|
|
31
31
|
"@typescript-eslint/parser": "^2.13.0",
|
|
32
32
|
"chai": "~4.2.0",
|
|
33
33
|
"chai-as-promised": "~7.1.1",
|
|
34
|
-
"coveralls": "^3.0.0",
|
|
35
34
|
"eslint": "^6.8.0",
|
|
36
35
|
"eslint-config-prettier": "^4.1.0",
|
|
37
36
|
"eslint-plugin-chai-friendly": "^0.4.0",
|
|
@@ -51,6 +51,11 @@ declare module 'stripe' {
|
|
|
51
51
|
*/
|
|
52
52
|
livemode: boolean;
|
|
53
53
|
|
|
54
|
+
/**
|
|
55
|
+
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
56
|
+
*/
|
|
57
|
+
metadata: Stripe.Metadata | null;
|
|
58
|
+
|
|
54
59
|
/**
|
|
55
60
|
* Time at which the object was last updated. Measured in seconds since the Unix epoch.
|
|
56
61
|
*/
|
|
@@ -251,6 +256,11 @@ declare module 'stripe' {
|
|
|
251
256
|
* Specifies which fields in the response should be expanded.
|
|
252
257
|
*/
|
|
253
258
|
expand?: Array<string>;
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
262
|
+
*/
|
|
263
|
+
metadata?: Stripe.MetadataParam;
|
|
254
264
|
}
|
|
255
265
|
|
|
256
266
|
namespace ConfigurationCreateParams {
|
|
@@ -482,6 +492,11 @@ declare module 'stripe' {
|
|
|
482
492
|
* Information about the features available in the portal.
|
|
483
493
|
*/
|
|
484
494
|
features?: ConfigurationUpdateParams.Features;
|
|
495
|
+
|
|
496
|
+
/**
|
|
497
|
+
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
498
|
+
*/
|
|
499
|
+
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
485
500
|
}
|
|
486
501
|
|
|
487
502
|
namespace ConfigurationUpdateParams {
|
|
@@ -187,7 +187,7 @@ declare module 'stripe' {
|
|
|
187
187
|
*
|
|
188
188
|
* - [Afterpay Clearpay's terms of service](https://stripe.com/afterpay-clearpay/legal#restricted-businesses)
|
|
189
189
|
*
|
|
190
|
-
* If you believe that the rejection is in error, please contact support
|
|
190
|
+
* If you believe that the rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance.
|
|
191
191
|
*/
|
|
192
192
|
disabled_reason: string | null;
|
|
193
193
|
|
|
@@ -1419,7 +1419,7 @@ declare module 'stripe' {
|
|
|
1419
1419
|
|
|
1420
1420
|
/**
|
|
1421
1421
|
* Preferred language of the Klarna authorization page that the customer is redirected to.
|
|
1422
|
-
* Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `fr-FR`, or `en-FR`
|
|
1422
|
+
* Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, or `en-FR`
|
|
1423
1423
|
*/
|
|
1424
1424
|
preferred_locale: string | null;
|
|
1425
1425
|
}
|
|
@@ -317,7 +317,7 @@ declare module 'stripe' {
|
|
|
317
317
|
|
|
318
318
|
interface TaxId {
|
|
319
319
|
/**
|
|
320
|
-
* The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, or `unknown`
|
|
320
|
+
* The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, or `unknown`
|
|
321
321
|
*/
|
|
322
322
|
type: TaxId.Type;
|
|
323
323
|
|
|
@@ -345,6 +345,7 @@ declare module 'stripe' {
|
|
|
345
345
|
| 'es_cif'
|
|
346
346
|
| 'eu_vat'
|
|
347
347
|
| 'gb_vat'
|
|
348
|
+
| 'ge_vat'
|
|
348
349
|
| 'hk_br'
|
|
349
350
|
| 'id_npwp'
|
|
350
351
|
| 'il_vat'
|
|
@@ -366,6 +367,7 @@ declare module 'stripe' {
|
|
|
366
367
|
| 'sg_uen'
|
|
367
368
|
| 'th_vat'
|
|
368
369
|
| 'tw_vat'
|
|
370
|
+
| 'ua_vat'
|
|
369
371
|
| 'unknown'
|
|
370
372
|
| 'us_ein'
|
|
371
373
|
| 'za_vat';
|
|
@@ -420,7 +420,7 @@ declare module 'stripe' {
|
|
|
420
420
|
|
|
421
421
|
interface TaxIdDatum {
|
|
422
422
|
/**
|
|
423
|
-
* Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`
|
|
423
|
+
* Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
|
|
424
424
|
*/
|
|
425
425
|
type: TaxIdDatum.Type;
|
|
426
426
|
|
|
@@ -448,6 +448,7 @@ declare module 'stripe' {
|
|
|
448
448
|
| 'es_cif'
|
|
449
449
|
| 'eu_vat'
|
|
450
450
|
| 'gb_vat'
|
|
451
|
+
| 'ge_vat'
|
|
451
452
|
| 'hk_br'
|
|
452
453
|
| 'id_npwp'
|
|
453
454
|
| 'il_vat'
|
|
@@ -469,6 +470,7 @@ declare module 'stripe' {
|
|
|
469
470
|
| 'sg_uen'
|
|
470
471
|
| 'th_vat'
|
|
471
472
|
| 'tw_vat'
|
|
473
|
+
| 'ua_vat'
|
|
472
474
|
| 'us_ein'
|
|
473
475
|
| 'za_vat';
|
|
474
476
|
}
|
|
@@ -713,7 +715,7 @@ declare module 'stripe' {
|
|
|
713
715
|
): Promise<Stripe.Response<Stripe.Customer>>;
|
|
714
716
|
|
|
715
717
|
/**
|
|
716
|
-
* Retrieves
|
|
718
|
+
* Retrieves a Customer object.
|
|
717
719
|
*/
|
|
718
720
|
retrieve(
|
|
719
721
|
id: string,
|
|
@@ -24,7 +24,7 @@ declare module 'stripe' {
|
|
|
24
24
|
/**
|
|
25
25
|
* A coupon contains information about a percent-off or amount-off discount you
|
|
26
26
|
* might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or
|
|
27
|
-
* [orders](https://stripe.com/docs/api#
|
|
27
|
+
* [orders](https://stripe.com/docs/api#create_order_legacy-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge).
|
|
28
28
|
*/
|
|
29
29
|
coupon: Stripe.Coupon;
|
|
30
30
|
|
|
@@ -88,7 +88,7 @@ declare module 'stripe' {
|
|
|
88
88
|
/**
|
|
89
89
|
* A coupon contains information about a percent-off or amount-off discount you
|
|
90
90
|
* might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or
|
|
91
|
-
* [orders](https://stripe.com/docs/api#
|
|
91
|
+
* [orders](https://stripe.com/docs/api#create_order_legacy-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge).
|
|
92
92
|
*/
|
|
93
93
|
coupon: Stripe.Coupon;
|
|
94
94
|
|
|
@@ -268,7 +268,7 @@ declare module 'stripe' {
|
|
|
268
268
|
subscription_trial_end?: 'now' | number;
|
|
269
269
|
|
|
270
270
|
/**
|
|
271
|
-
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](docs/billing/subscriptions/trials) to learn more.
|
|
271
|
+
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
|
272
272
|
*/
|
|
273
273
|
subscription_trial_from_plan?: boolean;
|
|
274
274
|
}
|
|
@@ -347,7 +347,7 @@ declare module 'stripe' {
|
|
|
347
347
|
|
|
348
348
|
interface TaxId {
|
|
349
349
|
/**
|
|
350
|
-
* Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`
|
|
350
|
+
* Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
|
|
351
351
|
*/
|
|
352
352
|
type: TaxId.Type;
|
|
353
353
|
|
|
@@ -375,6 +375,7 @@ declare module 'stripe' {
|
|
|
375
375
|
| 'es_cif'
|
|
376
376
|
| 'eu_vat'
|
|
377
377
|
| 'gb_vat'
|
|
378
|
+
| 'ge_vat'
|
|
378
379
|
| 'hk_br'
|
|
379
380
|
| 'id_npwp'
|
|
380
381
|
| 'il_vat'
|
|
@@ -396,6 +397,7 @@ declare module 'stripe' {
|
|
|
396
397
|
| 'sg_uen'
|
|
397
398
|
| 'th_vat'
|
|
398
399
|
| 'tw_vat'
|
|
400
|
+
| 'ua_vat'
|
|
399
401
|
| 'us_ein'
|
|
400
402
|
| 'za_vat';
|
|
401
403
|
}
|
|
@@ -399,7 +399,7 @@ declare module 'stripe' {
|
|
|
399
399
|
|
|
400
400
|
interface CustomerTaxId {
|
|
401
401
|
/**
|
|
402
|
-
* The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, or `unknown`
|
|
402
|
+
* The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, or `unknown`
|
|
403
403
|
*/
|
|
404
404
|
type: CustomerTaxId.Type;
|
|
405
405
|
|
|
@@ -427,6 +427,7 @@ declare module 'stripe' {
|
|
|
427
427
|
| 'es_cif'
|
|
428
428
|
| 'eu_vat'
|
|
429
429
|
| 'gb_vat'
|
|
430
|
+
| 'ge_vat'
|
|
430
431
|
| 'hk_br'
|
|
431
432
|
| 'id_npwp'
|
|
432
433
|
| 'il_vat'
|
|
@@ -448,6 +449,7 @@ declare module 'stripe' {
|
|
|
448
449
|
| 'sg_uen'
|
|
449
450
|
| 'th_vat'
|
|
450
451
|
| 'tw_vat'
|
|
452
|
+
| 'ua_vat'
|
|
451
453
|
| 'unknown'
|
|
452
454
|
| 'us_ein'
|
|
453
455
|
| 'za_vat';
|
|
@@ -1339,7 +1341,7 @@ declare module 'stripe' {
|
|
|
1339
1341
|
|
|
1340
1342
|
interface InvoiceFinalizeInvoiceParams {
|
|
1341
1343
|
/**
|
|
1342
|
-
* Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/
|
|
1344
|
+
* Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/invoicing/automatic-charging) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.
|
|
1343
1345
|
*/
|
|
1344
1346
|
auto_advance?: boolean;
|
|
1345
1347
|
|
|
@@ -1497,7 +1499,7 @@ declare module 'stripe' {
|
|
|
1497
1499
|
subscription_trial_end?: 'now' | number;
|
|
1498
1500
|
|
|
1499
1501
|
/**
|
|
1500
|
-
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](docs/billing/subscriptions/trials) to learn more.
|
|
1502
|
+
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
|
1501
1503
|
*/
|
|
1502
1504
|
subscription_trial_from_plan?: boolean;
|
|
1503
1505
|
}
|
|
@@ -1576,7 +1578,7 @@ declare module 'stripe' {
|
|
|
1576
1578
|
|
|
1577
1579
|
interface TaxId {
|
|
1578
1580
|
/**
|
|
1579
|
-
* Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`
|
|
1581
|
+
* Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
|
|
1580
1582
|
*/
|
|
1581
1583
|
type: TaxId.Type;
|
|
1582
1584
|
|
|
@@ -1604,6 +1606,7 @@ declare module 'stripe' {
|
|
|
1604
1606
|
| 'es_cif'
|
|
1605
1607
|
| 'eu_vat'
|
|
1606
1608
|
| 'gb_vat'
|
|
1609
|
+
| 'ge_vat'
|
|
1607
1610
|
| 'hk_br'
|
|
1608
1611
|
| 'id_npwp'
|
|
1609
1612
|
| 'il_vat'
|
|
@@ -1625,6 +1628,7 @@ declare module 'stripe' {
|
|
|
1625
1628
|
| 'sg_uen'
|
|
1626
1629
|
| 'th_vat'
|
|
1627
1630
|
| 'tw_vat'
|
|
1631
|
+
| 'ua_vat'
|
|
1628
1632
|
| 'us_ein'
|
|
1629
1633
|
| 'za_vat';
|
|
1630
1634
|
}
|
|
@@ -1109,7 +1109,7 @@ declare module 'stripe' {
|
|
|
1109
1109
|
billing: CardholderCreateParams.Billing;
|
|
1110
1110
|
|
|
1111
1111
|
/**
|
|
1112
|
-
* The cardholder's name. This will be printed on cards issued to them.
|
|
1112
|
+
* The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters.
|
|
1113
1113
|
*/
|
|
1114
1114
|
name: string;
|
|
1115
1115
|
|
|
@@ -146,6 +146,11 @@ declare module 'stripe' {
|
|
|
146
146
|
*/
|
|
147
147
|
payment_method_types: Array<string>;
|
|
148
148
|
|
|
149
|
+
/**
|
|
150
|
+
* If present, this property tells you about the processing state of the payment.
|
|
151
|
+
*/
|
|
152
|
+
processing: PaymentIntent.Processing | null;
|
|
153
|
+
|
|
149
154
|
/**
|
|
150
155
|
* Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
|
|
151
156
|
*/
|
|
@@ -511,6 +516,8 @@ declare module 'stripe' {
|
|
|
511
516
|
|
|
512
517
|
alipay?: PaymentMethodOptions.Alipay;
|
|
513
518
|
|
|
519
|
+
au_becs_debit?: PaymentMethodOptions.AuBecsDebit;
|
|
520
|
+
|
|
514
521
|
bancontact?: PaymentMethodOptions.Bancontact;
|
|
515
522
|
|
|
516
523
|
boleto?: PaymentMethodOptions.Boleto;
|
|
@@ -519,6 +526,8 @@ declare module 'stripe' {
|
|
|
519
526
|
|
|
520
527
|
card_present?: PaymentMethodOptions.CardPresent;
|
|
521
528
|
|
|
529
|
+
giropay?: PaymentMethodOptions.Giropay;
|
|
530
|
+
|
|
522
531
|
ideal?: PaymentMethodOptions.Ideal;
|
|
523
532
|
|
|
524
533
|
interac_present?: PaymentMethodOptions.InteracPresent;
|
|
@@ -588,6 +597,8 @@ declare module 'stripe' {
|
|
|
588
597
|
|
|
589
598
|
interface Alipay {}
|
|
590
599
|
|
|
600
|
+
interface AuBecsDebit {}
|
|
601
|
+
|
|
591
602
|
interface Bancontact {
|
|
592
603
|
/**
|
|
593
604
|
* Preferred language of the Bancontact authorization page that the customer is redirected to.
|
|
@@ -623,6 +634,15 @@ declare module 'stripe' {
|
|
|
623
634
|
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
624
635
|
*/
|
|
625
636
|
request_three_d_secure: Card.RequestThreeDSecure | null;
|
|
637
|
+
|
|
638
|
+
/**
|
|
639
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
640
|
+
*
|
|
641
|
+
* Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
|
|
642
|
+
*
|
|
643
|
+
* When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
|
|
644
|
+
*/
|
|
645
|
+
setup_future_usage?: Card.SetupFutureUsage;
|
|
626
646
|
}
|
|
627
647
|
|
|
628
648
|
namespace Card {
|
|
@@ -694,10 +714,14 @@ declare module 'stripe' {
|
|
|
694
714
|
| 'visa';
|
|
695
715
|
|
|
696
716
|
type RequestThreeDSecure = 'any' | 'automatic' | 'challenge_only';
|
|
717
|
+
|
|
718
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
697
719
|
}
|
|
698
720
|
|
|
699
721
|
interface CardPresent {}
|
|
700
722
|
|
|
723
|
+
interface Giropay {}
|
|
724
|
+
|
|
701
725
|
interface Ideal {}
|
|
702
726
|
|
|
703
727
|
interface InteracPresent {}
|
|
@@ -761,6 +785,19 @@ declare module 'stripe' {
|
|
|
761
785
|
}
|
|
762
786
|
}
|
|
763
787
|
|
|
788
|
+
interface Processing {
|
|
789
|
+
card?: Processing.Card;
|
|
790
|
+
|
|
791
|
+
/**
|
|
792
|
+
* Type of the payment method for which payment is in `processing` state, one of `card`.
|
|
793
|
+
*/
|
|
794
|
+
type: 'card';
|
|
795
|
+
}
|
|
796
|
+
|
|
797
|
+
namespace Processing {
|
|
798
|
+
interface Card {}
|
|
799
|
+
}
|
|
800
|
+
|
|
764
801
|
type SetupFutureUsage = 'off_session' | 'on_session';
|
|
765
802
|
|
|
766
803
|
interface Shipping {
|
|
@@ -1200,7 +1237,7 @@ declare module 'stripe' {
|
|
|
1200
1237
|
/**
|
|
1201
1238
|
* Email address.
|
|
1202
1239
|
*/
|
|
1203
|
-
email?: string
|
|
1240
|
+
email?: Stripe.Emptyable<string>;
|
|
1204
1241
|
|
|
1205
1242
|
/**
|
|
1206
1243
|
* Full name.
|
|
@@ -1456,6 +1493,11 @@ declare module 'stripe' {
|
|
|
1456
1493
|
*/
|
|
1457
1494
|
alipay?: Stripe.Emptyable<PaymentMethodOptions.Alipay>;
|
|
1458
1495
|
|
|
1496
|
+
/**
|
|
1497
|
+
* If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
|
|
1498
|
+
*/
|
|
1499
|
+
au_becs_debit?: Stripe.Emptyable<PaymentMethodOptions.AuBecsDebit>;
|
|
1500
|
+
|
|
1459
1501
|
/**
|
|
1460
1502
|
* If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
|
|
1461
1503
|
*/
|
|
@@ -1476,6 +1518,11 @@ declare module 'stripe' {
|
|
|
1476
1518
|
*/
|
|
1477
1519
|
card_present?: Stripe.Emptyable<PaymentMethodOptions.CardPresent>;
|
|
1478
1520
|
|
|
1521
|
+
/**
|
|
1522
|
+
* If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
|
|
1523
|
+
*/
|
|
1524
|
+
giropay?: Stripe.Emptyable<PaymentMethodOptions.Giropay>;
|
|
1525
|
+
|
|
1479
1526
|
/**
|
|
1480
1527
|
* If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
|
|
1481
1528
|
*/
|
|
@@ -1574,6 +1621,8 @@ declare module 'stripe' {
|
|
|
1574
1621
|
|
|
1575
1622
|
interface Alipay {}
|
|
1576
1623
|
|
|
1624
|
+
interface AuBecsDebit {}
|
|
1625
|
+
|
|
1577
1626
|
interface Bancontact {
|
|
1578
1627
|
/**
|
|
1579
1628
|
* Preferred language of the Bancontact authorization page that the customer is redirected to.
|
|
@@ -1621,6 +1670,17 @@ declare module 'stripe' {
|
|
|
1621
1670
|
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
1622
1671
|
*/
|
|
1623
1672
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
1673
|
+
|
|
1674
|
+
/**
|
|
1675
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1676
|
+
*
|
|
1677
|
+
* Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
|
|
1678
|
+
*
|
|
1679
|
+
* When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
|
|
1680
|
+
*
|
|
1681
|
+
* If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
|
|
1682
|
+
*/
|
|
1683
|
+
setup_future_usage?: Stripe.Emptyable<Card.SetupFutureUsage>;
|
|
1624
1684
|
}
|
|
1625
1685
|
|
|
1626
1686
|
namespace Card {
|
|
@@ -1672,10 +1732,14 @@ declare module 'stripe' {
|
|
|
1672
1732
|
| 'visa';
|
|
1673
1733
|
|
|
1674
1734
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
1735
|
+
|
|
1736
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1675
1737
|
}
|
|
1676
1738
|
|
|
1677
1739
|
interface CardPresent {}
|
|
1678
1740
|
|
|
1741
|
+
interface Giropay {}
|
|
1742
|
+
|
|
1679
1743
|
interface Ideal {}
|
|
1680
1744
|
|
|
1681
1745
|
interface InteracPresent {}
|
|
@@ -1698,15 +1762,19 @@ declare module 'stripe' {
|
|
|
1698
1762
|
| 'en-DK'
|
|
1699
1763
|
| 'en-ES'
|
|
1700
1764
|
| 'en-FI'
|
|
1765
|
+
| 'en-FR'
|
|
1701
1766
|
| 'en-GB'
|
|
1767
|
+
| 'en-IE'
|
|
1702
1768
|
| 'en-IT'
|
|
1703
1769
|
| 'en-NL'
|
|
1704
1770
|
| 'en-NO'
|
|
1705
1771
|
| 'en-SE'
|
|
1706
1772
|
| 'en-US'
|
|
1707
1773
|
| 'es-ES'
|
|
1774
|
+
| 'es-US'
|
|
1708
1775
|
| 'fi-FI'
|
|
1709
1776
|
| 'fr-BE'
|
|
1777
|
+
| 'fr-FR'
|
|
1710
1778
|
| 'it-IT'
|
|
1711
1779
|
| 'nb-NO'
|
|
1712
1780
|
| 'nl-BE'
|
|
@@ -2120,7 +2188,7 @@ declare module 'stripe' {
|
|
|
2120
2188
|
/**
|
|
2121
2189
|
* Email address.
|
|
2122
2190
|
*/
|
|
2123
|
-
email?: string
|
|
2191
|
+
email?: Stripe.Emptyable<string>;
|
|
2124
2192
|
|
|
2125
2193
|
/**
|
|
2126
2194
|
* Full name.
|
|
@@ -2376,6 +2444,11 @@ declare module 'stripe' {
|
|
|
2376
2444
|
*/
|
|
2377
2445
|
alipay?: Stripe.Emptyable<PaymentMethodOptions.Alipay>;
|
|
2378
2446
|
|
|
2447
|
+
/**
|
|
2448
|
+
* If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
|
|
2449
|
+
*/
|
|
2450
|
+
au_becs_debit?: Stripe.Emptyable<PaymentMethodOptions.AuBecsDebit>;
|
|
2451
|
+
|
|
2379
2452
|
/**
|
|
2380
2453
|
* If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
|
|
2381
2454
|
*/
|
|
@@ -2396,6 +2469,11 @@ declare module 'stripe' {
|
|
|
2396
2469
|
*/
|
|
2397
2470
|
card_present?: Stripe.Emptyable<PaymentMethodOptions.CardPresent>;
|
|
2398
2471
|
|
|
2472
|
+
/**
|
|
2473
|
+
* If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
|
|
2474
|
+
*/
|
|
2475
|
+
giropay?: Stripe.Emptyable<PaymentMethodOptions.Giropay>;
|
|
2476
|
+
|
|
2399
2477
|
/**
|
|
2400
2478
|
* If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
|
|
2401
2479
|
*/
|
|
@@ -2494,6 +2572,8 @@ declare module 'stripe' {
|
|
|
2494
2572
|
|
|
2495
2573
|
interface Alipay {}
|
|
2496
2574
|
|
|
2575
|
+
interface AuBecsDebit {}
|
|
2576
|
+
|
|
2497
2577
|
interface Bancontact {
|
|
2498
2578
|
/**
|
|
2499
2579
|
* Preferred language of the Bancontact authorization page that the customer is redirected to.
|
|
@@ -2541,6 +2621,17 @@ declare module 'stripe' {
|
|
|
2541
2621
|
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
2542
2622
|
*/
|
|
2543
2623
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
2624
|
+
|
|
2625
|
+
/**
|
|
2626
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
2627
|
+
*
|
|
2628
|
+
* Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
|
|
2629
|
+
*
|
|
2630
|
+
* When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
|
|
2631
|
+
*
|
|
2632
|
+
* If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
|
|
2633
|
+
*/
|
|
2634
|
+
setup_future_usage?: Stripe.Emptyable<Card.SetupFutureUsage>;
|
|
2544
2635
|
}
|
|
2545
2636
|
|
|
2546
2637
|
namespace Card {
|
|
@@ -2592,10 +2683,14 @@ declare module 'stripe' {
|
|
|
2592
2683
|
| 'visa';
|
|
2593
2684
|
|
|
2594
2685
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
2686
|
+
|
|
2687
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
2595
2688
|
}
|
|
2596
2689
|
|
|
2597
2690
|
interface CardPresent {}
|
|
2598
2691
|
|
|
2692
|
+
interface Giropay {}
|
|
2693
|
+
|
|
2599
2694
|
interface Ideal {}
|
|
2600
2695
|
|
|
2601
2696
|
interface InteracPresent {}
|
|
@@ -2618,15 +2713,19 @@ declare module 'stripe' {
|
|
|
2618
2713
|
| 'en-DK'
|
|
2619
2714
|
| 'en-ES'
|
|
2620
2715
|
| 'en-FI'
|
|
2716
|
+
| 'en-FR'
|
|
2621
2717
|
| 'en-GB'
|
|
2718
|
+
| 'en-IE'
|
|
2622
2719
|
| 'en-IT'
|
|
2623
2720
|
| 'en-NL'
|
|
2624
2721
|
| 'en-NO'
|
|
2625
2722
|
| 'en-SE'
|
|
2626
2723
|
| 'en-US'
|
|
2627
2724
|
| 'es-ES'
|
|
2725
|
+
| 'es-US'
|
|
2628
2726
|
| 'fi-FI'
|
|
2629
2727
|
| 'fr-BE'
|
|
2728
|
+
| 'fr-FR'
|
|
2630
2729
|
| 'it-IT'
|
|
2631
2730
|
| 'nb-NO'
|
|
2632
2731
|
| 'nl-BE'
|
|
@@ -3154,7 +3253,7 @@ declare module 'stripe' {
|
|
|
3154
3253
|
/**
|
|
3155
3254
|
* Email address.
|
|
3156
3255
|
*/
|
|
3157
|
-
email?: string
|
|
3256
|
+
email?: Stripe.Emptyable<string>;
|
|
3158
3257
|
|
|
3159
3258
|
/**
|
|
3160
3259
|
* Full name.
|
|
@@ -3410,6 +3509,11 @@ declare module 'stripe' {
|
|
|
3410
3509
|
*/
|
|
3411
3510
|
alipay?: Stripe.Emptyable<PaymentMethodOptions.Alipay>;
|
|
3412
3511
|
|
|
3512
|
+
/**
|
|
3513
|
+
* If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
|
|
3514
|
+
*/
|
|
3515
|
+
au_becs_debit?: Stripe.Emptyable<PaymentMethodOptions.AuBecsDebit>;
|
|
3516
|
+
|
|
3413
3517
|
/**
|
|
3414
3518
|
* If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
|
|
3415
3519
|
*/
|
|
@@ -3430,6 +3534,11 @@ declare module 'stripe' {
|
|
|
3430
3534
|
*/
|
|
3431
3535
|
card_present?: Stripe.Emptyable<PaymentMethodOptions.CardPresent>;
|
|
3432
3536
|
|
|
3537
|
+
/**
|
|
3538
|
+
* If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
|
|
3539
|
+
*/
|
|
3540
|
+
giropay?: Stripe.Emptyable<PaymentMethodOptions.Giropay>;
|
|
3541
|
+
|
|
3433
3542
|
/**
|
|
3434
3543
|
* If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
|
|
3435
3544
|
*/
|
|
@@ -3528,6 +3637,8 @@ declare module 'stripe' {
|
|
|
3528
3637
|
|
|
3529
3638
|
interface Alipay {}
|
|
3530
3639
|
|
|
3640
|
+
interface AuBecsDebit {}
|
|
3641
|
+
|
|
3531
3642
|
interface Bancontact {
|
|
3532
3643
|
/**
|
|
3533
3644
|
* Preferred language of the Bancontact authorization page that the customer is redirected to.
|
|
@@ -3575,6 +3686,17 @@ declare module 'stripe' {
|
|
|
3575
3686
|
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
3576
3687
|
*/
|
|
3577
3688
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
3689
|
+
|
|
3690
|
+
/**
|
|
3691
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
3692
|
+
*
|
|
3693
|
+
* Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
|
|
3694
|
+
*
|
|
3695
|
+
* When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
|
|
3696
|
+
*
|
|
3697
|
+
* If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
|
|
3698
|
+
*/
|
|
3699
|
+
setup_future_usage?: Stripe.Emptyable<Card.SetupFutureUsage>;
|
|
3578
3700
|
}
|
|
3579
3701
|
|
|
3580
3702
|
namespace Card {
|
|
@@ -3626,10 +3748,14 @@ declare module 'stripe' {
|
|
|
3626
3748
|
| 'visa';
|
|
3627
3749
|
|
|
3628
3750
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
3751
|
+
|
|
3752
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
3629
3753
|
}
|
|
3630
3754
|
|
|
3631
3755
|
interface CardPresent {}
|
|
3632
3756
|
|
|
3757
|
+
interface Giropay {}
|
|
3758
|
+
|
|
3633
3759
|
interface Ideal {}
|
|
3634
3760
|
|
|
3635
3761
|
interface InteracPresent {}
|
|
@@ -3652,15 +3778,19 @@ declare module 'stripe' {
|
|
|
3652
3778
|
| 'en-DK'
|
|
3653
3779
|
| 'en-ES'
|
|
3654
3780
|
| 'en-FI'
|
|
3781
|
+
| 'en-FR'
|
|
3655
3782
|
| 'en-GB'
|
|
3783
|
+
| 'en-IE'
|
|
3656
3784
|
| 'en-IT'
|
|
3657
3785
|
| 'en-NL'
|
|
3658
3786
|
| 'en-NO'
|
|
3659
3787
|
| 'en-SE'
|
|
3660
3788
|
| 'en-US'
|
|
3661
3789
|
| 'es-ES'
|
|
3790
|
+
| 'es-US'
|
|
3662
3791
|
| 'fi-FI'
|
|
3663
3792
|
| 'fr-BE'
|
|
3793
|
+
| 'fr-FR'
|
|
3664
3794
|
| 'it-IT'
|
|
3665
3795
|
| 'nb-NO'
|
|
3666
3796
|
| 'nl-BE'
|
|
@@ -842,7 +842,7 @@ declare module 'stripe' {
|
|
|
842
842
|
/**
|
|
843
843
|
* Email address.
|
|
844
844
|
*/
|
|
845
|
-
email?: string
|
|
845
|
+
email?: Stripe.Emptyable<string>;
|
|
846
846
|
|
|
847
847
|
/**
|
|
848
848
|
* Full name.
|
|
@@ -1172,7 +1172,7 @@ declare module 'stripe' {
|
|
|
1172
1172
|
/**
|
|
1173
1173
|
* Email address.
|
|
1174
1174
|
*/
|
|
1175
|
-
email?: string
|
|
1175
|
+
email?: Stripe.Emptyable<string>;
|
|
1176
1176
|
|
|
1177
1177
|
/**
|
|
1178
1178
|
* Full name.
|
|
@@ -345,7 +345,7 @@ declare module 'stripe' {
|
|
|
345
345
|
|
|
346
346
|
interface Relationship {
|
|
347
347
|
/**
|
|
348
|
-
* Whether the person is a director of the account's legal entity.
|
|
348
|
+
* Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
|
|
349
349
|
*/
|
|
350
350
|
director: boolean | null;
|
|
351
351
|
|
|
@@ -769,7 +769,7 @@ declare module 'stripe' {
|
|
|
769
769
|
|
|
770
770
|
interface Relationship {
|
|
771
771
|
/**
|
|
772
|
-
* Whether the person is a director of the account's legal entity.
|
|
772
|
+
* Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
|
|
773
773
|
*/
|
|
774
774
|
director?: boolean;
|
|
775
775
|
|
|
@@ -1036,7 +1036,7 @@ declare module 'stripe' {
|
|
|
1036
1036
|
|
|
1037
1037
|
interface Relationship {
|
|
1038
1038
|
/**
|
|
1039
|
-
* Whether the person is a director of the account's legal entity.
|
|
1039
|
+
* Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
|
|
1040
1040
|
*/
|
|
1041
1041
|
director?: boolean;
|
|
1042
1042
|
|
|
@@ -29,7 +29,7 @@ declare module 'stripe' {
|
|
|
29
29
|
/**
|
|
30
30
|
* A coupon contains information about a percent-off or amount-off discount you
|
|
31
31
|
* might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or
|
|
32
|
-
* [orders](https://stripe.com/docs/api#
|
|
32
|
+
* [orders](https://stripe.com/docs/api#create_order_legacy-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge).
|
|
33
33
|
*/
|
|
34
34
|
coupon: Stripe.Coupon;
|
|
35
35
|
|
|
@@ -222,7 +222,7 @@ declare module 'stripe' {
|
|
|
222
222
|
): Promise<Stripe.Response<Stripe.PromotionCode>>;
|
|
223
223
|
|
|
224
224
|
/**
|
|
225
|
-
* Retrieves the promotion code with the given ID.
|
|
225
|
+
* Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://stripe.com/docs/api/promotion_codes/list) with the desired code.
|
|
226
226
|
*/
|
|
227
227
|
retrieve(
|
|
228
228
|
id: string,
|
|
@@ -79,6 +79,8 @@ declare module 'stripe' {
|
|
|
79
79
|
|
|
80
80
|
bancontact?: PaymentMethodDetails.Bancontact;
|
|
81
81
|
|
|
82
|
+
boleto?: PaymentMethodDetails.Boleto;
|
|
83
|
+
|
|
82
84
|
card?: PaymentMethodDetails.Card;
|
|
83
85
|
|
|
84
86
|
card_present?: PaymentMethodDetails.CardPresent;
|
|
@@ -150,6 +152,8 @@ declare module 'stripe' {
|
|
|
150
152
|
type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
|
|
151
153
|
}
|
|
152
154
|
|
|
155
|
+
interface Boleto {}
|
|
156
|
+
|
|
153
157
|
interface Card {
|
|
154
158
|
/**
|
|
155
159
|
* Populated if this authorization used 3D Secure authentication.
|
|
@@ -364,7 +364,7 @@ declare module 'stripe' {
|
|
|
364
364
|
trial_end: number | null;
|
|
365
365
|
|
|
366
366
|
/**
|
|
367
|
-
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](docs/billing/subscriptions/trials) to learn more.
|
|
367
|
+
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
|
368
368
|
*/
|
|
369
369
|
trial_from_plan: boolean | null;
|
|
370
370
|
}
|
|
@@ -530,17 +530,17 @@ declare module 'stripe' {
|
|
|
530
530
|
transfer_data?: SubscriptionCreateParams.TransferData;
|
|
531
531
|
|
|
532
532
|
/**
|
|
533
|
-
* Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](docs/billing/subscriptions/trials) to learn more.
|
|
533
|
+
* Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
|
534
534
|
*/
|
|
535
535
|
trial_end?: 'now' | number;
|
|
536
536
|
|
|
537
537
|
/**
|
|
538
|
-
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](docs/billing/subscriptions/trials) to learn more.
|
|
538
|
+
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
|
539
539
|
*/
|
|
540
540
|
trial_from_plan?: boolean;
|
|
541
541
|
|
|
542
542
|
/**
|
|
543
|
-
* Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](docs/billing/subscriptions/trials) to learn more.
|
|
543
|
+
* Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
|
544
544
|
*/
|
|
545
545
|
trial_period_days?: number;
|
|
546
546
|
}
|
|
@@ -1013,7 +1013,7 @@ declare module 'stripe' {
|
|
|
1013
1013
|
trial_end?: 'now' | number;
|
|
1014
1014
|
|
|
1015
1015
|
/**
|
|
1016
|
-
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](docs/billing/subscriptions/trials) to learn more.
|
|
1016
|
+
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
|
1017
1017
|
*/
|
|
1018
1018
|
trial_from_plan?: boolean;
|
|
1019
1019
|
}
|
|
@@ -39,7 +39,7 @@ declare module 'stripe' {
|
|
|
39
39
|
livemode: boolean;
|
|
40
40
|
|
|
41
41
|
/**
|
|
42
|
-
* Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown`
|
|
42
|
+
* Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown`
|
|
43
43
|
*/
|
|
44
44
|
type: TaxId.Type;
|
|
45
45
|
|
|
@@ -72,6 +72,7 @@ declare module 'stripe' {
|
|
|
72
72
|
| 'es_cif'
|
|
73
73
|
| 'eu_vat'
|
|
74
74
|
| 'gb_vat'
|
|
75
|
+
| 'ge_vat'
|
|
75
76
|
| 'hk_br'
|
|
76
77
|
| 'id_npwp'
|
|
77
78
|
| 'il_vat'
|
|
@@ -93,6 +94,7 @@ declare module 'stripe' {
|
|
|
93
94
|
| 'sg_uen'
|
|
94
95
|
| 'th_vat'
|
|
95
96
|
| 'tw_vat'
|
|
97
|
+
| 'ua_vat'
|
|
96
98
|
| 'unknown'
|
|
97
99
|
| 'us_ein'
|
|
98
100
|
| 'za_vat';
|
|
@@ -141,7 +143,7 @@ declare module 'stripe' {
|
|
|
141
143
|
|
|
142
144
|
interface TaxIdCreateParams {
|
|
143
145
|
/**
|
|
144
|
-
* Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`
|
|
146
|
+
* Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
|
|
145
147
|
*/
|
|
146
148
|
type: TaxIdCreateParams.Type;
|
|
147
149
|
|
|
@@ -174,6 +176,7 @@ declare module 'stripe' {
|
|
|
174
176
|
| 'es_cif'
|
|
175
177
|
| 'eu_vat'
|
|
176
178
|
| 'gb_vat'
|
|
179
|
+
| 'ge_vat'
|
|
177
180
|
| 'hk_br'
|
|
178
181
|
| 'id_npwp'
|
|
179
182
|
| 'il_vat'
|
|
@@ -195,6 +198,7 @@ declare module 'stripe' {
|
|
|
195
198
|
| 'sg_uen'
|
|
196
199
|
| 'th_vat'
|
|
197
200
|
| 'tw_vat'
|
|
201
|
+
| 'ua_vat'
|
|
198
202
|
| 'us_ein'
|
|
199
203
|
| 'za_vat';
|
|
200
204
|
}
|
|
@@ -160,6 +160,7 @@ declare module 'stripe' {
|
|
|
160
160
|
class LocationsResource {
|
|
161
161
|
/**
|
|
162
162
|
* Creates a new Location object.
|
|
163
|
+
* For further details, including which address fields are required in each country, see the [Manage locations](https://stripe.com/docs/terminal/fleet/locations) guide.
|
|
163
164
|
*/
|
|
164
165
|
create(
|
|
165
166
|
params: LocationCreateParams,
|
|
@@ -109,7 +109,7 @@ declare module 'stripe' {
|
|
|
109
109
|
label?: string;
|
|
110
110
|
|
|
111
111
|
/**
|
|
112
|
-
* The location to assign the reader to.
|
|
112
|
+
* The location to assign the reader to.
|
|
113
113
|
*/
|
|
114
114
|
location?: string;
|
|
115
115
|
|
|
@@ -712,7 +712,7 @@ declare module 'stripe' {
|
|
|
712
712
|
|
|
713
713
|
interface Relationship {
|
|
714
714
|
/**
|
|
715
|
-
* Whether the person is a director of the account's legal entity.
|
|
715
|
+
* Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
|
|
716
716
|
*/
|
|
717
717
|
director?: boolean;
|
|
718
718
|
|
package/types/lib.d.ts
CHANGED
|
@@ -138,7 +138,7 @@ declare module 'stripe' {
|
|
|
138
138
|
api_key?: string;
|
|
139
139
|
|
|
140
140
|
/**
|
|
141
|
-
* See the [idempotency key docs](https://stripe.com/docs/api/
|
|
141
|
+
* See the [idempotency key docs](https://stripe.com/docs/api/idempotent_requests).
|
|
142
142
|
*/
|
|
143
143
|
idempotencyKey?: string;
|
|
144
144
|
/** @deprecated Please use idempotencyKey instead. */
|