stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (697) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -1
  3. data/CONTRIBUTING.md +25 -0
  4. data/Makefile +2 -0
  5. data/OPENAPI_VERSION +1 -1
  6. data/README.md +11 -6
  7. data/Rakefile +0 -5
  8. data/VERSION +1 -1
  9. data/justfile +43 -0
  10. data/lib/stripe/api_version.rb +1 -1
  11. data/lib/stripe/resources/account.rb +117 -747
  12. data/lib/stripe/resources/account_link.rb +0 -10
  13. data/lib/stripe/resources/account_notice.rb +0 -22
  14. data/lib/stripe/resources/account_session.rb +93 -128
  15. data/lib/stripe/resources/apple_pay_domain.rb +0 -10
  16. data/lib/stripe/resources/application.rb +0 -3
  17. data/lib/stripe/resources/application_fee.rb +0 -24
  18. data/lib/stripe/resources/application_fee_refund.rb +0 -7
  19. data/lib/stripe/resources/apps/secret.rb +0 -25
  20. data/lib/stripe/resources/balance.rb +0 -31
  21. data/lib/stripe/resources/balance_transaction.rb +0 -29
  22. data/lib/stripe/resources/bank_account.rb +0 -29
  23. data/lib/stripe/resources/billing/alert.rb +0 -22
  24. data/lib/stripe/resources/billing/alert_triggered.rb +0 -5
  25. data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -12
  26. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -24
  27. data/lib/stripe/resources/billing/credit_grant.rb +0 -32
  28. data/lib/stripe/resources/billing/meter.rb +0 -25
  29. data/lib/stripe/resources/billing/meter_error_report.rb +0 -11
  30. data/lib/stripe/resources/billing/meter_event.rb +0 -10
  31. data/lib/stripe/resources/billing/meter_event_adjustment.rb +0 -8
  32. data/lib/stripe/resources/billing/meter_event_summary.rb +0 -6
  33. data/lib/stripe/resources/billing_portal/configuration.rb +2 -79
  34. data/lib/stripe/resources/billing_portal/session.rb +0 -42
  35. data/lib/stripe/resources/capability.rb +2 -29
  36. data/lib/stripe/resources/capital/financing_offer.rb +0 -33
  37. data/lib/stripe/resources/capital/financing_summary.rb +0 -13
  38. data/lib/stripe/resources/capital/financing_transaction.rb +0 -24
  39. data/lib/stripe/resources/card.rb +2 -34
  40. data/lib/stripe/resources/cash_balance.rb +0 -5
  41. data/lib/stripe/resources/charge.rb +8 -665
  42. data/lib/stripe/resources/checkout/session.rb +21 -513
  43. data/lib/stripe/resources/climate/order.rb +0 -40
  44. data/lib/stripe/resources/climate/product.rb +0 -13
  45. data/lib/stripe/resources/climate/supplier.rb +0 -13
  46. data/lib/stripe/resources/confirmation_token.rb +12 -337
  47. data/lib/stripe/resources/connect_collection_transfer.rb +0 -5
  48. data/lib/stripe/resources/country_spec.rb +0 -13
  49. data/lib/stripe/resources/coupon.rb +0 -39
  50. data/lib/stripe/resources/credit_note.rb +0 -138
  51. data/lib/stripe/resources/credit_note_line_item.rb +0 -24
  52. data/lib/stripe/resources/customer.rb +1 -156
  53. data/lib/stripe/resources/customer_balance_transaction.rb +0 -12
  54. data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -27
  55. data/lib/stripe/resources/customer_session.rb +0 -24
  56. data/lib/stripe/resources/discount.rb +0 -12
  57. data/lib/stripe/resources/dispute.rb +4 -152
  58. data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -8
  59. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +0 -3
  60. data/lib/stripe/resources/entitlements/feature.rb +0 -17
  61. data/lib/stripe/resources/ephemeral_key.rb +0 -5
  62. data/lib/stripe/resources/event.rb +0 -27
  63. data/lib/stripe/resources/exchange_rate.rb +0 -5
  64. data/lib/stripe/resources/file.rb +0 -23
  65. data/lib/stripe/resources/file_link.rb +0 -22
  66. data/lib/stripe/resources/financial_connections/account.rb +0 -47
  67. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -3
  68. data/lib/stripe/resources/financial_connections/account_owner.rb +0 -7
  69. data/lib/stripe/resources/financial_connections/account_ownership.rb +0 -3
  70. data/lib/stripe/resources/financial_connections/institution.rb +0 -13
  71. data/lib/stripe/resources/financial_connections/session.rb +0 -28
  72. data/lib/stripe/resources/financial_connections/transaction.rb +1 -22
  73. data/lib/stripe/resources/forwarding/request.rb +0 -31
  74. data/lib/stripe/resources/funding_instructions.rb +0 -107
  75. data/lib/stripe/resources/gift_cards/card.rb +0 -28
  76. data/lib/stripe/resources/gift_cards/transaction.rb +0 -32
  77. data/lib/stripe/resources/identity/verification_report.rb +0 -69
  78. data/lib/stripe/resources/identity/verification_session.rb +0 -69
  79. data/lib/stripe/resources/invoice.rb +6 -1276
  80. data/lib/stripe/resources/invoice_item.rb +0 -91
  81. data/lib/stripe/resources/invoice_line_item.rb +0 -76
  82. data/lib/stripe/resources/invoice_payment.rb +0 -16
  83. data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
  84. data/lib/stripe/resources/issuing/authorization.rb +0 -199
  85. data/lib/stripe/resources/issuing/card.rb +0 -128
  86. data/lib/stripe/resources/issuing/cardholder.rb +0 -110
  87. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -82
  88. data/lib/stripe/resources/issuing/dispute.rb +0 -151
  89. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -14
  90. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -14
  91. data/lib/stripe/resources/issuing/personalization_design.rb +0 -48
  92. data/lib/stripe/resources/issuing/physical_bundle.rb +0 -13
  93. data/lib/stripe/resources/issuing/settlement.rb +0 -16
  94. data/lib/stripe/resources/issuing/token.rb +0 -46
  95. data/lib/stripe/resources/issuing/transaction.rb +0 -171
  96. data/lib/stripe/resources/line_item.rb +0 -23
  97. data/lib/stripe/resources/login_link.rb +0 -2
  98. data/lib/stripe/resources/mandate.rb +0 -45
  99. data/lib/stripe/resources/margin.rb +0 -19
  100. data/lib/stripe/resources/order.rb +3 -391
  101. data/lib/stripe/resources/payment_attempt_record.rb +0 -42
  102. data/lib/stripe/resources/payment_intent.rb +48 -1768
  103. data/lib/stripe/resources/payment_link.rb +15 -213
  104. data/lib/stripe/resources/payment_method.rb +19 -345
  105. data/lib/stripe/resources/payment_method_configuration.rb +58 -292
  106. data/lib/stripe/resources/payment_method_domain.rb +0 -23
  107. data/lib/stripe/resources/payment_record.rb +0 -109
  108. data/lib/stripe/resources/payout.rb +0 -49
  109. data/lib/stripe/resources/person.rb +2 -92
  110. data/lib/stripe/resources/plan.rb +0 -69
  111. data/lib/stripe/resources/price.rb +0 -133
  112. data/lib/stripe/resources/product.rb +0 -100
  113. data/lib/stripe/resources/product_feature.rb +0 -4
  114. data/lib/stripe/resources/promotion_code.rb +0 -40
  115. data/lib/stripe/resources/quote.rb +0 -458
  116. data/lib/stripe/resources/quote_line.rb +0 -66
  117. data/lib/stripe/resources/quote_preview_invoice.rb +3 -184
  118. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -101
  119. data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -16
  120. data/lib/stripe/resources/radar/value_list.rb +0 -26
  121. data/lib/stripe/resources/radar/value_list_item.rb +0 -18
  122. data/lib/stripe/resources/refund.rb +0 -92
  123. data/lib/stripe/resources/reporting/report_run.rb +0 -32
  124. data/lib/stripe/resources/reporting/report_type.rb +0 -8
  125. data/lib/stripe/resources/reserve_transaction.rb +0 -4
  126. data/lib/stripe/resources/reversal.rb +0 -9
  127. data/lib/stripe/resources/review.rb +0 -27
  128. data/lib/stripe/resources/setup_attempt.rb +2 -103
  129. data/lib/stripe/resources/setup_intent.rb +23 -539
  130. data/lib/stripe/resources/shipping_rate.rb +0 -44
  131. data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -13
  132. data/lib/stripe/resources/source.rb +6 -338
  133. data/lib/stripe/resources/source_mandate_notification.rb +0 -13
  134. data/lib/stripe/resources/source_transaction.rb +0 -29
  135. data/lib/stripe/resources/subscription.rb +0 -338
  136. data/lib/stripe/resources/subscription_item.rb +0 -69
  137. data/lib/stripe/resources/subscription_schedule.rb +0 -388
  138. data/lib/stripe/resources/tax/association.rb +0 -11
  139. data/lib/stripe/resources/tax/calculation.rb +2 -89
  140. data/lib/stripe/resources/tax/calculation_line_item.rb +0 -20
  141. data/lib/stripe/resources/tax/form.rb +2 -35
  142. data/lib/stripe/resources/tax/registration.rb +421 -213
  143. data/lib/stripe/resources/tax/settings.rb +0 -20
  144. data/lib/stripe/resources/tax/transaction.rb +1 -66
  145. data/lib/stripe/resources/tax/transaction_line_item.rb +0 -12
  146. data/lib/stripe/resources/tax_code.rb +0 -6
  147. data/lib/stripe/resources/tax_deducted_at_source.rb +0 -4
  148. data/lib/stripe/resources/tax_id.rb +2 -28
  149. data/lib/stripe/resources/tax_rate.rb +0 -45
  150. data/lib/stripe/resources/terminal/configuration.rb +46 -161
  151. data/lib/stripe/resources/terminal/connection_token.rb +0 -3
  152. data/lib/stripe/resources/terminal/location.rb +0 -33
  153. data/lib/stripe/resources/terminal/reader.rb +0 -129
  154. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -5
  155. data/lib/stripe/resources/test_helpers/test_clock.rb +0 -15
  156. data/lib/stripe/resources/token.rb +23 -192
  157. data/lib/stripe/resources/topup.rb +0 -36
  158. data/lib/stripe/resources/transfer.rb +0 -35
  159. data/lib/stripe/resources/treasury/credit_reversal.rb +0 -21
  160. data/lib/stripe/resources/treasury/debit_reversal.rb +0 -23
  161. data/lib/stripe/resources/treasury/financial_account.rb +77 -71
  162. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -46
  163. data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -50
  164. data/lib/stripe/resources/treasury/outbound_payment.rb +0 -92
  165. data/lib/stripe/resources/treasury/outbound_transfer.rb +25 -66
  166. data/lib/stripe/resources/treasury/received_credit.rb +6 -58
  167. data/lib/stripe/resources/treasury/received_debit.rb +0 -54
  168. data/lib/stripe/resources/treasury/transaction.rb +0 -39
  169. data/lib/stripe/resources/treasury/transaction_entry.rb +0 -36
  170. data/lib/stripe/resources/usage_record.rb +0 -5
  171. data/lib/stripe/resources/usage_record_summary.rb +0 -7
  172. data/lib/stripe/resources/v2/billing/meter_event.rb +0 -6
  173. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +0 -7
  174. data/lib/stripe/resources/v2/billing/meter_event_session.rb +0 -5
  175. data/lib/stripe/resources/v2/event.rb +0 -8
  176. data/lib/stripe/resources/v2/event_destination.rb +0 -19
  177. data/lib/stripe/resources/webhook_endpoint.rb +0 -26
  178. data/lib/stripe/services/account_capability_service.rb +0 -1
  179. data/lib/stripe/services/account_external_account_service.rb +0 -43
  180. data/lib/stripe/services/account_link_service.rb +0 -7
  181. data/lib/stripe/services/account_notice_service.rb +0 -9
  182. data/lib/stripe/services/account_person_service.rb +0 -139
  183. data/lib/stripe/services/account_service.rb +100 -521
  184. data/lib/stripe/services/account_session_service.rb +22 -80
  185. data/lib/stripe/services/apple_pay_domain_service.rb +0 -5
  186. data/lib/stripe/services/application_fee_refund_service.rb +0 -6
  187. data/lib/stripe/services/application_fee_service.rb +0 -8
  188. data/lib/stripe/services/apps/secret_service.rb +0 -16
  189. data/lib/stripe/services/balance_transaction_service.rb +0 -11
  190. data/lib/stripe/services/billing/alert_service.rb +0 -12
  191. data/lib/stripe/services/billing/credit_balance_summary_service.rb +0 -4
  192. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -5
  193. data/lib/stripe/services/billing/credit_grant_service.rb +0 -16
  194. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +0 -3
  195. data/lib/stripe/services/billing/meter_event_service.rb +0 -4
  196. data/lib/stripe/services/billing/meter_event_summary_service.rb +0 -7
  197. data/lib/stripe/services/billing/meter_service.rb +0 -12
  198. data/lib/stripe/services/billing_portal/configuration_service.rb +2 -50
  199. data/lib/stripe/services/billing_portal/session_service.rb +0 -19
  200. data/lib/stripe/services/capital/financing_offer_service.rb +0 -9
  201. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -7
  202. data/lib/stripe/services/charge_service.rb +0 -274
  203. data/lib/stripe/services/checkout/session_line_item_service.rb +0 -3
  204. data/lib/stripe/services/checkout/session_service.rb +9 -273
  205. data/lib/stripe/services/climate/order_service.rb +0 -11
  206. data/lib/stripe/services/climate/product_service.rb +0 -3
  207. data/lib/stripe/services/climate/supplier_service.rb +0 -3
  208. data/lib/stripe/services/country_spec_service.rb +0 -3
  209. data/lib/stripe/services/coupon_service.rb +0 -22
  210. data/lib/stripe/services/credit_note_line_item_service.rb +0 -3
  211. data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -28
  212. data/lib/stripe/services/credit_note_service.rb +0 -61
  213. data/lib/stripe/services/customer_balance_transaction_service.rb +0 -9
  214. data/lib/stripe/services/customer_cash_balance_service.rb +0 -1
  215. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +0 -3
  216. data/lib/stripe/services/customer_funding_instructions_service.rb +0 -5
  217. data/lib/stripe/services/customer_payment_method_service.rb +0 -5
  218. data/lib/stripe/services/customer_payment_source_service.rb +0 -29
  219. data/lib/stripe/services/customer_service.rb +1 -92
  220. data/lib/stripe/services/customer_session_service.rb +0 -10
  221. data/lib/stripe/services/customer_tax_id_service.rb +1 -6
  222. data/lib/stripe/services/dispute_service.rb +2 -67
  223. data/lib/stripe/services/entitlements/active_entitlement_service.rb +0 -4
  224. data/lib/stripe/services/entitlements/feature_service.rb +0 -11
  225. data/lib/stripe/services/ephemeral_key_service.rb +0 -4
  226. data/lib/stripe/services/event_service.rb +0 -10
  227. data/lib/stripe/services/exchange_rate_service.rb +0 -3
  228. data/lib/stripe/services/file_link_service.rb +0 -14
  229. data/lib/stripe/services/file_service.rb +0 -13
  230. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -3
  231. data/lib/stripe/services/financial_connections/account_owner_service.rb +0 -4
  232. data/lib/stripe/services/financial_connections/account_service.rb +0 -9
  233. data/lib/stripe/services/financial_connections/institution_service.rb +0 -3
  234. data/lib/stripe/services/financial_connections/session_service.rb +0 -11
  235. data/lib/stripe/services/financial_connections/transaction_service.rb +1 -10
  236. data/lib/stripe/services/forwarding/request_service.rb +0 -14
  237. data/lib/stripe/services/gift_cards/card_service.rb +0 -13
  238. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -16
  239. data/lib/stripe/services/identity/verification_report_service.rb +0 -10
  240. data/lib/stripe/services/identity/verification_session_service.rb +0 -30
  241. data/lib/stripe/services/invoice_item_service.rb +0 -66
  242. data/lib/stripe/services/invoice_line_item_service.rb +0 -40
  243. data/lib/stripe/services/invoice_payment_service.rb +0 -3
  244. data/lib/stripe/services/invoice_rendering_template_service.rb +0 -5
  245. data/lib/stripe/services/invoice_service.rb +2 -810
  246. data/lib/stripe/services/invoice_upcoming_lines_service.rb +1 -279
  247. data/lib/stripe/services/issuing/authorization_service.rb +0 -14
  248. data/lib/stripe/services/issuing/card_service.rb +0 -70
  249. data/lib/stripe/services/issuing/cardholder_service.rb +0 -73
  250. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -56
  251. data/lib/stripe/services/issuing/dispute_service.rb +0 -98
  252. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -4
  253. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -7
  254. data/lib/stripe/services/issuing/personalization_design_service.rb +0 -29
  255. data/lib/stripe/services/issuing/physical_bundle_service.rb +0 -5
  256. data/lib/stripe/services/issuing/token_service.rb +0 -10
  257. data/lib/stripe/services/issuing/transaction_service.rb +0 -12
  258. data/lib/stripe/services/margin_service.rb +0 -11
  259. data/lib/stripe/services/order_line_item_service.rb +0 -3
  260. data/lib/stripe/services/order_service.rb +2 -266
  261. data/lib/stripe/services/payment_attempt_record_service.rb +0 -1
  262. data/lib/stripe/services/payment_intent_service.rb +42 -1309
  263. data/lib/stripe/services/payment_link_line_item_service.rb +0 -3
  264. data/lib/stripe/services/payment_link_service.rb +15 -135
  265. data/lib/stripe/services/payment_method_configuration_service.rb +42 -102
  266. data/lib/stripe/services/payment_method_domain_service.rb +0 -8
  267. data/lib/stripe/services/payment_method_service.rb +14 -113
  268. data/lib/stripe/services/payment_record_service.rb +0 -68
  269. data/lib/stripe/services/payout_service.rb +0 -23
  270. data/lib/stripe/services/plan_service.rb +0 -43
  271. data/lib/stripe/services/price_service.rb +0 -87
  272. data/lib/stripe/services/product_feature_service.rb +0 -4
  273. data/lib/stripe/services/product_service.rb +0 -74
  274. data/lib/stripe/services/promotion_code_service.rb +0 -25
  275. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +0 -3
  276. data/lib/stripe/services/quote_line_item_service.rb +0 -3
  277. data/lib/stripe/services/quote_line_service.rb +0 -3
  278. data/lib/stripe/services/quote_preview_invoice_service.rb +0 -3
  279. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -3
  280. data/lib/stripe/services/quote_service.rb +0 -309
  281. data/lib/stripe/services/radar/early_fraud_warning_service.rb +0 -9
  282. data/lib/stripe/services/radar/value_list_item_service.rb +0 -11
  283. data/lib/stripe/services/radar/value_list_service.rb +0 -16
  284. data/lib/stripe/services/refund_service.rb +0 -21
  285. data/lib/stripe/services/reporting/report_run_service.rb +0 -16
  286. data/lib/stripe/services/review_service.rb +0 -7
  287. data/lib/stripe/services/setup_attempt_service.rb +0 -8
  288. data/lib/stripe/services/setup_intent_service.rb +21 -447
  289. data/lib/stripe/services/shipping_rate_service.rb +0 -27
  290. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +0 -3
  291. data/lib/stripe/services/source_service.rb +0 -92
  292. data/lib/stripe/services/source_transaction_service.rb +0 -3
  293. data/lib/stripe/services/subscription_item_service.rb +0 -56
  294. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -3
  295. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -3
  296. data/lib/stripe/services/subscription_schedule_service.rb +0 -290
  297. data/lib/stripe/services/subscription_service.rb +0 -245
  298. data/lib/stripe/services/tax/association_service.rb +0 -1
  299. data/lib/stripe/services/tax/calculation_line_item_service.rb +0 -3
  300. data/lib/stripe/services/tax/calculation_service.rb +1 -31
  301. data/lib/stripe/services/tax/form_service.rb +0 -7
  302. data/lib/stripe/services/tax/registration_service.rb +274 -108
  303. data/lib/stripe/services/tax/settings_service.rb +0 -8
  304. data/lib/stripe/services/tax/transaction_line_item_service.rb +0 -3
  305. data/lib/stripe/services/tax/transaction_service.rb +0 -17
  306. data/lib/stripe/services/tax_code_service.rb +0 -3
  307. data/lib/stripe/services/tax_id_service.rb +1 -12
  308. data/lib/stripe/services/tax_rate_service.rb +0 -27
  309. data/lib/stripe/services/terminal/configuration_service.rb +36 -106
  310. data/lib/stripe/services/terminal/connection_token_service.rb +0 -1
  311. data/lib/stripe/services/terminal/location_service.rb +0 -21
  312. data/lib/stripe/services/terminal/reader_service.rb +0 -53
  313. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +7 -89
  314. data/lib/stripe/services/test_helpers/customer_service.rb +0 -3
  315. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +0 -99
  316. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +0 -2
  317. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +0 -91
  318. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -4
  319. data/lib/stripe/services/test_helpers/test_clock_service.rb +0 -6
  320. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +0 -1
  321. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +0 -6
  322. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +0 -6
  323. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +0 -11
  324. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +0 -11
  325. data/lib/stripe/services/token_service.rb +23 -184
  326. data/lib/stripe/services/topup_service.rb +0 -21
  327. data/lib/stripe/services/transfer_reversal_service.rb +0 -8
  328. data/lib/stripe/services/transfer_service.rb +0 -19
  329. data/lib/stripe/services/treasury/credit_reversal_service.rb +0 -8
  330. data/lib/stripe/services/treasury/debit_reversal_service.rb +0 -9
  331. data/lib/stripe/services/treasury/financial_account_features_service.rb +0 -10
  332. data/lib/stripe/services/treasury/financial_account_service.rb +64 -36
  333. data/lib/stripe/services/treasury/inbound_transfer_service.rb +0 -12
  334. data/lib/stripe/services/treasury/outbound_payment_service.rb +0 -38
  335. data/lib/stripe/services/treasury/outbound_transfer_service.rb +16 -15
  336. data/lib/stripe/services/treasury/received_credit_service.rb +0 -6
  337. data/lib/stripe/services/treasury/received_debit_service.rb +0 -5
  338. data/lib/stripe/services/treasury/transaction_entry_service.rb +0 -14
  339. data/lib/stripe/services/treasury/transaction_service.rb +0 -14
  340. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +0 -2
  341. data/lib/stripe/services/v2/billing/meter_event_service.rb +0 -3
  342. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +0 -3
  343. data/lib/stripe/services/v2/core/event_destination_service.rb +0 -18
  344. data/lib/stripe/services/v2/core/event_service.rb +0 -2
  345. data/lib/stripe/services/webhook_endpoint_service.rb +0 -14
  346. data/lib/stripe/stripe_client.rb +7 -2
  347. data/lib/stripe/stripe_configuration.rb +21 -1
  348. data/lib/stripe/stripe_object.rb +3 -3
  349. data/lib/stripe/thin_event.rb +22 -2
  350. data/lib/stripe/util.rb +1 -1
  351. data/lib/stripe/version.rb +1 -1
  352. data/lib/stripe.rb +22 -0
  353. data/rbi/stripe/resources/account.rbi +120 -1007
  354. data/rbi/stripe/resources/account_link.rbi +0 -13
  355. data/rbi/stripe/resources/account_notice.rbi +0 -27
  356. data/rbi/stripe/resources/account_session.rbi +121 -172
  357. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -14
  358. data/rbi/stripe/resources/application.rbi +0 -3
  359. data/rbi/stripe/resources/application_fee.rbi +0 -28
  360. data/rbi/stripe/resources/application_fee_refund.rbi +0 -7
  361. data/rbi/stripe/resources/apps/secret.rbi +0 -34
  362. data/rbi/stripe/resources/balance.rbi +0 -33
  363. data/rbi/stripe/resources/balance_transaction.rbi +0 -33
  364. data/rbi/stripe/resources/bank_account.rbi +0 -29
  365. data/rbi/stripe/resources/billing/alert.rbi +0 -31
  366. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -5
  367. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -16
  368. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -27
  369. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -43
  370. data/rbi/stripe/resources/billing/meter.rbi +0 -35
  371. data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -11
  372. data/rbi/stripe/resources/billing/meter_event.rbi +0 -12
  373. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -11
  374. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -6
  375. data/rbi/stripe/resources/billing_portal/configuration.rbi +2 -108
  376. data/rbi/stripe/resources/billing_portal/session.rbi +0 -55
  377. data/rbi/stripe/resources/capability.rbi +2 -29
  378. data/rbi/stripe/resources/capital/financing_offer.rbi +0 -38
  379. data/rbi/stripe/resources/capital/financing_summary.rbi +0 -15
  380. data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -27
  381. data/rbi/stripe/resources/card.rbi +3 -34
  382. data/rbi/stripe/resources/cash_balance.rbi +0 -5
  383. data/rbi/stripe/resources/charge.rbi +10 -738
  384. data/rbi/stripe/resources/checkout/session.rbi +26 -638
  385. data/rbi/stripe/resources/climate/order.rbi +0 -48
  386. data/rbi/stripe/resources/climate/product.rbi +0 -16
  387. data/rbi/stripe/resources/climate/supplier.rbi +0 -16
  388. data/rbi/stripe/resources/confirmation_token.rbi +15 -365
  389. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -5
  390. data/rbi/stripe/resources/country_spec.rbi +0 -16
  391. data/rbi/stripe/resources/coupon.rbi +0 -48
  392. data/rbi/stripe/resources/credit_note.rbi +0 -159
  393. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -24
  394. data/rbi/stripe/resources/customer.rbi +1 -188
  395. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -12
  396. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -27
  397. data/rbi/stripe/resources/customer_session.rbi +0 -31
  398. data/rbi/stripe/resources/discount.rbi +0 -12
  399. data/rbi/stripe/resources/dispute.rbi +4 -166
  400. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -11
  401. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -3
  402. data/rbi/stripe/resources/entitlements/feature.rbi +0 -22
  403. data/rbi/stripe/resources/ephemeral_key.rbi +0 -7
  404. data/rbi/stripe/resources/event.rbi +0 -31
  405. data/rbi/stripe/resources/exchange_rate.rbi +0 -8
  406. data/rbi/stripe/resources/file.rbi +0 -29
  407. data/rbi/stripe/resources/file_link.rbi +0 -28
  408. data/rbi/stripe/resources/financial_connections/account.rbi +0 -56
  409. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -3
  410. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -7
  411. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -3
  412. data/rbi/stripe/resources/financial_connections/institution.rbi +0 -16
  413. data/rbi/stripe/resources/financial_connections/session.rbi +0 -35
  414. data/rbi/stripe/resources/financial_connections/transaction.rbi +1 -27
  415. data/rbi/stripe/resources/forwarding/request.rbi +0 -38
  416. data/rbi/stripe/resources/funding_instructions.rbi +0 -107
  417. data/rbi/stripe/resources/gift_cards/card.rbi +0 -36
  418. data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -41
  419. data/rbi/stripe/resources/identity/verification_report.rbi +0 -73
  420. data/rbi/stripe/resources/identity/verification_session.rbi +0 -83
  421. data/rbi/stripe/resources/invoice.rbi +7 -1663
  422. data/rbi/stripe/resources/invoice_item.rbi +0 -107
  423. data/rbi/stripe/resources/invoice_line_item.rbi +0 -86
  424. data/rbi/stripe/resources/invoice_payment.rbi +0 -16
  425. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -17
  426. data/rbi/stripe/resources/issuing/authorization.rbi +0 -245
  427. data/rbi/stripe/resources/issuing/card.rbi +0 -153
  428. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -138
  429. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -109
  430. data/rbi/stripe/resources/issuing/dispute.rbi +0 -177
  431. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -17
  432. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -18
  433. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -62
  434. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -16
  435. data/rbi/stripe/resources/issuing/settlement.rbi +0 -16
  436. data/rbi/stripe/resources/issuing/token.rbi +0 -51
  437. data/rbi/stripe/resources/issuing/transaction.rbi +0 -205
  438. data/rbi/stripe/resources/line_item.rbi +0 -23
  439. data/rbi/stripe/resources/login_link.rbi +0 -2
  440. data/rbi/stripe/resources/mandate.rbi +0 -47
  441. data/rbi/stripe/resources/margin.rbi +0 -24
  442. data/rbi/stripe/resources/order.rbi +3 -492
  443. data/rbi/stripe/resources/payment_attempt_record.rbi +0 -45
  444. data/rbi/stripe/resources/payment_intent.rbi +61 -2230
  445. data/rbi/stripe/resources/payment_link.rbi +14 -291
  446. data/rbi/stripe/resources/payment_method.rbi +23 -384
  447. data/rbi/stripe/resources/payment_method_configuration.rbi +75 -495
  448. data/rbi/stripe/resources/payment_method_domain.rbi +0 -29
  449. data/rbi/stripe/resources/payment_record.rbi +0 -134
  450. data/rbi/stripe/resources/payout.rbi +0 -58
  451. data/rbi/stripe/resources/person.rbi +2 -92
  452. data/rbi/stripe/resources/plan.rbi +0 -78
  453. data/rbi/stripe/resources/price.rbi +0 -153
  454. data/rbi/stripe/resources/product.rbi +0 -120
  455. data/rbi/stripe/resources/product_feature.rbi +0 -4
  456. data/rbi/stripe/resources/promotion_code.rbi +0 -50
  457. data/rbi/stripe/resources/quote.rbi +0 -593
  458. data/rbi/stripe/resources/quote_line.rbi +0 -66
  459. data/rbi/stripe/resources/quote_preview_invoice.rbi +4 -184
  460. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -101
  461. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -20
  462. data/rbi/stripe/resources/radar/value_list.rbi +0 -32
  463. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -23
  464. data/rbi/stripe/resources/refund.rbi +0 -100
  465. data/rbi/stripe/resources/reporting/report_run.rbi +0 -38
  466. data/rbi/stripe/resources/reporting/report_type.rbi +0 -11
  467. data/rbi/stripe/resources/reserve_transaction.rbi +0 -4
  468. data/rbi/stripe/resources/reversal.rbi +0 -9
  469. data/rbi/stripe/resources/review.rbi +0 -32
  470. data/rbi/stripe/resources/setup_attempt.rbi +3 -106
  471. data/rbi/stripe/resources/setup_intent.rbi +27 -691
  472. data/rbi/stripe/resources/shipping_rate.rbi +0 -57
  473. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -16
  474. data/rbi/stripe/resources/source.rbi +9 -365
  475. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -13
  476. data/rbi/stripe/resources/source_transaction.rbi +0 -29
  477. data/rbi/stripe/resources/subscription.rbi +0 -431
  478. data/rbi/stripe/resources/subscription_item.rbi +0 -88
  479. data/rbi/stripe/resources/subscription_schedule.rbi +0 -504
  480. data/rbi/stripe/resources/tax/association.rbi +0 -13
  481. data/rbi/stripe/resources/tax/calculation.rbi +2 -100
  482. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -20
  483. data/rbi/stripe/resources/tax/form.rbi +2 -40
  484. data/rbi/stripe/resources/tax/registration.rbi +401 -317
  485. data/rbi/stripe/resources/tax/settings.rbi +0 -26
  486. data/rbi/stripe/resources/tax/transaction.rbi +1 -73
  487. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -12
  488. data/rbi/stripe/resources/tax_code.rbi +0 -9
  489. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -4
  490. data/rbi/stripe/resources/tax_id.rbi +2 -34
  491. data/rbi/stripe/resources/tax_rate.rbi +0 -51
  492. data/rbi/stripe/resources/terminal/configuration.rbi +54 -213
  493. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -5
  494. data/rbi/stripe/resources/terminal/location.rbi +0 -40
  495. data/rbi/stripe/resources/terminal/reader.rbi +0 -158
  496. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -7
  497. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -20
  498. data/rbi/stripe/resources/token.rbi +22 -235
  499. data/rbi/stripe/resources/topup.rbi +0 -44
  500. data/rbi/stripe/resources/transfer.rbi +0 -41
  501. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -25
  502. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -27
  503. data/rbi/stripe/resources/treasury/financial_account.rbi +70 -124
  504. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -46
  505. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -59
  506. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -113
  507. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +28 -84
  508. data/rbi/stripe/resources/treasury/received_credit.rbi +7 -67
  509. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -62
  510. data/rbi/stripe/resources/treasury/transaction.rbi +0 -45
  511. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -41
  512. data/rbi/stripe/resources/usage_record.rbi +0 -5
  513. data/rbi/stripe/resources/usage_record_summary.rbi +0 -7
  514. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -6
  515. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -7
  516. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -5
  517. data/rbi/stripe/resources/v2/event.rbi +0 -8
  518. data/rbi/stripe/resources/v2/event_destination.rbi +0 -19
  519. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -31
  520. data/rbi/stripe/services/account_capability_service.rbi +0 -4
  521. data/rbi/stripe/services/account_external_account_service.rbi +0 -52
  522. data/rbi/stripe/services/account_link_service.rbi +0 -9
  523. data/rbi/stripe/services/account_login_link_service.rbi +0 -1
  524. data/rbi/stripe/services/account_notice_service.rbi +0 -13
  525. data/rbi/stripe/services/account_person_service.rbi +0 -174
  526. data/rbi/stripe/services/account_service.rbi +98 -779
  527. data/rbi/stripe/services/account_session_service.rbi +29 -122
  528. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -8
  529. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -10
  530. data/rbi/stripe/services/application_fee_service.rbi +0 -11
  531. data/rbi/stripe/services/apps/secret_service.rbi +0 -24
  532. data/rbi/stripe/services/balance_service.rbi +0 -1
  533. data/rbi/stripe/services/balance_transaction_service.rbi +0 -14
  534. data/rbi/stripe/services/billing/alert_service.rbi +0 -20
  535. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -7
  536. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -7
  537. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -26
  538. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -5
  539. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -5
  540. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -8
  541. data/rbi/stripe/services/billing/meter_service.rbi +0 -21
  542. data/rbi/stripe/services/billing_portal/configuration_service.rbi +2 -78
  543. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -31
  544. data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -13
  545. data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -1
  546. data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -9
  547. data/rbi/stripe/services/charge_service.rbi +0 -346
  548. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -4
  549. data/rbi/stripe/services/checkout/session_service.rbi +12 -396
  550. data/rbi/stripe/services/climate/order_service.rbi +0 -18
  551. data/rbi/stripe/services/climate/product_service.rbi +0 -5
  552. data/rbi/stripe/services/climate/supplier_service.rbi +0 -5
  553. data/rbi/stripe/services/confirmation_token_service.rbi +0 -1
  554. data/rbi/stripe/services/country_spec_service.rbi +0 -5
  555. data/rbi/stripe/services/coupon_service.rbi +0 -30
  556. data/rbi/stripe/services/credit_note_line_item_service.rbi +0 -4
  557. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -33
  558. data/rbi/stripe/services/credit_note_service.rbi +0 -76
  559. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -13
  560. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -4
  561. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -5
  562. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -8
  563. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -7
  564. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -37
  565. data/rbi/stripe/services/customer_service.rbi +1 -117
  566. data/rbi/stripe/services/customer_session_service.rbi +0 -16
  567. data/rbi/stripe/services/customer_tax_id_service.rbi +1 -9
  568. data/rbi/stripe/services/dispute_service.rbi +2 -80
  569. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -6
  570. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -15
  571. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -6
  572. data/rbi/stripe/services/event_service.rbi +0 -13
  573. data/rbi/stripe/services/exchange_rate_service.rbi +0 -5
  574. data/rbi/stripe/services/file_link_service.rbi +0 -19
  575. data/rbi/stripe/services/file_service.rbi +0 -18
  576. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -4
  577. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -5
  578. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -16
  579. data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -5
  580. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -17
  581. data/rbi/stripe/services/financial_connections/transaction_service.rbi +1 -14
  582. data/rbi/stripe/services/forwarding/request_service.rbi +0 -20
  583. data/rbi/stripe/services/gift_cards/card_service.rbi +0 -20
  584. data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -24
  585. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -13
  586. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -43
  587. data/rbi/stripe/services/invoice_item_service.rbi +0 -81
  588. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -50
  589. data/rbi/stripe/services/invoice_payment_service.rbi +0 -5
  590. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -9
  591. data/rbi/stripe/services/invoice_service.rbi +2 -1100
  592. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +1 -375
  593. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -20
  594. data/rbi/stripe/services/issuing/card_service.rbi +0 -89
  595. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -100
  596. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -82
  597. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -123
  598. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -6
  599. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -10
  600. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -38
  601. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -7
  602. data/rbi/stripe/services/issuing/token_service.rbi +0 -14
  603. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -16
  604. data/rbi/stripe/services/mandate_service.rbi +0 -1
  605. data/rbi/stripe/services/margin_service.rbi +0 -15
  606. data/rbi/stripe/services/order_line_item_service.rbi +0 -4
  607. data/rbi/stripe/services/order_service.rbi +2 -365
  608. data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -3
  609. data/rbi/stripe/services/payment_intent_service.rbi +54 -1770
  610. data/rbi/stripe/services/payment_link_line_item_service.rbi +0 -4
  611. data/rbi/stripe/services/payment_link_service.rbi +14 -211
  612. data/rbi/stripe/services/payment_method_configuration_service.rbi +46 -296
  613. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -13
  614. data/rbi/stripe/services/payment_method_service.rbi +16 -151
  615. data/rbi/stripe/services/payment_record_service.rbi +0 -92
  616. data/rbi/stripe/services/payout_service.rbi +0 -31
  617. data/rbi/stripe/services/plan_service.rbi +0 -51
  618. data/rbi/stripe/services/price_service.rbi +0 -106
  619. data/rbi/stripe/services/product_feature_service.rbi +0 -7
  620. data/rbi/stripe/services/product_service.rbi +0 -93
  621. data/rbi/stripe/services/promotion_code_service.rbi +0 -34
  622. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -4
  623. data/rbi/stripe/services/quote_line_item_service.rbi +0 -4
  624. data/rbi/stripe/services/quote_line_service.rbi +0 -4
  625. data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -4
  626. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -4
  627. data/rbi/stripe/services/quote_service.rbi +0 -440
  628. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -12
  629. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -15
  630. data/rbi/stripe/services/radar/value_list_service.rbi +0 -21
  631. data/rbi/stripe/services/refund_service.rbi +0 -27
  632. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -21
  633. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -2
  634. data/rbi/stripe/services/review_service.rbi +0 -11
  635. data/rbi/stripe/services/setup_attempt_service.rbi +0 -10
  636. data/rbi/stripe/services/setup_intent_service.rbi +24 -598
  637. data/rbi/stripe/services/shipping_rate_service.rbi +0 -39
  638. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -5
  639. data/rbi/stripe/services/source_service.rbi +0 -119
  640. data/rbi/stripe/services/source_transaction_service.rbi +0 -4
  641. data/rbi/stripe/services/subscription_item_service.rbi +0 -74
  642. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -4
  643. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -4
  644. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -405
  645. data/rbi/stripe/services/subscription_service.rbi +0 -337
  646. data/rbi/stripe/services/tax/association_service.rbi +0 -2
  647. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -4
  648. data/rbi/stripe/services/tax/calculation_service.rbi +1 -40
  649. data/rbi/stripe/services/tax/form_service.rbi +0 -11
  650. data/rbi/stripe/services/tax/registration_service.rbi +233 -211
  651. data/rbi/stripe/services/tax/settings_service.rbi +0 -13
  652. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +0 -4
  653. data/rbi/stripe/services/tax/transaction_service.rbi +0 -22
  654. data/rbi/stripe/services/tax_code_service.rbi +0 -5
  655. data/rbi/stripe/services/tax_id_service.rbi +1 -17
  656. data/rbi/stripe/services/tax_rate_service.rbi +0 -32
  657. data/rbi/stripe/services/terminal/configuration_service.rbi +40 -156
  658. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -2
  659. data/rbi/stripe/services/terminal/location_service.rbi +0 -27
  660. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -1
  661. data/rbi/stripe/services/terminal/reader_service.rbi +0 -78
  662. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +10 -115
  663. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -4
  664. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -138
  665. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -5
  666. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -6
  667. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -120
  668. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -1
  669. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -7
  670. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -10
  671. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -5
  672. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -14
  673. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -14
  674. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -16
  675. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -16
  676. data/rbi/stripe/services/token_service.rbi +24 -226
  677. data/rbi/stripe/services/topup_service.rbi +0 -28
  678. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -12
  679. data/rbi/stripe/services/transfer_service.rbi +0 -24
  680. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -11
  681. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -12
  682. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -25
  683. data/rbi/stripe/services/treasury/financial_account_service.rbi +62 -73
  684. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -16
  685. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -50
  686. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +17 -24
  687. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -9
  688. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -7
  689. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -18
  690. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -19
  691. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -4
  692. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -4
  693. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -5
  694. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -25
  695. data/rbi/stripe/services/v2/core/event_service.rbi +0 -3
  696. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -18
  697. metadata +4 -2
