stripe 13.6.0.pre.beta.1 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (556) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +699 -1457
  3. data/OPENAPI_VERSION +1 -1
  4. data/README.md +29 -0
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_requestor.rb +2 -0
  7. data/lib/stripe/api_version.rb +1 -1
  8. data/lib/stripe/errors.rb +0 -7
  9. data/lib/stripe/object_types.rb +0 -26
  10. data/lib/stripe/resources/account.rb +83 -614
  11. data/lib/stripe/resources/account_session.rb +1 -247
  12. data/lib/stripe/resources/apple_pay_domain.rb +0 -9
  13. data/lib/stripe/resources/application_fee.rb +1 -10
  14. data/lib/stripe/resources/balance.rb +0 -9
  15. data/lib/stripe/resources/balance_transaction.rb +2 -11
  16. data/lib/stripe/resources/bank_account.rb +1 -1
  17. data/lib/stripe/resources/billing/alert.rb +0 -9
  18. data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -48
  19. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -9
  20. data/lib/stripe/resources/billing/credit_grant.rb +4 -13
  21. data/lib/stripe/resources/billing/meter.rb +1 -10
  22. data/lib/stripe/resources/billing_portal/configuration.rb +0 -9
  23. data/lib/stripe/resources/card.rb +2 -4
  24. data/lib/stripe/resources/charge.rb +35 -1457
  25. data/lib/stripe/resources/checkout/session.rb +100 -293
  26. data/lib/stripe/resources/climate/order.rb +0 -9
  27. data/lib/stripe/resources/climate/product.rb +0 -9
  28. data/lib/stripe/resources/climate/supplier.rb +0 -9
  29. data/lib/stripe/resources/confirmation_token.rb +74 -156
  30. data/lib/stripe/resources/country_spec.rb +0 -9
  31. data/lib/stripe/resources/coupon.rb +0 -9
  32. data/lib/stripe/resources/credit_note.rb +14 -35
  33. data/lib/stripe/resources/credit_note_line_item.rb +14 -12
  34. data/lib/stripe/resources/customer.rb +12 -28
  35. data/lib/stripe/resources/customer_balance_transaction.rb +3 -1
  36. data/lib/stripe/resources/dispute.rb +0 -9
  37. data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -9
  38. data/lib/stripe/resources/entitlements/feature.rb +0 -9
  39. data/lib/stripe/resources/event.rb +0 -40
  40. data/lib/stripe/resources/exchange_rate.rb +0 -9
  41. data/lib/stripe/resources/file.rb +0 -9
  42. data/lib/stripe/resources/file_link.rb +0 -9
  43. data/lib/stripe/resources/financial_connections/account.rb +0 -23
  44. data/lib/stripe/resources/financial_connections/session.rb +1 -65
  45. data/lib/stripe/resources/financial_connections/transaction.rb +0 -9
  46. data/lib/stripe/resources/forwarding/request.rb +0 -9
  47. data/lib/stripe/resources/identity/verification_report.rb +0 -9
  48. data/lib/stripe/resources/identity/verification_session.rb +0 -9
  49. data/lib/stripe/resources/invoice.rb +225 -5120
  50. data/lib/stripe/resources/invoice_item.rb +65 -110
  51. data/lib/stripe/resources/invoice_line_item.rb +106 -89
  52. data/lib/stripe/resources/invoice_payment.rb +53 -4
  53. data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
  54. data/lib/stripe/resources/issuing/authorization.rb +0 -9
  55. data/lib/stripe/resources/issuing/card.rb +0 -9
  56. data/lib/stripe/resources/issuing/cardholder.rb +1 -11
  57. data/lib/stripe/resources/issuing/dispute.rb +0 -9
  58. data/lib/stripe/resources/issuing/personalization_design.rb +0 -9
  59. data/lib/stripe/resources/issuing/physical_bundle.rb +0 -9
  60. data/lib/stripe/resources/issuing/token.rb +0 -9
  61. data/lib/stripe/resources/issuing/transaction.rb +0 -15
  62. data/lib/stripe/resources/line_item.rb +0 -28
  63. data/lib/stripe/resources/mandate.rb +6 -33
  64. data/lib/stripe/resources/payment_intent.rb +642 -4975
  65. data/lib/stripe/resources/payment_link.rb +84 -15
  66. data/lib/stripe/resources/payment_method.rb +74 -187
  67. data/lib/stripe/resources/payment_method_configuration.rb +87 -214
  68. data/lib/stripe/resources/payment_method_domain.rb +9 -18
  69. data/lib/stripe/resources/payout.rb +0 -9
  70. data/lib/stripe/resources/person.rb +9 -9
  71. data/lib/stripe/resources/plan.rb +0 -15
  72. data/lib/stripe/resources/price.rb +2 -47
  73. data/lib/stripe/resources/product.rb +0 -68
  74. data/lib/stripe/resources/promotion_code.rb +0 -9
  75. data/lib/stripe/resources/quote.rb +8 -2037
  76. data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -9
  77. data/lib/stripe/resources/radar/value_list.rb +0 -9
  78. data/lib/stripe/resources/radar/value_list_item.rb +0 -9
  79. data/lib/stripe/resources/refund.rb +13 -18
  80. data/lib/stripe/resources/reporting/report_run.rb +0 -9
  81. data/lib/stripe/resources/reporting/report_type.rb +0 -9
  82. data/lib/stripe/resources/review.rb +2 -11
  83. data/lib/stripe/resources/setup_attempt.rb +11 -16
  84. data/lib/stripe/resources/setup_intent.rb +158 -540
  85. data/lib/stripe/resources/shipping_rate.rb +0 -9
  86. data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -9
  87. data/lib/stripe/resources/source.rb +0 -41
  88. data/lib/stripe/resources/subscription.rb +14 -385
  89. data/lib/stripe/resources/subscription_item.rb +9 -134
  90. data/lib/stripe/resources/subscription_schedule.rb +14 -1135
  91. data/lib/stripe/resources/tax/calculation.rb +0 -9
  92. data/lib/stripe/resources/tax/registration.rb +1 -10
  93. data/lib/stripe/resources/tax/settings.rb +0 -9
  94. data/lib/stripe/resources/tax/transaction.rb +0 -9
  95. data/lib/stripe/resources/tax_code.rb +0 -9
  96. data/lib/stripe/resources/tax_id.rb +0 -9
  97. data/lib/stripe/resources/tax_rate.rb +0 -9
  98. data/lib/stripe/resources/terminal/configuration.rb +214 -14
  99. data/lib/stripe/resources/terminal/location.rb +0 -9
  100. data/lib/stripe/resources/terminal/reader.rb +0 -408
  101. data/lib/stripe/resources/test_helpers/test_clock.rb +0 -9
  102. data/lib/stripe/resources/token.rb +1 -10
  103. data/lib/stripe/resources/topup.rb +0 -9
  104. data/lib/stripe/resources/transfer.rb +0 -9
  105. data/lib/stripe/resources/treasury/credit_reversal.rb +0 -9
  106. data/lib/stripe/resources/treasury/debit_reversal.rb +0 -9
  107. data/lib/stripe/resources/treasury/financial_account.rb +4 -32
  108. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
  109. data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -9
  110. data/lib/stripe/resources/treasury/outbound_payment.rb +0 -9
  111. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -46
  112. data/lib/stripe/resources/treasury/received_credit.rb +1 -47
  113. data/lib/stripe/resources/treasury/received_debit.rb +1 -49
  114. data/lib/stripe/resources/treasury/transaction.rb +0 -9
  115. data/lib/stripe/resources/treasury/transaction_entry.rb +0 -9
  116. data/lib/stripe/resources/v2/event.rb +1 -0
  117. data/lib/stripe/resources/v2/event_destination.rb +1 -0
  118. data/lib/stripe/resources/webhook_endpoint.rb +0 -9
  119. data/lib/stripe/resources.rb +0 -25
  120. data/lib/stripe/services/account_external_account_service.rb +1 -1
  121. data/lib/stripe/services/account_service.rb +68 -509
  122. data/lib/stripe/services/account_session_service.rb +1 -217
  123. data/lib/stripe/services/balance_transaction_service.rb +1 -1
  124. data/lib/stripe/services/billing/credit_balance_summary_service.rb +2 -2
  125. data/lib/stripe/services/billing/credit_grant_service.rb +2 -2
  126. data/lib/stripe/services/billing/meter_service.rb +1 -1
  127. data/lib/stripe/services/charge_service.rb +1 -1335
  128. data/lib/stripe/services/checkout/session_service.rb +60 -168
  129. data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -4
  130. data/lib/stripe/services/credit_note_service.rb +0 -8
  131. data/lib/stripe/services/customer_service.rb +0 -16
  132. data/lib/stripe/services/financial_connections/account_service.rb +1 -3
  133. data/lib/stripe/services/financial_connections/session_service.rb +1 -30
  134. data/lib/stripe/services/financial_connections_service.rb +1 -2
  135. data/lib/stripe/services/invoice_item_service.rb +34 -88
  136. data/lib/stripe/services/invoice_line_item_service.rb +25 -41
  137. data/lib/stripe/services/invoice_payment_service.rb +33 -5
  138. data/lib/stripe/services/invoice_service.rb +210 -3147
  139. data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
  140. data/lib/stripe/services/issuing/transaction_service.rb +0 -4
  141. data/lib/stripe/services/issuing_service.rb +1 -5
  142. data/lib/stripe/services/payment_intent_service.rb +568 -4513
  143. data/lib/stripe/services/payment_link_service.rb +59 -6
  144. data/lib/stripe/services/payment_method_configuration_service.rb +62 -146
  145. data/lib/stripe/services/payment_method_domain_service.rb +6 -6
  146. data/lib/stripe/services/payment_method_service.rb +49 -119
  147. data/lib/stripe/services/plan_service.rb +0 -4
  148. data/lib/stripe/services/price_service.rb +2 -25
  149. data/lib/stripe/services/product_service.rb +0 -38
  150. data/lib/stripe/services/quote_service.rb +9 -1716
  151. data/lib/stripe/services/setup_intent_service.rb +158 -492
  152. data/lib/stripe/services/subscription_item_service.rb +5 -111
  153. data/lib/stripe/services/subscription_schedule_service.rb +14 -1005
  154. data/lib/stripe/services/subscription_service.rb +13 -323
  155. data/lib/stripe/services/tax/registration_service.rb +1 -1
  156. data/lib/stripe/services/tax_service.rb +1 -3
  157. data/lib/stripe/services/terminal/configuration_service.rb +170 -4
  158. data/lib/stripe/services/terminal/reader_service.rb +0 -177
  159. data/lib/stripe/services/terminal_service.rb +1 -2
  160. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +49 -87
  161. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -43
  162. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
  163. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
  164. data/lib/stripe/services/token_service.rb +1 -1
  165. data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
  166. data/lib/stripe/services/treasury/financial_account_service.rb +3 -17
  167. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
  168. data/lib/stripe/services/v1_services.rb +2 -8
  169. data/lib/stripe/services/v2/core/event_destination_service.rb +1 -4
  170. data/lib/stripe/services/v2/core/event_service.rb +1 -4
  171. data/lib/stripe/services.rb +0 -27
  172. data/lib/stripe/stripe_client.rb +1 -0
  173. data/lib/stripe/stripe_configuration.rb +1 -3
  174. data/lib/stripe/util.rb +1 -7
  175. data/lib/stripe/version.rb +1 -1
  176. data/lib/stripe.rb +0 -45
  177. data/rbi/stripe/resources/account.rbi +1131 -1479
  178. data/rbi/stripe/resources/account_link.rbi +9 -9
  179. data/rbi/stripe/resources/account_session.rbi +118 -367
  180. data/rbi/stripe/resources/apple_pay_domain.rbi +8 -15
  181. data/rbi/stripe/resources/application_fee.rbi +15 -20
  182. data/rbi/stripe/resources/apps/secret.rbi +20 -20
  183. data/rbi/stripe/resources/balance.rbi +0 -7
  184. data/rbi/stripe/resources/balance_transaction.rbi +19 -24
  185. data/rbi/stripe/resources/bank_account.rbi +1 -1
  186. data/rbi/stripe/resources/billing/alert.rbi +23 -28
  187. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -53
  188. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +6 -13
  189. data/rbi/stripe/resources/billing/credit_grant.rbi +30 -37
  190. data/rbi/stripe/resources/billing/meter.rbi +19 -26
  191. data/rbi/stripe/resources/billing/meter_event.rbi +4 -4
  192. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +5 -5
  193. data/rbi/stripe/resources/billing_portal/configuration.rbi +86 -81
  194. data/rbi/stripe/resources/billing_portal/session.rbi +31 -27
  195. data/rbi/stripe/resources/card.rbi +2 -5
  196. data/rbi/stripe/resources/charge.rbi +136 -1576
  197. data/rbi/stripe/resources/checkout/session.rbi +631 -748
  198. data/rbi/stripe/resources/climate/order.rbi +20 -25
  199. data/rbi/stripe/resources/climate/product.rbi +5 -12
  200. data/rbi/stripe/resources/climate/supplier.rbi +5 -12
  201. data/rbi/stripe/resources/confirmation_token.rbi +274 -268
  202. data/rbi/stripe/resources/country_spec.rbi +5 -12
  203. data/rbi/stripe/resources/coupon.rbi +34 -39
  204. data/rbi/stripe/resources/credit_note.rbi +134 -146
  205. data/rbi/stripe/resources/credit_note_line_item.rbi +20 -18
  206. data/rbi/stripe/resources/customer.rbi +172 -164
  207. data/rbi/stripe/resources/customer_balance_transaction.rbi +4 -1
  208. data/rbi/stripe/resources/customer_session.rbi +19 -15
  209. data/rbi/stripe/resources/dispute.rbi +92 -95
  210. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +5 -12
  211. data/rbi/stripe/resources/entitlements/feature.rbi +15 -22
  212. data/rbi/stripe/resources/ephemeral_key.rbi +2 -2
  213. data/rbi/stripe/resources/event.rbi +16 -60
  214. data/rbi/stripe/resources/exchange_rate.rbi +5 -12
  215. data/rbi/stripe/resources/file.rbi +20 -25
  216. data/rbi/stripe/resources/file_link.rbi +23 -28
  217. data/rbi/stripe/resources/financial_connections/account.rbi +25 -44
  218. data/rbi/stripe/resources/financial_connections/session.rbi +12 -75
  219. data/rbi/stripe/resources/financial_connections/transaction.rbi +16 -19
  220. data/rbi/stripe/resources/forwarding/request.rbi +21 -24
  221. data/rbi/stripe/resources/identity/verification_report.rbi +18 -21
  222. data/rbi/stripe/resources/identity/verification_session.rbi +60 -61
  223. data/rbi/stripe/resources/invoice.rbi +723 -5918
  224. data/rbi/stripe/resources/invoice_item.rbi +138 -177
  225. data/rbi/stripe/resources/invoice_line_item.rbi +199 -264
  226. data/rbi/stripe/resources/invoice_payment.rbi +51 -7
  227. data/rbi/stripe/resources/invoice_rendering_template.rbi +10 -20
  228. data/rbi/stripe/resources/issuing/authorization.rbi +216 -199
  229. data/rbi/stripe/resources/issuing/card.rbi +104 -101
  230. data/rbi/stripe/resources/issuing/cardholder.rbi +120 -108
  231. data/rbi/stripe/resources/issuing/dispute.rbi +164 -151
  232. data/rbi/stripe/resources/issuing/personalization_design.rbi +61 -56
  233. data/rbi/stripe/resources/issuing/physical_bundle.rbi +7 -14
  234. data/rbi/stripe/resources/issuing/token.rbi +16 -21
  235. data/rbi/stripe/resources/issuing/transaction.rbi +180 -176
  236. data/rbi/stripe/resources/line_item.rbi +0 -36
  237. data/rbi/stripe/resources/mandate.rbi +8 -40
  238. data/rbi/stripe/resources/payment_intent.rbi +2252 -6482
  239. data/rbi/stripe/resources/payment_link.rbi +346 -211
  240. data/rbi/stripe/resources/payment_method.rbi +226 -330
  241. data/rbi/stripe/resources/payment_method_configuration.rbi +602 -685
  242. data/rbi/stripe/resources/payment_method_domain.rbi +26 -31
  243. data/rbi/stripe/resources/payout.rbi +43 -42
  244. data/rbi/stripe/resources/person.rbi +9 -9
  245. data/rbi/stripe/resources/plan.rbi +51 -63
  246. data/rbi/stripe/resources/price.rbi +114 -151
  247. data/rbi/stripe/resources/product.rbi +90 -152
  248. data/rbi/stripe/resources/promotion_code.rbi +42 -47
  249. data/rbi/stripe/resources/quote.rbi +168 -2231
  250. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +17 -20
  251. data/rbi/stripe/resources/radar/value_list.rbi +24 -29
  252. data/rbi/stripe/resources/radar/value_list_item.rbi +18 -21
  253. data/rbi/stripe/resources/refund.rbi +52 -51
  254. data/rbi/stripe/resources/reporting/report_run.rbi +27 -30
  255. data/rbi/stripe/resources/reporting/report_type.rbi +2 -9
  256. data/rbi/stripe/resources/review.rbi +17 -22
  257. data/rbi/stripe/resources/setup_attempt.rbi +25 -32
  258. data/rbi/stripe/resources/setup_intent.rbi +900 -1102
  259. data/rbi/stripe/resources/shipping_rate.rbi +41 -46
  260. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +5 -12
  261. data/rbi/stripe/resources/source.rbi +132 -179
  262. data/rbi/stripe/resources/subscription.rbi +363 -707
  263. data/rbi/stripe/resources/subscription_item.rbi +69 -177
  264. data/rbi/stripe/resources/subscription_schedule.rbi +289 -1447
  265. data/rbi/stripe/resources/tax/calculation.rbi +43 -48
  266. data/rbi/stripe/resources/tax/registration.rbi +217 -170
  267. data/rbi/stripe/resources/tax/settings.rbi +14 -21
  268. data/rbi/stripe/resources/tax/transaction.rbi +20 -25
  269. data/rbi/stripe/resources/tax_code.rbi +5 -12
  270. data/rbi/stripe/resources/tax_id.rbi +15 -22
  271. data/rbi/stripe/resources/tax_rate.rbi +34 -39
  272. data/rbi/stripe/resources/terminal/configuration.rbi +457 -212
  273. data/rbi/stripe/resources/terminal/connection_token.rbi +3 -3
  274. data/rbi/stripe/resources/terminal/location.rbi +28 -35
  275. data/rbi/stripe/resources/terminal/reader.rbi +71 -441
  276. data/rbi/stripe/resources/test_helpers/test_clock.rbi +12 -17
  277. data/rbi/stripe/resources/token.rbi +288 -263
  278. data/rbi/stripe/resources/topup.rbi +35 -38
  279. data/rbi/stripe/resources/transfer.rbi +27 -32
  280. data/rbi/stripe/resources/treasury/credit_reversal.rbi +10 -17
  281. data/rbi/stripe/resources/treasury/debit_reversal.rbi +11 -18
  282. data/rbi/stripe/resources/treasury/financial_account.rbi +125 -130
  283. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -3
  284. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +22 -29
  285. data/rbi/stripe/resources/treasury/outbound_payment.rbi +82 -79
  286. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +44 -86
  287. data/rbi/stripe/resources/treasury/received_credit.rbi +18 -64
  288. data/rbi/stripe/resources/treasury/received_debit.rbi +17 -66
  289. data/rbi/stripe/resources/treasury/transaction.rbi +27 -28
  290. data/rbi/stripe/resources/treasury/transaction_entry.rbi +25 -26
  291. data/rbi/stripe/resources/v2/amount.rbi +1 -1
  292. data/rbi/stripe/resources/v2/event.rbi +1 -0
  293. data/rbi/stripe/resources/v2/event_destination.rbi +1 -0
  294. data/rbi/stripe/resources/webhook_endpoint.rbi +18 -25
  295. data/rbi/stripe/services/account_capability_service.rbi +7 -7
  296. data/rbi/stripe/services/account_external_account_service.rbi +52 -52
  297. data/rbi/stripe/services/account_link_service.rbi +9 -9
  298. data/rbi/stripe/services/account_login_link_service.rbi +2 -2
  299. data/rbi/stripe/services/account_person_service.rbi +221 -201
  300. data/rbi/stripe/services/account_service.rbi +1221 -1345
  301. data/rbi/stripe/services/account_session_service.rbi +115 -346
  302. data/rbi/stripe/services/apple_pay_domain_service.rbi +10 -10
  303. data/rbi/stripe/services/application_fee_refund_service.rbi +16 -14
  304. data/rbi/stripe/services/application_fee_service.rbi +18 -14
  305. data/rbi/stripe/services/apps/secret_service.rbi +20 -20
  306. data/rbi/stripe/services/balance_service.rbi +2 -2
  307. data/rbi/stripe/services/balance_transaction_service.rbi +22 -18
  308. data/rbi/stripe/services/billing/alert_service.rbi +23 -23
  309. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +10 -10
  310. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +8 -8
  311. data/rbi/stripe/services/billing/credit_grant_service.rbi +32 -30
  312. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +7 -5
  313. data/rbi/stripe/services/billing/meter_event_service.rbi +4 -4
  314. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +6 -6
  315. data/rbi/stripe/services/billing/meter_service.rbi +21 -21
  316. data/rbi/stripe/services/billing_portal/configuration_service.rbi +90 -76
  317. data/rbi/stripe/services/billing_portal/session_service.rbi +29 -27
  318. data/rbi/stripe/services/charge_service.rbi +96 -1464
  319. data/rbi/stripe/services/checkout/session_line_item_service.rbi +5 -5
  320. data/rbi/stripe/services/checkout/session_service.rbi +555 -591
  321. data/rbi/stripe/services/climate/order_service.rbi +22 -20
  322. data/rbi/stripe/services/climate/product_service.rbi +7 -7
  323. data/rbi/stripe/services/climate/supplier_service.rbi +7 -7
  324. data/rbi/stripe/services/confirmation_token_service.rbi +2 -2
  325. data/rbi/stripe/services/country_spec_service.rbi +7 -7
  326. data/rbi/stripe/services/coupon_service.rbi +40 -34
  327. data/rbi/stripe/services/credit_note_line_item_service.rbi +5 -5
  328. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +35 -35
  329. data/rbi/stripe/services/credit_note_service.rbi +81 -85
  330. data/rbi/stripe/services/customer_balance_transaction_service.rbi +15 -15
  331. data/rbi/stripe/services/customer_cash_balance_service.rbi +7 -7
  332. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +7 -7
  333. data/rbi/stripe/services/customer_funding_instructions_service.rbi +5 -5
  334. data/rbi/stripe/services/customer_payment_method_service.rbi +9 -9
  335. data/rbi/stripe/services/customer_payment_source_service.rbi +48 -44
  336. data/rbi/stripe/services/customer_service.rbi +143 -139
  337. data/rbi/stripe/services/customer_session_service.rbi +21 -15
  338. data/rbi/stripe/services/customer_tax_id_service.rbi +9 -9
  339. data/rbi/stripe/services/dispute_service.rbi +92 -90
  340. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +7 -7
  341. data/rbi/stripe/services/entitlements/feature_service.rbi +17 -17
  342. data/rbi/stripe/services/ephemeral_key_service.rbi +8 -8
  343. data/rbi/stripe/services/event_service.rbi +18 -16
  344. data/rbi/stripe/services/exchange_rate_service.rbi +7 -7
  345. data/rbi/stripe/services/file_link_service.rbi +25 -23
  346. data/rbi/stripe/services/file_service.rbi +22 -20
  347. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +5 -5
  348. data/rbi/stripe/services/financial_connections/account_service.rbi +22 -21
  349. data/rbi/stripe/services/financial_connections/session_service.rbi +16 -39
  350. data/rbi/stripe/services/financial_connections/transaction_service.rbi +16 -14
  351. data/rbi/stripe/services/financial_connections_service.rbi +0 -1
  352. data/rbi/stripe/services/forwarding/request_service.rbi +21 -19
  353. data/rbi/stripe/services/identity/verification_report_service.rbi +18 -16
  354. data/rbi/stripe/services/identity/verification_session_service.rbi +62 -56
  355. data/rbi/stripe/services/invoice_item_service.rbi +99 -155
  356. data/rbi/stripe/services/invoice_line_item_service.rbi +71 -82
  357. data/rbi/stripe/services/invoice_payment_service.rbi +39 -12
  358. data/rbi/stripe/services/invoice_rendering_template_service.rbi +13 -13
  359. data/rbi/stripe/services/invoice_service.rbi +679 -3799
  360. data/rbi/stripe/services/issuing/authorization_service.rbi +32 -26
  361. data/rbi/stripe/services/issuing/card_service.rbi +102 -86
  362. data/rbi/stripe/services/issuing/cardholder_service.rbi +122 -103
  363. data/rbi/stripe/services/issuing/dispute_service.rbi +152 -146
  364. data/rbi/stripe/services/issuing/personalization_design_service.rbi +52 -42
  365. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +9 -9
  366. data/rbi/stripe/services/issuing/token_service.rbi +20 -16
  367. data/rbi/stripe/services/issuing/transaction_service.rbi +25 -23
  368. data/rbi/stripe/services/issuing_service.rbi +0 -3
  369. data/rbi/stripe/services/mandate_service.rbi +2 -2
  370. data/rbi/stripe/services/payment_intent_service.rbi +2312 -6081
  371. data/rbi/stripe/services/payment_link_line_item_service.rbi +5 -5
  372. data/rbi/stripe/services/payment_link_service.rbi +303 -201
  373. data/rbi/stripe/services/payment_method_configuration_service.rbi +616 -620
  374. data/rbi/stripe/services/payment_method_domain_service.rbi +25 -23
  375. data/rbi/stripe/services/payment_method_service.rbi +192 -249
  376. data/rbi/stripe/services/payout_service.rbi +45 -37
  377. data/rbi/stripe/services/plan_service.rbi +53 -55
  378. data/rbi/stripe/services/price_service.rbi +124 -129
  379. data/rbi/stripe/services/product_feature_service.rbi +9 -9
  380. data/rbi/stripe/services/product_service.rbi +94 -122
  381. data/rbi/stripe/services/promotion_code_service.rbi +46 -42
  382. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +5 -5
  383. data/rbi/stripe/services/quote_line_item_service.rbi +5 -5
  384. data/rbi/stripe/services/quote_service.rbi +159 -1863
  385. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +17 -15
  386. data/rbi/stripe/services/radar/value_list_item_service.rbi +20 -16
  387. data/rbi/stripe/services/radar/value_list_service.rbi +28 -24
  388. data/rbi/stripe/services/refund_service.rbi +37 -33
  389. data/rbi/stripe/services/reporting/report_run_service.rbi +29 -25
  390. data/rbi/stripe/services/reporting/report_type_service.rbi +4 -4
  391. data/rbi/stripe/services/review_service.rbi +17 -15
  392. data/rbi/stripe/services/setup_attempt_service.rbi +13 -11
  393. data/rbi/stripe/services/setup_intent_service.rbi +1028 -1062
  394. data/rbi/stripe/services/shipping_rate_service.rbi +47 -41
  395. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +7 -7
  396. data/rbi/stripe/services/source_service.rbi +149 -133
  397. data/rbi/stripe/services/source_transaction_service.rbi +5 -5
  398. data/rbi/stripe/services/subscription_item_service.rbi +61 -159
  399. data/rbi/stripe/services/subscription_schedule_service.rbi +289 -1305
  400. data/rbi/stripe/services/subscription_service.rbi +366 -640
  401. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +5 -5
  402. data/rbi/stripe/services/tax/calculation_service.rbi +40 -38
  403. data/rbi/stripe/services/tax/registration_service.rbi +337 -165
  404. data/rbi/stripe/services/tax/settings_service.rbi +16 -16
  405. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +5 -5
  406. data/rbi/stripe/services/tax/transaction_service.rbi +19 -15
  407. data/rbi/stripe/services/tax_code_service.rbi +7 -7
  408. data/rbi/stripe/services/tax_id_service.rbi +17 -17
  409. data/rbi/stripe/services/tax_rate_service.rbi +36 -34
  410. data/rbi/stripe/services/tax_service.rbi +0 -2
  411. data/rbi/stripe/services/terminal/configuration_service.rbi +464 -204
  412. data/rbi/stripe/services/terminal/connection_token_service.rbi +3 -3
  413. data/rbi/stripe/services/terminal/location_service.rbi +30 -30
  414. data/rbi/stripe/services/terminal/reader_service.rbi +57 -226
  415. data/rbi/stripe/services/terminal_service.rbi +0 -1
  416. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +157 -198
  417. data/rbi/stripe/services/test_helpers/customer_service.rbi +3 -3
  418. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +180 -168
  419. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +10 -10
  420. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +11 -9
  421. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +151 -145
  422. data/rbi/stripe/services/test_helpers/refund_service.rbi +2 -2
  423. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +10 -39
  424. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +14 -12
  425. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +9 -9
  426. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +20 -18
  427. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +20 -18
  428. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +11 -38
  429. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +11 -38
  430. data/rbi/stripe/services/token_service.rbi +292 -258
  431. data/rbi/stripe/services/topup_service.rbi +37 -33
  432. data/rbi/stripe/services/transfer_reversal_service.rbi +18 -16
  433. data/rbi/stripe/services/transfer_service.rbi +29 -27
  434. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +12 -12
  435. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +13 -13
  436. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +23 -26
  437. data/rbi/stripe/services/treasury/financial_account_service.rbi +92 -96
  438. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +15 -15
  439. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +60 -56
  440. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +24 -49
  441. data/rbi/stripe/services/treasury/received_credit_service.rbi +11 -9
  442. data/rbi/stripe/services/treasury/received_debit_service.rbi +8 -8
  443. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +25 -21
  444. data/rbi/stripe/services/treasury/transaction_service.rbi +31 -23
  445. data/rbi/stripe/services/v1_services.rbi +1 -7
  446. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +3 -3
  447. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +3 -3
  448. data/rbi/stripe/services/v2/core/event_destination_service.rbi +21 -24
  449. data/rbi/stripe/services/v2/core/event_service.rbi +3 -6
  450. data/rbi/stripe/services/webhook_endpoint_service.rbi +20 -20
  451. metadata +4 -109
  452. data/lib/stripe/request_signing_authenticator.rb +0 -79
  453. data/lib/stripe/resources/account_notice.rb +0 -132
  454. data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
  455. data/lib/stripe/resources/capital/financing_offer.rb +0 -188
  456. data/lib/stripe/resources/capital/financing_summary.rb +0 -64
  457. data/lib/stripe/resources/capital/financing_transaction.rb +0 -123
  458. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  459. data/lib/stripe/resources/financial_connections/institution.rb +0 -99
  460. data/lib/stripe/resources/gift_cards/card.rb +0 -217
  461. data/lib/stripe/resources/gift_cards/transaction.rb +0 -281
  462. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -611
  463. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -84
  464. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -95
  465. data/lib/stripe/resources/issuing/settlement.rb +0 -49
  466. data/lib/stripe/resources/margin.rb +0 -124
  467. data/lib/stripe/resources/order.rb +0 -2868
  468. data/lib/stripe/resources/payment_attempt_record.rb +0 -184
  469. data/lib/stripe/resources/payment_record.rb +0 -715
  470. data/lib/stripe/resources/quote_line.rb +0 -274
  471. data/lib/stripe/resources/quote_preview_invoice.rb +0 -652
  472. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -362
  473. data/lib/stripe/resources/tax/association.rb +0 -89
  474. data/lib/stripe/resources/tax/form.rb +0 -220
  475. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -40
  476. data/lib/stripe/resources/usage_record.rb +0 -30
  477. data/lib/stripe/resources/usage_record_summary.rb +0 -33
  478. data/lib/stripe/services/account_notice_service.rb +0 -101
  479. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  480. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  481. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  482. data/lib/stripe/services/capital_service.rb +0 -15
  483. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -37
  484. data/lib/stripe/services/financial_connections/institution_service.rb +0 -57
  485. data/lib/stripe/services/gift_cards/card_service.rb +0 -170
  486. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
  487. data/lib/stripe/services/gift_cards_service.rb +0 -14
  488. data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -1881
  489. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  490. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  491. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  492. data/lib/stripe/services/margin_service.rb +0 -119
  493. data/lib/stripe/services/order_line_item_service.rb +0 -35
  494. data/lib/stripe/services/order_service.rb +0 -2268
  495. data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
  496. data/lib/stripe/services/payment_record_service.rb +0 -542
  497. data/lib/stripe/services/quote_line_service.rb +0 -35
  498. data/lib/stripe/services/quote_preview_invoice_service.rb +0 -35
  499. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
  500. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -41
  501. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -37
  502. data/lib/stripe/services/tax/association_service.rb +0 -31
  503. data/lib/stripe/services/tax/form_service.rb +0 -100
  504. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  505. data/rbi/stripe/resources/account_notice.rbi +0 -139
  506. data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -71
  507. data/rbi/stripe/resources/capital/financing_offer.rbi +0 -190
  508. data/rbi/stripe/resources/capital/financing_summary.rbi +0 -74
  509. data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -130
  510. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -27
  511. data/rbi/stripe/resources/financial_connections/institution.rbi +0 -99
  512. data/rbi/stripe/resources/gift_cards/card.rbi +0 -206
  513. data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -257
  514. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -622
  515. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -83
  516. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -90
  517. data/rbi/stripe/resources/issuing/settlement.rbi +0 -62
  518. data/rbi/stripe/resources/margin.rbi +0 -127
  519. data/rbi/stripe/resources/order.rbi +0 -3036
  520. data/rbi/stripe/resources/payment_attempt_record.rbi +0 -215
  521. data/rbi/stripe/resources/payment_record.rbi +0 -722
  522. data/rbi/stripe/resources/quote_line.rbi +0 -350
  523. data/rbi/stripe/resources/quote_preview_invoice.rbi +0 -850
  524. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -474
  525. data/rbi/stripe/resources/tax/association.rbi +0 -94
  526. data/rbi/stripe/resources/tax/form.rbi +0 -224
  527. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -41
  528. data/rbi/stripe/resources/usage_record.rbi +0 -32
  529. data/rbi/stripe/resources/usage_record_summary.rbi +0 -38
  530. data/rbi/stripe/services/account_notice_service.rbi +0 -90
  531. data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -95
  532. data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -22
  533. data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -68
  534. data/rbi/stripe/services/capital_service.rbi +0 -11
  535. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -33
  536. data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -46
  537. data/rbi/stripe/services/gift_cards/card_service.rbi +0 -142
  538. data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -174
  539. data/rbi/stripe/services/gift_cards_service.rbi +0 -10
  540. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +0 -2023
  541. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -498
  542. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -55
  543. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -73
  544. data/rbi/stripe/services/margin_service.rbi +0 -104
  545. data/rbi/stripe/services/order_line_item_service.rbi +0 -31
  546. data/rbi/stripe/services/order_service.rbi +0 -2320
  547. data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -36
  548. data/rbi/stripe/services/payment_record_service.rbi +0 -521
  549. data/rbi/stripe/services/quote_line_service.rbi +0 -31
  550. data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -31
  551. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -31
  552. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -37
  553. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -33
  554. data/rbi/stripe/services/tax/association_service.rbi +0 -25
  555. data/rbi/stripe/services/tax/form_service.rbi +0 -85
  556. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -22
