stripe 15.3.0 → 15.4.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 (96) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +21 -1
  4. data/OPENAPI_VERSION +1 -1
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_version.rb +1 -1
  7. data/lib/stripe/resources/account.rb +5 -5
  8. data/lib/stripe/resources/account_link.rb +3 -1
  9. data/lib/stripe/resources/account_session.rb +51 -0
  10. data/lib/stripe/resources/billing/credit_grant.rb +1 -1
  11. data/lib/stripe/resources/billing_portal/configuration.rb +46 -2
  12. data/lib/stripe/resources/charge.rb +7 -5
  13. data/lib/stripe/resources/checkout/session.rb +32 -4
  14. data/lib/stripe/resources/confirmation_token.rb +3 -3
  15. data/lib/stripe/resources/customer.rb +1 -1
  16. data/lib/stripe/resources/dispute.rb +1 -1
  17. data/lib/stripe/resources/event.rb +14 -26
  18. data/lib/stripe/resources/invoice.rb +24 -8
  19. data/lib/stripe/resources/invoice_item.rb +1 -1
  20. data/lib/stripe/resources/payment_intent.rb +14 -4
  21. data/lib/stripe/resources/payment_link.rb +83 -5
  22. data/lib/stripe/resources/payment_method.rb +4 -4
  23. data/lib/stripe/resources/quote.rb +1 -1
  24. data/lib/stripe/resources/radar/value_list.rb +2 -2
  25. data/lib/stripe/resources/refund.rb +1 -1
  26. data/lib/stripe/resources/review.rb +2 -2
  27. data/lib/stripe/resources/setup_attempt.rb +1 -1
  28. data/lib/stripe/resources/subscription.rb +2 -2
  29. data/lib/stripe/resources/subscription_item.rb +2 -2
  30. data/lib/stripe/resources/subscription_schedule.rb +35 -3
  31. data/lib/stripe/resources/tax/registration.rb +408 -30
  32. data/lib/stripe/resources/terminal/configuration.rb +196 -0
  33. data/lib/stripe/services/account_link_service.rb +3 -1
  34. data/lib/stripe/services/account_service.rb +3 -3
  35. data/lib/stripe/services/account_session_service.rb +34 -0
  36. data/lib/stripe/services/billing/credit_grant_service.rb +1 -1
  37. data/lib/stripe/services/billing_portal/configuration_service.rb +36 -2
  38. data/lib/stripe/services/checkout/session_service.rb +19 -3
  39. data/lib/stripe/services/invoice_item_service.rb +1 -1
  40. data/lib/stripe/services/invoice_service.rb +24 -8
  41. data/lib/stripe/services/payment_intent_service.rb +8 -3
  42. data/lib/stripe/services/payment_link_service.rb +81 -5
  43. data/lib/stripe/services/payment_method_service.rb +1 -1
  44. data/lib/stripe/services/quote_service.rb +1 -1
  45. data/lib/stripe/services/radar/value_list_service.rb +1 -1
  46. data/lib/stripe/services/subscription_item_service.rb +2 -2
  47. data/lib/stripe/services/subscription_schedule_service.rb +35 -3
  48. data/lib/stripe/services/subscription_service.rb +2 -2
  49. data/lib/stripe/services/tax/registration_service.rb +360 -30
  50. data/lib/stripe/services/terminal/configuration_service.rb +152 -0
  51. data/lib/stripe/version.rb +1 -1
  52. data/rbi/stripe/resources/account.rbi +5 -5
  53. data/rbi/stripe/resources/account_link.rbi +3 -1
  54. data/rbi/stripe/resources/account_session.rbi +62 -1
  55. data/rbi/stripe/resources/billing/credit_grant.rbi +1 -1
  56. data/rbi/stripe/resources/billing_portal/configuration.rbi +62 -4
  57. data/rbi/stripe/resources/charge.rbi +8 -5
  58. data/rbi/stripe/resources/checkout/session.rbi +42 -7
  59. data/rbi/stripe/resources/confirmation_token.rbi +3 -3
  60. data/rbi/stripe/resources/customer.rbi +1 -1
  61. data/rbi/stripe/resources/dispute.rbi +1 -1
  62. data/rbi/stripe/resources/event.rbi +14 -26
  63. data/rbi/stripe/resources/invoice.rbi +27 -11
  64. data/rbi/stripe/resources/invoice_item.rbi +1 -1
  65. data/rbi/stripe/resources/payment_intent.rbi +14 -4
  66. data/rbi/stripe/resources/payment_link.rbi +101 -9
  67. data/rbi/stripe/resources/payment_method.rbi +4 -4
  68. data/rbi/stripe/resources/quote.rbi +1 -1
  69. data/rbi/stripe/resources/radar/value_list.rbi +2 -2
  70. data/rbi/stripe/resources/refund.rbi +1 -1
  71. data/rbi/stripe/resources/review.rbi +2 -2
  72. data/rbi/stripe/resources/setup_attempt.rbi +1 -1
  73. data/rbi/stripe/resources/subscription.rbi +6 -6
  74. data/rbi/stripe/resources/subscription_item.rbi +2 -2
  75. data/rbi/stripe/resources/subscription_schedule.rbi +33 -5
  76. data/rbi/stripe/resources/tax/registration.rbi +544 -60
  77. data/rbi/stripe/resources/terminal/configuration.rbi +210 -2
  78. data/rbi/stripe/services/account_link_service.rbi +3 -1
  79. data/rbi/stripe/services/account_service.rbi +3 -3
  80. data/rbi/stripe/services/account_session_service.rbi +40 -1
  81. data/rbi/stripe/services/billing/credit_grant_service.rbi +1 -1
  82. data/rbi/stripe/services/billing_portal/configuration_service.rbi +48 -4
  83. data/rbi/stripe/services/checkout/session_service.rbi +26 -6
  84. data/rbi/stripe/services/invoice_item_service.rbi +1 -1
  85. data/rbi/stripe/services/invoice_service.rbi +27 -11
  86. data/rbi/stripe/services/payment_intent_service.rbi +8 -3
  87. data/rbi/stripe/services/payment_link_service.rbi +98 -9
  88. data/rbi/stripe/services/payment_method_service.rbi +1 -1
  89. data/rbi/stripe/services/quote_service.rbi +1 -1
  90. data/rbi/stripe/services/radar/value_list_service.rbi +1 -1
  91. data/rbi/stripe/services/subscription_item_service.rbi +2 -2
  92. data/rbi/stripe/services/subscription_schedule_service.rbi +37 -5
  93. data/rbi/stripe/services/subscription_service.rbi +6 -6
  94. data/rbi/stripe/services/tax/registration_service.rbi +480 -60
  95. data/rbi/stripe/services/terminal/configuration_service.rbi +170 -2
  96. metadata +2 -2