@@ -29,17 +29,14 @@ module Stripe
29
29
  # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
30
30
  sig { returns(T::Boolean) }
31
31
  attr_reader :allow_promotion_codes
32
-
33
32
  # If `true`, a recovery url will be generated to recover this Checkout Session if it
34
33
  # expires before a transaction is completed. It will be attached to the
35
34
  # Checkout Session object upon expiration.
36
35
  sig { returns(T::Boolean) }
37
36
  attr_reader :enabled
38
-
39
37
  # The timestamp at which the recovery URL will expire.
40
38
  sig { returns(T.nilable(Integer)) }
41
39
  attr_reader :expires_at
42
-
43
40
  # URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
44
41
  sig { returns(T.nilable(String)) }
45
42
  attr_reader :url
@@ -53,7 +50,6 @@ module Stripe
53
50
  # The connected account being referenced when `type` is `account`.
54
51
  sig { returns(T.any(String, Stripe::Account)) }
55
52
  attr_reader :account
56
-
57
53
  # Type of the account referenced.
58
54
  sig { returns(String) }
59
55
  attr_reader :type
@@ -61,11 +57,9 @@ module Stripe
61
57
  # Indicates whether automatic tax is enabled for the session
62
58
  sig { returns(T::Boolean) }
63
59
  attr_reader :enabled
64
-
65
60
  # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
66
61
  sig { returns(T.nilable(Liability)) }
67
62
  attr_reader :liability
68
-
69
63
  # The status of the most recent automated tax calculation for this session.
70
64
  sig { returns(T.nilable(String)) }
71
65
  attr_reader :status
@@ -76,23 +70,18 @@ module Stripe
76
70
  # City, district, suburb, town, or village.
77
71
  sig { returns(T.nilable(String)) }
78
72
  attr_reader :city
79
-
80
73
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
81
74
  sig { returns(T.nilable(String)) }
82
75
  attr_reader :country
83
-
84
76
  # Address line 1 (e.g., street, PO Box, or company name).
85
77
  sig { returns(T.nilable(String)) }
86
78
  attr_reader :line1
87
-
88
79
  # Address line 2 (e.g., apartment, suite, unit, or building).
89
80
  sig { returns(T.nilable(String)) }
90
81
  attr_reader :line2
91
-
92
82
  # ZIP or postal code.
93
83
  sig { returns(T.nilable(String)) }
94
84
  attr_reader :postal_code
95
-
96
85
  # State, county, province, or region.
97
86
  sig { returns(T.nilable(String)) }
98
87
  attr_reader :state
@@ -100,28 +89,23 @@ module Stripe
100
89
  # Attribute for field address
101
90
  sig { returns(Address) }
102
91
  attr_reader :address
103
-
104
92
  # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
105
93
  sig { returns(T.nilable(String)) }
106
94
  attr_reader :carrier
107
-
108
95
  # Recipient name.
109
96
  sig { returns(String) }
110
97
  attr_reader :name
111
-
112
98
  # Recipient phone (including extension).
113
99
  sig { returns(T.nilable(String)) }
114
100
  attr_reader :phone
115
-
116
101
  # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
117
102
  sig { returns(T.nilable(String)) }
118
103
  attr_reader :tracking_number
119
104
  end
120
105
  class TaxId < Stripe::StripeObject
121
- # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`
106
+ # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`
122
107
  sig { returns(String) }
123
108
  attr_reader :type
124
-
125
109
  # The value of the tax ID.
126
110
  sig { returns(T.nilable(String)) }
127
111
  attr_reader :value
@@ -129,19 +113,15 @@ module Stripe
129
113
  # Customer’s business name for this Checkout Session
130
114
  sig { returns(T.nilable(String)) }
131
115
  attr_reader :business_name
132
-
133
116
  # Customer’s email for this Checkout Session
134
117
  sig { returns(T.nilable(String)) }
135
118
  attr_reader :email
136
-
137
119
  # Customer’s phone number for this Checkout Session
138
120
  sig { returns(T.nilable(String)) }
139
121
  attr_reader :phone
140
-
141
122
  # Shipping information for this Checkout Session.
142
123
  sig { returns(T.nilable(ShippingDetails)) }
143
124
  attr_reader :shipping_details
144
-
145
125
  # Customer’s tax ids for this Checkout Session.
146
126
  sig { returns(T.nilable(T::Array[TaxId])) }
147
127
  attr_reader :tax_ids
@@ -151,7 +131,6 @@ module Stripe
151
131
  # from the merchant about this Checkout Session.
152
132
  sig { returns(T.nilable(String)) }
153
133
  attr_reader :promotions
154
-
155
134
  # If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.
156
135
  sig { returns(T.nilable(String)) }
157
136
  attr_reader :terms_of_service
@@ -167,13 +146,11 @@ module Stripe
167
146
  # If set to `hidden`, it will hide legal text related to the reuse of a payment method.
168
147
  sig { returns(T.nilable(PaymentMethodReuseAgreement)) }
169
148
  attr_reader :payment_method_reuse_agreement
170
-
171
149
  # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
172
150
  # Session will determine whether to display an option to opt into promotional communication
