stripe 20.1.0-alpha.4 → 20.2.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/OPENAPI_VERSION +1 -1
- package/VERSION +1 -1
- package/cjs/Error.js +9 -1
- package/cjs/apiVersion.js +1 -1
- package/cjs/resources/SharedPayment/GrantedTokens.js +12 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +16 -0
- package/cjs/resources/V2/Iam/ApiKeys.js +24 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +20 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +33 -0
- package/cjs/resources/V2/Tax/ManualRules.js +23 -0
- package/cjs/resources.js +15 -1
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +7 -0
- package/esm/apiVersion.js +1 -1
- package/esm/resources/SharedPayment/GrantedTokens.js +9 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +13 -0
- package/esm/resources/V2/Iam/ApiKeys.js +21 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +17 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.js +30 -0
- package/esm/resources/V2/Tax/ManualRules.js +20 -0
- package/esm/resources.js +14 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinks.d.ts +1 -1
- package/types/AccountNotices.d.ts +6 -6
- package/types/AccountNoticesResource.d.ts +1 -1
- package/types/AccountSessions.d.ts +7 -7
- package/types/AccountSessionsResource.d.ts +21 -0
- package/types/Accounts.d.ts +25 -25
- package/types/AccountsResource.d.ts +107 -63
- package/types/ApplicationFeesResource.d.ts +2 -2
- package/types/Apps/Secrets.d.ts +1 -1
- package/types/Balance.d.ts +2 -2
- package/types/BalanceSettings.d.ts +1 -1
- package/types/BalanceTransactions.d.ts +1 -1
- package/types/BalanceTransfers.d.ts +3 -3
- package/types/BalanceTransfersResource.d.ts +1 -1
- package/types/BankAccounts.d.ts +10 -10
- package/types/Billing/Alerts.d.ts +2 -2
- package/types/Billing/CreditBalanceSummary.d.ts +3 -3
- package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactions.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
- package/types/Billing/CreditGrants.d.ts +4 -4
- package/types/Billing/CreditGrantsResource.d.ts +3 -3
- package/types/Billing/MeterEvents.d.ts +1 -1
- package/types/Billing/MeterEventsResource.d.ts +1 -1
- package/types/BillingPortal/Configurations.d.ts +10 -3
- package/types/BillingPortal/ConfigurationsResource.d.ts +20 -6
- package/types/BillingPortal/Sessions.d.ts +7 -7
- package/types/BillingPortal/SessionsResource.d.ts +7 -7
- package/types/Capabilities.d.ts +16 -16
- package/types/Capital/FinancingOffers.d.ts +2 -2
- package/types/Capital/FinancingSummary.d.ts +7 -4
- package/types/Capital/FinancingSummaryResource.d.ts +1 -1
- package/types/Cards.d.ts +2 -2
- package/types/CashBalances.d.ts +3 -3
- package/types/Charges.d.ts +59 -27
- package/types/ChargesResource.d.ts +22 -22
- package/types/Checkout/Sessions.d.ts +18 -18
- package/types/Checkout/SessionsResource.d.ts +90 -60
- package/types/Climate/Orders.d.ts +1 -1
- package/types/Climate/OrdersResource.d.ts +2 -2
- package/types/ConfirmationTokens.d.ts +8 -6
- package/types/Coupons.d.ts +3 -3
- package/types/CouponsResource.d.ts +2 -2
- package/types/CreditNoteLineItems.d.ts +3 -0
- package/types/CreditNotes.d.ts +8 -5
- package/types/CreditNotesResource.d.ts +5 -5
- package/types/CustomerBalanceTransactions.d.ts +9 -6
- package/types/CustomerCashBalanceTransactions.d.ts +13 -10
- package/types/CustomerSessions.d.ts +1 -1
- package/types/Customers.d.ts +8 -5
- package/types/CustomersResource.d.ts +21 -16
- package/types/DelegatedCheckout/RequestedSessions.d.ts +83 -17
- package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +102 -0
- package/types/Discounts.d.ts +6 -6
- package/types/Disputes.d.ts +3 -3
- package/types/DisputesResource.d.ts +1 -1
- package/types/Entitlements/ActiveEntitlements.d.ts +1 -1
- package/types/Errors.d.ts +6 -0
- package/types/Events.d.ts +1 -1
- package/types/ExchangeRates.d.ts +2 -2
- package/types/ExternalAccountsResource.d.ts +4 -4
- package/types/FeeRefunds.d.ts +2 -2
- package/types/FileLinks.d.ts +1 -1
- package/types/FileLinksResource.d.ts +2 -2
- package/types/Files.d.ts +4 -4
- package/types/FilesResource.d.ts +3 -3
- package/types/FinancialConnections/Accounts.d.ts +3 -3
- package/types/FinancialConnections/AccountsResource.d.ts +3 -3
- package/types/FinancialConnections/Sessions.d.ts +2 -2
- package/types/FinancialConnections/SessionsResource.d.ts +3 -3
- package/types/Forwarding/Requests.d.ts +1 -1
- package/types/Forwarding/RequestsResource.d.ts +1 -1
- package/types/FundingInstructions.d.ts +2 -2
- package/types/Identity/BlocklistEntries.d.ts +1 -1
- package/types/Identity/VerificationReports.d.ts +8 -8
- package/types/Identity/VerificationSessions.d.ts +11 -11
- package/types/Identity/VerificationSessionsResource.d.ts +18 -12
- package/types/InvoiceItems.d.ts +12 -12
- package/types/InvoiceItemsResource.d.ts +16 -16
- package/types/InvoiceLineItems.d.ts +11 -8
- package/types/InvoicePayments.d.ts +1 -1
- package/types/InvoiceRenderingTemplates.d.ts +1 -1
- package/types/Invoices.d.ts +83 -33
- package/types/InvoicesResource.d.ts +237 -111
- package/types/Issuing/Authorizations.d.ts +20 -20
- package/types/Issuing/AuthorizationsResource.d.ts +4 -4
- package/types/Issuing/Cardholders.d.ts +13 -13
- package/types/Issuing/CardholdersResource.d.ts +21 -21
- package/types/Issuing/Cards.d.ts +20 -10
- package/types/Issuing/CardsResource.d.ts +46 -13
- package/types/Issuing/CreditUnderwritingRecords.d.ts +5 -5
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +15 -15
- package/types/Issuing/Disputes.d.ts +7 -7
- package/types/Issuing/DisputesResource.d.ts +5 -5
- package/types/Issuing/FraudLiabilityDebits.d.ts +1 -1
- package/types/Issuing/PersonalizationDesigns.d.ts +1 -1
- package/types/Issuing/PersonalizationDesignsResource.d.ts +2 -2
- package/types/Issuing/Programs.d.ts +1 -1
- package/types/Issuing/ProgramsResource.d.ts +1 -1
- package/types/Issuing/Settlements.d.ts +2 -2
- package/types/Issuing/Tokens.d.ts +1 -1
- package/types/Issuing/Transactions.d.ts +13 -13
- package/types/Issuing/TransactionsResource.d.ts +1 -1
- package/types/LineItems.d.ts +3 -3
- package/types/LoginLinks.d.ts +1 -1
- package/types/MandatesResource.d.ts +1 -1
- package/types/Margins.d.ts +1 -1
- package/types/MarginsResource.d.ts +2 -2
- package/types/Orders.d.ts +11 -11
- package/types/OrdersResource.d.ts +24 -24
- package/types/PaymentAttemptRecords.d.ts +119 -18
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +3 -3
- package/types/PaymentIntents.d.ts +72 -44
- package/types/PaymentIntentsResource.d.ts +172 -159
- package/types/PaymentLinks.d.ts +7 -7
- package/types/PaymentLinksResource.d.ts +42 -28
- package/types/PaymentMethodConfigurations.d.ts +4 -4
- package/types/PaymentMethodConfigurationsResource.d.ts +80 -80
- package/types/PaymentMethodDomains.d.ts +1 -1
- package/types/PaymentMethods.d.ts +10 -8
- package/types/PaymentMethodsResource.d.ts +7 -6
- package/types/PaymentRecords.d.ts +126 -18
- package/types/PaymentRecordsResource.d.ts +7 -7
- package/types/Payouts.d.ts +7 -7
- package/types/PayoutsResource.d.ts +3 -3
- package/types/Persons.d.ts +21 -21
- package/types/Plans.d.ts +5 -5
- package/types/PlansResource.d.ts +6 -6
- package/types/Prices.d.ts +6 -6
- package/types/PricesResource.d.ts +10 -10
- package/types/ProductCatalog/TrialOffers.d.ts +1 -1
- package/types/Products.d.ts +10 -10
- package/types/ProductsResource.d.ts +38 -14
- package/types/PromotionCodes.d.ts +5 -5
- package/types/PromotionCodesResource.d.ts +5 -5
- package/types/QuoteLines.d.ts +3 -3
- package/types/QuotePreviewInvoices.d.ts +81 -31
- package/types/QuotePreviewSubscriptionSchedules.d.ts +18 -18
- package/types/Quotes.d.ts +16 -16
- package/types/QuotesResource.d.ts +30 -30
- package/types/Radar/EarlyFraudWarnings.d.ts +1 -1
- package/types/Radar/ValueListItems.d.ts +1 -1
- package/types/Radar/ValueLists.d.ts +2 -2
- package/types/Radar/ValueListsResource.d.ts +2 -2
- package/types/Refunds.d.ts +3 -3
- package/types/RefundsResource.d.ts +3 -3
- package/types/Reporting/ReportRuns.d.ts +3 -3
- package/types/Reporting/ReportRunsResource.d.ts +2 -2
- package/types/Reporting/ReportTypes.d.ts +3 -3
- package/types/Reviews.d.ts +1 -1
- package/types/SetupAttempts.d.ts +21 -18
- package/types/SetupIntents.d.ts +20 -19
- package/types/SetupIntentsResource.d.ts +47 -44
- package/types/SharedPayment/GrantedTokens.d.ts +102 -0
- package/types/SharedPayment/GrantedTokensResource.d.ts +29 -0
- package/types/ShippingRates.d.ts +3 -3
- package/types/ShippingRatesResource.d.ts +3 -3
- package/types/Sigma/ScheduledQueryRuns.d.ts +1 -1
- package/types/SourceMandateNotifications.d.ts +3 -3
- package/types/Sources.d.ts +5 -5
- package/types/SourcesResource.d.ts +2 -2
- package/types/SubscriptionItems.d.ts +7 -7
- package/types/SubscriptionItemsResource.d.ts +22 -22
- package/types/SubscriptionSchedules.d.ts +19 -19
- package/types/SubscriptionSchedulesResource.d.ts +61 -61
- package/types/Subscriptions.d.ts +61 -15
- package/types/SubscriptionsResource.d.ts +142 -58
- package/types/Tax/Associations.d.ts +3 -3
- package/types/Tax/AssociationsResource.d.ts +1 -1
- package/types/Tax/CalculationLineItems.d.ts +7 -7
- package/types/Tax/Calculations.d.ts +12 -12
- package/types/Tax/CalculationsResource.d.ts +7 -7
- package/types/Tax/Registrations.d.ts +3 -3
- package/types/Tax/Settings.d.ts +1 -1
- package/types/Tax/SettingsResource.d.ts +1 -1
- package/types/Tax/TransactionLineItems.d.ts +5 -5
- package/types/Tax/Transactions.d.ts +9 -9
- package/types/Tax/TransactionsResource.d.ts +10 -10
- package/types/TaxIds.d.ts +6 -6
- package/types/TaxIdsResource.d.ts +4 -4
- package/types/TaxRates.d.ts +1 -1
- package/types/TaxRatesResource.d.ts +2 -2
- package/types/Terminal/ConnectionTokens.d.ts +1 -1
- package/types/Terminal/Locations.d.ts +2 -2
- package/types/Terminal/LocationsResource.d.ts +3 -3
- package/types/Terminal/Readers.d.ts +10 -10
- package/types/Terminal/ReadersResource.d.ts +7 -7
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +5 -4
- package/types/TestHelpers/CustomersResource.d.ts +2 -2
- package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +10 -10
- package/types/TestHelpers/Issuing/TransactionsResource.d.ts +5 -5
- package/types/TestHelpers/SharedPayment/GrantedTokensResource.d.ts +87 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +1 -1
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +1 -1
- package/types/Tokens.d.ts +4 -4
- package/types/TokensResource.d.ts +17 -17
- package/types/Topups.d.ts +3 -3
- package/types/TopupsResource.d.ts +3 -3
- package/types/TransferReversals.d.ts +4 -4
- package/types/Transfers.d.ts +5 -5
- package/types/TransfersResource.d.ts +6 -6
- package/types/Treasury/CreditReversals.d.ts +3 -3
- package/types/Treasury/CreditReversalsResource.d.ts +1 -1
- package/types/Treasury/DebitReversals.d.ts +3 -3
- package/types/Treasury/DebitReversalsResource.d.ts +1 -1
- package/types/Treasury/FinancialAccounts.d.ts +1 -1
- package/types/Treasury/FinancialAccountsResource.d.ts +2 -2
- package/types/Treasury/InboundTransfers.d.ts +4 -4
- package/types/Treasury/InboundTransfersResource.d.ts +2 -2
- package/types/Treasury/OutboundPayments.d.ts +5 -5
- package/types/Treasury/OutboundPaymentsResource.d.ts +4 -4
- package/types/Treasury/OutboundTransfers.d.ts +4 -4
- package/types/Treasury/OutboundTransfersResource.d.ts +3 -3
- package/types/Treasury/ReceivedCredits.d.ts +9 -9
- package/types/Treasury/ReceivedDebits.d.ts +6 -6
- package/types/Treasury/TransactionEntries.d.ts +11 -11
- package/types/Treasury/Transactions.d.ts +11 -11
- package/types/V2/Billing/IntentActions.d.ts +141 -36
- package/types/V2/Billing/IntentsResource.d.ts +141 -42
- package/types/V2/Core/AccountLinks.d.ts +11 -11
- package/types/V2/Core/AccountLinksResource.d.ts +6 -6
- package/types/V2/Core/AccountPersons.d.ts +55 -10
- package/types/V2/Core/AccountTokensResource.d.ts +99 -10
- package/types/V2/Core/Accounts/PersonTokensResource.d.ts +48 -3
- package/types/V2/Core/Accounts/PersonsResource.d.ts +101 -11
- package/types/V2/Core/Accounts.d.ts +298 -509
- package/types/V2/Core/AccountsResource.d.ts +256 -51
- package/types/V2/Core/ClaimableSandboxesResource.d.ts +1 -1
- package/types/V2/Core/EventTypes.d.ts +601 -0
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +21 -0
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +26 -0
- package/types/V2/Iam/ApiKeys.d.ts +154 -0
- package/types/V2/Iam/ApiKeysResource.d.ts +215 -0
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +31 -1
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +8 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +2 -0
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +26 -0
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +2 -0
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +10 -1
- package/types/V2/Payments/SettlementAllocationIntentSplits.d.ts +111 -0
- package/types/V2/Payments/SettlementAllocationIntents/SplitsResource.d.ts +126 -0
- package/types/V2/Payments/SettlementAllocationIntents.d.ts +122 -0
- package/types/V2/Payments/SettlementAllocationIntentsResource.d.ts +168 -0
- package/types/V2/Tax/ManualRules.d.ts +142 -0
- package/types/V2/Tax/ManualRulesResource.d.ts +292 -0
- package/types/WebhookEndpoints.d.ts +1 -1
- package/types/WebhookEndpointsResource.d.ts +4 -3
- package/types/apiVersion.d.ts +1 -1
- package/types/index.d.ts +24 -0
|
@@ -14,7 +14,7 @@ declare module 'stripe' {
|
|
|
14
14
|
* the verification flow. The VerificationSession contains the user's verified data after
|
|
15
15
|
* verification checks are complete.
|
|
16
16
|
*
|
|
17
|
-
* Related guide: [The Verification Sessions API](https://stripe.com/
|
|
17
|
+
* Related guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions)
|
|
18
18
|
*/
|
|
19
19
|
interface VerificationSession {
|
|
20
20
|
/**
|
|
@@ -33,7 +33,7 @@ declare module 'stripe' {
|
|
|
33
33
|
client_reference_id: string | null;
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
* The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/
|
|
36
|
+
* The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don't store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more.
|
|
37
37
|
*/
|
|
38
38
|
client_secret: string | null;
|
|
39
39
|
|
|
@@ -48,7 +48,7 @@ declare module 'stripe' {
|
|
|
48
48
|
last_error: VerificationSession.LastError | null;
|
|
49
49
|
|
|
50
50
|
/**
|
|
51
|
-
* ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/
|
|
51
|
+
* ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results)
|
|
52
52
|
*/
|
|
53
53
|
last_verification_report:
|
|
54
54
|
| string
|
|
@@ -61,7 +61,7 @@ declare module 'stripe' {
|
|
|
61
61
|
livemode: boolean;
|
|
62
62
|
|
|
63
63
|
/**
|
|
64
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
64
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
65
65
|
*/
|
|
66
66
|
metadata: Stripe.Metadata;
|
|
67
67
|
|
|
@@ -86,24 +86,24 @@ declare module 'stripe' {
|
|
|
86
86
|
related_customer: string | null;
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* The ID of the Account representing a customer.
|
|
90
90
|
*/
|
|
91
|
-
related_customer_account
|
|
91
|
+
related_customer_account: string | null;
|
|
92
92
|
|
|
93
93
|
related_person?: VerificationSession.RelatedPerson;
|
|
94
94
|
|
|
95
95
|
/**
|
|
96
|
-
* Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/
|
|
96
|
+
* Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).
|
|
97
97
|
*/
|
|
98
98
|
status: VerificationSession.Status;
|
|
99
99
|
|
|
100
100
|
/**
|
|
101
|
-
* The type of [verification check](https://stripe.com/
|
|
101
|
+
* The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.
|
|
102
102
|
*/
|
|
103
103
|
type: VerificationSession.Type;
|
|
104
104
|
|
|
105
105
|
/**
|
|
106
|
-
* The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don't store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/
|
|
106
|
+
* The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don't store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
|
|
107
107
|
*/
|
|
108
108
|
url: string | null;
|
|
109
109
|
|
|
@@ -174,7 +174,7 @@ declare module 'stripe' {
|
|
|
174
174
|
allowed_types?: Array<Document.AllowedType>;
|
|
175
175
|
|
|
176
176
|
/**
|
|
177
|
-
* Collect an ID number and perform an [ID number check](https://stripe.com/
|
|
177
|
+
* Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
|
|
178
178
|
*/
|
|
179
179
|
require_id_number?: boolean;
|
|
180
180
|
|
|
@@ -184,7 +184,7 @@ declare module 'stripe' {
|
|
|
184
184
|
require_live_capture?: boolean;
|
|
185
185
|
|
|
186
186
|
/**
|
|
187
|
-
* Capture a face image and perform a [selfie check](https://stripe.com/
|
|
187
|
+
* Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie).
|
|
188
188
|
*/
|
|
189
189
|
require_matching_selfie?: boolean;
|
|
190
190
|
}
|
|
@@ -15,7 +15,7 @@ declare module 'stripe' {
|
|
|
15
15
|
expand?: Array<string>;
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
18
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
19
19
|
*/
|
|
20
20
|
metadata?: Stripe.MetadataParam;
|
|
21
21
|
|
|
@@ -35,7 +35,7 @@ declare module 'stripe' {
|
|
|
35
35
|
related_customer?: string;
|
|
36
36
|
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* The ID of the Account representing a customer.
|
|
39
39
|
*/
|
|
40
40
|
related_customer_account?: string;
|
|
41
41
|
|
|
@@ -50,7 +50,7 @@ declare module 'stripe' {
|
|
|
50
50
|
return_url?: string;
|
|
51
51
|
|
|
52
52
|
/**
|
|
53
|
-
* The type of [verification check](https://stripe.com/
|
|
53
|
+
* The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
|
|
54
54
|
*/
|
|
55
55
|
type?: VerificationSessionCreateParams.Type;
|
|
56
56
|
|
|
@@ -63,7 +63,7 @@ declare module 'stripe' {
|
|
|
63
63
|
namespace VerificationSessionCreateParams {
|
|
64
64
|
interface Options {
|
|
65
65
|
/**
|
|
66
|
-
* Options that apply to the [document check](https://stripe.com/
|
|
66
|
+
* Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document).
|
|
67
67
|
*/
|
|
68
68
|
document?: Stripe.Emptyable<Options.Document>;
|
|
69
69
|
}
|
|
@@ -76,7 +76,7 @@ declare module 'stripe' {
|
|
|
76
76
|
allowed_types?: Array<Document.AllowedType>;
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
* Collect an ID number and perform an [ID number check](https://stripe.com/
|
|
79
|
+
* Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
|
|
80
80
|
*/
|
|
81
81
|
require_id_number?: boolean;
|
|
82
82
|
|
|
@@ -86,7 +86,7 @@ declare module 'stripe' {
|
|
|
86
86
|
require_live_capture?: boolean;
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
* Capture a face image and perform a [selfie check](https://stripe.com/
|
|
89
|
+
* Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie).
|
|
90
90
|
*/
|
|
91
91
|
require_matching_selfie?: boolean;
|
|
92
92
|
}
|
|
@@ -137,7 +137,7 @@ declare module 'stripe' {
|
|
|
137
137
|
expand?: Array<string>;
|
|
138
138
|
|
|
139
139
|
/**
|
|
140
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
140
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
141
141
|
*/
|
|
142
142
|
metadata?: Stripe.MetadataParam;
|
|
143
143
|
|
|
@@ -152,7 +152,7 @@ declare module 'stripe' {
|
|
|
152
152
|
provided_details?: VerificationSessionUpdateParams.ProvidedDetails;
|
|
153
153
|
|
|
154
154
|
/**
|
|
155
|
-
* The type of [verification check](https://stripe.com/
|
|
155
|
+
* The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.
|
|
156
156
|
*/
|
|
157
157
|
type?: VerificationSessionUpdateParams.Type;
|
|
158
158
|
}
|
|
@@ -160,7 +160,7 @@ declare module 'stripe' {
|
|
|
160
160
|
namespace VerificationSessionUpdateParams {
|
|
161
161
|
interface Options {
|
|
162
162
|
/**
|
|
163
|
-
* Options that apply to the [document check](https://stripe.com/
|
|
163
|
+
* Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document).
|
|
164
164
|
*/
|
|
165
165
|
document?: Stripe.Emptyable<Options.Document>;
|
|
166
166
|
}
|
|
@@ -173,7 +173,7 @@ declare module 'stripe' {
|
|
|
173
173
|
allowed_types?: Array<Document.AllowedType>;
|
|
174
174
|
|
|
175
175
|
/**
|
|
176
|
-
* Collect an ID number and perform an [ID number check](https://stripe.com/
|
|
176
|
+
* Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
|
|
177
177
|
*/
|
|
178
178
|
require_id_number?: boolean;
|
|
179
179
|
|
|
@@ -183,7 +183,7 @@ declare module 'stripe' {
|
|
|
183
183
|
require_live_capture?: boolean;
|
|
184
184
|
|
|
185
185
|
/**
|
|
186
|
-
* Capture a face image and perform a [selfie check](https://stripe.com/
|
|
186
|
+
* Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie).
|
|
187
187
|
*/
|
|
188
188
|
require_matching_selfie?: boolean;
|
|
189
189
|
}
|
|
@@ -224,12 +224,18 @@ declare module 'stripe' {
|
|
|
224
224
|
*/
|
|
225
225
|
expand?: Array<string>;
|
|
226
226
|
|
|
227
|
+
/**
|
|
228
|
+
* Customer ID
|
|
229
|
+
*/
|
|
227
230
|
related_customer?: string;
|
|
228
231
|
|
|
232
|
+
/**
|
|
233
|
+
* The ID of the Account representing a customer.
|
|
234
|
+
*/
|
|
229
235
|
related_customer_account?: string;
|
|
230
236
|
|
|
231
237
|
/**
|
|
232
|
-
* Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/
|
|
238
|
+
* Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).
|
|
233
239
|
*/
|
|
234
240
|
status?: VerificationSessionListParams.Status;
|
|
235
241
|
}
|
package/types/InvoiceItems.d.ts
CHANGED
|
@@ -23,14 +23,14 @@ declare module 'stripe' {
|
|
|
23
23
|
}
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
|
-
* Invoice Items represent the component lines of an [invoice](https://stripe.com/
|
|
26
|
+
* Invoice Items represent the component lines of an [invoice](https://docs.stripe.com/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://docs.stripe.com/api/invoices/line_item) within [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines).
|
|
27
27
|
*
|
|
28
28
|
* Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined
|
|
29
|
-
* with a [subscription](https://stripe.com/
|
|
29
|
+
* with a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge
|
|
30
30
|
* or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges
|
|
31
31
|
* (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.
|
|
32
32
|
*
|
|
33
|
-
* Related guides: [Integrate with the Invoicing API](https://stripe.com/
|
|
33
|
+
* Related guides: [Integrate with the Invoicing API](https://docs.stripe.com/invoicing/integration), [Subscription Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items).
|
|
34
34
|
*/
|
|
35
35
|
interface InvoiceItem {
|
|
36
36
|
/**
|
|
@@ -54,14 +54,14 @@ declare module 'stripe' {
|
|
|
54
54
|
currency: string;
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
|
-
* The ID of the customer
|
|
57
|
+
* The ID of the customer to bill for this invoice item.
|
|
58
58
|
*/
|
|
59
59
|
customer: string | Stripe.Customer | Stripe.DeletedCustomer;
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
|
-
* The ID of the account
|
|
62
|
+
* The ID of the account to bill for this invoice item.
|
|
63
63
|
*/
|
|
64
|
-
customer_account
|
|
64
|
+
customer_account: string | null;
|
|
65
65
|
|
|
66
66
|
/**
|
|
67
67
|
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
@@ -104,7 +104,7 @@ declare module 'stripe' {
|
|
|
104
104
|
margins?: Array<string | Stripe.Margin> | null;
|
|
105
105
|
|
|
106
106
|
/**
|
|
107
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
107
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
108
108
|
*/
|
|
109
109
|
metadata: Stripe.Metadata | null;
|
|
110
110
|
|
|
@@ -160,6 +160,11 @@ declare module 'stripe' {
|
|
|
160
160
|
*/
|
|
161
161
|
rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
|
|
162
162
|
|
|
163
|
+
/**
|
|
164
|
+
* Details about the subscription schedule that generated this invoice item
|
|
165
|
+
*/
|
|
166
|
+
schedule_details?: Parent.ScheduleDetails | null;
|
|
167
|
+
|
|
163
168
|
/**
|
|
164
169
|
* Details about the subscription that generated this invoice item
|
|
165
170
|
*/
|
|
@@ -169,11 +174,6 @@ declare module 'stripe' {
|
|
|
169
174
|
* The type of parent that generated this invoice item
|
|
170
175
|
*/
|
|
171
176
|
type: Parent.Type;
|
|
172
|
-
|
|
173
|
-
/**
|
|
174
|
-
* Details about the subscription schedule that generated this invoice item
|
|
175
|
-
*/
|
|
176
|
-
schedule_details?: Parent.ScheduleDetails | null;
|
|
177
177
|
}
|
|
178
178
|
|
|
179
179
|
namespace Parent {
|
|
@@ -14,12 +14,12 @@ declare module 'stripe' {
|
|
|
14
14
|
currency?: string;
|
|
15
15
|
|
|
16
16
|
/**
|
|
17
|
-
* The ID of the customer
|
|
17
|
+
* The ID of the customer to bill for this invoice item.
|
|
18
18
|
*/
|
|
19
19
|
customer?: string;
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
|
-
* The ID of the account
|
|
22
|
+
* The ID of the account representing the customer to bill for this invoice item.
|
|
23
23
|
*/
|
|
24
24
|
customer_account?: string;
|
|
25
25
|
|
|
@@ -54,17 +54,17 @@ declare module 'stripe' {
|
|
|
54
54
|
margins?: Array<string>;
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
57
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
58
58
|
*/
|
|
59
59
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
|
-
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/
|
|
62
|
+
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
|
|
63
63
|
*/
|
|
64
64
|
period?: InvoiceItemCreateParams.Period;
|
|
65
65
|
|
|
66
66
|
/**
|
|
67
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
67
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
68
68
|
*/
|
|
69
69
|
price_data?: InvoiceItemCreateParams.PriceData;
|
|
70
70
|
|
|
@@ -84,12 +84,12 @@ declare module 'stripe' {
|
|
|
84
84
|
subscription?: string;
|
|
85
85
|
|
|
86
86
|
/**
|
|
87
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
87
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
88
88
|
*/
|
|
89
89
|
tax_behavior?: InvoiceItemCreateParams.TaxBehavior;
|
|
90
90
|
|
|
91
91
|
/**
|
|
92
|
-
* A [tax code](https://stripe.com/
|
|
92
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
93
93
|
*/
|
|
94
94
|
tax_code?: Stripe.Emptyable<string>;
|
|
95
95
|
|
|
@@ -190,7 +190,7 @@ declare module 'stripe' {
|
|
|
190
190
|
product: string;
|
|
191
191
|
|
|
192
192
|
/**
|
|
193
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
193
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
194
194
|
*/
|
|
195
195
|
tax_behavior?: PriceData.TaxBehavior;
|
|
196
196
|
|
|
@@ -258,17 +258,17 @@ declare module 'stripe' {
|
|
|
258
258
|
margins?: Stripe.Emptyable<Array<string>>;
|
|
259
259
|
|
|
260
260
|
/**
|
|
261
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
261
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
262
262
|
*/
|
|
263
263
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
264
264
|
|
|
265
265
|
/**
|
|
266
|
-
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/
|
|
266
|
+
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
|
|
267
267
|
*/
|
|
268
268
|
period?: InvoiceItemUpdateParams.Period;
|
|
269
269
|
|
|
270
270
|
/**
|
|
271
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
271
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
272
272
|
*/
|
|
273
273
|
price_data?: InvoiceItemUpdateParams.PriceData;
|
|
274
274
|
|
|
@@ -283,12 +283,12 @@ declare module 'stripe' {
|
|
|
283
283
|
quantity?: number;
|
|
284
284
|
|
|
285
285
|
/**
|
|
286
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
286
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
287
287
|
*/
|
|
288
288
|
tax_behavior?: InvoiceItemUpdateParams.TaxBehavior;
|
|
289
289
|
|
|
290
290
|
/**
|
|
291
|
-
* A [tax code](https://stripe.com/
|
|
291
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
292
292
|
*/
|
|
293
293
|
tax_code?: Stripe.Emptyable<string>;
|
|
294
294
|
|
|
@@ -389,7 +389,7 @@ declare module 'stripe' {
|
|
|
389
389
|
product: string;
|
|
390
390
|
|
|
391
391
|
/**
|
|
392
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
392
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
393
393
|
*/
|
|
394
394
|
tax_behavior?: PriceData.TaxBehavior;
|
|
395
395
|
|
|
@@ -425,12 +425,12 @@ declare module 'stripe' {
|
|
|
425
425
|
created?: Stripe.RangeQueryParam | number;
|
|
426
426
|
|
|
427
427
|
/**
|
|
428
|
-
* The identifier of the customer whose invoice items to return. If none is provided, all invoice items
|
|
428
|
+
* The identifier of the customer whose invoice items to return. If none is provided, returns all invoice items.
|
|
429
429
|
*/
|
|
430
430
|
customer?: string;
|
|
431
431
|
|
|
432
432
|
/**
|
|
433
|
-
* The identifier of the account whose invoice items to return. If none is provided, all invoice items
|
|
433
|
+
* The identifier of the account representing the customer whose invoice items to return. If none is provided, returns all invoice items.
|
|
434
434
|
*/
|
|
435
435
|
customer_account?: string;
|
|
436
436
|
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
declare module 'stripe' {
|
|
4
4
|
namespace Stripe {
|
|
5
5
|
/**
|
|
6
|
-
* Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/
|
|
6
|
+
* Invoice Line Items represent the individual lines within an [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice.
|
|
7
7
|
*
|
|
8
|
-
* Each line item is backed by either an [invoice item](https://stripe.com/
|
|
8
|
+
* Each line item is backed by either an [invoice item](https://docs.stripe.com/api/invoiceitems) or a [subscription item](https://docs.stripe.com/api/subscription_items).
|
|
9
9
|
*/
|
|
10
10
|
interface InvoiceLineItem {
|
|
11
11
|
/**
|
|
@@ -69,7 +69,7 @@ declare module 'stripe' {
|
|
|
69
69
|
margins?: Array<string | Stripe.Margin> | null;
|
|
70
70
|
|
|
71
71
|
/**
|
|
72
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
72
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
|
|
73
73
|
*/
|
|
74
74
|
metadata: Stripe.Metadata;
|
|
75
75
|
|
|
@@ -149,6 +149,11 @@ declare module 'stripe' {
|
|
|
149
149
|
*/
|
|
150
150
|
rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
|
|
151
151
|
|
|
152
|
+
/**
|
|
153
|
+
* Details about the subscription schedule that generated this line item
|
|
154
|
+
*/
|
|
155
|
+
schedule_details?: Parent.ScheduleDetails | null;
|
|
156
|
+
|
|
152
157
|
/**
|
|
153
158
|
* Details about the subscription item that generated this line item
|
|
154
159
|
*/
|
|
@@ -158,11 +163,6 @@ declare module 'stripe' {
|
|
|
158
163
|
* The type of parent that generated this line item
|
|
159
164
|
*/
|
|
160
165
|
type: Parent.Type;
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* Details about the subscription schedule that generated this line item
|
|
164
|
-
*/
|
|
165
|
-
schedule_details?: Parent.ScheduleDetails | null;
|
|
166
166
|
}
|
|
167
167
|
|
|
168
168
|
namespace Parent {
|
|
@@ -501,6 +501,9 @@ declare module 'stripe' {
|
|
|
501
501
|
type TaxBehavior = 'exclusive' | 'inclusive';
|
|
502
502
|
|
|
503
503
|
interface TaxRateDetails {
|
|
504
|
+
/**
|
|
505
|
+
* ID of the tax rate
|
|
506
|
+
*/
|
|
504
507
|
tax_rate: string;
|
|
505
508
|
}
|
|
506
509
|
}
|
|
@@ -5,7 +5,7 @@ declare module 'stripe' {
|
|
|
5
5
|
/**
|
|
6
6
|
* Invoice Payments represent payments made against invoices. Invoice Payments can
|
|
7
7
|
* be accessed in two ways:
|
|
8
|
-
* 1. By expanding the `payments` field on the [Invoice](https://stripe.com
|
|
8
|
+
* 1. By expanding the `payments` field on the [Invoice](https://api.stripe.com#invoice) resource.
|
|
9
9
|
* 2. By using the Invoice Payment retrieve and list endpoints.
|
|
10
10
|
*
|
|
11
11
|
* Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.
|
|
@@ -28,7 +28,7 @@ declare module 'stripe' {
|
|
|
28
28
|
livemode: boolean;
|
|
29
29
|
|
|
30
30
|
/**
|
|
31
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
31
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
32
32
|
*/
|
|
33
33
|
metadata: Stripe.Metadata | null;
|
|
34
34
|
|