@@ -219,9 +219,6 @@ module Stripe
219
219
  # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
220
220
  sig { returns(T.nilable(String)) }
221
221
  attr_reader :brand
222
- # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
223
- sig { returns(T.nilable(String)) }
224
- attr_reader :brand_product
225
222
  # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
226
223
  sig { returns(T.nilable(String)) }
227
224
  attr_reader :country
@@ -305,6 +302,7 @@ module Stripe
305
302
  sig { returns(T.nilable(String)) }
306
303
  attr_reader :verified_name
307
304
  end
305
+ class Billie < Stripe::StripeObject; end
308
306
  class Blik < Stripe::StripeObject
309
307
  # A unique and immutable identifier assigned by BLIK to every buyer.
310
308
  sig { returns(T.nilable(String)) }
@@ -327,11 +325,6 @@ module Stripe
327
325
  sig { returns(T.nilable(String)) }
328
326
  attr_reader :cvc_check
329
327
  end
330
- class DecrementalAuthorization < Stripe::StripeObject
331
- # Indicates whether or not the decremental authorization feature is supported.
332
- sig { returns(String) }
333
- attr_reader :status
334
- end
335
328
  class ExtendedAuthorization < Stripe::StripeObject
336
329
  # Indicates whether or not the capture window is extended beyond the standard authorization.