173
151
  # from the merchant depending on the customer's locale. Only available to US merchants.
174
152
  sig { returns(T.nilable(String)) }
175
153
  attr_reader :promotions
176
-
177
154
  # If set to `required`, it requires customers to accept the terms of service before being able to pay.
178
155
  sig { returns(T.nilable(String)) }
179
156
  attr_reader :terms_of_service
@@ -182,15 +159,12 @@ module Stripe
182
159
  # Total of all items in source currency before discounts or taxes are applied.
183
160
  sig { returns(Integer) }
184
161
  attr_reader :amount_subtotal
185
-
186
162
  # Total of all items in source currency after discounts and taxes are applied.
187
163
  sig { returns(Integer) }
188
164
  attr_reader :amount_total
189
-
190
165
  # Exchange rate used to convert source currency amounts to customer currency amounts
191
166
  sig { returns(String) }
192
167
  attr_reader :fx_rate
193
-
194
168
  # Creation currency of the CheckoutSession before localization
195
169
  sig { returns(String) }
196
170
  attr_reader :source_currency
@@ -201,7 +175,6 @@ module Stripe
201
175
  # The label for the option, displayed to the customer. Up to 100 characters.
202
176
  sig { returns(String) }
203
177
  attr_reader :label
204
-
205
178
  # The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
206
179
  sig { returns(String) }
207
180
  attr_reader :value
@@ -209,11 +182,9 @@ module Stripe
209
182
  # The value that will pre-fill on the payment page.
210
183
  sig { returns(T.nilable(String)) }
211
184
  attr_reader :default_value
212
-
213
185
  # The options available for the customer to select. Up to 200 options allowed.
214
186
  sig { returns(T::Array[Option]) }
215
187
  attr_reader :options
216
-
217
188
  # The option selected by the customer. This will be the `value` for the option.
218
189
  sig { returns(T.nilable(String)) }
219
190
  attr_reader :value
@@ -222,7 +193,6 @@ module Stripe
222
193
  # Custom text for the label, displayed to the customer. Up to 50 characters.
223
194
  sig { returns(T.nilable(String)) }
224
195
  attr_reader :custom
225
-
226
196
  # The type of the label.
227
197
  sig { returns(String) }
228
198
  attr_reader :type
@@ -231,15 +201,12 @@ module Stripe
231
201
  # The value that will pre-fill the field on the payment page.
232
202
  sig { returns(T.nilable(String)) }
233
203
  attr_reader :default_value
234
-
235
204
  # The maximum character length constraint for the customer's input.
236
205
  sig { returns(T.nilable(Integer)) }
237
206
  attr_reader :maximum_length
238
-
239
207
  # The minimum character length requirement for the customer's input.
240
208
  sig { returns(T.nilable(Integer)) }
241
209
  attr_reader :minimum_length
242
-
243
210
  # The value entered by the customer, containing only digits.
244
211
  sig { returns(T.nilable(String)) }
245
212
  attr_reader :value
@@ -248,15 +215,12 @@ module Stripe
248
215
  # The value that will pre-fill the field on the payment page.
249
216
  sig { returns(T.nilable(String)) }
250
217
  attr_reader :default_value
251
-
252
218
  # The maximum character length constraint for the customer's input.
253
219
  sig { returns(T.nilable(Integer)) }
254
220
  attr_reader :maximum_length
255
-
256
221
  # The minimum character length requirement for the customer's input.
257
222
  sig { returns(T.nilable(Integer)) }
258
223
  attr_reader :minimum_length
259
-
260
224
  # The value entered by the customer.
261
225
  sig { returns(T.nilable(String)) }
262
226
  attr_reader :value
@@ -264,27 +228,21 @@ module Stripe
264
228
  # Attribute for field dropdown
265
229
  sig { returns(Dropdown) }
266
230
  attr_reader :dropdown
267
-
268
231
  # String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
269
232
  sig { returns(String) }
270
233
  attr_reader :key
271
-
272
234
  # Attribute for field label
273
235
  sig { returns(Label) }
274
236
  attr_reader :label
275
-
276
237
  # Attribute for field numeric
277
238
  sig { returns(Numeric) }
278
239
  attr_reader :numeric
279
-
280
240
  # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
281
241
  sig { returns(T::Boolean) }
282
242
  attr_reader :optional
283
-
284
243
  # Attribute for field text
285
244
  sig { returns(Text) }
286
245
  attr_reader :text
287
-
288
246
  # The type of the field.
289
247
  sig { returns(String) }
290
248
  attr_reader :type
@@ -313,15 +271,12 @@ module Stripe
313
271
  # Custom text that should be displayed after the payment confirmation button.
314
272
  sig { returns(T.nilable(AfterSubmit)) }
315
273
  attr_reader :after_submit
316
-
317
274
  # Custom text that should be displayed alongside shipping address collection.
318
275
  sig { returns(T.nilable(ShippingAddress)) }
319
276
  attr_reader :shipping_address
320
-
321
277
  # Custom text that should be displayed alongside the payment confirmation button.
322
278
  sig { returns(T.nilable(Submit)) }
323
279
  attr_reader :submit
324
-
325
280
  # Custom text that should be displayed in place of the default terms of service agreement text.
326
281
  sig { returns(T.nilable(TermsOfServiceAcceptance)) }
327
282
  attr_reader :terms_of_service_acceptance
@@ -331,32 +286,26 @@ module Stripe
331
286
  # City, district, suburb, town, or village.
332
287
  sig { returns(T.nilable(String)) }
333
288
  attr_reader :city
334
-
335
289
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
336
290
  sig { returns(T.nilable(String)) }
337
291
  attr_reader :country
338
-
339
292
  # Address line 1 (e.g., street, PO Box, or company name).
340
293
  sig { returns(T.nilable(String)) }
341
294
  attr_reader :line1
342
-
343
295
  # Address line 2 (e.g., apartment, suite, unit, or building).
344
296
  sig { returns(T.nilable(String)) }
345
297
  attr_reader :line2
346
-
347
298
  # ZIP or postal code.
348
299
  sig { returns(T.nilable(String)) }
349
300
  attr_reader :postal_code
350
-
351
301
  # State, county, province, or region.
352
302
  sig { returns(T.nilable(String)) }
353
303
  attr_reader :state
354
304
  end
355
305
  class TaxId < Stripe::StripeObject
356
- # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`
306
+ # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`
357
307
  sig { returns(String) }
358
308
  attr_reader :type
359
-
360
309
  # The value of the tax ID.
361
310
  sig { returns(T.nilable(String)) }
362
311
  attr_reader :value
@@ -364,35 +313,37 @@ module Stripe
364
313
  # The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
365
314
  sig { returns(T.nilable(Address)) }
366
315
  attr_reader :address
367
-
368
316
  # The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
369
317
  # Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
370
318
  sig { returns(T.nilable(String)) }
371
319
  attr_reader :email
372
-
373
320
  # The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
374
321
  sig { returns(T.nilable(String)) }
375
322
  attr_reader :name
376
-
377
323
  # The customer's phone number after a completed Checkout Session.
378
324
  sig { returns(T.nilable(String)) }
379
325
  attr_reader :phone
380
-
381
326
  # The customer’s tax exempt status after a completed Checkout Session.
382
327
  sig { returns(T.nilable(String)) }
383
328
  attr_reader :tax_exempt
384
-
385
329
  # The customer’s tax IDs after a completed Checkout Session.
386
330
  sig { returns(T.nilable(T::Array[TaxId])) }
387
331
  attr_reader :tax_ids
388
332
  end
333
+ class Discount < Stripe::StripeObject
334
+ # Coupon attached to the Checkout Session.
335
+ sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
336
+ attr_reader :coupon
337
+ # Promotion code attached to the Checkout Session.
338
+ sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
339
+ attr_reader :promotion_code
340
+ end
389
341
  class InvoiceCreation < Stripe::StripeObject
390
342
  class InvoiceData < Stripe::StripeObject
391
343
  class CustomField < Stripe::StripeObject
392
344
  # The name of the custom field.
393
345
  sig { returns(String) }
394
346
  attr_reader :name
395
-
396
347
  # The value of the custom field.
397
348
  sig { returns(String) }
398
349
  attr_reader :value
@@ -401,7 +352,6 @@ module Stripe
401
352
  # The connected account being referenced when `type` is `account`.
402
353
  sig { returns(T.any(String, Stripe::Account)) }
403
354
  attr_reader :account
404
-
405
355
  # Type of the account referenced.
406
356
  sig { returns(String) }
407
357
  attr_reader :type
@@ -414,27 +364,21 @@ module Stripe
414
364
  # The account tax IDs associated with the invoice.
415
365
  sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
416
366
  attr_reader :account_tax_ids
417
-
418
367
  # Custom fields displayed on the invoice.
419
368
  sig { returns(T.nilable(T::Array[CustomField])) }
420
369
  attr_reader :custom_fields
421
-
422
370
  # An arbitrary string attached to the object. Often useful for displaying to users.
423
371
  sig { returns(T.nilable(String)) }
424
372
  attr_reader :description
425
-
426
373
  # Footer displayed on the invoice.
427
374
  sig { returns(T.nilable(String)) }
428
375
  attr_reader :footer
429
-
430
376
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
431
377
  sig { returns(T.nilable(Issuer)) }
432
378
  attr_reader :issuer
433
-
434
379
  # 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.
435
380
  sig { returns(T.nilable(T::Hash[String, String])) }
436
381
  attr_reader :metadata
437
-
438
382
  # Options for invoice PDF rendering.
439
383
  sig { returns(T.nilable(RenderingOptions)) }
440
384
  attr_reader :rendering_options
@@ -442,7 +386,6 @@ module Stripe
442
386
  # Indicates whether invoice creation is enabled for the Checkout Session.
443
387
  sig { returns(T::Boolean) }
444
388
  attr_reader :enabled
445
-
446
389
  # Attribute for field invoice_data
447
390
  sig { returns(InvoiceData) }
448
391
  attr_reader :invoice_data
@@ -451,7 +394,6 @@ module Stripe
451
394
  # ID of the payment method configuration used.
452
395
  sig { returns(String) }
453
396
  attr_reader :id
454
-
455
397
  # ID of the parent payment method configuration used.
456
398
  sig { returns(T.nilable(String)) }
457
399
  attr_reader :parent
@@ -462,19 +404,15 @@ module Stripe
462
404
  # A URL for custom mandate text
463
405
  sig { returns(String) }
464
406
  attr_reader :custom_mandate_url
465
-
466
407
  # List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
467
408
  sig { returns(T::Array[String]) }
468
409
  attr_reader :default_for
469
-
470
410
  # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
471
411
  sig { returns(T.nilable(String)) }
472
412
  attr_reader :interval_description
473
-
474
413
  # Payment schedule for the mandate.
475
414
  sig { returns(T.nilable(String)) }
476
415
  attr_reader :payment_schedule
477
-
478
416
  # Transaction type of the mandate.
479
417
  sig { returns(T.nilable(String)) }
480
418
  attr_reader :transaction_type
@@ -482,11 +420,9 @@ module Stripe
482
420
  # Currency supported by the bank account. Returned when the Session is in `setup` mode.
483
421
  sig { returns(String) }
484
422
  attr_reader :currency
485
-
486
423
  # Attribute for field mandate_options
487
424
  sig { returns(MandateOptions) }
488
425
  attr_reader :mandate_options
489
-
490
426
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
491
427
  #
492
428
  # 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.
@@ -496,7 +432,6 @@ module Stripe
496
432
  # 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).
497
433
  sig { returns(String) }
498
434
  attr_reader :setup_future_usage
499
-
500
435
  # Bank account verification method.
501
436
  sig { returns(String) }
502
437
  attr_reader :verification_method
@@ -565,7 +500,6 @@ module Stripe
565
500
  # Attribute for field mandate_options
566
501
  sig { returns(MandateOptions) }
567
502
  attr_reader :mandate_options
568
-
569
503
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
570
504
  #
571
505
  # 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.
@@ -591,7 +525,6 @@ module Stripe
591
525
  # The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
592
526
  sig { returns(Integer) }
593
527
  attr_reader :expires_after_days
594
-
595
528
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
596
529
  #
597
530
  # 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.
@@ -611,31 +544,24 @@ module Stripe
611
544
  # Attribute for field installments
612
545
  sig { returns(Installments) }
613
546
  attr_reader :installments
614
-
615
547
  # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
616
548
  sig { returns(String) }
617
549
  attr_reader :request_decremental_authorization
618
-
619
550
  # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
620
551
  sig { returns(String) }
621
552
  attr_reader :request_extended_authorization
622
-
623
553
  # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
624
554
  sig { returns(String) }
625
555
  attr_reader :request_incremental_authorization
626
-
627
556
  # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
628
557
  sig { returns(String) }
629
558
  attr_reader :request_multicapture
630
-
631
559
  # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
632
560
  sig { returns(String) }
633
561
  attr_reader :request_overcapture
634
-
635
562
  # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
636
563
  sig { returns(String) }
637
564
  attr_reader :request_three_d_secure
638
-
639
565
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
640
566
  #
641
567
  # 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.
@@ -645,11 +571,9 @@ module Stripe
645
571
  # 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).
646
572
  sig { returns(String) }
647
573
  attr_reader :setup_future_usage
648
-
649
574
  # Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
650
575
  sig { returns(String) }
651
576
  attr_reader :statement_descriptor_suffix_kana
652
-
653
577
  # Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
654
578
  sig { returns(String) }
655
579
  attr_reader :statement_descriptor_suffix_kanji
@@ -675,13 +599,11 @@ module Stripe
675
599
  # Attribute for field eu_bank_transfer
676
600
  sig { returns(EuBankTransfer) }
677
601
  attr_reader :eu_bank_transfer
678
-
679
602
  # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
680
603
  #
681
604
  # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
682
605
  sig { returns(T::Array[String]) }
683
606
  attr_reader :requested_address_types
684
-
685
607
  # The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
686
608
  sig { returns(T.nilable(String)) }
687
609
  attr_reader :type
@@ -689,11 +611,9 @@ module Stripe
689
611
  # Attribute for field bank_transfer
690
612
  sig { returns(BankTransfer) }
691
613
  attr_reader :bank_transfer
692
-
693
614
  # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
694
615
  sig { returns(T.nilable(String)) }
695
616
  attr_reader :funding_type
696
-
697
617
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
698
618
  #
699
619
  # 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.
@@ -763,7 +683,6 @@ module Stripe
763
683
  # Controls when the funds will be captured from the customer's account.
764
684
  sig { returns(String) }
765
685
  attr_reader :capture_method
766
-
767
686
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
768
687
  #
769
688
  # 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.
@@ -789,7 +708,6 @@ module Stripe
789
708
  # The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
790
709
  sig { returns(T.nilable(Integer)) }
791
710
  attr_reader :expires_after_days
792
-
793
711
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
794
712
  #
795
713
  # 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.
@@ -804,7 +722,6 @@ module Stripe
804
722
  # Controls when the funds will be captured from the customer's account.
805
723
  sig { returns(String) }
806
724
  attr_reader :capture_method
807
-
808
725
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
809
726
  #
810
727
  # 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.
@@ -857,7 +774,6 @@ module Stripe
857
774
  # The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
858
775
  sig { returns(Integer) }
859
776
  attr_reader :expires_after_days
860
-
861
777
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
862
778
  #
863
779
  # 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.
@@ -899,15 +815,12 @@ module Stripe
899
815
  # Controls when the funds will be captured from the customer's account.
900
816
  sig { returns(String) }
901
817
  attr_reader :capture_method
902
-
903
818
  # Preferred locale of the PayPal checkout page that the customer is redirected to.
904
819
  sig { returns(T.nilable(String)) }
905
820
  attr_reader :preferred_locale
906
-
907
821
  # A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
908
822
  sig { returns(T.nilable(String)) }
909
823
  attr_reader :reference
910
-
911
824
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
912
825
  #
913
826
  # 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.
@@ -917,7 +830,6 @@ module Stripe
917
830
  # 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).
918
831
  sig { returns(String) }
919
832
  attr_reader :setup_future_usage
920
-
921
833
  # The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
922
834
  sig { returns(T::Array[String]) }
923
835
  attr_reader :subsellers
@@ -927,27 +839,21 @@ module Stripe
927
839
  # Amount that will be collected. It is required when `amount_type` is `fixed`.
928
840
  sig { returns(T.nilable(Integer)) }
929
841
  attr_reader :amount
930
-
931
842
  # The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
932
843
  sig { returns(T.nilable(String)) }
933
844
  attr_reader :amount_type
934
-
935
845
  # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
936
846
  sig { returns(T.nilable(String)) }
937
847
  attr_reader :end_date
938
-
939
848
  # The periodicity at which payments will be collected.
940
849
  sig { returns(T.nilable(String)) }
941
850
  attr_reader :payment_schedule
942
-
943
851
  # The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
944
852
  sig { returns(T.nilable(Integer)) }
945
853
  attr_reader :payments_per_period
946
-
947
854
  # The purpose for which payments are made. Defaults to retail.
948
855
  sig { returns(T.nilable(String)) }
949
856
  attr_reader :purpose
950
-
951
857
  # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
952
858
  sig { returns(T.nilable(String)) }
953
859
  attr_reader :start_date
@@ -955,7 +861,6 @@ module Stripe
955
861
  # Attribute for field mandate_options
956
862
  sig { returns(MandateOptions) }
957
863
  attr_reader :mandate_options
958
-
959
864
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
960
865
  #
961
866
  # 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.
@@ -996,7 +901,6 @@ module Stripe
996
901
  # Attribute for field mandate_options
997
902
  sig { returns(MandateOptions) }
998
903
  attr_reader :mandate_options
999
-
1000
904
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1001
905
  #
1002
906
  # 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.
@@ -1029,7 +933,6 @@ module Stripe
1029
933
  # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
1030
934
  sig { returns(T::Array[String]) }
1031
935
  attr_reader :account_subcategories
1032
-
1033
936
  # The institution to use to filter for possible accounts to link.
1034
937
  sig { returns(String) }
1035
938
  attr_reader :institution
@@ -1042,19 +945,15 @@ module Stripe
1042
945
  # Attribute for field filters
1043
946
  sig { returns(Filters) }
1044
947
  attr_reader :filters
1045
-
1046
948
  # Attribute for field manual_entry
1047
949
  sig { returns(ManualEntry) }
1048
950
  attr_reader :manual_entry
1049
-
1050
951
  # The list of permissions to request. The `payment_method` permission must be included.
1051
952
  sig { returns(T::Array[String]) }
1052
953
  attr_reader :permissions
1053
-
1054
954
  # Data features requested to be retrieved upon account creation.
1055
955
  sig { returns(T.nilable(T::Array[String])) }
1056
956
  attr_reader :prefetch
1057
-
1058
957
  # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
1059
958
  sig { returns(String) }
1060
959
  attr_reader :return_url
@@ -1062,7 +961,6 @@ module Stripe
1062
961
  # Attribute for field financial_connections
1063
962
  sig { returns(FinancialConnections) }
1064
963
  attr_reader :financial_connections
1065
-
1066
964
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1067
965
  #
1068
966
  # 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.
@@ -1072,7 +970,6 @@ module Stripe
1072
970
  # 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).
1073
971
  sig { returns(String) }
1074
972
  attr_reader :setup_future_usage
1075
-
1076
973
  # Bank account verification method.
1077
974
  sig { returns(String) }
1078
975
  attr_reader :verification_method
@@ -1080,151 +977,114 @@ module Stripe
1080
977
  # Attribute for field acss_debit
1081
978
  sig { returns(AcssDebit) }
1082
979
  attr_reader :acss_debit
1083
-
1084
980
  # Attribute for field affirm
1085
981
  sig { returns(Affirm) }
1086
982
  attr_reader :affirm
1087
-
1088
983
  # Attribute for field afterpay_clearpay
1089
984
  sig { returns(AfterpayClearpay) }
1090
985
  attr_reader :afterpay_clearpay
1091
-
1092
986
  # Attribute for field alipay
1093
987
  sig { returns(Alipay) }
1094
988
  attr_reader :alipay
1095
-
1096
989
  # Attribute for field amazon_pay
1097
990
  sig { returns(AmazonPay) }
1098
991
  attr_reader :amazon_pay
1099
-
1100
992
  # Attribute for field au_becs_debit
1101
993
  sig { returns(AuBecsDebit) }
1102
994
  attr_reader :au_becs_debit
1103
-
1104
995
  # Attribute for field bacs_debit
1105
996
  sig { returns(BacsDebit) }
1106
997
  attr_reader :bacs_debit
1107
-
1108
998
  # Attribute for field bancontact
1109
999
  sig { returns(Bancontact) }
1110
1000
  attr_reader :bancontact
1111
-
1112
1001
  # Attribute for field boleto
1113
1002
  sig { returns(Boleto) }
1114
1003
  attr_reader :boleto
1115
-
1116
1004
  # Attribute for field card
1117
1005
  sig { returns(Card) }
1118
1006
  attr_reader :card
1119
-
1120
1007
  # Attribute for field cashapp
1121
1008
  sig { returns(Cashapp) }
1122
1009
  attr_reader :cashapp
1123
-
1124
1010
  # Attribute for field customer_balance
1125
1011
  sig { returns(CustomerBalance) }
1126
1012
  attr_reader :customer_balance
1127
-
1128
1013
  # Attribute for field eps
1129
1014
  sig { returns(Eps) }
1130
1015
  attr_reader :eps
1131
-
1132
1016
  # Attribute for field fpx
1133
1017
  sig { returns(Fpx) }
1134
1018
  attr_reader :fpx
1135
-
1136
1019
  # Attribute for field giropay
1137
1020
  sig { returns(Giropay) }
1138
1021
  attr_reader :giropay
1139
-
1140
1022
  # Attribute for field grabpay
1141
1023
  sig { returns(Grabpay) }
1142
1024
  attr_reader :grabpay
1143
-
1144
1025
  # Attribute for field ideal
1145
1026
  sig { returns(Ideal) }
1146
1027
  attr_reader :ideal
1147
-
1148
1028
  # Attribute for field kakao_pay
1149
1029
  sig { returns(KakaoPay) }
1150
1030
  attr_reader :kakao_pay
1151
-
1152
1031
  # Attribute for field klarna
1153
1032
  sig { returns(Klarna) }
1154
1033
  attr_reader :klarna
1155
-
1156
1034
  # Attribute for field konbini
1157
1035
  sig { returns(Konbini) }
1158
1036
  attr_reader :konbini
1159
-
1160
1037
  # Attribute for field kr_card
1161
1038
  sig { returns(KrCard) }
1162
1039
  attr_reader :kr_card
1163
-
1164
1040
  # Attribute for field link
1165
1041
  sig { returns(Link) }
1166
1042
  attr_reader :link
1167
-
1168
1043
  # Attribute for field mobilepay
1169
1044
  sig { returns(Mobilepay) }
1170
1045
  attr_reader :mobilepay
1171
-
1172
1046
  # Attribute for field multibanco
1173
1047
  sig { returns(Multibanco) }
1174
1048
  attr_reader :multibanco
