stripe 16.13.0-beta.1 → 17.1.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 (221) hide show
  1. package/CHANGELOG.md +139 -849
  2. package/README.md +4 -3
  3. package/VERSION +1 -1
  4. package/cjs/Error.js +31 -4
  5. package/cjs/RequestSender.js +114 -74
  6. package/cjs/StripeResource.js +8 -3
  7. package/cjs/apiVersion.js +2 -3
  8. package/cjs/autoPagination.js +51 -7
  9. package/cjs/crypto/CryptoProvider.js +6 -0
  10. package/cjs/crypto/NodeCryptoProvider.js +7 -0
  11. package/cjs/crypto/SubtleCryptoProvider.js +4 -0
  12. package/cjs/resources/{Capital/FinancingSummary.js → Billing/CreditBalanceSummary.js} +3 -3
  13. package/cjs/resources/{FinancialConnections/Institutions.js → Billing/CreditBalanceTransactions.js} +4 -4
  14. package/cjs/resources/Billing/CreditGrants.js +30 -0
  15. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  16. package/cjs/resources/Invoices.js +0 -17
  17. package/cjs/resources/PaymentIntents.js +0 -4
  18. package/cjs/resources/Quotes.js +0 -32
  19. package/cjs/resources/SubscriptionSchedules.js +0 -4
  20. package/cjs/resources/Terminal/Readers.js +0 -12
  21. package/cjs/resources/V2/Billing/MeterEventAdjustments.js +12 -0
  22. package/cjs/resources/V2/Billing/MeterEventSession.js +12 -0
  23. package/cjs/resources/V2/Billing/MeterEventStream.js +13 -0
  24. package/cjs/resources/V2/Billing/MeterEvents.js +9 -0
  25. package/cjs/resources/V2/Billing.js +18 -0
  26. package/cjs/resources/V2/Core/Events.js +14 -0
  27. package/cjs/resources/V2/Core.js +12 -0
  28. package/cjs/resources/V2.js +14 -0
  29. package/cjs/resources.js +18 -42
  30. package/cjs/stripe.core.js +20 -8
  31. package/cjs/utils.js +41 -10
  32. package/esm/Error.js +27 -2
  33. package/esm/RequestSender.js +115 -75
  34. package/esm/StripeResource.js +9 -4
  35. package/esm/apiVersion.js +1 -2
  36. package/esm/autoPagination.js +52 -8
  37. package/esm/crypto/CryptoProvider.js +6 -0
  38. package/esm/crypto/NodeCryptoProvider.js +7 -0
  39. package/esm/crypto/SubtleCryptoProvider.js +4 -0
  40. package/esm/resources/{Capital/FinancingSummary.js → Billing/CreditBalanceSummary.js} +2 -2
  41. package/esm/resources/{FinancialConnections/Institutions.js → Billing/CreditBalanceTransactions.js} +3 -3
  42. package/esm/resources/Billing/CreditGrants.js +27 -0
  43. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  44. package/esm/resources/Invoices.js +0 -17
  45. package/esm/resources/PaymentIntents.js +0 -4
  46. package/esm/resources/Quotes.js +0 -32
  47. package/esm/resources/SubscriptionSchedules.js +0 -4
  48. package/esm/resources/Terminal/Readers.js +0 -12
  49. package/esm/resources/V2/Billing/MeterEventAdjustments.js +9 -0
  50. package/esm/resources/V2/Billing/MeterEventSession.js +9 -0
  51. package/esm/resources/V2/Billing/MeterEventStream.js +10 -0
  52. package/esm/resources/V2/Billing/MeterEvents.js +6 -0
  53. package/esm/resources/V2/Billing.js +15 -0
  54. package/esm/resources/V2/Core/Events.js +11 -0
  55. package/esm/resources/V2/Core.js +9 -0
  56. package/esm/resources/V2.js +11 -0
  57. package/esm/resources.js +7 -29
  58. package/esm/stripe.core.js +21 -9
  59. package/esm/utils.js +38 -9
  60. package/package.json +1 -1
  61. package/types/AccountLinksResource.d.ts +1 -5
  62. package/types/AccountSessions.d.ts +0 -45
  63. package/types/AccountSessionsResource.d.ts +0 -288
  64. package/types/Accounts.d.ts +1 -113
  65. package/types/AccountsResource.d.ts +0 -270
  66. package/types/Billing/Alerts.d.ts +17 -13
  67. package/types/Billing/AlertsResource.d.ts +18 -21
  68. package/types/Billing/CreditBalanceSummary.d.ts +94 -0
  69. package/types/Billing/CreditBalanceSummaryResource.d.ts +64 -0
  70. package/types/Billing/CreditBalanceTransactions.d.ts +159 -0
  71. package/types/Billing/CreditBalanceTransactionsResource.d.ts +54 -0
  72. package/types/Billing/CreditGrants.d.ts +124 -0
  73. package/types/Billing/CreditGrantsResource.d.ts +219 -0
  74. package/types/BillingPortal/ConfigurationsResource.d.ts +2 -2
  75. package/types/Capabilities.d.ts +1 -1
  76. package/types/Charges.d.ts +0 -71
  77. package/types/ChargesResource.d.ts +0 -1294
  78. package/types/Checkout/Sessions.d.ts +4 -296
  79. package/types/Checkout/SessionsResource.d.ts +6 -352
  80. package/types/ConfirmationTokens.d.ts +0 -67
  81. package/types/Coupons.d.ts +1 -1
  82. package/types/CouponsResource.d.ts +1 -1
  83. package/types/CreditNoteLineItems.d.ts +30 -0
  84. package/types/CreditNotes.d.ts +27 -18
  85. package/types/CreditNotesResource.d.ts +0 -51
  86. package/types/Customers.d.ts +2 -3
  87. package/types/CustomersResource.d.ts +0 -3
  88. package/types/Disputes.d.ts +0 -152
  89. package/types/DisputesResource.d.ts +0 -120
  90. package/types/Errors.d.ts +32 -2
  91. package/types/EventTypes.d.ts +2 -545
  92. package/types/Events.d.ts +0 -90
  93. package/types/FinancialConnections/Accounts.d.ts +1 -29
  94. package/types/FinancialConnections/AccountsResource.d.ts +3 -35
  95. package/types/FinancialConnections/Sessions.d.ts +1 -49
  96. package/types/FinancialConnections/SessionsResource.d.ts +1 -38
  97. package/types/InvoiceItems.d.ts +0 -5
  98. package/types/InvoiceItemsResource.d.ts +0 -98
  99. package/types/InvoiceLineItems.d.ts +29 -20
  100. package/types/Invoices.d.ts +25 -108
  101. package/types/InvoicesResource.d.ts +1835 -5493
  102. package/types/Issuing/CardholdersResource.d.ts +1 -2
  103. package/types/Issuing/Transactions.d.ts +0 -2
  104. package/types/Issuing/TransactionsResource.d.ts +0 -5
  105. package/types/LineItems.d.ts +0 -7
  106. package/types/Mandates.d.ts +0 -77
  107. package/types/PaymentIntents.d.ts +1 -503
  108. package/types/PaymentIntentsResource.d.ts +3464 -7064
  109. package/types/PaymentLinks.d.ts +0 -3
  110. package/types/PaymentLinksResource.d.ts +0 -6
  111. package/types/PaymentMethodConfigurations.d.ts +0 -36
  112. package/types/PaymentMethodConfigurationsResource.d.ts +0 -50
  113. package/types/PaymentMethods.d.ts +0 -67
  114. package/types/PaymentMethodsResource.d.ts +0 -88
  115. package/types/Prices.d.ts +0 -22
  116. package/types/PricesResource.d.ts +0 -22
  117. package/types/Products.d.ts +0 -39
  118. package/types/ProductsResource.d.ts +28 -37
  119. package/types/PromotionCodes.d.ts +1 -1
  120. package/types/PromotionCodesResource.d.ts +3 -1
  121. package/types/Quotes.d.ts +1 -596
  122. package/types/QuotesResource.d.ts +199 -2531
  123. package/types/SetupAttempts.d.ts +0 -10
  124. package/types/SetupIntents.d.ts +1 -111
  125. package/types/SetupIntentsResource.d.ts +3 -522
  126. package/types/Sources.d.ts +0 -23
  127. package/types/SubscriptionItems.d.ts +0 -21
  128. package/types/SubscriptionItemsResource.d.ts +0 -109
  129. package/types/SubscriptionSchedules.d.ts +0 -200
  130. package/types/SubscriptionSchedulesResource.d.ts +13 -1231
  131. package/types/Subscriptions.d.ts +1 -82
  132. package/types/SubscriptionsResource.d.ts +5 -350
  133. package/types/Tax/Settings.d.ts +1 -1
  134. package/types/Terminal/Readers.d.ts +0 -278
  135. package/types/Terminal/ReadersResource.d.ts +13 -212
  136. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -63
  137. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  138. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  139. package/types/ThinEvent.d.ts +36 -0
  140. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  141. package/types/Treasury/FinancialAccountsResource.d.ts +0 -10
  142. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  143. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  144. package/types/Treasury/ReceivedCredits.d.ts +5 -27
  145. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  146. package/types/V2/Billing/MeterEventAdjustments.d.ts +65 -0
  147. package/types/V2/Billing/MeterEventAdjustmentsResource.d.ts +47 -0
  148. package/types/V2/Billing/MeterEventSessionResource.d.ts +26 -0
  149. package/types/V2/Billing/MeterEventSessions.d.ts +45 -0
  150. package/types/V2/Billing/MeterEventStreamResource.d.ts +62 -0
  151. package/types/V2/Billing/MeterEvents.d.ts +54 -0
  152. package/types/V2/Billing/MeterEventsResource.d.ts +52 -0
  153. package/types/V2/BillingResource.d.ts +14 -0
  154. package/types/V2/Core/EventsResource.d.ts +57 -0
  155. package/types/V2/CoreResource.d.ts +11 -0
  156. package/types/V2/EventTypes.d.ts +214 -0
  157. package/types/V2/Events.d.ts +75 -0
  158. package/types/V2Resource.d.ts +10 -0
  159. package/types/WebhookEndpointsResource.d.ts +2 -65
  160. package/types/index.d.ts +67 -53
  161. package/types/lib.d.ts +1 -6
  162. package/types/test/typescriptTest.ts +3 -3
  163. package/cjs/resources/AccountNotices.js +0 -21
  164. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  165. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  166. package/cjs/resources/GiftCards/Cards.js +0 -23
  167. package/cjs/resources/GiftCards/Transactions.js +0 -33
  168. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  169. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  170. package/cjs/resources/Margins.js +0 -22
  171. package/cjs/resources/Orders.js +0 -24
  172. package/cjs/resources/Tax/Associations.js +0 -9
  173. package/cjs/resources/Tax/Forms.js +0 -20
  174. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  175. package/esm/resources/AccountNotices.js +0 -18
  176. package/esm/resources/Capital/FinancingOffers.js +0 -18
  177. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  178. package/esm/resources/GiftCards/Cards.js +0 -20
  179. package/esm/resources/GiftCards/Transactions.js +0 -30
  180. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  181. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  182. package/esm/resources/Margins.js +0 -19
  183. package/esm/resources/Orders.js +0 -21
  184. package/esm/resources/Tax/Associations.js +0 -6
  185. package/esm/resources/Tax/Forms.js +0 -17
  186. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  187. package/types/AccountNotices.d.ts +0 -113
  188. package/types/AccountNoticesResource.d.ts +0 -98
  189. package/types/Billing/MeterErrorReports.d.ts +0 -106
  190. package/types/Capital/FinancingOffers.d.ts +0 -188
  191. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  192. package/types/Capital/FinancingSummary.d.ts +0 -106
  193. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  194. package/types/Capital/FinancingTransactions.d.ts +0 -135
  195. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  196. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  197. package/types/FinancialConnections/Institutions.d.ts +0 -93
  198. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  199. package/types/GiftCards/Cards.d.ts +0 -118
  200. package/types/GiftCards/CardsResource.d.ts +0 -159
  201. package/types/GiftCards/Transactions.d.ts +0 -129
  202. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  203. package/types/InvoicePayments.d.ts +0 -138
  204. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  205. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  206. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -73
  207. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  208. package/types/Issuing/Settlements.d.ts +0 -103
  209. package/types/Margins.d.ts +0 -56
  210. package/types/MarginsResource.d.ts +0 -114
  211. package/types/Orders.d.ts +0 -1084
  212. package/types/OrdersResource.d.ts +0 -2765
  213. package/types/QuoteLines.d.ts +0 -634
  214. package/types/QuotePreviewInvoices.d.ts +0 -1548
  215. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -814
  216. package/types/Tax/Associations.d.ts +0 -126
  217. package/types/Tax/AssociationsResource.d.ts +0 -29
  218. package/types/Tax/Forms.d.ts +0 -133
  219. package/types/Tax/FormsResource.d.ts +0 -90
  220. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  221. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
