stripe 8.190.0 → 8.194.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 +27 -0
- package/README.md +0 -1
- package/VERSION +1 -1
- package/package.json +1 -2
- package/types/2020-08-27/Accounts.d.ts +1 -1
- package/types/2020-08-27/BillingPortal/Configurations.d.ts +15 -0
- package/types/2020-08-27/Capabilities.d.ts +2 -2
- 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 +7 -3
- package/types/2020-08-27/Issuing/Cards.d.ts +56 -0
- package/types/2020-08-27/PaymentIntents.d.ts +107 -4
- 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/Subscriptions.d.ts +5 -5
- package/types/2020-08-27/TaxIds.d.ts +6 -2
- package/types/2020-08-27/TaxRates.d.ts +3 -0
- 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,32 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
|
+
## 8.194.0 - 2021-12-15
|
|
4
|
+
* [#1309](https://github.com/stripe/stripe-node/pull/1309) API Updates
|
|
5
|
+
* Add support for new resource `PaymentIntentTypeSpecificPaymentMethodOptionsClient`
|
|
6
|
+
* 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`
|
|
7
|
+
|
|
8
|
+
## 8.193.0 - 2021-12-09
|
|
9
|
+
* [#1308](https://github.com/stripe/stripe-node/pull/1308) API Updates
|
|
10
|
+
* Add support for `metadata` on `BillingPortalConfigurationCreateParams`, `BillingPortalConfigurationUpdateParams`, and `BillingPortal.Configuration`
|
|
11
|
+
|
|
12
|
+
## 8.192.0 - 2021-12-09
|
|
13
|
+
* [#1307](https://github.com/stripe/stripe-node/pull/1307) API Updates
|
|
14
|
+
* 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`
|
|
15
|
+
* 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`
|
|
16
|
+
* 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)`
|
|
17
|
+
* Add support for `giropay` on `PaymentIntentCreateParams.payment_method_options`, `PaymentIntentUpdateParams.payment_method_options`, `PaymentIntentConfirmParams.payment_method_options`, and `PaymentIntent.payment_method_options`
|
|
18
|
+
* 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`
|
|
19
|
+
* [#1301](https://github.com/stripe/stripe-node/pull/1301) Remove coveralls from package.json
|
|
20
|
+
* [#1300](https://github.com/stripe/stripe-node/pull/1300) Fix broken link in docstring
|
|
21
|
+
|
|
22
|
+
## 8.191.0 - 2021-11-19
|
|
23
|
+
* [#1299](https://github.com/stripe/stripe-node/pull/1299) API Updates
|
|
24
|
+
* Add support for `wallets` on `Issuing.Card`
|
|
25
|
+
|
|
26
|
+
* [#1298](https://github.com/stripe/stripe-node/pull/1298) API Updates
|
|
27
|
+
* Add support for `interac_present` on `PaymentIntentCreateParams.payment_method_options`, `PaymentIntentUpdateParams.payment_method_options`, `PaymentIntentConfirmParams.payment_method_options`, and `PaymentIntent.payment_method_options`
|
|
28
|
+
* Add support for new value `jct` on enums `TaxRateCreateParams.tax_type`, `TaxRateUpdateParams.tax_type`, and `TaxRate.tax_type`
|
|
29
|
+
|
|
3
30
|
## 8.190.0 - 2021-11-17
|
|
4
31
|
* [#1297](https://github.com/stripe/stripe-node/pull/1297) API Updates
|
|
5
32
|
* Add support for `automatic_payment_methods` on `PaymentIntentCreateParams` and `PaymentIntent`
|
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.194.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "stripe",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.194.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",
|
|
@@ -704,7 +704,7 @@ declare module 'stripe' {
|
|
|
704
704
|
currently_due: Array<string> | null;
|
|
705
705
|
|
|
706
706
|
/**
|
|
707
|
-
* If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.
|
|
707
|
+
* If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`.
|
|
708
708
|
*/
|
|
709
709
|
disabled_reason: string | null;
|
|
710
710
|
|
|
@@ -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 {
|
|
@@ -181,13 +181,13 @@ declare module 'stripe' {
|
|
|
181
181
|
currently_due: Array<string>;
|
|
182
182
|
|
|
183
183
|
/**
|
|
184
|
-
* If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.
|
|
184
|
+
* If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`.
|
|
185
185
|
*
|
|
186
186
|
* `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service:
|
|
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`, `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';
|
|
@@ -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
|
}
|
|
@@ -110,6 +110,11 @@ declare module 'stripe' {
|
|
|
110
110
|
* The type of the card.
|
|
111
111
|
*/
|
|
112
112
|
type: Card.Type;
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* Information relating to digital wallets (like Apple Pay and Google Pay).
|
|
116
|
+
*/
|
|
117
|
+
wallets: Card.Wallets | null;
|
|
113
118
|
}
|
|
114
119
|
|
|
115
120
|
namespace Card {
|
|
@@ -1101,6 +1106,57 @@ declare module 'stripe' {
|
|
|
1101
1106
|
type Status = 'active' | 'canceled' | 'inactive';
|
|
1102
1107
|
|
|
1103
1108
|
type Type = 'physical' | 'virtual';
|
|
1109
|
+
|
|
1110
|
+
interface Wallets {
|
|
1111
|
+
apple_pay: Wallets.ApplePay;
|
|
1112
|
+
|
|
1113
|
+
google_pay: Wallets.GooglePay;
|
|
1114
|
+
|
|
1115
|
+
/**
|
|
1116
|
+
* Unique identifier for a card used with digital wallets
|
|
1117
|
+
*/
|
|
1118
|
+
primary_account_identifier: string | null;
|
|
1119
|
+
}
|
|
1120
|
+
|
|
1121
|
+
namespace Wallets {
|
|
1122
|
+
interface ApplePay {
|
|
1123
|
+
/**
|
|
1124
|
+
* Apple Pay Eligibility
|
|
1125
|
+
*/
|
|
1126
|
+
eligible: boolean;
|
|
1127
|
+
|
|
1128
|
+
/**
|
|
1129
|
+
* Reason the card is ineligible for Apple Pay
|
|
1130
|
+
*/
|
|
1131
|
+
ineligible_reason: ApplePay.IneligibleReason | null;
|
|
1132
|
+
}
|
|
1133
|
+
|
|
1134
|
+
namespace ApplePay {
|
|
1135
|
+
type IneligibleReason =
|
|
1136
|
+
| 'missing_agreement'
|
|
1137
|
+
| 'missing_cardholder_contact'
|
|
1138
|
+
| 'unsupported_region';
|
|
1139
|
+
}
|
|
1140
|
+
|
|
1141
|
+
interface GooglePay {
|
|
1142
|
+
/**
|
|
1143
|
+
* Google Pay Eligibility
|
|
1144
|
+
*/
|
|
1145
|
+
eligible: boolean;
|
|
1146
|
+
|
|
1147
|
+
/**
|
|
1148
|
+
* Reason the card is ineligible for Google Pay
|
|
1149
|
+
*/
|
|
1150
|
+
ineligible_reason: GooglePay.IneligibleReason | null;
|
|
1151
|
+
}
|
|
1152
|
+
|
|
1153
|
+
namespace GooglePay {
|
|
1154
|
+
type IneligibleReason =
|
|
1155
|
+
| 'missing_agreement'
|
|
1156
|
+
| 'missing_cardholder_contact'
|
|
1157
|
+
| 'unsupported_region';
|
|
1158
|
+
}
|
|
1159
|
+
}
|
|
1104
1160
|
}
|
|
1105
1161
|
|
|
1106
1162
|
interface CardCreateParams {
|
|
@@ -519,8 +519,12 @@ declare module 'stripe' {
|
|
|
519
519
|
|
|
520
520
|
card_present?: PaymentMethodOptions.CardPresent;
|
|
521
521
|
|
|
522
|
+
giropay?: PaymentMethodOptions.Giropay;
|
|
523
|
+
|
|
522
524
|
ideal?: PaymentMethodOptions.Ideal;
|
|
523
525
|
|
|
526
|
+
interac_present?: PaymentMethodOptions.InteracPresent;
|
|
527
|
+
|
|
524
528
|
klarna?: PaymentMethodOptions.Klarna;
|
|
525
529
|
|
|
526
530
|
oxxo?: PaymentMethodOptions.Oxxo;
|
|
@@ -621,6 +625,15 @@ declare module 'stripe' {
|
|
|
621
625
|
* 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.
|
|
622
626
|
*/
|
|
623
627
|
request_three_d_secure: Card.RequestThreeDSecure | null;
|
|
628
|
+
|
|
629
|
+
/**
|
|
630
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
631
|
+
*
|
|
632
|
+
* 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.
|
|
633
|
+
*
|
|
634
|
+
* 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).
|
|
635
|
+
*/
|
|
636
|
+
setup_future_usage?: Card.SetupFutureUsage;
|
|
624
637
|
}
|
|
625
638
|
|
|
626
639
|
namespace Card {
|
|
@@ -692,12 +705,18 @@ declare module 'stripe' {
|
|
|
692
705
|
| 'visa';
|
|
693
706
|
|
|
694
707
|
type RequestThreeDSecure = 'any' | 'automatic' | 'challenge_only';
|
|
708
|
+
|
|
709
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
695
710
|
}
|
|
696
711
|
|
|
697
712
|
interface CardPresent {}
|
|
698
713
|
|
|
714
|
+
interface Giropay {}
|
|
715
|
+
|
|
699
716
|
interface Ideal {}
|
|
700
717
|
|
|
718
|
+
interface InteracPresent {}
|
|
719
|
+
|
|
701
720
|
interface Klarna {
|
|
702
721
|
/**
|
|
703
722
|
* Preferred locale of the Klarna checkout page that the customer is redirected to.
|
|
@@ -1196,7 +1215,7 @@ declare module 'stripe' {
|
|
|
1196
1215
|
/**
|
|
1197
1216
|
* Email address.
|
|
1198
1217
|
*/
|
|
1199
|
-
email?: string
|
|
1218
|
+
email?: Stripe.Emptyable<string>;
|
|
1200
1219
|
|
|
1201
1220
|
/**
|
|
1202
1221
|
* Full name.
|
|
@@ -1472,11 +1491,21 @@ declare module 'stripe' {
|
|
|
1472
1491
|
*/
|
|
1473
1492
|
card_present?: Stripe.Emptyable<PaymentMethodOptions.CardPresent>;
|
|
1474
1493
|
|
|
1494
|
+
/**
|
|
1495
|
+
* If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
|
|
1496
|
+
*/
|
|
1497
|
+
giropay?: Stripe.Emptyable<PaymentMethodOptions.Giropay>;
|
|
1498
|
+
|
|
1475
1499
|
/**
|
|
1476
1500
|
* If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
|
|
1477
1501
|
*/
|
|
1478
1502
|
ideal?: Stripe.Emptyable<PaymentMethodOptions.Ideal>;
|
|
1479
1503
|
|
|
1504
|
+
/**
|
|
1505
|
+
* If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
|
|
1506
|
+
*/
|
|
1507
|
+
interac_present?: Stripe.Emptyable<PaymentMethodOptions.InteracPresent>;
|
|
1508
|
+
|
|
1480
1509
|
/**
|
|
1481
1510
|
* If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
|
|
1482
1511
|
*/
|
|
@@ -1612,6 +1641,17 @@ declare module 'stripe' {
|
|
|
1612
1641
|
* 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.
|
|
1613
1642
|
*/
|
|
1614
1643
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
1644
|
+
|
|
1645
|
+
/**
|
|
1646
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1647
|
+
*
|
|
1648
|
+
* 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.
|
|
1649
|
+
*
|
|
1650
|
+
* 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).
|
|
1651
|
+
*
|
|
1652
|
+
* 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`.
|
|
1653
|
+
*/
|
|
1654
|
+
setup_future_usage?: Stripe.Emptyable<Card.SetupFutureUsage>;
|
|
1615
1655
|
}
|
|
1616
1656
|
|
|
1617
1657
|
namespace Card {
|
|
@@ -1663,12 +1703,18 @@ declare module 'stripe' {
|
|
|
1663
1703
|
| 'visa';
|
|
1664
1704
|
|
|
1665
1705
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
1706
|
+
|
|
1707
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1666
1708
|
}
|
|
1667
1709
|
|
|
1668
1710
|
interface CardPresent {}
|
|
1669
1711
|
|
|
1712
|
+
interface Giropay {}
|
|
1713
|
+
|
|
1670
1714
|
interface Ideal {}
|
|
1671
1715
|
|
|
1716
|
+
interface InteracPresent {}
|
|
1717
|
+
|
|
1672
1718
|
interface Klarna {
|
|
1673
1719
|
/**
|
|
1674
1720
|
* Preferred language of the Klarna authorization page that the customer is redirected to
|
|
@@ -1688,6 +1734,7 @@ declare module 'stripe' {
|
|
|
1688
1734
|
| 'en-ES'
|
|
1689
1735
|
| 'en-FI'
|
|
1690
1736
|
| 'en-GB'
|
|
1737
|
+
| 'en-IE'
|
|
1691
1738
|
| 'en-IT'
|
|
1692
1739
|
| 'en-NL'
|
|
1693
1740
|
| 'en-NO'
|
|
@@ -2109,7 +2156,7 @@ declare module 'stripe' {
|
|
|
2109
2156
|
/**
|
|
2110
2157
|
* Email address.
|
|
2111
2158
|
*/
|
|
2112
|
-
email?: string
|
|
2159
|
+
email?: Stripe.Emptyable<string>;
|
|
2113
2160
|
|
|
2114
2161
|
/**
|
|
2115
2162
|
* Full name.
|
|
@@ -2385,11 +2432,21 @@ declare module 'stripe' {
|
|
|
2385
2432
|
*/
|
|
2386
2433
|
card_present?: Stripe.Emptyable<PaymentMethodOptions.CardPresent>;
|
|
2387
2434
|
|
|
2435
|
+
/**
|
|
2436
|
+
* If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
|
|
2437
|
+
*/
|
|
2438
|
+
giropay?: Stripe.Emptyable<PaymentMethodOptions.Giropay>;
|
|
2439
|
+
|
|
2388
2440
|
/**
|
|
2389
2441
|
* If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
|
|
2390
2442
|
*/
|
|
2391
2443
|
ideal?: Stripe.Emptyable<PaymentMethodOptions.Ideal>;
|
|
2392
2444
|
|
|
2445
|
+
/**
|
|
2446
|
+
* If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
|
|
2447
|
+
*/
|
|
2448
|
+
interac_present?: Stripe.Emptyable<PaymentMethodOptions.InteracPresent>;
|
|
2449
|
+
|
|
2393
2450
|
/**
|
|
2394
2451
|
* If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
|
|
2395
2452
|
*/
|
|
@@ -2525,6 +2582,17 @@ declare module 'stripe' {
|
|
|
2525
2582
|
* 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.
|
|
2526
2583
|
*/
|
|
2527
2584
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
2585
|
+
|
|
2586
|
+
/**
|
|
2587
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
2588
|
+
*
|
|
2589
|
+
* 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.
|
|
2590
|
+
*
|
|
2591
|
+
* 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).
|
|
2592
|
+
*
|
|
2593
|
+
* 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`.
|
|
2594
|
+
*/
|
|
2595
|
+
setup_future_usage?: Stripe.Emptyable<Card.SetupFutureUsage>;
|
|
2528
2596
|
}
|
|
2529
2597
|
|
|
2530
2598
|
namespace Card {
|
|
@@ -2576,12 +2644,18 @@ declare module 'stripe' {
|
|
|
2576
2644
|
| 'visa';
|
|
2577
2645
|
|
|
2578
2646
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
2647
|
+
|
|
2648
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
2579
2649
|
}
|
|
2580
2650
|
|
|
2581
2651
|
interface CardPresent {}
|
|
2582
2652
|
|
|
2653
|
+
interface Giropay {}
|
|
2654
|
+
|
|
2583
2655
|
interface Ideal {}
|
|
2584
2656
|
|
|
2657
|
+
interface InteracPresent {}
|
|
2658
|
+
|
|
2585
2659
|
interface Klarna {
|
|
2586
2660
|
/**
|
|
2587
2661
|
* Preferred language of the Klarna authorization page that the customer is redirected to
|
|
@@ -2601,6 +2675,7 @@ declare module 'stripe' {
|
|
|
2601
2675
|
| 'en-ES'
|
|
2602
2676
|
| 'en-FI'
|
|
2603
2677
|
| 'en-GB'
|
|
2678
|
+
| 'en-IE'
|
|
2604
2679
|
| 'en-IT'
|
|
2605
2680
|
| 'en-NL'
|
|
2606
2681
|
| 'en-NO'
|
|
@@ -3136,7 +3211,7 @@ declare module 'stripe' {
|
|
|
3136
3211
|
/**
|
|
3137
3212
|
* Email address.
|
|
3138
3213
|
*/
|
|
3139
|
-
email?: string
|
|
3214
|
+
email?: Stripe.Emptyable<string>;
|
|
3140
3215
|
|
|
3141
3216
|
/**
|
|
3142
3217
|
* Full name.
|
|
@@ -3412,11 +3487,21 @@ declare module 'stripe' {
|
|
|
3412
3487
|
*/
|
|
3413
3488
|
card_present?: Stripe.Emptyable<PaymentMethodOptions.CardPresent>;
|
|
3414
3489
|
|
|
3490
|
+
/**
|
|
3491
|
+
* If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
|
|
3492
|
+
*/
|
|
3493
|
+
giropay?: Stripe.Emptyable<PaymentMethodOptions.Giropay>;
|
|
3494
|
+
|
|
3415
3495
|
/**
|
|
3416
3496
|
* If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
|
|
3417
3497
|
*/
|
|
3418
3498
|
ideal?: Stripe.Emptyable<PaymentMethodOptions.Ideal>;
|
|
3419
3499
|
|
|
3500
|
+
/**
|
|
3501
|
+
* If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
|
|
3502
|
+
*/
|
|
3503
|
+
interac_present?: Stripe.Emptyable<PaymentMethodOptions.InteracPresent>;
|
|
3504
|
+
|
|
3420
3505
|
/**
|
|
3421
3506
|
* If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
|
|
3422
3507
|
*/
|
|
@@ -3552,6 +3637,17 @@ declare module 'stripe' {
|
|
|
3552
3637
|
* 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.
|
|
3553
3638
|
*/
|
|
3554
3639
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
3640
|
+
|
|
3641
|
+
/**
|
|
3642
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
3643
|
+
*
|
|
3644
|
+
* 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.
|
|
3645
|
+
*
|
|
3646
|
+
* 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).
|
|
3647
|
+
*
|
|
3648
|
+
* 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`.
|
|
3649
|
+
*/
|
|
3650
|
+
setup_future_usage?: Stripe.Emptyable<Card.SetupFutureUsage>;
|
|
3555
3651
|
}
|
|
3556
3652
|
|
|
3557
3653
|
namespace Card {
|
|
@@ -3603,12 +3699,18 @@ declare module 'stripe' {
|
|
|
3603
3699
|
| 'visa';
|
|
3604
3700
|
|
|
3605
3701
|
type RequestThreeDSecure = 'any' | 'automatic';
|
|
3702
|
+
|
|
3703
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
3606
3704
|
}
|
|
3607
3705
|
|
|
3608
3706
|
interface CardPresent {}
|
|
3609
3707
|
|
|
3708
|
+
interface Giropay {}
|
|
3709
|
+
|
|
3610
3710
|
interface Ideal {}
|
|
3611
3711
|
|
|
3712
|
+
interface InteracPresent {}
|
|
3713
|
+
|
|
3612
3714
|
interface Klarna {
|
|
3613
3715
|
/**
|
|
3614
3716
|
* Preferred language of the Klarna authorization page that the customer is redirected to
|
|
@@ -3628,6 +3730,7 @@ declare module 'stripe' {
|
|
|
3628
3730
|
| 'en-ES'
|
|
3629
3731
|
| 'en-FI'
|
|
3630
3732
|
| 'en-GB'
|
|
3733
|
+
| 'en-IE'
|
|
3631
3734
|
| 'en-IT'
|
|
3632
3735
|
| 'en-NL'
|
|
3633
3736
|
| 'en-NO'
|
|
@@ -3800,7 +3903,7 @@ declare module 'stripe' {
|
|
|
3800
3903
|
list(options?: RequestOptions): ApiListPromise<Stripe.PaymentIntent>;
|
|
3801
3904
|
|
|
3802
3905
|
/**
|
|
3803
|
-
* A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, or
|
|
3906
|
+
* A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.
|
|
3804
3907
|
*
|
|
3805
3908
|
* Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status='requires_capture', the remaining amount_capturable will automatically be refunded.
|
|
3806
3909
|
*/
|
|
@@ -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,
|
|
@@ -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
|
}
|
|
@@ -81,6 +81,7 @@ declare module 'stripe' {
|
|
|
81
81
|
type TaxType =
|
|
82
82
|
| 'gst'
|
|
83
83
|
| 'hst'
|
|
84
|
+
| 'jct'
|
|
84
85
|
| 'pst'
|
|
85
86
|
| 'qst'
|
|
86
87
|
| 'rst'
|
|
@@ -149,6 +150,7 @@ declare module 'stripe' {
|
|
|
149
150
|
type TaxType =
|
|
150
151
|
| 'gst'
|
|
151
152
|
| 'hst'
|
|
153
|
+
| 'jct'
|
|
152
154
|
| 'pst'
|
|
153
155
|
| 'qst'
|
|
154
156
|
| 'rst'
|
|
@@ -214,6 +216,7 @@ declare module 'stripe' {
|
|
|
214
216
|
type TaxType =
|
|
215
217
|
| 'gst'
|
|
216
218
|
| 'hst'
|
|
219
|
+
| 'jct'
|
|
217
220
|
| 'pst'
|
|
218
221
|
| 'qst'
|
|
219
222
|
| 'rst'
|
|
@@ -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. */
|