1175
-
1176
1049
  # Attribute for field naver_pay
1177
1050
  sig { returns(NaverPay) }
1178
1051
  attr_reader :naver_pay
1179
-
1180
1052
  # Attribute for field oxxo
1181
1053
  sig { returns(Oxxo) }
1182
1054
  attr_reader :oxxo
1183
-
1184
1055
  # Attribute for field p24
1185
1056
  sig { returns(P24) }
1186
1057
  attr_reader :p24
1187
-
1188
1058
  # Attribute for field payco
1189
1059
  sig { returns(Payco) }
1190
1060
  attr_reader :payco
1191
-
1192
1061
  # Attribute for field paynow
1193
1062
  sig { returns(Paynow) }
1194
1063
  attr_reader :paynow
1195
-
1196
1064
  # Attribute for field paypal
1197
1065
  sig { returns(Paypal) }
1198
1066
  attr_reader :paypal
1199
-
1200
1067
  # Attribute for field payto
1201
1068
  sig { returns(Payto) }
1202
1069
  attr_reader :payto
1203
-
1204
1070
  # Attribute for field pix
1205
1071
  sig { returns(Pix) }
1206
1072
  attr_reader :pix
1207
-
1208
1073
  # Attribute for field revolut_pay
1209
1074
  sig { returns(RevolutPay) }
1210
1075
  attr_reader :revolut_pay
1211
-
1212
1076
  # Attribute for field samsung_pay
1213
1077
  sig { returns(SamsungPay) }
1214
1078
  attr_reader :samsung_pay
1215
-
1216
1079
  # Attribute for field sepa_debit
1217
1080
  sig { returns(SepaDebit) }
1218
1081
  attr_reader :sepa_debit
1219
-
1220
1082
  # Attribute for field sofort
1221
1083
  sig { returns(Sofort) }
1222
1084
  attr_reader :sofort
1223
-
1224
1085
  # Attribute for field swish
1225
1086
  sig { returns(Swish) }
1226
1087
  attr_reader :swish
1227
-
1228
1088
  # Attribute for field us_bank_account
1229
1089
  sig { returns(UsBankAccount) }
1230
1090
  attr_reader :us_bank_account
@@ -1238,7 +1098,6 @@ module Stripe
1238
1098
  # When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
1239
1099
  sig { returns(T.nilable(String)) }
1240
1100
  attr_reader :line_items
1241
-
1242
1101
  # Determines which entity is allowed to update the shipping details.
1243
1102
  #
1244
1103
  # Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
@@ -1260,18 +1119,16 @@ module Stripe
1260
1119
  # Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
1261
1120
  sig { returns(T.nilable(T::Array[String])) }
1262
1121
  attr_reader :allow_redisplay_filters
1263
-
1264
1122
  # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
1265
1123
  sig { returns(T.nilable(String)) }
1266
1124
  attr_reader :payment_method_remove
1267
-
1268
1125
  # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
1269
1126
  sig { returns(T.nilable(String)) }
1270
1127
  attr_reader :payment_method_save
1271
1128
  end
1272
1129
  class ShippingAddressCollection < Stripe::StripeObject
1273
1130
  # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1274
- # shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.
1131
+ # shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.
1275
1132
  sig { returns(T::Array[String]) }
1276
1133
  attr_reader :allowed_countries
1277
1134
  end
@@ -1280,17 +1137,14 @@ module Stripe
1280
1137
  # Amount of tax applied for this rate.
1281
1138
  sig { returns(Integer) }
1282
1139
  attr_reader :amount
1283
-
1284
1140
  # Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
1285
1141
  #
1286
1142
  # Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
1287
1143
  sig { returns(Stripe::TaxRate) }
1288
1144
  attr_reader :rate
1289
-
1290
1145
  # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
1291
1146
  sig { returns(T.nilable(String)) }
1292
1147
  attr_reader :taxability_reason
1293
-
1294
1148
  # The amount on which tax is calculated, in cents (or local equivalent).
1295
1149
  sig { returns(T.nilable(Integer)) }
1296
1150
  attr_reader :taxable_amount
@@ -1298,19 +1152,15 @@ module Stripe
1298
1152
  # Total shipping cost before any discounts or taxes are applied.
1299
1153
  sig { returns(Integer) }
1300
1154
  attr_reader :amount_subtotal
1301
-
1302
1155
  # Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
1303
1156
  sig { returns(Integer) }
1304
1157
  attr_reader :amount_tax
1305
-
1306
1158
  # Total shipping cost after discounts and taxes are applied.
1307
1159
  sig { returns(Integer) }
1308
1160
  attr_reader :amount_total
1309
-
1310
1161
  # The ID of the ShippingRate for this order.
1311
1162
  sig { returns(T.nilable(T.any(String, Stripe::ShippingRate))) }
1312
1163
  attr_reader :shipping_rate
1313
-
1314
1164
  # The taxes applied to the shipping rate.
1315
1165
  sig { returns(T::Array[Tax]) }
1316
1166
  attr_reader :taxes
@@ -1320,23 +1170,18 @@ module Stripe
1320
1170
  # City, district, suburb, town, or village.
1321
1171
  sig { returns(T.nilable(String)) }
1322
1172
  attr_reader :city
1323
-
1324
1173
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1325
1174
  sig { returns(T.nilable(String)) }
1326
1175
  attr_reader :country
1327
-
1328
1176
  # Address line 1 (e.g., street, PO Box, or company name).
1329
1177
  sig { returns(T.nilable(String)) }
1330
1178
  attr_reader :line1
1331
-
1332
1179
  # Address line 2 (e.g., apartment, suite, unit, or building).
1333
1180
  sig { returns(T.nilable(String)) }
1334
1181
  attr_reader :line2
1335
-
1336
1182
  # ZIP or postal code.
1337
1183
  sig { returns(T.nilable(String)) }
1338
1184
  attr_reader :postal_code
1339
-
1340
1185
  # State, county, province, or region.
1341
1186
  sig { returns(T.nilable(String)) }
1342
1187
  attr_reader :state
@@ -1344,19 +1189,15 @@ module Stripe
1344
1189
  # Attribute for field address
1345
1190
  sig { returns(Address) }
1346
1191
  attr_reader :address
1347
-
1348
1192
  # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1349
1193
  sig { returns(T.nilable(String)) }
1350
1194
  attr_reader :carrier
1351
-
1352
1195
  # Recipient name.
1353
1196
  sig { returns(String) }
1354
1197
  attr_reader :name
1355
-
1356
1198
  # Recipient phone (including extension).
1357
1199
  sig { returns(T.nilable(String)) }
1358
1200
  attr_reader :phone
1359
-
1360
1201
  # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
1361
1202
  sig { returns(T.nilable(String)) }
1362
1203
  attr_reader :tracking_number
@@ -1365,7 +1206,6 @@ module Stripe
1365
1206
  # A non-negative integer in cents representing how much to charge.
1366
1207
  sig { returns(Integer) }
1367
1208
  attr_reader :shipping_amount
1368
-
1369
1209
  # The shipping rate.
1370
1210
  sig { returns(T.any(String, Stripe::ShippingRate)) }
1371
1211
  attr_reader :shipping_rate
@@ -1374,7 +1214,6 @@ module Stripe
1374
1214
  # Indicates whether tax ID collection is enabled for the session
1375
1215
  sig { returns(T::Boolean) }
1376
1216
  attr_reader :enabled
1377
-
1378
1217
  # Indicates whether a tax ID is required on the payment page
1379
1218
  sig { returns(String) }
1380
1219
  attr_reader :required
@@ -1385,7 +1224,6 @@ module Stripe
1385
1224
  # The amount discounted.
1386
1225
  sig { returns(Integer) }
1387
1226
  attr_reader :amount
1388
-
1389
1227
  # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
1390
1228
  # It contains information about when the discount began, when it will end, and what it is applied to.
1391
1229
  #
@@ -1397,17 +1235,14 @@ module Stripe
1397
1235
  # Amount of tax applied for this rate.
1398
1236
  sig { returns(Integer) }
1399
1237
  attr_reader :amount
1400
-
1401
1238
  # Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
1402
1239
  #
1403
1240
  # Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
1404
1241
  sig { returns(Stripe::TaxRate) }
1405
1242
  attr_reader :rate
1406
-
1407
1243
  # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
1408
1244
  sig { returns(T.nilable(String)) }
1409
1245
  attr_reader :taxability_reason
1410
-
1411
1246
  # The amount on which tax is calculated, in cents (or local equivalent).
1412
1247
  sig { returns(T.nilable(Integer)) }
1413
1248
  attr_reader :taxable_amount
@@ -1415,7 +1250,6 @@ module Stripe
1415
1250
  # The aggregated discounts.
1416
1251
  sig { returns(T::Array[Discount]) }
1417
1252
  attr_reader :discounts
1418
-
1419
1253
  # The aggregated tax amounts by rate.
1420
1254
  sig { returns(T::Array[Tax]) }
1421
1255
  attr_reader :taxes
@@ -1423,15 +1257,12 @@ module Stripe
1423
1257
  # This is the sum of all the discounts.
1424
1258
  sig { returns(Integer) }
1425
1259
  attr_reader :amount_discount
1426
-
1427
1260
  # This is the sum of all the shipping amounts.
1428
1261
  sig { returns(T.nilable(Integer)) }
1429
1262
  attr_reader :amount_shipping
1430
-
1431
1263
  # This is the sum of all the tax amounts.
1432
1264
  sig { returns(Integer) }
1433
1265
  attr_reader :amount_tax
1434
-
1435
1266
  # Attribute for field breakdown
1436
1267
  sig { returns(Breakdown) }
1437
1268
  attr_reader :breakdown
@@ -1439,77 +1270,59 @@ module Stripe
1439
1270
  # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
1440
1271
  sig { returns(T.nilable(AdaptivePricing)) }
1441
1272
  attr_reader :adaptive_pricing
1442
-
1443
1273
  # When set, provides configuration for actions to take if this Checkout Session expires.
1444
1274
  sig { returns(T.nilable(AfterExpiration)) }
1445
1275
  attr_reader :after_expiration
1446
-
1447
1276
  # Enables user redeemable promotion codes.
1448
1277
  sig { returns(T.nilable(T::Boolean)) }
1449
1278
  attr_reader :allow_promotion_codes
1450
-
1451
1279
  # Total of all items before discounts or taxes are applied.
1452
1280
  sig { returns(T.nilable(Integer)) }
1453
1281
  attr_reader :amount_subtotal
1454
-
1455
1282
  # Total of all items after discounts and taxes are applied.
1456
1283
  sig { returns(T.nilable(Integer)) }
1457
1284
  attr_reader :amount_total
1458
-
1459
1285
  # Attribute for field automatic_tax
1460
1286
  sig { returns(AutomaticTax) }
1461
1287
  attr_reader :automatic_tax
1462
-
1463
1288
  # Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.
1464
1289
  sig { returns(T.nilable(String)) }
1465
1290
  attr_reader :billing_address_collection
1466
-
1467
1291
  # If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
1468
1292
  sig { returns(T.nilable(String)) }
1469
1293
  attr_reader :cancel_url
1470
-
1471
1294
  # A unique string to reference the Checkout Session. This can be a
1472
1295
  # customer ID, a cart ID, or similar, and can be used to reconcile the
1473
1296
  # Session with your internal systems.
1474
1297
  sig { returns(T.nilable(String)) }
1475
1298
  attr_reader :client_reference_id
1476
-
1477
1299
  # The client secret of the Session. Use this with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
1478
1300
  sig { returns(T.nilable(String)) }
1479
1301
  attr_reader :client_secret
1480
-
1481
1302
  # Information about the customer collected within the Checkout Session.
1482
1303
  sig { returns(T.nilable(CollectedInformation)) }
1483
1304
  attr_reader :collected_information
1484
-
1485
1305
  # Results of `consent_collection` for this session.
1486
1306
  sig { returns(T.nilable(Consent)) }
1487
1307
  attr_reader :consent
1488
-
1489
1308
  # When set, provides configuration for the Checkout Session to gather active consent from customers.
1490
1309
  sig { returns(T.nilable(ConsentCollection)) }
1491
1310
  attr_reader :consent_collection
1492
-
1493
1311
  # Time at which the object was created. Measured in seconds since the Unix epoch.
1494
1312
  sig { returns(Integer) }
1495
1313
  attr_reader :created
1496
-
1497
1314
  # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
1498
1315
  sig { returns(T.nilable(String)) }
1499
1316
  attr_reader :currency
1500
-
1501
1317
  # Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions
1502
1318
  sig { returns(T.nilable(CurrencyConversion)) }
1503
1319
  attr_reader :currency_conversion
1504
-
1505
1320
  # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
1506
1321
  sig { returns(T::Array[CustomField]) }
1507
1322
  attr_reader :custom_fields
1508
-
1509
1323
  # Attribute for field custom_text
1510
1324
  sig { returns(CustomText) }
1511
1325
  attr_reader :custom_text
1512
-
1513
1326
  # The ID of the customer for this Session.
1514
1327
  # For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout
1515
1328
  # will create a new customer object based on information provided
@@ -1517,15 +1330,12 @@ module Stripe
1517
1330
  # the Session was created.
1518
1331
  sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
1519
1332
  attr_reader :customer
1520
-
1521
1333
  # Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
1522
1334
  sig { returns(T.nilable(String)) }
1523
1335
  attr_reader :customer_creation
1524
-
1525
1336
  # The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.
1526
1337
  sig { returns(T.nilable(CustomerDetails)) }
1527
1338
  attr_reader :customer_details
1528
-
1529
1339
  # If provided, this value will be used when the Customer object is created.
1530
1340
  # If not provided, customers will be asked to enter their email address.
1531
1341
  # Use this parameter to prefill customer data if you already have an email
@@ -1533,177 +1343,139 @@ module Stripe
1533
1343
  # complete, use the `customer` attribute.
1534
1344
  sig { returns(T.nilable(String)) }
1535
1345
  attr_reader :customer_email
1536
-
1346
+ # List of coupons and promotion codes attached to the Checkout Session.
1347
+ sig { returns(T.nilable(T::Array[Discount])) }
1348
+ attr_reader :discounts
1537
1349
  # The timestamp at which the Checkout Session will expire.
1538
1350
  sig { returns(Integer) }
1539
1351
  attr_reader :expires_at
1540
-
1541
1352
  # Unique identifier for the object.
1542
1353
  sig { returns(String) }
1543
1354
  attr_reader :id
1544
-
1545
1355
  # ID of the invoice created by the Checkout Session, if it exists.
1546
1356
  sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
1547
1357
  attr_reader :invoice
1548
-
1549
1358
  # Details on the state of invoice creation for the Checkout Session.
1550
1359
  sig { returns(T.nilable(InvoiceCreation)) }
1551
1360
  attr_reader :invoice_creation
1552
-
1553
1361
  # The line items purchased by the customer.
1554
1362
  sig { returns(Stripe::ListObject) }
1555
1363
  attr_reader :line_items
1556
-
1557
1364
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
1558
1365
  sig { returns(T::Boolean) }
1559
1366
  attr_reader :livemode
1560
-
1561
1367
  # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
1562
1368
  sig { returns(T.nilable(String)) }
1563
1369
  attr_reader :locale
1564
-
1565
1370
  # 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.
1566
1371
  sig { returns(T.nilable(T::Hash[String, String])) }
1567
1372
  attr_reader :metadata
1568
-
1569
1373
  # The mode of the Checkout Session.
1570
1374
  sig { returns(String) }
1571
1375
  attr_reader :mode
1572
-
1573
1376
  # String representing the object's type. Objects of the same type share the same value.
1574
1377
  sig { returns(String) }
1575
1378
  attr_reader :object
1576
-
1577
1379
  # 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.
1578
1380
  sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
1579
1381
  attr_reader :payment_intent
1580
-
1581
1382
  # The ID of the Payment Link that created this Session.
1582
1383
  sig { returns(T.nilable(T.any(String, Stripe::PaymentLink))) }
1583
1384
  attr_reader :payment_link
1584
-
1585
1385
  # Configure whether a Checkout Session should collect a payment method. Defaults to `always`.
1586
1386
  sig { returns(T.nilable(String)) }
1587
1387
  attr_reader :payment_method_collection
1588
-
1589
1388
  # Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
1590
1389
  sig { returns(T.nilable(PaymentMethodConfigurationDetails)) }
1591
1390
  attr_reader :payment_method_configuration_details
1592
-
1593
1391
  # Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
1594
1392
  sig { returns(T.nilable(PaymentMethodOptions)) }
1595
1393
  attr_reader :payment_method_options
1596
-
1597
1394
  # A list of the types of payment methods (e.g. card) this Checkout
1598
1395
  # Session is allowed to accept.
1599
1396
  sig { returns(T::Array[String]) }
1600
1397
  attr_reader :payment_method_types
1601
-
1602
1398
  # The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.
1603
1399
  # You can use this value to decide when to fulfill your customer's order.
1604
1400
  sig { returns(String) }
1605
1401
  attr_reader :payment_status
1606
-
1607
1402
  # This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
1608
1403
  #
1609
1404
  # For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
1610
1405
  sig { returns(T.nilable(Permissions)) }
1611
1406
  attr_reader :permissions
1612
-
1613
1407
  # Attribute for field phone_number_collection
1614
1408
  sig { returns(PhoneNumberCollection) }
1615
1409
  attr_reader :phone_number_collection
1616
-
1617
1410
  # The ID of the original expired Checkout Session that triggered the recovery flow.
1618
1411
  sig { returns(T.nilable(String)) }
1619
1412
  attr_reader :recovered_from
1620
-
1621
1413
  # This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
1622
1414
  sig { returns(String) }
1623
1415
  attr_reader :redirect_on_completion
1624
-
1625
1416
  # Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
1626
1417
  sig { returns(String) }
1627
1418
  attr_reader :return_url
1628
-
1629
1419
  # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
1630
1420
  sig { returns(T.nilable(SavedPaymentMethodOptions)) }
1631
1421
  attr_reader :saved_payment_method_options
1632
-
1633
1422
  # The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
1634
1423
  sig { returns(T.nilable(T.any(String, Stripe::SetupIntent))) }
1635
1424
  attr_reader :setup_intent
1636
-
1637
1425
  # When set, provides configuration for Checkout to collect a shipping address from a customer.
1638
1426
  sig { returns(T.nilable(ShippingAddressCollection)) }
1639
1427
  attr_reader :shipping_address_collection
1640
-
1641
1428
  # The details of the customer cost of shipping, including the customer chosen ShippingRate.
1642
1429
  sig { returns(T.nilable(ShippingCost)) }
1643
1430
  attr_reader :shipping_cost
1644
-
1645
1431
  # Shipping information for this Checkout Session.
1646
1432
  sig { returns(T.nilable(ShippingDetails)) }
1647
1433
  attr_reader :shipping_details
1648
-
1649
1434
  # The shipping rate options applied to this Session.
1650
1435
  sig { returns(T::Array[ShippingOption]) }
1651
1436
  attr_reader :shipping_options
1652
-
1653
1437
  # The status of the Checkout Session, one of `open`, `complete`, or `expired`.
1654
1438
  sig { returns(T.nilable(String)) }
1655
1439
  attr_reader :status
1656
-
1657
1440
  # Describes the type of transaction being performed by Checkout in order to customize
1658
1441
  # relevant text on the page, such as the submit button. `submit_type` can only be
1659
1442
  # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
1660
1443
  sig { returns(T.nilable(String)) }
1661
1444
  attr_reader :submit_type
1662
-
1663
1445
  # The ID of the subscription for Checkout Sessions in `subscription` mode.
1664
1446
  sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
1665
1447
  attr_reader :subscription
1666
-
1667
1448
  # The URL the customer will be directed to after the payment or
1668
1449
  # subscription creation is successful.
1669
1450
  sig { returns(T.nilable(String)) }
1670
1451
  attr_reader :success_url
1671
-
1672
1452
  # Attribute for field tax_id_collection
1673
1453
  sig { returns(TaxIdCollection) }
1674
1454
  attr_reader :tax_id_collection
1675
-
1676
1455
  # Tax and discount details for the computed total amount.
1677
1456
  sig { returns(T.nilable(TotalDetails)) }
1678
1457
  attr_reader :total_details
1679
-
1680
1458
  # The UI mode of the Session. Defaults to `hosted`.
1681
1459
  sig { returns(T.nilable(String)) }
1682
1460
  attr_reader :ui_mode
1683
-
1684
1461
  # The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`
1685
1462
  # This value is only present when the session is active.
1686
1463
  sig { returns(T.nilable(String)) }
1687
1464
  attr_reader :url
1688
-
1689
1465
  class ListParams < Stripe::RequestParams
1690
1466
  class Created < Stripe::RequestParams
1691
1467
  # Minimum value to filter by (exclusive)
1692
1468
  sig { returns(Integer) }
1693
1469
  attr_accessor :gt
1694
-
1695
1470
  # Minimum value to filter by (inclusive)
1696
1471
  sig { returns(Integer) }
1697
1472
  attr_accessor :gte
1698
-
1699
1473
  # Maximum value to filter by (exclusive)
1700
1474
  sig { returns(Integer) }
1701
1475
  attr_accessor :lt
1702
-
1703
1476
  # Maximum value to filter by (inclusive)
1704
1477
  sig { returns(Integer) }
1705
1478
  attr_accessor :lte
1706
-
1707
1479
  sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
1708
1480
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
1709
1481
  end
@@ -1711,54 +1483,42 @@ module Stripe
1711
1483
  # Customer's email address.
1712
1484
  sig { returns(String) }
1713
1485
  attr_accessor :email
1714
-
1715
1486
  sig { params(email: String).void }
1716
1487
  def initialize(email: nil); end
1717
1488
  end
1718
1489
  # Only return Checkout Sessions that were created during the given date interval.
1719
1490
  sig { returns(T.any(::Stripe::Checkout::Session::ListParams::Created, Integer)) }
1720
1491
  attr_accessor :created
1721
-
1722
1492
  # Only return the Checkout Sessions for the Customer specified.
1723
1493
  sig { returns(String) }
1724
1494
  attr_accessor :customer
1725
-
1726
1495
  # Only return the Checkout Sessions for the Customer details specified.
1727
1496
  sig { returns(::Stripe::Checkout::Session::ListParams::CustomerDetails) }
1728
1497
  attr_accessor :customer_details
1729
-
1730
1498
  # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
1731
1499
  sig { returns(String) }
1732
1500
  attr_accessor :ending_before
1733
-
1734
1501
  # Specifies which fields in the response should be expanded.
1735
1502
  sig { returns(T::Array[String]) }
1736
1503
  attr_accessor :expand
1737
-
1738
1504
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1739
1505
  sig { returns(Integer) }
1740
1506
  attr_accessor :limit
1741
-
1742
1507
  # Only return the Checkout Session for the PaymentIntent specified.
1743
1508
  sig { returns(String) }
1744
1509
  attr_accessor :payment_intent
1745
-
1746
1510
  # Only return the Checkout Sessions for the Payment Link specified.
1747
1511
  sig { returns(String) }
1748
1512
  attr_accessor :payment_link
1749
-
1750
1513
  # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