337
330
  sig { returns(String) }
@@ -377,11 +370,6 @@ module Stripe
377
370
  sig { returns(String) }
378
371
  attr_reader :status
379
372
  end
380
- class PartialAuthorization < Stripe::StripeObject
381
- # Indicates whether the transaction requested for partial authorization feature and the authorization outcome.
382
- sig { returns(String) }
383
- attr_reader :status
384
- end
385
373
  class ThreeDSecure < Stripe::StripeObject
386
374
  # For authenticated transactions: how the customer was authenticated by
387
375
  # the issuing bank.
@@ -558,9 +546,6 @@ module Stripe
558
546
  # The authorized amount.
559
547
  sig { returns(T.nilable(Integer)) }
560
548
  attr_reader :amount_authorized
561
- # The latest amount intended to be authorized by this charge.
562
- sig { returns(T.nilable(Integer)) }
563
- attr_reader :amount_requested
564
549
  # Authorization code on the charge.
565
550
  sig { returns(T.nilable(String)) }
566
551
  attr_reader :authorization_code
@@ -576,9 +561,6 @@ module Stripe
576
561
  # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
577
562
  sig { returns(T.nilable(String)) }
578
563
  attr_reader :country
579
- # Attribute for field decremental_authorization
580
- sig { returns(DecrementalAuthorization) }
581
- attr_reader :decremental_authorization
582
564
  # A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
583
565
  sig { returns(T.nilable(String)) }
584
566
  attr_reader :description
@@ -637,9 +619,6 @@ module Stripe
637
619
  # Attribute for field overcapture
638
620
  sig { returns(Overcapture) }
639
621
  attr_reader :overcapture
640
- # Attribute for field partial_authorization
641
- sig { returns(PartialAuthorization) }
642
- attr_reader :partial_authorization
643
622
  # Status of a card based on the card issuer.
644
623
  sig { returns(T.nilable(String)) }
645
624
  attr_reader :regulated_status
@@ -817,29 +796,11 @@ module Stripe
817
796
  sig { returns(T.nilable(String)) }
818
797
  attr_reader :verified_name
819
798
  end
820
- class Gopay < Stripe::StripeObject; end
821
799
  class Grabpay < Stripe::StripeObject
822
800
  # Unique transaction id generated by GrabPay
823
801
  sig { returns(T.nilable(String)) }
824
802
  attr_reader :transaction_id
825
803
  end
826
- class IdBankTransfer < Stripe::StripeObject
827
- # Account number of the bank account to transfer funds to.
828
- sig { returns(String) }
829
- attr_reader :account_number
830
- # Bank where the account is located.
831
- sig { returns(String) }
832
- attr_reader :bank
833
- # Local bank code of the bank.
834
- sig { returns(String) }
835
- attr_reader :bank_code
836
- # Name of the bank associated with the bank account.
837
- sig { returns(String) }
838
- attr_reader :bank_name
839
- # Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
840
- sig { returns(String) }
841
- attr_reader :display_name
842
- end
843
804
  class Ideal < Stripe::StripeObject
844
805
  # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
845
806
  sig { returns(T.nilable(String)) }
@@ -1003,7 +964,6 @@ module Stripe
1003
964
  sig { returns(T.nilable(String)) }
1004
965
  attr_reader :country
1005
966
  end
1006
- class MbWay < Stripe::StripeObject; end
1007
967
  class Mobilepay < Stripe::StripeObject
1008
968
  class Card < Stripe::StripeObject
1009
969
  # Brand of the card used in the transaction
@@ -1039,6 +999,26 @@ module Stripe
1039
999
  sig { returns(T.nilable(String)) }
1040
1000
  attr_reader :buyer_id
1041
1001
  end
1002
+ class NzBankAccount < Stripe::StripeObject
1003
+ # The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
1004
+ sig { returns(T.nilable(String)) }
1005
+ attr_reader :account_holder_name
1006
+ # The numeric code for the bank account's bank.
1007
+ sig { returns(String) }
1008
+ attr_reader :bank_code
1009
+ # The name of the bank.
1010
+ sig { returns(String) }
1011
+ attr_reader :bank_name
1012
+ # The numeric code for the bank account's bank branch.
1013
+ sig { returns(String) }
1014
+ attr_reader :branch_code
1015
+ # Last four digits of the bank account number.
1016
+ sig { returns(String) }
1017
+ attr_reader :last4
1018
+ # The suffix of the bank account number.
1019
+ sig { returns(T.nilable(String)) }
1020
+ attr_reader :suffix
1021
+ end
1042
1022
  class Oxxo < Stripe::StripeObject
1043
1023
  # OXXO reference number
1044
1024
  sig { returns(T.nilable(String)) }
@@ -1077,46 +1057,6 @@ module Stripe
1077
1057
  sig { returns(String) }
1078
1058
  attr_reader :status
1079
1059
  end
1080
- class Shipping < Stripe::StripeObject
1081
- # City, district, suburb, town, or village.
1082
- sig { returns(T.nilable(String)) }
1083
- attr_reader :city
1084
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1085
- sig { returns(T.nilable(String)) }
1086
- attr_reader :country
1087
- # Address line 1 (e.g., street, PO Box, or company name).
1088
- sig { returns(T.nilable(String)) }
1089
- attr_reader :line1
1090
- # Address line 2 (e.g., apartment, suite, unit, or building).
1091
- sig { returns(T.nilable(String)) }
1092
- attr_reader :line2
1093
- # ZIP or postal code.
1094
- sig { returns(T.nilable(String)) }
1095
- attr_reader :postal_code
1096
- # State, county, province, or region.
1097
- sig { returns(T.nilable(String)) }
1098
- attr_reader :state
1099
- end
1100
- class VerifiedAddress < Stripe::StripeObject
1101
- # City, district, suburb, town, or village.
1102
- sig { returns(T.nilable(String)) }
1103
- attr_reader :city
1104
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1105
- sig { returns(T.nilable(String)) }
1106
- attr_reader :country
1107
- # Address line 1 (e.g., street, PO Box, or company name).
1108
- sig { returns(T.nilable(String)) }
1109
- attr_reader :line1
1110
- # Address line 2 (e.g., apartment, suite, unit, or building).
1111
- sig { returns(T.nilable(String)) }
1112
- attr_reader :line2
1113
- # ZIP or postal code.
1114
- sig { returns(T.nilable(String)) }
1115
- attr_reader :postal_code
1116
- # State, county, province, or region.
1117
- sig { returns(T.nilable(String)) }
1118
- attr_reader :state
1119
- end
1120
1060
  # Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1121
1061
  sig { returns(T.nilable(String)) }
1122
1062
  attr_reader :country
@@ -1134,41 +1074,9 @@ module Stripe
1134
1074
  # The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
1135
1075
  sig { returns(T.nilable(SellerProtection)) }
1136
1076
  attr_reader :seller_protection
1137
- # The shipping address for the customer, as supplied by the merchant at the point of payment
1138
- # execution. This shipping address will not be updated if the merchant updates the shipping
1139
- # address on the PaymentIntent after the PaymentIntent was successfully confirmed.
1140
- sig { returns(T.nilable(Shipping)) }
1141
- attr_reader :shipping
1142
1077
  # A unique ID generated by PayPal for this transaction.
1143
1078
  sig { returns(T.nilable(String)) }
1144
1079
  attr_reader :transaction_id
1145
- # The shipping address for the customer, as supplied by the merchant at the point of payment
1146
- # execution. This shipping address will not be updated if the merchant updates the shipping
1147
- # address on the PaymentIntent after the PaymentIntent was successfully confirmed.
1148
- sig { returns(T.nilable(VerifiedAddress)) }
1149
- attr_reader :verified_address
1150
- # Owner's verified email. Values are verified or provided by PayPal directly
1151
- # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1152
- sig { returns(T.nilable(String)) }
1153
- attr_reader :verified_email
1154
- # Owner's verified full name. Values are verified or provided by PayPal directly
1155
- # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1156
- sig { returns(T.nilable(String)) }
1157
- attr_reader :verified_name
1158
- end
1159
- class Payto < Stripe::StripeObject
1160
- # Bank-State-Branch number of the bank account.
1161
- sig { returns(T.nilable(String)) }
1162
- attr_reader :bsb_number
1163
- # Last four digits of the bank account number.
1164
- sig { returns(T.nilable(String)) }
1165
- attr_reader :last4
1166
- # ID of the mandate used to make this payment.
1167
- sig { returns(String) }
1168
- attr_reader :mandate
1169
- # The PayID alias for the bank account.
1170
- sig { returns(T.nilable(String)) }
1171
- attr_reader :pay_id
1172
1080
  end
1173
1081
  class Pix < Stripe::StripeObject
1174
1082
  # Unique transaction id generated by BCB
@@ -1180,17 +1088,12 @@ module Stripe
1180
1088
  sig { returns(T.nilable(String)) }
1181
1089
  attr_reader :reference
1182
1090
  end
1183
- class Qris < Stripe::StripeObject; end
1184
- class Rechnung < Stripe::StripeObject; end
1185
1091
  class RevolutPay < Stripe::StripeObject
1186
1092
  class Funding < Stripe::StripeObject
1187
1093
  class Card < Stripe::StripeObject
1188
1094
  # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
1189
1095
  sig { returns(T.nilable(String)) }
1190
1096
  attr_reader :brand
1191
- # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
1192
- sig { returns(T.nilable(String)) }
1193
- attr_reader :brand_product
1194
1097
  # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
1195
1098
  sig { returns(T.nilable(String)) }
1196
1099
  attr_reader :country
@@ -1223,6 +1126,7 @@ module Stripe
1223
1126
  sig { returns(T.nilable(String)) }
1224
1127
  attr_reader :buyer_id
1225
1128
  end
1129
+ class Satispay < Stripe::StripeObject; end
1226
1130
  class SepaCreditTransfer < Stripe::StripeObject
1227
1131
  # Name of the bank associated with the bank account.
1228
1132
  sig { returns(T.nilable(String)) }
@@ -1254,7 +1158,6 @@ module Stripe
1254
1158
  sig { returns(T.nilable(String)) }
1255
1159
  attr_reader :mandate
1256
1160
  end
1257
- class Shopeepay < Stripe::StripeObject; end
1258
1161
  class Sofort < Stripe::StripeObject
1259
1162
  # Bank code of bank associated with the bank account.
1260
1163
  sig { returns(T.nilable(String)) }
@@ -1368,6 +1271,9 @@ module Stripe
1368
1271
  # Attribute for field bancontact
1369
1272
  sig { returns(Bancontact) }
1370
1273
  attr_reader :bancontact
1274
+ # Attribute for field billie
1275
+ sig { returns(Billie) }
1276
+ attr_reader :billie
1371
1277
  # Attribute for field blik
1372
1278
  sig { returns(Blik) }
1373
1279
  attr_reader :blik
