stripe 16.4.0 → 16.6.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +794 -109
- package/README.md +33 -0
- package/VERSION +1 -1
- package/cjs/RequestSender.js +66 -5
- package/cjs/StripeResource.js +1 -1
- package/cjs/apiVersion.js +2 -1
- package/cjs/multipart.js +1 -1
- package/cjs/resources/AccountNotices.js +21 -0
- package/cjs/resources/Billing/Alerts.js +27 -0
- package/cjs/resources/Capital/FinancingOffers.js +21 -0
- package/cjs/resources/Capital/FinancingSummary.js +12 -0
- package/cjs/resources/Capital/FinancingTransactions.js +17 -0
- package/cjs/resources/Checkout/Sessions.js +4 -0
- package/cjs/resources/FinancialConnections/Accounts.js +5 -0
- package/cjs/resources/FinancialConnections/Institutions.js +17 -0
- package/cjs/resources/GiftCards/Cards.js +23 -0
- package/cjs/resources/GiftCards/Transactions.js +33 -0
- package/cjs/resources/Invoices.js +13 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
- package/cjs/resources/Margins.js +22 -0
- package/cjs/resources/OAuth.js +1 -1
- package/cjs/resources/Orders.js +24 -0
- package/cjs/resources/PaymentIntents.js +4 -0
- package/cjs/resources/QuotePhases.js +22 -0
- package/cjs/resources/Quotes.js +32 -0
- package/cjs/resources/SubscriptionSchedules.js +4 -0
- package/cjs/resources/Tax/Associations.js +9 -0
- package/cjs/resources/Tax/Forms.js +20 -0
- package/cjs/resources/Terminal/Readers.js +12 -0
- package/cjs/resources.js +42 -10
- package/cjs/stripe.core.js +6 -3
- package/cjs/utils.js +30 -3
- package/esm/RequestSender.js +67 -6
- package/esm/StripeResource.js +2 -2
- package/esm/apiVersion.js +1 -0
- package/esm/multipart.js +2 -2
- package/esm/resources/AccountNotices.js +18 -0
- package/esm/resources/Billing/Alerts.js +24 -0
- package/esm/resources/Capital/FinancingOffers.js +18 -0
- package/esm/resources/Capital/FinancingSummary.js +9 -0
- package/esm/resources/Capital/FinancingTransactions.js +14 -0
- package/esm/resources/Checkout/Sessions.js +4 -0
- package/esm/resources/FinancialConnections/Accounts.js +5 -0
- package/esm/resources/FinancialConnections/Institutions.js +14 -0
- package/esm/resources/GiftCards/Cards.js +20 -0
- package/esm/resources/GiftCards/Transactions.js +30 -0
- package/esm/resources/Invoices.js +13 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
- package/esm/resources/Margins.js +19 -0
- package/esm/resources/OAuth.js +2 -2
- package/esm/resources/Orders.js +21 -0
- package/esm/resources/PaymentIntents.js +4 -0
- package/esm/resources/QuotePhases.js +19 -0
- package/esm/resources/Quotes.js +32 -0
- package/esm/resources/SubscriptionSchedules.js +4 -0
- package/esm/resources/Tax/Associations.js +6 -0
- package/esm/resources/Tax/Forms.js +17 -0
- package/esm/resources/Terminal/Readers.js +12 -0
- package/esm/resources.js +28 -0
- package/esm/stripe.core.js +6 -3
- package/esm/utils.js +27 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +5 -1
- package/types/AccountNotices.d.ts +113 -0
- package/types/AccountNoticesResource.d.ts +98 -0
- package/types/AccountSessions.d.ts +45 -0
- package/types/AccountSessionsResource.d.ts +205 -0
- package/types/Accounts.d.ts +109 -4
- package/types/AccountsResource.d.ts +272 -26
- package/types/Billing/AlertTriggereds.d.ts +42 -0
- package/types/Billing/Alerts.d.ts +80 -0
- package/types/Billing/AlertsResource.d.ts +176 -0
- package/types/Capital/FinancingOffers.d.ts +188 -0
- package/types/Capital/FinancingOffersResource.d.ts +97 -0
- package/types/Capital/FinancingSummary.d.ts +106 -0
- package/types/Capital/FinancingSummaryResource.d.ts +27 -0
- package/types/Capital/FinancingTransactions.d.ts +135 -0
- package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
- package/types/Charges.d.ts +106 -3
- package/types/ChargesResource.d.ts +1294 -0
- package/types/Checkout/Sessions.d.ts +28 -1
- package/types/Checkout/SessionsResource.d.ts +36 -1
- package/types/ConfirmationTokens.d.ts +80 -0
- package/types/Coupons.d.ts +1 -1
- package/types/CouponsResource.d.ts +1 -1
- package/types/CreditNotes.d.ts +21 -0
- package/types/CreditNotesResource.d.ts +51 -0
- package/types/CustomersResource.d.ts +2 -0
- package/types/Disputes.d.ts +177 -0
- package/types/DisputesResource.d.ts +120 -0
- package/types/EventTypes.d.ts +477 -0
- package/types/Events.d.ts +86 -0
- package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
- package/types/FinancialConnections/Accounts.d.ts +29 -1
- package/types/FinancialConnections/AccountsResource.d.ts +35 -3
- package/types/FinancialConnections/Institutions.d.ts +93 -0
- package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
- package/types/FinancialConnections/Sessions.d.ts +49 -1
- package/types/FinancialConnections/SessionsResource.d.ts +38 -1
- package/types/GiftCards/Cards.d.ts +118 -0
- package/types/GiftCards/CardsResource.d.ts +159 -0
- package/types/GiftCards/Transactions.d.ts +129 -0
- package/types/GiftCards/TransactionsResource.d.ts +201 -0
- package/types/InvoiceItems.d.ts +5 -0
- package/types/InvoiceItemsResource.d.ts +98 -0
- package/types/InvoiceLineItems.d.ts +22 -0
- package/types/InvoicePayments.d.ts +138 -0
- package/types/Invoices.d.ts +116 -1
- package/types/InvoicesResource.d.ts +5395 -1818
- package/types/Issuing/CardholdersResource.d.ts +2 -1
- package/types/Issuing/CreditUnderwritingRecords.d.ts +446 -0
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1017 -0
- package/types/LineItems.d.ts +7 -0
- package/types/Mandates.d.ts +77 -0
- package/types/Margins.d.ts +56 -0
- package/types/MarginsResource.d.ts +114 -0
- package/types/Orders.d.ts +1057 -0
- package/types/OrdersResource.d.ts +2711 -0
- package/types/PaymentIntents.d.ts +491 -2
- package/types/PaymentIntentsResource.d.ts +6884 -3356
- package/types/PaymentMethodConfigurations.d.ts +72 -0
- package/types/PaymentMethodConfigurationsResource.d.ts +100 -0
- package/types/PaymentMethods.d.ts +80 -0
- package/types/PaymentMethodsResource.d.ts +110 -0
- package/types/Prices.d.ts +22 -0
- package/types/PricesResource.d.ts +22 -0
- package/types/Products.d.ts +39 -0
- package/types/ProductsResource.d.ts +36 -0
- package/types/QuoteLines.d.ts +634 -0
- package/types/QuotePhases.d.ts +198 -0
- package/types/QuotePhasesResource.d.ts +67 -0
- package/types/QuotePreviewInvoices.d.ts +1528 -0
- package/types/QuotePreviewSubscriptionSchedules.d.ts +778 -0
- package/types/Quotes.d.ts +578 -1
- package/types/QuotesResource.d.ts +3174 -265
- package/types/RefundsResource.d.ts +1 -1
- package/types/SetupAttempts.d.ts +9 -0
- package/types/SetupIntents.d.ts +110 -1
- package/types/SetupIntentsResource.d.ts +498 -3
- package/types/Sources.d.ts +23 -0
- package/types/SubscriptionItems.d.ts +21 -0
- package/types/SubscriptionItemsResource.d.ts +109 -0
- package/types/SubscriptionSchedules.d.ts +164 -0
- package/types/SubscriptionSchedulesResource.d.ts +1234 -16
- package/types/Subscriptions.d.ts +46 -1
- package/types/SubscriptionsResource.d.ts +347 -2
- package/types/Tax/Associations.d.ts +126 -0
- package/types/Tax/AssociationsResource.d.ts +29 -0
- package/types/Tax/Calculations.d.ts +1 -1
- package/types/Tax/CalculationsResource.d.ts +1 -3
- package/types/Tax/Forms.d.ts +133 -0
- package/types/Tax/FormsResource.d.ts +90 -0
- package/types/Terminal/Readers.d.ts +278 -0
- package/types/Terminal/ReadersResource.d.ts +208 -0
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +55 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
- package/types/TokensResource.d.ts +7 -7
- package/types/Treasury/FinancialAccounts.d.ts +5 -0
- package/types/Treasury/FinancialAccountsResource.d.ts +10 -0
- package/types/Treasury/OutboundTransfers.d.ts +26 -0
- package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
- package/types/Treasury/ReceivedCredits.d.ts +26 -0
- package/types/Treasury/ReceivedDebits.d.ts +31 -0
- package/types/WebhookEndpointsResource.d.ts +56 -0
- package/types/index.d.ts +71 -0
- package/types/lib.d.ts +12 -0
|
@@ -82,6 +82,11 @@ declare module 'stripe' {
|
|
|
82
82
|
*/
|
|
83
83
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
84
84
|
|
|
85
|
+
/**
|
|
86
|
+
* A hash to configure risk controls on the account. Please see [this page for more details](https://stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts).
|
|
87
|
+
*/
|
|
88
|
+
risk_controls?: AccountCreateParams.RiskControls;
|
|
89
|
+
|
|
85
90
|
/**
|
|
86
91
|
* Options for customizing how the account functions within Stripe.
|
|
87
92
|
*/
|
|
@@ -111,7 +116,7 @@ declare module 'stripe' {
|
|
|
111
116
|
estimated_worker_count?: number;
|
|
112
117
|
|
|
113
118
|
/**
|
|
114
|
-
* [The merchant category code for the account](https://
|
|
119
|
+
* [The merchant category code for the account](https://stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
|
|
115
120
|
*/
|
|
116
121
|
mcc?: string;
|
|
117
122
|
|
|
@@ -159,7 +164,7 @@ declare module 'stripe' {
|
|
|
159
164
|
namespace BusinessProfile {
|
|
160
165
|
interface AnnualRevenue {
|
|
161
166
|
/**
|
|
162
|
-
* A non-negative integer representing the amount in the [smallest currency unit](https://
|
|
167
|
+
* A non-negative integer representing the amount in the [smallest currency unit](https://stripe.com/currencies#zero-decimal).
|
|
163
168
|
*/
|
|
164
169
|
amount: number;
|
|
165
170
|
|
|
@@ -176,7 +181,7 @@ declare module 'stripe' {
|
|
|
176
181
|
|
|
177
182
|
interface MonthlyEstimatedRevenue {
|
|
178
183
|
/**
|
|
179
|
-
* A non-negative integer representing how much to charge in the [smallest currency unit](https://
|
|
184
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/currencies#zero-decimal).
|
|
180
185
|
*/
|
|
181
186
|
amount: number;
|
|
182
187
|
|
|
@@ -359,11 +364,26 @@ declare module 'stripe' {
|
|
|
359
364
|
*/
|
|
360
365
|
paynow_payments?: Capabilities.PaynowPayments;
|
|
361
366
|
|
|
367
|
+
/**
|
|
368
|
+
* The paypal_payments capability.
|
|
369
|
+
*/
|
|
370
|
+
paypal_payments?: Capabilities.PaypalPayments;
|
|
371
|
+
|
|
372
|
+
/**
|
|
373
|
+
* The payto_payments capability.
|
|
374
|
+
*/
|
|
375
|
+
payto_payments?: Capabilities.PaytoPayments;
|
|
376
|
+
|
|
362
377
|
/**
|
|
363
378
|
* The promptpay_payments capability.
|
|
364
379
|
*/
|
|
365
380
|
promptpay_payments?: Capabilities.PromptpayPayments;
|
|
366
381
|
|
|
382
|
+
/**
|
|
383
|
+
* The rechnung_payments capability.
|
|
384
|
+
*/
|
|
385
|
+
rechnung_payments?: Capabilities.RechnungPayments;
|
|
386
|
+
|
|
367
387
|
/**
|
|
368
388
|
* The revolut_pay_payments capability.
|
|
369
389
|
*/
|
|
@@ -662,6 +682,20 @@ declare module 'stripe' {
|
|
|
662
682
|
requested?: boolean;
|
|
663
683
|
}
|
|
664
684
|
|
|
685
|
+
interface PaypalPayments {
|
|
686
|
+
/**
|
|
687
|
+
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
688
|
+
*/
|
|
689
|
+
requested?: boolean;
|
|
690
|
+
}
|
|
691
|
+
|
|
692
|
+
interface PaytoPayments {
|
|
693
|
+
/**
|
|
694
|
+
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
695
|
+
*/
|
|
696
|
+
requested?: boolean;
|
|
697
|
+
}
|
|
698
|
+
|
|
665
699
|
interface PromptpayPayments {
|
|
666
700
|
/**
|
|
667
701
|
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
@@ -669,6 +703,13 @@ declare module 'stripe' {
|
|
|
669
703
|
requested?: boolean;
|
|
670
704
|
}
|
|
671
705
|
|
|
706
|
+
interface RechnungPayments {
|
|
707
|
+
/**
|
|
708
|
+
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
709
|
+
*/
|
|
710
|
+
requested?: boolean;
|
|
711
|
+
}
|
|
712
|
+
|
|
672
713
|
interface RevolutPayPayments {
|
|
673
714
|
/**
|
|
674
715
|
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
@@ -778,12 +819,12 @@ declare module 'stripe' {
|
|
|
778
819
|
address_kanji?: Stripe.JapanAddressParam;
|
|
779
820
|
|
|
780
821
|
/**
|
|
781
|
-
* Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://
|
|
822
|
+
* Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
|
|
782
823
|
*/
|
|
783
824
|
directors_provided?: boolean;
|
|
784
825
|
|
|
785
826
|
/**
|
|
786
|
-
* Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://
|
|
827
|
+
* Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.executive` requirement.
|
|
787
828
|
*/
|
|
788
829
|
executives_provided?: boolean;
|
|
789
830
|
|
|
@@ -813,7 +854,7 @@ declare module 'stripe' {
|
|
|
813
854
|
name_kanji?: string;
|
|
814
855
|
|
|
815
856
|
/**
|
|
816
|
-
* Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://
|
|
857
|
+
* Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.owner` requirement.
|
|
817
858
|
*/
|
|
818
859
|
owners_provided?: boolean;
|
|
819
860
|
|
|
@@ -833,7 +874,7 @@ declare module 'stripe' {
|
|
|
833
874
|
registration_number?: string;
|
|
834
875
|
|
|
835
876
|
/**
|
|
836
|
-
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://
|
|
877
|
+
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
|
|
837
878
|
*/
|
|
838
879
|
structure?: Stripe.Emptyable<Company.Structure>;
|
|
839
880
|
|
|
@@ -924,6 +965,16 @@ declare module 'stripe' {
|
|
|
924
965
|
}
|
|
925
966
|
|
|
926
967
|
interface Controller {
|
|
968
|
+
/**
|
|
969
|
+
* A hash of configuration describing the Connect application that controls the account.
|
|
970
|
+
*/
|
|
971
|
+
application?: Controller.Application;
|
|
972
|
+
|
|
973
|
+
/**
|
|
974
|
+
* Properties of the account's dashboard.
|
|
975
|
+
*/
|
|
976
|
+
dashboard?: Controller.Dashboard;
|
|
977
|
+
|
|
927
978
|
/**
|
|
928
979
|
* A hash of configuration for who pays Stripe fees for product usage on this account.
|
|
929
980
|
*/
|
|
@@ -946,6 +997,34 @@ declare module 'stripe' {
|
|
|
946
997
|
}
|
|
947
998
|
|
|
948
999
|
namespace Controller {
|
|
1000
|
+
interface Application {
|
|
1001
|
+
/**
|
|
1002
|
+
* Whether the controller is liable for losses on this account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).
|
|
1003
|
+
*/
|
|
1004
|
+
loss_liable: boolean;
|
|
1005
|
+
|
|
1006
|
+
/**
|
|
1007
|
+
* Whether the controller owns onboarding for this account.
|
|
1008
|
+
*/
|
|
1009
|
+
onboarding_owner?: boolean;
|
|
1010
|
+
|
|
1011
|
+
/**
|
|
1012
|
+
* Whether the controller has pricing controls for this account.
|
|
1013
|
+
*/
|
|
1014
|
+
pricing_controls?: boolean;
|
|
1015
|
+
}
|
|
1016
|
+
|
|
1017
|
+
interface Dashboard {
|
|
1018
|
+
/**
|
|
1019
|
+
* Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.
|
|
1020
|
+
*/
|
|
1021
|
+
type?: Dashboard.Type;
|
|
1022
|
+
}
|
|
1023
|
+
|
|
1024
|
+
namespace Dashboard {
|
|
1025
|
+
type Type = 'express' | 'full' | 'none';
|
|
1026
|
+
}
|
|
1027
|
+
|
|
949
1028
|
interface Fees {
|
|
950
1029
|
/**
|
|
951
1030
|
* A value indicating the responsible payer of Stripe fees on this account. Defaults to `account`. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).
|
|
@@ -1159,12 +1238,12 @@ declare module 'stripe' {
|
|
|
1159
1238
|
gender?: string;
|
|
1160
1239
|
|
|
1161
1240
|
/**
|
|
1162
|
-
* The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://
|
|
1241
|
+
* The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/js/tokens/create_token?type=pii).
|
|
1163
1242
|
*/
|
|
1164
1243
|
id_number?: string;
|
|
1165
1244
|
|
|
1166
1245
|
/**
|
|
1167
|
-
* The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://
|
|
1246
|
+
* The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/js/tokens/create_token?type=pii).
|
|
1168
1247
|
*/
|
|
1169
1248
|
id_number_secondary?: string;
|
|
1170
1249
|
|
|
@@ -1310,6 +1389,36 @@ declare module 'stripe' {
|
|
|
1310
1389
|
}
|
|
1311
1390
|
}
|
|
1312
1391
|
|
|
1392
|
+
interface RiskControls {
|
|
1393
|
+
/**
|
|
1394
|
+
* Represents the risk control status of charges. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
|
|
1395
|
+
*/
|
|
1396
|
+
charges?: RiskControls.Charges;
|
|
1397
|
+
|
|
1398
|
+
/**
|
|
1399
|
+
* Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
|
|
1400
|
+
*/
|
|
1401
|
+
payouts?: RiskControls.Payouts;
|
|
1402
|
+
}
|
|
1403
|
+
|
|
1404
|
+
namespace RiskControls {
|
|
1405
|
+
interface Charges {
|
|
1406
|
+
/**
|
|
1407
|
+
* To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
|
|
1408
|
+
* There can be a delay before the risk control is paused or unpaused.
|
|
1409
|
+
*/
|
|
1410
|
+
pause_requested?: boolean;
|
|
1411
|
+
}
|
|
1412
|
+
|
|
1413
|
+
interface Payouts {
|
|
1414
|
+
/**
|
|
1415
|
+
* To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
|
|
1416
|
+
* There can be a delay before the risk control is paused or unpaused.
|
|
1417
|
+
*/
|
|
1418
|
+
pause_requested?: boolean;
|
|
1419
|
+
}
|
|
1420
|
+
}
|
|
1421
|
+
|
|
1313
1422
|
interface Settings {
|
|
1314
1423
|
/**
|
|
1315
1424
|
* Settings specific to Bacs Direct Debit.
|
|
@@ -1321,6 +1430,11 @@ declare module 'stripe' {
|
|
|
1321
1430
|
*/
|
|
1322
1431
|
branding?: Settings.Branding;
|
|
1323
1432
|
|
|
1433
|
+
/**
|
|
1434
|
+
* Settings specific to the account's use of the Capital product.
|
|
1435
|
+
*/
|
|
1436
|
+
capital?: Settings.Capital;
|
|
1437
|
+
|
|
1324
1438
|
/**
|
|
1325
1439
|
* Settings specific to the account's use of the Card Issuing product.
|
|
1326
1440
|
*/
|
|
@@ -1341,6 +1455,11 @@ declare module 'stripe' {
|
|
|
1341
1455
|
*/
|
|
1342
1456
|
payouts?: Settings.Payouts;
|
|
1343
1457
|
|
|
1458
|
+
/**
|
|
1459
|
+
* Settings specific to the account's tax forms.
|
|
1460
|
+
*/
|
|
1461
|
+
tax_forms?: Settings.TaxForms;
|
|
1462
|
+
|
|
1344
1463
|
/**
|
|
1345
1464
|
* Settings specific to the account's Treasury FinancialAccounts.
|
|
1346
1465
|
*/
|
|
@@ -1377,9 +1496,25 @@ declare module 'stripe' {
|
|
|
1377
1496
|
secondary_color?: string;
|
|
1378
1497
|
}
|
|
1379
1498
|
|
|
1499
|
+
interface Capital {
|
|
1500
|
+
/**
|
|
1501
|
+
* Per-currency mapping of user-selected destination accounts used to pay out loans.
|
|
1502
|
+
*/
|
|
1503
|
+
payout_destination?: {
|
|
1504
|
+
[key: string]: string;
|
|
1505
|
+
};
|
|
1506
|
+
|
|
1507
|
+
/**
|
|
1508
|
+
* Per-currency mapping of all destination accounts eligible to receive Capital financing payouts.
|
|
1509
|
+
*/
|
|
1510
|
+
payout_destination_selector?: {
|
|
1511
|
+
[key: string]: Array<string>;
|
|
1512
|
+
};
|
|
1513
|
+
}
|
|
1514
|
+
|
|
1380
1515
|
interface CardIssuing {
|
|
1381
1516
|
/**
|
|
1382
|
-
* Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://
|
|
1517
|
+
* Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://stripe.com/issuing/connect/tos_acceptance).
|
|
1383
1518
|
*/
|
|
1384
1519
|
tos_acceptance?: CardIssuing.TosAcceptance;
|
|
1385
1520
|
}
|
|
@@ -1458,12 +1593,12 @@ declare module 'stripe' {
|
|
|
1458
1593
|
|
|
1459
1594
|
interface Payouts {
|
|
1460
1595
|
/**
|
|
1461
|
-
* A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://
|
|
1596
|
+
* A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/connect/account-balances).
|
|
1462
1597
|
*/
|
|
1463
1598
|
debit_negative_balances?: boolean;
|
|
1464
1599
|
|
|
1465
1600
|
/**
|
|
1466
|
-
* Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://
|
|
1601
|
+
* Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/connect/bank-transfers#payout-information) documentation.
|
|
1467
1602
|
*/
|
|
1468
1603
|
schedule?: Payouts.Schedule;
|
|
1469
1604
|
|
|
@@ -1476,7 +1611,7 @@ declare module 'stripe' {
|
|
|
1476
1611
|
namespace Payouts {
|
|
1477
1612
|
interface Schedule {
|
|
1478
1613
|
/**
|
|
1479
|
-
* The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://
|
|
1614
|
+
* The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/connect/manage-payout-schedule).
|
|
1480
1615
|
*/
|
|
1481
1616
|
delay_days?: 'minimum' | number;
|
|
1482
1617
|
|
|
@@ -1510,6 +1645,13 @@ declare module 'stripe' {
|
|
|
1510
1645
|
}
|
|
1511
1646
|
}
|
|
1512
1647
|
|
|
1648
|
+
interface TaxForms {
|
|
1649
|
+
/**
|
|
1650
|
+
* Whether the account opted out of receiving their tax forms by postal delivery.
|
|
1651
|
+
*/
|
|
1652
|
+
consented_to_paperless_delivery?: boolean;
|
|
1653
|
+
}
|
|
1654
|
+
|
|
1513
1655
|
interface Treasury {
|
|
1514
1656
|
/**
|
|
1515
1657
|
* Details on the account's acceptance of the Stripe Treasury Services Agreement.
|
|
@@ -1644,6 +1786,11 @@ declare module 'stripe' {
|
|
|
1644
1786
|
*/
|
|
1645
1787
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
1646
1788
|
|
|
1789
|
+
/**
|
|
1790
|
+
* A hash to configure risk controls on the account. Please see [this page for more details](https://stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts).
|
|
1791
|
+
*/
|
|
1792
|
+
risk_controls?: AccountUpdateParams.RiskControls;
|
|
1793
|
+
|
|
1647
1794
|
/**
|
|
1648
1795
|
* Options for customizing how the account functions within Stripe.
|
|
1649
1796
|
*/
|
|
@@ -1706,7 +1853,7 @@ declare module 'stripe' {
|
|
|
1706
1853
|
estimated_worker_count?: number;
|
|
1707
1854
|
|
|
1708
1855
|
/**
|
|
1709
|
-
* [The merchant category code for the account](https://
|
|
1856
|
+
* [The merchant category code for the account](https://stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
|
|
1710
1857
|
*/
|
|
1711
1858
|
mcc?: string;
|
|
1712
1859
|
|
|
@@ -1754,7 +1901,7 @@ declare module 'stripe' {
|
|
|
1754
1901
|
namespace BusinessProfile {
|
|
1755
1902
|
interface AnnualRevenue {
|
|
1756
1903
|
/**
|
|
1757
|
-
* A non-negative integer representing the amount in the [smallest currency unit](https://
|
|
1904
|
+
* A non-negative integer representing the amount in the [smallest currency unit](https://stripe.com/currencies#zero-decimal).
|
|
1758
1905
|
*/
|
|
1759
1906
|
amount: number;
|
|
1760
1907
|
|
|
@@ -1771,7 +1918,7 @@ declare module 'stripe' {
|
|
|
1771
1918
|
|
|
1772
1919
|
interface MonthlyEstimatedRevenue {
|
|
1773
1920
|
/**
|
|
1774
|
-
* A non-negative integer representing how much to charge in the [smallest currency unit](https://
|
|
1921
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/currencies#zero-decimal).
|
|
1775
1922
|
*/
|
|
1776
1923
|
amount: number;
|
|
1777
1924
|
|
|
@@ -1954,11 +2101,26 @@ declare module 'stripe' {
|
|
|
1954
2101
|
*/
|
|
1955
2102
|
paynow_payments?: Capabilities.PaynowPayments;
|
|
1956
2103
|
|
|
2104
|
+
/**
|
|
2105
|
+
* The paypal_payments capability.
|
|
2106
|
+
*/
|
|
2107
|
+
paypal_payments?: Capabilities.PaypalPayments;
|
|
2108
|
+
|
|
2109
|
+
/**
|
|
2110
|
+
* The payto_payments capability.
|
|
2111
|
+
*/
|
|
2112
|
+
payto_payments?: Capabilities.PaytoPayments;
|
|
2113
|
+
|
|
1957
2114
|
/**
|
|
1958
2115
|
* The promptpay_payments capability.
|
|
1959
2116
|
*/
|
|
1960
2117
|
promptpay_payments?: Capabilities.PromptpayPayments;
|
|
1961
2118
|
|
|
2119
|
+
/**
|
|
2120
|
+
* The rechnung_payments capability.
|
|
2121
|
+
*/
|
|
2122
|
+
rechnung_payments?: Capabilities.RechnungPayments;
|
|
2123
|
+
|
|
1962
2124
|
/**
|
|
1963
2125
|
* The revolut_pay_payments capability.
|
|
1964
2126
|
*/
|
|
@@ -2257,6 +2419,20 @@ declare module 'stripe' {
|
|
|
2257
2419
|
requested?: boolean;
|
|
2258
2420
|
}
|
|
2259
2421
|
|
|
2422
|
+
interface PaypalPayments {
|
|
2423
|
+
/**
|
|
2424
|
+
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
2425
|
+
*/
|
|
2426
|
+
requested?: boolean;
|
|
2427
|
+
}
|
|
2428
|
+
|
|
2429
|
+
interface PaytoPayments {
|
|
2430
|
+
/**
|
|
2431
|
+
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
2432
|
+
*/
|
|
2433
|
+
requested?: boolean;
|
|
2434
|
+
}
|
|
2435
|
+
|
|
2260
2436
|
interface PromptpayPayments {
|
|
2261
2437
|
/**
|
|
2262
2438
|
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
@@ -2264,6 +2440,13 @@ declare module 'stripe' {
|
|
|
2264
2440
|
requested?: boolean;
|
|
2265
2441
|
}
|
|
2266
2442
|
|
|
2443
|
+
interface RechnungPayments {
|
|
2444
|
+
/**
|
|
2445
|
+
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
2446
|
+
*/
|
|
2447
|
+
requested?: boolean;
|
|
2448
|
+
}
|
|
2449
|
+
|
|
2267
2450
|
interface RevolutPayPayments {
|
|
2268
2451
|
/**
|
|
2269
2452
|
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
|
|
@@ -2416,12 +2599,12 @@ declare module 'stripe' {
|
|
|
2416
2599
|
address_kanji?: Stripe.JapanAddressParam;
|
|
2417
2600
|
|
|
2418
2601
|
/**
|
|
2419
|
-
* Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://
|
|
2602
|
+
* Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
|
|
2420
2603
|
*/
|
|
2421
2604
|
directors_provided?: boolean;
|
|
2422
2605
|
|
|
2423
2606
|
/**
|
|
2424
|
-
* Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://
|
|
2607
|
+
* Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.executive` requirement.
|
|
2425
2608
|
*/
|
|
2426
2609
|
executives_provided?: boolean;
|
|
2427
2610
|
|
|
@@ -2451,7 +2634,7 @@ declare module 'stripe' {
|
|
|
2451
2634
|
name_kanji?: string;
|
|
2452
2635
|
|
|
2453
2636
|
/**
|
|
2454
|
-
* Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://
|
|
2637
|
+
* Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.owner` requirement.
|
|
2455
2638
|
*/
|
|
2456
2639
|
owners_provided?: boolean;
|
|
2457
2640
|
|
|
@@ -2471,7 +2654,7 @@ declare module 'stripe' {
|
|
|
2471
2654
|
registration_number?: string;
|
|
2472
2655
|
|
|
2473
2656
|
/**
|
|
2474
|
-
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://
|
|
2657
|
+
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
|
|
2475
2658
|
*/
|
|
2476
2659
|
structure?: Stripe.Emptyable<Company.Structure>;
|
|
2477
2660
|
|
|
@@ -2701,12 +2884,12 @@ declare module 'stripe' {
|
|
|
2701
2884
|
gender?: string;
|
|
2702
2885
|
|
|
2703
2886
|
/**
|
|
2704
|
-
* The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://
|
|
2887
|
+
* The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/js/tokens/create_token?type=pii).
|
|
2705
2888
|
*/
|
|
2706
2889
|
id_number?: string;
|
|
2707
2890
|
|
|
2708
2891
|
/**
|
|
2709
|
-
* The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://
|
|
2892
|
+
* The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/js/tokens/create_token?type=pii).
|
|
2710
2893
|
*/
|
|
2711
2894
|
id_number_secondary?: string;
|
|
2712
2895
|
|
|
@@ -2852,6 +3035,36 @@ declare module 'stripe' {
|
|
|
2852
3035
|
}
|
|
2853
3036
|
}
|
|
2854
3037
|
|
|
3038
|
+
interface RiskControls {
|
|
3039
|
+
/**
|
|
3040
|
+
* Represents the risk control status of charges. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
|
|
3041
|
+
*/
|
|
3042
|
+
charges?: RiskControls.Charges;
|
|
3043
|
+
|
|
3044
|
+
/**
|
|
3045
|
+
* Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
|
|
3046
|
+
*/
|
|
3047
|
+
payouts?: RiskControls.Payouts;
|
|
3048
|
+
}
|
|
3049
|
+
|
|
3050
|
+
namespace RiskControls {
|
|
3051
|
+
interface Charges {
|
|
3052
|
+
/**
|
|
3053
|
+
* To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
|
|
3054
|
+
* There can be a delay before the risk control is paused or unpaused.
|
|
3055
|
+
*/
|
|
3056
|
+
pause_requested?: boolean;
|
|
3057
|
+
}
|
|
3058
|
+
|
|
3059
|
+
interface Payouts {
|
|
3060
|
+
/**
|
|
3061
|
+
* To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
|
|
3062
|
+
* There can be a delay before the risk control is paused or unpaused.
|
|
3063
|
+
*/
|
|
3064
|
+
pause_requested?: boolean;
|
|
3065
|
+
}
|
|
3066
|
+
}
|
|
3067
|
+
|
|
2855
3068
|
interface Settings {
|
|
2856
3069
|
/**
|
|
2857
3070
|
* Settings specific to Bacs Direct Debit payments.
|
|
@@ -2863,6 +3076,11 @@ declare module 'stripe' {
|
|
|
2863
3076
|
*/
|
|
2864
3077
|
branding?: Settings.Branding;
|
|
2865
3078
|
|
|
3079
|
+
/**
|
|
3080
|
+
* Settings specific to the account's use of the Capital product.
|
|
3081
|
+
*/
|
|
3082
|
+
capital?: Settings.Capital;
|
|
3083
|
+
|
|
2866
3084
|
/**
|
|
2867
3085
|
* Settings specific to the account's use of the Card Issuing product.
|
|
2868
3086
|
*/
|
|
@@ -2888,6 +3106,11 @@ declare module 'stripe' {
|
|
|
2888
3106
|
*/
|
|
2889
3107
|
payouts?: Settings.Payouts;
|
|
2890
3108
|
|
|
3109
|
+
/**
|
|
3110
|
+
* Settings specific to the account's tax forms.
|
|
3111
|
+
*/
|
|
3112
|
+
tax_forms?: Settings.TaxForms;
|
|
3113
|
+
|
|
2891
3114
|
/**
|
|
2892
3115
|
* Settings specific to the account's Treasury FinancialAccounts.
|
|
2893
3116
|
*/
|
|
@@ -2924,9 +3147,25 @@ declare module 'stripe' {
|
|
|
2924
3147
|
secondary_color?: string;
|
|
2925
3148
|
}
|
|
2926
3149
|
|
|
3150
|
+
interface Capital {
|
|
3151
|
+
/**
|
|
3152
|
+
* Per-currency mapping of user-selected destination accounts used to pay out loans.
|
|
3153
|
+
*/
|
|
3154
|
+
payout_destination?: {
|
|
3155
|
+
[key: string]: string;
|
|
3156
|
+
};
|
|
3157
|
+
|
|
3158
|
+
/**
|
|
3159
|
+
* Per-currency mapping of all destination accounts eligible to receive Capital financing payouts.
|
|
3160
|
+
*/
|
|
3161
|
+
payout_destination_selector?: {
|
|
3162
|
+
[key: string]: Array<string>;
|
|
3163
|
+
};
|
|
3164
|
+
}
|
|
3165
|
+
|
|
2927
3166
|
interface CardIssuing {
|
|
2928
3167
|
/**
|
|
2929
|
-
* Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://
|
|
3168
|
+
* Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://stripe.com/issuing/connect/tos_acceptance).
|
|
2930
3169
|
*/
|
|
2931
3170
|
tos_acceptance?: CardIssuing.TosAcceptance;
|
|
2932
3171
|
}
|
|
@@ -3012,12 +3251,12 @@ declare module 'stripe' {
|
|
|
3012
3251
|
|
|
3013
3252
|
interface Payouts {
|
|
3014
3253
|
/**
|
|
3015
|
-
* A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://
|
|
3254
|
+
* A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/connect/account-balances).
|
|
3016
3255
|
*/
|
|
3017
3256
|
debit_negative_balances?: boolean;
|
|
3018
3257
|
|
|
3019
3258
|
/**
|
|
3020
|
-
* Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://
|
|
3259
|
+
* Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/connect/bank-transfers#payout-information) documentation.
|
|
3021
3260
|
*/
|
|
3022
3261
|
schedule?: Payouts.Schedule;
|
|
3023
3262
|
|
|
@@ -3030,7 +3269,7 @@ declare module 'stripe' {
|
|
|
3030
3269
|
namespace Payouts {
|
|
3031
3270
|
interface Schedule {
|
|
3032
3271
|
/**
|
|
3033
|
-
* The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://
|
|
3272
|
+
* The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/connect/manage-payout-schedule).
|
|
3034
3273
|
*/
|
|
3035
3274
|
delay_days?: 'minimum' | number;
|
|
3036
3275
|
|
|
@@ -3064,6 +3303,13 @@ declare module 'stripe' {
|
|
|
3064
3303
|
}
|
|
3065
3304
|
}
|
|
3066
3305
|
|
|
3306
|
+
interface TaxForms {
|
|
3307
|
+
/**
|
|
3308
|
+
* Whether the account opted out of receiving their tax forms by postal delivery.
|
|
3309
|
+
*/
|
|
3310
|
+
consented_to_paperless_delivery?: boolean;
|
|
3311
|
+
}
|
|
3312
|
+
|
|
3067
3313
|
interface Treasury {
|
|
3068
3314
|
/**
|
|
3069
3315
|
* Details on the account's acceptance of the Stripe Treasury Services Agreement.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec
|
|
2
|
+
|
|
3
|
+
declare module 'stripe' {
|
|
4
|
+
namespace Stripe {
|
|
5
|
+
namespace Billing {
|
|
6
|
+
/**
|
|
7
|
+
* The AlertTriggered object.
|
|
8
|
+
*/
|
|
9
|
+
interface AlertTriggered {
|
|
10
|
+
/**
|
|
11
|
+
* String representing the object's type. Objects of the same type share the same value.
|
|
12
|
+
*/
|
|
13
|
+
object: 'billing.alert_triggered';
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
|
|
17
|
+
*/
|
|
18
|
+
alert: Stripe.Billing.Alert;
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
22
|
+
*/
|
|
23
|
+
created: number;
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* ID of customer for which the alert triggered
|
|
27
|
+
*/
|
|
28
|
+
customer: string;
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
32
|
+
*/
|
|
33
|
+
livemode: boolean;
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* The value triggering the alert
|
|
37
|
+
*/
|
|
38
|
+
value: number;
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|