1751
1514
  sig { returns(String) }
1752
1515
  attr_accessor :starting_after
1753
-
1754
1516
  # Only return the Checkout Sessions matching the given status.
1755
1517
  sig { returns(String) }
1756
1518
  attr_accessor :status
1757
-
1758
1519
  # Only return the Checkout Session for the subscription specified.
1759
1520
  sig { returns(String) }
1760
1521
  attr_accessor :subscription
1761
-
1762
1522
  sig {
1763
1523
  params(created: T.any(::Stripe::Checkout::Session::ListParams::Created, Integer), customer: String, customer_details: ::Stripe::Checkout::Session::ListParams::CustomerDetails, ending_before: String, expand: T::Array[String], limit: Integer, payment_intent: String, payment_link: String, starting_after: String, status: String, subscription: String).void
1764
1524
  }
@@ -1781,7 +1541,6 @@ module Stripe
1781
1541
  # Set to `true` to enable [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
1782
1542
  sig { returns(T::Boolean) }
1783
1543
  attr_accessor :enabled
1784
-
1785
1544
  sig { params(enabled: T::Boolean).void }
1786
1545
  def initialize(enabled: nil); end
1787
1546
  end
@@ -1790,20 +1549,17 @@ module Stripe
1790
1549
  # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
1791
1550
  sig { returns(T::Boolean) }
1792
1551
  attr_accessor :allow_promotion_codes
1793
-
1794
1552
  # If `true`, a recovery URL will be generated to recover this Checkout Session if it
1795
1553
  # expires before a successful transaction is completed. It will be attached to the
1796
1554
  # Checkout Session object upon expiration.
1797
1555
  sig { returns(T::Boolean) }
1798
1556
  attr_accessor :enabled
1799
-
1800
1557
  sig { params(allow_promotion_codes: T::Boolean, enabled: T::Boolean).void }
1801
1558
  def initialize(allow_promotion_codes: nil, enabled: nil); end
1802
1559
  end
1803
1560
  # Configure a Checkout Session that can be used to recover an expired session.
1804
1561
  sig { returns(::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery) }
1805
1562
  attr_accessor :recovery
1806
-
1807
1563
  sig {
1808
1564
  params(recovery: ::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery).void
1809
1565
  }
@@ -1814,11 +1570,9 @@ module Stripe
1814
1570
  # The connected account being referenced when `type` is `account`.
1815
1571
  sig { returns(String) }
1816
1572
  attr_accessor :account
1817
-
1818
1573
  # Type of the account referenced in the request.
1819
1574
  sig { returns(String) }
1820
1575
  attr_accessor :type
1821
-
1822
1576
  sig { params(account: String, type: String).void }
1823
1577
  def initialize(account: nil, type: nil); end
1824
1578
  end
@@ -1827,11 +1581,9 @@ module Stripe
1827
1581
  # Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
1828
1582
  sig { returns(T::Boolean) }
1829
1583
  attr_accessor :enabled
1830
-
1831
1584
  # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
1832
1585
  sig { returns(::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability) }
1833
1586
  attr_accessor :liability
1834
-
1835
1587
  sig {
1836
1588
  params(enabled: T::Boolean, liability: ::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability).void
1837
1589
  }
@@ -1843,7 +1595,6 @@ module Stripe
1843
1595
  # defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
1844
1596
  sig { returns(String) }
1845
1597
  attr_accessor :position
1846
-
1847
1598
  sig { params(position: String).void }
1848
1599
  def initialize(position: nil); end
1849
1600
  end
@@ -1852,18 +1603,15 @@ module Stripe
1852
1603
  returns(::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)
1853
1604
  }
1854
1605
  attr_accessor :payment_method_reuse_agreement
1855
-
1856
1606
  # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
1857
1607
  # Session will determine whether to display an option to opt into promotional communication
1858
1608
  # from the merchant depending on the customer's locale. Only available to US merchants.
1859
1609
  sig { returns(String) }
1860
1610
  attr_accessor :promotions
1861
-
1862
1611
  # If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
1863
1612
  # There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
1864
1613
  sig { returns(String) }
1865
1614
  attr_accessor :terms_of_service
1866
-
1867
1615
  sig {
1868
1616
  params(payment_method_reuse_agreement: ::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement, promotions: String, terms_of_service: String).void
1869
1617
  }
@@ -1879,24 +1627,20 @@ module Stripe
1879
1627
  # The label for the option, displayed to the customer. Up to 100 characters.
1880
1628
  sig { returns(String) }
1881
1629
  attr_accessor :label
1882
-
1883
1630
  # The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
1884
1631
  sig { returns(String) }
1885
1632
  attr_accessor :value
1886
-
1887
1633
  sig { params(label: String, value: String).void }
1888
1634
  def initialize(label: nil, value: nil); end
1889
1635
  end
1890
1636
  # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
1891
1637
  sig { returns(String) }
1892
1638
  attr_accessor :default_value
1893
-
1894
1639
  # The options available for the customer to select. Up to 200 options allowed.
1895
1640
  sig {
1896
1641
  returns(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option])
1897
1642
  }
1898
1643
  attr_accessor :options
1899
-
1900
1644
  sig {
1901
1645
  params(default_value: String, options: T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option]).void
1902
1646
  }
@@ -1906,11 +1650,9 @@ module Stripe
1906
1650
  # Custom text for the label, displayed to the customer. Up to 50 characters.
1907
1651
  sig { returns(String) }
1908
1652
  attr_accessor :custom
1909
-
1910
1653
  # The type of the label.
1911
1654
  sig { returns(String) }
1912
1655
  attr_accessor :type
1913
-
1914
1656
  sig { params(custom: String, type: String).void }
1915
1657
  def initialize(custom: nil, type: nil); end
1916
1658
  end
@@ -1918,15 +1660,12 @@ module Stripe
1918
1660
  # The value that will pre-fill the field on the payment page.
1919
1661
  sig { returns(String) }
1920
1662
  attr_accessor :default_value
1921
-
1922
1663
  # The maximum character length constraint for the customer's input.
1923
1664
  sig { returns(Integer) }
1924
1665
  attr_accessor :maximum_length
1925
-
1926
1666
  # The minimum character length requirement for the customer's input.
1927
1667
  sig { returns(Integer) }
1928
1668
  attr_accessor :minimum_length
1929
-
1930
1669
  sig {
1931
1670
  params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
1932
1671
  }
@@ -1936,15 +1675,12 @@ module Stripe
1936
1675
  # The value that will pre-fill the field on the payment page.
1937
1676
  sig { returns(String) }
1938
1677
  attr_accessor :default_value
1939
-
1940
1678
  # The maximum character length constraint for the customer's input.
1941
1679
  sig { returns(Integer) }
1942
1680
  attr_accessor :maximum_length
1943
-
1944
1681
  # The minimum character length requirement for the customer's input.
1945
1682
  sig { returns(Integer) }
1946
1683
  attr_accessor :minimum_length
1947
-
1948
1684
  sig {
1949
1685
  params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
1950
1686
  }
@@ -1953,31 +1689,24 @@ module Stripe
1953
1689
  # Configuration for `type=dropdown` fields.
1954
1690
  sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown) }
1955
1691
  attr_accessor :dropdown
1956
-
1957
1692
  # String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
1958
1693
  sig { returns(String) }
1959
1694
  attr_accessor :key
1960
-
1961
1695
  # The label for the field, displayed to the customer.
1962
1696
  sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Label) }
1963
1697
  attr_accessor :label
1964
-
1965
1698
  # Configuration for `type=numeric` fields.
1966
1699
  sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Numeric) }
1967
1700
  attr_accessor :numeric
1968
-
1969
1701
  # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
1970
1702
  sig { returns(T::Boolean) }
1971
1703
  attr_accessor :optional
1972
-
1973
1704
  # Configuration for `type=text` fields.
1974
1705
  sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Text) }
1975
1706
  attr_accessor :text
1976
-
1977
1707
  # The type of the field.
1978
1708
  sig { returns(String) }
1979
1709
  attr_accessor :type
1980
-
1981
1710
  sig {
1982
1711
  params(dropdown: ::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown, key: String, label: ::Stripe::Checkout::Session::CreateParams::CustomField::Label, numeric: ::Stripe::Checkout::Session::CreateParams::CustomField::Numeric, optional: T::Boolean, text: ::Stripe::Checkout::Session::CreateParams::CustomField::Text, type: String).void
1983
1712
  }
@@ -1996,7 +1725,6 @@ module Stripe
1996
1725
  # Text may be up to 1200 characters in length.
1997
1726
  sig { returns(String) }
1998
1727
  attr_accessor :message
1999
-
2000
1728
  sig { params(message: String).void }
2001
1729
  def initialize(message: nil); end
2002
1730
  end
@@ -2004,7 +1732,6 @@ module Stripe
2004
1732
  # Text may be up to 1200 characters in length.
2005
1733
  sig { returns(String) }
2006
1734
  attr_accessor :message
2007
-
2008
1735
  sig { params(message: String).void }
2009
1736
  def initialize(message: nil); end
2010
1737
  end
@@ -2012,7 +1739,6 @@ module Stripe
2012
1739
  # Text may be up to 1200 characters in length.
2013
1740
  sig { returns(String) }
2014
1741
  attr_accessor :message
2015
-
2016
1742
  sig { params(message: String).void }
2017
1743
  def initialize(message: nil); end
2018
1744
  end
@@ -2020,7 +1746,6 @@ module Stripe
2020
1746
  # Text may be up to 1200 characters in length.
2021
1747
  sig { returns(String) }
2022
1748
  attr_accessor :message
2023
-
2024
1749
  sig { params(message: String).void }
2025
1750
  def initialize(message: nil); end
2026
1751
  end
@@ -2029,23 +1754,19 @@ module Stripe
2029
1754
  returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit))
2030
1755
  }
2031
1756
  attr_accessor :after_submit
2032
-
2033
1757
  # Custom text that should be displayed alongside shipping address collection.
2034
1758
  sig {
2035
1759
  returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress))
2036
1760
  }
2037
1761
  attr_accessor :shipping_address
2038
-
2039
1762
  # Custom text that should be displayed alongside the payment confirmation button.
2040
1763
  sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::Submit)) }
2041
1764
  attr_accessor :submit
2042
-
2043
1765
  # Custom text that should be displayed in place of the default terms of service agreement text.
2044
1766
  sig {
2045
1767
  returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance))
2046
1768
  }
2047
1769
  attr_accessor :terms_of_service_acceptance
2048
-
2049
1770
  sig {
2050
1771
  params(after_submit: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit), shipping_address: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress), submit: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::Submit), terms_of_service_acceptance: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance)).void
2051
1772
  }
@@ -2061,16 +1782,13 @@ module Stripe
2061
1782
  # To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
2062
1783
  sig { returns(String) }
2063
1784
  attr_accessor :address
2064
-
2065
1785
  # Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
2066
1786
  sig { returns(String) }
2067
1787
  attr_accessor :name
2068
-
2069
1788
  # Describes whether Checkout saves shipping information onto `customer.shipping`.
2070
1789
  # To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
2071
1790
  sig { returns(String) }
2072
1791
  attr_accessor :shipping
2073
-
2074
1792
  sig { params(address: String, name: String, shipping: String).void }
2075
1793
  def initialize(address: nil, name: nil, shipping: nil); end
2076
1794
  end
@@ -2078,11 +1796,9 @@ module Stripe
2078
1796
  # The ID of the coupon to apply to this Session.
2079
1797
  sig { returns(String) }
2080
1798
  attr_accessor :coupon
2081
-
2082
1799
  # The ID of a promotion code to apply to this Session.
2083
1800
  sig { returns(String) }
2084
1801
  attr_accessor :promotion_code
2085
-
2086
1802
  sig { params(coupon: String, promotion_code: String).void }
2087
1803
  def initialize(coupon: nil, promotion_code: nil); end
2088
1804
  end
@@ -2092,11 +1808,9 @@ module Stripe
2092
1808
  # The name of the custom field. This may be up to 40 characters.
2093
1809
  sig { returns(String) }
2094
1810
  attr_accessor :name
2095
-
2096
1811
  # The value of the custom field. This may be up to 140 characters.
2097
1812
  sig { returns(String) }
2098
1813
  attr_accessor :value
2099
-
2100
1814
  sig { params(name: String, value: String).void }
2101
1815
  def initialize(name: nil, value: nil); end
2102
1816
  end
@@ -2104,11 +1818,9 @@ module Stripe
2104
1818
  # The connected account being referenced when `type` is `account`.
2105
1819
  sig { returns(String) }
2106
1820
  attr_accessor :account
2107
-
2108
1821
  # Type of the account referenced in the request.
2109
1822
  sig { returns(String) }
2110
1823
  attr_accessor :type
2111
-
2112
1824
  sig { params(account: String, type: String).void }
2113
1825
  def initialize(account: nil, type: nil); end
2114
1826
  end
@@ -2116,44 +1828,36 @@ module Stripe
2116
1828
  # 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.
2117
1829
  sig { returns(T.nilable(String)) }
2118
1830
  attr_accessor :amount_tax_display
2119
-
2120
1831
  sig { params(amount_tax_display: T.nilable(String)).void }
2121
1832
  def initialize(amount_tax_display: nil); end
2122
1833
  end
2123
1834
  # The account tax IDs associated with the invoice.
2124
1835
  sig { returns(T.nilable(T::Array[String])) }
2125
1836
  attr_accessor :account_tax_ids
2126
-
2127
1837
  # Default custom fields to be displayed on invoices for this customer.
2128
1838
  sig {
2129
1839
  returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField]))
2130
1840
  }
2131
1841
  attr_accessor :custom_fields
2132
-
2133
1842
  # An arbitrary string attached to the object. Often useful for displaying to users.
2134
1843
  sig { returns(String) }
2135
1844
  attr_accessor :description
2136
-
2137
1845
  # Default footer to be displayed on invoices for this customer.
2138
1846
  sig { returns(String) }
2139
1847
  attr_accessor :footer
2140
-
2141
1848
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
2142
1849
  sig {
2143
1850
  returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer)
2144
1851
  }
2145
1852
  attr_accessor :issuer
2146
-
2147
1853
  # 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`.
2148
1854
  sig { returns(T::Hash[String, String]) }
2149
1855
  attr_accessor :metadata
2150
-
2151
1856
  # Default options for invoice PDF rendering for this customer.
2152
1857
  sig {
2153
1858
  returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))
2154
1859
  }
2155
1860
  attr_accessor :rendering_options
2156
-
2157
1861
  sig {
2158
1862
  params(account_tax_ids: T.nilable(T::Array[String]), custom_fields: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField]), description: String, footer: String, issuer: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer, metadata: T::Hash[String, String], rendering_options: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)).void
2159
1863
  }
@@ -2170,11 +1874,9 @@ module Stripe
2170
1874
  # Set to `true` to enable invoice creation.
2171
1875
  sig { returns(T::Boolean) }
2172
1876
  attr_accessor :enabled
2173
-
2174
1877
  # Parameters passed when creating invoices for payment-mode Checkout Sessions.
2175
1878
  sig { returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData) }
2176
1879
  attr_accessor :invoice_data
2177
-
2178
1880
  sig {
2179
1881
  params(enabled: T::Boolean, invoice_data: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData).void
2180
1882
  }
@@ -2185,15 +1887,12 @@ module Stripe
2185
1887
  # Set to true if the quantity can be adjusted to any non-negative integer.
2186
1888
  sig { returns(T::Boolean) }
2187
1889
  attr_accessor :enabled
2188
-
2189
1890
  # The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
2190
1891
  sig { returns(Integer) }
2191
1892
  attr_accessor :maximum
2192
-
2193
1893
  # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
2194
1894
  sig { returns(Integer) }
2195
1895
  attr_accessor :minimum
2196
-
2197
1896
  sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
2198
1897
  def initialize(enabled: nil, maximum: nil, minimum: nil); end
2199
1898
  end
@@ -2202,23 +1901,18 @@ module Stripe
2202
1901
  # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
2203
1902
  sig { returns(String) }
2204
1903
  attr_accessor :description
2205
-
2206
1904
  # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
2207
1905
  sig { returns(T::Array[String]) }
2208
1906
  attr_accessor :images
2209
-
2210
1907
  # 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`.
2211
1908
  sig { returns(T::Hash[String, String]) }
2212
1909
  attr_accessor :metadata
2213
-
2214
1910
  # The product's name, meant to be displayable to the customer.
2215
1911
  sig { returns(String) }
2216
1912
  attr_accessor :name
2217
-
2218
1913
  # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
2219
1914
  sig { returns(String) }
2220
1915
  attr_accessor :tax_code
2221
-
2222
1916
  sig {
2223
1917
  params(description: String, images: T::Array[String], metadata: T::Hash[String, String], name: String, tax_code: String).void
2224
1918
  }
@@ -2234,46 +1928,37 @@ module Stripe
2234
1928
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
2235
1929
  sig { returns(String) }
2236
1930
  attr_accessor :interval
2237
-
2238
1931
  # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
2239
1932
  sig { returns(Integer) }
2240
1933
  attr_accessor :interval_count
2241
-
2242
1934
  sig { params(interval: String, interval_count: Integer).void }
2243
1935
  def initialize(interval: nil, interval_count: nil); end
2244
1936
  end
2245
1937
  # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
2246
1938
  sig { returns(String) }
2247
1939
  attr_accessor :currency
2248
-
2249
1940
  # The ID of the product that this price will belong to. One of `product` or `product_data` is required.
2250
1941
  sig { returns(String) }
2251
1942
  attr_accessor :product
2252
-
2253
1943
  # Data used to generate a new product object inline. One of `product` or `product_data` is required.
2254
1944
  sig {
2255
1945
  returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData)
2256
1946
  }
2257
1947
  attr_accessor :product_data
2258
-
2259
1948
  # The recurring components of a price such as `interval` and `interval_count`.
2260
1949
  sig {
2261
1950
  returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring)
2262
1951
  }
2263
1952
  attr_accessor :recurring
2264
-
2265
1953
  # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
2266
1954
  sig { returns(String) }
2267
1955
  attr_accessor :tax_behavior
2268
-
2269
1956
  # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
2270
1957
  sig { returns(Integer) }
2271
1958
  attr_accessor :unit_amount
2272
-
2273
1959
  # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
2274
1960
  sig { returns(String) }
2275
1961
  attr_accessor :unit_amount_decimal
2276
-
2277
1962
  sig {
2278
1963
  params(currency: String, product: String, product_data: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData, recurring: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
2279
1964
  }
@@ -2290,31 +1975,24 @@ module Stripe
2290
1975
  # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
2291
1976
  sig { returns(::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity) }
2292
1977
  attr_accessor :adjustable_quantity
2293
-
2294
1978
  # The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.
2295
1979
  sig { returns(T::Array[String]) }
2296
1980
  attr_accessor :dynamic_tax_rates
2297
-
2298
1981
  # 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`.
2299
1982
  sig { returns(T::Hash[String, String]) }
2300
1983
  attr_accessor :metadata
2301
-
2302
1984
  # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
2303
1985
  sig { returns(String) }
2304
1986
  attr_accessor :price
2305
-
2306
1987
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
2307
1988
  sig { returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData) }
2308
1989
  attr_accessor :price_data
2309
-
2310
1990
  # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
2311
1991
  sig { returns(Integer) }
2312
1992
  attr_accessor :quantity
2313
-
2314
1993
  # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
2315
1994
  sig { returns(T::Array[String]) }
2316
1995
  attr_accessor :tax_rates
2317
-
2318
1996
  sig {
2319
1997
  params(adjustable_quantity: ::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity, dynamic_tax_rates: T::Array[String], metadata: T::Hash[String, String], price: String, price_data: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData, quantity: Integer, tax_rates: T::Array[String]).void
2320
1998
  }
@@ -2334,27 +2012,21 @@ module Stripe
2334
2012
  # City, district, suburb, town, or village.
2335
2013
  sig { returns(String) }
2336
2014
  attr_accessor :city
2337
-
2338
2015
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2339
2016
  sig { returns(String) }
2340
2017
  attr_accessor :country
2341
-
2342
2018
  # Address line 1 (e.g., street, PO Box, or company name).
2343
2019
  sig { returns(String) }
2344
2020
  attr_accessor :line1
2345
-
2346
2021
  # Address line 2 (e.g., apartment, suite, unit, or building).
2347
2022
  sig { returns(String) }
2348
2023
  attr_accessor :line2
2349
-
2350
2024
  # ZIP or postal code.
2351
2025
  sig { returns(String) }
2352
2026
  attr_accessor :postal_code
2353
-
2354
2027
  # State, county, province, or region.
2355
2028
  sig { returns(String) }
2356
2029
  attr_accessor :state
2357
-
2358
2030
  sig {
2359
2031
  params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2360
2032
  }
@@ -2372,23 +2044,18 @@ module Stripe
2372
2044
  returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address)
2373
2045
  }
2374
2046
  attr_accessor :address
2375
-
2376
2047
  # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
2377
2048
  sig { returns(String) }
2378
2049
  attr_accessor :carrier
2379
-
2380
2050
  # Recipient name.
2381
2051
  sig { returns(String) }
2382
2052
  attr_accessor :name
2383
-
2384
2053
  # Recipient phone (including extension).
2385
2054
  sig { returns(String) }
2386
2055
  attr_accessor :phone
2387
-
2388
2056
  # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
2389
2057
  sig { returns(String) }
2390
2058
  attr_accessor :tracking_number
2391
-
2392
2059
  sig {
2393
2060
  params(address: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
2394
2061
  }
@@ -2404,43 +2071,35 @@ module Stripe
2404
2071
  # The amount that will be transferred automatically when a charge succeeds.
2405
2072
  sig { returns(Integer) }
2406
2073
  attr_accessor :amount
2407
-
2408
2074
  # If specified, successful charges will be attributed to the destination
2409
2075
  # account for tax reporting, and the funds from charges will be transferred
2410
2076
  # to the destination account. The ID of the resulting transfer will be
2411
2077
  # returned on the successful charge's `transfer` field.
2412
2078
  sig { returns(String) }
2413
2079
  attr_accessor :destination
2414
-
2415
2080
  sig { params(amount: Integer, destination: String).void }
2416
2081
  def initialize(amount: nil, destination: nil); end
2417
2082
  end
2418
2083
  # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
2419
2084
  sig { returns(Integer) }
2420
2085
  attr_accessor :application_fee_amount
2421
-
2422
2086
  # Controls when the funds will be captured from the customer's account.
2423
2087
  sig { returns(String) }
2424
2088
  attr_accessor :capture_method
2425
-
2426
2089
  # An arbitrary string attached to the object. Often useful for displaying to users.
2427
2090
  sig { returns(String) }
2428
2091
  attr_accessor :description
2429
-
2430
2092
  # 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`.
2431
2093
  sig { returns(T::Hash[String, String]) }
2432
2094
  attr_accessor :metadata
2433
-
2434
2095
  # The Stripe account ID for which these funds are intended. For details,
2435
2096
  # see the PaymentIntents [use case for connected
2436
2097
  # accounts](/docs/payments/connected-accounts).
2437
2098
  sig { returns(String) }
2438
2099
  attr_accessor :on_behalf_of
2439
-
2440
2100
  # Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
2441
2101
  sig { returns(String) }
2442
2102
  attr_accessor :receipt_email
2443
-
2444
2103
  # Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
2445
2104
  # method collected by this Checkout Session.
2446
2105
  #
@@ -2463,32 +2122,26 @@ module Stripe
2463
2122
  # legislation and network rules, such as SCA.
2464
2123
  sig { returns(String) }
2465
2124
  attr_accessor :setup_future_usage
2466
-
2467
2125
  # Shipping information for this payment.
2468
2126
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping) }
2469
2127
  attr_accessor :shipping