@@ -1395,15 +1301,9 @@ module Stripe
1395
1301
  # Attribute for field giropay
1396
1302
  sig { returns(Giropay) }
1397
1303
  attr_reader :giropay
1398
- # Attribute for field gopay
1399
- sig { returns(Gopay) }
1400
- attr_reader :gopay
1401
1304
  # Attribute for field grabpay
1402
1305
  sig { returns(Grabpay) }
1403
1306
  attr_reader :grabpay
1404
- # Attribute for field id_bank_transfer
1405
- sig { returns(IdBankTransfer) }
1406
- attr_reader :id_bank_transfer
1407
1307
  # Attribute for field ideal
1408
1308
  sig { returns(Ideal) }
1409
1309
  attr_reader :ideal
@@ -1425,9 +1325,6 @@ module Stripe
1425
1325
  # Attribute for field link
1426
1326
  sig { returns(Link) }
1427
1327
  attr_reader :link
1428
- # Attribute for field mb_way
1429
- sig { returns(MbWay) }
1430
- attr_reader :mb_way
1431
1328
  # Attribute for field mobilepay
1432
1329
  sig { returns(Mobilepay) }
1433
1330
  attr_reader :mobilepay
@@ -1437,6 +1334,9 @@ module Stripe
1437
1334
  # Attribute for field naver_pay
1438
1335
  sig { returns(NaverPay) }
1439
1336
  attr_reader :naver_pay
1337
+ # Attribute for field nz_bank_account
1338
+ sig { returns(NzBankAccount) }
1339
+ attr_reader :nz_bank_account
1440
1340
  # Attribute for field oxxo
1441
1341
  sig { returns(Oxxo) }
1442
1342
  attr_reader :oxxo
@@ -1455,36 +1355,27 @@ module Stripe
1455
1355
  # Attribute for field paypal
1456
1356
  sig { returns(Paypal) }
1457
1357
  attr_reader :paypal
1458
- # Attribute for field payto
1459
- sig { returns(Payto) }
1460
- attr_reader :payto
1461
1358
  # Attribute for field pix
1462
1359
  sig { returns(Pix) }
1463
1360
  attr_reader :pix
1464
1361
  # Attribute for field promptpay
1465
1362
  sig { returns(Promptpay) }
1466
1363
  attr_reader :promptpay
1467
- # Attribute for field qris
1468
- sig { returns(Qris) }
1469
- attr_reader :qris
1470
- # Attribute for field rechnung
1471
- sig { returns(Rechnung) }
1472
- attr_reader :rechnung
1473
1364
  # Attribute for field revolut_pay
1474
1365
  sig { returns(RevolutPay) }
1475
1366
  attr_reader :revolut_pay
1476
1367
  # Attribute for field samsung_pay
1477
1368
  sig { returns(SamsungPay) }
1478
1369
  attr_reader :samsung_pay
1370
+ # Attribute for field satispay
1371
+ sig { returns(Satispay) }
1372
+ attr_reader :satispay
1479
1373
  # Attribute for field sepa_credit_transfer
1480
1374
  sig { returns(SepaCreditTransfer) }
1481
1375
  attr_reader :sepa_credit_transfer
1482
1376
  # Attribute for field sepa_debit
1483
1377
  sig { returns(SepaDebit) }
1484
1378
  attr_reader :sepa_debit
1485
- # Attribute for field shopeepay
1486
- sig { returns(Shopeepay) }
1487
- attr_reader :shopeepay
1488
1379
  # Attribute for field sofort
1489
1380
  sig { returns(Sofort) }
1490
1381
  attr_reader :sofort
@@ -1515,6 +1406,14 @@ module Stripe
1515
1406
  sig { returns(Zip) }
1516
1407
  attr_reader :zip
1517
1408
  end
1409
+ class PresentmentDetails < Stripe::StripeObject
1410
+ # Amount intended to be collected by this payment, denominated in presentment_currency.
1411
+ sig { returns(Integer) }
1412
+ attr_reader :presentment_amount
1413
+ # Currency presented to the customer during payment.
1414
+ sig { returns(String) }
1415
+ attr_reader :presentment_currency
1416
+ end
1518
1417
  class RadarOptions < Stripe::StripeObject
1519
1418
  # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
1520
1419
  sig { returns(String) }
@@ -1628,9 +1527,6 @@ module Stripe
1628
1527
  # Unique identifier for the object.
1629
1528
  sig { returns(String) }
1630
1529
  attr_reader :id
1631
- # ID of the invoice this charge is for if one exists.
1632
- sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
1633
- attr_reader :invoice
1634
1530
  # Attribute for field level3
1635
1531
  sig { returns(Level3) }
1636
1532
  attr_reader :level3
@@ -1661,6 +1557,9 @@ module Stripe
1661
1557
  # Details about the payment method at the time of the transaction.
1662
1558
  sig { returns(T.nilable(PaymentMethodDetails)) }
1663
1559
  attr_reader :payment_method_details
1560
+ # Attribute for field presentment_details
1561
+ sig { returns(PresentmentDetails) }
1562
+ attr_reader :presentment_details
1664
1563
  # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
1665
1564
  sig { returns(RadarOptions) }
1666
1565
  attr_reader :radar_options
@@ -1716,46 +1615,48 @@ module Stripe
1716
1615
  class ListParams < Stripe::RequestParams
1717
1616
  class Created < Stripe::RequestParams
1718
1617
  # Minimum value to filter by (exclusive)
1719
- sig { returns(Integer) }
1618
+ sig { returns(T.nilable(Integer)) }
1720
1619
  attr_accessor :gt
1721
1620
  # Minimum value to filter by (inclusive)
1722
- sig { returns(Integer) }
1621
+ sig { returns(T.nilable(Integer)) }
1723
1622
  attr_accessor :gte
1724
1623
  # Maximum value to filter by (exclusive)
1725
- sig { returns(Integer) }
1624
+ sig { returns(T.nilable(Integer)) }
1726
1625
  attr_accessor :lt
1727
1626
  # Maximum value to filter by (inclusive)
1728
- sig { returns(Integer) }
1627
+ sig { returns(T.nilable(Integer)) }
1729
1628
  attr_accessor :lte
1730
- sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
1629
+ sig {
1630
+ params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
1631
+ }
1731
1632
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
1732
1633
  end
1733
1634
  # Only return charges that were created during the given date interval.
1734
- sig { returns(T.any(::Stripe::Charge::ListParams::Created, Integer)) }
1635
+ sig { returns(T.nilable(T.any(::Stripe::Charge::ListParams::Created, Integer))) }
1735
1636
  attr_accessor :created
1736
1637
  # Only return charges for the customer specified by this customer ID.
1737
- sig { returns(String) }
1638
+ sig { returns(T.nilable(String)) }
1738
1639
  attr_accessor :customer
1739
1640
  # 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.
1740
- sig { returns(String) }
1641
+ sig { returns(T.nilable(String)) }
1741
1642
  attr_accessor :ending_before
1742
1643
  # Specifies which fields in the response should be expanded.
1743
- sig { returns(T::Array[String]) }
1644
+ sig { returns(T.nilable(T::Array[String])) }
1744
1645
  attr_accessor :expand
1745
1646
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1746
- sig { returns(Integer) }
1647
+ sig { returns(T.nilable(Integer)) }
1747
1648
  attr_accessor :limit
1748
1649
  # Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
1749
- sig { returns(String) }
1650
+ sig { returns(T.nilable(String)) }
1750
1651
  attr_accessor :payment_intent
1751
1652
  # 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.
1752
- sig { returns(String) }
1653
+ sig { returns(T.nilable(String)) }
1753
1654
  attr_accessor :starting_after
1754
1655
  # Only return charges for this transfer group, limited to 100.
1755
- sig { returns(String) }
1656
+ sig { returns(T.nilable(String)) }
1756
1657
  attr_accessor :transfer_group