@@ -334,6 +334,9 @@ module Stripe
334
334
  # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
335
335
  sig { returns(T.nilable(String)) }
336
336
  attr_reader :amount_tax_display
337
+ # ID of the invoice rendering template to be used for the generated invoice.
338
+ sig { returns(T.nilable(String)) }
339
+ attr_reader :template
337
340
  end
338
341
  # The account tax IDs associated with the invoice.
339
342
  sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
@@ -854,6 +857,15 @@ module Stripe
854
857
  # The number of seconds after which Pix payment will expire.
855
858
  sig { returns(T.nilable(Integer)) }
856
859
  attr_reader :expires_after_seconds
860
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
861
+ #
862
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
863
+ #
864
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
865
+ #
866
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
867
+ sig { returns(String) }
868
+ attr_reader :setup_future_usage
857
869
  end
858
870
  class RevolutPay < Stripe::StripeObject
859
871
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
@@ -1075,7 +1087,7 @@ module Stripe
1075
1087
  attr_reader :enabled
1076
1088
  end
1077
1089
  class PresentmentDetails < Stripe::StripeObject
1078
- # Amount intended to be collected by this payment, denominated in presentment_currency.
1090
+ # Amount intended to be collected by this payment, denominated in `presentment_currency`.
1079
1091
  sig { returns(Integer) }
