stripe 20.1.0-alpha.2 → 20.1.0-alpha.4

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 CHANGED
@@ -1,5 +1,27 @@
1
1
  # Changelog
2
2
 
3
+ ## 20.1.0-alpha.4 - 2025-12-04
4
+ * [#2519](https://github.com/stripe/stripe-node/pull/2519) Update generated code for private-preview
5
+ * Add support for event notifications `V2IamApiKeyCreatedEvent`, `V2IamApiKeyDefaultSecretRevealedEvent`, `V2IamApiKeyExpiredEvent`, `V2IamApiKeyPermissionsUpdatedEvent`, `V2IamApiKeyRotatedEvent`, and `V2IamApiKeyUpdatedEvent`
6
+ * [#2517](https://github.com/stripe/stripe-node/pull/2517) Update generated code for private-preview
7
+ * Add support for `check_scanning` on `AccountSession.components`
8
+ * Add support for `client` on `V2.Core.Event.reason.request`
9
+ * Add support for `stripe_balance_payment` on `V2.MoneyManagement.ReceivedCredit` and `V2.MoneyManagement.ReceivedDebit`
10
+ * Add support for new value `stripe_balance_payment` on enum `V2.MoneyManagement.ReceivedCredit.type`
11
+ * Add support for `balance_transfer` on `V2.MoneyManagement.ReceivedDebit`
12
+ * Add support for new values `balance_transfer` and `stripe_balance_payment` on enum `V2.MoneyManagement.ReceivedDebit.type`
13
+ * Add support for `include` on `V2.Core.EventListParams` and `V2.Core.EventRetrieveParams`
14
+
15
+ ## 20.1.0-alpha.3 - 2025-11-24
16
+ * [#2512](https://github.com/stripe/stripe-node/pull/2512) Update generated code for private-preview
17
+ * Add support for new resource `ProductCatalog.TrialOffer`
18
+ * Add support for `create` method on resource `ProductCatalog.TrialOffer`
19
+ * Remove support for `amount_subtotal_after_discount` on `DelegatedCheckout.RequestedSession.line_item_details[]` and `DelegatedCheckout.RequestedSession.total_details`
20
+ * Remove support for `amount_total`, `unit_amount_after_discount`, and `unit_discount` on `DelegatedCheckout.RequestedSession.line_item_details[]`
21
+ * Add support for `amount_cart_discount` and `amount_items_discount` on `DelegatedCheckout.RequestedSession.total_details`
22
+ * Remove support for `amount_discount` on `DelegatedCheckout.RequestedSession.total_details`
23
+ * Add support for `payments_orchestration` on `PaymentIntentCreateParams` and `PaymentIntent`
24
+
3
25
  ## 20.1.0-alpha.2 - 2025-11-20
4
26
  This release changes the pinned API version to `2025-11-17.preview`.
5
27
 
package/OPENAPI_VERSION CHANGED
@@ -1 +1 @@
1
- v2128
1
+ v2132
package/VERSION CHANGED
@@ -1 +1 @@
1
- 20.1.0-alpha.2
1
+ 20.1.0-alpha.4
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.TrialOffers = void 0;
5
+ const StripeResource_js_1 = require("../../StripeResource.js");
6
+ const stripeMethod = StripeResource_js_1.StripeResource.method;
7
+ exports.TrialOffers = StripeResource_js_1.StripeResource.extend({
8
+ create: stripeMethod({
9
+ method: 'POST',
10
+ fullPath: '/v1/product_catalog/trial_offers',
11
+ }),
12
+ });
package/cjs/resources.js CHANGED
@@ -2,7 +2,7 @@
2
2
  // File generated from our OpenAPI spec
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.SetupAttempts = exports.Reviews = exports.Refunds = exports.Quotes = exports.PromotionCodes = exports.Products = exports.Prices = exports.Plans = exports.Payouts = exports.PaymentRecords = exports.PaymentMethods = exports.PaymentMethodDomains = exports.PaymentMethodConfigurations = exports.PaymentLinks = exports.PaymentIntents = exports.PaymentAttemptRecords = exports.Orders = exports.OAuth = exports.Margins = exports.Mandates = exports.Invoices = exports.InvoiceRenderingTemplates = exports.InvoicePayments = exports.InvoiceItems = exports.FxQuotes = exports.Files = exports.FileLinks = exports.ExternalAccounts = exports.ExchangeRates = exports.Events = exports.EphemeralKeys = exports.Disputes = exports.Customers = exports.CustomerSessions = exports.CreditNotes = exports.Coupons = exports.CountrySpecs = exports.ConfirmationTokens = exports.Charges = exports.BalanceTransfers = exports.BalanceTransactions = exports.BalanceSettings = exports.Balance = exports.ApplicationFees = exports.ApplePayDomains = exports.Accounts = exports.AccountSessions = exports.AccountNotices = exports.AccountLinks = exports.Account = void 0;
5
- exports.V2 = exports.Treasury = exports.TestHelpers = exports.Terminal = exports.Tax = exports.Sigma = exports.Reporting = exports.Radar = exports.Privacy = exports.Issuing = exports.Identity = exports.Forwarding = exports.FinancialConnections = exports.Entitlements = exports.DelegatedCheckout = exports.Climate = exports.Checkout = exports.Capital = exports.BillingPortal = exports.Billing = exports.Apps = exports.WebhookEndpoints = exports.Transfers = exports.Topups = exports.Tokens = exports.TaxRates = exports.TaxIds = exports.TaxCodes = exports.Subscriptions = exports.SubscriptionSchedules = exports.SubscriptionItems = exports.Sources = exports.ShippingRates = exports.SetupIntents = void 0;
5
+ exports.V2 = exports.Treasury = exports.TestHelpers = exports.Terminal = exports.Tax = exports.Sigma = exports.Reporting = exports.Radar = exports.ProductCatalog = exports.Privacy = exports.Issuing = exports.Identity = exports.Forwarding = exports.FinancialConnections = exports.Entitlements = exports.DelegatedCheckout = exports.Climate = exports.Checkout = exports.Capital = exports.BillingPortal = exports.Billing = exports.Apps = exports.WebhookEndpoints = exports.Transfers = exports.Topups = exports.Tokens = exports.TaxRates = exports.TaxIds = exports.TaxCodes = exports.Subscriptions = exports.SubscriptionSchedules = exports.SubscriptionItems = exports.Sources = exports.ShippingRates = exports.SetupIntents = void 0;
6
6
  const ResourceNamespace_js_1 = require("./ResourceNamespace.js");
7
7
  const AccountEvaluations_js_1 = require("./resources/Radar/AccountEvaluations.js");
8
8
  const AccountLinks_js_1 = require("./resources/V2/Core/AccountLinks.js");
@@ -133,6 +133,7 @@ const Transactions_js_3 = require("./resources/Tax/Transactions.js");
133
133
  const Transactions_js_4 = require("./resources/TestHelpers/Issuing/Transactions.js");
134
134
  const Transactions_js_5 = require("./resources/Treasury/Transactions.js");
135
135
  const Transactions_js_6 = require("./resources/V2/MoneyManagement/Transactions.js");
136
+ const TrialOffers_js_1 = require("./resources/ProductCatalog/TrialOffers.js");
136
137
  const UsBankAccounts_js_1 = require("./resources/V2/Core/Vault/UsBankAccounts.js");
137
138
  const ValueListItems_js_1 = require("./resources/Radar/ValueListItems.js");
138
139
  const ValueLists_js_1 = require("./resources/Radar/ValueLists.js");
@@ -332,6 +333,9 @@ exports.Issuing = (0, ResourceNamespace_js_1.resourceNamespace)('issuing', {
332
333
  exports.Privacy = (0, ResourceNamespace_js_1.resourceNamespace)('privacy', {
333
334
  RedactionJobs: RedactionJobs_js_1.RedactionJobs,
334
335
  });
336
+ exports.ProductCatalog = (0, ResourceNamespace_js_1.resourceNamespace)('productCatalog', {
337
+ TrialOffers: TrialOffers_js_1.TrialOffers,
338
+ });
335
339
  exports.Radar = (0, ResourceNamespace_js_1.resourceNamespace)('radar', {
336
340
  AccountEvaluations: AccountEvaluations_js_1.AccountEvaluations,
337
341
  EarlyFraudWarnings: EarlyFraudWarnings_js_1.EarlyFraudWarnings,
@@ -37,7 +37,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
37
37
  ];
38
38
  const defaultRequestSenderFactory = (stripe) => new RequestSender_js_1.RequestSender(stripe, StripeResource_js_1.StripeResource.MAX_BUFFERED_REQUEST_METRICS);
39
39
  function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
40
- Stripe.PACKAGE_VERSION = '20.1.0-alpha.2';
40
+ Stripe.PACKAGE_VERSION = '20.1.0-alpha.4';
41
41
  Stripe.API_VERSION = apiVersion_js_1.ApiVersion;
42
42
  Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, (0, utils_js_1.determineProcessUserAgentProperties)());
43
43
  Stripe.StripeResource = StripeResource_js_1.StripeResource;
@@ -0,0 +1,9 @@
1
+ // File generated from our OpenAPI spec
2
+ import { StripeResource } from '../../StripeResource.js';
3
+ const stripeMethod = StripeResource.method;
4
+ export const TrialOffers = StripeResource.extend({
5
+ create: stripeMethod({
6
+ method: 'POST',
7
+ fullPath: '/v1/product_catalog/trial_offers',
8
+ }),
9
+ });
package/esm/resources.js CHANGED
@@ -129,6 +129,7 @@ import { Transactions as TaxTransactions } from './resources/Tax/Transactions.js
129
129
  import { Transactions as TestHelpersIssuingTransactions } from './resources/TestHelpers/Issuing/Transactions.js';
130
130
  import { Transactions as TreasuryTransactions } from './resources/Treasury/Transactions.js';
131
131
  import { Transactions as V2MoneyManagementTransactions } from './resources/V2/MoneyManagement/Transactions.js';
132
+ import { TrialOffers as ProductCatalogTrialOffers } from './resources/ProductCatalog/TrialOffers.js';
132
133
  import { UsBankAccounts as V2CoreVaultUsBankAccounts } from './resources/V2/Core/Vault/UsBankAccounts.js';
133
134
  import { ValueListItems as RadarValueListItems } from './resources/Radar/ValueListItems.js';
134
135
  import { ValueLists as RadarValueLists } from './resources/Radar/ValueLists.js';
@@ -265,6 +266,9 @@ export const Issuing = resourceNamespace('issuing', {
265
266
  export const Privacy = resourceNamespace('privacy', {
266
267
  RedactionJobs: PrivacyRedactionJobs,
267
268
  });
269
+ export const ProductCatalog = resourceNamespace('productCatalog', {
270
+ TrialOffers: ProductCatalogTrialOffers,
271
+ });
268
272
  export const Radar = resourceNamespace('radar', {
269
273
  AccountEvaluations: RadarAccountEvaluations,
270
274
  EarlyFraudWarnings: RadarEarlyFraudWarnings,
@@ -34,7 +34,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
34
34
  ];
35
35
  const defaultRequestSenderFactory = (stripe) => new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
36
36
  export function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
37
- Stripe.PACKAGE_VERSION = '20.1.0-alpha.2';
37
+ Stripe.PACKAGE_VERSION = '20.1.0-alpha.4';
38
38
  Stripe.API_VERSION = ApiVersion;
39
39
  Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, determineProcessUserAgentProperties());
40
40
  Stripe.StripeResource = StripeResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stripe",
3
- "version": "20.1.0-alpha.2",
3
+ "version": "20.1.0-alpha.4",
4
4
  "description": "Stripe API wrapper",
5
5
  "keywords": [
6
6
  "stripe",
@@ -89,6 +89,11 @@ declare module 'stripe' {
89
89
  tax_registrations: Components.TaxRegistrations;
90
90
 
91
91
  tax_settings: Components.TaxSettings;
92
+
93
+ /**
94
+ * Configuration for the [check scanning](https://docs.stripe.com/connect/supported-embedded-components/check-scanning/) embedded component.
95
+ */
96
+ check_scanning?: Components.CheckScanning | null;
92
97
  }
93
98
 
94
99
  namespace Components {
@@ -215,6 +220,19 @@ declare module 'stripe' {
215
220
  interface Features {}
216
221
  }
217
222
 
223
+ interface CheckScanning {
224
+ /**
225
+ * Whether the embedded component is enabled.
226
+ */
227
+ enabled: boolean;
228
+
229
+ features: CheckScanning.Features;
230
+ }
231
+
232
+ namespace CheckScanning {
233
+ interface Features {}
234
+ }
235
+
218
236
  interface DisputesList {
219
237
  /**
220
238
  * Whether the embedded component is enabled.
@@ -1781,14 +1781,26 @@ declare module 'stripe' {
1781
1781
  }
1782
1782
 
1783
1783
  interface SelfReportedIncome {
1784
+ /**
1785
+ * The amount in the minor currency unit (for example, cents for USD).
1786
+ */
1784
1787
  amount: number;
1785
1788
 
1789
+ /**
1790
+ * 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).
1791
+ */
1786
1792
  currency: string;
1787
1793
  }
1788
1794
 
1789
1795
  interface SelfReportedMonthlyHousingPayment {
1796
+ /**
1797
+ * The amount in the minor currency unit (for example, cents for USD).
1798
+ */
1790
1799
  amount: number;
1791
1800
 
1801
+ /**
1802
+ * 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).
1803
+ */
1792
1804
  currency: string;
1793
1805
  }
1794
1806
 
@@ -3932,14 +3944,26 @@ declare module 'stripe' {
3932
3944
  }
3933
3945
 
3934
3946
  interface SelfReportedIncome {
3947
+ /**
3948
+ * The amount in the minor currency unit (for example, cents for USD).
3949
+ */
3935
3950
  amount: number;
3936
3951
 
3952
+ /**
3953
+ * 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).
3954
+ */
3937
3955
  currency: string;
3938
3956
  }
3939
3957
 
3940
3958
  interface SelfReportedMonthlyHousingPayment {
3959
+ /**
3960
+ * The amount in the minor currency unit (for example, cents for USD).
3961
+ */
3941
3962
  amount: number;
3942
3963
 
3964
+ /**
3965
+ * 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).
3966
+ */
3943
3967
  currency: string;
3944
3968
  }
3945
3969
 
@@ -4780,14 +4804,26 @@ declare module 'stripe' {
4780
4804
  }
4781
4805
 
4782
4806
  interface SelfReportedIncome {
4807
+ /**
4808
+ * The amount in the minor currency unit (for example, cents for USD).
4809
+ */
4783
4810
  amount: number;
4784
4811
 
4812
+ /**
4813
+ * 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).
4814
+ */
4785
4815
  currency: string;
4786
4816
  }
4787
4817
 
4788
4818
  interface SelfReportedMonthlyHousingPayment {
4819
+ /**
4820
+ * The amount in the minor currency unit (for example, cents for USD).
4821
+ */
4789
4822
  amount: number;
4790
4823
 
4824
+ /**
4825
+ * 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).
4826
+ */
4791
4827
  currency: string;
4792
4828
  }
4793
4829
 
@@ -5431,14 +5467,26 @@ declare module 'stripe' {
5431
5467
  }
5432
5468
 
5433
5469
  interface SelfReportedIncome {
5470
+ /**
5471
+ * The amount in the minor currency unit (for example, cents for USD).
5472
+ */
5434
5473
  amount: number;
5435
5474
 
5475
+ /**
5476
+ * 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).
5477
+ */
5436
5478
  currency: string;
5437
5479
  }
5438
5480
 
5439
5481
  interface SelfReportedMonthlyHousingPayment {
5482
+ /**
5483
+ * The amount in the minor currency unit (for example, cents for USD).
5484
+ */
5440
5485
  amount: number;
5441
5486
 
5487
+ /**
5488
+ * 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).
5489
+ */
5442
5490
  currency: string;
5443
5491
  }
5444
5492
 
@@ -272,26 +272,6 @@ declare module 'stripe' {
272
272
  * The total before any discounts or taxes are applied.
273
273
  */
274
274
  amount_subtotal: number;
275
-
276
- /**
277
- * The total after discounts but before taxes are applied.
278
- */
279
- amount_subtotal_after_discount: number;
280
-
281
- /**
282
- * The total after discounts and taxes.
283
- */
284
- amount_total: number;
285
-
286
- /**
287
- * The per-unit amount of the item after discounts but before taxes are applied.
288
- */
289
- unit_amount_after_discount: number;
290
-
291
- /**
292
- * The per-unit discount amount. If no discount were applied, defaults to 0.
293
- */
294
- unit_discount: number;
295
275
  }
296
276
 
297
277
  interface OrderDetails {
@@ -369,11 +349,6 @@ declare module 'stripe' {
369
349
  type Status = 'completed' | 'expired' | 'open';
370
350
 
371
351
  interface TotalDetails {
372
- /**
373
- * The amount discount of the total details.
374
- */
375
- amount_discount: number | null;
376
-
377
352
  /**
378
353
  * The amount fulfillment of the total details.
379
354
  */
@@ -385,9 +360,14 @@ declare module 'stripe' {
385
360
  amount_tax: number | null;
386
361
 
387
362
  /**
388
- * Total of all items after discounts but before taxes are applied.
363
+ * The amount of order-level discounts applied to the cart. The total discount amount for this session can be computed by summing the cart discount and the item discounts.
364
+ */
365
+ amount_cart_discount: number | null;
366
+
367
+ /**
368
+ * The amount of item-level discounts applied to the cart. The total discount amount for this session can be computed by summing the cart discount and the item discounts.
389
369
  */
390
- amount_subtotal_after_discount: number | null;
370
+ amount_items_discount: number | null;
391
371
 
392
372
  /**
393
373
  * The applicable fees of the total details.
@@ -113,7 +113,7 @@ declare module 'stripe' {
113
113
  postal_code: string;
114
114
 
115
115
  /**
116
- * State, county, province, or region.
116
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
117
117
  */
118
118
  state: string;
119
119
  }
@@ -199,7 +199,7 @@ declare module 'stripe' {
199
199
  postal_code: string;
200
200
 
201
201
  /**
202
- * State, county, province, or region.
202
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
203
203
  */
204
204
  state: string;
205
205
  }
@@ -338,7 +338,7 @@ declare module 'stripe' {
338
338
  postal_code: string;
339
339
 
340
340
  /**
341
- * State, county, province, or region.
341
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
342
342
  */
343
343
  state: string;
344
344
  }
@@ -445,7 +445,7 @@ declare module 'stripe' {
445
445
  postal_code: string;
446
446
 
447
447
  /**
448
- * State, county, province, or region.
448
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
449
449
  */
450
450
  state: string;
451
451
  }
@@ -191,6 +191,11 @@ declare module 'stripe' {
191
191
  */
192
192
  payment_method_types: Array<string>;
193
193
 
194
+ /**
195
+ * When you enable this parameter, this PaymentIntent will route your payment to processors that you configure in the dashboard.
196
+ */
197
+ payments_orchestration?: PaymentIntent.PaymentsOrchestration | null;
198
+
194
199
  presentment_details?: PaymentIntent.PresentmentDetails;
195
200
 
196
201
  /**
@@ -3674,6 +3679,13 @@ declare module 'stripe' {
3674
3679
  }
3675
3680
  }
3676
3681
 
3682
+ interface PaymentsOrchestration {
3683
+ /**
3684
+ * Whether this feature is enabled.
3685
+ */
3686
+ enabled: boolean;
3687
+ }
3688
+
3677
3689
  interface PresentmentDetails {
3678
3690
  /**
3679
3691
  * Amount intended to be collected by this payment, denominated in `presentment_currency`.
@@ -166,6 +166,11 @@ declare module 'stripe' {
166
166
  */
167
167
  payment_method_types?: Array<string>;
168
168
 
169
+ /**
170
+ * When you enable this parameter, this PaymentIntent will route your payment to processors that you configure in the dashboard.
171
+ */
172
+ payments_orchestration?: PaymentIntentCreateParams.PaymentsOrchestration;
173
+
169
174
  /**
170
175
  * Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).
171
176
  */
@@ -6984,6 +6989,13 @@ declare module 'stripe' {
6984
6989
  }
6985
6990
  }
6986
6991
 
6992
+ interface PaymentsOrchestration {
6993
+ /**
6994
+ * Whether this feature is enabled.
6995
+ */
6996
+ enabled: boolean;
6997
+ }
6998
+
6987
6999
  interface RadarOptions {
6988
7000
  /**
6989
7001
  * A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
@@ -676,7 +676,7 @@ declare module 'stripe' {
676
676
 
677
677
  interface SelfReportedIncome {
678
678
  /**
679
- * Amount in the minor currency unit (e.g., cents for USD)
679
+ * The amount in the minor currency unit (for example, cents for USD).
680
680
  */
681
681
  amount: number;
682
682
 
@@ -688,7 +688,7 @@ declare module 'stripe' {
688
688
 
689
689
  interface SelfReportedMonthlyHousingPayment {
690
690
  /**
691
- * Amount in the minor currency unit (e.g., cents for USD)
691
+ * The amount in the minor currency unit (for example, cents for USD).
692
692
  */
693
693
  amount: number;
694
694
 
@@ -0,0 +1,77 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ namespace ProductCatalog {
6
+ /**
7
+ * Resource for the TrialOffer API, used to describe a subscription item's trial period settings.
8
+ * Renders a TrialOffer object that describes the price, duration, end_behavior of a trial offer.
9
+ */
10
+ interface TrialOffer {
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: 'product_catalog.trial_offer';
20
+
21
+ duration: TrialOffer.Duration;
22
+
23
+ end_behavior: TrialOffer.EndBehavior;
24
+
25
+ /**
26
+ * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
27
+ */
28
+ livemode: boolean;
29
+
30
+ /**
31
+ * The price during the trial offer.
32
+ */
33
+ price: string | Stripe.Price;
34
+ }
35
+
36
+ namespace TrialOffer {
37
+ interface Duration {
38
+ relative: Duration.Relative;
39
+
40
+ /**
41
+ * The type of trial offer duration.
42
+ */
43
+ type: Duration.Type;
44
+ }
45
+
46
+ namespace Duration {
47
+ interface Relative {
48
+ /**
49
+ * The number of iterations of the price's interval for this trial offer.
50
+ */
51
+ iterations: number;
52
+ }
53
+
54
+ type Type = 'relative' | 'timestamp';
55
+ }
56
+
57
+ interface EndBehavior {
58
+ transition: EndBehavior.Transition;
59
+
60
+ /**
61
+ * The type of behavior when the trial offer ends.
62
+ */
63
+ type: 'transition';
64
+ }
65
+
66
+ namespace EndBehavior {
67
+ interface Transition {
68
+ /**
69
+ * The new price to use at the end of the trial offer period.
70
+ */
71
+ price: string;
72
+ }
73
+ }
74
+ }
75
+ }
76
+ }
77
+ }
@@ -0,0 +1,80 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ namespace ProductCatalog {
6
+ interface TrialOfferCreateParams {
7
+ /**
8
+ * Duration of one service period of the trial.
9
+ */
10
+ duration: TrialOfferCreateParams.Duration;
11
+
12
+ /**
13
+ * Define behavior that occurs at the end of the trial.
14
+ */
15
+ end_behavior: TrialOfferCreateParams.EndBehavior;
16
+
17
+ /**
18
+ * Price configuration during the trial period (amount, billing scheme, etc).
19
+ */
20
+ price: string;
21
+
22
+ /**
23
+ * Specifies which fields in the response should be expanded.
24
+ */
25
+ expand?: Array<string>;
26
+ }
27
+
28
+ namespace TrialOfferCreateParams {
29
+ interface Duration {
30
+ /**
31
+ * The relative duration of the trial period computed as the number of recurring price intervals.
32
+ */
33
+ relative?: Duration.Relative;
34
+
35
+ /**
36
+ * Specifies how the trial offer duration is determined.
37
+ */
38
+ type: Duration.Type;
39
+ }
40
+
41
+ namespace Duration {
42
+ interface Relative {
43
+ /**
44
+ * The number of recurring price's interval to apply for the trial period.
45
+ */
46
+ iterations: number;
47
+ }
48
+
49
+ type Type = 'relative' | 'timestamp';
50
+ }
51
+
52
+ interface EndBehavior {
53
+ /**
54
+ * The transition to apply when the trial offer ends.
55
+ */
56
+ transition: EndBehavior.Transition;
57
+ }
58
+
59
+ namespace EndBehavior {
60
+ interface Transition {
61
+ /**
62
+ * The price to transition the recurring item to when the trial offer ends.
63
+ */
64
+ price: string;
65
+ }
66
+ }
67
+ }
68
+
69
+ class TrialOffersResource {
70
+ /**
71
+ * Creates a trial offer.
72
+ */
73
+ create(
74
+ params: TrialOfferCreateParams,
75
+ options?: RequestOptions
76
+ ): Promise<Stripe.Response<Stripe.ProductCatalog.TrialOffer>>;
77
+ }
78
+ }
79
+ }
80
+ }
@@ -493,14 +493,26 @@ declare module 'stripe' {
493
493
  }
494
494
 
495
495
  interface SelfReportedIncome {
496
+ /**
497
+ * The amount in the minor currency unit (for example, cents for USD).
498
+ */
496
499
  amount: number;
497
500
 
501
+ /**
502
+ * 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).
503
+ */
498
504
  currency: string;
499
505
  }
500
506
 
501
507
  interface SelfReportedMonthlyHousingPayment {
508
+ /**
509
+ * The amount in the minor currency unit (for example, cents for USD).
510
+ */
502
511
  amount: number;
503
512
 
513
+ /**
514
+ * 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).
515
+ */
504
516
  currency: string;
505
517
  }
506
518
 
@@ -955,14 +967,26 @@ declare module 'stripe' {
955
967
  }
956
968
 
957
969
  interface SelfReportedIncome {
970
+ /**
971
+ * The amount in the minor currency unit (for example, cents for USD).
972
+ */
958
973
  amount: number;
959
974
 
975
+ /**
976
+ * 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).
977
+ */
960
978
  currency: string;
961
979
  }
962
980
 
963
981
  interface SelfReportedMonthlyHousingPayment {
982
+ /**
983
+ * The amount in the minor currency unit (for example, cents for USD).
984
+ */
964
985
  amount: number;
965
986
 
987
+ /**
988
+ * 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).
989
+ */
966
990
  currency: string;
967
991
  }
968
992
 
@@ -86,6 +86,12 @@ declare module 'stripe' {
86
86
  | Stripe.Events.V2CoreHealthTrafficVolumeDropResolvedEvent
87
87
  | Stripe.Events.V2CoreHealthWebhookLatencyFiringEvent
88
88
  | Stripe.Events.V2CoreHealthWebhookLatencyResolvedEvent
89
+ | Stripe.Events.V2IamApiKeyCreatedEvent
90
+ | Stripe.Events.V2IamApiKeyDefaultSecretRevealedEvent
91
+ | Stripe.Events.V2IamApiKeyExpiredEvent
92
+ | Stripe.Events.V2IamApiKeyPermissionsUpdatedEvent
93
+ | Stripe.Events.V2IamApiKeyRotatedEvent
94
+ | Stripe.Events.V2IamApiKeyUpdatedEvent
89
95
  | Stripe.Events.V2MoneyManagementAdjustmentCreatedEvent
90
96
  | Stripe.Events.V2MoneyManagementFinancialAccountCreatedEvent
91
97
  | Stripe.Events.V2MoneyManagementFinancialAccountUpdatedEvent
@@ -221,6 +227,12 @@ declare module 'stripe' {
221
227
  | Stripe.Events.V2CoreHealthTrafficVolumeDropResolvedEventNotification
222
228
  | Stripe.Events.V2CoreHealthWebhookLatencyFiringEventNotification
223
229
  | Stripe.Events.V2CoreHealthWebhookLatencyResolvedEventNotification
230
+ | Stripe.Events.V2IamApiKeyCreatedEventNotification
231
+ | Stripe.Events.V2IamApiKeyDefaultSecretRevealedEventNotification
232
+ | Stripe.Events.V2IamApiKeyExpiredEventNotification
233
+ | Stripe.Events.V2IamApiKeyPermissionsUpdatedEventNotification
234
+ | Stripe.Events.V2IamApiKeyRotatedEventNotification
235
+ | Stripe.Events.V2IamApiKeyUpdatedEventNotification
224
236
  | Stripe.Events.V2MoneyManagementAdjustmentCreatedEventNotification
225
237
  | Stripe.Events.V2MoneyManagementFinancialAccountCreatedEventNotification
226
238
  | Stripe.Events.V2MoneyManagementFinancialAccountUpdatedEventNotification
@@ -3859,6 +3871,91 @@ declare module 'stripe' {
3859
3871
  }
3860
3872
  }
3861
3873
 
3874
+ /**
3875
+ * Occurs when an API Key is created.
3876
+ */
3877
+ export interface V2IamApiKeyCreatedEvent extends V2.Core.EventBase {
3878
+ type: 'v2.iam.api_key.created';
3879
+ }
3880
+ export interface V2IamApiKeyCreatedEventNotification
3881
+ extends V2.Core.EventNotificationBase {
3882
+ type: 'v2.iam.api_key.created';
3883
+ fetchEvent(): Promise<V2IamApiKeyCreatedEvent>;
3884
+ }
3885
+
3886
+ /**
3887
+ * Occurs when the default API Key's secret is revealed.
3888
+ */
3889
+ export interface V2IamApiKeyDefaultSecretRevealedEvent
3890
+ extends V2.Core.EventBase {
3891
+ type: 'v2.iam.api_key.default_secret_revealed';
3892
+ }
3893
+ export interface V2IamApiKeyDefaultSecretRevealedEventNotification
3894
+ extends V2.Core.EventNotificationBase {
3895
+ type: 'v2.iam.api_key.default_secret_revealed';
3896
+ fetchEvent(): Promise<V2IamApiKeyDefaultSecretRevealedEvent>;
3897
+ }
3898
+
3899
+ /**
3900
+ * Occurs when an API Key is expired.
3901
+ */
3902
+ export interface V2IamApiKeyExpiredEvent extends V2.Core.EventBase {
3903
+ type: 'v2.iam.api_key.expired';
3904
+ }
3905
+ export interface V2IamApiKeyExpiredEventNotification
3906
+ extends V2.Core.EventNotificationBase {
3907
+ type: 'v2.iam.api_key.expired';
3908
+ fetchEvent(): Promise<V2IamApiKeyExpiredEvent>;
3909
+ }
3910
+
3911
+ /**
3912
+ * Occurs when an API Key's permissions are updated.
3913
+ */
3914
+ export interface V2IamApiKeyPermissionsUpdatedEvent
3915
+ extends V2.Core.EventBase {
3916
+ type: 'v2.iam.api_key.permissions_updated';
3917
+ }
3918
+ export interface V2IamApiKeyPermissionsUpdatedEventNotification
3919
+ extends V2.Core.EventNotificationBase {
3920
+ type: 'v2.iam.api_key.permissions_updated';
3921
+ fetchEvent(): Promise<V2IamApiKeyPermissionsUpdatedEvent>;
3922
+ }
3923
+
3924
+ /**
3925
+ * Occurs when an API Key is rotated.
3926
+ */
3927
+ export interface V2IamApiKeyRotatedEvent extends V2.Core.EventBase {
3928
+ type: 'v2.iam.api_key.rotated';
3929
+ // Retrieves data specific to this event.
3930
+ data: V2IamApiKeyRotatedEvent.Data;
3931
+ }
3932
+ export interface V2IamApiKeyRotatedEventNotification
3933
+ extends V2.Core.EventNotificationBase {
3934
+ type: 'v2.iam.api_key.rotated';
3935
+ fetchEvent(): Promise<V2IamApiKeyRotatedEvent>;
3936
+ }
3937
+
3938
+ namespace V2IamApiKeyRotatedEvent {
3939
+ export interface Data {
3940
+ /**
3941
+ * ID of the new key that was created due to rotation.
3942
+ */
3943
+ new_api_key: string;
3944
+ }
3945
+ }
3946
+
3947
+ /**
3948
+ * Occurs when an API Key is updated.
3949
+ */
3950
+ export interface V2IamApiKeyUpdatedEvent extends V2.Core.EventBase {
3951
+ type: 'v2.iam.api_key.updated';
3952
+ }
3953
+ export interface V2IamApiKeyUpdatedEventNotification
3954
+ extends V2.Core.EventNotificationBase {
3955
+ type: 'v2.iam.api_key.updated';
3956
+ fetchEvent(): Promise<V2IamApiKeyUpdatedEvent>;
3957
+ }
3958
+
3862
3959
  /**
3863
3960
  * Occurs when an Adjustment is created.
3864
3961
  */
@@ -23,6 +23,11 @@ declare module 'stripe' {
23
23
 
24
24
  namespace Reason {
25
25
  interface Request {
26
+ /**
27
+ * The client details that made the request.
28
+ */
29
+ client?: Request.Client;
30
+
26
31
  /**
27
32
  * ID of the API request that caused the event.
28
33
  */
@@ -33,6 +38,62 @@ declare module 'stripe' {
33
38
  */
34
39
  idempotency_key: string;
35
40
  }
41
+
42
+ namespace Request {
43
+ interface Client {
44
+ /**
45
+ * The type of the client.
46
+ */
47
+ type: Client.Type;
48
+
49
+ /**
50
+ * API key that triggered the event.
51
+ */
52
+ api_key?: Client.ApiKey;
53
+
54
+ /**
55
+ * Dashboard user that triggered the event.
56
+ */
57
+ dashboard_user?: Client.DashboardUser;
58
+
59
+ /**
60
+ * Stripe action that triggered the event.
61
+ */
62
+ stripe_action?: Client.StripeAction;
63
+ }
64
+
65
+ namespace Client {
66
+ interface ApiKey {
67
+ /**
68
+ * The ID of the API key.
69
+ */
70
+ id: string;
71
+ }
72
+
73
+ interface DashboardUser {
74
+ /**
75
+ * The email of the dashboard user.
76
+ */
77
+ email: string;
78
+
79
+ /**
80
+ * The IP address of the user.
81
+ */
82
+ ip_address: string;
83
+
84
+ /**
85
+ * The machine identifier of the user.
86
+ */
87
+ machine_identifier: string;
88
+ }
89
+
90
+ type StripeAction = {
91
+ [key: string]: unknown;
92
+ };
93
+
94
+ type Type = 'api_key' | 'dashboard_user' | 'stripe_action';
95
+ }
96
+ }
36
97
  }
37
98
  }
38
99
 
@@ -6,7 +6,12 @@ declare module 'stripe' {
6
6
  namespace Stripe {
7
7
  namespace V2 {
8
8
  namespace Core {
9
- interface EventRetrieveParams {}
9
+ interface EventRetrieveParams {
10
+ /**
11
+ * Additional fields to include in the response.
12
+ */
13
+ include?: Array<'reason.request.client'>;
14
+ }
10
15
  }
11
16
 
12
17
  namespace Core {
@@ -16,6 +21,11 @@ declare module 'stripe' {
16
21
  */
17
22
  created?: Stripe.RangeQueryParam;
18
23
 
24
+ /**
25
+ * Additional fields to include in the response.
26
+ */
27
+ include?: Array<'reason.request.client'>;
28
+
19
29
  /**
20
30
  * The page size.
21
31
  */
@@ -79,6 +79,11 @@ declare module 'stripe' {
79
79
  */
80
80
  status_transitions?: ReceivedCredit.StatusTransitions;
81
81
 
82
+ /**
83
+ * This object stores details about the stripe balance pay refund that resulted in the ReceivedCredit. Present if `type` field value is `stripe_balance_payment`.
84
+ */
85
+ stripe_balance_payment?: ReceivedCredit.StripeBalancePayment;
86
+
82
87
  /**
83
88
  * Open Enum. The type of flow that caused the ReceivedCredit.
84
89
  */
@@ -323,7 +328,18 @@ declare module 'stripe' {
323
328
  succeeded_at?: string;
324
329
  }
325
330
 
326
- type Type = 'balance_transfer' | 'bank_transfer' | 'external_credit';
331
+ interface StripeBalancePayment {
332
+ /**
333
+ * Statement descriptor for the Stripe Balance Payment.
334
+ */
335
+ statement_descriptor?: string;
336
+ }
337
+
338
+ type Type =
339
+ | 'balance_transfer'
340
+ | 'bank_transfer'
341
+ | 'external_credit'
342
+ | 'stripe_balance_payment';
327
343
  }
328
344
  }
329
345
  }
@@ -23,6 +23,11 @@ declare module 'stripe' {
23
23
  */
24
24
  amount: ReceivedDebit.Amount;
25
25
 
26
+ /**
27
+ * This object stores details about the balance transfer object that resulted in the ReceivedDebit.
28
+ */
29
+ balance_transfer?: ReceivedDebit.BalanceTransfer;
30
+
26
31
  /**
27
32
  * This object stores details about the originating banking transaction that resulted in the ReceivedDebit. Present if `type` field value is `bank_transfer`.
28
33
  */
@@ -75,7 +80,12 @@ declare module 'stripe' {
75
80
  status_transitions?: ReceivedDebit.StatusTransitions;
76
81
 
77
82
  /**
78
- * Open Enum. The type of the ReceivedDebit.
83
+ * This object stores details about the Stripe Balance Payment that resulted in the ReceivedDebit.
84
+ */
85
+ stripe_balance_payment?: ReceivedDebit.StripeBalancePayment;
86
+
87
+ /**
88
+ * Open enum, the type of the received debit.
79
89
  */
80
90
  type: ReceivedDebit.Type;
81
91
  }
@@ -93,6 +103,18 @@ declare module 'stripe' {
93
103
  currency?: string;
94
104
  }
95
105
 
106
+ interface BalanceTransfer {
107
+ /**
108
+ * Open Enum. The type of balance transfer that originated the ReceivedDebit.
109
+ */
110
+ type: 'topup';
111
+
112
+ /**
113
+ * The ID of the topup object that originated the ReceivedDebit.
114
+ */
115
+ topup?: string;
116
+ }
117
+
96
118
  interface BankTransfer {
97
119
  /**
98
120
  * The Financial Address that was debited.
@@ -202,7 +224,23 @@ declare module 'stripe' {
202
224
  succeeded_at?: string;
203
225
  }
204
226
 
205
- type Type = 'bank_transfer' | 'external_debit';
227
+ interface StripeBalancePayment {
228
+ /**
229
+ * ID of the debit agreement associated with this payment.
230
+ */
231
+ debit_agreement?: string;
232
+
233
+ /**
234
+ * Statement descriptor for the Stripe Balance Payment.
235
+ */
236
+ statement_descriptor?: string;
237
+ }
238
+
239
+ type Type =
240
+ | 'balance_transfer'
241
+ | 'bank_transfer'
242
+ | 'external_debit'
243
+ | 'stripe_balance_payment';
206
244
  }
207
245
  }
208
246
  }
package/types/index.d.ts CHANGED
@@ -94,6 +94,7 @@
94
94
  ///<reference path='./PlansResource.d.ts' />
95
95
  ///<reference path='./PricesResource.d.ts' />
96
96
  ///<reference path='./Privacy/RedactionJobsResource.d.ts' />
97
+ ///<reference path='./ProductCatalog/TrialOffersResource.d.ts' />
97
98
  ///<reference path='./ProductsResource.d.ts' />
98
99
  ///<reference path='./PromotionCodesResource.d.ts' />
99
100
  ///<reference path='./QuotesResource.d.ts' />
@@ -329,6 +330,7 @@
329
330
  ///<reference path='./Prices.d.ts' />
330
331
  ///<reference path='./Privacy/RedactionJobValidationErrors.d.ts' />
331
332
  ///<reference path='./Privacy/RedactionJobs.d.ts' />
333
+ ///<reference path='./ProductCatalog/TrialOffers.d.ts' />
332
334
  ///<reference path='./ProductFeatures.d.ts' />
333
335
  ///<reference path='./Products.d.ts' />
334
336
  ///<reference path='./PromotionCodes.d.ts' />
@@ -601,6 +603,9 @@ declare module 'stripe' {
601
603
  privacy: {
602
604
  redactionJobs: Stripe.Privacy.RedactionJobsResource;
603
605
  };
606
+ productCatalog: {
607
+ trialOffers: Stripe.ProductCatalog.TrialOffersResource;
608
+ };
604
609
  radar: {
605
610
  accountEvaluations: Stripe.Radar.AccountEvaluationsResource;
606
611
  earlyFraudWarnings: Stripe.Radar.EarlyFraudWarningsResource;