stripe 16.4.0-beta.1 → 16.5.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 (159) hide show
  1. package/CHANGELOG.md +145 -767
  2. package/README.md +0 -33
  3. package/VERSION +1 -1
  4. package/cjs/RequestSender.js +5 -66
  5. package/cjs/StripeResource.js +1 -1
  6. package/cjs/apiVersion.js +1 -2
  7. package/cjs/multipart.js +1 -1
  8. package/cjs/resources/Checkout/Sessions.js +4 -0
  9. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  10. package/cjs/resources/Invoices.js +0 -13
  11. package/cjs/resources/OAuth.js +1 -1
  12. package/cjs/resources/PaymentIntents.js +0 -4
  13. package/cjs/resources/Quotes.js +0 -32
  14. package/cjs/resources/SubscriptionSchedules.js +0 -4
  15. package/cjs/resources/Terminal/Readers.js +0 -12
  16. package/cjs/resources.js +10 -38
  17. package/cjs/stripe.core.js +3 -6
  18. package/cjs/utils.js +3 -30
  19. package/esm/RequestSender.js +6 -67
  20. package/esm/StripeResource.js +2 -2
  21. package/esm/apiVersion.js +0 -1
  22. package/esm/multipart.js +2 -2
  23. package/esm/resources/Checkout/Sessions.js +4 -0
  24. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  25. package/esm/resources/Invoices.js +0 -13
  26. package/esm/resources/OAuth.js +2 -2
  27. package/esm/resources/PaymentIntents.js +0 -4
  28. package/esm/resources/Quotes.js +0 -32
  29. package/esm/resources/SubscriptionSchedules.js +0 -4
  30. package/esm/resources/Terminal/Readers.js +0 -12
  31. package/esm/resources.js +0 -24
  32. package/esm/stripe.core.js +3 -6
  33. package/esm/utils.js +1 -27
  34. package/package.json +1 -1
  35. package/types/AccountLinksResource.d.ts +1 -5
  36. package/types/AccountSessions.d.ts +30 -15
  37. package/types/AccountSessionsResource.d.ts +0 -163
  38. package/types/Accounts.d.ts +4 -91
  39. package/types/AccountsResource.d.ts +26 -230
  40. package/types/Charges.d.ts +38 -69
  41. package/types/ChargesResource.d.ts +0 -1294
  42. package/types/Checkout/Sessions.d.ts +1 -28
  43. package/types/Checkout/SessionsResource.d.ts +22 -15
  44. package/types/ConfirmationTokens.d.ts +23 -62
  45. package/types/Coupons.d.ts +1 -1
  46. package/types/CouponsResource.d.ts +1 -1
  47. package/types/CreditNotes.d.ts +0 -21
  48. package/types/CreditNotesResource.d.ts +0 -51
  49. package/types/CustomersResource.d.ts +0 -2
  50. package/types/Disputes.d.ts +9 -168
  51. package/types/DisputesResource.d.ts +3 -120
  52. package/types/EventTypes.d.ts +47 -422
  53. package/types/Events.d.ts +3 -83
  54. package/types/EventsResource.d.ts +1 -1
  55. package/types/FinancialConnections/Accounts.d.ts +1 -29
  56. package/types/FinancialConnections/AccountsResource.d.ts +3 -35
  57. package/types/FinancialConnections/Sessions.d.ts +1 -49
  58. package/types/FinancialConnections/SessionsResource.d.ts +1 -38
  59. package/types/Identity/VerificationReports.d.ts +1 -1
  60. package/types/InvoiceItems.d.ts +0 -5
  61. package/types/InvoiceItemsResource.d.ts +0 -98
  62. package/types/InvoiceLineItems.d.ts +0 -22
  63. package/types/Invoices.d.ts +2 -116
  64. package/types/InvoicesResource.d.ts +1784 -5359
  65. package/types/Issuing/CardholdersResource.d.ts +1 -2
  66. package/types/LineItems.d.ts +0 -7
  67. package/types/Mandates.d.ts +0 -77
  68. package/types/PaymentIntents.d.ts +2 -470
  69. package/types/PaymentIntentsResource.d.ts +3377 -6725
  70. package/types/PaymentMethodConfigurations.d.ts +36 -0
  71. package/types/PaymentMethodConfigurationsResource.d.ts +50 -0
  72. package/types/PaymentMethodDomains.d.ts +1 -1
  73. package/types/PaymentMethods.d.ts +18 -62
  74. package/types/PaymentMethodsResource.d.ts +0 -110
  75. package/types/Prices.d.ts +0 -22
  76. package/types/PricesResource.d.ts +0 -22
  77. package/types/Products.d.ts +0 -39
  78. package/types/ProductsResource.d.ts +0 -36
  79. package/types/Quotes.d.ts +1 -578
  80. package/types/QuotesResource.d.ts +266 -3175
  81. package/types/RefundsResource.d.ts +1 -1
  82. package/types/SetupAttempts.d.ts +0 -9
  83. package/types/SetupIntents.d.ts +1 -110
  84. package/types/SetupIntentsResource.d.ts +3 -498
  85. package/types/Sources.d.ts +0 -23
  86. package/types/SubscriptionItems.d.ts +0 -21
  87. package/types/SubscriptionItemsResource.d.ts +0 -109
  88. package/types/SubscriptionSchedules.d.ts +0 -164
  89. package/types/SubscriptionSchedulesResource.d.ts +13 -1231
  90. package/types/Subscriptions.d.ts +3 -47
  91. package/types/SubscriptionsResource.d.ts +6 -349
  92. package/types/Tax/Calculations.d.ts +1 -1
  93. package/types/Tax/CalculationsResource.d.ts +1 -3
  94. package/types/Terminal/Readers.d.ts +2 -279
  95. package/types/Terminal/ReadersResource.d.ts +1 -208
  96. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -55
  97. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  98. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  99. package/types/TokensResource.d.ts +7 -7
  100. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  101. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  102. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  103. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  104. package/types/WebhookEndpointsResource.d.ts +6 -50
  105. package/types/index.d.ts +0 -64
  106. package/types/lib.d.ts +0 -12
  107. package/cjs/resources/AccountNotices.js +0 -21
  108. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  109. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  110. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  111. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  112. package/cjs/resources/GiftCards/Cards.js +0 -23
  113. package/cjs/resources/GiftCards/Transactions.js +0 -33
  114. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  115. package/cjs/resources/Margins.js +0 -22
  116. package/cjs/resources/Orders.js +0 -24
  117. package/cjs/resources/QuotePhases.js +0 -22
  118. package/cjs/resources/Tax/Forms.js +0 -20
  119. package/esm/resources/AccountNotices.js +0 -18
  120. package/esm/resources/Capital/FinancingOffers.js +0 -18
  121. package/esm/resources/Capital/FinancingSummary.js +0 -9
  122. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  123. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  124. package/esm/resources/GiftCards/Cards.js +0 -20
  125. package/esm/resources/GiftCards/Transactions.js +0 -30
  126. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  127. package/esm/resources/Margins.js +0 -19
  128. package/esm/resources/Orders.js +0 -21
  129. package/esm/resources/QuotePhases.js +0 -19
  130. package/esm/resources/Tax/Forms.js +0 -17
  131. package/types/AccountNotices.d.ts +0 -110
  132. package/types/AccountNoticesResource.d.ts +0 -98
  133. package/types/Capital/FinancingOffers.d.ts +0 -188
  134. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  135. package/types/Capital/FinancingSummary.d.ts +0 -106
  136. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  137. package/types/Capital/FinancingTransactions.d.ts +0 -135
  138. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  139. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  140. package/types/FinancialConnections/Institutions.d.ts +0 -93
  141. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  142. package/types/GiftCards/Cards.d.ts +0 -118
  143. package/types/GiftCards/CardsResource.d.ts +0 -159
  144. package/types/GiftCards/Transactions.d.ts +0 -129
  145. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  146. package/types/InvoicePayments.d.ts +0 -91
  147. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -446
  148. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1017
  149. package/types/Margins.d.ts +0 -56
  150. package/types/MarginsResource.d.ts +0 -114
  151. package/types/Orders.d.ts +0 -1057
  152. package/types/OrdersResource.d.ts +0 -2711
  153. package/types/QuoteLines.d.ts +0 -634
  154. package/types/QuotePhases.d.ts +0 -198
  155. package/types/QuotePhasesResource.d.ts +0 -67
  156. package/types/QuotePreviewInvoices.d.ts +0 -1530
  157. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -778
  158. package/types/Tax/Forms.d.ts +0 -133
  159. package/types/Tax/FormsResource.d.ts +0 -90