1757
1658
  sig {
1758
- params(created: T.any(::Stripe::Charge::ListParams::Created, Integer), customer: String, ending_before: String, expand: T::Array[String], limit: Integer, payment_intent: String, starting_after: String, transfer_group: String).void
1659
+ params(created: T.nilable(T.any(::Stripe::Charge::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String), transfer_group: T.nilable(String)).void
1759
1660
  }
1760
1661
  def initialize(
1761
1662
  created: nil,
@@ -1774,40 +1675,40 @@ module Stripe
1774
1675
  sig { returns(String) }
1775
1676
  attr_accessor :account
1776
1677
  # The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount.
1777
- sig { returns(Integer) }
1678
+ sig { returns(T.nilable(Integer)) }
1778
1679
  attr_accessor :amount
1779
- sig { params(account: String, amount: Integer).void }
1680
+ sig { params(account: String, amount: T.nilable(Integer)).void }
1780
1681
  def initialize(account: nil, amount: nil); end
1781
1682
  end
1782
1683
  class RadarOptions < Stripe::RequestParams
1783
1684
  # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
1784
- sig { returns(String) }
1685
+ sig { returns(T.nilable(String)) }
1785
1686
  attr_accessor :session
1786
- sig { params(session: String).void }
1687
+ sig { params(session: T.nilable(String)).void }
1787
1688
  def initialize(session: nil); end
1788
1689
  end
1789
1690
  class Shipping < Stripe::RequestParams
1790
1691
  class Address < Stripe::RequestParams
1791
1692
  # City, district, suburb, town, or village.
1792
- sig { returns(String) }
1693
+ sig { returns(T.nilable(String)) }
1793
1694
  attr_accessor :city
1794
1695
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1795
- sig { returns(String) }
1696
+ sig { returns(T.nilable(String)) }
1796
1697
  attr_accessor :country
1797
1698
  # Address line 1 (e.g., street, PO Box, or company name).
1798
- sig { returns(String) }
1699
+ sig { returns(T.nilable(String)) }
1799
1700
  attr_accessor :line1
1800
1701
  # Address line 2 (e.g., apartment, suite, unit, or building).
1801
- sig { returns(String) }
1702
+ sig { returns(T.nilable(String)) }
1802
1703
  attr_accessor :line2
1803
1704
  # ZIP or postal code.
1804
- sig { returns(String) }
1705
+ sig { returns(T.nilable(String)) }
1805
1706
  attr_accessor :postal_code
1806
1707
  # State, county, province, or region.
1807
- sig { returns(String) }
1708
+ sig { returns(T.nilable(String)) }
1808
1709
  attr_accessor :state
1809
1710
  sig {
1810
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1711
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
1811
1712
  }
1812
1713
  def initialize(
1813
1714
  city: nil,
@@ -1822,93 +1723,93 @@ module Stripe
1822
1723
  sig { returns(::Stripe::Charge::CreateParams::Shipping::Address) }
1823
1724
  attr_accessor :address
1824
1725
  # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1825
- sig { returns(String) }
1726
+ sig { returns(T.nilable(String)) }
1826
1727
  attr_accessor :carrier
1827
1728
  # Recipient name.
1828
1729
  sig { returns(String) }
1829
1730
  attr_accessor :name
1830
1731
  # Recipient phone (including extension).
1831
- sig { returns(String) }
1732
+ sig { returns(T.nilable(String)) }
1832
1733
  attr_accessor :phone
1833
1734
  # 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.
1834
- sig { returns(String) }
1735
+ sig { returns(T.nilable(String)) }
1835
1736
  attr_accessor :tracking_number
1836
1737
  sig {
1837
- params(address: ::Stripe::Charge::CreateParams::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
1738
+ params(address: ::Stripe::Charge::CreateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
1838
1739
  }
1839
1740
  def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
1840
1741
  end
1841
1742
  class TransferData < Stripe::RequestParams
1842
1743
  # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
1843
- sig { returns(Integer) }
1744
+ sig { returns(T.nilable(Integer)) }
1844
1745
  attr_accessor :amount
1845
1746
  # ID of an existing, connected Stripe account.
1846
1747
  sig { returns(String) }
1847
1748
  attr_accessor :destination
1848
- sig { params(amount: Integer, destination: String).void }
1749
+ sig { params(amount: T.nilable(Integer), destination: String).void }
1849
1750
  def initialize(amount: nil, destination: nil); end
1850
1751
  end
1851
1752
  # Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
1852
- sig { returns(Integer) }
1753
+ sig { returns(T.nilable(Integer)) }
1853
1754
  attr_accessor :amount
1854
1755
  # Attribute for param field application_fee
1855
- sig { returns(Integer) }
1756
+ sig { returns(T.nilable(Integer)) }
1856
1757
  attr_accessor :application_fee
1857
1758
  # A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).
1858
- sig { returns(Integer) }
1759
+ sig { returns(T.nilable(Integer)) }
1859
1760
  attr_accessor :application_fee_amount
1860
1761
  # Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.
1861
- sig { returns(T::Boolean) }
1762
+ sig { returns(T.nilable(T::Boolean)) }
1862
1763
  attr_accessor :capture
1863
1764
  # 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).
1864
- sig { returns(String) }
1765
+ sig { returns(T.nilable(String)) }
1865
1766
  attr_accessor :currency
1866
1767
  # The ID of an existing customer that will be charged in this request.
1867
- sig { returns(String) }
1768
+ sig { returns(T.nilable(String)) }
1868
1769
  attr_accessor :customer
1869
1770
  # An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
1870
- sig { returns(String) }
1771
+ sig { returns(T.nilable(String)) }
1871
1772
  attr_accessor :description
1872
1773
  # Attribute for param field destination
1873
- sig { returns(::Stripe::Charge::CreateParams::Destination) }
1774
+ sig { returns(T.nilable(::Stripe::Charge::CreateParams::Destination)) }
1874
1775
  attr_accessor :destination
1875
1776
  # Specifies which fields in the response should be expanded.
1876
- sig { returns(T::Array[String]) }
1777
+ sig { returns(T.nilable(T::Array[String])) }
1877
1778
  attr_accessor :expand
1878
1779
  # 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`.
1879
- sig { returns(T.nilable(T::Hash[String, String])) }
1780
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
1880
1781
  attr_accessor :metadata
1881
1782
  # The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).
1882
- sig { returns(String) }
1783
+ sig { returns(T.nilable(String)) }
1883
1784
  attr_accessor :on_behalf_of
1884
1785
  # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
1885
- sig { returns(::Stripe::Charge::CreateParams::RadarOptions) }
1786
+ sig { returns(T.nilable(::Stripe::Charge::CreateParams::RadarOptions)) }
1886
1787
  attr_accessor :radar_options
1887
1788
  # The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
1888
- sig { returns(String) }
1789
+ sig { returns(T.nilable(String)) }
1889
1790
  attr_accessor :receipt_email
1890
1791
  # Shipping information for the charge. Helps prevent fraud on charges for physical goods.
1891
- sig { returns(::Stripe::Charge::CreateParams::Shipping) }
1792
+ sig { returns(T.nilable(::Stripe::Charge::CreateParams::Shipping)) }
1892
1793
  attr_accessor :shipping
1893
1794
  # A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.
1894
- sig { returns(String) }
1795
+ sig { returns(T.nilable(String)) }
1895
1796
  attr_accessor :source
1896
1797
  # For a non-card charge, text that appears on the customer's statement as the statement descriptor. 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).
1897
1798
  #
1898
1799
  # For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
1899
- sig { returns(String) }
1800
+ sig { returns(T.nilable(String)) }
1900
1801
  attr_accessor :statement_descriptor
1901
1802
  # 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. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
1902
- sig { returns(String) }
1803
+ sig { returns(T.nilable(String)) }
1903
1804
  attr_accessor :statement_descriptor_suffix
1904
1805
  # An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
1905
- sig { returns(::Stripe::Charge::CreateParams::TransferData) }
1806
+ sig { returns(T.nilable(::Stripe::Charge::CreateParams::TransferData)) }
1906
1807
  attr_accessor :transfer_data
1907
1808
  # A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).
1908
- sig { returns(String) }
1809
+ sig { returns(T.nilable(String)) }
1909
1810
  attr_accessor :transfer_group
1910
1811
  sig {
1911
- params(amount: Integer, application_fee: Integer, application_fee_amount: Integer, capture: T::Boolean, currency: String, customer: String, description: String, destination: ::Stripe::Charge::CreateParams::Destination, expand: T::Array[String], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: String, radar_options: ::Stripe::Charge::CreateParams::RadarOptions, receipt_email: String, shipping: ::Stripe::Charge::CreateParams::Shipping, source: String, statement_descriptor: String, statement_descriptor_suffix: String, transfer_data: ::Stripe::Charge::CreateParams::TransferData, transfer_group: String).void
1812
+ params(amount: T.nilable(Integer), application_fee: T.nilable(Integer), application_fee_amount: T.nilable(Integer), capture: T.nilable(T::Boolean), currency: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), destination: T.nilable(::Stripe::Charge::CreateParams::Destination), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), on_behalf_of: T.nilable(String), radar_options: T.nilable(::Stripe::Charge::CreateParams::RadarOptions), receipt_email: T.nilable(String), shipping: T.nilable(::Stripe::Charge::CreateParams::Shipping), source: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::Charge::CreateParams::TransferData), transfer_group: T.nilable(String)).void
1912
1813
  }
1913
1814
  def initialize(
1914
1815
  amount: nil,
@@ -1932,706 +1833,36 @@ module Stripe
1932
1833
  transfer_group: nil
1933
1834
  ); end
1934
1835
  end
1935
- class RetrieveParams < Stripe::RequestParams
1936
- # Specifies which fields in the response should be expanded.
1937
- sig { returns(T::Array[String]) }
1938
- attr_accessor :expand
1939
- sig { params(expand: T::Array[String]).void }
1940
- def initialize(expand: nil); end
1941
- end
1942
1836
  class UpdateParams < Stripe::RequestParams
1943
1837
  class FraudDetails < Stripe::RequestParams
1944
1838
  # Either `safe` or `fraudulent`.
1945
- sig { returns(T.nilable(String)) }
1839
+ sig { returns(T.nilable(T.any(String, String))) }
1946
1840
  attr_accessor :user_report
1947
- sig { params(user_report: T.nilable(String)).void }
1841
+ sig { params(user_report: T.nilable(T.any(String, String))).void }
1948
1842
  def initialize(user_report: nil); end
1949
1843
  end
1950
- class PaymentDetails < Stripe::RequestParams
1951
- class CarRental < Stripe::RequestParams
1952
- class Affiliate < Stripe::RequestParams
1953
- # The name of the affiliate that originated the purchase.
1954
- sig { returns(String) }
1955
- attr_accessor :name
1956
- sig { params(name: String).void }
1957
- def initialize(name: nil); end
1958
- end
1959
- class Delivery < Stripe::RequestParams
1960
- class Recipient < Stripe::RequestParams
1961
- # The email of the recipient the ticket is delivered to.
1962
- sig { returns(String) }
1963
- attr_accessor :email
1964
- # The name of the recipient the ticket is delivered to.
1965
- sig { returns(String) }
1966
- attr_accessor :name
1967
- # The phone number of the recipient the ticket is delivered to.
1968
- sig { returns(String) }
1969
- attr_accessor :phone
1970
- sig { params(email: String, name: String, phone: String).void }
1971
- def initialize(email: nil, name: nil, phone: nil); end
1972
- end
1973
- # The delivery method for the payment
1974
- sig { returns(String) }
1975
- attr_accessor :mode
1976
- # Details of the recipient.
1977
- sig {
1978
- returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)
1979
- }
1980
- attr_accessor :recipient
1981
- sig {
1982
- params(mode: String, recipient: ::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient).void
1983
- }
1984
- def initialize(mode: nil, recipient: nil); end
1985
- end
1986
- class Driver < Stripe::RequestParams
1987
- # Full name of the person or entity on the car reservation.
1988
- sig { returns(String) }
1989
- attr_accessor :name
1990
- sig { params(name: String).void }
1991
- def initialize(name: nil); end
1992
- end
1993
- class PickupAddress < Stripe::RequestParams
1994
- # City, district, suburb, town, or village.
1995
- sig { returns(String) }
1996
- attr_accessor :city
1997
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1998
- sig { returns(String) }
1999
- attr_accessor :country
2000
- # Address line 1 (e.g., street, PO Box, or company name).
2001
- sig { returns(String) }
2002
- attr_accessor :line1
2003
- # Address line 2 (e.g., apartment, suite, unit, or building).
2004
- sig { returns(String) }
2005
- attr_accessor :line2
2006
- # ZIP or postal code.
2007
- sig { returns(String) }
2008
- attr_accessor :postal_code
2009
- # State, county, province, or region.
2010
- sig { returns(String) }
2011
- attr_accessor :state
2012
- sig {
2013
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2014
- }
2015
- def initialize(
2016
- city: nil,
2017
- country: nil,
2018
- line1: nil,
2019
- line2: nil,
2020
- postal_code: nil,
2021
- state: nil
2022
- ); end
2023
- end
2024
- class ReturnAddress < Stripe::RequestParams
2025
- # City, district, suburb, town, or village.
2026
- sig { returns(String) }
2027
- attr_accessor :city
2028
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2029
- sig { returns(String) }
2030
- attr_accessor :country
2031
- # Address line 1 (e.g., street, PO Box, or company name).
2032
- sig { returns(String) }
2033
- attr_accessor :line1
2034
- # Address line 2 (e.g., apartment, suite, unit, or building).
2035
- sig { returns(String) }
2036
- attr_accessor :line2
2037
- # ZIP or postal code.
2038
- sig { returns(String) }
2039
- attr_accessor :postal_code
2040
- # State, county, province, or region.
2041
- sig { returns(String) }
2042
- attr_accessor :state
2043
- sig {
2044
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2045
- }
2046
- def initialize(
2047
- city: nil,
2048
- country: nil,
2049
- line1: nil,
2050
- line2: nil,
2051
- postal_code: nil,
2052
- state: nil
2053
- ); end
2054
- end
2055
- # Affiliate details for this purchase.
2056
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Affiliate) }
2057
- attr_accessor :affiliate
2058
- # The booking number associated with the car rental.
2059
- sig { returns(String) }
2060
- attr_accessor :booking_number
2061
- # Class code of the car.
2062
- sig { returns(String) }
2063
- attr_accessor :car_class_code
2064
- # Make of the car.
2065
- sig { returns(String) }
2066
- attr_accessor :car_make
2067
- # Model of the car.
2068
- sig { returns(String) }
2069
- attr_accessor :car_model
2070
- # The name of the rental car company.
2071
- sig { returns(String) }
2072
- attr_accessor :company
2073
- # The customer service phone number of the car rental company.
2074
- sig { returns(String) }
2075
- attr_accessor :customer_service_phone_number
2076
- # Number of days the car is being rented.
2077
- sig { returns(Integer) }
2078
- attr_accessor :days_rented
2079
- # Delivery details for this purchase.
2080
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery) }
2081
- attr_accessor :delivery
2082
- # The details of the passengers in the travel reservation
2083
- sig {
2084
- returns(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Driver])
2085
- }
2086
- attr_accessor :drivers
2087
- # List of additional charges being billed.
2088
- sig { returns(T::Array[String]) }
2089
- attr_accessor :extra_charges
2090
- # Indicates if the customer did not keep nor cancel their booking.
2091
- sig { returns(T::Boolean) }
2092
- attr_accessor :no_show
2093
- # Car pick-up address.
2094
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::PickupAddress) }
2095
- attr_accessor :pickup_address
2096
- # Car pick-up time. Measured in seconds since the Unix epoch.
2097
- sig { returns(Integer) }
2098
- attr_accessor :pickup_at
2099
- # Rental rate.
2100
- sig { returns(Integer) }
2101
- attr_accessor :rate_amount
2102
- # The frequency at which the rate amount is applied. One of `day`, `week` or `month`
2103
- sig { returns(String) }
2104
- attr_accessor :rate_interval
2105
- # The name of the person or entity renting the car.
2106
- sig { returns(String) }
2107
- attr_accessor :renter_name
2108
- # Car return address.
2109
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::ReturnAddress) }
2110
- attr_accessor :return_address
2111
- # Car return time. Measured in seconds since the Unix epoch.
2112
- sig { returns(Integer) }
2113
- attr_accessor :return_at
2114
- # Indicates whether the goods or services are tax-exempt or tax is not collected.
2115
- sig { returns(T::Boolean) }
2116
- attr_accessor :tax_exempt
2117
- sig {
2118
- params(affiliate: ::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Affiliate, booking_number: String, car_class_code: String, car_make: String, car_model: String, company: String, customer_service_phone_number: String, days_rented: Integer, delivery: ::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery, drivers: T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Driver], extra_charges: T::Array[String], no_show: T::Boolean, pickup_address: ::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::PickupAddress, pickup_at: Integer, rate_amount: Integer, rate_interval: String, renter_name: String, return_address: ::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::ReturnAddress, return_at: Integer, tax_exempt: T::Boolean).void
2119
- }
2120
- def initialize(
2121
- affiliate: nil,
2122
- booking_number: nil,
2123
- car_class_code: nil,
2124
- car_make: nil,
2125
- car_model: nil,
2126
- company: nil,
2127
- customer_service_phone_number: nil,
2128
- days_rented: nil,
2129
- delivery: nil,
2130
- drivers: nil,
2131
- extra_charges: nil,
2132
- no_show: nil,
2133
- pickup_address: nil,
2134
- pickup_at: nil,
2135
- rate_amount: nil,
2136
- rate_interval: nil,
2137
- renter_name: nil,
2138
- return_address: nil,
2139
- return_at: nil,
2140
- tax_exempt: nil
2141
- ); end
2142
- end
2143
- class EventDetails < Stripe::RequestParams
2144
- class Address < Stripe::RequestParams
2145
- # City, district, suburb, town, or village.
2146
- sig { returns(String) }
2147
- attr_accessor :city
2148
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2149
- sig { returns(String) }
2150
- attr_accessor :country
2151
- # Address line 1 (e.g., street, PO Box, or company name).
2152
- sig { returns(String) }
2153
- attr_accessor :line1
2154
- # Address line 2 (e.g., apartment, suite, unit, or building).
2155
- sig { returns(String) }
2156
- attr_accessor :line2
2157
- # ZIP or postal code.
2158
- sig { returns(String) }
2159
- attr_accessor :postal_code
2160
- # State, county, province, or region.
2161
- sig { returns(String) }
2162
- attr_accessor :state
2163
- sig {
2164
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2165
- }
2166
- def initialize(
2167
- city: nil,
2168
- country: nil,
2169
- line1: nil,
2170
- line2: nil,
2171
- postal_code: nil,
2172
- state: nil
2173
- ); end
2174
- end
2175
- class Affiliate < Stripe::RequestParams
2176
- # The name of the affiliate that originated the purchase.
2177
- sig { returns(String) }
2178
- attr_accessor :name
2179
- sig { params(name: String).void }
2180
- def initialize(name: nil); end
2181
- end
2182
- class Delivery < Stripe::RequestParams
2183
- class Recipient < Stripe::RequestParams
2184
- # The email of the recipient the ticket is delivered to.
2185
- sig { returns(String) }
2186
- attr_accessor :email
2187
- # The name of the recipient the ticket is delivered to.
2188
- sig { returns(String) }
2189
- attr_accessor :name
2190
- # The phone number of the recipient the ticket is delivered to.
2191
- sig { returns(String) }
2192
- attr_accessor :phone
2193
- sig { params(email: String, name: String, phone: String).void }
2194
- def initialize(email: nil, name: nil, phone: nil); end
2195
- end
2196
- # The delivery method for the payment
2197
- sig { returns(String) }
2198
- attr_accessor :mode
2199
- # Details of the recipient.
2200
- sig {
2201
- returns(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)
2202
- }
2203
- attr_accessor :recipient
2204
- sig {
2205
- params(mode: String, recipient: ::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient).void
2206
- }
2207
- def initialize(mode: nil, recipient: nil); end
2208
- end
2209
- # Indicates if the tickets are digitally checked when entering the venue.
2210
- sig { returns(T::Boolean) }
2211
- attr_accessor :access_controlled_venue
2212
- # The event location's address.
2213
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Address) }
2214
- attr_accessor :address
2215
- # Affiliate details for this purchase.
2216
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Affiliate) }
2217
- attr_accessor :affiliate
2218
- # The name of the company
2219
- sig { returns(String) }
2220
- attr_accessor :company
2221
- # Delivery details for this purchase.
2222
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery) }
2223
- attr_accessor :delivery
2224
- # Event end time. Measured in seconds since the Unix epoch.
2225
- sig { returns(Integer) }
2226
- attr_accessor :ends_at
2227
- # Type of the event entertainment (concert, sports event etc)
2228
- sig { returns(String) }
2229
- attr_accessor :genre
2230
- # The name of the event.
2231
- sig { returns(String) }
2232
- attr_accessor :name
2233
- # Event start time. Measured in seconds since the Unix epoch.
2234
- sig { returns(Integer) }
2235
- attr_accessor :starts_at
2236
- sig {
2237
- params(access_controlled_venue: T::Boolean, address: ::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Address, affiliate: ::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Affiliate, company: String, delivery: ::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery, ends_at: Integer, genre: String, name: String, starts_at: Integer).void
2238
- }
2239
- def initialize(
2240
- access_controlled_venue: nil,
2241
- address: nil,
2242
- affiliate: nil,
2243
- company: nil,
2244
- delivery: nil,
2245
- ends_at: nil,
2246
- genre: nil,
2247
- name: nil,
2248
- starts_at: nil
2249
- ); end
2250
- end
2251
- class Flight < Stripe::RequestParams
2252
- class Affiliate < Stripe::RequestParams
2253
- # The name of the affiliate that originated the purchase.
2254
- sig { returns(String) }
2255
- attr_accessor :name
2256
- sig { params(name: String).void }
2257
- def initialize(name: nil); end
2258
- end
2259
- class Delivery < Stripe::RequestParams
2260
- class Recipient < Stripe::RequestParams
2261
- # The email of the recipient the ticket is delivered to.
2262
- sig { returns(String) }
2263
- attr_accessor :email
2264
- # The name of the recipient the ticket is delivered to.
2265
- sig { returns(String) }
2266
- attr_accessor :name
2267
- # The phone number of the recipient the ticket is delivered to.
2268
- sig { returns(String) }
2269
- attr_accessor :phone
2270
- sig { params(email: String, name: String, phone: String).void }
2271
- def initialize(email: nil, name: nil, phone: nil); end
2272
- end
2273
- # The delivery method for the payment
2274
- sig { returns(String) }
2275
- attr_accessor :mode
2276
- # Details of the recipient.
2277
- sig {
2278
- returns(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)
2279
- }
2280
- attr_accessor :recipient
2281
- sig {
2282
- params(mode: String, recipient: ::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery::Recipient).void
2283
- }
2284
- def initialize(mode: nil, recipient: nil); end
2285
- end
2286
- class Passenger < Stripe::RequestParams
2287
- # Full name of the person or entity on the flight reservation.
2288
- sig { returns(String) }
2289
- attr_accessor :name
2290
- sig { params(name: String).void }
2291
- def initialize(name: nil); end
2292
- end
2293
- class Segment < Stripe::RequestParams
2294
- # The flight segment amount.
2295
- sig { returns(Integer) }
2296
- attr_accessor :amount
2297
- # The International Air Transport Association (IATA) airport code for the arrival airport.
2298
- sig { returns(String) }
2299
- attr_accessor :arrival_airport
2300
- # The arrival time for the flight segment. Measured in seconds since the Unix epoch.
2301
- sig { returns(Integer) }
2302
- attr_accessor :arrives_at
2303
- # The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
2304
- sig { returns(String) }
2305
- attr_accessor :carrier
2306
- # The departure time for the flight segment. Measured in seconds since the Unix epoch.
2307
- sig { returns(Integer) }
2308
- attr_accessor :departs_at
2309
- # The International Air Transport Association (IATA) airport code for the departure airport.
2310
- sig { returns(String) }
2311
- attr_accessor :departure_airport
2312
- # The flight number associated with the segment
2313
- sig { returns(String) }
2314
- attr_accessor :flight_number
2315
- # The fare class for the segment.
2316
- sig { returns(String) }
2317
- attr_accessor :service_class
2318
- sig {
2319
- params(amount: Integer, arrival_airport: String, arrives_at: Integer, carrier: String, departs_at: Integer, departure_airport: String, flight_number: String, service_class: String).void
2320
- }
2321
- def initialize(
2322
- amount: nil,
2323
- arrival_airport: nil,
2324
- arrives_at: nil,
2325
- carrier: nil,
2326
- departs_at: nil,
2327
- departure_airport: nil,
2328
- flight_number: nil,
2329
- service_class: nil
2330
- ); end
2331
- end
2332
- # Affiliate details for this purchase.
2333
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Affiliate) }
2334
- attr_accessor :affiliate
2335
- # The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
2336
- sig { returns(String) }
2337
- attr_accessor :agency_number
2338
- # The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
2339
- sig { returns(String) }
2340
- attr_accessor :carrier
2341
- # Delivery details for this purchase.
2342
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery) }
2343
- attr_accessor :delivery
2344
- # The name of the person or entity on the reservation.
2345
- sig { returns(String) }
2346
- attr_accessor :passenger_name
2347
- # The details of the passengers in the travel reservation.
2348
- sig {
2349
- returns(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Passenger])
2350
- }
2351
- attr_accessor :passengers
2352
- # The individual flight segments associated with the trip.
2353
- sig { returns(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Segment]) }
2354
- attr_accessor :segments
2355
- # The ticket number associated with the travel reservation.
2356
- sig { returns(String) }
2357
- attr_accessor :ticket_number
2358
- sig {
2359
- params(affiliate: ::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Affiliate, agency_number: String, carrier: String, delivery: ::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery, passenger_name: String, passengers: T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Passenger], segments: T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Segment], ticket_number: String).void
2360
- }
2361
- def initialize(
2362
- affiliate: nil,
2363
- agency_number: nil,
2364
- carrier: nil,
2365
- delivery: nil,
2366
- passenger_name: nil,
2367
- passengers: nil,
2368
- segments: nil,
2369
- ticket_number: nil
2370
- ); end
2371
- end
2372
- class Lodging < Stripe::RequestParams
2373
- class Address < Stripe::RequestParams
2374
- # City, district, suburb, town, or village.
2375
- sig { returns(String) }
2376
- attr_accessor :city
2377
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2378
- sig { returns(String) }
2379
- attr_accessor :country
2380
- # Address line 1 (e.g., street, PO Box, or company name).
2381
- sig { returns(String) }
2382
- attr_accessor :line1
2383
- # Address line 2 (e.g., apartment, suite, unit, or building).
2384
- sig { returns(String) }
2385
- attr_accessor :line2
2386
- # ZIP or postal code.
2387
- sig { returns(String) }
2388
- attr_accessor :postal_code
2389
- # State, county, province, or region.
2390
- sig { returns(String) }
2391
- attr_accessor :state
2392
- sig {
2393
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2394
- }
2395
- def initialize(
2396
- city: nil,
2397
- country: nil,
2398
- line1: nil,
2399
- line2: nil,
2400
- postal_code: nil,
2401
- state: nil
2402
- ); end
2403
- end
2404
- class Affiliate < Stripe::RequestParams
2405
- # The name of the affiliate that originated the purchase.
2406
- sig { returns(String) }
2407
- attr_accessor :name
2408
- sig { params(name: String).void }
2409
- def initialize(name: nil); end
2410
- end
2411
- class Delivery < Stripe::RequestParams
2412
- class Recipient < Stripe::RequestParams
2413
- # The email of the recipient the ticket is delivered to.
2414
- sig { returns(String) }
2415
- attr_accessor :email
2416
- # The name of the recipient the ticket is delivered to.
2417
- sig { returns(String) }
2418
- attr_accessor :name
2419
- # The phone number of the recipient the ticket is delivered to.
2420
- sig { returns(String) }
2421
- attr_accessor :phone
2422
- sig { params(email: String, name: String, phone: String).void }
2423
- def initialize(email: nil, name: nil, phone: nil); end
2424
- end
2425
- # The delivery method for the payment
2426
- sig { returns(String) }
2427
- attr_accessor :mode
2428
- # Details of the recipient.
2429
- sig {
2430
- returns(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)
2431
- }
2432
- attr_accessor :recipient
2433
- sig {
2434
- params(mode: String, recipient: ::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient).void
2435
- }
2436
- def initialize(mode: nil, recipient: nil); end
2437
- end
2438
- class Passenger < Stripe::RequestParams
2439
- # Full name of the person or entity on the lodging reservation.
2440
- sig { returns(String) }
2441
- attr_accessor :name
2442
- sig { params(name: String).void }
2443
- def initialize(name: nil); end
2444
- end
2445
- # The lodging location's address.
2446
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Address) }
2447
- attr_accessor :address
2448
- # The number of adults on the booking
2449
- sig { returns(Integer) }
2450
- attr_accessor :adults
2451
- # Affiliate details for this purchase.
2452
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Affiliate) }
2453
- attr_accessor :affiliate
2454
- # The booking number associated with the lodging reservation.
2455
- sig { returns(String) }
2456
- attr_accessor :booking_number
2457
- # The lodging category
2458
- sig { returns(String) }
2459
- attr_accessor :category
2460
- # Loding check-in time. Measured in seconds since the Unix epoch.
2461
- sig { returns(Integer) }
2462
- attr_accessor :checkin_at
2463
- # Lodging check-out time. Measured in seconds since the Unix epoch.
2464
- sig { returns(Integer) }
2465
- attr_accessor :checkout_at
2466
- # The customer service phone number of the lodging company.
2467
- sig { returns(String) }
2468
- attr_accessor :customer_service_phone_number
2469
- # The daily lodging room rate.
2470
- sig { returns(Integer) }
2471
- attr_accessor :daily_room_rate_amount
2472
- # Delivery details for this purchase.
2473
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery) }
2474
- attr_accessor :delivery
2475
- # List of additional charges being billed.
2476
- sig { returns(T::Array[String]) }
2477
- attr_accessor :extra_charges
2478
- # Indicates whether the lodging location is compliant with the Fire Safety Act.
2479
- sig { returns(T::Boolean) }
2480
- attr_accessor :fire_safety_act_compliance
2481
- # The name of the lodging location.
2482
- sig { returns(String) }
2483
- attr_accessor :name
2484
- # Indicates if the customer did not keep their booking while failing to cancel the reservation.
2485
- sig { returns(T::Boolean) }
2486
- attr_accessor :no_show
2487
- # The number of rooms on the booking
2488
- sig { returns(Integer) }
2489
- attr_accessor :number_of_rooms
2490
- # The details of the passengers in the travel reservation
2491
- sig {
2492
- returns(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Passenger])
2493
- }
2494
- attr_accessor :passengers
2495
- # The phone number of the lodging location.
2496
- sig { returns(String) }
2497
- attr_accessor :property_phone_number
2498
- # The room class for this purchase.
2499
- sig { returns(String) }
2500
- attr_accessor :room_class
2501
- # The number of room nights
2502
- sig { returns(Integer) }
2503
- attr_accessor :room_nights
2504
- # The total tax amount associating with the room reservation.
2505
- sig { returns(Integer) }
2506
- attr_accessor :total_room_tax_amount
2507
- # The total tax amount
2508
- sig { returns(Integer) }
2509
- attr_accessor :total_tax_amount
2510
- sig {
2511
- params(address: ::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Address, adults: Integer, affiliate: ::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Affiliate, booking_number: String, category: String, checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: String, daily_room_rate_amount: Integer, delivery: ::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery, extra_charges: T::Array[String], fire_safety_act_compliance: T::Boolean, name: String, no_show: T::Boolean, number_of_rooms: Integer, passengers: T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Passenger], property_phone_number: String, room_class: String, room_nights: Integer, total_room_tax_amount: Integer, total_tax_amount: Integer).void
2512
- }
2513
- def initialize(
2514
- address: nil,
2515
- adults: nil,
2516
- affiliate: nil,
2517
- booking_number: nil,
2518
- category: nil,
2519
- checkin_at: nil,
2520
- checkout_at: nil,
2521
- customer_service_phone_number: nil,
2522
- daily_room_rate_amount: nil,
2523
- delivery: nil,
2524
- extra_charges: nil,
2525
- fire_safety_act_compliance: nil,
2526
- name: nil,
2527
- no_show: nil,
2528
- number_of_rooms: nil,
2529
- passengers: nil,
2530
- property_phone_number: nil,
2531
- room_class: nil,
2532
- room_nights: nil,
2533
- total_room_tax_amount: nil,
2534
- total_tax_amount: nil
2535
- ); end
2536
- end
2537
- class Subscription < Stripe::RequestParams
2538
- class Affiliate < Stripe::RequestParams
2539
- # The name of the affiliate that originated the purchase.
2540
- sig { returns(String) }
2541
- attr_accessor :name
2542
- sig { params(name: String).void }
2543
- def initialize(name: nil); end
2544
- end
2545
- class BillingInterval < Stripe::RequestParams
2546
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2547
- sig { returns(Integer) }
2548
- attr_accessor :count
2549
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2550
- sig { returns(String) }
2551
- attr_accessor :interval
2552
- sig { params(count: Integer, interval: String).void }
2553
- def initialize(count: nil, interval: nil); end
2554
- end
2555
- # Affiliate details for this purchase.
2556
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::Affiliate) }
2557
- attr_accessor :affiliate
2558
- # Info whether the subscription will be auto renewed upon expiry.
2559
- sig { returns(T::Boolean) }
2560
- attr_accessor :auto_renewal
2561
- # Subscription billing details for this purchase.
2562
- sig {
2563
- returns(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::BillingInterval)
2564
- }
2565
- attr_accessor :billing_interval
2566
- # Subscription end time. Measured in seconds since the Unix epoch.
2567
- sig { returns(Integer) }
2568
- attr_accessor :ends_at
2569
- # Name of the product on subscription. e.g. Apple Music Subscription
2570
- sig { returns(String) }
2571
- attr_accessor :name
2572
- # Subscription start time. Measured in seconds since the Unix epoch.
2573
- sig { returns(Integer) }
2574
- attr_accessor :starts_at
2575
- sig {
2576
- params(affiliate: ::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::Affiliate, auto_renewal: T::Boolean, billing_interval: ::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::BillingInterval, ends_at: Integer, name: String, starts_at: Integer).void
2577
- }
2578
- def initialize(
2579
- affiliate: nil,
2580
- auto_renewal: nil,
2581
- billing_interval: nil,
2582
- ends_at: nil,
2583
- name: nil,
2584
- starts_at: nil
2585
- ); end
2586
- end
2587
- # Car rental details for this PaymentIntent.
2588
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental) }
2589
- attr_accessor :car_rental
2590
- # Event details for this PaymentIntent
2591
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails) }
2592
- attr_accessor :event_details
2593
- # Flight reservation details for this PaymentIntent
2594
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Flight) }
2595
- attr_accessor :flight
2596
- # Lodging reservation details for this PaymentIntent
2597
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging) }
2598
- attr_accessor :lodging
2599
- # Subscription details for this PaymentIntent
2600
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription) }
2601
- attr_accessor :subscription
2602
- sig {
2603
- params(car_rental: ::Stripe::Charge::UpdateParams::PaymentDetails::CarRental, event_details: ::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails, flight: ::Stripe::Charge::UpdateParams::PaymentDetails::Flight, lodging: ::Stripe::Charge::UpdateParams::PaymentDetails::Lodging, subscription: ::Stripe::Charge::UpdateParams::PaymentDetails::Subscription).void
2604
- }
2605
- def initialize(
2606
- car_rental: nil,
2607
- event_details: nil,
2608
- flight: nil,
2609
- lodging: nil,
2610
- subscription: nil
2611
- ); end
2612
- end
2613
1844
  class Shipping < Stripe::RequestParams