@@ -1,73 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Issuing {
6
- /**
7
- * Represents a record from the card network of a money movement or change in state for an Issuing dispute. These records are included in the settlement reports that we receive from networks and expose to users as Settlement objects.
8
- */
9
- interface DisputeSettlementDetail {
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: 'issuing.dispute_settlement_detail';
19
-
20
- /**
21
- * Disputed amount in the card's currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
22
- */
23
- amount: number;
24
-
25
- /**
26
- * The card used to make the original transaction.
27
- */
28
- card: string;
29
-
30
- /**
31
- * Time at which the object was created. Measured in seconds since the Unix epoch.
32
- */
33
- created: number;
34
-
35
- /**
36
- * The currency the original transaction was made in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
37
- */
38
- currency: string;
39
-
40
- /**
41
- * The ID of the linked dispute.
42
- */
43
- dispute: string;
44
-
45
- /**
46
- * The type of event corresponding to this dispute settlement detail, representing the stage in the dispute network lifecycle.
47
- */
48
- event_type: DisputeSettlementDetail.EventType;
49
-
50
- /**
51
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
52
- */
53
- livemode: boolean;
54
-
55
- /**
56
- * The card network for this dispute settlement detail. One of ["visa", "mastercard", "maestro"]
57
- */
58
- network: DisputeSettlementDetail.Network;
59
-
60
- /**
61
- * The ID of the linked card network settlement.
62
- */
63
- settlement: string | null;
64
- }
65
-
66
- namespace DisputeSettlementDetail {
67
- type EventType = 'filing' | 'loss' | 'representment' | 'win';
68
-
69
- type Network = 'maestro' | 'mastercard' | 'visa';
70
- }
71
- }
72
- }
73
- }
@@ -1,52 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Issuing {
6
- interface DisputeSettlementDetailRetrieveParams {
7
- /**
8
- * Specifies which fields in the response should be expanded.
9
- */
10
- expand?: Array<string>;
11
- }
12
-
13
- interface DisputeSettlementDetailListParams extends PaginationParams {
14
- /**
15
- * Specifies which fields in the response should be expanded.
16
- */
17
- expand?: Array<string>;
18
-
19
- /**
20
- * Select the Issuing dispute settlement details for the given settlement.
21
- */
22
- settlement?: string;
23
- }
24
-
25
- class DisputeSettlementDetailsResource {
26
- /**
27
- * Retrieves an Issuing DisputeSettlementDetail object.
28
- */
29
- retrieve(
30
- id: string,
31
- params?: DisputeSettlementDetailRetrieveParams,
32
- options?: RequestOptions
33
- ): Promise<Stripe.Response<Stripe.Issuing.DisputeSettlementDetail>>;
34
- retrieve(
35
- id: string,
36
- options?: RequestOptions
37
- ): Promise<Stripe.Response<Stripe.Issuing.DisputeSettlementDetail>>;
38
-
39
- /**
40
- * Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
41
- */
42
- list(
43
- params?: DisputeSettlementDetailListParams,
44
- options?: RequestOptions
45
- ): ApiListPromise<Stripe.Issuing.DisputeSettlementDetail>;
46
- list(
47
- options?: RequestOptions
48
- ): ApiListPromise<Stripe.Issuing.DisputeSettlementDetail>;
49
- }
50
- }
51
- }
52
- }
@@ -1,103 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Issuing {
6
- /**
7
- * When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
8
- */
9
- interface Settlement {
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: 'issuing.settlement';
19
-
20
- /**
21
- * The Bank Identification Number reflecting this settlement record.
22
- */
23
- bin: string;
24
-
25
- /**
26
- * The date that the transactions are cleared and posted to user's accounts.
27
- */
28
- clearing_date: number;
29
-
30
- /**
31
- * Time at which the object was created. Measured in seconds since the Unix epoch.
32
- */
33
- created: number;
34
-
35
- /**
36
- * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
37
- */
38
- currency: string;
39
-
40
- /**
41
- * The total interchange received as reimbursement for the transactions.
42
- */
43
- interchange_fees: number;
44
-
45
- /**
46
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
47
- */
48
- livemode: boolean;
49
-
50
- /**
51
- * 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.
52
- */
53
- metadata: Stripe.Metadata;
54
-
55
- /**
56
- * The total net amount required to settle with the network.
57
- */
58
- net_total: number;
59
-
60
- /**
61
- * The card network for this settlement report. One of ["visa", "maestro"]
62
- */
63
- network: Settlement.Network;
64
-
65
- /**
66
- * The total amount of fees owed to the network.
67
- */
68
- network_fees: number;
69
-
70
- /**
71
- * The Settlement Identification Number assigned by the network.
72
- */
73
- network_settlement_identifier: string;
74
-
75
- /**
76
- * One of `international` or `uk_national_net`.
77
- */
78
- settlement_service: string;
79
-
80
- /**
81
- * The current processing status of this settlement.
82
- */
83
- status: Settlement.Status;
84
-
85
- /**
86
- * The total number of transactions reflected in this settlement.
87
- */
88
- transaction_count: number;
89
-
90
- /**
91
- * The total transaction amount reflected in this settlement.
92
- */
93
- transaction_volume: number;
94
- }
95
-
96
- namespace Settlement {
97
- type Network = 'maestro' | 'visa';
98
-
99
- type Status = 'complete' | 'pending';
100
- }
101
- }
102
- }
103
- }
@@ -1,56 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- /**
6
- * A (partner) margin represents a specific discount distributed in partner reseller programs to business partners who
7
- * resell products and services and earn a discount (margin) for doing so.
8
- */
9
- interface Margin {
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: 'margin';
19
-
20
- /**
21
- * Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to `true`.
22
- */
23
- active: boolean;
24
-
25
- /**
26
- * Time at which the object was created. Measured in seconds since the Unix epoch.
27
- */
28
- created: number;
29
-
30
- /**
31
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
32
- */
33
- livemode: boolean;
34
-
35
- /**
36
- * 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.
37
- */
38
- metadata: Stripe.Metadata | null;
39
-
40
- /**
41
- * Name of the margin that's displayed on, for example, invoices.
42
- */
43
- name: string | null;
44
-
45
- /**
46
- * Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
47
- */
48
- percent_off: number;
49
-
50
- /**
51
- * Time at which the object was last updated. Measured in seconds since the Unix epoch.
52
- */
53
- updated: number;
54
- }
55
- }
56
- }
@@ -1,114 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- interface MarginCreateParams {
6
- /**
7
- * Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
8
- */
9
- percent_off: number;
10
-
11
- /**
12
- * Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`.
13
- */
14
- active?: boolean;
15
-
16
- /**
17
- * Specifies which fields in the response should be expanded.
18
- */
19
- expand?: Array<string>;
20
-
21
- /**
22
- * 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`.
23
- */
24
- metadata?: Stripe.MetadataParam;
25
-
26
- /**
27
- * Name of the margin, which is displayed to customers, such as on invoices.
28
- */
29
- name?: string;
30
- }
31
-
32
- interface MarginRetrieveParams {
33
- /**
34
- * Specifies which fields in the response should be expanded.
35
- */
36
- expand?: Array<string>;
37
- }
38
-
39
- interface MarginUpdateParams {
40
- /**
41
- * Whether the margin can be applied to invoices, invoice items, or invoice line items or not.
42
- */
43
- active?: boolean;
44
-
45
- /**
46
- * Specifies which fields in the response should be expanded.
47
- */
48
- expand?: Array<string>;
49
-
50
- /**
51
- * 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`.
52
- */
53
- metadata?: Stripe.MetadataParam;
54
-
55
- /**
56
- * Name of the margin, which is displayed to customers, such as on invoices.
57
- */
58
- name?: string;
59
- }
60
-
61
- interface MarginListParams extends PaginationParams {
62
- /**
63
- * Only return margins that are active or inactive. For example, pass `true` to only list active margins.
64
- */
65
- active?: boolean;
66
-
67
- /**
68
- * Specifies which fields in the response should be expanded.
69
- */
70
- expand?: Array<string>;
71
- }
72
-
73
- class MarginsResource {
74
- /**
75
- * Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
76
- */
77
- create(
78
- params: MarginCreateParams,
79
- options?: RequestOptions
80
- ): Promise<Stripe.Response<Stripe.Margin>>;
81
-
82
- /**
83
- * Retrieve a margin object with the given ID.
84
- */
85
- retrieve(
86
- id: string,
87
- params?: MarginRetrieveParams,
88
- options?: RequestOptions
89
- ): Promise<Stripe.Response<Stripe.Margin>>;
90
- retrieve(
91
- id: string,
92
- options?: RequestOptions
93
- ): Promise<Stripe.Response<Stripe.Margin>>;
94
-
95
- /**
96
- * Update the specified margin object. Certain fields of the margin object are not editable.
97
- */
98
- update(
99
- id: string,
100
- params?: MarginUpdateParams,
101
- options?: RequestOptions
102
- ): Promise<Stripe.Response<Stripe.Margin>>;
103
-
104
- /**
105
- * Retrieve a list of your margins.
106
- */
107
- list(
108
- params?: MarginListParams,
109
- options?: RequestOptions
110
- ): ApiListPromise<Stripe.Margin>;
111
- list(options?: RequestOptions): ApiListPromise<Stripe.Margin>;
112
- }
113
- }
114
- }