@@ -1,30 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const Transactions = StripeResource.extend({
5
- create: stripeMethod({
6
- method: 'POST',
7
- fullPath: '/v1/gift_cards/transactions',
8
- }),
9
- retrieve: stripeMethod({
10
- method: 'GET',
11
- fullPath: '/v1/gift_cards/transactions/{id}',
12
- }),
13
- update: stripeMethod({
14
- method: 'POST',
15
- fullPath: '/v1/gift_cards/transactions/{id}',
16
- }),
17
- list: stripeMethod({
18
- method: 'GET',
19
- fullPath: '/v1/gift_cards/transactions',
20
- methodType: 'list',
21
- }),
22
- cancel: stripeMethod({
23
- method: 'POST',
24
- fullPath: '/v1/gift_cards/transactions/{id}/cancel',
25
- }),
26
- confirm: stripeMethod({
27
- method: 'POST',
28
- fullPath: '/v1/gift_cards/transactions/{id}/confirm',
29
- }),
30
- });
@@ -1,30 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const CreditUnderwritingRecords = StripeResource.extend({
5
- retrieve: stripeMethod({
6
- method: 'GET',
7
- fullPath: '/v1/issuing/credit_underwriting_records/{credit_underwriting_record}',
8
- }),
9
- list: stripeMethod({
10
- method: 'GET',
11
- fullPath: '/v1/issuing/credit_underwriting_records',
12
- methodType: 'list',
13
- }),
14
- correct: stripeMethod({
15
- method: 'POST',
16
- fullPath: '/v1/issuing/credit_underwriting_records/{credit_underwriting_record}/correct',
17
- }),
18
- createFromApplication: stripeMethod({
19
- method: 'POST',
20
- fullPath: '/v1/issuing/credit_underwriting_records/create_from_application',
21
- }),
22
- createFromProactiveReview: stripeMethod({
23
- method: 'POST',
24
- fullPath: '/v1/issuing/credit_underwriting_records/create_from_proactive_review',
25
- }),
26
- reportDecision: stripeMethod({
27
- method: 'POST',
28
- fullPath: '/v1/issuing/credit_underwriting_records/{credit_underwriting_record}/report_decision',
29
- }),
30
- });
@@ -1,19 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const Margins = StripeResource.extend({
5
- create: stripeMethod({ method: 'POST', fullPath: '/v1/billing/margins' }),
6
- retrieve: stripeMethod({
7
- method: 'GET',
8
- fullPath: '/v1/billing/margins/{margin}',
9
- }),
10
- update: stripeMethod({
11
- method: 'POST',
12
- fullPath: '/v1/billing/margins/{margin}',
13
- }),
14
- list: stripeMethod({
15
- method: 'GET',
16
- fullPath: '/v1/billing/margins',
17
- methodType: 'list',
18
- }),
19
- });
@@ -1,21 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const Orders = StripeResource.extend({
5
- create: stripeMethod({ method: 'POST', fullPath: '/v1/orders' }),
6
- retrieve: stripeMethod({ method: 'GET', fullPath: '/v1/orders/{id}' }),
7
- update: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}' }),
8
- list: stripeMethod({
9
- method: 'GET',
10
- fullPath: '/v1/orders',
11
- methodType: 'list',
12
- }),
13
- cancel: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}/cancel' }),
14
- listLineItems: stripeMethod({
15
- method: 'GET',
16
- fullPath: '/v1/orders/{id}/line_items',
17
- methodType: 'list',
18
- }),
19
- reopen: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}/reopen' }),
20
- submit: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}/submit' }),
21
- });
@@ -1,19 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const QuotePhases = StripeResource.extend({
5
- retrieve: stripeMethod({
6
- method: 'GET',
7
- fullPath: '/v1/quote_phases/{quote_phase}',
8
- }),
9
- list: stripeMethod({
10
- method: 'GET',
11
- fullPath: '/v1/quote_phases',
12
- methodType: 'list',
13
- }),
14
- listLineItems: stripeMethod({
15
- method: 'GET',
16
- fullPath: '/v1/quote_phases/{quote_phase}/line_items',
17
- methodType: 'list',
18
- }),
19
- });
@@ -1,17 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const Forms = StripeResource.extend({
5
- retrieve: stripeMethod({ method: 'GET', fullPath: '/v1/tax/forms/{id}' }),
6
- list: stripeMethod({
7
- method: 'GET',
8
- fullPath: '/v1/tax/forms',
9
- methodType: 'list',
10
- }),
11
- pdf: stripeMethod({
12
- method: 'GET',
13
- fullPath: '/v1/tax/forms/{id}/pdf',
14
- host: 'files.stripe.com',
15
- streaming: true,
16
- }),
17
- });
@@ -1,110 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- /**
6
- * A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.
7
- *
8
- * See the [guide to send notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.
9
- */
10
- interface AccountNotice {
11
- /**
12
- * Unique identifier for the object.
13
- */
14
- id: string;
15
-
16
- /**
17
- * String representing the object's type. Objects of the same type share the same value.
18
- */
19
- object: 'account_notice';
20
-
21
- /**
22
- * Time at which the object was created. Measured in seconds since the Unix epoch.
23
- */
24
- created: number;
25
-
26
- /**
27
- * When present, the deadline for sending the notice to meet the relevant regulations.
28
- */
29
- deadline: number | null;
30
-
31
- /**
32
- * Information about the email when sent.
33
- */
34
- email: AccountNotice.Email | null;
35
-
36
- /**
37
- * Information about objects related to the notice.
38
- */
39
- linked_objects: AccountNotice.LinkedObjects | null;
40
-
41
- /**
42
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
43
- */
44
- livemode: boolean;
45
-
46
- /**
47
- * 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.
48
- */
49
- metadata: Stripe.Metadata | null;
50
-
51
- /**
52
- * Reason the notice is being sent. The reason determines what copy the notice must contain. See the [regulated customer notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.
53
- */
54
- reason: AccountNotice.Reason;
55
-
56
- /**
57
- * Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.
58
- */
59
- sent_at: number | null;
60
- }
61
-
62
- namespace AccountNotice {
63
- interface Email {
64
- /**
65
- * Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
66
- */
67
- plain_text: string;
68
-
69
- /**
70
- * Email address of the recipient.
71
- */
72
- recipient: string;
73
-
74
- /**
75
- * Subject of the email.
76
- */
77
- subject: string;
78
- }
79
-
80
- interface LinkedObjects {
81
- /**
82
- * Associated [Capability](https://stripe.com/docs/api/capabilities)
83
- */
84
- capability: string | null;
85
-
86
- /**
87
- * Associated [Credit Underwriting Record](https://stripe.com/docs/api/issuing/credit_underwriting_record)
88
- */
89
- issuing_credit_underwriting_record?: string | null;
90
-
91
- /**
92
- * Associated [Issuing Dispute](https://stripe.com/docs/api/issuing/disputes)
93
- */
94
- issuing_dispute: string | null;
95
- }
96
-
97
- type Reason =
98
- | 'issuing.account_closed_for_inactivity'
99
- | 'issuing.account_closed_for_terms_of_service_violation'
100
- | 'issuing.application_rejected_for_failure_to_verify'
101
- | 'issuing.credit_application_rejected'
102
- | 'issuing.credit_increase_application_rejected'
103
- | 'issuing.credit_limit_decreased'
104
- | 'issuing.credit_line_closed'
105
- | 'issuing.dispute_lost'
106
- | 'issuing.dispute_submitted'
107
- | 'issuing.dispute_won';
108
- }
109
- }
110
- }
@@ -1,98 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- interface AccountNoticeRetrieveParams {
6
- /**
7
- * Specifies which fields in the response should be expanded.
8
- */
9
- expand?: Array<string>;
10
- }
11
-
12
- interface AccountNoticeUpdateParams {
13
- /**
14
- * Information about the email you sent.
15
- */
16
- email: AccountNoticeUpdateParams.Email;
17
-
18
- /**
19
- * Date when you sent the notice.
20
- */
21
- sent_at: number;
22
-
23
- /**
24
- * Specifies which fields in the response should be expanded.
25
- */
26
- expand?: Array<string>;
27
-
28
- /**
29
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
30
- */
31
- metadata?: Stripe.MetadataParam;
32
- }
33
-
34
- namespace AccountNoticeUpdateParams {
35
- interface Email {
36
- /**
37
- * Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
38
- */
39
- plain_text: string;
40
-
41
- /**
42
- * Email address of the recipient.
43
- */
44
- recipient: string;
45
-
46
- /**
47
- * Subject of the email.
48
- */
49
- subject: string;
50
- }
51
- }
52
-
53
- interface AccountNoticeListParams extends PaginationParams {
54
- /**
55
- * Specifies which fields in the response should be expanded.
56
- */
57
- expand?: Array<string>;
58
-
59
- /**
60
- * Set to false to only return unsent AccountNotices.
61
- */
62
- sent?: boolean;
63
- }
64
-
65
- class AccountNoticesResource {
66
- /**
67
- * Retrieves an AccountNotice object.
68
- */
69
- retrieve(
70
- id: string,
71
- params?: AccountNoticeRetrieveParams,
72
- options?: RequestOptions
73
- ): Promise<Stripe.Response<Stripe.AccountNotice>>;
74
- retrieve(
75
- id: string,
76
- options?: RequestOptions
77
- ): Promise<Stripe.Response<Stripe.AccountNotice>>;
78
-
79
- /**
80
- * Updates an AccountNotice object.
81
- */
82
- update(
83
- id: string,
84
- params: AccountNoticeUpdateParams,
85
- options?: RequestOptions
86
- ): Promise<Stripe.Response<Stripe.AccountNotice>>;
87
-
88
- /**
89
- * Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
90
- */
91
- list(
92
- params?: AccountNoticeListParams,
93
- options?: RequestOptions
94
- ): ApiListPromise<Stripe.AccountNotice>;
95
- list(options?: RequestOptions): ApiListPromise<Stripe.AccountNotice>;
96
- }
97
- }
98
- }
@@ -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
- }