2614
1845
  class Address < Stripe::RequestParams
2615
1846
  # City, district, suburb, town, or village.
2616
- sig { returns(String) }
1847
+ sig { returns(T.nilable(String)) }
2617
1848
  attr_accessor :city
2618
1849
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2619
- sig { returns(String) }
1850
+ sig { returns(T.nilable(String)) }
2620
1851
  attr_accessor :country
2621
1852
  # Address line 1 (e.g., street, PO Box, or company name).
2622
- sig { returns(String) }
1853
+ sig { returns(T.nilable(String)) }
2623
1854
  attr_accessor :line1
2624
1855
  # Address line 2 (e.g., apartment, suite, unit, or building).
2625
- sig { returns(String) }
1856
+ sig { returns(T.nilable(String)) }
2626
1857
  attr_accessor :line2
2627
1858
  # ZIP or postal code.
2628
- sig { returns(String) }
1859
+ sig { returns(T.nilable(String)) }
2629
1860
  attr_accessor :postal_code
2630
1861
  # State, county, province, or region.
2631
- sig { returns(String) }
1862
+ sig { returns(T.nilable(String)) }
2632
1863
  attr_accessor :state
2633
1864
  sig {
2634
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1865
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
2635
1866
  }
2636
1867
  def initialize(
2637
1868
  city: nil,
@@ -2646,51 +1877,48 @@ module Stripe
2646
1877
  sig { returns(::Stripe::Charge::UpdateParams::Shipping::Address) }
2647
1878
  attr_accessor :address
2648
1879
  # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
2649
- sig { returns(String) }
1880
+ sig { returns(T.nilable(String)) }
2650
1881
  attr_accessor :carrier
2651
1882
  # Recipient name.
2652
1883
  sig { returns(String) }
2653
1884
  attr_accessor :name
2654
1885
  # Recipient phone (including extension).
2655
- sig { returns(String) }
1886
+ sig { returns(T.nilable(String)) }
2656
1887
  attr_accessor :phone
2657
1888
  # 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.
2658
- sig { returns(String) }
1889
+ sig { returns(T.nilable(String)) }
2659
1890
  attr_accessor :tracking_number
2660
1891
  sig {
2661
- params(address: ::Stripe::Charge::UpdateParams::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
1892
+ params(address: ::Stripe::Charge::UpdateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
2662
1893
  }
2663
1894
  def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
2664
1895
  end
2665
1896
  # The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
2666
- sig { returns(String) }
1897
+ sig { returns(T.nilable(String)) }
2667
1898
  attr_accessor :customer
2668
1899
  # An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
2669
- sig { returns(String) }
1900
+ sig { returns(T.nilable(String)) }
2670
1901
  attr_accessor :description
2671
1902
  # Specifies which fields in the response should be expanded.
2672
- sig { returns(T::Array[String]) }
1903
+ sig { returns(T.nilable(T::Array[String])) }
2673
1904
  attr_accessor :expand
2674
1905
  # A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.
2675
- sig { returns(::Stripe::Charge::UpdateParams::FraudDetails) }
1906
+ sig { returns(T.nilable(::Stripe::Charge::UpdateParams::FraudDetails)) }
2676
1907
  attr_accessor :fraud_details
2677
1908
  # 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`.
2678
- sig { returns(T.nilable(T::Hash[String, String])) }
1909
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
2679
1910
  attr_accessor :metadata
2680
- # Provides industry-specific information about the charge.
2681
- sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails) }
2682
- attr_accessor :payment_details
2683
1911
  # This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
2684
- sig { returns(String) }
1912
+ sig { returns(T.nilable(String)) }
2685
1913
  attr_accessor :receipt_email
2686
1914
  # Shipping information for the charge. Helps prevent fraud on charges for physical goods.
2687
- sig { returns(::Stripe::Charge::UpdateParams::Shipping) }
1915
+ sig { returns(T.nilable(::Stripe::Charge::UpdateParams::Shipping)) }
2688
1916
  attr_accessor :shipping
2689
1917
  # A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
2690
- sig { returns(String) }
1918
+ sig { returns(T.nilable(String)) }
2691
1919
  attr_accessor :transfer_group
2692
1920
  sig {
2693
- params(customer: String, description: String, expand: T::Array[String], fraud_details: ::Stripe::Charge::UpdateParams::FraudDetails, metadata: T.nilable(T::Hash[String, String]), payment_details: ::Stripe::Charge::UpdateParams::PaymentDetails, receipt_email: String, shipping: ::Stripe::Charge::UpdateParams::Shipping, transfer_group: String).void
1921
+ params(customer: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), fraud_details: T.nilable(::Stripe::Charge::UpdateParams::FraudDetails), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), receipt_email: T.nilable(String), shipping: T.nilable(::Stripe::Charge::UpdateParams::Shipping), transfer_group: T.nilable(String)).void
2694
1922
  }