1080
1092
  attr_reader :presentment_amount
1081
1093
  # Currency presented to the customer during payment.
@@ -1320,6 +1332,9 @@ module Stripe
1320
1332
  # The optional items presented to the customer at checkout.
1321
1333
  sig { returns(T.nilable(T::Array[OptionalItem])) }
1322
1334
  attr_reader :optional_items
1335
+ # Where the user is coming from. This informs the optimizations that are applied to the session.
1336
+ sig { returns(T.nilable(String)) }
1337
+ attr_reader :origin_context
1323
1338
  # The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
1324
1339
  sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
1325
1340
  attr_reader :payment_intent
@@ -1789,8 +1804,13 @@ module Stripe
1789
1804
  # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
1790
1805
  sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
1791
1806
  attr_accessor :amount_tax_display
1792
- sig { params(amount_tax_display: T.nilable(T.nilable(T.any(String, String)))).void }
1793
- def initialize(amount_tax_display: nil); end
1807
+ # ID of the invoice rendering template to use for this invoice.
1808
+ sig { returns(T.nilable(String)) }
1809
+ attr_accessor :template
1810
+ sig {
1811
+ params(amount_tax_display: T.nilable(T.nilable(T.any(String, String))), template: T.nilable(String)).void
1812
+ }
1813
+ def initialize(amount_tax_display: nil, template: nil); end
1794
1814
  end
1795
1815
  # The account tax IDs associated with the invoice.
1796
1816
  sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
@@ -2825,8 +2845,19 @@ module Stripe
2825
2845
  # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
2826
2846
  sig { returns(T.nilable(Integer)) }
2827
2847
  attr_accessor :expires_after_seconds
2828
- sig { params(expires_after_seconds: T.nilable(Integer)).void }
2829
- def initialize(expires_after_seconds: nil); end
2848
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2849
+ #
2850
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
2851
+ #
2852
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
2853
+ #
2854
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
2855
+ sig { returns(T.nilable(String)) }
2856
+ attr_accessor :setup_future_usage
2857
+ sig {
2858
+ params(expires_after_seconds: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
2859
+ }
2860
+ def initialize(expires_after_seconds: nil, setup_future_usage: nil); end
2830
2861
  end
2831
2862
  class RevolutPay < Stripe::RequestParams
2832
2863
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
@@ -3382,7 +3413,7 @@ module Stripe
3382
3413
  end
3383
3414
  class SubscriptionData < Stripe::RequestParams
3384
3415
  class BillingMode < Stripe::RequestParams
3385
- # Attribute for param field type
3416
+ # Controls the calculation and orchestration of prorations and invoices for subscriptions.
3386
3417
  sig { returns(String) }
3387
3418
  attr_accessor :type
3388
3419
  sig { params(type: String).void }
@@ -3641,6 +3672,9 @@ module Stripe
3641
3672
  returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::OptionalItem]))
3642
3673
  }
3643
3674
  attr_accessor :optional_items
3675
+ # Where the user is coming from. This informs the optimizations that are applied to the session. For example, a session originating from a mobile app may behave more like a native app, depending on the platform. This parameter is currently not allowed if `ui_mode` is `custom`.
3676
+ sig { returns(T.nilable(String)) }
3677
+ attr_accessor :origin_context
3644
3678
  # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
3645
3679
  sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData)) }
3646
3680
  attr_accessor :payment_intent_data
@@ -3737,7 +3771,7 @@ module Stripe
3737
3771
  sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions)) }
3738
3772
  attr_accessor :wallet_options