2470
-
2471
2128
  # Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
2472
2129
  #
2473
2130
  # Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
2474
2131
  sig { returns(String) }
2475
2132
  attr_accessor :statement_descriptor
2476
-
2477
2133
  # Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
2478
2134
  sig { returns(String) }
2479
2135
  attr_accessor :statement_descriptor_suffix
2480
-
2481
2136
  # The parameters used to automatically create a Transfer when the payment succeeds.
2482
2137
  # For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
2483
2138
  sig {
2484
2139
  returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData)
2485
2140
  }
2486
2141
  attr_accessor :transfer_data
2487
-
2488
2142
  # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
2489
2143
  sig { returns(String) }
2490
2144
  attr_accessor :transfer_group
2491
-
2492
2145
  sig {
2493
2146
  params(application_fee_amount: Integer, capture_method: String, description: String, metadata: T::Hash[String, String], on_behalf_of: String, receipt_email: String, setup_future_usage: String, shipping: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping, statement_descriptor: String, statement_descriptor_suffix: String, transfer_data: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData, transfer_group: String).void
2494
2147
  }
@@ -2511,7 +2164,6 @@ module Stripe
2511
2164
  # Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.
2512
2165
  sig { returns(String) }
2513
2166
  attr_accessor :allow_redisplay
2514
-
2515
2167
  sig { params(allow_redisplay: String).void }
2516
2168
  def initialize(allow_redisplay: nil); end
2517
2169
  end
@@ -2523,23 +2175,18 @@ module Stripe
2523
2175
  # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
2524
2176
  sig { returns(T.nilable(String)) }
2525
2177
  attr_accessor :custom_mandate_url
2526
-
2527
2178
  # List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
2528
2179
  sig { returns(T::Array[String]) }
2529
2180
  attr_accessor :default_for
2530
-
2531
2181
  # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
2532
2182
  sig { returns(String) }
2533
2183
  attr_accessor :interval_description
2534
-
2535
2184
  # Payment schedule for the mandate.
2536
2185
  sig { returns(String) }
2537
2186
  attr_accessor :payment_schedule
2538
-
2539
2187
  # Transaction type of the mandate.
2540
2188
  sig { returns(String) }
2541
2189
  attr_accessor :transaction_type
2542
-
2543
2190
  sig {
2544
2191
  params(custom_mandate_url: T.nilable(String), default_for: T::Array[String], interval_description: String, payment_schedule: String, transaction_type: String).void
2545
2192
  }
@@ -2554,13 +2201,11 @@ module Stripe
2554
2201
  # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). This is only accepted for Checkout Sessions in `setup` mode.
2555
2202
  sig { returns(String) }
2556
2203
  attr_accessor :currency
2557
-
2558
2204
  # Additional fields for Mandate creation
2559
2205
  sig {
2560
2206
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)
2561
2207
  }
2562
2208
  attr_accessor :mandate_options
2563
-
2564
2209
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2565
2210
  #
2566
2211
  # 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.
@@ -2570,11 +2215,9 @@ module Stripe
2570
2215
  # 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).
2571
2216
  sig { returns(String) }
2572
2217
  attr_accessor :setup_future_usage
2573
-
2574
2218
  # Verification method for the intent
2575
2219
  sig { returns(String) }
2576
2220
  attr_accessor :verification_method
2577
-
2578
2221
  sig {
2579
2222
  params(currency: String, mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: String, verification_method: String).void
2580
2223
  }
@@ -2595,7 +2238,6 @@ module Stripe
2595
2238
  # 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).
2596
2239
  sig { returns(String) }
2597
2240
  attr_accessor :setup_future_usage
2598
-
2599
2241
  sig { params(setup_future_usage: String).void }
2600
2242
  def initialize(setup_future_usage: nil); end
2601
2243
  end
@@ -2609,7 +2251,6 @@ module Stripe
2609
2251
  # 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).
2610
2252
  sig { returns(String) }
2611
2253
  attr_accessor :setup_future_usage
2612
-
2613
2254
  sig { params(setup_future_usage: String).void }
2614
2255
  def initialize(setup_future_usage: nil); end
2615
2256
  end
@@ -2623,7 +2264,6 @@ module Stripe
2623
2264
  # 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).
2624
2265
  sig { returns(String) }
2625
2266
  attr_accessor :setup_future_usage
2626
-
2627
2267
  sig { params(setup_future_usage: String).void }
2628
2268
  def initialize(setup_future_usage: nil); end
2629
2269
  end
@@ -2637,7 +2277,6 @@ module Stripe
2637
2277
  # 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).
2638
2278
  sig { returns(String) }
2639
2279
  attr_accessor :setup_future_usage
2640
-
2641
2280
  sig { params(setup_future_usage: String).void }
2642
2281
  def initialize(setup_future_usage: nil); end
2643
2282
  end
@@ -2651,7 +2290,6 @@ module Stripe
2651
2290
  # 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).
2652
2291
  sig { returns(String) }
2653
2292
  attr_accessor :setup_future_usage
2654
-
2655
2293
  sig { params(setup_future_usage: String).void }
2656
2294
  def initialize(setup_future_usage: nil); end
2657
2295
  end
@@ -2660,7 +2298,6 @@ module Stripe
2660
2298
  # 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'.
2661
2299
  sig { returns(T.nilable(String)) }
2662
2300
  attr_accessor :reference_prefix
2663
-
2664
2301
  sig { params(reference_prefix: T.nilable(String)).void }
2665
2302
  def initialize(reference_prefix: nil); end
2666
2303
  end
@@ -2669,7 +2306,6 @@ module Stripe
2669
2306
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)
2670
2307
  }
2671
2308
  attr_accessor :mandate_options
2672
-
2673
2309
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2674
2310
  #
2675
2311
  # 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.
@@ -2679,7 +2315,6 @@ module Stripe
2679
2315
  # 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).
2680
2316
  sig { returns(String) }
2681
2317
  attr_accessor :setup_future_usage
2682
-
2683
2318
  sig {
2684
2319
  params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: String).void
2685
2320
  }
@@ -2695,7 +2330,6 @@ module Stripe
2695
2330
  # 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).
2696
2331
  sig { returns(String) }
2697
2332
  attr_accessor :setup_future_usage
2698
-
2699
2333
  sig { params(setup_future_usage: String).void }
2700
2334
  def initialize(setup_future_usage: nil); end
2701
2335
  end
@@ -2703,7 +2337,6 @@ module Stripe
2703
2337
  # The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
2704
2338
  sig { returns(Integer) }
2705
2339
  attr_accessor :expires_after_days
2706
-
2707
2340
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2708
2341
  #
2709
2342
  # 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.
@@ -2713,7 +2346,6 @@ module Stripe
2713
2346
  # 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).
2714
2347
  sig { returns(String) }
2715
2348
  attr_accessor :setup_future_usage
2716
-
2717
2349
  sig { params(expires_after_days: Integer, setup_future_usage: String).void }
2718
2350
  def initialize(expires_after_days: nil, setup_future_usage: nil); end
2719
2351
  end
@@ -2723,7 +2355,6 @@ module Stripe
2723
2355
  # Setting to false will prevent any installment plan from applying to a payment.
2724
2356
  sig { returns(T::Boolean) }
2725
2357
  attr_accessor :enabled
2726
-
2727
2358
  sig { params(enabled: T::Boolean).void }
2728
2359
  def initialize(enabled: nil); end
2729
2360
  end
@@ -2732,31 +2363,24 @@ module Stripe
2732
2363
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments)
2733
2364
  }
2734
2365
  attr_accessor :installments
2735
-
2736
2366
  # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
2737
2367
  sig { returns(String) }
2738
2368
  attr_accessor :request_decremental_authorization
2739
-
2740
2369
  # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
2741
2370
  sig { returns(String) }
2742
2371
  attr_accessor :request_extended_authorization
2743
-
2744
2372
  # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
2745
2373
  sig { returns(String) }
2746
2374
  attr_accessor :request_incremental_authorization
2747
-
2748
2375
  # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
2749
2376
  sig { returns(String) }
2750
2377
  attr_accessor :request_multicapture
2751
-
2752
2378
  # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
2753
2379
  sig { returns(String) }
2754
2380
  attr_accessor :request_overcapture
2755
-
2756
2381
  # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
2757
2382
  sig { returns(String) }
2758
2383
  attr_accessor :request_three_d_secure
2759
-
2760
2384
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2761
2385
  #
2762
2386
  # 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.
@@ -2766,15 +2390,12 @@ module Stripe
2766
2390
  # 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).
2767
2391
  sig { returns(String) }
2768
2392
  attr_accessor :setup_future_usage
2769
-
2770
2393
  # Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
2771
2394
  sig { returns(String) }
2772
2395
  attr_accessor :statement_descriptor_suffix_kana
2773
-
2774
2396
  # Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
2775
2397
  sig { returns(String) }
2776
2398
  attr_accessor :statement_descriptor_suffix_kanji
2777
-
2778
2399
  sig {
2779
2400
  params(installments: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments, request_decremental_authorization: String, request_extended_authorization: String, request_incremental_authorization: String, request_multicapture: String, request_overcapture: String, request_three_d_secure: String, setup_future_usage: String, statement_descriptor_suffix_kana: String, statement_descriptor_suffix_kanji: String).void
2780
2401
  }
@@ -2801,7 +2422,6 @@ module Stripe
2801
2422
  # 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).
2802
2423
  sig { returns(String) }
2803
2424
  attr_accessor :setup_future_usage
2804
-
2805
2425
  sig { params(setup_future_usage: String).void }
2806
2426
  def initialize(setup_future_usage: nil); end
2807
2427
  end
@@ -2811,7 +2431,6 @@ module Stripe
2811
2431
  # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
2812
2432
  sig { returns(String) }
2813
2433
  attr_accessor :country
2814
-
2815
2434
  sig { params(country: String).void }
2816
2435
  def initialize(country: nil); end
2817
2436
  end
@@ -2820,17 +2439,14 @@ module Stripe
2820
2439
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
2821
2440
  }
2822
2441
  attr_accessor :eu_bank_transfer
2823
-
2824
2442
  # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
2825
2443
  #
2826
2444
  # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
2827
2445
  sig { returns(T::Array[String]) }
2828
2446
  attr_accessor :requested_address_types
2829
-
2830
2447
  # The list of bank transfer types that this PaymentIntent is allowed to use for funding.
2831
2448
  sig { returns(String) }
2832
2449
  attr_accessor :type
2833
-
2834
2450
  sig {
2835
2451
  params(eu_bank_transfer: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, requested_address_types: T::Array[String], type: String).void
2836
2452
  }
@@ -2841,11 +2457,9 @@ module Stripe
2841
2457
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)
2842
2458
  }
2843
2459
  attr_accessor :bank_transfer
2844
-
2845
2460
  # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
2846
2461
  sig { returns(String) }
2847
2462
  attr_accessor :funding_type
2848
-
2849
2463
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2850
2464
  #
2851
2465
  # 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.
@@ -2855,7 +2469,6 @@ module Stripe
2855
2469
  # 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).
2856
2470
  sig { returns(String) }
2857
2471
  attr_accessor :setup_future_usage
2858
-
2859
2472
  sig {
2860
2473
  params(bank_transfer: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String, setup_future_usage: String).void
2861
2474
  }
@@ -2871,7 +2484,6 @@ module Stripe
2871
2484
  # 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).
2872
2485
  sig { returns(String) }
2873
2486
  attr_accessor :setup_future_usage
2874
-
2875
2487
  sig { params(setup_future_usage: String).void }
2876
2488
  def initialize(setup_future_usage: nil); end
2877
2489
  end
@@ -2885,7 +2497,6 @@ module Stripe
2885
2497
  # 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).
2886
2498
  sig { returns(String) }
2887
2499
  attr_accessor :setup_future_usage
2888
-
2889
2500
  sig { params(setup_future_usage: String).void }
2890
2501
  def initialize(setup_future_usage: nil); end
2891
2502
  end
@@ -2899,7 +2510,6 @@ module Stripe
2899
2510
  # 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).
2900
2511
  sig { returns(String) }
2901
2512
  attr_accessor :setup_future_usage
2902
-
2903
2513
  sig { params(setup_future_usage: String).void }
2904
2514
  def initialize(setup_future_usage: nil); end
2905
2515
  end
@@ -2913,7 +2523,6 @@ module Stripe
2913
2523
  # 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).
2914
2524
  sig { returns(String) }
2915
2525
  attr_accessor :setup_future_usage
2916
-
2917
2526
  sig { params(setup_future_usage: String).void }
2918
2527
  def initialize(setup_future_usage: nil); end
2919
2528
  end
@@ -2927,7 +2536,6 @@ module Stripe
2927
2536
  # 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).
2928
2537
  sig { returns(String) }
2929
2538
  attr_accessor :setup_future_usage
2930
-
2931
2539
  sig { params(setup_future_usage: String).void }
2932
2540
  def initialize(setup_future_usage: nil); end
2933
2541
  end
@@ -2935,7 +2543,6 @@ module Stripe
2935
2543
  # Controls when the funds will be captured from the customer's account.
2936
2544
  sig { returns(String) }
2937
2545
  attr_accessor :capture_method
2938
-
2939
2546
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2940
2547
  #
2941
2548
  # 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.
@@ -2945,7 +2552,6 @@ module Stripe
2945
2552
  # 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).
2946
2553
  sig { returns(String) }
2947
2554
  attr_accessor :setup_future_usage
2948
-
2949
2555
  sig { params(capture_method: String, setup_future_usage: String).void }
2950
2556
  def initialize(capture_method: nil, setup_future_usage: nil); end
2951
2557
  end
@@ -2959,7 +2565,6 @@ module Stripe
2959
2565
  # 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).
2960
2566
  sig { returns(String) }
2961
2567
  attr_accessor :setup_future_usage
2962
-
2963
2568
  sig { params(setup_future_usage: String).void }
2964
2569
  def initialize(setup_future_usage: nil); end
2965
2570
  end
@@ -2967,7 +2572,6 @@ module Stripe
2967
2572
  # The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
2968
2573
  sig { returns(Integer) }
2969
2574
  attr_accessor :expires_after_days
2970
-
2971
2575
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2972
2576
  #
2973
2577
  # 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.
@@ -2977,7 +2581,6 @@ module Stripe
2977
2581
  # 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).
2978
2582
  sig { returns(String) }
2979
2583
  attr_accessor :setup_future_usage
2980
-
2981
2584
  sig { params(expires_after_days: Integer, setup_future_usage: String).void }
2982
2585
  def initialize(expires_after_days: nil, setup_future_usage: nil); end
2983
2586
  end
@@ -2985,7 +2588,6 @@ module Stripe
2985
2588
  # Controls when the funds will be captured from the customer's account.
2986
2589
  sig { returns(String) }
2987
2590
  attr_accessor :capture_method
2988
-
2989
2591
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2990
2592
  #
2991
2593
  # 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.
@@ -2995,7 +2597,6 @@ module Stripe
2995
2597
  # 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).
2996
2598
  sig { returns(String) }
2997
2599
  attr_accessor :setup_future_usage
2998
-
2999
2600
  sig { params(capture_method: String, setup_future_usage: String).void }
3000
2601
  def initialize(capture_method: nil, setup_future_usage: nil); end
3001
2602
  end
@@ -3009,7 +2610,6 @@ module Stripe
3009
2610
  # 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).
3010
2611
  sig { returns(String) }
3011
2612
  attr_accessor :setup_future_usage
3012
-
3013
2613
  sig { params(setup_future_usage: String).void }
3014
2614
  def initialize(setup_future_usage: nil); end
3015
2615
  end
@@ -3023,7 +2623,6 @@ module Stripe
3023
2623
  # 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).
3024
2624
  sig { returns(String) }
3025
2625
  attr_accessor :setup_future_usage
3026
-
3027
2626
  sig { params(setup_future_usage: String).void }
3028
2627
  def initialize(setup_future_usage: nil); end
3029
2628
  end
@@ -3037,7 +2636,6 @@ module Stripe
3037
2636
  # 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).
3038
2637
  sig { returns(String) }
3039
2638
  attr_accessor :setup_future_usage
3040
-
3041
2639
  sig { params(setup_future_usage: String).void }
3042
2640
  def initialize(setup_future_usage: nil); end
3043
2641
  end
@@ -3045,7 +2643,6 @@ module Stripe
3045
2643
  # Controls when the funds will be captured from the customer's account.
3046
2644
  sig { returns(String) }
3047
2645
  attr_accessor :capture_method
3048
-
3049
2646
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
3050
2647
  #
3051
2648
  # 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.
@@ -3055,7 +2652,6 @@ module Stripe
3055
2652
  # 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).
3056
2653
  sig { returns(String) }
3057
2654
  attr_accessor :setup_future_usage
3058
-
3059
2655
  sig { params(capture_method: String, setup_future_usage: String).void }
3060
2656
  def initialize(capture_method: nil, setup_future_usage: nil); end
3061
2657
  end
@@ -3063,7 +2659,6 @@ module Stripe
3063
2659
  # The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
3064
2660
  sig { returns(Integer) }
3065
2661
  attr_accessor :expires_after_days
3066
-
3067
2662
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
3068
2663
  #
3069
2664
  # 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.
@@ -3073,7 +2668,6 @@ module Stripe
3073
2668
  # 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).
3074
2669
  sig { returns(String) }
3075
2670
  attr_accessor :setup_future_usage
3076
-
3077
2671
  sig { params(expires_after_days: Integer, setup_future_usage: String).void }
3078
2672
  def initialize(expires_after_days: nil, setup_future_usage: nil); end
3079
2673
  end
@@ -3087,19 +2681,19 @@ module Stripe
3087
2681
  # 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).
3088
2682
  sig { returns(String) }
3089
2683
  attr_accessor :setup_future_usage
3090
-
3091
2684
  # Confirm that the payer has accepted the P24 terms and conditions.
3092
2685
  sig { returns(T::Boolean) }
3093
2686
  attr_accessor :tos_shown_and_accepted
3094
-
3095
2687
  sig { params(setup_future_usage: String, tos_shown_and_accepted: T::Boolean).void }
3096
2688
  def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
2689
+ end
2690
+ class PayByBank < Stripe::RequestParams
2691
+
3097
2692
  end
3098
2693
  class Payco < Stripe::RequestParams
3099
2694
  # Controls when the funds will be captured from the customer's account.
3100
2695
  sig { returns(String) }
3101
2696
  attr_accessor :capture_method
3102
-
3103
2697
  sig { params(capture_method: String).void }
3104
2698
  def initialize(capture_method: nil); end
3105
2699
  end
@@ -3113,7 +2707,6 @@ module Stripe
3113
2707
  # 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).
3114
2708
  sig { returns(String) }
3115
2709
  attr_accessor :setup_future_usage
3116
-
3117
2710
  sig { params(setup_future_usage: String).void }
3118
2711
  def initialize(setup_future_usage: nil); end
3119
2712
  end
@@ -3121,23 +2714,18 @@ module Stripe
3121
2714
  # Controls when the funds will be captured from the customer's account.
3122
2715
  sig { returns(T.nilable(String)) }
3123
2716
  attr_accessor :capture_method
3124
-
3125
2717
  # [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
3126
2718
  sig { returns(String) }
3127
2719
  attr_accessor :preferred_locale
3128
-
3129
2720
  # A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
3130
2721
  sig { returns(String) }
3131
2722
  attr_accessor :reference
3132
-
3133
2723
  # A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
3134
2724
  sig { returns(String) }
3135
2725
  attr_accessor :reference_id
3136
-
3137
2726
  # The risk correlation ID for an on-session payment using a saved PayPal payment method.
3138
2727
  sig { returns(String) }
3139
2728
  attr_accessor :risk_correlation_id
3140
-
3141
2729
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
3142
2730
  #
3143
2731
  # 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.
@@ -3149,11 +2737,9 @@ module Stripe
3149
2737
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
3150
2738
  sig { returns(T.nilable(String)) }
3151
2739
  attr_accessor :setup_future_usage
3152
-
3153
2740
  # The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
3154
2741
  sig { returns(T::Array[String]) }
3155
2742
  attr_accessor :subsellers
3156
-
3157
2743
  sig {
3158
2744
  params(capture_method: T.nilable(String), preferred_locale: String, reference: String, reference_id: String, risk_correlation_id: String, setup_future_usage: T.nilable(String), subsellers: T::Array[String]).void
3159
2745
  }
@@ -3172,31 +2758,24 @@ module Stripe
3172
2758
  # Amount that will be collected. It is required when `amount_type` is `fixed`.
3173
2759
  sig { returns(Integer) }
3174
2760
  attr_accessor :amount
3175
-
3176
2761
  # The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
3177
2762
  sig { returns(String) }
3178
2763
  attr_accessor :amount_type
3179
-
3180
2764
  # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
3181
2765
  sig { returns(String) }
3182
2766
  attr_accessor :end_date
3183
-
3184
2767
  # The periodicity at which payments will be collected.
3185
2768
  sig { returns(String) }
3186
2769
  attr_accessor :payment_schedule
3187
-
3188
2770
  # The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
3189
2771
  sig { returns(Integer) }
3190
2772
  attr_accessor :payments_per_period
3191
-
3192
2773
  # The purpose for which payments are made. Defaults to retail.
3193
2774
  sig { returns(String) }
3194
2775
  attr_accessor :purpose
3195
-
3196
2776
  # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
3197
2777
  sig { returns(String) }
3198
2778
  attr_accessor :start_date
3199
-
3200
2779
  sig {
3201
2780
  params(amount: Integer, amount_type: String, end_date: String, payment_schedule: String, payments_per_period: Integer, purpose: String, start_date: String).void
3202
2781
  }
@@ -3215,7 +2794,6 @@ module Stripe
3215
2794
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions)
3216
2795
  }
3217
2796
  attr_accessor :mandate_options
3218
-
3219
2797
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
3220
2798
  #
3221
2799
  # 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.
@@ -3225,7 +2803,6 @@ module Stripe
3225
2803
  # 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).
3226
2804
  sig { returns(String) }
3227
2805
  attr_accessor :setup_future_usage
3228
-
3229
2806
  sig {
3230
2807
  params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions, setup_future_usage: String).void
3231
2808
  }
@@ -3235,7 +2812,6 @@ module Stripe
3235
2812
  # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
3236
2813
  sig { returns(Integer) }
3237
2814
  attr_accessor :expires_after_seconds
