stripe 17.2.0-beta.2 → 17.2.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.
Files changed (178) hide show
  1. package/CHANGELOG.md +112 -900
  2. package/README.md +4 -4
  3. package/VERSION +1 -1
  4. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  5. package/cjs/resources/Invoices.js +0 -17
  6. package/cjs/resources/PaymentIntents.js +0 -4
  7. package/cjs/resources/Quotes.js +0 -32
  8. package/cjs/resources/SubscriptionSchedules.js +0 -4
  9. package/cjs/resources/Terminal/Readers.js +0 -12
  10. package/cjs/resources/TestHelpers/Issuing/Cards.js +0 -4
  11. package/cjs/resources/V2/Core/Events.js +50 -7
  12. package/cjs/resources.js +10 -42
  13. package/cjs/stripe.core.js +1 -1
  14. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  15. package/esm/resources/Invoices.js +0 -17
  16. package/esm/resources/PaymentIntents.js +0 -4
  17. package/esm/resources/Quotes.js +0 -32
  18. package/esm/resources/SubscriptionSchedules.js +0 -4
  19. package/esm/resources/Terminal/Readers.js +0 -12
  20. package/esm/resources/TestHelpers/Issuing/Cards.js +0 -4
  21. package/esm/resources/V2/Core/Events.js +50 -7
  22. package/esm/resources.js +0 -29
  23. package/esm/stripe.core.js +1 -1
  24. package/package.json +1 -1
  25. package/types/AccountLinksResource.d.ts +1 -5
  26. package/types/AccountSessions.d.ts +5 -75
  27. package/types/AccountSessionsResource.d.ts +5 -354
  28. package/types/Accounts.d.ts +3 -127
  29. package/types/AccountsResource.d.ts +2 -296
  30. package/types/Billing/CreditGrants.d.ts +2 -2
  31. package/types/Billing/CreditGrantsResource.d.ts +2 -2
  32. package/types/Billing/Meters.d.ts +0 -2
  33. package/types/Charges.d.ts +0 -152
  34. package/types/ChargesResource.d.ts +0 -1294
  35. package/types/Checkout/Sessions.d.ts +5 -309
  36. package/types/Checkout/SessionsResource.d.ts +5 -356
  37. package/types/ConfirmationTokens.d.ts +0 -137
  38. package/types/Coupons.d.ts +1 -1
  39. package/types/CouponsResource.d.ts +1 -1
  40. package/types/CreditNotes.d.ts +0 -21
  41. package/types/CreditNotesResource.d.ts +0 -51
  42. package/types/CustomersResource.d.ts +2 -22
  43. package/types/Disputes.d.ts +0 -152
  44. package/types/DisputesResource.d.ts +0 -120
  45. package/types/EventTypes.d.ts +2 -564
  46. package/types/Events.d.ts +0 -91
  47. package/types/FinancialConnections/Accounts.d.ts +1 -29
  48. package/types/FinancialConnections/AccountsResource.d.ts +3 -35
  49. package/types/FinancialConnections/Sessions.d.ts +1 -49
  50. package/types/FinancialConnections/SessionsResource.d.ts +1 -38
  51. package/types/Forwarding/Requests.d.ts +0 -5
  52. package/types/InvoiceItems.d.ts +0 -5
  53. package/types/InvoiceItemsResource.d.ts +0 -98
  54. package/types/InvoiceLineItems.d.ts +1 -31
  55. package/types/Invoices.d.ts +3 -134
  56. package/types/InvoicesResource.d.ts +1836 -5515
  57. package/types/Issuing/Authorizations.d.ts +1 -1
  58. package/types/Issuing/AuthorizationsResource.d.ts +1 -1
  59. package/types/Issuing/CardholdersResource.d.ts +1 -2
  60. package/types/Issuing/Transactions.d.ts +0 -2
  61. package/types/Issuing/TransactionsResource.d.ts +0 -5
  62. package/types/LineItems.d.ts +0 -7
  63. package/types/Mandates.d.ts +0 -85
  64. package/types/PaymentIntents.d.ts +1 -643
  65. package/types/PaymentIntentsResource.d.ts +3463 -7739
  66. package/types/PaymentLinks.d.ts +0 -3
  67. package/types/PaymentLinksResource.d.ts +0 -6
  68. package/types/PaymentMethodConfigurations.d.ts +0 -36
  69. package/types/PaymentMethodConfigurationsResource.d.ts +2 -52
  70. package/types/PaymentMethods.d.ts +0 -137
  71. package/types/PaymentMethodsResource.d.ts +0 -158
  72. package/types/Persons.d.ts +1 -1
  73. package/types/Prices.d.ts +0 -22
  74. package/types/PricesResource.d.ts +0 -22
  75. package/types/Products.d.ts +0 -39
  76. package/types/ProductsResource.d.ts +0 -36
  77. package/types/Quotes.d.ts +1 -591
  78. package/types/QuotesResource.d.ts +199 -2531
  79. package/types/SetupAttempts.d.ts +0 -19
  80. package/types/SetupIntents.d.ts +1 -112
  81. package/types/SetupIntentsResource.d.ts +3 -669
  82. package/types/Sources.d.ts +0 -23
  83. package/types/SubscriptionItems.d.ts +0 -21
  84. package/types/SubscriptionItemsResource.d.ts +0 -109
  85. package/types/SubscriptionSchedules.d.ts +0 -200
  86. package/types/SubscriptionSchedulesResource.d.ts +13 -1231
  87. package/types/Subscriptions.d.ts +1 -82
  88. package/types/SubscriptionsResource.d.ts +3 -348
  89. package/types/Tax/CalculationLineItems.d.ts +0 -1
  90. package/types/Tax/Calculations.d.ts +1 -33
  91. package/types/Tax/CalculationsResource.d.ts +1 -7
  92. package/types/Tax/Registrations.d.ts +0 -82
  93. package/types/Tax/RegistrationsResource.d.ts +0 -109
  94. package/types/Tax/Transactions.d.ts +1 -8
  95. package/types/TaxIds.d.ts +1 -7
  96. package/types/TaxIdsResource.d.ts +1 -7
  97. package/types/TaxRates.d.ts +0 -25
  98. package/types/TaxRatesResource.d.ts +0 -2
  99. package/types/Terminal/Readers.d.ts +0 -278
  100. package/types/Terminal/ReadersResource.d.ts +0 -215
  101. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -112
  102. package/types/TestHelpers/Issuing/CardsResource.d.ts +0 -22
  103. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  104. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  105. package/types/TokensResource.d.ts +1 -1
  106. package/types/Treasury/FinancialAccounts.d.ts +1 -6
  107. package/types/Treasury/FinancialAccountsResource.d.ts +0 -10
  108. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  109. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  110. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  111. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  112. package/types/UsageRecordSummaries.d.ts +1 -1
  113. package/types/V2/EventTypes.d.ts +3 -1
  114. package/types/WebhookEndpointsResource.d.ts +0 -66
  115. package/types/index.d.ts +0 -53
  116. package/cjs/resources/AccountNotices.js +0 -21
  117. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  118. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  119. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  120. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  121. package/cjs/resources/GiftCards/Cards.js +0 -23
  122. package/cjs/resources/GiftCards/Transactions.js +0 -33
  123. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  124. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  125. package/cjs/resources/Margins.js +0 -22
  126. package/cjs/resources/Orders.js +0 -24
  127. package/cjs/resources/Tax/Associations.js +0 -9
  128. package/cjs/resources/Tax/Forms.js +0 -20
  129. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  130. package/esm/resources/AccountNotices.js +0 -18
  131. package/esm/resources/Capital/FinancingOffers.js +0 -18
  132. package/esm/resources/Capital/FinancingSummary.js +0 -9
  133. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  134. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  135. package/esm/resources/GiftCards/Cards.js +0 -20
  136. package/esm/resources/GiftCards/Transactions.js +0 -30
  137. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  138. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  139. package/esm/resources/Margins.js +0 -19
  140. package/esm/resources/Orders.js +0 -21
  141. package/esm/resources/Tax/Associations.js +0 -6
  142. package/esm/resources/Tax/Forms.js +0 -17
  143. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  144. package/types/AccountNotices.d.ts +0 -113
  145. package/types/AccountNoticesResource.d.ts +0 -98
  146. package/types/Billing/MeterErrorReports.d.ts +0 -106
  147. package/types/Capital/FinancingOffers.d.ts +0 -188
  148. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  149. package/types/Capital/FinancingSummary.d.ts +0 -106
  150. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  151. package/types/Capital/FinancingTransactions.d.ts +0 -135
  152. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  153. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  154. package/types/FinancialConnections/Institutions.d.ts +0 -93
  155. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  156. package/types/GiftCards/Cards.d.ts +0 -118
  157. package/types/GiftCards/CardsResource.d.ts +0 -159
  158. package/types/GiftCards/Transactions.d.ts +0 -129
  159. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  160. package/types/InvoicePayments.d.ts +0 -138
  161. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  162. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  163. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -73
  164. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  165. package/types/Issuing/Settlements.d.ts +0 -103
  166. package/types/Margins.d.ts +0 -56
  167. package/types/MarginsResource.d.ts +0 -114
  168. package/types/Orders.d.ts +0 -1154
  169. package/types/OrdersResource.d.ts +0 -2911
  170. package/types/QuoteLines.d.ts +0 -634
  171. package/types/QuotePreviewInvoices.d.ts +0 -1596
  172. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -814
  173. package/types/Tax/Associations.d.ts +0 -126
  174. package/types/Tax/AssociationsResource.d.ts +0 -29
  175. package/types/Tax/Forms.d.ts +0 -133
  176. package/types/Tax/FormsResource.d.ts +0 -90
  177. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  178. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