3739
3773
  sig {
3740
- params(adaptive_pricing: T.nilable(::Stripe::Checkout::Session::CreateParams::AdaptivePricing), after_expiration: T.nilable(::Stripe::Checkout::Session::CreateParams::AfterExpiration), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::Checkout::Session::CreateParams::AutomaticTax), billing_address_collection: T.nilable(String), cancel_url: T.nilable(String), client_reference_id: T.nilable(String), consent_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText), customer: T.nilable(String), customer_creation: T.nilable(String), customer_email: T.nilable(String), customer_update: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomerUpdate), discounts: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::Discount]), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), invoice_creation: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::LineItem]), locale: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), mode: T.nilable(String), optional_items: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::OptionalItem]), payment_intent_data: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), permissions: T.nilable(::Stripe::Checkout::Session::CreateParams::Permissions), phone_number_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection), redirect_on_completion: T.nilable(String), return_url: T.nilable(String), saved_payment_method_options: T.nilable(::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions), setup_intent_data: T.nilable(::Stripe::Checkout::Session::CreateParams::SetupIntentData), shipping_address_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData), success_url: T.nilable(String), tax_id_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::TaxIdCollection), ui_mode: T.nilable(String), wallet_options: T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions)).void
3774
+ params(adaptive_pricing: T.nilable(::Stripe::Checkout::Session::CreateParams::AdaptivePricing), after_expiration: T.nilable(::Stripe::Checkout::Session::CreateParams::AfterExpiration), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::Checkout::Session::CreateParams::AutomaticTax), billing_address_collection: T.nilable(String), cancel_url: T.nilable(String), client_reference_id: T.nilable(String), consent_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText), customer: T.nilable(String), customer_creation: T.nilable(String), customer_email: T.nilable(String), customer_update: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomerUpdate), discounts: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::Discount]), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), invoice_creation: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::LineItem]), locale: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), mode: T.nilable(String), optional_items: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::OptionalItem]), origin_context: T.nilable(String), payment_intent_data: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), permissions: T.nilable(::Stripe::Checkout::Session::CreateParams::Permissions), phone_number_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection), redirect_on_completion: T.nilable(String), return_url: T.nilable(String), saved_payment_method_options: T.nilable(::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions), setup_intent_data: T.nilable(::Stripe::Checkout::Session::CreateParams::SetupIntentData), shipping_address_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::Checkout::Session::CreateParams::SubscriptionData), success_url: T.nilable(String), tax_id_collection: T.nilable(::Stripe::Checkout::Session::CreateParams::TaxIdCollection), ui_mode: T.nilable(String), wallet_options: T.nilable(::Stripe::Checkout::Session::CreateParams::WalletOptions)).void
3741
3775
  }