2695
1923
  def initialize(
2696
1924
  customer: nil,
@@ -2698,7 +1926,6 @@ module Stripe
2698
1926
  expand: nil,
2699
1927
  fraud_details: nil,
2700
1928
  metadata: nil,
2701
- payment_details: nil,
2702
1929
  receipt_email: nil,
2703
1930
  shipping: nil,
2704
1931
  transfer_group: nil
@@ -2706,734 +1933,67 @@ module Stripe
2706
1933
  end
2707
1934
  class SearchParams < Stripe::RequestParams
2708
1935
  # Specifies which fields in the response should be expanded.
2709
- sig { returns(T::Array[String]) }
1936
+ sig { returns(T.nilable(T::Array[String])) }
2710
1937
  attr_accessor :expand
2711
1938
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
2712
- sig { returns(Integer) }
1939
+ sig { returns(T.nilable(Integer)) }
2713
1940
  attr_accessor :limit
2714
1941
  # A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
2715
- sig { returns(String) }
1942
+ sig { returns(T.nilable(String)) }
2716
1943
  attr_accessor :page
2717
1944
  # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).
2718
1945
  sig { returns(String) }
2719
1946
  attr_accessor :query
2720
- sig { params(expand: T::Array[String], limit: Integer, page: String, query: String).void }
1947
+ sig {
1948
+ params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
1949
+ }
2721
1950
  def initialize(expand: nil, limit: nil, page: nil, query: nil); end
2722
1951
  end
2723
1952
  class CaptureParams < Stripe::RequestParams
2724
- class PaymentDetails < Stripe::RequestParams
2725
- class CarRental < Stripe::RequestParams
2726
- class Affiliate < Stripe::RequestParams
2727
- # The name of the affiliate that originated the purchase.
2728
- sig { returns(String) }
2729
- attr_accessor :name
2730
- sig { params(name: String).void }
2731
- def initialize(name: nil); end
2732
- end
2733
- class Delivery < Stripe::RequestParams
2734
- class Recipient < Stripe::RequestParams
2735
- # The email of the recipient the ticket is delivered to.
2736
- sig { returns(String) }
2737
- attr_accessor :email
2738
- # The name of the recipient the ticket is delivered to.
2739
- sig { returns(String) }
2740
- attr_accessor :name
2741
- # The phone number of the recipient the ticket is delivered to.
2742
- sig { returns(String) }
2743
- attr_accessor :phone
2744
- sig { params(email: String, name: String, phone: String).void }
2745
- def initialize(email: nil, name: nil, phone: nil); end
2746
- end
2747
- # The delivery method for the payment
2748
- sig { returns(String) }
2749
- attr_accessor :mode
2750
- # Details of the recipient.
2751
- sig {
2752
- returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)
2753
- }
2754
- attr_accessor :recipient
2755
- sig {
2756
- params(mode: String, recipient: ::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient).void
2757
- }
2758
- def initialize(mode: nil, recipient: nil); end
2759
- end
2760
- class Driver < Stripe::RequestParams
2761
- # Full name of the person or entity on the car reservation.
2762
- sig { returns(String) }
2763
- attr_accessor :name
2764
- sig { params(name: String).void }
2765
- def initialize(name: nil); end
2766
- end
2767
- class PickupAddress < Stripe::RequestParams
2768
- # City, district, suburb, town, or village.
2769
- sig { returns(String) }
2770
- attr_accessor :city
2771
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2772
- sig { returns(String) }
2773
- attr_accessor :country
2774
- # Address line 1 (e.g., street, PO Box, or company name).
2775
- sig { returns(String) }
2776
- attr_accessor :line1
2777
- # Address line 2 (e.g., apartment, suite, unit, or building).
2778
- sig { returns(String) }
2779
- attr_accessor :line2
2780
- # ZIP or postal code.
2781
- sig { returns(String) }
2782
- attr_accessor :postal_code
2783
- # State, county, province, or region.
2784
- sig { returns(String) }
2785
- attr_accessor :state
2786
- sig {
2787
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2788
- }
2789
- def initialize(
2790
- city: nil,
2791
- country: nil,
2792
- line1: nil,
2793
- line2: nil,
2794
- postal_code: nil,
2795
- state: nil
2796
- ); end
2797
- end
2798
- class ReturnAddress < Stripe::RequestParams
2799
- # City, district, suburb, town, or village.
2800
- sig { returns(String) }
2801
- attr_accessor :city
2802
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2803
- sig { returns(String) }
2804
- attr_accessor :country
2805
- # Address line 1 (e.g., street, PO Box, or company name).
2806
- sig { returns(String) }
2807
- attr_accessor :line1
2808
- # Address line 2 (e.g., apartment, suite, unit, or building).
2809
- sig { returns(String) }
2810
- attr_accessor :line2
2811
- # ZIP or postal code.
2812
- sig { returns(String) }
2813
- attr_accessor :postal_code
2814
- # State, county, province, or region.
2815
- sig { returns(String) }
2816
- attr_accessor :state
2817
- sig {
2818
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2819
- }
2820
- def initialize(
2821
- city: nil,
2822
- country: nil,
2823
- line1: nil,
2824
- line2: nil,
2825
- postal_code: nil,
2826
- state: nil
2827
- ); end
2828
- end
2829
- # Affiliate details for this purchase.
2830
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Affiliate) }
2831
- attr_accessor :affiliate
2832
- # The booking number associated with the car rental.
2833
- sig { returns(String) }
2834
- attr_accessor :booking_number
2835
- # Class code of the car.
2836
- sig { returns(String) }
2837
- attr_accessor :car_class_code
2838
- # Make of the car.
2839
- sig { returns(String) }
2840
- attr_accessor :car_make
2841
- # Model of the car.
2842
- sig { returns(String) }
2843
- attr_accessor :car_model
2844
- # The name of the rental car company.
2845
- sig { returns(String) }
2846
- attr_accessor :company
2847
- # The customer service phone number of the car rental company.
2848
- sig { returns(String) }
2849
- attr_accessor :customer_service_phone_number
2850
- # Number of days the car is being rented.
2851
- sig { returns(Integer) }
2852
- attr_accessor :days_rented
2853
- # Delivery details for this purchase.
2854
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery) }
2855
- attr_accessor :delivery
2856
- # The details of the passengers in the travel reservation
2857
- sig {
2858
- returns(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Driver])
2859
- }
2860
- attr_accessor :drivers
2861
- # List of additional charges being billed.
2862
- sig { returns(T::Array[String]) }
2863
- attr_accessor :extra_charges
2864
- # Indicates if the customer did not keep nor cancel their booking.
2865
- sig { returns(T::Boolean) }
2866
- attr_accessor :no_show
2867
- # Car pick-up address.
2868
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::PickupAddress) }
2869
- attr_accessor :pickup_address
2870
- # Car pick-up time. Measured in seconds since the Unix epoch.
2871
- sig { returns(Integer) }
2872
- attr_accessor :pickup_at
2873
- # Rental rate.
2874
- sig { returns(Integer) }
2875
- attr_accessor :rate_amount
2876
- # The frequency at which the rate amount is applied. One of `day`, `week` or `month`
2877
- sig { returns(String) }
2878
- attr_accessor :rate_interval
2879
- # The name of the person or entity renting the car.
2880
- sig { returns(String) }
2881
- attr_accessor :renter_name
2882
- # Car return address.
2883
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::ReturnAddress) }
2884
- attr_accessor :return_address
2885
- # Car return time. Measured in seconds since the Unix epoch.
2886
- sig { returns(Integer) }
2887
- attr_accessor :return_at
2888
- # Indicates whether the goods or services are tax-exempt or tax is not collected.
2889
- sig { returns(T::Boolean) }
2890
- attr_accessor :tax_exempt
2891
- sig {
2892
- params(affiliate: ::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Affiliate, booking_number: String, car_class_code: String, car_make: String, car_model: String, company: String, customer_service_phone_number: String, days_rented: Integer, delivery: ::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery, drivers: T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Driver], extra_charges: T::Array[String], no_show: T::Boolean, pickup_address: ::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::PickupAddress, pickup_at: Integer, rate_amount: Integer, rate_interval: String, renter_name: String, return_address: ::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::ReturnAddress, return_at: Integer, tax_exempt: T::Boolean).void
2893
- }
2894
- def initialize(
2895
- affiliate: nil,
2896
- booking_number: nil,
2897
- car_class_code: nil,
2898
- car_make: nil,
2899
- car_model: nil,
2900
- company: nil,
2901
- customer_service_phone_number: nil,
2902
- days_rented: nil,
2903
- delivery: nil,
2904
- drivers: nil,
2905
- extra_charges: nil,
2906
- no_show: nil,
2907
- pickup_address: nil,
2908
- pickup_at: nil,
2909
- rate_amount: nil,
2910
- rate_interval: nil,
2911
- renter_name: nil,
2912
- return_address: nil,
2913
- return_at: nil,
2914
- tax_exempt: nil
2915
- ); end
2916
- end
2917
- class EventDetails < Stripe::RequestParams
2918
- class Address < Stripe::RequestParams
2919
- # City, district, suburb, town, or village.
2920
- sig { returns(String) }
2921
- attr_accessor :city
2922
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2923
- sig { returns(String) }
2924
- attr_accessor :country
2925
- # Address line 1 (e.g., street, PO Box, or company name).
2926
- sig { returns(String) }
2927
- attr_accessor :line1
2928
- # Address line 2 (e.g., apartment, suite, unit, or building).
2929
- sig { returns(String) }
2930
- attr_accessor :line2
2931
- # ZIP or postal code.
2932
- sig { returns(String) }
2933
- attr_accessor :postal_code
2934
- # State, county, province, or region.
2935
- sig { returns(String) }
2936
- attr_accessor :state
2937
- sig {
2938
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2939
- }
2940
- def initialize(
2941
- city: nil,
2942
- country: nil,
2943
- line1: nil,
2944
- line2: nil,
2945
- postal_code: nil,
2946
- state: nil
2947
- ); end
2948
- end
2949
- class Affiliate < Stripe::RequestParams
2950
- # The name of the affiliate that originated the purchase.
2951
- sig { returns(String) }
2952
- attr_accessor :name
2953
- sig { params(name: String).void }
2954
- def initialize(name: nil); end
2955
- end
2956
- class Delivery < Stripe::RequestParams
2957
- class Recipient < Stripe::RequestParams
2958
- # The email of the recipient the ticket is delivered to.
2959
- sig { returns(String) }
2960
- attr_accessor :email
2961
- # The name of the recipient the ticket is delivered to.
2962
- sig { returns(String) }
2963
- attr_accessor :name
2964
- # The phone number of the recipient the ticket is delivered to.
2965
- sig { returns(String) }
2966
- attr_accessor :phone
2967
- sig { params(email: String, name: String, phone: String).void }
2968
- def initialize(email: nil, name: nil, phone: nil); end
2969
- end
2970
- # The delivery method for the payment
2971
- sig { returns(String) }
2972
- attr_accessor :mode
2973
- # Details of the recipient.
2974
- sig {
2975
- returns(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)
2976
- }
2977
- attr_accessor :recipient
2978
- sig {
2979
- params(mode: String, recipient: ::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient).void
2980
- }
2981
- def initialize(mode: nil, recipient: nil); end
2982
- end
2983
- # Indicates if the tickets are digitally checked when entering the venue.
2984
- sig { returns(T::Boolean) }
2985
- attr_accessor :access_controlled_venue
2986
- # The event location's address.
2987
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Address) }
2988
- attr_accessor :address
2989
- # Affiliate details for this purchase.
2990
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Affiliate) }
2991
- attr_accessor :affiliate
2992
- # The name of the company
2993
- sig { returns(String) }
2994
- attr_accessor :company
2995
- # Delivery details for this purchase.
2996
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery) }
2997
- attr_accessor :delivery
2998
- # Event end time. Measured in seconds since the Unix epoch.
2999
- sig { returns(Integer) }
3000
- attr_accessor :ends_at
3001
- # Type of the event entertainment (concert, sports event etc)
3002
- sig { returns(String) }
3003
- attr_accessor :genre
3004
- # The name of the event.
3005
- sig { returns(String) }
3006
- attr_accessor :name
3007
- # Event start time. Measured in seconds since the Unix epoch.
3008
- sig { returns(Integer) }
3009
- attr_accessor :starts_at
3010
- sig {
3011
- params(access_controlled_venue: T::Boolean, address: ::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Address, affiliate: ::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Affiliate, company: String, delivery: ::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery, ends_at: Integer, genre: String, name: String, starts_at: Integer).void
3012
- }
3013
- def initialize(
3014
- access_controlled_venue: nil,
3015
- address: nil,
3016
- affiliate: nil,
3017
- company: nil,
3018
- delivery: nil,
3019
- ends_at: nil,
3020
- genre: nil,
3021
- name: nil,
3022
- starts_at: nil
3023
- ); end
3024
- end
3025
- class Flight < Stripe::RequestParams
3026
- class Affiliate < Stripe::RequestParams
3027
- # The name of the affiliate that originated the purchase.
3028
- sig { returns(String) }
3029
- attr_accessor :name
3030
- sig { params(name: String).void }
3031
- def initialize(name: nil); end
3032
- end
3033
- class Delivery < Stripe::RequestParams
3034
- class Recipient < Stripe::RequestParams
3035
- # The email of the recipient the ticket is delivered to.
3036
- sig { returns(String) }
3037
- attr_accessor :email
3038
- # The name of the recipient the ticket is delivered to.
3039
- sig { returns(String) }
3040
- attr_accessor :name
3041
- # The phone number of the recipient the ticket is delivered to.
3042
- sig { returns(String) }
3043
- attr_accessor :phone
3044
- sig { params(email: String, name: String, phone: String).void }
3045
- def initialize(email: nil, name: nil, phone: nil); end
3046
- end
3047
- # The delivery method for the payment
3048
- sig { returns(String) }
3049
- attr_accessor :mode
3050
- # Details of the recipient.
3051
- sig {
3052
- returns(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)
3053
- }
3054
- attr_accessor :recipient
3055
- sig {
3056
- params(mode: String, recipient: ::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery::Recipient).void
3057
- }
3058
- def initialize(mode: nil, recipient: nil); end
3059
- end
3060
- class Passenger < Stripe::RequestParams
3061
- # Full name of the person or entity on the flight reservation.
3062
- sig { returns(String) }
3063
- attr_accessor :name
3064
- sig { params(name: String).void }
3065
- def initialize(name: nil); end
3066
- end
3067
- class Segment < Stripe::RequestParams
3068
- # The flight segment amount.
3069
- sig { returns(Integer) }
3070
- attr_accessor :amount
3071
- # The International Air Transport Association (IATA) airport code for the arrival airport.
3072
- sig { returns(String) }
3073
- attr_accessor :arrival_airport
3074
- # The arrival time for the flight segment. Measured in seconds since the Unix epoch.
3075
- sig { returns(Integer) }
3076
- attr_accessor :arrives_at
3077
- # The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
3078
- sig { returns(String) }
3079
- attr_accessor :carrier
3080
- # The departure time for the flight segment. Measured in seconds since the Unix epoch.
3081
- sig { returns(Integer) }
3082
- attr_accessor :departs_at
3083
- # The International Air Transport Association (IATA) airport code for the departure airport.
3084
- sig { returns(String) }
3085
- attr_accessor :departure_airport
3086
- # The flight number associated with the segment
3087
- sig { returns(String) }
3088
- attr_accessor :flight_number
3089
- # The fare class for the segment.
3090
- sig { returns(String) }
3091
- attr_accessor :service_class
3092
- sig {
3093
- params(amount: Integer, arrival_airport: String, arrives_at: Integer, carrier: String, departs_at: Integer, departure_airport: String, flight_number: String, service_class: String).void
3094
- }
3095
- def initialize(
3096
- amount: nil,
3097
- arrival_airport: nil,
3098
- arrives_at: nil,
3099
- carrier: nil,
3100
- departs_at: nil,
3101
- departure_airport: nil,
3102
- flight_number: nil,
3103
- service_class: nil
3104
- ); end
3105
- end
3106
- # Affiliate details for this purchase.
3107
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Affiliate) }
3108
- attr_accessor :affiliate
3109
- # The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
3110
- sig { returns(String) }
3111
- attr_accessor :agency_number
3112
- # The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
3113
- sig { returns(String) }
3114
- attr_accessor :carrier
3115
- # Delivery details for this purchase.
3116
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery) }
3117
- attr_accessor :delivery
3118
- # The name of the person or entity on the reservation.
3119
- sig { returns(String) }
3120
- attr_accessor :passenger_name
3121
- # The details of the passengers in the travel reservation.
3122
- sig {
3123
- returns(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Passenger])
3124
- }
3125
- attr_accessor :passengers
3126
- # The individual flight segments associated with the trip.
3127
- sig {
3128
- returns(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Segment])
3129
- }
3130
- attr_accessor :segments
3131
- # The ticket number associated with the travel reservation.
3132
- sig { returns(String) }
3133
- attr_accessor :ticket_number
3134
- sig {
3135
- params(affiliate: ::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Affiliate, agency_number: String, carrier: String, delivery: ::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery, passenger_name: String, passengers: T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Passenger], segments: T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Segment], ticket_number: String).void
3136
- }
3137
- def initialize(
3138
- affiliate: nil,
3139
- agency_number: nil,
3140
- carrier: nil,
3141
- delivery: nil,
3142
- passenger_name: nil,
3143
- passengers: nil,
3144
- segments: nil,
3145
- ticket_number: nil
3146
- ); end
3147
- end
3148
- class Lodging < Stripe::RequestParams
3149
- class Address < Stripe::RequestParams
3150
- # City, district, suburb, town, or village.
3151
- sig { returns(String) }
3152
- attr_accessor :city
3153
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3154
- sig { returns(String) }
3155
- attr_accessor :country
3156
- # Address line 1 (e.g., street, PO Box, or company name).
3157
- sig { returns(String) }
3158
- attr_accessor :line1
3159
- # Address line 2 (e.g., apartment, suite, unit, or building).
3160
- sig { returns(String) }
3161
- attr_accessor :line2
3162
- # ZIP or postal code.
3163
- sig { returns(String) }
3164
- attr_accessor :postal_code
3165
- # State, county, province, or region.
3166
- sig { returns(String) }
3167
- attr_accessor :state
3168
- sig {
3169
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
3170
- }
3171
- def initialize(
3172
- city: nil,
3173
- country: nil,
3174
- line1: nil,
3175
- line2: nil,
3176
- postal_code: nil,
3177
- state: nil
3178
- ); end
3179
- end
3180
- class Affiliate < Stripe::RequestParams
3181
- # The name of the affiliate that originated the purchase.
3182
- sig { returns(String) }
3183
- attr_accessor :name
3184
- sig { params(name: String).void }
3185
- def initialize(name: nil); end
3186
- end
3187
- class Delivery < Stripe::RequestParams
3188
- class Recipient < Stripe::RequestParams
3189
- # The email of the recipient the ticket is delivered to.
3190
- sig { returns(String) }
3191
- attr_accessor :email
3192
- # The name of the recipient the ticket is delivered to.
3193
- sig { returns(String) }
3194
- attr_accessor :name
3195
- # The phone number of the recipient the ticket is delivered to.
3196
- sig { returns(String) }
3197
- attr_accessor :phone
3198
- sig { params(email: String, name: String, phone: String).void }
3199
- def initialize(email: nil, name: nil, phone: nil); end
3200
- end
3201
- # The delivery method for the payment
3202
- sig { returns(String) }
3203
- attr_accessor :mode
3204
- # Details of the recipient.
3205
- sig {
3206
- returns(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)
3207
- }
3208
- attr_accessor :recipient
3209
- sig {
3210
- params(mode: String, recipient: ::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient).void
3211
- }
3212
- def initialize(mode: nil, recipient: nil); end
3213
- end
3214
- class Passenger < Stripe::RequestParams
3215
- # Full name of the person or entity on the lodging reservation.
3216
- sig { returns(String) }
3217
- attr_accessor :name
3218
- sig { params(name: String).void }
3219
- def initialize(name: nil); end
3220
- end
3221
- # The lodging location's address.
3222
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Address) }
3223
- attr_accessor :address
3224
- # The number of adults on the booking
3225
- sig { returns(Integer) }
3226
- attr_accessor :adults
3227
- # Affiliate details for this purchase.
3228
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Affiliate) }
3229
- attr_accessor :affiliate
3230
- # The booking number associated with the lodging reservation.
3231
- sig { returns(String) }
3232
- attr_accessor :booking_number
3233
- # The lodging category
3234
- sig { returns(String) }
3235
- attr_accessor :category
3236
- # Loding check-in time. Measured in seconds since the Unix epoch.
3237
- sig { returns(Integer) }
3238
- attr_accessor :checkin_at
3239
- # Lodging check-out time. Measured in seconds since the Unix epoch.
3240
- sig { returns(Integer) }
3241
- attr_accessor :checkout_at
3242
- # The customer service phone number of the lodging company.
3243
- sig { returns(String) }
3244
- attr_accessor :customer_service_phone_number
3245
- # The daily lodging room rate.
3246
- sig { returns(Integer) }
3247
- attr_accessor :daily_room_rate_amount
3248
- # Delivery details for this purchase.
3249
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery) }
3250
- attr_accessor :delivery
3251
- # List of additional charges being billed.
3252
- sig { returns(T::Array[String]) }
3253
- attr_accessor :extra_charges
3254
- # Indicates whether the lodging location is compliant with the Fire Safety Act.
3255
- sig { returns(T::Boolean) }
3256
- attr_accessor :fire_safety_act_compliance
3257
- # The name of the lodging location.
3258
- sig { returns(String) }
3259
- attr_accessor :name
3260
- # Indicates if the customer did not keep their booking while failing to cancel the reservation.
3261
- sig { returns(T::Boolean) }
3262
- attr_accessor :no_show
3263
- # The number of rooms on the booking
3264
- sig { returns(Integer) }
3265
- attr_accessor :number_of_rooms
3266
- # The details of the passengers in the travel reservation
3267
- sig {
3268
- returns(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Passenger])
3269
- }
3270
- attr_accessor :passengers
3271
- # The phone number of the lodging location.
3272
- sig { returns(String) }
3273
- attr_accessor :property_phone_number
3274
- # The room class for this purchase.
3275
- sig { returns(String) }
3276
- attr_accessor :room_class
3277
- # The number of room nights
3278
- sig { returns(Integer) }
3279
- attr_accessor :room_nights
3280
- # The total tax amount associating with the room reservation.
3281
- sig { returns(Integer) }
3282
- attr_accessor :total_room_tax_amount
3283
- # The total tax amount
3284
- sig { returns(Integer) }
3285
- attr_accessor :total_tax_amount
3286
- sig {
3287
- params(address: ::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Address, adults: Integer, affiliate: ::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Affiliate, booking_number: String, category: String, checkin_at: Integer, checkout_at: Integer, customer_service_phone_number: String, daily_room_rate_amount: Integer, delivery: ::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery, extra_charges: T::Array[String], fire_safety_act_compliance: T::Boolean, name: String, no_show: T::Boolean, number_of_rooms: Integer, passengers: T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Passenger], property_phone_number: String, room_class: String, room_nights: Integer, total_room_tax_amount: Integer, total_tax_amount: Integer).void
3288
- }
3289
- def initialize(
3290
- address: nil,
3291
- adults: nil,
3292
- affiliate: nil,
3293
- booking_number: nil,
3294
- category: nil,
3295
- checkin_at: nil,
3296
- checkout_at: nil,
3297
- customer_service_phone_number: nil,
3298
- daily_room_rate_amount: nil,
3299
- delivery: nil,
3300
- extra_charges: nil,
3301
- fire_safety_act_compliance: nil,
3302
- name: nil,
3303
- no_show: nil,
3304
- number_of_rooms: nil,
3305
- passengers: nil,
3306
- property_phone_number: nil,
3307
- room_class: nil,
3308
- room_nights: nil,
3309
- total_room_tax_amount: nil,
3310
- total_tax_amount: nil
3311
- ); end
3312
- end
3313
- class Subscription < Stripe::RequestParams
3314
- class Affiliate < Stripe::RequestParams
3315
- # The name of the affiliate that originated the purchase.
3316
- sig { returns(String) }
3317
- attr_accessor :name
3318
- sig { params(name: String).void }
3319
- def initialize(name: nil); end
3320
- end
3321
- class BillingInterval < Stripe::RequestParams
3322
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3323
- sig { returns(Integer) }
3324
- attr_accessor :count
3325
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3326
- sig { returns(String) }
3327
- attr_accessor :interval
3328
- sig { params(count: Integer, interval: String).void }
3329
- def initialize(count: nil, interval: nil); end
3330
- end
3331
- # Affiliate details for this purchase.
3332
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::Affiliate) }
3333
- attr_accessor :affiliate
3334
- # Info whether the subscription will be auto renewed upon expiry.
3335
- sig { returns(T::Boolean) }
3336
- attr_accessor :auto_renewal
3337
- # Subscription billing details for this purchase.
3338
- sig {
3339
- returns(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::BillingInterval)
3340
- }
3341
- attr_accessor :billing_interval
3342
- # Subscription end time. Measured in seconds since the Unix epoch.
3343
- sig { returns(Integer) }
3344
- attr_accessor :ends_at
3345
- # Name of the product on subscription. e.g. Apple Music Subscription
3346
- sig { returns(String) }
3347
- attr_accessor :name
3348
- # Subscription start time. Measured in seconds since the Unix epoch.
3349
- sig { returns(Integer) }
3350
- attr_accessor :starts_at
3351
- sig {
3352
- params(affiliate: ::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::Affiliate, auto_renewal: T::Boolean, billing_interval: ::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::BillingInterval, ends_at: Integer, name: String, starts_at: Integer).void
3353
- }
3354
- def initialize(
3355
- affiliate: nil,
3356
- auto_renewal: nil,
3357
- billing_interval: nil,
3358
- ends_at: nil,
3359
- name: nil,
3360
- starts_at: nil
3361
- ); end
3362
- end
3363
- # Car rental details for this PaymentIntent.
3364
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental) }
3365
- attr_accessor :car_rental
3366
- # Event details for this PaymentIntent
3367
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails) }
3368
- attr_accessor :event_details
3369
- # Flight reservation details for this PaymentIntent
3370
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Flight) }
3371
- attr_accessor :flight
3372
- # Lodging reservation details for this PaymentIntent
3373
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging) }
3374
- attr_accessor :lodging
3375
- # Subscription details for this PaymentIntent
3376
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription) }
3377
- attr_accessor :subscription
3378
- sig {
3379
- params(car_rental: ::Stripe::Charge::CaptureParams::PaymentDetails::CarRental, event_details: ::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails, flight: ::Stripe::Charge::CaptureParams::PaymentDetails::Flight, lodging: ::Stripe::Charge::CaptureParams::PaymentDetails::Lodging, subscription: ::Stripe::Charge::CaptureParams::PaymentDetails::Subscription).void
3380
- }
3381
- def initialize(
3382
- car_rental: nil,
3383
- event_details: nil,
3384
- flight: nil,
3385
- lodging: nil,
3386
- subscription: nil
3387
- ); end
3388
- end
3389
1953
  class TransferData < Stripe::RequestParams