3238
-
3239
2815
  sig { params(expires_after_seconds: Integer).void }
3240
2816
  def initialize(expires_after_seconds: nil); end
3241
2817
  end
@@ -3249,7 +2825,6 @@ module Stripe
3249
2825
  # 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).
3250
2826
  sig { returns(String) }
3251
2827
  attr_accessor :setup_future_usage
3252
-
3253
2828
  sig { params(setup_future_usage: String).void }
3254
2829
  def initialize(setup_future_usage: nil); end
3255
2830
  end
@@ -3257,7 +2832,6 @@ module Stripe
3257
2832
  # Controls when the funds will be captured from the customer's account.
3258
2833
  sig { returns(String) }
3259
2834
  attr_accessor :capture_method
3260
-
3261
2835
  sig { params(capture_method: String).void }
3262
2836
  def initialize(capture_method: nil); end
3263
2837
  end
@@ -3266,7 +2840,6 @@ module Stripe
3266
2840
  # 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'.
3267
2841
  sig { returns(T.nilable(String)) }
3268
2842
  attr_accessor :reference_prefix
3269
-
3270
2843
  sig { params(reference_prefix: T.nilable(String)).void }
3271
2844
  def initialize(reference_prefix: nil); end
3272
2845
  end
@@ -3275,7 +2848,6 @@ module Stripe
3275
2848
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)
3276
2849
  }
3277
2850
  attr_accessor :mandate_options
3278
-
3279
2851
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
3280
2852
  #
3281
2853
  # 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.
@@ -3285,7 +2857,6 @@ module Stripe
3285
2857
  # 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).
3286
2858
  sig { returns(String) }
3287
2859
  attr_accessor :setup_future_usage
3288
-
3289
2860
  sig {
3290
2861
  params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: String).void
3291
2862
  }
@@ -3301,7 +2872,6 @@ module Stripe
3301
2872
  # 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).
3302
2873
  sig { returns(String) }
3303
2874
  attr_accessor :setup_future_usage
3304
-
3305
2875
  sig { params(setup_future_usage: String).void }
3306
2876
  def initialize(setup_future_usage: nil); end
3307
2877
  end
@@ -3309,7 +2879,6 @@ module Stripe
3309
2879
  # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
3310
2880
  sig { returns(String) }
3311
2881
  attr_accessor :reference
3312
-
3313
2882
  sig { params(reference: String).void }
3314
2883
  def initialize(reference: nil); end
3315
2884
  end
@@ -3318,11 +2887,9 @@ module Stripe
3318
2887
  # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
3319
2888
  sig { returns(T::Array[String]) }
3320
2889
  attr_accessor :permissions
3321
-
3322
2890
  # List of data features that you would like to retrieve upon account creation.
3323
2891
  sig { returns(T::Array[String]) }
3324
2892
  attr_accessor :prefetch
3325
-
3326
2893
  sig { params(permissions: T::Array[String], prefetch: T::Array[String]).void }
3327
2894
  def initialize(permissions: nil, prefetch: nil); end
3328
2895
  end
@@ -3331,7 +2898,6 @@ module Stripe
3331
2898
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)
3332
2899
  }
3333
2900
  attr_accessor :financial_connections
3334
-
3335
2901
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
3336
2902
  #
3337
2903
  # 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.
@@ -3341,11 +2907,9 @@ module Stripe
3341
2907
  # 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).
3342
2908
  sig { returns(String) }
3343
2909
  attr_accessor :setup_future_usage
3344
-
3345
2910
  # Verification method for the intent
3346
2911
  sig { returns(String) }
3347
2912
  attr_accessor :verification_method
3348
-
3349
2913
  sig {
3350
2914
  params(financial_connections: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, setup_future_usage: String, verification_method: String).void
3351
2915
  }
@@ -3359,11 +2923,9 @@ module Stripe
3359
2923
  # The app ID registered with WeChat Pay. Only required when client is ios or android.
3360
2924
  sig { returns(String) }
3361
2925
  attr_accessor :app_id
3362
-
3363
2926
  # The client type that the end customer will pay from
3364
2927
  sig { returns(String) }
3365
2928
  attr_accessor :client
3366
-
3367
2929
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
3368
2930
  #
3369
2931
  # 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.
@@ -3373,7 +2935,6 @@ module Stripe
3373
2935
  # 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).
3374
2936
  sig { returns(String) }
3375
2937
  attr_accessor :setup_future_usage
3376
-
3377
2938
  sig { params(app_id: String, client: String, setup_future_usage: String).void }
3378
2939
  def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
3379
2940
  end
@@ -3382,187 +2943,153 @@ module Stripe
3382
2943
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit)
3383
2944
  }
3384
2945
  attr_accessor :acss_debit
3385
-
3386
2946
  # contains details about the Affirm payment method options.
3387
2947
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm) }
3388
2948
  attr_accessor :affirm
3389
-
3390
2949
  # contains details about the Afterpay Clearpay payment method options.
3391
2950
  sig {
3392
2951
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay)
3393
2952
  }
3394
2953
  attr_accessor :afterpay_clearpay
3395
-
3396
2954
  # contains details about the Alipay payment method options.
3397
2955
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay) }
3398
2956
  attr_accessor :alipay
3399
-
3400
2957
  # contains details about the AmazonPay payment method options.
3401
2958
  sig {
3402
2959
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay)
3403
2960
  }
3404
2961
  attr_accessor :amazon_pay
3405
-
3406
2962
  # contains details about the AU Becs Debit payment method options.
3407
2963
  sig {
3408
2964
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit)
3409
2965
  }
3410
2966
  attr_accessor :au_becs_debit
3411
-
3412
2967
  # contains details about the Bacs Debit payment method options.
3413
2968
  sig {
3414
2969
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit)
3415
2970
  }
3416
2971
  attr_accessor :bacs_debit
3417
-
3418
2972
  # contains details about the Bancontact payment method options.
3419
2973
  sig {
3420
2974
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact)
3421
2975
  }
3422
2976
  attr_accessor :bancontact
3423
-
3424
2977
  # contains details about the Boleto payment method options.
3425
2978
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto) }
3426
2979
  attr_accessor :boleto
3427
-
3428
2980
  # contains details about the Card payment method options.
3429
2981
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card) }
3430
2982
  attr_accessor :card
3431
-
3432
2983
  # contains details about the Cashapp Pay payment method options.
3433
2984
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp) }
3434
2985
  attr_accessor :cashapp
3435
-
3436
2986
  # contains details about the Customer Balance payment method options.
3437
2987
  sig {
3438
2988
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance)
3439
2989
  }
3440
2990
  attr_accessor :customer_balance
3441
-
3442
2991
  # contains details about the EPS payment method options.
3443
2992
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps) }
3444
2993
  attr_accessor :eps
3445
-
3446
2994
  # contains details about the FPX payment method options.
3447
2995
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx) }
3448
2996
  attr_accessor :fpx
3449
-
3450
2997
  # contains details about the Giropay payment method options.
3451
2998
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay) }
3452
2999
  attr_accessor :giropay
3453
-
3454
3000
  # contains details about the Grabpay payment method options.
3455
3001
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay) }
3456
3002
  attr_accessor :grabpay
3457
-
3458
3003
  # contains details about the Ideal payment method options.
3459
3004
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal) }
3460
3005
  attr_accessor :ideal
3461
-
3462
3006
  # contains details about the Kakao Pay payment method options.
3463
3007
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay) }
3464
3008
  attr_accessor :kakao_pay
3465
-
3466
3009
  # contains details about the Klarna payment method options.
3467
3010
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna) }
3468
3011
  attr_accessor :klarna
3469
-
3470
3012
  # contains details about the Konbini payment method options.
3471
3013
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini) }
3472
3014
  attr_accessor :konbini
3473
-
3474
3015
  # contains details about the Korean card payment method options.
3475
3016
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard) }
3476
3017
  attr_accessor :kr_card
3477
-
3478
3018
  # contains details about the Link payment method options.
3479
3019
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link) }
3480
3020
  attr_accessor :link
3481
-
3482
3021
  # contains details about the Mobilepay payment method options.
3483
3022
  sig {
3484
3023
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay)
3485
3024
  }
3486
3025
  attr_accessor :mobilepay
3487
-
3488
3026
  # contains details about the Multibanco payment method options.
3489
3027
  sig {
3490
3028
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco)
3491
3029
  }
3492
3030
  attr_accessor :multibanco
3493
-
3494
3031
  # contains details about the Naver Pay payment method options.
3495
3032
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay) }
3496
3033
  attr_accessor :naver_pay
3497
-
3498
3034
  # contains details about the OXXO payment method options.
3499
3035
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo) }
3500
3036
  attr_accessor :oxxo
3501
-
3502
3037
  # contains details about the P24 payment method options.
3503
3038
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24) }
3504
3039
  attr_accessor :p24
3505
-
3040
+ # contains details about the Pay By Bank payment method options.
3041
+ sig {
3042
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::PayByBank)
3043
+ }
3044
+ attr_accessor :pay_by_bank
3506
3045
  # contains details about the PAYCO payment method options.
3507
3046
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco) }
3508
3047
  attr_accessor :payco
3509
-
3510
3048
  # contains details about the PayNow payment method options.
3511
3049
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow) }
3512
3050
  attr_accessor :paynow
3513
-
3514
3051
  # contains details about the PayPal payment method options.
3515
3052
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal) }
3516
3053
  attr_accessor :paypal
3517
-
3518
3054
  # contains details about the PayTo payment method options.
3519
3055
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto) }
3520
3056
  attr_accessor :payto
3521
-
3522
3057
  # contains details about the Pix payment method options.
3523
3058
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix) }
3524
3059
  attr_accessor :pix
3525
-
3526
3060
  # contains details about the RevolutPay payment method options.
3527
3061
  sig {
3528
3062
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay)
3529
3063
  }
3530
3064
  attr_accessor :revolut_pay
3531
-
3532
3065
  # contains details about the Samsung Pay payment method options.
3533
3066
  sig {
3534
3067
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay)
3535
3068
  }
3536
3069
  attr_accessor :samsung_pay
3537
-
3538
3070
  # contains details about the Sepa Debit payment method options.
3539
3071
  sig {
3540
3072
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit)
3541
3073
  }
3542
3074
  attr_accessor :sepa_debit
3543
-
3544
3075
  # contains details about the Sofort payment method options.
3545
3076
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort) }
3546
3077
  attr_accessor :sofort
3547
-
3548
3078
  # contains details about the Swish payment method options.
3549
3079
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish) }
3550
3080
  attr_accessor :swish
3551
-
3552
3081
  # contains details about the Us Bank Account payment method options.
3553
3082
  sig {
3554
3083
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount)
3555
3084
  }
3556
3085
  attr_accessor :us_bank_account
3557
-
3558
3086
  # contains details about the WeChat Pay payment method options.
3559
3087
  sig {
3560
3088
  returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay)
3561
3089
  }
3562
3090
  attr_accessor :wechat_pay
3563
-
3564
3091
  sig {
3565
- params(acss_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit, affirm: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm, afterpay_clearpay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay, alipay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay, amazon_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay, au_becs_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit, bacs_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit, bancontact: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact, boleto: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto, card: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card, cashapp: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp, customer_balance: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance, eps: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps, fpx: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx, giropay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay, grabpay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay, ideal: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal, kakao_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay, klarna: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna, konbini: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini, kr_card: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard, link: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link, mobilepay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay, multibanco: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco, naver_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay, oxxo: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo, p24: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24, payco: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco, paynow: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow, paypal: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal, payto: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto, pix: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix, revolut_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay, samsung_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay, sepa_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit, sofort: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort, swish: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish, us_bank_account: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount, wechat_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay).void
3092
+ params(acss_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit, affirm: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm, afterpay_clearpay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay, alipay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay, amazon_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay, au_becs_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit, bacs_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit, bancontact: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact, boleto: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto, card: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card, cashapp: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp, customer_balance: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance, eps: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps, fpx: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx, giropay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay, grabpay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay, ideal: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal, kakao_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay, klarna: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna, konbini: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini, kr_card: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard, link: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link, mobilepay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay, multibanco: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco, naver_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay, oxxo: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo, p24: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24, pay_by_bank: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::PayByBank, payco: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco, paynow: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow, paypal: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal, payto: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto, pix: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix, revolut_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay, samsung_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay, sepa_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit, sofort: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort, swish: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish, us_bank_account: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount, wechat_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay).void
3566
3093
  }
3567
3094
  def initialize(
3568
3095
  acss_debit: nil,
@@ -3592,6 +3119,7 @@ module Stripe
3592
3119
  naver_pay: nil,
3593
3120
  oxxo: nil,
3594
3121
  p24: nil,
3122
+ pay_by_bank: nil,
3595
3123
  payco: nil,
3596
3124
  paynow: nil,
3597
3125
  paypal: nil,
@@ -3615,7 +3143,6 @@ module Stripe
3615
3143
  # When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
3616
3144
  sig { returns(String) }
3617
3145
  attr_accessor :line_items
3618
-
3619
3146
  # Determines which entity is allowed to update the shipping details.
3620
3147
  #
3621
3148
  # Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
@@ -3623,14 +3150,12 @@ module Stripe
3623
3150
  # When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
3624
3151
  sig { returns(String) }
3625
3152
  attr_accessor :shipping_details
3626
-
3627
3153
  sig { params(line_items: String, shipping_details: String).void }
3628
3154
  def initialize(line_items: nil, shipping_details: nil); end
3629
3155
  end
3630
3156
  # Permissions for updating the Checkout Session.
3631
3157
  sig { returns(::Stripe::Checkout::Session::CreateParams::Permissions::Update) }
3632
3158
  attr_accessor :update
3633
-
3634
3159
  sig {
3635
3160
  params(update: ::Stripe::Checkout::Session::CreateParams::Permissions::Update).void
3636
3161
  }
@@ -3638,9 +3163,10 @@ module Stripe
3638
3163
  end
3639
3164
  class PhoneNumberCollection < Stripe::RequestParams
3640
3165
  # Set to `true` to enable phone number collection.
3166
+ #
3167
+ # Can only be set in `payment` and `subscription` mode.
3641
3168
  sig { returns(T::Boolean) }
3642
3169
  attr_accessor :enabled
3643
-
3644
3170
  sig { params(enabled: T::Boolean).void }
3645
3171
  def initialize(enabled: nil); end
3646
3172
  end
@@ -3648,11 +3174,9 @@ module Stripe
3648
3174
  # Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
3649
3175
  sig { returns(T::Array[String]) }
3650
3176
  attr_accessor :allow_redisplay_filters
3651
-
3652
3177
  # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
3653
3178
  sig { returns(String) }
3654
3179
  attr_accessor :payment_method_save
3655
-
3656
3180
  sig {
3657
3181
  params(allow_redisplay_filters: T::Array[String], payment_method_save: String).void
3658
3182
  }
@@ -3662,15 +3186,12 @@ module Stripe
3662
3186
  # An arbitrary string attached to the object. Often useful for displaying to users.
3663
3187
  sig { returns(String) }
3664
3188
  attr_accessor :description
3665
-
3666
3189
  # 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`.
3667
3190
  sig { returns(T::Hash[String, String]) }
3668
3191
  attr_accessor :metadata
3669
-
3670
3192
  # The Stripe account for which the setup is intended.
3671
3193
  sig { returns(String) }
3672
3194
  attr_accessor :on_behalf_of
3673
-
3674
3195
  sig {
3675
3196
  params(description: String, metadata: T::Hash[String, String], on_behalf_of: String).void
3676
3197
  }
@@ -3681,7 +3202,6 @@ module Stripe
3681
3202
  # shipping locations.
3682
3203
  sig { returns(T::Array[String]) }
3683
3204
  attr_accessor :allowed_countries
3684
-
3685
3205
  sig { params(allowed_countries: T::Array[String]).void }
3686
3206
  def initialize(allowed_countries: nil); end
3687
3207
  end
@@ -3692,11 +3212,9 @@ module Stripe
3692
3212
  # A unit of time.
3693
3213
  sig { returns(String) }
3694
3214
  attr_accessor :unit
3695
-
3696
3215
  # Must be greater than 0.
3697
3216
  sig { returns(Integer) }
3698
3217
  attr_accessor :value
3699
-
3700
3218
  sig { params(unit: String, value: Integer).void }
3701
3219
  def initialize(unit: nil, value: nil); end
3702
3220
  end
@@ -3704,11 +3222,9 @@ module Stripe
3704
3222
  # A unit of time.
3705
3223
  sig { returns(String) }
3706
3224
  attr_accessor :unit
3707
-
3708
3225
  # Must be greater than 0.
3709
3226
  sig { returns(Integer) }
3710
3227
  attr_accessor :value
3711
-
3712
3228
  sig { params(unit: String, value: Integer).void }
3713
3229
  def initialize(unit: nil, value: nil); end
3714
3230
  end
@@ -3717,13 +3233,11 @@ module Stripe
3717
3233
  returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
3718
3234
  }
3719
3235
  attr_accessor :maximum
3720
-
3721
3236
  # The lower bound of the estimated range. If empty, represents no lower bound.
3722
3237
  sig {
3723
3238
  returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
3724
3239
  }
3725
3240
  attr_accessor :minimum
3726
-
3727
3241
  sig {
3728
3242
  params(maximum: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
3729
3243
  }
@@ -3734,28 +3248,23 @@ module Stripe
3734
3248
  # A non-negative integer in cents representing how much to charge.
3735
3249
  sig { returns(Integer) }
3736
3250
  attr_accessor :amount
3737
-
3738
3251
  # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3739
3252
  sig { returns(String) }
3740
3253
  attr_accessor :tax_behavior
3741
-
3742
3254
  sig { params(amount: Integer, tax_behavior: String).void }
3743
3255
  def initialize(amount: nil, tax_behavior: nil); end
3744
3256
  end
3745
3257
  # A non-negative integer in cents representing how much to charge.
3746
3258
  sig { returns(Integer) }
3747
3259
  attr_accessor :amount
3748
-
3749
3260
  # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
3750
3261
  sig { returns(String) }
3751
3262
  attr_accessor :currency
3752
-
3753
3263
  # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
3754
3264
  sig {
3755
3265
  returns(T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
3756
3266
  }
3757
3267
  attr_accessor :currency_options
3758
-
3759
3268
  sig {
3760
3269
  params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
3761
3270
  }
@@ -3766,33 +3275,26 @@ module Stripe
3766
3275
  returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
3767
3276
  }
3768
3277
  attr_accessor :delivery_estimate
3769
-
3770
3278
  # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
3771
3279
  sig { returns(String) }
3772
3280
  attr_accessor :display_name
3773
-
3774
3281
  # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
3775
3282
  sig {
3776
3283
  returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount)
3777
3284
  }
3778
3285
  attr_accessor :fixed_amount
3779
-
3780
3286
  # 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`.
3781
3287
  sig { returns(T::Hash[String, String]) }
3782
3288
  attr_accessor :metadata
3783
-
3784
3289
  # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3785
3290
  sig { returns(String) }
3786
3291
  attr_accessor :tax_behavior
3787
-
3788
3292
  # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
3789
3293
  sig { returns(String) }
3790
3294
  attr_accessor :tax_code
3791
-
3792
3295
  # The type of calculation to use on the shipping rate.
3793
3296
  sig { returns(String) }
3794
3297
  attr_accessor :type
3795
-
3796
3298
  sig {
3797
3299
  params(delivery_estimate: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
3798
3300
  }
@@ -3809,13 +3311,11 @@ module Stripe
3809
3311
  # The ID of the Shipping Rate to use for this shipping option.
3810
3312
  sig { returns(String) }
3811
3313
  attr_accessor :shipping_rate
3812
-
3813
3314
  # Parameters to be passed to Shipping Rate creation for this shipping option.
3814
3315
  sig {
3815
3316
  returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData)
3816
3317
  }
3817
3318
  attr_accessor :shipping_rate_data
3818
-
3819
3319
  sig {
3820
3320
  params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData).void
3821
3321
  }
@@ -3827,11 +3327,9 @@ module Stripe
3827
3327
  # The connected account being referenced when `type` is `account`.
3828
3328
  sig { returns(String) }
3829
3329
  attr_accessor :account
3830
-
3831
3330
  # Type of the account referenced in the request.
3832
3331
  sig { returns(String) }
3833
3332
  attr_accessor :type
3834
-
3835
3333
  sig { params(account: String, type: String).void }
3836
3334
  def initialize(account: nil, type: nil); end
3837
3335
  end
@@ -3840,7 +3338,6 @@ module Stripe
3840
3338
  returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer)
3841
3339
  }
3842
3340
  attr_accessor :issuer
3843
-
3844
3341
  sig {
3845
3342
  params(issuer: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer).void
3846
3343
  }
@@ -3850,11 +3347,9 @@ module Stripe
3850
3347
  # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
3851
3348
  sig { returns(Float) }
3852
3349
  attr_accessor :amount_percent
3853
-
3854
3350
  # ID of an existing, connected Stripe account.
3855
3351
  sig { returns(String) }
3856
3352
  attr_accessor :destination
3857
-
3858
3353
  sig { params(amount_percent: Float, destination: String).void }
3859
3354
  def initialize(amount_percent: nil, destination: nil); end
3860
3355
  end
@@ -3863,7 +3358,6 @@ module Stripe
3863
3358
  # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
3864
3359
  sig { returns(String) }
3865
3360
  attr_accessor :missing_payment_method
3866
-
3867
3361
  sig { params(missing_payment_method: String).void }
3868
3362
  def initialize(missing_payment_method: nil); end
3869
3363
  end
@@ -3872,7 +3366,6 @@ module Stripe
3872
3366
  returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
3873
3367
  }
3874
3368
  attr_accessor :end_behavior
3875
-
3876
3369
  sig {
3877
3370
  params(end_behavior: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
3878
3371
  }
@@ -3881,62 +3374,50 @@ module Stripe
3881
3374
  # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
3882
3375
  sig { returns(Float) }
3883
3376
  attr_accessor :application_fee_percent
3884
-
3885
3377
  # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
3886
3378
  sig { returns(Integer) }
3887
3379
  attr_accessor :billing_cycle_anchor
3888
-
3889
3380
  # The tax rates that will apply to any subscription item that does not have
3890
3381
  # `tax_rates` set. Invoices created will have their `default_tax_rates` populated
3891
3382
  # from the subscription.
3892
3383
  sig { returns(T::Array[String]) }
3893
3384
  attr_accessor :default_tax_rates
3894
-
3895
3385
  # The subscription's description, meant to be displayable to the customer.
3896
3386
  # Use this field to optionally store an explanation of the subscription
3897
3387
  # for rendering in the [customer portal](https://stripe.com/docs/customer-management).
3898
3388
  sig { returns(String) }
3899
3389
  attr_accessor :description
3900
-
3901
3390
  # All invoices will be billed using the specified settings.
3902
3391
  sig {
3903
3392
  returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings)
3904
3393
  }
3905
3394
  attr_accessor :invoice_settings