3742
3776
  def initialize(
3743
3777
  adaptive_pricing: nil,
@@ -3764,6 +3798,7 @@ module Stripe
3764
3798
  metadata: nil,
3765
3799
  mode: nil,
3766
3800
  optional_items: nil,
3801
+ origin_context: nil,
3767
3802
  payment_intent_data: nil,
3768
3803
  payment_method_collection: nil,
3769
3804
  payment_method_configuration: nil,
@@ -212,7 +212,7 @@ module Stripe
212
212
  # The authorized amount
213
213
  sig { returns(T.nilable(Integer)) }
214
214
  attr_reader :amount_authorized
215
- # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
215
+ # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
216
216
  sig { returns(T.nilable(String)) }
217
217
  attr_reader :brand
218
218
  # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
@@ -459,7 +459,7 @@ module Stripe
459
459
  sig { returns(VisaCheckout) }
460
460
  attr_reader :visa_checkout
461
461
  end
462
- # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
462
+ # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
463
463
  sig { returns(String) }
464
464
  attr_reader :brand
465
465
  # Checks on Card address and CVC if provided.
@@ -535,7 +535,7 @@ module Stripe
535
535
  sig { returns(String) }
536
536
  attr_reader :type
537
537
  end
538
- # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
538
+ # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
539
539
  sig { returns(T.nilable(String)) }
540
540
  attr_reader :brand
541
541
  # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
@@ -118,7 +118,7 @@ module Stripe
118
118
  # The customer's address.
119
119
  sig { returns(T.nilable(Address)) }
120
120
  attr_reader :address
121
- # The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize.
121
+ # The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance).
122
122
  sig { returns(Integer) }
123
123
  attr_reader :balance
124
124
  # The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.
@@ -253,7 +253,7 @@ module Stripe
253
253
  attr_reader :dispute_type
254
254
  end
255
255
  class Card < Stripe::StripeObject
256
- # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
256
+ # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
257
257
  sig { returns(String) }
258
258
  attr_reader :brand
259
259
  # The type of dispute opened. Different case types may have varying fees and financial impact.
@@ -3,35 +3,23 @@
3
3
 
4
4
  # typed: true
5
5
  module Stripe
6
- # Events are our way of letting you know when something interesting happens in
7
- # your account. When an interesting event occurs, we create a new `Event`
8
- # object. For example, when a charge succeeds, we create a `charge.succeeded`
9
- # event, and when an invoice payment attempt fails, we create an
10
- # `invoice.payment_failed` event. Certain API requests might create multiple
11
- # events. For example, if you create a new subscription for a
12
- # customer, you receive both a `customer.subscription.created` event and a
13
- # `charge.succeeded` event.
6
+ # Snapshot events allow you to track and react to activity in your Stripe integration. When
7
+ # the state of another API resource changes, Stripe creates an `Event` object that contains
8
+ # all the relevant information associated with that action, including the affected API
9
+ # resource. For example, a successful payment triggers a `charge.succeeded` event, which
10
+ # contains the `Charge` in the event's data property. Some actions trigger multiple events.
11
+ # For example, if you create a new subscription for a customer, it triggers both a
12
+ # `customer.subscription.created` event and a `charge.succeeded` event.
14
13
  #
15
- # Events occur when the state of another API resource changes. The event's data
16
- # field embeds the resource's state at the time of the change. For
17
- # example, a `charge.succeeded` event contains a charge, and an
18
- # `invoice.payment_failed` event contains an invoice.
14
+ # Configure an event destination in your account to listen for events that represent actions
15
+ # your integration needs to respond to. Additionally, you can retrieve an individual event or
16
+ # a list of events from the API.
19
17
  #
20
- # As with other API resources, you can use endpoints to retrieve an
21
- # [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)
22
- # from the API. We also have a separate
23
- # [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the
24
- # `Event` objects directly to an endpoint on your server. You can manage
25
- # webhooks in your
26
- # [account settings](https://dashboard.stripe.com/account/webhooks). Learn how
27
- # to [listen for events](https://docs.stripe.com/webhooks)
28
- # so that your integration can automatically trigger reactions.
18
+ # [Connect](https://docs.stripe.com/connect) platforms can also receive event notifications
19
+ # that occur in their connected accounts. These events include an account attribute that
20
+ # identifies the relevant connected account.
29
21
  #
30
- # When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications
31
- # that occur in connected accounts. For these events, there's an
32
- # additional `account` attribute in the received `Event` object.
33
- #
34
- # We only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)
22
+ # You can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event)
35
23
  # for 30 days.
36
24
  class Event < APIResource
37
25
  class Data < Stripe::StripeObject
@@ -910,7 +910,7 @@ module Stripe
910
910
  }
911
911
  def initialize(enabled: nil, plan: nil); end
912
912
  end
913
- # Installment configuration for payments attempted on this invoice (Mexico Only).
913
+ # Installment configuration for payments attempted on this invoice.
914
914
  #
915
915
  # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
916
916
  sig {
@@ -1277,7 +1277,7 @@ module Stripe
1277
1277
  # Settings for automatic tax lookup for this invoice.
1278
1278
  sig { returns(T.nilable(::Stripe::Invoice::UpdateParams::AutomaticTax)) }
1279
1279
  attr_accessor :automatic_tax
1280
- # The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. To turn off automatic finalization, set `auto_advance` to false.
1280
+ # The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state. To turn off automatic finalization, set `auto_advance` to false.
1281
1281
  sig { returns(T.nilable(Integer)) }
1282
1282
  attr_accessor :automatically_finalizes_at
1283
1283
  # Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.
@@ -1602,7 +1602,7 @@ module Stripe
1602
1602
  }