3390
1954
  # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
3391
- sig { returns(Integer) }
1955
+ sig { returns(T.nilable(Integer)) }
3392
1956
  attr_accessor :amount
3393
- sig { params(amount: Integer).void }
1957
+ sig { params(amount: T.nilable(Integer)).void }
3394
1958
  def initialize(amount: nil); end
3395
1959
  end
3396
- # The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.
3397
- sig { returns(Integer) }
1960
+ # The amount to capture, which must be less than or equal to the original amount.
1961
+ sig { returns(T.nilable(Integer)) }
3398
1962
  attr_accessor :amount
3399
1963
  # An application fee to add on to this charge.
3400
- sig { returns(Integer) }
1964
+ sig { returns(T.nilable(Integer)) }
3401
1965
  attr_accessor :application_fee
3402
1966
  # An application fee amount to add on to this charge, which must be less than or equal to the original amount.
3403
- sig { returns(Integer) }
1967
+ sig { returns(T.nilable(Integer)) }
3404
1968
  attr_accessor :application_fee_amount
3405
1969
  # Specifies which fields in the response should be expanded.
3406
- sig { returns(T::Array[String]) }
1970
+ sig { returns(T.nilable(T::Array[String])) }
3407
1971
  attr_accessor :expand
3408
- # Provides industry-specific information about the charge.
3409
- sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails) }
3410
- attr_accessor :payment_details
3411
1972
  # The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
3412
- sig { returns(String) }
1973
+ sig { returns(T.nilable(String)) }
3413
1974
  attr_accessor :receipt_email
3414
1975
  # For a non-card charge, text that appears on the customer's statement as the statement descriptor. 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).
3415
1976
  #
3416
1977
  # For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
3417
- sig { returns(String) }
1978
+ sig { returns(T.nilable(String)) }
3418
1979
  attr_accessor :statement_descriptor
3419
1980
  # 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. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
3420
- sig { returns(String) }
1981
+ sig { returns(T.nilable(String)) }
3421
1982
  attr_accessor :statement_descriptor_suffix
3422
1983
  # An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
3423
- sig { returns(::Stripe::Charge::CaptureParams::TransferData) }
1984
+ sig { returns(T.nilable(::Stripe::Charge::CaptureParams::TransferData)) }
3424
1985
  attr_accessor :transfer_data
3425
1986
  # A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
3426
- sig { returns(String) }
1987
+ sig { returns(T.nilable(String)) }
3427
1988
  attr_accessor :transfer_group
3428
1989
  sig {
3429
- params(amount: Integer, application_fee: Integer, application_fee_amount: Integer, expand: T::Array[String], payment_details: ::Stripe::Charge::CaptureParams::PaymentDetails, receipt_email: String, statement_descriptor: String, statement_descriptor_suffix: String, transfer_data: ::Stripe::Charge::CaptureParams::TransferData, transfer_group: String).void
1990
+ params(amount: T.nilable(Integer), application_fee: T.nilable(Integer), application_fee_amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), receipt_email: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::Charge::CaptureParams::TransferData), transfer_group: T.nilable(String)).void
3430
1991
  }
3431
1992
  def initialize(
3432
1993
  amount: nil,
3433
1994
  application_fee: nil,
3434
1995
  application_fee_amount: nil,
3435
1996
  expand: nil,
3436
- payment_details: nil,
3437
1997
  receipt_email: nil,
3438
1998
  statement_descriptor: nil,
3439
1999
  statement_descriptor_suffix: nil,