stripe 17.5.0-beta.1 → 17.5.0-beta.2

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 (38) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/VERSION +1 -1
  3. package/cjs/stripe.core.js +1 -1
  4. package/esm/stripe.core.js +1 -1
  5. package/package.json +1 -1
  6. package/types/Accounts.d.ts +7 -0
  7. package/types/AccountsResource.d.ts +26 -2
  8. package/types/BalanceTransactions.d.ts +3 -1
  9. package/types/BalanceTransactionsResource.d.ts +1 -1
  10. package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
  11. package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
  12. package/types/Billing/CreditGrants.d.ts +2 -2
  13. package/types/Billing/CreditGrantsResource.d.ts +8 -8
  14. package/types/Billing/MeterEventAdjustmentsResource.d.ts +1 -1
  15. package/types/Billing/MeterEvents.d.ts +1 -2
  16. package/types/Billing/MeterEventsResource.d.ts +2 -2
  17. package/types/Billing/Meters.d.ts +1 -1
  18. package/types/Billing/MetersResource.d.ts +8 -8
  19. package/types/Checkout/Sessions.d.ts +13 -3
  20. package/types/Checkout/SessionsResource.d.ts +15 -5
  21. package/types/CustomersResource.d.ts +1 -1
  22. package/types/EventTypes.d.ts +2 -2
  23. package/types/Invoices.d.ts +9 -0
  24. package/types/InvoicesResource.d.ts +5 -5
  25. package/types/Issuing/Authorizations.d.ts +1 -1
  26. package/types/Orders.d.ts +6 -1
  27. package/types/OrdersResource.d.ts +12 -2
  28. package/types/PaymentIntents.d.ts +12 -2
  29. package/types/PaymentIntentsResource.d.ts +36 -6
  30. package/types/PaymentLinksResource.d.ts +5 -0
  31. package/types/QuotePreviewInvoices.d.ts +9 -0
  32. package/types/QuotePreviewSubscriptionSchedules.d.ts +10 -0
  33. package/types/SetupIntents.d.ts +12 -2
  34. package/types/SetupIntentsResource.d.ts +36 -6
  35. package/types/SubscriptionSchedules.d.ts +10 -0
  36. package/types/Subscriptions.d.ts +5 -0
  37. package/types/SubscriptionsResource.d.ts +3 -3
  38. package/types/Treasury/FinancialAccountFeatures.d.ts +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Changelog
2
2
 
3
+ ## 17.5.0-beta.2 - 2024-12-05
4
+ * [#2232](https://github.com/stripe/stripe-node/pull/2232) Update generated code for beta
5
+ * Add support for `automatic_indirect_tax` on `Account.capabilities`, `AccountCreateParams.capabilities`, and `AccountUpdateParams.capabilities`
6
+ * Add support for new values `payout_minimum_balance_hold` and `payout_minimum_balance_release` on enum `BalanceTransaction.type`
7
+ * Add support for `reference_prefix` on `Checkout.Session.payment_method_options.bacs_debit.mandate_options`, `Checkout.Session.payment_method_options.sepa_debit.mandate_options`, `Checkout.SessionCreateParams.payment_method_options.bacs_debit.mandate_options`, `Checkout.SessionCreateParams.payment_method_options.sepa_debit.mandate_options`, `Order.payment.settings.payment_method_options.sepa_debit.mandate_options`, `OrderCreateParams.payment.settings.payment_method_options.sepa_debit.mandate_options`, `OrderUpdateParams.payment.settings.payment_method_options.sepa_debit.mandate_options`, `PaymentIntent.payment_method_options.bacs_debit.mandate_options`, `PaymentIntent.payment_method_options.sepa_debit.mandate_options`, `PaymentIntentConfirmParams.payment_method_options.bacs_debit.mandate_options`, `PaymentIntentConfirmParams.payment_method_options.sepa_debit.mandate_options`, `PaymentIntentCreateParams.payment_method_options.bacs_debit.mandate_options`, `PaymentIntentCreateParams.payment_method_options.sepa_debit.mandate_options`, `PaymentIntentUpdateParams.payment_method_options.bacs_debit.mandate_options`, `PaymentIntentUpdateParams.payment_method_options.sepa_debit.mandate_options`, `SetupIntent.payment_method_options.bacs_debit.mandate_options`, `SetupIntent.payment_method_options.sepa_debit.mandate_options`, `SetupIntentConfirmParams.payment_method_options.bacs_debit.mandate_options`, `SetupIntentConfirmParams.payment_method_options.sepa_debit.mandate_options`, `SetupIntentCreateParams.payment_method_options.bacs_debit.mandate_options`, `SetupIntentCreateParams.payment_method_options.sepa_debit.mandate_options`, `SetupIntentUpdateParams.payment_method_options.bacs_debit.mandate_options`, and `SetupIntentUpdateParams.payment_method_options.sepa_debit.mandate_options`
8
+ * Add support for `disabled_reason` on `Invoice.automatic_tax`, `Subscription.automatic_tax`, `SubscriptionSchedule.default_settings.automatic_tax`, and `SubscriptionSchedule.phases[].automatic_tax`
9
+ * Change `Issuing.Authorization.verified_by_fraud_challenge` to be required
10
+ * Add support for `trial_period_days` on `PaymentLinkUpdateParams.subscription_data`
11
+
3
12
  ## 17.5.0-beta.1 - 2024-11-21
4
13
  * [#2229](https://github.com/stripe/stripe-node/pull/2229) Update generated code for beta
5
14
  * Add support for `network_advice_code` and `network_decline_code` on `Charge.outcome`, `Invoice.last_finalization_error`, `PaymentIntent.last_payment_error`, `SetupAttempt.setup_error`, `SetupIntent.last_setup_error`, and `StripeError`
package/VERSION CHANGED
@@ -1 +1 @@
1
- 17.5.0-beta.1
1
+ 17.5.0-beta.2
@@ -36,7 +36,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
36
36
  ];
37
37
  const defaultRequestSenderFactory = (stripe) => new RequestSender_js_1.RequestSender(stripe, StripeResource_js_1.StripeResource.MAX_BUFFERED_REQUEST_METRICS);
38
38
  function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
39
- Stripe.PACKAGE_VERSION = '17.5.0-beta.1';
39
+ Stripe.PACKAGE_VERSION = '17.5.0-beta.2';
40
40
  Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, (0, utils_js_1.determineProcessUserAgentProperties)());