1603
1603
  def initialize(enabled: nil, plan: nil); end
1604
1604
  end
1605
- # Installment configuration for payments attempted on this invoice (Mexico Only).
1605
+ # Installment configuration for payments attempted on this invoice.
1606
1606
  #
1607
1607
  # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
1608
1608
  sig {
@@ -1963,13 +1963,13 @@ module Stripe
1963
1963
  # A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
1964
1964
  sig { returns(T.nilable(Integer)) }
1965
1965
  attr_accessor :application_fee_amount
1966
- # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
1966
+ # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false.
1967
1967
  sig { returns(T.nilable(T::Boolean)) }
1968
1968
  attr_accessor :auto_advance
1969
1969
  # Settings for automatic tax lookup for this invoice.
1970
1970
  sig { returns(T.nilable(::Stripe::Invoice::CreateParams::AutomaticTax)) }
1971
1971
  attr_accessor :automatic_tax
1972
- # The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state.
1972
+ # The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state.
1973
1973
  sig { returns(T.nilable(Integer)) }
1974
1974
  attr_accessor :automatically_finalizes_at
1975
1975
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.
@@ -2982,7 +2982,7 @@ module Stripe
2982
2982
  end
2983
2983
  class ScheduleDetails < Stripe::RequestParams
2984
2984
  class BillingMode < Stripe::RequestParams
2985
- # Attribute for param field type
2985
+ # Controls the calculation and orchestration of prorations and invoices for subscriptions.
2986
2986
  sig { returns(String) }
2987
2987
  attr_accessor :type
2988
2988
  sig { params(type: String).void }
@@ -3113,6 +3113,16 @@ module Stripe
3113
3113
  }
3114
3114
  def initialize(coupon: nil, discount: nil, promotion_code: nil); end
3115
3115
  end
3116
+ class Duration < Stripe::RequestParams
3117
+ # Specifies phase duration. Either `day`, `week`, `month` or `year`.
3118
+ sig { returns(String) }
3119
+ attr_accessor :interval
3120
+ # The multiplier applied to the interval.
3121
+ sig { returns(T.nilable(Integer)) }
3122
+ attr_accessor :interval_count
3123
+ sig { params(interval: String, interval_count: T.nilable(Integer)).void }
3124
+ def initialize(interval: nil, interval_count: nil); end
3125
+ end
3116
3126
  class InvoiceSettings < Stripe::RequestParams
3117
3127
  class Issuer < Stripe::RequestParams
3118
3128
  # The connected account being referenced when `type` is `account`.
@@ -3301,6 +3311,11 @@ module Stripe
3301
3311
  returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount]))))
3302
3312
  }
3303
3313
  attr_accessor :discounts
3314
+ # The number of intervals the phase should last. If set, `end_date` must not be set.
3315
+ sig {
3316
+ returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Duration))
3317
+ }
3318
+ attr_accessor :duration
3304
3319
  # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
3305
3320
  sig { returns(T.nilable(T.any(Integer, String))) }
3306
3321
  attr_accessor :end_date
@@ -3314,7 +3329,7 @@ module Stripe
3314
3329
  returns(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item])
3315
3330
  }
3316
3331
  attr_accessor :items
3317
- # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
3332
+ # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. This parameter is deprecated and will be removed in a future version. Use `duration` instead.
3318
3333
  sig { returns(T.nilable(Integer)) }
3319
3334
  attr_accessor :iterations
3320
3335
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
@@ -3341,7 +3356,7 @@ module Stripe
3341
3356
  sig { returns(T.nilable(T.any(Integer, String))) }
3342
3357
  attr_accessor :trial_end
3343
3358
  sig {
3344
- params(add_invoice_items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds))), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount]))), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings), items: T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void
3359
+ params(add_invoice_items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds))), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount]))), duration: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Duration), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings), items: T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void
3345
3360
  }