@@ -1,106 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Billing {
6
- /**
7
- * The MeterErrorReport object.
8
- */
9
- interface MeterErrorReport {
10
- /**
11
- * Unique identifier for the object.
12
- */
13
- id: string;
14
-
15
- /**
16
- * String representing the object's type. Objects of the same type share the same value.
17
- */
18
- object: 'billing.meter_error_report';
19
-
20
- reason: MeterErrorReport.Reason;
21
-
22
- /**
23
- * The related objects about the error
24
- */
25
- related_object: MeterErrorReport.RelatedObject | null;
26
-
27
- /**
28
- * Summary of invalid events
29
- */
30
- summary: string;
31
-
32
- /**
33
- * Time when validation ended. Measured in seconds since the Unix epoch
34
- */
35
- validation_end: number;
36
-
37
- /**
38
- * Time when validation started. Measured in seconds since the Unix epoch
39
- */
40
- validation_start: number;
41
- }
42
-
43
- namespace MeterErrorReport {
44
- interface Reason {
45
- /**
46
- * The number of errors generated
47
- */
48
- error_count: number;
49
-
50
- /**
51
- * More information about errors
52
- */
53
- error_types: Array<Reason.ErrorType>;
54
- }
55
-
56
- namespace Reason {
57
- interface ErrorType {
58
- sample_errors: Array<ErrorType.SampleError>;
59
- }
60
-
61
- namespace ErrorType {
62
- interface SampleError {
63
- api_request: SampleError.ApiRequest | null;
64
-
65
- /**
66
- * message of the error
67
- */
68
- error_message: string;
69
- }
70
-
71
- namespace SampleError {
72
- interface ApiRequest {
73
- /**
74
- * Unique identifier for the object.
75
- */
76
- id: string;
77
-
78
- /**
79
- * idempotency_key of the request
80
- */
81
- idempotency_key: string;
82
- }
83
- }
84
- }
85
- }
86
-
87
- interface RelatedObject {
88
- /**
89
- * Unique identifier for the object.
90
- */
91
- id: string;
92
-
93
- /**
94
- * The type of meter error related object. Should be 'meter'
95
- */
96
- object: string;
97
-
98
- /**
99
- * The url of the meter object
100
- */
101
- url: string;
102
- }
103
- }
104
- }
105
- }
106
- }
@@ -1,188 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Capital {
6
- /**
7
- * This is an object representing an offer of financing from
8
- * Stripe Capital to a Connect subaccount.
9
- */
10
- interface FinancingOffer {
11
- /**
12
- * A unique identifier for the financing object.
13
- */
14
- id: string;
15
-
16
- /**
17
- * The object type: financing_offer.
18
- */
19
- object: 'capital.financing_offer';
20
-
21
- /**
22
- * This is an object representing the terms of an offer of financing from
23
- * Stripe Capital to a Connected account. This resource represents
24
- * the terms accepted by the Connected account, which may differ from those
25
- * offered.
26
- */
27
- accepted_terms?: FinancingOffer.AcceptedTerms;
28
-
29
- /**
30
- * The ID of the merchant associated with this financing object.
31
- */
32
- account: string;
33
-
34
- /**
35
- * The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
36
- */
37
- charged_off_at?: number;
38
-
39
- /**
40
- * Time at which the offer was created. Given in seconds since unix epoch.
41
- */
42
- created: number;
43
-
44
- /**
45
- * Time at which the offer expires. Given in seconds since unix epoch.
46
- */
47
- expires_after: number;
48
-
49
- /**
50
- * The type of financing being offered.
51
- */
52
- financing_type?: FinancingOffer.FinancingType;
53
-
54
- /**
55
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
56
- */
57
- livemode: boolean;
58
-
59
- /**
60
- * 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.
61
- */
62
- metadata?: Stripe.Metadata;
63
-
64
- /**
65
- * This is an object representing the terms of an offer of financing from
66
- * Stripe Capital to a Connected account. This resource represents
67
- * both the terms offered to the Connected account.
68
- */
69
- offered_terms?: FinancingOffer.OfferedTerms;
70
-
71
- /**
72
- * Financing product identifier.
73
- */
74
- product_type?: FinancingOffer.ProductType;
75
-
76
- /**
77
- * The ID of the financing offer that replaced this offer.
78
- */
79
- replacement?: string;
80
-
81
- /**
82
- * The ID of the financing offer that this offer is a replacement for.
83
- */
84
- replacement_for?: string;
85
-
86
- /**
87
- * The current status of the offer.
88
- */
89
- status: FinancingOffer.Status;
90
-
91
- /**
92
- * See [financing_type](https://stripe.com/docs/api/capital/connect_financing_object#financing_offer_object-financing_type).
93
- */
94
- type?: FinancingOffer.Type;
95
- }
96
-
97
- namespace FinancingOffer {
98
- interface AcceptedTerms {
99
- /**
100
- * Amount of financing offered, in minor units.
101
- */
102
- advance_amount: number;
103
-
104
- /**
105
- * Currency that the financing offer is transacted in. For example, `usd`.
106
- */
107
- currency: string;
108
-
109
- /**
110
- * Fixed fee amount, in minor units.
111
- */
112
- fee_amount: number;
113
-
114
- /**
115
- * Populated when the `product_type` of the `financingoffer` is `refill`.
116
- * Represents the discount amount on remaining premium for the existing loan at payout time.
117
- */
118
- previous_financing_fee_discount_amount: number | null;
119
-
120
- /**
121
- * Per-transaction rate at which Stripe will withhold funds to repay the financing.
122
- */
123
- withhold_rate: number;
124
- }
125
-
126
- type FinancingType = 'cash_advance' | 'flex_loan';
127
-
128
- interface OfferedTerms {
129
- /**
130
- * Amount of financing offered, in minor units.
131
- */
132
- advance_amount: number;
133
-
134
- /**
135
- * Describes the type of user the offer is being extended to.
136
- */
137
- campaign_type: OfferedTerms.CampaignType;
138
-
139
- /**
140
- * Currency that the financing offer is transacted in. For example, `usd`.
141
- */
142
- currency: string;
143
-
144
- /**
145
- * Fixed fee amount, in minor units.
146
- */
147
- fee_amount: number;
148
-
149
- /**
150
- * Populated when the `product_type` of the `financingoffer` is `refill`.
151
- * Represents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`
152
- * is paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate
153
- * and the remaining fee.
154
- */
155
- previous_financing_fee_discount_rate: number | null;
156
-
157
- /**
158
- * Per-transaction rate at which Stripe will withhold funds to repay the financing.
159
- */
160
- withhold_rate: number;
161
- }
162
-
163
- namespace OfferedTerms {
164
- type CampaignType =
165
- | 'newly_eligible_user'
166
- | 'previously_eligible_user'
167
- | 'repeat_user';
168
- }
169
-
170
- type ProductType = 'refill' | 'standard';
171
-
172
- type Status =
173
- | 'accepted'
174
- | 'canceled'
175
- | 'completed'
176
- | 'delivered'
177
- | 'expired'
178
- | 'fully_repaid'
179
- | 'paid_out'
180
- | 'rejected'
181
- | 'replaced'
182
- | 'undelivered';
183
-
184
- type Type = 'cash_advance' | 'flex_loan';
185
- }
186
- }
187
- }
188
- }
@@ -1,97 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Capital {
6
- interface FinancingOfferRetrieveParams {
7
- /**
8
- * Specifies which fields in the response should be expanded.
9
- */
10
- expand?: Array<string>;
11
- }
12
-
13
- interface FinancingOfferListParams extends PaginationParams {
14
- /**
15
- * limit list to offers belonging to given connected account
16
- */
17
- connected_account?: string;
18
-
19
- /**
20
- * Only return offers that were created during the given date interval.
21
- */
22
- created?: Stripe.RangeQueryParam | number;
23
-
24
- /**
25
- * Specifies which fields in the response should be expanded.
26
- */
27
- expand?: Array<string>;
28
-
29
- /**
30
- * limit list to offers with given status
31
- */
32
- status?: FinancingOfferListParams.Status;
33
- }
34
-
35
- namespace FinancingOfferListParams {
36
- type Status =
37
- | 'accepted'
38
- | 'canceled'
39
- | 'completed'
40
- | 'delivered'
41
- | 'expired'
42
- | 'fully_repaid'
43
- | 'paid_out'
44
- | 'rejected'
45
- | 'revoked'
46
- | 'undelivered';
47
- }
48
-
49
- interface FinancingOfferMarkDeliveredParams {
50
- /**
51
- * Specifies which fields in the response should be expanded.
52
- */
53
- expand?: Array<string>;
54
- }
55
-
56
- class FinancingOffersResource {
57
- /**
58
- * Get the details of the financing offer
59
- */
60
- retrieve(
61
- id: string,
62
- params?: FinancingOfferRetrieveParams,
63
- options?: RequestOptions
64
- ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
65
- retrieve(
66
- id: string,
67
- options?: RequestOptions
68
- ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
69
-
70
- /**
71
- * Retrieves the financing offers available for Connected accounts that belong to your platform.
72
- */
73
- list(
74
- params?: FinancingOfferListParams,
75
- options?: RequestOptions
76
- ): ApiListPromise<Stripe.Capital.FinancingOffer>;
77
- list(
78
- options?: RequestOptions
79
- ): ApiListPromise<Stripe.Capital.FinancingOffer>;
80
-
81
- /**
82
- * Acknowledges that platform has received and delivered the financing_offer to
83
- * the intended merchant recipient.
84
- */
85
- markDelivered(
86
- id: string,
87
- params?: FinancingOfferMarkDeliveredParams,
88
- options?: RequestOptions
89
- ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
90
- markDelivered(
91
- id: string,
92
- options?: RequestOptions
93
- ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
94
- }
95
- }
96
- }
97
- }
@@ -1,106 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Capital {
6
- /**
7
- * A financing object describes an account's current financing state. Used by Connect
8
- * platforms to read the state of Capital offered to their connected accounts.
9
- */
10
- interface FinancingSummary {
11
- /**
12
- * The object type: financing_summary
13
- */
14
- object: 'capital.financing_summary';
15
-
16
- /**
17
- * Additional information about the financing summary. Describes currency, advance amount,
18
- * fee amount, withhold rate, remaining amount, paid amount, current repayment interval,
19
- * repayment start date, and advance payout date.
20
- */
21
- details: FinancingSummary.Details | null;
22
-
23
- /**
24
- * The Financing Offer ID this Financing Summary corresponds to
25
- */
26
- financing_offer: string | null;
27
-
28
- /**
29
- * Status of the Connected Account's financing. [/v1/capital/financing_summary](https://stripe.com/docs/api/capital/financing_summary) will only return `details` for `paid_out` financing.
30
- */
31
- status: FinancingSummary.Status | null;
32
- }
33
-
34
- namespace FinancingSummary {
35
- interface Details {
36
- /**
37
- * Amount of financing offered, in minor units.
38
- */
39
- advance_amount: number;
40
-
41
- /**
42
- * The time at which the funds were paid out to the connected account's Stripe balance. Given in milliseconds since unix epoch.
43
- */
44
- advance_paid_out_at: number | null;
45
-
46
- /**
47
- * Currency that the financing offer is transacted in. For example, `usd`.
48
- */
49
- currency: string;
50
-
51
- /**
52
- * The chronologically current repayment interval for the financing offer.
53
- */
54
- current_repayment_interval: Details.CurrentRepaymentInterval | null;
55
-
56
- /**
57
- * Fixed fee amount, in minor units.
58
- */
59
- fee_amount: number;
60
-
61
- /**
62
- * The amount the Connected account has paid toward the financing debt so far.
63
- */
64
- paid_amount: number;
65
-
66
- /**
67
- * The balance remaining to be paid on the financing, in minor units.
68
- */
69
- remaining_amount: number;
70
-
71
- /**
72
- * The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
73
- */
74
- repayments_begin_at: number | null;
75
-
76
- /**
77
- * Per-transaction rate at which Stripe will withhold funds to repay the financing.
78
- */
79
- withhold_rate: number;
80
- }
81
-
82
- namespace Details {
83
- interface CurrentRepaymentInterval {
84
- /**
85
- * The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.
86
- * Given in seconds since unix epoch.
87
- */
88
- due_at: number;
89
-
90
- /**
91
- * The amount that has already been paid in the current repayment interval.
92
- */
93
- paid_amount: number | null;
94
-
95
- /**
96
- * The amount that is yet to be paid in the current repayment interval.
97
- */
98
- remaining_amount: number;
99
- }
100
- }
101
-
102
- type Status = 'accepted' | 'delivered' | 'none';
103
- }
104
- }
105
- }
106
- }
@@ -1,27 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Capital {
6
- interface FinancingSummaryRetrieveParams {
7
- /**
8
- * Specifies which fields in the response should be expanded.
9
- */
10
- expand?: Array<string>;
11
- }
12
-
13
- class FinancingSummaryResource {
14
- /**
15
- * Retrieve the financing state for the account that was authenticated in the request.
16
- */
17
- retrieve(
18
- params?: FinancingSummaryRetrieveParams,
19
- options?: RequestOptions
20
- ): Promise<Stripe.Response<Stripe.Capital.FinancingSummary>>;
21
- retrieve(
22
- options?: RequestOptions
23
- ): Promise<Stripe.Response<Stripe.Capital.FinancingSummary>>;
24
- }
25
- }
26
- }
27
- }
@@ -1,135 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Capital {
6
- /**
7
- * This is an object representing the details of a transaction on a Capital financing object.
8
- */
9
- interface FinancingTransaction {
10
- /**
11
- * A unique identifier for the financing transaction object.
12
- */
13
- id: string;
14
-
15
- /**
16
- * The object type: financing_transaction
17
- */
18
- object: 'capital.financing_transaction';
19
-
20
- /**
21
- * The ID of the merchant associated with this financing transaction.
22
- */
23
- account: string;
24
-
25
- /**
26
- * Time at which the financing transaction was created. Given in seconds since unix epoch.
27
- */
28
- created_at: number;
29
-
30
- /**
31
- * This is an object representing a transaction on a Capital financing offer.
32
- */
33
- details: FinancingTransaction.Details;
34
-
35
- /**
36
- * The Capital financing offer for this financing transaction.
37
- */
38
- financing_offer: string | null;
39
-
40
- /**
41
- * The Capital transaction object that predates the Financing Transactions API and
42
- * corresponds with the balance transaction that was created as a result of this
43
- * financing transaction.
44
- */
45
- legacy_balance_transaction_source?: string;
46
-
47
- /**
48
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
49
- */
50
- livemode: boolean;
51
-
52
- /**
53
- * The type of the financing transaction.
54
- */
55
- type: FinancingTransaction.Type;
56
-
57
- /**
58
- * A human-friendly description of the financing transaction.
59
- */
60
- user_facing_description: string | null;
61
- }
62
-
63
- namespace FinancingTransaction {
64
- interface Details {
65
- /**
66
- * The advance amount being repaid, paid out, or reversed in minor units.
67
- */
68
- advance_amount: number;
69
-
70
- /**
71
- * The currency of the financing transaction.
72
- */
73
- currency: string;
74
-
75
- /**
76
- * The fee amount being repaid, paid out, or reversed in minor units.
77
- */
78
- fee_amount: number;
79
-
80
- /**
81
- * The linked payment for the transaction. This field only applies to financing transactions of type `paydown` and reason `automatic_withholding`.
82
- */
83
- linked_payment?: string;
84
-
85
- /**
86
- * The reason for the financing transaction (if applicable).
87
- */
88
- reason?: Details.Reason;
89
-
90
- /**
91
- * The reversed transaction. This field only applies to financing
92
- * transactions of type `reversal`.
93
- */
94
- reversed_transaction?: string;
95
-
96
- /**
97
- * The advance and fee amount being repaid, paid out, or reversed in minor units.
98
- */
99
- total_amount: number;
100
-
101
- /**
102
- * This is an object representing a linked transaction on a Capital Financing Transaction.
103
- */
104
- transaction?: Details.Transaction;
105
- }
106
-
107
- namespace Details {
108
- type Reason =
109
- | 'automatic_withholding'
110
- | 'automatic_withholding_refund'
111
- | 'collection'
112
- | 'collection_failure'
113
- | 'financing_cancellation'
114
- | 'refill'
115
- | 'requested_by_user'
116
- | 'user_initiated';
117
-
118
- interface Transaction {
119
- /**
120
- * The linked payment ID.
121
- */
122
- charge?: string;
123
-
124
- /**
125
- * The linked Treasury Financing Transaction ID.
126
- */
127
- treasury_transaction?: string;
128
- }
129
- }
130
-
131
- type Type = 'payment' | 'payout' | 'reversal';
132
- }
133
- }
134
- }
135
- }