41
41
  Stripe.StripeResource = StripeResource_js_1.StripeResource;
42
42
  Stripe.resources = resources;
@@ -33,7 +33,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
33
33
  ];
34
34
  const defaultRequestSenderFactory = (stripe) => new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
35
35
  export function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
36
- Stripe.PACKAGE_VERSION = '17.5.0-beta.1';
36
+ Stripe.PACKAGE_VERSION = '17.5.0-beta.2';
37
37
  Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, determineProcessUserAgentProperties());
38
38
  Stripe.StripeResource = StripeResource;
39
39
  Stripe.resources = resources;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stripe",
3
- "version": "17.5.0-beta.1",
3
+ "version": "17.5.0-beta.2",
4
4
  "description": "Stripe API wrapper",
5
5
  "keywords": [
6
6
  "stripe",
@@ -249,6 +249,11 @@ declare module 'stripe' {
249
249
  */
250
250
  au_becs_debit_payments?: Capabilities.AuBecsDebitPayments;
251
251
 
252
+ /**
253
+ * The status of the automatic_indirect_tax capability of the account.
254
+ */
255
+ automatic_indirect_tax?: Capabilities.AutomaticIndirectTax;
256
+
252
257
  /**
253
258
  * The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.
254
259
  */
@@ -558,6 +563,8 @@ declare module 'stripe' {
558
563
 
559
564
  type AuBecsDebitPayments = 'active' | 'inactive' | 'pending';
560
565
 
566
+ type AutomaticIndirectTax = 'active' | 'inactive' | 'pending';
567
+
561
568
  type BacsDebitPayments = 'active' | 'inactive' | 'pending';
562
569
 
563
570
  type BancontactPayments = 'active' | 'inactive' | 'pending';
@@ -73,7 +73,7 @@ declare module 'stripe' {
73
73
  external_account?: string | AccountCreateParams.ExternalAccount;
74
74
 
75
75
  /**
76
- * A hash of account group type to tokens. These are account groups this account should be added to
76
+ * A hash of account group type to tokens. These are account groups this account should be added to.
77
77
  */
78
78
  groups?: AccountCreateParams.Groups;
79
79
 
@@ -234,6 +234,11 @@ declare module 'stripe' {
234
234
  */
235
235
  au_becs_debit_payments?: Capabilities.AuBecsDebitPayments;
236
236
 
237
+ /**
238
+ * The automatic_indirect_tax capability.
239
+ */
240
+ automatic_indirect_tax?: Capabilities.AutomaticIndirectTax;
241
+
237
242
  /**
238
243
  * The bacs_debit_payments capability.
239
244
  */
@@ -573,6 +578,13 @@ declare module 'stripe' {
573
578
  requested?: boolean;
574
579
  }
575
580
 
581
+ interface AutomaticIndirectTax {
582
+ /**
583
+ * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
584
+ */
585
+ requested?: boolean;
586
+ }
587
+
576
588
  interface BacsDebitPayments {
577
589
  /**
578
590
  * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
@@ -1986,7 +1998,7 @@ declare module 'stripe' {
1986
1998
  >;
1987
1999
 
1988
2000
  /**
1989
- * A hash of account group type to tokens. These are account groups this account should be added to
2001
+ * A hash of account group type to tokens. These are account groups this account should be added to.
1990
2002
  */
1991
2003
  groups?: AccountUpdateParams.Groups;
1992
2004
 
@@ -2180,6 +2192,11 @@ declare module 'stripe' {
2180
2192
  */
2181
2193
  au_becs_debit_payments?: Capabilities.AuBecsDebitPayments;
2182
2194
 
2195
+ /**
2196
+ * The automatic_indirect_tax capability.
2197
+ */
2198
+ automatic_indirect_tax?: Capabilities.AutomaticIndirectTax;
2199
+
2183
2200
  /**
2184
2201
  * The bacs_debit_payments capability.
2185
2202
  */
@@ -2519,6 +2536,13 @@ declare module 'stripe' {
2519
2536
  requested?: boolean;
2520
2537
  }
2521
2538
 
2539
+ interface AutomaticIndirectTax {
2540
+ /**
2541
+ * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
2542
+ */
2543
+ requested?: boolean;
2544
+ }
2545
+
2522
2546
  interface BacsDebitPayments {
2523
2547
  /**
2524
2548
  * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
@@ -80,7 +80,7 @@ declare module 'stripe' {
80
80
  status: string;
81
81
 
82
82
  /**
83
- * Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
83
+ * Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
84
84
  */
85
85
  type: BalanceTransaction.Type;
86
86
  }
@@ -141,6 +141,8 @@ declare module 'stripe' {
141
141
  | 'payout'
142
142
  | 'payout_cancel'
143
143
  | 'payout_failure'
144
+ | 'payout_minimum_balance_hold'
145
+ | 'payout_minimum_balance_release'
144
146
  | 'refund'
145
147
  | 'refund_failure'
146
148
  | 'reserve_transaction'
@@ -36,7 +36,7 @@ declare module 'stripe' {
36
36
  source?: string;
37
37
 
38
38
  /**
39
- * Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
39
+ * Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
40
40
  */
41
41
  type?: string;
42
42
  }
@@ -41,7 +41,7 @@ declare module 'stripe' {
41
41
  namespace Filter {
42
42
  interface ApplicabilityScope {
43
43
  /**
44
- * The price type for which credit grants can apply. We currently only support the `metered` price type.
44
+ * The price type that credit grants can apply to. We currently only support the `metered` price type.
45
45
  */
46
46
  price_type: 'metered';
47
47
  }
@@ -52,7 +52,7 @@ declare module 'stripe' {
52
52
 
53
53
  class CreditBalanceSummaryResource {
54
54
  /**
55
- * Retrieves the credit balance summary for a customer
55
+ * Retrieves the credit balance summary for a customer.
56
56
  */
57
57
  retrieve(
58
58
  params: CreditBalanceSummaryRetrieveParams,
@@ -29,7 +29,7 @@ declare module 'stripe' {
29
29
 
30
30
  class CreditBalanceTransactionsResource {
31
31
  /**
32
- * Retrieves a credit balance transaction
32
+ * Retrieves a credit balance transaction.
33
33
  */
34
34
  retrieve(
35
35
  id: string,
@@ -42,7 +42,7 @@ declare module 'stripe' {
42
42
  ): Promise<Stripe.Response<Stripe.Billing.CreditBalanceTransaction>>;
43
43
 
44
44
  /**
45
- * Retrieve a list of credit balance transactions
45
+ * Retrieve a list of credit balance transactions.
46
46
  */
47
47
  list(
48
48
  params: CreditBalanceTransactionListParams,
@@ -39,7 +39,7 @@ declare module 'stripe' {
39
39
  customer: string | Stripe.Customer | Stripe.DeletedCustomer;
40
40
 
41
41
  /**
42
- * The time when the billing credits become effectivewhen they're eligible for use.
42
+ * The time when the billing credits become effective-when they're eligible for use.
43
43
  */
44
44
  effective_at: number | null;
45
45
 
@@ -113,7 +113,7 @@ declare module 'stripe' {
113
113
  namespace ApplicabilityConfig {
114
114
  interface Scope {
115
115
  /**
116
- * The price type for which credit grants can apply. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
116
+ * The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
117
117
  */
118
118
  price_type: 'metered';
119
119
  }
@@ -25,7 +25,7 @@ declare module 'stripe' {
25
25
  customer: string;
26
26
 
27
27
  /**
28
- * The time when the billing credits become effectivewhen they're eligible for use. Defaults to the current timestamp if not specified.
28
+ * The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
29
29
  */
30
30
  effective_at?: number;
31
31
 
@@ -35,12 +35,12 @@ declare module 'stripe' {
35
35
  expand?: Array<string>;
36
36
 
37
37
  /**
38
- * The time when the billing credits will expire. If not specified, the billing credits don't expire.
38
+ * The time when the billing credits expire. If not specified, the billing credits don't expire.
39
39
  */
40
40
  expires_at?: number;
41
41
 
42
42
  /**
43
- * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.
43
+ * Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
44
44
  */
45
45
  metadata?: Stripe.MetadataParam;
46
46
 
@@ -87,7 +87,7 @@ declare module 'stripe' {
87
87
  namespace ApplicabilityConfig {
88
88
  interface Scope {
89
89
  /**
90
- * The price type for which credit grants can apply. We currently only support the `metered` price type.
90
+ * The price type that credit grants can apply to. We currently only support the `metered` price type.
91
91
  */
92
92
  price_type: 'metered';
93
93
  }
@@ -115,7 +115,7 @@ declare module 'stripe' {
115
115
  expires_at?: Stripe.Emptyable<number>;
116
116
 
117
117
  /**
118
- * Set of key-value pairs you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.
118
+ * Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
119
119
  */
120
120
  metadata?: Stripe.MetadataParam;
121
121
  }
@@ -148,7 +148,7 @@ declare module 'stripe' {
148
148
 
149
149
  class CreditGrantsResource {
150
150
  /**
151
- * Creates a credit grant
151
+ * Creates a credit grant.
152
152
  */
153
153
  create(
154
154
  params: CreditGrantCreateParams,
@@ -156,7 +156,7 @@ declare module 'stripe' {
156
156
  ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
157
157
 
158
158
  /**
159
- * Retrieves a credit grant
159
+ * Retrieves a credit grant.
160
160
  */
161
161
  retrieve(
162
162
  id: string,
@@ -169,7 +169,7 @@ declare module 'stripe' {
169
169
  ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
170
170
 
171
171
  /**
172
- * Updates a credit grant
172
+ * Updates a credit grant.
173
173
  */
174
174
  update(
175
175
  id: string,
@@ -36,7 +36,7 @@ declare module 'stripe' {
36
36
 
37
37
  class MeterEventAdjustmentsResource {
38
38
  /**
39
- * Creates a billing meter event adjustment
39
+ * Creates a billing meter event adjustment.
40
40
  */
41
41
  create(
42
42
  params: MeterEventAdjustmentCreateParams,
@@ -4,8 +4,7 @@ declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  namespace Billing {
6
6
  /**
7
- * A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.
8
- * Meter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.
7
+ * Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event's payload and how to aggregate those events.
9
8
  */
10
9
  interface MeterEvent {
11
10
  /**
@@ -22,7 +22,7 @@ declare module 'stripe' {
22
22
  expand?: Array<string>;
23
23
 
24
24
  /**
25
- * A unique identifier for the event. If not provided, one will be generated. We strongly advise using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.
25
+ * A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.
26
26
  */
27
27
  identifier?: string;
28
28
 
@@ -34,7 +34,7 @@ declare module 'stripe' {
34
34
 
35
35
  class MeterEventsResource {
36
36
  /**
37
- * Creates a billing meter event
37
+ * Creates a billing meter event.
38
38
  */
39
39
  create(
40
40
  params: MeterEventCreateParams,
@@ -4,7 +4,7 @@ declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  namespace Billing {
6
6
  /**
7
- * A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.
7
+ * Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.
8
8
  *
9
9
  * Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)
10
10
  */
@@ -10,7 +10,7 @@ declare module 'stripe' {
10
10
  default_aggregation: MeterCreateParams.DefaultAggregation;
11
11
 
12
12
  /**
13
- * The meter's name.
13
+ * The meter's name. Not visible to the customer.
14
14
  */
15
15
  display_name: string;
16
16
 
@@ -43,7 +43,7 @@ declare module 'stripe' {
43
43
  namespace MeterCreateParams {
44
44
  interface CustomerMapping {
45
45
  /**
46
- * The key in the usage event payload to use for mapping the event to a customer.
46
+ * The key in the meter event payload to use for mapping the event to a customer.
47
47
  */
48
48
  event_payload_key: string;
49
49
 
@@ -83,7 +83,7 @@ declare module 'stripe' {
83
83
 
84
84
  interface MeterUpdateParams {
85
85
  /**
86
- * The meter's name.
86
+ * The meter's name. Not visible to the customer.
87
87
  */
88
88
  display_name?: string;
89
89
 
@@ -156,7 +156,7 @@ declare module 'stripe' {
156
156
 
157
157
  class MetersResource {
158
158
  /**
159
- * Creates a billing meter
159
+ * Creates a billing meter.
160
160
  */
161
161
  create(
162
162
  params: MeterCreateParams,
@@ -164,7 +164,7 @@ declare module 'stripe' {
164
164
  ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
165
165
 
166
166
  /**
167
- * Retrieves a billing meter given an ID
167
+ * Retrieves a billing meter given an ID.
168
168
  */
169
169
  retrieve(
170
170
  id: string,
@@ -177,7 +177,7 @@ declare module 'stripe' {
177
177
  ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
178
178
 
179
179
  /**
180
- * Updates a billing meter
180
+ * Updates a billing meter.
181
181
  */
182
182
  update(
183
183
  id: string,
@@ -195,7 +195,7 @@ declare module 'stripe' {
195
195
  list(options?: RequestOptions): ApiListPromise<Stripe.Billing.Meter>;
196
196
 
197
197
  /**
198
- * Deactivates a billing meter
198
+ * When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
199
199
  */
200
200
  deactivate(
201
201
  id: string,
@@ -217,7 +217,7 @@ declare module 'stripe' {
217
217
  ): ApiListPromise<Stripe.Billing.MeterEventSummary>;
218
218
 
219
219
  /**
220
- * Reactivates a billing meter
220
+ * When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
221
221
  */
222
222
  reactivate(
223
223
  id: string,
@@ -75,7 +75,7 @@ declare module 'stripe' {
75
75
  client_reference_id: string | null;
76
76
 
77
77
  /**
78
- * The client secret of the Session. Use this with [initCustomCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
78
+ * The client secret of the Session. Use this with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
79
79
  */
80
80
  client_secret: string | null;
81
81
 
@@ -1308,7 +1308,12 @@ declare module 'stripe' {
1308
1308
  }
1309
1309
 
1310
1310
  namespace BacsDebit {
1311
- interface MandateOptions {}
1311
+ interface MandateOptions {
1312
+ /**
1313
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
1314
+ */
1315
+ reference_prefix?: string;
1316
+ }
1312
1317
 
1313
1318
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1314
1319
  }
@@ -1920,7 +1925,12 @@ declare module 'stripe' {
1920
1925
  }
1921
1926
 
1922
1927
  namespace SepaDebit {
1923
- interface MandateOptions {}
1928
+ interface MandateOptions {
1929
+ /**
1930
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
1931
+ */
1932
+ reference_prefix?: string;
1933
+ }
1924
1934
 
1925
1935
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1926
1936
  }
@@ -1367,7 +1367,12 @@ declare module 'stripe' {
1367
1367
  }
1368
1368
 
1369
1369
  namespace BacsDebit {
1370
- interface MandateOptions {}
1370
+ interface MandateOptions {
1371
+ /**
1372
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
1373
+ */
1374
+ reference_prefix?: Stripe.Emptyable<string>;
1375
+ }
1371
1376
 
1372
1377
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1373
1378
  }
@@ -2046,7 +2051,12 @@ declare module 'stripe' {
2046
2051
  }
2047
2052
 
2048
2053
  namespace SepaDebit {
2049
- interface MandateOptions {}
2054
+ interface MandateOptions {
2055
+ /**
2056
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
2057
+ */
2058
+ reference_prefix?: Stripe.Emptyable<string>;
2059
+ }
2050
2060
 
2051
2061
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
2052
2062
  }
@@ -2845,13 +2855,13 @@ declare module 'stripe' {
2845
2855
  /**
2846
2856
  * A list of items the customer is purchasing.
2847
2857
  *
2848
- * When updating line items, the entire array of line items must be retransmitted.
2858
+ * When updating line items, you must retransmit the entire array of line items.
2849
2859
  *
2850
2860
  * To retain an existing line item, specify its `id`.
2851
2861
  *
2852
- * To update an existing line item, specify its `id` along with the new values of the fields to be updated.
2862
+ * To update an existing line item, specify its `id` along with the new values of the fields to update.
2853
2863
  *
2854
- * To add a new line item, specify a `price` and `quantity`. Recurring prices are not supported yet.
2864
+ * To add a new line item, specify a `price` and `quantity`. We don't currently support recurring prices.
2855
2865
  *
2856
2866
  * To remove an existing line item, omit the line item's ID from the retransmitted array.
2857
2867
  *
@@ -525,7 +525,7 @@ declare module 'stripe' {
525
525
  ip_address?: Stripe.Emptyable<string>;
526
526
 
527
527
  /**
528
- * A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.
528
+ * A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.
529
529
  */
530
530
  validate_location?: Tax.ValidateLocation;
531
531
  }
@@ -873,7 +873,7 @@ declare module 'stripe' {
873
873
  }
874
874
 
875
875
  /**
876
- * Occurs whenever a refund is updated, on selected payment methods.
876
+ * Occurs whenever a refund is updated on selected payment methods. For updates on all refunds, listen to `refund.updated` instead.
877
877
  */
878
878
  interface ChargeRefundUpdatedEvent extends EventBase {
879
879
  type: 'charge.refund.updated';
@@ -889,7 +889,7 @@ declare module 'stripe' {
889
889
  }
890
890
 
891
891
  /**
892
- * Occurs whenever a charge is refunded, including partial refunds.
892
+ * Occurs whenever a charge is refunded, including partial refunds. Listen to `refund.created` for information about the refund.
893
893
  */
894
894
  interface ChargeRefundedEvent extends EventBase {
895
895
  type: 'charge.refunded';
@@ -557,6 +557,11 @@ declare module 'stripe' {
557
557
  }
558
558
 
559
559
  interface AutomaticTax {
560
+ /**
561
+ * If Stripe disabled automatic tax, this enum describes why.
562
+ */
563
+ disabled_reason: AutomaticTax.DisabledReason | null;
564
+
560
565
  /**
561
566
  * Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
562
567
  */
@@ -574,6 +579,10 @@ declare module 'stripe' {
574
579
  }
575
580
 
576
581
  namespace AutomaticTax {
582
+ type DisabledReason =
583
+ | 'finalization_requires_location_inputs'
584
+ | 'finalization_system_error';
585
+
577
586
  interface Liability {
578
587
  /**
579
588
  * The connected account being referenced when `type` is `account`.
@@ -4015,7 +4015,7 @@ declare module 'stripe' {
4015
4015
  billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
4016
4016
 
4017
4017
  /**
4018
- * Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
4018
+ * Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
4019
4019
  */
4020
4020
  clear_usage?: boolean;
4021
4021
 
@@ -6238,7 +6238,7 @@ declare module 'stripe' {
6238
6238
  billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
6239
6239
 
6240
6240
  /**
6241
- * Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
6241
+ * Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
6242
6242
  */
6243
6243
  clear_usage?: boolean;
6244
6244
 
@@ -6432,7 +6432,7 @@ declare module 'stripe' {
6432
6432
  >;
6433
6433
 
6434
6434
  /**
6435
- * Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
6435
+ * Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
6436
6436
  */
6437
6437
  clear_usage?: boolean;
6438
6438
 
@@ -8718,7 +8718,7 @@ declare module 'stripe' {
8718
8718
  billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
8719
8719
 
8720
8720
  /**
8721
- * Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
8721
+ * Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
8722
8722
  */
8723
8723
  clear_usage?: boolean;
8724
8724
 
@@ -8912,7 +8912,7 @@ declare module 'stripe' {
8912
8912
  >;
8913
8913
 
8914
8914
  /**
8915
- * Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
8915
+ * Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
8916
8916
  */
8917
8917
  clear_usage?: boolean;
8918
8918
 
@@ -143,7 +143,7 @@ declare module 'stripe' {
143
143
  /**
144
144
  * Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.
145
145
  */
146
- verified_by_fraud_challenge?: boolean | null;
146
+ verified_by_fraud_challenge: boolean | null;
147
147
 
148
148
  /**
149
149
  * The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.
package/types/Orders.d.ts CHANGED
@@ -735,7 +735,12 @@ declare module 'stripe' {
735
735
  }
736
736
 
737
737
  namespace SepaDebit {
738
- interface MandateOptions {}
738
+ interface MandateOptions {
739
+ /**
740
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
741
+ */
742
+ reference_prefix?: string;
743
+ }
739
744
 
740
745
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
741
746
  }
@@ -1007,7 +1007,12 @@ declare module 'stripe' {
1007
1007
  }
1008
1008
 
1009
1009
  namespace SepaDebit {
1010
- interface MandateOptions {}
1010
+ interface MandateOptions {
1011
+ /**
1012
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
1013
+ */
1014
+ reference_prefix?: Stripe.Emptyable<string>;
1015
+ }
1011
1016
 
1012
1017
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1013
1018
  }
@@ -2402,7 +2407,12 @@ declare module 'stripe' {
2402
2407
  }
2403
2408
 
2404
2409
  namespace SepaDebit {
2405
- interface MandateOptions {}
2410
+ interface MandateOptions {
2411
+ /**
2412
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
2413
+ */
2414
+ reference_prefix?: Stripe.Emptyable<string>;
2415
+ }
2406
2416
 
2407
2417
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
2408
2418
  }
@@ -1940,7 +1940,12 @@ declare module 'stripe' {
1940
1940
  }
1941
1941
 
1942
1942
  namespace BacsDebit {
1943
- interface MandateOptions {}
1943
+ interface MandateOptions {
1944
+ /**
1945
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
1946
+ */
1947
+ reference_prefix?: string;
1948
+ }
1944
1949
 
1945
1950
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1946
1951
  }
@@ -3008,7 +3013,12 @@ declare module 'stripe' {
3008
3013
  }
3009
3014
 
3010
3015
  namespace SepaDebit {
3011
- interface MandateOptions {}
3016
+ interface MandateOptions {
3017
+ /**
3018
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
3019
+ */
3020
+ reference_prefix?: string;
3021
+ }
3012
3022
 
3013
3023
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
3014
3024
  }
@@ -2186,7 +2186,12 @@ declare module 'stripe' {
2186
2186
  }
2187
2187
 
2188
2188
  namespace BacsDebit {
2189
- interface MandateOptions {}
2189
+ interface MandateOptions {
2190
+ /**
2191
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
2192
+ */
2193
+ reference_prefix?: Stripe.Emptyable<string>;
2194
+ }
2190
2195
 
2191
2196
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
2192
2197
  }
@@ -3522,7 +3527,12 @@ declare module 'stripe' {
3522
3527
  }
3523
3528
 
3524
3529
  namespace SepaDebit {
3525
- interface MandateOptions {}
3530
+ interface MandateOptions {
3531
+ /**
3532
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
3533
+ */
3534
+ reference_prefix?: Stripe.Emptyable<string>;
3535
+ }
3526
3536
 
3527
3537
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
3528
3538
  }
@@ -5949,7 +5959,12 @@ declare module 'stripe' {
5949
5959
  }
5950
5960
 
5951
5961
  namespace BacsDebit {
5952
- interface MandateOptions {}
5962
+ interface MandateOptions {
5963
+ /**
5964
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
5965
+ */
5966
+ reference_prefix?: Stripe.Emptyable<string>;
5967
+ }
5953
5968
 
5954
5969
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
5955
5970
  }
@@ -7285,7 +7300,12 @@ declare module 'stripe' {
7285
7300
  }
7286
7301
 
7287
7302
  namespace SepaDebit {
7288
- interface MandateOptions {}
7303
+ interface MandateOptions {
7304
+ /**
7305
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
7306
+ */
7307
+ reference_prefix?: Stripe.Emptyable<string>;
7308
+ }
7289
7309
 
7290
7310
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
7291
7311
  }
@@ -10467,7 +10487,12 @@ declare module 'stripe' {
10467
10487
  }
10468
10488
 
10469
10489
  namespace BacsDebit {
10470
- interface MandateOptions {}
10490
+ interface MandateOptions {
10491
+ /**
10492
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
10493
+ */
10494
+ reference_prefix?: Stripe.Emptyable<string>;
10495
+ }
10471
10496
 
10472
10497
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
10473
10498
  }
@@ -11803,7 +11828,12 @@ declare module 'stripe' {
11803
11828
  }
11804
11829
 
11805
11830
  namespace SepaDebit {
11806
- interface MandateOptions {}
11831
+ interface MandateOptions {
11832
+ /**
11833
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
11834
+ */
11835
+ reference_prefix?: Stripe.Emptyable<string>;
11836
+ }
11807
11837
 
11808
11838
  type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
11809
11839
  }
@@ -1857,6 +1857,11 @@ declare module 'stripe' {
1857
1857
  */
1858
1858
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
1859
1859
 
1860
+ /**
1861
+ * Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
1862
+ */
1863
+ trial_period_days?: Stripe.Emptyable<number>;
1864
+
1860
1865
  /**
1861
1866
  * Settings related to subscription trials.
1862
1867
  */
@@ -531,6 +531,11 @@ declare module 'stripe' {
531
531
  }
532
532
 
533
533
  interface AutomaticTax {
534
+ /**
535
+ * If Stripe disabled automatic tax, this enum describes why.
536
+ */
537
+ disabled_reason: AutomaticTax.DisabledReason | null;
538
+
534
539
  /**
535
540
  * Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
536
541
  */
@@ -548,6 +553,10 @@ declare module 'stripe' {
548
553
  }
549
554
 
550
555
  namespace AutomaticTax {
556
+ type DisabledReason =
557
+ | 'finalization_requires_location_inputs'
558
+ | 'finalization_system_error';
559
+
551
560
  interface Liability {
552
561
  /**
553
562
  * The connected account being referenced when `type` is `account`.
@@ -199,6 +199,11 @@ declare module 'stripe' {
199
199
 
200
200
  namespace DefaultSettings {
201
201
  interface AutomaticTax {
202
+ /**
203
+ * If Stripe disabled automatic tax, this enum describes why.
204
+ */
205
+ disabled_reason: 'requires_location_inputs' | null;
206
+
202
207
  /**
203
208
  * Whether Stripe automatically computes tax on invoices created during this phase.
204
209
  */
@@ -505,6 +510,11 @@ declare module 'stripe' {
505
510
  }
506
511
 
507
512
  interface AutomaticTax {
513
+ /**
514
+ * If Stripe disabled automatic tax, this enum describes why.
515
+ */
516
+ disabled_reason: 'requires_location_inputs' | null;
517
+
508
518
  /**
509
519
  * Whether Stripe automatically computes tax on invoices created during this phase.
510
520
  */
@@ -669,7 +669,12 @@ declare module 'stripe' {
669
669
  }
670
670
 
671
671
  namespace BacsDebit {
672
- interface MandateOptions {}
672
+ interface MandateOptions {
673
+ /**
674
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
675
+ */
676
+ reference_prefix?: string;
677
+ }
673
678
  }
674
679
 
675
680
  interface Card {
@@ -868,7 +873,12 @@ declare module 'stripe' {
868
873
  }
869
874
 
870
875
  namespace SepaDebit {
871
- interface MandateOptions {}
876
+ interface MandateOptions {
877
+ /**
878
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
879
+ */
880
+ reference_prefix?: string;
881
+ }
872
882
  }
873
883
 
874
884
  interface UsBankAccount {
@@ -1068,7 +1068,12 @@ declare module 'stripe' {
1068
1068
  }
1069
1069
 
1070
1070
  namespace BacsDebit {
1071
- interface MandateOptions {}
1071
+ interface MandateOptions {
1072
+ /**
1073
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
1074
+ */
1075
+ reference_prefix?: Stripe.Emptyable<string>;
1076
+ }
1072
1077
  }
1073
1078
 
1074
1079
  interface Card {
@@ -1372,7 +1377,12 @@ declare module 'stripe' {
1372
1377
  }
1373
1378
 
1374
1379
  namespace SepaDebit {
1375
- interface MandateOptions {}
1380
+ interface MandateOptions {
1381
+ /**
1382
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
1383
+ */
1384
+ reference_prefix?: Stripe.Emptyable<string>;
1385
+ }
1376
1386
  }
1377
1387
 
1378
1388
  interface UsBankAccount {
@@ -2467,7 +2477,12 @@ declare module 'stripe' {
2467
2477
  }
2468
2478
 
2469
2479
  namespace BacsDebit {
2470
- interface MandateOptions {}
2480
+ interface MandateOptions {
2481
+ /**
2482
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
2483
+ */
2484
+ reference_prefix?: Stripe.Emptyable<string>;
2485
+ }
2471
2486
  }
2472
2487
 
2473
2488
  interface Card {
@@ -2771,7 +2786,12 @@ declare module 'stripe' {
2771
2786
  }
2772
2787
 
2773
2788
  namespace SepaDebit {
2774
- interface MandateOptions {}
2789
+ interface MandateOptions {
2790
+ /**
2791
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
2792
+ */
2793
+ reference_prefix?: Stripe.Emptyable<string>;
2794
+ }
2775
2795
  }
2776
2796
 
2777
2797
  interface UsBankAccount {
@@ -3915,7 +3935,12 @@ declare module 'stripe' {
3915
3935
  }
3916
3936
 
3917
3937
  namespace BacsDebit {
3918
- interface MandateOptions {}
3938
+ interface MandateOptions {
3939
+ /**
3940
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
3941
+ */
3942
+ reference_prefix?: Stripe.Emptyable<string>;
3943
+ }
3919
3944
  }
3920
3945
 
3921
3946
  interface Card {
@@ -4219,7 +4244,12 @@ declare module 'stripe' {
4219
4244
  }
4220
4245
 
4221
4246
  namespace SepaDebit {
4222
- interface MandateOptions {}
4247
+ interface MandateOptions {
4248
+ /**
4249
+ * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
4250
+ */
4251
+ reference_prefix?: Stripe.Emptyable<string>;
4252
+ }
4223
4253
  }
4224
4254
 
4225
4255
  interface UsBankAccount {
@@ -178,6 +178,11 @@ declare module 'stripe' {
178
178
 
179
179
  namespace DefaultSettings {
180
180
  interface AutomaticTax {
181
+ /**
182
+ * If Stripe disabled automatic tax, this enum describes why.
183
+ */
184
+ disabled_reason: 'requires_location_inputs' | null;
185
+
181
186
  /**
182
187
  * Whether Stripe automatically computes tax on invoices created during this phase.
183
188
  */
@@ -484,6 +489,11 @@ declare module 'stripe' {
484
489
  }
485
490
 
486
491
  interface AutomaticTax {
492
+ /**
493
+ * If Stripe disabled automatic tax, this enum describes why.
494
+ */
495
+ disabled_reason: 'requires_location_inputs' | null;
496
+
487
497
  /**
488
498
  * Whether Stripe automatically computes tax on invoices created during this phase.
489
499
  */
@@ -259,6 +259,11 @@ declare module 'stripe' {
259
259
 
260
260
  namespace Subscription {
261
261
  interface AutomaticTax {
262
+ /**
263
+ * If Stripe disabled automatic tax, this enum describes why.
264
+ */
265
+ disabled_reason: 'requires_location_inputs' | null;
266
+
262
267
  /**
263
268
  * Whether Stripe automatically computes tax on this subscription.
264
269
  */
@@ -680,7 +680,7 @@ declare module 'stripe' {
680
680
  payment_method_options?: PaymentSettings.PaymentMethodOptions;
681
681
 
682
682
  /**
683
- * The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
683
+ * The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
684
684
  */
685
685
  payment_method_types?: Stripe.Emptyable<
686
686
  Array<PaymentSettings.PaymentMethodType>
@@ -1532,7 +1532,7 @@ declare module 'stripe' {
1532
1532
  billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
1533
1533
 
1534
1534
  /**
1535
- * Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
1535
+ * Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
1536
1536
  */
1537
1537
  clear_usage?: boolean;
1538
1538
 
@@ -1733,7 +1733,7 @@ declare module 'stripe' {
1733
1733
  payment_method_options?: PaymentSettings.PaymentMethodOptions;
1734
1734
 
1735
1735
  /**
1736
- * The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
1736
+ * The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
1737
1737
  */
1738
1738
  payment_method_types?: Stripe.Emptyable<
1739
1739
  Array<PaymentSettings.PaymentMethodType>
@@ -242,7 +242,7 @@ declare module 'stripe' {
242
242
 
243
243
  interface InboundTransfers {
244
244
  /**
245
- * Toggle settings for enabling/disabling an ACH specific feature
245
+ * Toggle settings for enabling/disabling an inbound ACH specific feature
246
246
  */
247
247
  ach?: InboundTransfers.Ach;
248
248
  }
@@ -367,7 +367,7 @@ declare module 'stripe' {
367
367
 
368
368
  interface OutboundPayments {
369
369
  /**
370
- * Toggle settings for enabling/disabling an ACH specific feature
370
+ * Toggle settings for enabling/disabling an outbound ACH specific feature
371
371
  */
372
372
  ach?: OutboundPayments.Ach;
373
373
 
@@ -497,7 +497,7 @@ declare module 'stripe' {
497
497
 
498
498
  interface OutboundTransfers {
499
499
  /**
500
- * Toggle settings for enabling/disabling an ACH specific feature
500
+ * Toggle settings for enabling/disabling an outbound ACH specific feature
501
501
  */
502
502
  ach?: OutboundTransfers.Ach;
503
503