3346
3361
  def initialize(
3347
3362
  add_invoice_items: nil,
@@ -3355,6 +3370,7 @@ module Stripe
3355
3370
  default_tax_rates: nil,
3356
3371
  description: nil,
3357
3372
  discounts: nil,
3373
+ duration: nil,
3358
3374
  end_date: nil,
3359
3375
  invoice_settings: nil,
3360
3376
  items: nil,
@@ -3396,7 +3412,7 @@ module Stripe
3396
3412
  end
3397
3413
  class SubscriptionDetails < Stripe::RequestParams
3398
3414
  class BillingMode < Stripe::RequestParams
3399
- # Attribute for param field type
3415
+ # Controls the calculation and orchestration of prorations and invoices for subscriptions.
3400
3416
  sig { returns(String) }
3401
3417
  attr_accessor :type
3402
3418
  sig { params(type: String).void }
@@ -3533,7 +3549,7 @@ module Stripe
3533
3549
  }
3534
3550
  attr_accessor :billing_mode
3535
3551
  # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
3536
- sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
3552
+ sig { returns(T.nilable(T.nilable(T.any(String, T.any(Integer, String))))) }
3537
3553
  attr_accessor :cancel_at
3538
3554
  # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
3539
3555
  sig { returns(T.nilable(T::Boolean)) }
@@ -3565,7 +3581,7 @@ module Stripe
3565
3581
  sig { returns(T.nilable(T.any(String, Integer))) }
3566
3582
  attr_accessor :trial_end
3567
3583
  sig {
3568
- params(billing_cycle_anchor: T.nilable(T.any(String, Integer)), billing_mode: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode), cancel_at: T.nilable(T.nilable(T.any(String, Integer))), cancel_at_period_end: T.nilable(T::Boolean), cancel_now: T.nilable(T::Boolean), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item]), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), resume_at: T.nilable(String), start_date: T.nilable(Integer), trial_end: T.nilable(T.any(String, Integer))).void
3584
+ params(billing_cycle_anchor: T.nilable(T.any(String, Integer)), billing_mode: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode), cancel_at: T.nilable(T.nilable(T.any(String, T.any(Integer, String)))), cancel_at_period_end: T.nilable(T::Boolean), cancel_now: T.nilable(T::Boolean), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item]), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), resume_at: T.nilable(String), start_date: T.nilable(Integer), trial_end: T.nilable(T.any(String, Integer))).void
3569
3585
  }