3906
-
3907
3395
  # 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`.
3908
3396
  sig { returns(T::Hash[String, String]) }
3909
3397
  attr_accessor :metadata
3910
-
3911
3398
  # The account on behalf of which to charge, for each of the subscription's invoices.
3912
3399
  sig { returns(String) }
3913
3400
  attr_accessor :on_behalf_of
3914
-
3915
3401
  # Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
3916
3402
  sig { returns(String) }
3917
3403
  attr_accessor :proration_behavior
3918
-
3919
3404
  # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
3920
3405
  sig { returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData) }
3921
3406
  attr_accessor :transfer_data
3922
-
3923
3407
  # Unix timestamp representing the end of the trial period the customer
3924
3408
  # will get before being charged for the first time. Has to be at least
3925
3409
  # 48 hours in the future.
3926
3410
  sig { returns(Integer) }
3927
3411
  attr_accessor :trial_end
3928
-
3929
3412
  # Integer representing the number of trial period days before the
3930
3413
  # customer is charged for the first time. Has to be at least 1.
3931
3414
  sig { returns(Integer) }
3932
3415
  attr_accessor :trial_period_days
3933
-
3934
3416
  # Settings related to subscription trials.
3935
3417
  sig {
3936
3418
  returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings)
3937
3419
  }
3938
3420
  attr_accessor :trial_settings
3939
-
3940
3421
  sig {
3941
3422
  params(application_fee_percent: Float, billing_cycle_anchor: Integer, default_tax_rates: T::Array[String], description: String, invoice_settings: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings, metadata: T::Hash[String, String], on_behalf_of: String, proration_behavior: String, transfer_data: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData, trial_end: Integer, trial_period_days: Integer, trial_settings: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings).void
3942
3423
  }
@@ -3959,60 +3440,47 @@ module Stripe
3959
3440
  # Enable tax ID collection during checkout. Defaults to `false`.
3960
3441
  sig { returns(T::Boolean) }
3961
3442
  attr_accessor :enabled
3962
-
3963
3443
  # Describes whether a tax ID is required during checkout. Defaults to `never`.
3964
3444
  sig { returns(String) }
3965
3445
  attr_accessor :required
3966
-
3967
3446
  sig { params(enabled: T::Boolean, required: String).void }
3968
3447
  def initialize(enabled: nil, required: nil); end
3969
3448
  end
3970
3449
  # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
3971
3450
  sig { returns(::Stripe::Checkout::Session::CreateParams::AdaptivePricing) }
3972
3451
  attr_accessor :adaptive_pricing
3973
-
3974
3452
  # Configure actions after a Checkout Session has expired.
3975
3453
  sig { returns(::Stripe::Checkout::Session::CreateParams::AfterExpiration) }
3976
3454
  attr_accessor :after_expiration
3977
-
3978
3455
  # Enables user redeemable promotion codes.
3979
3456
  sig { returns(T::Boolean) }
3980
3457
  attr_accessor :allow_promotion_codes
3981
-
3982
3458
  # Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
3983
3459
  sig { returns(::Stripe::Checkout::Session::CreateParams::AutomaticTax) }
3984
3460
  attr_accessor :automatic_tax
3985
-
3986
3461
  # Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
3987
3462
  sig { returns(String) }
3988
3463
  attr_accessor :billing_address_collection
3989
-
3990
3464
  # If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`.
3991
3465
  sig { returns(String) }
3992
3466
  attr_accessor :cancel_url
3993
-
3994
3467
  # A unique string to reference the Checkout Session. This can be a
3995
3468
  # customer ID, a cart ID, or similar, and can be used to reconcile the
3996
3469
  # session with your internal systems.
3997
3470
  sig { returns(String) }
3998
3471
  attr_accessor :client_reference_id
3999
-
4000
3472
  # Configure fields for the Checkout Session to gather active consent from customers.
4001
3473
  sig { returns(::Stripe::Checkout::Session::CreateParams::ConsentCollection) }
4002
3474
  attr_accessor :consent_collection
4003
-
4004
3475
  # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set.
4005
3476
  sig { returns(String) }
4006
3477
  attr_accessor :currency
4007
-
4008
3478
  # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
4009
3479
  sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField]) }
4010
3480
  attr_accessor :custom_fields
4011
-
4012
3481
  # Display additional text for your customers using custom text.
4013
3482
  sig { returns(::Stripe::Checkout::Session::CreateParams::CustomText) }
4014
3483
  attr_accessor :custom_text
4015
-
4016
3484
  # ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
4017
3485
  # payment method will be used to prefill the email, name, card details, and billing address
4018
3486
  # on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)
@@ -4026,7 +3494,6 @@ module Stripe
4026
3494
  # You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
4027
3495
  sig { returns(String) }
4028
3496
  attr_accessor :customer
4029
-
4030
3497
  # Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
4031
3498
  #
4032
3499
  # When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
@@ -4038,7 +3505,6 @@ module Stripe
4038
3505
  # Can only be set in `payment` and `setup` mode.
4039
3506
  sig { returns(String) }
4040
3507
  attr_accessor :customer_creation
4041
-
4042
3508
  # If provided, this value will be used when the Customer object is created.
4043
3509
  # If not provided, customers will be asked to enter their email address.
4044
3510
  # Use this parameter to prefill customer data if you already have an email
@@ -4046,27 +3512,21 @@ module Stripe
4046
3512
  # complete, use the `customer` field.
4047
3513
  sig { returns(String) }
4048
3514
  attr_accessor :customer_email
4049
-
4050
3515
  # Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
4051
3516
  sig { returns(::Stripe::Checkout::Session::CreateParams::CustomerUpdate) }
4052
3517
  attr_accessor :customer_update
4053
-
4054
3518
  # The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
4055
3519
  sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::Discount]) }
4056
3520
  attr_accessor :discounts
4057
-
4058
3521
  # Specifies which fields in the response should be expanded.
4059
3522
  sig { returns(T::Array[String]) }
4060
3523
  attr_accessor :expand
4061
-
4062
3524
  # The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
4063
3525
  sig { returns(Integer) }
4064
3526
  attr_accessor :expires_at
4065
-
4066
3527
  # Generate a post-purchase Invoice for one-time payments.
4067
3528
  sig { returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation) }
4068
3529
  attr_accessor :invoice_creation
4069
-
4070
3530
  # A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
4071
3531
  #
4072
3532
  # For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.
@@ -4074,23 +3534,18 @@ module Stripe
4074
3534
  # For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.
4075
3535
  sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::LineItem]) }
4076
3536
  attr_accessor :line_items
4077
-
4078
3537
  # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
4079
3538
  sig { returns(String) }
4080
3539
  attr_accessor :locale
4081
-
4082
3540
  # 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`.
4083
3541
  sig { returns(T::Hash[String, String]) }
4084
3542
  attr_accessor :metadata
4085
-
4086
3543
  # The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
4087
3544
  sig { returns(String) }
4088
3545
  attr_accessor :mode
4089
-
4090
3546
  # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
4091
3547
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData) }
4092
3548
  attr_accessor :payment_intent_data
4093
-
4094
3549
  # Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.
4095
3550
  # This may occur if the Checkout Session includes a free trial or a discount.
4096
3551
  #
@@ -4099,19 +3554,15 @@ module Stripe
4099
3554
  # If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
4100
3555
  sig { returns(String) }
4101
3556
  attr_accessor :payment_method_collection
4102
-
4103
3557
  # The ID of the payment method configuration to use with this Checkout session.
4104
3558
  sig { returns(String) }
4105
3559
  attr_accessor :payment_method_configuration
4106
-
4107
3560
  # This parameter allows you to set some attributes on the payment method created during a Checkout session.
4108
3561
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodData) }
4109
3562
  attr_accessor :payment_method_data
4110
-
4111
3563
  # Payment-method-specific configuration.
4112
3564
  sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions) }
4113
3565
  attr_accessor :payment_method_options
4114
-
4115
3566
  # A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
4116
3567
  #
4117
3568
  # You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
@@ -4125,56 +3576,45 @@ module Stripe
4125
3576
  # other characteristics.
4126
3577
  sig { returns(T::Array[String]) }
4127
3578
  attr_accessor :payment_method_types
4128
-
4129
3579
  # This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
4130
3580
  #
4131
3581
  # For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
4132
3582
  sig { returns(::Stripe::Checkout::Session::CreateParams::Permissions) }
4133
3583
  attr_accessor :permissions
4134
-
4135
3584
  # Controls phone number collection settings for the session.
4136
3585
  #
4137
3586
  # We recommend that you review your privacy policy and check with your legal contacts
4138
3587
  # before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
4139
3588
  sig { returns(::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection) }
4140
3589
  attr_accessor :phone_number_collection
4141
-
4142
3590
  # This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
4143
3591
  sig { returns(String) }
4144
3592
  attr_accessor :redirect_on_completion
4145
-
4146
3593
  # The URL to redirect your customer back to after they authenticate or cancel their payment on the
4147
3594
  # payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
4148
3595
  # and redirect-based payment methods are enabled on the session.
4149
3596
  sig { returns(String) }
4150
3597
  attr_accessor :return_url
4151
-
4152
3598
  # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
4153
3599
  sig { returns(::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions) }
4154
3600
  attr_accessor :saved_payment_method_options
4155
-
4156
3601
  # A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
4157
3602
  sig { returns(::Stripe::Checkout::Session::CreateParams::SetupIntentData) }
4158
3603
  attr_accessor :setup_intent_data
4159
-
4160
3604
  # When set, provides configuration for Checkout to collect a shipping address from a customer.
4161
3605
  sig { returns(::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection) }
4162
3606
  attr_accessor :shipping_address_collection
4163
-
4164
3607
  # The shipping rate options to apply to this Session. Up to a maximum of 5.
4165
3608
  sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption]) }
4166
3609
  attr_accessor :shipping_options
4167
-
4168
3610
  # Describes the type of transaction being performed by Checkout in order to customize
4169
3611
  # relevant text on the page, such as the submit button. `submit_type` can only be
4170
3612
  # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
4171
3613
  sig { returns(String) }
4172
3614
  attr_accessor :submit_type
4173
-
4174
3615
  # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
4175
3616
  sig { returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData) }
4176
3617
  attr_accessor :subscription_data
4177
-
4178
3618
  # The URL to which Stripe should send customers when payment or setup
4179
3619
  # is complete.
4180
3620
  # This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
@@ -4182,15 +3622,12 @@ module Stripe
4182
3622
  # guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
4183
3623
  sig { returns(String) }
4184
3624
  attr_accessor :success_url
4185
-
4186
3625
  # Controls tax ID collection during checkout.
4187
3626
  sig { returns(::Stripe::Checkout::Session::CreateParams::TaxIdCollection) }
4188
3627
  attr_accessor :tax_id_collection
4189
-
4190
3628
  # The UI mode of the Session. Defaults to `hosted`.
4191
3629
  sig { returns(String) }
4192
3630
  attr_accessor :ui_mode
4193
-
4194
3631
  sig {
4195
3632
  params(adaptive_pricing: ::Stripe::Checkout::Session::CreateParams::AdaptivePricing, after_expiration: ::Stripe::Checkout::Session::CreateParams::AfterExpiration, allow_promotion_codes: T::Boolean, automatic_tax: ::Stripe::Checkout::Session::CreateParams::AutomaticTax, billing_address_collection: String, cancel_url: String, client_reference_id: String, consent_collection: ::Stripe::Checkout::Session::CreateParams::ConsentCollection, currency: String, custom_fields: T::Array[::Stripe::Checkout::Session::CreateParams::CustomField], custom_text: ::Stripe::Checkout::Session::CreateParams::CustomText, customer: String, customer_creation: String, customer_email: String, customer_update: ::Stripe::Checkout::Session::CreateParams::CustomerUpdate, discounts: T::Array[::Stripe::Checkout::Session::CreateParams::Discount], expand: T::Array[String], expires_at: Integer, invoice_creation: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation, line_items: T::Array[::Stripe::Checkout::Session::CreateParams::LineItem], locale: String, metadata: T::Hash[String, String], mode: String, payment_intent_data: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData, payment_method_collection: String, payment_method_configuration: String, payment_method_data: ::Stripe::Checkout::Session::CreateParams::PaymentMethodData, payment_method_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions, payment_method_types: T::Array[String], permissions: ::Stripe::Checkout::Session::CreateParams::Permissions, phone_number_collection: ::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection, redirect_on_completion: String, return_url: String, saved_payment_method_options: ::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions, setup_intent_data: ::Stripe::Checkout::Session::CreateParams::SetupIntentData, shipping_address_collection: ::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection, shipping_options: T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption], submit_type: String, subscription_data: ::Stripe::Checkout::Session::CreateParams::SubscriptionData, success_url: String, tax_id_collection: ::Stripe::Checkout::Session::CreateParams::TaxIdCollection, ui_mode: String).void
4196
3633
  }
@@ -4243,7 +3680,6 @@ module Stripe
4243
3680
  # Specifies which fields in the response should be expanded.
4244
3681
  sig { returns(T::Array[String]) }
4245
3682
  attr_accessor :expand
4246
-
4247
3683
  sig { params(expand: T::Array[String]).void }
4248
3684
  def initialize(expand: nil); end
4249
3685
  end
@@ -4254,27 +3690,21 @@ module Stripe
4254
3690
  # City, district, suburb, town, or village.
4255
3691
  sig { returns(String) }
4256
3692
  attr_accessor :city
4257
-
4258
3693
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
4259
3694
  sig { returns(String) }
4260
3695
  attr_accessor :country
4261
-
4262
3696
  # Address line 1 (e.g., street, PO Box, or company name).
4263
3697
  sig { returns(String) }
4264
3698
  attr_accessor :line1
4265
-
4266
3699
  # Address line 2 (e.g., apartment, suite, unit, or building).
4267
3700
  sig { returns(String) }
4268
3701
  attr_accessor :line2
4269
-
4270
3702
  # ZIP or postal code.
4271
3703
  sig { returns(String) }
4272
3704
  attr_accessor :postal_code
4273
-
4274
3705
  # State, county, province, or region.
4275
3706
  sig { returns(String) }
4276
3707
  attr_accessor :state
4277
-
4278
3708
  sig {
4279
3709
  params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
4280
3710
  }
@@ -4292,11 +3722,9 @@ module Stripe
4292
3722
  returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address)
4293
3723
  }
4294
3724
  attr_accessor :address
4295
-
4296
3725
  # The name of customer
4297
3726
  sig { returns(String) }
4298
3727
  attr_accessor :name
4299
-
4300
3728
  sig {
4301
3729
  params(address: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address, name: String).void
4302
3730
  }
@@ -4307,7 +3735,6 @@ module Stripe
4307
3735
  returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails)
4308
3736
  }
4309
3737
  attr_accessor :shipping_details
4310
-
4311
3738
  sig {
4312
3739
  params(shipping_details: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails).void
4313
3740
  }
@@ -4318,42 +3745,33 @@ module Stripe
4318
3745
  # Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
4319
3746
  sig { returns(T::Boolean) }
4320
3747
  attr_accessor :enabled
4321
-
4322
3748
  # The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
4323
3749
  sig { returns(Integer) }
4324
3750
  attr_accessor :maximum
4325
-
4326
3751
  # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
4327
3752
  sig { returns(Integer) }
4328
3753
  attr_accessor :minimum
4329
-
4330
3754
  sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
4331
3755
  def initialize(enabled: nil, maximum: nil, minimum: nil); end
4332
3756
  end
4333
3757
  # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
4334
3758
  sig { returns(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity) }
4335
3759
  attr_accessor :adjustable_quantity
4336
-
4337
3760
  # ID of an existing line item.
4338
3761
  sig { returns(String) }
4339
3762
  attr_accessor :id
4340
-
4341
3763
  # 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`.
4342
3764
  sig { returns(T.nilable(T::Hash[String, String])) }
4343
3765
  attr_accessor :metadata
4344
-
4345
3766
  # The ID of the [Price](https://stripe.com/docs/api/prices).
4346
3767
  sig { returns(String) }
4347
3768
  attr_accessor :price
4348
-
4349
3769
  # The quantity of the line item being purchased.
4350
3770
  sig { returns(Integer) }
4351
3771
  attr_accessor :quantity
4352
-
4353
3772
  # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
4354
3773
  sig { returns(T.nilable(T::Array[String])) }
4355
3774
  attr_accessor :tax_rates
4356
-
4357
3775
  sig {
4358
3776
  params(adjustable_quantity: ::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity, id: String, metadata: T.nilable(T::Hash[String, String]), price: String, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
4359
3777
  }
@@ -4373,11 +3791,9 @@ module Stripe
4373
3791
  # A unit of time.
4374
3792
  sig { returns(String) }
4375
3793
  attr_accessor :unit
4376
-
4377
3794
  # Must be greater than 0.
4378
3795
  sig { returns(Integer) }
4379
3796
  attr_accessor :value
4380
-
4381
3797
  sig { params(unit: String, value: Integer).void }
4382
3798
  def initialize(unit: nil, value: nil); end
4383
3799
  end
@@ -4385,11 +3801,9 @@ module Stripe
4385
3801
  # A unit of time.
4386
3802
  sig { returns(String) }
4387
3803
  attr_accessor :unit
4388
-
4389
3804
  # Must be greater than 0.
4390
3805
  sig { returns(Integer) }
4391
3806
  attr_accessor :value
4392
-
4393
3807
  sig { params(unit: String, value: Integer).void }
4394
3808
  def initialize(unit: nil, value: nil); end
4395
3809
  end
@@ -4398,13 +3812,11 @@ module Stripe
4398
3812
  returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
4399
3813
  }
4400
3814
  attr_accessor :maximum
4401
-
4402
3815
  # The lower bound of the estimated range. If empty, represents no lower bound.
4403
3816
  sig {
4404
3817
  returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
4405
3818
  }
4406
3819
  attr_accessor :minimum
4407
-
4408
3820
  sig {
4409
3821
  params(maximum: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
4410
3822
  }
@@ -4415,28 +3827,23 @@ module Stripe
4415
3827
  # A non-negative integer in cents representing how much to charge.
4416
3828
  sig { returns(Integer) }
4417
3829
  attr_accessor :amount
4418
-
4419
3830
  # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
4420
3831
  sig { returns(String) }
4421
3832
  attr_accessor :tax_behavior
4422
-
4423
3833
  sig { params(amount: Integer, tax_behavior: String).void }
4424
3834
  def initialize(amount: nil, tax_behavior: nil); end
4425
3835
  end
4426
3836
  # A non-negative integer in cents representing how much to charge.
4427
3837
  sig { returns(Integer) }
4428
3838
  attr_accessor :amount
4429
-
4430
3839
  # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
4431
3840
  sig { returns(String) }
4432
3841
  attr_accessor :currency
4433
-
4434
3842
  # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
4435
3843
  sig {
4436
3844
  returns(T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
4437
3845
  }
4438
3846
  attr_accessor :currency_options
4439
-
4440
3847
  sig {
4441
3848
  params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
4442
3849
  }
@@ -4447,33 +3854,26 @@ module Stripe
4447
3854
  returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
4448
3855
  }
4449
3856
  attr_accessor :delivery_estimate
4450
-
4451
3857
  # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
4452
3858
  sig { returns(String) }
4453
3859
  attr_accessor :display_name
4454
-
4455
3860
  # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
4456
3861
  sig {
4457
3862
  returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount)
4458
3863
  }
4459
3864
  attr_accessor :fixed_amount
4460
-
4461
3865
  # 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`.
4462
3866
  sig { returns(T::Hash[String, String]) }
4463
3867
  attr_accessor :metadata
4464
-
4465
3868
  # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
4466
3869
  sig { returns(String) }
4467
3870
  attr_accessor :tax_behavior
4468
-
4469
3871
  # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
4470
3872
  sig { returns(String) }
4471
3873
  attr_accessor :tax_code
4472
-
4473
3874
  # The type of calculation to use on the shipping rate.
4474
3875
  sig { returns(String) }
4475
3876
  attr_accessor :type
4476
-
4477
3877
  sig {
4478
3878
  params(delivery_estimate: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
4479
3879
  }
@@ -4490,13 +3890,11 @@ module Stripe
4490
3890
  # The ID of the Shipping Rate to use for this shipping option.
4491
3891
  sig { returns(String) }
4492
3892
  attr_accessor :shipping_rate
4493
-
4494
3893
  # Parameters to be passed to Shipping Rate creation for this shipping option.
4495
3894
  sig {
4496
3895
  returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData)
4497
3896
  }
4498
3897
  attr_accessor :shipping_rate_data
4499
-
4500
3898
  sig {
4501
3899
  params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData).void
4502
3900
  }
@@ -4505,11 +3903,9 @@ module Stripe
4505
3903
  # Information about the customer collected within the Checkout Session.
4506
3904
  sig { returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation) }
4507
3905
  attr_accessor :collected_information
4508
-
4509
3906
  # Specifies which fields in the response should be expanded.
4510
3907
  sig { returns(T::Array[String]) }
4511
3908
  attr_accessor :expand
4512
-
4513
3909
  # A list of items the customer is purchasing.
4514
3910
  #
4515
3911
  # When updating line items, you must retransmit the entire array of line items.
@@ -4525,17 +3921,14 @@ module Stripe
4525
3921
  # To reorder a line item, specify it at the desired position in the retransmitted array.
4526
3922
  sig { returns(T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem]) }
4527
3923
  attr_accessor :line_items
4528
-
4529
3924
  # 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`.
4530
3925
  sig { returns(T.nilable(T::Hash[String, String])) }
4531
3926
  attr_accessor :metadata
4532
-
4533
3927
  # The shipping rate options to apply to this Session. Up to a maximum of 5.
4534
3928
  sig {
4535
3929
  returns(T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption]))
4536
3930
  }
4537
3931
  attr_accessor :shipping_options
4538
-
4539
3932
  sig {
4540
3933
  params(collected_information: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation, expand: T::Array[String], line_items: T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), shipping_options: T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption])).void
4541
3934
  }
@@ -4551,19 +3944,15 @@ module Stripe
4551
3944
  # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
4552
3945
  sig { returns(String) }
4553
3946
  attr_accessor :ending_before
4554
-
4555
3947
  # Specifies which fields in the response should be expanded.
4556
3948
  sig { returns(T::Array[String]) }
4557
3949
  attr_accessor :expand
4558
-
4559
3950
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
4560
3951
  sig { returns(Integer) }
4561
3952
  attr_accessor :limit
4562
-
4563
3953
  # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
4564
3954
  sig { returns(String) }
4565
3955
  attr_accessor :starting_after
4566
-
4567
3956
  sig {
4568
3957
  params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
4569
3958
  }
@@ -4573,7 +3962,6 @@ module Stripe
4573
3962
  # Specifies which fields in the response should be expanded.
4574
3963
  sig { returns(T::Array[String]) }
4575
3964
  attr_accessor :expand
4576
-
4577
3965
  sig { params(expand: T::Array[String]).void }
4578
3966
  def initialize(expand: nil); end
4579
3967
  end