3570
3586
  def initialize(
3571
3587
  billing_cycle_anchor: nil,
@@ -380,7 +380,7 @@ module Stripe
380
380
  # Specifies which fields in the response should be expanded.
381
381
  sig { returns(T.nilable(T::Array[String])) }
382
382
  attr_accessor :expand
383
- # The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
383
+ # The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
384
384
  sig { returns(T.nilable(String)) }
385
385
  attr_accessor :invoice
386
386
  # 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`.
@@ -1843,7 +1843,7 @@ module Stripe
1843
1843
  attr_reader :zip
1844
1844
  end
1845
1845
  class PresentmentDetails < Stripe::StripeObject
1846
- # Amount intended to be collected by this payment, denominated in presentment_currency.
1846
+ # Amount intended to be collected by this payment, denominated in `presentment_currency`.
1847
1847
  sig { returns(Integer) }
1848
1848
  attr_reader :presentment_amount
1849
1849
  # Currency presented to the customer during payment.
@@ -3157,7 +3157,7 @@ module Stripe
3157
3157
  # A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
3158
3158
  sig { returns(T.nilable(String)) }
3159
3159
  attr_accessor :cvc_token
3160
- # Installment configuration for payments attempted on this PaymentIntent (Mexico Only).
3160
+ # Installment configuration for payments attempted on this PaymentIntent.
3161
3161
  #
3162
3162
  # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
3163
3163
  sig {
@@ -5668,7 +5668,7 @@ module Stripe
5668
5668
  # A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
5669
5669
  sig { returns(T.nilable(String)) }
5670
5670
  attr_accessor :cvc_token
5671
- # Installment configuration for payments attempted on this PaymentIntent (Mexico Only).
5671
+ # Installment configuration for payments attempted on this PaymentIntent.
5672
5672
  #
5673
5673
  # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
5674
5674
  sig {
@@ -8269,7 +8269,7 @@ module Stripe
8269
8269
  # A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
8270
8270
  sig { returns(T.nilable(String)) }
8271
8271
  attr_accessor :cvc_token
8272
- # Installment configuration for payments attempted on this PaymentIntent (Mexico Only).
8272
+ # Installment configuration for payments attempted on this PaymentIntent.
8273
8273
  #
8274
8274
  # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
8275
8275
  sig {
@@ -9814,6 +9814,7 @@ module Stripe
9814
9814
  # Confirm that your customer intends to pay with current or provided
9815
9815
  # payment method. Upon confirmation, the PaymentIntent will attempt to initiate
9816
9816
  # a payment.
9817
+ #
9817
9818
  # If the selected payment method requires additional authentication steps, the
9818
9819
  # PaymentIntent will transition to the requires_action status and
9819
9820
  # suggest additional actions via next_action. If payment fails,
@@ -9821,18 +9822,22 @@ module Stripe
9821
9822
  # canceled status if the confirmation limit is reached. If
9822
9823
  # payment succeeds, the PaymentIntent will transition to the succeeded
9823
9824
  # status (or requires_capture, if capture_method is set to manual).
9825
+ #
9824
9826
  # If the confirmation_method is automatic, payment may be attempted
9825
9827
  # using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment)
9826
9828
  # and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret).
9827
9829
  # After next_actions are handled by the client, no additional
9828
9830
  # confirmation is required to complete the payment.
9831
+ #
9829
9832
  # If the confirmation_method is manual, all payment attempts must be
9830
9833
  # initiated using a secret key.
9834
+ #
9831
9835
  # If any actions are required for the payment, the PaymentIntent will
9832
9836
  # return to the requires_confirmation state
9833
9837
  # after those actions are completed. Your server needs to then
9834
9838
  # explicitly re-confirm the PaymentIntent to initiate the next payment
9835
9839
  # attempt.
9840
+ #
9836
9841
  # There is a variable upper limit on how many times a PaymentIntent can be confirmed.
9837
9842
  # After this limit is reached, any further calls to this endpoint will
9838
9843
  # transition the PaymentIntent to the canceled state.
@@ -9844,6 +9849,7 @@ module Stripe
9844
9849
  # Confirm that your customer intends to pay with current or provided
9845
9850
  # payment method. Upon confirmation, the PaymentIntent will attempt to initiate
9846
9851
  # a payment.
9852
+ #
9847
9853
  # If the selected payment method requires additional authentication steps, the
9848
9854
  # PaymentIntent will transition to the requires_action status and
9849
9855
  # suggest additional actions via next_action. If payment fails,
@@ -9851,18 +9857,22 @@ module Stripe
9851
9857
  # canceled status if the confirmation limit is reached. If
9852
9858
  # payment succeeds, the PaymentIntent will transition to the succeeded
9853
9859
  # status (or requires_capture, if capture_method is set to manual).
9860
+ #
9854
9861
  # If the confirmation_method is automatic, payment may be attempted
9855
9862
  # using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment)
9856
9863
  # and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret).
9857
9864
  # After next_actions are handled by the client, no additional
9858
9865
  # confirmation is required to complete the payment.
9866
+ #
9859
9867
  # If the confirmation_method is manual, all payment attempts must be
9860
9868
  # initiated using a secret key.
9869
+ #
9861
9870
  # If any actions are required for the payment, the PaymentIntent will
9862
9871
  # return to the requires_confirmation state
9863
9872
  # after those actions are completed. Your server needs to then
9864
9873
  # explicitly re-confirm the PaymentIntent to initiate the next payment
9865
9874
  # attempt.
9875
+ #
9866
9876
  # There is a variable upper limit on how many times a PaymentIntent can be confirmed.
9867
9877
  # After this limit is reached, any further calls to this endpoint will
9868
9878
  # transition the PaymentIntent to the canceled state.