stripe 13.3.0 → 13.4.0.pre.beta.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (743) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1416 -645
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_operations/request.rb +1 -0
  6. data/lib/stripe/api_requestor.rb +1 -0
  7. data/lib/stripe/object_types.rb +32 -0
  8. data/lib/stripe/request_params.rb +24 -0
  9. data/lib/stripe/request_signing_authenticator.rb +79 -0
  10. data/lib/stripe/resources/account.rb +5071 -0
  11. data/lib/stripe/resources/account_link.rb +54 -0
  12. data/lib/stripe/resources/account_notice.rb +132 -0
  13. data/lib/stripe/resources/account_session.rb +877 -0
  14. data/lib/stripe/resources/apple_pay_domain.rb +63 -0
  15. data/lib/stripe/resources/application.rb +20 -0
  16. data/lib/stripe/resources/application_fee.rb +96 -0
  17. data/lib/stripe/resources/application_fee_refund.rb +17 -0
  18. data/lib/stripe/resources/apps/secret.rb +141 -0
  19. data/lib/stripe/resources/balance.rb +131 -0
  20. data/lib/stripe/resources/balance_transaction.rb +112 -0
  21. data/lib/stripe/resources/bank_account.rb +84 -2
  22. data/lib/stripe/resources/billing/alert.rb +144 -0
  23. data/lib/stripe/resources/billing/alert_triggered.rb +26 -0
  24. data/lib/stripe/resources/billing/credit_balance_summary.rb +77 -0
  25. data/lib/stripe/resources/billing/credit_balance_transaction.rb +116 -0
  26. data/lib/stripe/resources/billing/credit_grant.rb +203 -0
  27. data/lib/stripe/resources/billing/meter.rb +178 -0
  28. data/lib/stripe/resources/billing/meter_error_report.rb +59 -0
  29. data/lib/stripe/resources/billing/meter_event.rb +35 -0
  30. data/lib/stripe/resources/billing/meter_event_adjustment.rb +43 -0
  31. data/lib/stripe/resources/billing/meter_event_summary.rb +15 -0
  32. data/lib/stripe/resources/billing_portal/configuration.rb +562 -0
  33. data/lib/stripe/resources/billing_portal/session.rb +271 -0
  34. data/lib/stripe/resources/capability.rb +84 -0
  35. data/lib/stripe/resources/capital/financing_offer.rb +188 -0
  36. data/lib/stripe/resources/capital/financing_summary.rb +64 -0
  37. data/lib/stripe/resources/capital/financing_transaction.rb +123 -0
  38. data/lib/stripe/resources/card.rb +79 -0
  39. data/lib/stripe/resources/cash_balance.rb +17 -0
  40. data/lib/stripe/resources/charge.rb +3026 -0
  41. data/lib/stripe/resources/checkout/session.rb +3654 -0
  42. data/lib/stripe/resources/climate/order.rb +176 -0
  43. data/lib/stripe/resources/climate/product.rb +56 -0
  44. data/lib/stripe/resources/climate/supplier.rb +54 -0
  45. data/lib/stripe/resources/confirmation_token.rb +1520 -0
  46. data/lib/stripe/resources/connect_collection_transfer.rb +24 -0
  47. data/lib/stripe/resources/country_spec.rb +63 -0
  48. data/lib/stripe/resources/coupon.rb +198 -0
  49. data/lib/stripe/resources/credit_note.rb +660 -0
  50. data/lib/stripe/resources/credit_note_line_item.rb +65 -0
  51. data/lib/stripe/resources/customer.rb +840 -0
  52. data/lib/stripe/resources/customer_balance_transaction.rb +27 -0
  53. data/lib/stripe/resources/customer_cash_balance_transaction.rb +109 -0
  54. data/lib/stripe/resources/customer_session.rb +159 -0
  55. data/lib/stripe/resources/discount.rb +29 -0
  56. data/lib/stripe/resources/dispute.rb +619 -0
  57. data/lib/stripe/resources/entitlements/active_entitlement.rb +46 -0
  58. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +23 -0
  59. data/lib/stripe/resources/entitlements/feature.rb +90 -0
  60. data/lib/stripe/resources/ephemeral_key.rb +21 -0
  61. data/lib/stripe/resources/event.rb +130 -0
  62. data/lib/stripe/resources/exchange_rate.rb +33 -0
  63. data/lib/stripe/resources/file.rb +111 -0
  64. data/lib/stripe/resources/file_link.rb +112 -0
  65. data/lib/stripe/resources/financial_connections/account.rb +260 -0
  66. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  67. data/lib/stripe/resources/financial_connections/account_owner.rb +17 -0
  68. data/lib/stripe/resources/financial_connections/account_ownership.rb +9 -0
  69. data/lib/stripe/resources/financial_connections/institution.rb +99 -0
  70. data/lib/stripe/resources/financial_connections/session.rb +159 -0
  71. data/lib/stripe/resources/financial_connections/transaction.rb +101 -0
  72. data/lib/stripe/resources/forwarding/request.rb +165 -0
  73. data/lib/stripe/resources/funding_instructions.rb +308 -0
  74. data/lib/stripe/resources/gift_cards/card.rb +217 -0
  75. data/lib/stripe/resources/gift_cards/transaction.rb +281 -0
  76. data/lib/stripe/resources/identity/verification_report.rb +266 -0
  77. data/lib/stripe/resources/identity/verification_session.rb +361 -0
  78. data/lib/stripe/resources/invoice.rb +8078 -0
  79. data/lib/stripe/resources/invoice_item.rb +445 -0
  80. data/lib/stripe/resources/invoice_line_item.rb +333 -0
  81. data/lib/stripe/resources/invoice_payment.rb +56 -0
  82. data/lib/stripe/resources/invoice_rendering_template.rb +67 -0
  83. data/lib/stripe/resources/issuing/authorization.rb +1117 -2
  84. data/lib/stripe/resources/issuing/card.rb +666 -0
  85. data/lib/stripe/resources/issuing/cardholder.rb +658 -0
  86. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +611 -0
  87. data/lib/stripe/resources/issuing/dispute.rb +790 -0
  88. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +84 -0
  89. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +95 -0
  90. data/lib/stripe/resources/issuing/personalization_design.rb +285 -0
  91. data/lib/stripe/resources/issuing/physical_bundle.rb +63 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +49 -0
  93. data/lib/stripe/resources/issuing/token.rb +175 -0
  94. data/lib/stripe/resources/issuing/transaction.rb +927 -0
  95. data/lib/stripe/resources/line_item.rb +75 -0
  96. data/lib/stripe/resources/login_link.rb +7 -0
  97. data/lib/stripe/resources/mandate.rb +169 -0
  98. data/lib/stripe/resources/margin.rb +124 -0
  99. data/lib/stripe/resources/order.rb +2850 -0
  100. data/lib/stripe/resources/payment_attempt_record.rb +184 -0
  101. data/lib/stripe/resources/payment_intent.rb +12864 -0
  102. data/lib/stripe/resources/payment_link.rb +1563 -0
  103. data/lib/stripe/resources/payment_method.rb +1638 -0
  104. data/lib/stripe/resources/payment_method_configuration.rb +2844 -0
  105. data/lib/stripe/resources/payment_method_domain.rb +153 -0
  106. data/lib/stripe/resources/payment_record.rb +715 -0
  107. data/lib/stripe/resources/payout.rb +218 -0
  108. data/lib/stripe/resources/person.rb +263 -0
  109. data/lib/stripe/resources/plan.rb +317 -0
  110. data/lib/stripe/resources/price.rb +649 -0
  111. data/lib/stripe/resources/product.rb +536 -0
  112. data/lib/stripe/resources/product_feature.rb +12 -0
  113. data/lib/stripe/resources/promotion_code.rb +221 -0
  114. data/lib/stripe/resources/quote.rb +2946 -0
  115. data/lib/stripe/resources/quote_line.rb +274 -0
  116. data/lib/stripe/resources/quote_preview_invoice.rb +652 -0
  117. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +362 -0
  118. data/lib/stripe/resources/radar/early_fraud_warning.rb +77 -0
  119. data/lib/stripe/resources/radar/value_list.rb +125 -0
  120. data/lib/stripe/resources/radar/value_list_item.rb +95 -0
  121. data/lib/stripe/resources/refund.rb +397 -0
  122. data/lib/stripe/resources/reporting/report_run.rb +150 -0
  123. data/lib/stripe/resources/reporting/report_type.rb +36 -0
  124. data/lib/stripe/resources/reserve_transaction.rb +22 -0
  125. data/lib/stripe/resources/reversal.rb +21 -0
  126. data/lib/stripe/resources/review.rb +108 -0
  127. data/lib/stripe/resources/setup_attempt.rb +373 -0
  128. data/lib/stripe/resources/setup_intent.rb +3834 -0
  129. data/lib/stripe/resources/shipping_rate.rb +259 -0
  130. data/lib/stripe/resources/sigma/scheduled_query_run.rb +54 -0
  131. data/lib/stripe/resources/source.rb +1239 -0
  132. data/lib/stripe/resources/source_mandate_notification.rb +66 -0
  133. data/lib/stripe/resources/source_transaction.rb +85 -0
  134. data/lib/stripe/resources/subscription.rb +2057 -0
  135. data/lib/stripe/resources/subscription_item.rb +433 -0
  136. data/lib/stripe/resources/subscription_schedule.rb +2402 -0
  137. data/lib/stripe/resources/tax/association.rb +89 -0
  138. data/lib/stripe/resources/tax/calculation.rb +387 -0
  139. data/lib/stripe/resources/tax/calculation_line_item.rb +56 -0
  140. data/lib/stripe/resources/tax/form.rb +220 -0
  141. data/lib/stripe/resources/tax/registration.rb +2382 -0
  142. data/lib/stripe/resources/tax/settings.rb +126 -0
  143. data/lib/stripe/resources/tax/transaction.rb +267 -0
  144. data/lib/stripe/resources/tax/transaction_line_item.rb +31 -0
  145. data/lib/stripe/resources/tax_code.rb +35 -0
  146. data/lib/stripe/resources/tax_deducted_at_source.rb +22 -0
  147. data/lib/stripe/resources/tax_id.rb +121 -0
  148. data/lib/stripe/resources/tax_rate.rb +200 -0
  149. data/lib/stripe/resources/terminal/configuration.rb +1011 -0
  150. data/lib/stripe/resources/terminal/connection_token.rb +18 -0
  151. data/lib/stripe/resources/terminal/location.rb +175 -0
  152. data/lib/stripe/resources/terminal/reader.rb +782 -0
  153. data/lib/stripe/resources/terminal/reader_collected_data.rb +40 -0
  154. data/lib/stripe/resources/test_helpers/test_clock.rb +86 -0
  155. data/lib/stripe/resources/token.rb +1149 -0
  156. data/lib/stripe/resources/topup.rb +174 -0
  157. data/lib/stripe/resources/transfer.rb +153 -0
  158. data/lib/stripe/resources/treasury/credit_reversal.rb +92 -0
  159. data/lib/stripe/resources/treasury/debit_reversal.rb +103 -0
  160. data/lib/stripe/resources/treasury/financial_account.rb +772 -0
  161. data/lib/stripe/resources/treasury/financial_account_features.rb +191 -0
  162. data/lib/stripe/resources/treasury/inbound_transfer.rb +235 -0
  163. data/lib/stripe/resources/treasury/outbound_payment.rb +495 -0
  164. data/lib/stripe/resources/treasury/outbound_transfer.rb +387 -0
  165. data/lib/stripe/resources/treasury/received_credit.rb +283 -0
  166. data/lib/stripe/resources/treasury/received_debit.rb +244 -0
  167. data/lib/stripe/resources/treasury/transaction.rb +176 -0
  168. data/lib/stripe/resources/treasury/transaction_entry.rb +157 -0
  169. data/lib/stripe/resources/usage_record.rb +13 -0
  170. data/lib/stripe/resources/usage_record_summary.rb +21 -0
  171. data/lib/stripe/resources/v2/amount.rb +9 -0
  172. data/lib/stripe/resources/v2/billing/meter_event.rb +18 -0
  173. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +21 -0
  174. data/lib/stripe/resources/v2/billing/meter_event_session.rb +14 -0
  175. data/lib/stripe/resources/v2/event.rb +27 -0
  176. data/lib/stripe/resources/v2/event_destination.rb +59 -0
  177. data/lib/stripe/resources/webhook_endpoint.rb +122 -0
  178. data/lib/stripe/resources.rb +31 -0
  179. data/lib/stripe/services/account_capability_service.rb +32 -0
  180. data/lib/stripe/services/account_external_account_service.rb +250 -0
  181. data/lib/stripe/services/account_link_service.rb +46 -0
  182. data/lib/stripe/services/account_login_link_service.rb +9 -0
  183. data/lib/stripe/services/account_notice_service.rb +101 -0
  184. data/lib/stripe/services/account_person_service.rb +875 -0
  185. data/lib/stripe/services/account_service.rb +4351 -0
  186. data/lib/stripe/services/account_session_service.rb +664 -0
  187. data/lib/stripe/services/apple_pay_domain_service.rb +51 -0
  188. data/lib/stripe/services/application_fee_refund_service.rb +54 -0
  189. data/lib/stripe/services/application_fee_service.rb +57 -0
  190. data/lib/stripe/services/apps/secret_service.rb +116 -0
  191. data/lib/stripe/services/balance_service.rb +9 -0
  192. data/lib/stripe/services/balance_transaction_service.rb +69 -0
  193. data/lib/stripe/services/billing/alert_service.rb +113 -0
  194. data/lib/stripe/services/billing/credit_balance_summary_service.rb +37 -0
  195. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +40 -0
  196. data/lib/stripe/services/billing/credit_grant_service.rb +151 -0
  197. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +26 -0
  198. data/lib/stripe/services/billing/meter_event_service.rb +21 -0
  199. data/lib/stripe/services/billing/meter_event_summary_service.rb +39 -0
  200. data/lib/stripe/services/billing/meter_service.rb +130 -0
  201. data/lib/stripe/services/billing_portal/configuration_service.rb +444 -0
  202. data/lib/stripe/services/billing_portal/session_service.rb +173 -0
  203. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  204. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  205. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  206. data/lib/stripe/services/capital_service.rb +15 -0
  207. data/lib/stripe/services/charge_service.rb +1736 -0
  208. data/lib/stripe/services/checkout/session_line_item_service.rb +18 -0
  209. data/lib/stripe/services/checkout/session_service.rb +2465 -0
  210. data/lib/stripe/services/climate/order_service.rb +102 -0
  211. data/lib/stripe/services/climate/product_service.rb +27 -0
  212. data/lib/stripe/services/climate/supplier_service.rb +27 -0
  213. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  214. data/lib/stripe/services/country_spec_service.rb +27 -0
  215. data/lib/stripe/services/coupon_service.rb +152 -0
  216. data/lib/stripe/services/credit_note_line_item_service.rb +18 -0
  217. data/lib/stripe/services/credit_note_preview_lines_service.rb +156 -0
  218. data/lib/stripe/services/credit_note_service.rb +373 -0
  219. data/lib/stripe/services/customer_balance_transaction_service.rb +63 -0
  220. data/lib/stripe/services/customer_cash_balance_service.rb +29 -0
  221. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +27 -0
  222. data/lib/stripe/services/customer_funding_instructions_service.rb +42 -0
  223. data/lib/stripe/services/customer_payment_method_service.rb +40 -0
  224. data/lib/stripe/services/customer_payment_source_service.rb +179 -0
  225. data/lib/stripe/services/customer_service.rb +593 -0
  226. data/lib/stripe/services/customer_session_service.rb +96 -0
  227. data/lib/stripe/services/customer_tax_id_service.rb +45 -0
  228. data/lib/stripe/services/dispute_service.rb +374 -0
  229. data/lib/stripe/services/entitlements/active_entitlement_service.rb +36 -0
  230. data/lib/stripe/services/entitlements/feature_service.rb +76 -0
  231. data/lib/stripe/services/ephemeral_key_service.rb +36 -0
  232. data/lib/stripe/services/event_service.rb +65 -0
  233. data/lib/stripe/services/exchange_rate_service.rb +27 -0
  234. data/lib/stripe/services/file_link_service.rb +94 -0
  235. data/lib/stripe/services/file_service.rb +89 -0
  236. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +37 -0
  237. data/lib/stripe/services/financial_connections/account_owner_service.rb +27 -0
  238. data/lib/stripe/services/financial_connections/account_service.rb +99 -1
  239. data/lib/stripe/services/financial_connections/institution_service.rb +57 -0
  240. data/lib/stripe/services/financial_connections/session_service.rb +97 -0
  241. data/lib/stripe/services/financial_connections/transaction_service.rb +70 -0
  242. data/lib/stripe/services/financial_connections_service.rb +2 -1
  243. data/lib/stripe/services/forwarding/request_service.rb +106 -0
  244. data/lib/stripe/services/gift_cards/card_service.rb +170 -0
  245. data/lib/stripe/services/gift_cards/transaction_service.rb +209 -0
  246. data/lib/stripe/services/gift_cards_service.rb +14 -0
  247. data/lib/stripe/services/identity/verification_report_service.rb +65 -0
  248. data/lib/stripe/services/identity/verification_session_service.rb +231 -0
  249. data/lib/stripe/services/invoice_item_service.rb +388 -0
  250. data/lib/stripe/services/invoice_line_item_service.rb +237 -0
  251. data/lib/stripe/services/invoice_payment_service.rb +55 -0
  252. data/lib/stripe/services/invoice_rendering_template_service.rb +51 -0
  253. data/lib/stripe/services/invoice_service.rb +5567 -1
  254. data/lib/stripe/services/invoice_upcoming_lines_service.rb +1864 -0
  255. data/lib/stripe/services/issuing/authorization_service.rb +104 -0
  256. data/lib/stripe/services/issuing/card_service.rb +455 -0
  257. data/lib/stripe/services/issuing/cardholder_service.rb +526 -0
  258. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  259. data/lib/stripe/services/issuing/dispute_service.rb +633 -0
  260. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  261. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  262. data/lib/stripe/services/issuing/personalization_design_service.rb +193 -0
  263. data/lib/stripe/services/issuing/physical_bundle_service.rb +40 -0
  264. data/lib/stripe/services/issuing/token_service.rb +73 -0
  265. data/lib/stripe/services/issuing/transaction_service.rb +81 -0
  266. data/lib/stripe/services/issuing_service.rb +5 -1
  267. data/lib/stripe/services/mandate_service.rb +9 -0
  268. data/lib/stripe/services/margin_service.rb +119 -0
  269. data/lib/stripe/services/order_line_item_service.rb +35 -0
  270. data/lib/stripe/services/order_service.rb +2254 -0
  271. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  272. data/lib/stripe/services/payment_intent_service.rb +10894 -0
  273. data/lib/stripe/services/payment_link_line_item_service.rb +18 -0
  274. data/lib/stripe/services/payment_link_service.rb +1223 -0
  275. data/lib/stripe/services/payment_method_configuration_service.rb +2046 -0
  276. data/lib/stripe/services/payment_method_domain_service.rb +76 -0
  277. data/lib/stripe/services/payment_method_service.rb +864 -0
  278. data/lib/stripe/services/payment_record_service.rb +542 -0
  279. data/lib/stripe/services/payout_service.rb +159 -0
  280. data/lib/stripe/services/plan_service.rb +253 -0
  281. data/lib/stripe/services/price_service.rb +516 -0
  282. data/lib/stripe/services/product_feature_service.rb +42 -0
  283. data/lib/stripe/services/product_service.rb +459 -0
  284. data/lib/stripe/services/promotion_code_service.rb +178 -0
  285. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +18 -0
  286. data/lib/stripe/services/quote_line_item_service.rb +18 -0
  287. data/lib/stripe/services/quote_line_service.rb +35 -0
  288. data/lib/stripe/services/quote_preview_invoice_service.rb +35 -0
  289. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  290. data/lib/stripe/services/quote_service.rb +2319 -1
  291. data/lib/stripe/services/radar/early_fraud_warning_service.rb +61 -0
  292. data/lib/stripe/services/radar/value_list_item_service.rb +79 -0
  293. data/lib/stripe/services/radar/value_list_service.rb +103 -0
  294. data/lib/stripe/services/refund_service.rb +137 -0
  295. data/lib/stripe/services/reporting/report_run_service.rb +106 -0
  296. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  297. data/lib/stripe/services/review_service.rb +56 -0
  298. data/lib/stripe/services/setup_attempt_service.rb +51 -0
  299. data/lib/stripe/services/setup_intent_service.rb +3476 -0
  300. data/lib/stripe/services/shipping_rate_service.rb +200 -0
  301. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +27 -0
  302. data/lib/stripe/services/source_service.rb +601 -0
  303. data/lib/stripe/services/source_transaction_service.rb +18 -0
  304. data/lib/stripe/services/subscription_item_service.rb +383 -0
  305. data/lib/stripe/services/subscription_item_usage_record_service.rb +18 -0
  306. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +18 -0
  307. data/lib/stripe/services/subscription_schedule_service.rb +2053 -0
  308. data/lib/stripe/services/subscription_service.rb +1722 -0
  309. data/lib/stripe/services/tax/association_service.rb +31 -0
  310. data/lib/stripe/services/tax/calculation_line_item_service.rb +18 -0
  311. data/lib/stripe/services/tax/calculation_service.rb +205 -0
  312. data/lib/stripe/services/tax/form_service.rb +100 -0
  313. data/lib/stripe/services/tax/registration_service.rb +1564 -0
  314. data/lib/stripe/services/tax/settings_service.rb +74 -0
  315. data/lib/stripe/services/tax/transaction_line_item_service.rb +18 -0
  316. data/lib/stripe/services/tax/transaction_service.rb +111 -0
  317. data/lib/stripe/services/tax_code_service.rb +27 -0
  318. data/lib/stripe/services/tax_id_service.rb +79 -0
  319. data/lib/stripe/services/tax_rate_service.rb +155 -0
  320. data/lib/stripe/services/tax_service.rb +3 -1
  321. data/lib/stripe/services/terminal/configuration_service.rb +793 -0
  322. data/lib/stripe/services/terminal/connection_token_service.rb +12 -0
  323. data/lib/stripe/services/terminal/location_service.rb +144 -0
  324. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  325. data/lib/stripe/services/terminal/reader_service.rb +443 -0
  326. data/lib/stripe/services/terminal_service.rb +2 -1
  327. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +673 -0
  328. data/lib/stripe/services/test_helpers/customer_service.rb +18 -0
  329. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +745 -0
  330. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  331. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +41 -0
  332. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +632 -0
  333. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  334. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +44 -0
  335. data/lib/stripe/services/test_helpers/test_clock_service.rb +57 -0
  336. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +38 -0
  337. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +87 -0
  338. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +87 -0
  339. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +84 -0
  340. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +84 -0
  341. data/lib/stripe/services/token_service.rb +1121 -0
  342. data/lib/stripe/services/topup_service.rb +142 -0
  343. data/lib/stripe/services/transfer_reversal_service.rb +66 -0
  344. data/lib/stripe/services/transfer_service.rb +119 -0
  345. data/lib/stripe/services/treasury/credit_reversal_service.rb +59 -0
  346. data/lib/stripe/services/treasury/debit_reversal_service.rb +63 -0
  347. data/lib/stripe/services/treasury/financial_account_features_service.rb +169 -0
  348. data/lib/stripe/services/treasury/financial_account_service.rb +509 -0
  349. data/lib/stripe/services/treasury/inbound_transfer_service.rb +88 -0
  350. data/lib/stripe/services/treasury/outbound_payment_service.rb +258 -0
  351. data/lib/stripe/services/treasury/outbound_transfer_service.rb +148 -0
  352. data/lib/stripe/services/treasury/received_credit_service.rb +52 -0
  353. data/lib/stripe/services/treasury/received_debit_service.rb +40 -0
  354. data/lib/stripe/services/treasury/transaction_entry_service.rb +87 -0
  355. data/lib/stripe/services/treasury/transaction_service.rb +95 -0
  356. data/lib/stripe/services/v1_services.rb +8 -1
  357. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +23 -0
  358. data/lib/stripe/services/v2/billing/meter_event_service.rb +25 -0
  359. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  360. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +33 -0
  361. data/lib/stripe/services/v2/core/event_destination_service.rb +146 -0
  362. data/lib/stripe/services/v2/core/event_service.rb +18 -0
  363. data/lib/stripe/services/webhook_endpoint_service.rb +96 -0
  364. data/lib/stripe/services.rb +25 -0
  365. data/lib/stripe/stripe_client.rb +1 -1
  366. data/lib/stripe/stripe_configuration.rb +3 -1
  367. data/lib/stripe/stripe_object.rb +5 -0
  368. data/lib/stripe/util.rb +7 -1
  369. data/lib/stripe/version.rb +1 -1
  370. data/lib/stripe.rb +46 -0
  371. data/rbi/stripe/resources/account.rbi +5100 -0
  372. data/rbi/stripe/resources/account_link.rbi +74 -0
  373. data/rbi/stripe/resources/account_notice.rbi +139 -0
  374. data/rbi/stripe/resources/account_session.rbi +1007 -0
  375. data/rbi/stripe/resources/apple_pay_domain.rbi +97 -0
  376. data/rbi/stripe/resources/application.rbi +20 -0
  377. data/rbi/stripe/resources/application_fee.rbi +123 -0
  378. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  379. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  380. data/rbi/stripe/resources/balance.rbi +187 -0
  381. data/rbi/stripe/resources/balance_transaction.rbi +149 -0
  382. data/rbi/stripe/resources/bank_account.rbi +127 -0
  383. data/rbi/stripe/resources/billing/alert.rbi +206 -0
  384. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  385. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +102 -0
  386. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +154 -0
  387. data/rbi/stripe/resources/billing/credit_grant.rbi +269 -0
  388. data/rbi/stripe/resources/billing/meter.rbi +233 -0
  389. data/rbi/stripe/resources/billing/meter_error_report.rbi +71 -0
  390. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  391. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  392. data/rbi/stripe/resources/billing/meter_event_summary.rbi +33 -0
  393. data/rbi/stripe/resources/billing_portal/configuration.rbi +640 -0
  394. data/rbi/stripe/resources/billing_portal/session.rbi +341 -0
  395. data/rbi/stripe/resources/capability.rbi +125 -0
  396. data/rbi/stripe/resources/capital/financing_offer.rbi +190 -0
  397. data/rbi/stripe/resources/capital/financing_summary.rbi +74 -0
  398. data/rbi/stripe/resources/capital/financing_transaction.rbi +130 -0
  399. data/rbi/stripe/resources/card.rbi +128 -0
  400. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  401. data/rbi/stripe/resources/charge.rbi +3484 -0
  402. data/rbi/stripe/resources/checkout/session.rbi +3995 -0
  403. data/rbi/stripe/resources/climate/order.rbi +250 -0
  404. data/rbi/stripe/resources/climate/product.rbi +82 -0
  405. data/rbi/stripe/resources/climate/supplier.rbi +79 -0
  406. data/rbi/stripe/resources/confirmation_token.rbi +1776 -0
  407. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  408. data/rbi/stripe/resources/country_spec.rbi +92 -0
  409. data/rbi/stripe/resources/coupon.rbi +257 -0
  410. data/rbi/stripe/resources/credit_note.rbi +759 -0
  411. data/rbi/stripe/resources/credit_note_line_item.rbi +99 -0
  412. data/rbi/stripe/resources/customer.rbi +1001 -0
  413. data/rbi/stripe/resources/customer_balance_transaction.rbi +53 -0
  414. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  415. data/rbi/stripe/resources/customer_session.rbi +196 -0
  416. data/rbi/stripe/resources/discount.rbi +53 -0
  417. data/rbi/stripe/resources/dispute.rbi +764 -0
  418. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +65 -0
  419. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  420. data/rbi/stripe/resources/entitlements/feature.rbi +124 -0
  421. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  422. data/rbi/stripe/resources/event.rbi +190 -0
  423. data/rbi/stripe/resources/exchange_rate.rbi +73 -0
  424. data/rbi/stripe/resources/file.rbi +148 -0
  425. data/rbi/stripe/resources/file_link.rbi +146 -0
  426. data/rbi/stripe/resources/financial_connections/account.rbi +358 -0
  427. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +27 -0
  428. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  429. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  430. data/rbi/stripe/resources/financial_connections/institution.rbi +99 -0
  431. data/rbi/stripe/resources/financial_connections/session.rbi +186 -0
  432. data/rbi/stripe/resources/financial_connections/transaction.rbi +127 -0
  433. data/rbi/stripe/resources/forwarding/request.rbi +219 -0
  434. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  435. data/rbi/stripe/resources/gift_cards/card.rbi +206 -0
  436. data/rbi/stripe/resources/gift_cards/transaction.rbi +257 -0
  437. data/rbi/stripe/resources/identity/verification_report.rbi +354 -0
  438. data/rbi/stripe/resources/identity/verification_session.rbi +518 -0
  439. data/rbi/stripe/resources/invoice.rbi +8928 -0
  440. data/rbi/stripe/resources/invoice_item.rbi +514 -0
  441. data/rbi/stripe/resources/invoice_line_item.rbi +400 -0
  442. data/rbi/stripe/resources/invoice_payment.rbi +70 -0
  443. data/rbi/stripe/resources/invoice_rendering_template.rbi +114 -0
  444. data/rbi/stripe/resources/issuing/authorization.rbi +1266 -0
  445. data/rbi/stripe/resources/issuing/card.rbi +738 -0
  446. data/rbi/stripe/resources/issuing/cardholder.rbi +732 -0
  447. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +622 -0
  448. data/rbi/stripe/resources/issuing/dispute.rbi +900 -0
  449. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +83 -0
  450. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +90 -0
  451. data/rbi/stripe/resources/issuing/personalization_design.rbi +333 -0
  452. data/rbi/stripe/resources/issuing/physical_bundle.rbi +86 -0
  453. data/rbi/stripe/resources/issuing/settlement.rbi +62 -0
  454. data/rbi/stripe/resources/issuing/token.rbi +231 -0
  455. data/rbi/stripe/resources/issuing/transaction.rbi +1057 -0
  456. data/rbi/stripe/resources/line_item.rbi +108 -0
  457. data/rbi/stripe/resources/login_link.rbi +18 -0
  458. data/rbi/stripe/resources/mandate.rbi +219 -0
  459. data/rbi/stripe/resources/margin.rbi +127 -0
  460. data/rbi/stripe/resources/order.rbi +3016 -0
  461. data/rbi/stripe/resources/payment_attempt_record.rbi +215 -0
  462. data/rbi/stripe/resources/payment_intent.rbi +13843 -0
  463. data/rbi/stripe/resources/payment_link.rbi +1666 -0
  464. data/rbi/stripe/resources/payment_method.rbi +1908 -0
  465. data/rbi/stripe/resources/payment_method_configuration.rbi +3171 -0
  466. data/rbi/stripe/resources/payment_method_domain.rbi +217 -0
  467. data/rbi/stripe/resources/payment_record.rbi +722 -0
  468. data/rbi/stripe/resources/payout.rbi +299 -0
  469. data/rbi/stripe/resources/person.rbi +371 -0
  470. data/rbi/stripe/resources/plan.rbi +385 -0
  471. data/rbi/stripe/resources/price.rbi +731 -0
  472. data/rbi/stripe/resources/product.rbi +615 -0
  473. data/rbi/stripe/resources/product_feature.rbi +26 -0
  474. data/rbi/stripe/resources/promotion_code.rbi +266 -0
  475. data/rbi/stripe/resources/quote.rbi +3186 -0
  476. data/rbi/stripe/resources/quote_line.rbi +350 -0
  477. data/rbi/stripe/resources/quote_preview_invoice.rbi +850 -0
  478. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +474 -0
  479. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +101 -0
  480. data/rbi/stripe/resources/radar/value_list.rbi +175 -0
  481. data/rbi/stripe/resources/radar/value_list_item.rbi +134 -0
  482. data/rbi/stripe/resources/refund.rbi +515 -0
  483. data/rbi/stripe/resources/reporting/report_run.rbi +194 -0
  484. data/rbi/stripe/resources/reporting/report_type.rbi +64 -0
  485. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  486. data/rbi/stripe/resources/reversal.rbi +51 -0
  487. data/rbi/stripe/resources/review.rbi +159 -0
  488. data/rbi/stripe/resources/setup_attempt.rbi +484 -0
  489. data/rbi/stripe/resources/setup_intent.rbi +4041 -0
  490. data/rbi/stripe/resources/shipping_rate.rbi +310 -0
  491. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +82 -0
  492. data/rbi/stripe/resources/source.rbi +1543 -0
  493. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  494. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  495. data/rbi/stripe/resources/subscription.rbi +2308 -0
  496. data/rbi/stripe/resources/subscription_item.rbi +478 -0
  497. data/rbi/stripe/resources/subscription_schedule.rbi +2653 -0
  498. data/rbi/stripe/resources/tax/association.rbi +94 -0
  499. data/rbi/stripe/resources/tax/calculation.rbi +479 -0
  500. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  501. data/rbi/stripe/resources/tax/form.rbi +224 -0
  502. data/rbi/stripe/resources/tax/registration.rbi +2438 -0
  503. data/rbi/stripe/resources/tax/settings.rbi +148 -0
  504. data/rbi/stripe/resources/tax/transaction.rbi +356 -0
  505. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  506. data/rbi/stripe/resources/tax_code.rbi +51 -0
  507. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  508. data/rbi/stripe/resources/tax_id.rbi +174 -0
  509. data/rbi/stripe/resources/tax_rate.rbi +244 -0
  510. data/rbi/stripe/resources/terminal/configuration.rbi +1091 -0
  511. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  512. data/rbi/stripe/resources/terminal/location.rbi +231 -0
  513. data/rbi/stripe/resources/terminal/reader.rbi +952 -0
  514. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +41 -0
  515. data/rbi/stripe/resources/test_helpers/test_clock.rbi +139 -0
  516. data/rbi/stripe/resources/token.rbi +1175 -0
  517. data/rbi/stripe/resources/topup.rbi +225 -0
  518. data/rbi/stripe/resources/transfer.rbi +204 -0
  519. data/rbi/stripe/resources/treasury/credit_reversal.rbi +126 -0
  520. data/rbi/stripe/resources/treasury/debit_reversal.rbi +138 -0
  521. data/rbi/stripe/resources/treasury/financial_account.rbi +870 -0
  522. data/rbi/stripe/resources/treasury/financial_account_features.rbi +263 -0
  523. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +302 -0
  524. data/rbi/stripe/resources/treasury/outbound_payment.rbi +589 -0
  525. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +473 -0
  526. data/rbi/stripe/resources/treasury/received_credit.rbi +348 -0
  527. data/rbi/stripe/resources/treasury/received_debit.rbi +305 -0
  528. data/rbi/stripe/resources/treasury/transaction.rbi +216 -0
  529. data/rbi/stripe/resources/treasury/transaction_entry.rbi +193 -0
  530. data/rbi/stripe/resources/usage_record.rbi +32 -0
  531. data/rbi/stripe/resources/usage_record_summary.rbi +38 -0
  532. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  533. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  534. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  535. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  536. data/rbi/stripe/resources/v2/event.rbi +47 -0
  537. data/rbi/stripe/resources/v2/event_destination.rbi +90 -0
  538. data/rbi/stripe/resources/webhook_endpoint.rbi +177 -0
  539. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  540. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  541. data/rbi/stripe/services/account_link_service.rbi +58 -0
  542. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  543. data/rbi/stripe/services/account_notice_service.rbi +90 -0
  544. data/rbi/stripe/services/account_person_service.rbi +903 -0
  545. data/rbi/stripe/services/account_service.rbi +4185 -0
  546. data/rbi/stripe/services/account_session_service.rbi +757 -0
  547. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  548. data/rbi/stripe/services/application_fee_refund_service.rbi +91 -0
  549. data/rbi/stripe/services/application_fee_service.rbi +74 -0
  550. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  551. data/rbi/stripe/services/apps_service.rbi +9 -0
  552. data/rbi/stripe/services/balance_service.rbi +21 -0
  553. data/rbi/stripe/services/balance_transaction_service.rbi +89 -0
  554. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  555. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +54 -0
  556. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  557. data/rbi/stripe/services/billing/credit_grant_service.rbi +191 -0
  558. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +40 -0
  559. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  560. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  561. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  562. data/rbi/stripe/services/billing_portal/configuration_service.rbi +497 -0
  563. data/rbi/stripe/services/billing_portal/session_service.rbi +202 -0
  564. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  565. data/rbi/stripe/services/billing_service.rbi +15 -0
  566. data/rbi/stripe/services/capital/financing_offer_service.rbi +95 -0
  567. data/rbi/stripe/services/capital/financing_summary_service.rbi +22 -0
  568. data/rbi/stripe/services/capital/financing_transaction_service.rbi +68 -0
  569. data/rbi/stripe/services/capital_service.rbi +11 -0
  570. data/rbi/stripe/services/charge_service.rbi +1816 -0
  571. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  572. data/rbi/stripe/services/checkout/session_service.rbi +2582 -0
  573. data/rbi/stripe/services/checkout_service.rbi +9 -0
  574. data/rbi/stripe/services/climate/order_service.rbi +140 -0
  575. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  576. data/rbi/stripe/services/climate/supplier_service.rbi +46 -0
  577. data/rbi/stripe/services/climate_service.rbi +11 -0
  578. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  579. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  580. data/rbi/stripe/services/coupon_service.rbi +190 -0
  581. data/rbi/stripe/services/credit_note_line_item_service.rbi +31 -0
  582. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  583. data/rbi/stripe/services/credit_note_service.rbi +420 -0
  584. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  585. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  586. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  587. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  588. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  589. data/rbi/stripe/services/customer_payment_source_service.rbi +228 -0
  590. data/rbi/stripe/services/customer_service.rbi +647 -0
  591. data/rbi/stripe/services/customer_session_service.rbi +110 -0
  592. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  593. data/rbi/stripe/services/dispute_service.rbi +422 -0
  594. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  595. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  596. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  597. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  598. data/rbi/stripe/services/event_service.rbi +81 -0
  599. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  600. data/rbi/stripe/services/file_link_service.rbi +122 -0
  601. data/rbi/stripe/services/file_service.rbi +114 -0
  602. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +33 -0
  603. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  604. data/rbi/stripe/services/financial_connections/account_service.rbi +132 -0
  605. data/rbi/stripe/services/financial_connections/institution_service.rbi +46 -0
  606. data/rbi/stripe/services/financial_connections/session_service.rbi +111 -0
  607. data/rbi/stripe/services/financial_connections/transaction_service.rbi +90 -0
  608. data/rbi/stripe/services/financial_connections_service.rbi +12 -0
  609. data/rbi/stripe/services/forwarding/request_service.rbi +132 -0
  610. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  611. data/rbi/stripe/services/gift_cards/card_service.rbi +142 -0
  612. data/rbi/stripe/services/gift_cards/transaction_service.rbi +174 -0
  613. data/rbi/stripe/services/gift_cards_service.rbi +10 -0
  614. data/rbi/stripe/services/identity/verification_report_service.rbi +85 -0
  615. data/rbi/stripe/services/identity/verification_session_service.rbi +317 -0
  616. data/rbi/stripe/services/identity_service.rbi +10 -0
  617. data/rbi/stripe/services/invoice_item_service.rbi +424 -0
  618. data/rbi/stripe/services/invoice_line_item_service.rbi +270 -0
  619. data/rbi/stripe/services/invoice_payment_service.rbi +44 -0
  620. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  621. data/rbi/stripe/services/invoice_service.rbi +6040 -0
  622. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +2023 -0
  623. data/rbi/stripe/services/issuing/authorization_service.rbi +140 -0
  624. data/rbi/stripe/services/issuing/card_service.rbi +479 -0
  625. data/rbi/stripe/services/issuing/cardholder_service.rbi +568 -0
  626. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +498 -0
  627. data/rbi/stripe/services/issuing/dispute_service.rbi +701 -0
  628. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +55 -0
  629. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +73 -0
  630. data/rbi/stripe/services/issuing/personalization_design_service.rbi +233 -0
  631. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  632. data/rbi/stripe/services/issuing/token_service.rbi +95 -0
  633. data/rbi/stripe/services/issuing/transaction_service.rbi +103 -0
  634. data/rbi/stripe/services/issuing_service.rbi +19 -0
  635. data/rbi/stripe/services/mandate_service.rbi +20 -0
  636. data/rbi/stripe/services/margin_service.rbi +104 -0
  637. data/rbi/stripe/services/order_line_item_service.rbi +31 -0
  638. data/rbi/stripe/services/order_service.rbi +2306 -0
  639. data/rbi/stripe/services/payment_attempt_record_service.rbi +36 -0
  640. data/rbi/stripe/services/payment_intent_service.rbi +11429 -0
  641. data/rbi/stripe/services/payment_link_line_item_service.rbi +31 -0
  642. data/rbi/stripe/services/payment_link_service.rbi +1250 -0
  643. data/rbi/stripe/services/payment_method_configuration_service.rbi +2171 -0
  644. data/rbi/stripe/services/payment_method_domain_service.rbi +110 -0
  645. data/rbi/stripe/services/payment_method_service.rbi +883 -0
  646. data/rbi/stripe/services/payment_record_service.rbi +521 -0
  647. data/rbi/stripe/services/payout_service.rbi +197 -0
  648. data/rbi/stripe/services/plan_service.rbi +286 -0
  649. data/rbi/stripe/services/price_service.rbi +551 -0
  650. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  651. data/rbi/stripe/services/product_service.rbi +503 -0
  652. data/rbi/stripe/services/promotion_code_service.rbi +210 -0
  653. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  654. data/rbi/stripe/services/quote_line_item_service.rbi +31 -0
  655. data/rbi/stripe/services/quote_line_service.rbi +31 -0
  656. data/rbi/stripe/services/quote_preview_invoice_service.rbi +31 -0
  657. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +31 -0
  658. data/rbi/stripe/services/quote_service.rbi +2390 -0
  659. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +83 -0
  660. data/rbi/stripe/services/radar/value_list_item_service.rbi +107 -0
  661. data/rbi/stripe/services/radar/value_list_service.rbi +139 -0
  662. data/rbi/stripe/services/radar_service.rbi +11 -0
  663. data/rbi/stripe/services/refund_service.rbi +181 -0
  664. data/rbi/stripe/services/reporting/report_run_service.rbi +131 -0
  665. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  666. data/rbi/stripe/services/reporting_service.rbi +10 -0
  667. data/rbi/stripe/services/review_service.rbi +82 -0
  668. data/rbi/stripe/services/setup_attempt_service.rbi +63 -0
  669. data/rbi/stripe/services/setup_intent_service.rbi +3609 -0
  670. data/rbi/stripe/services/shipping_rate_service.rbi +235 -0
  671. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  672. data/rbi/stripe/services/sigma_service.rbi +9 -0
  673. data/rbi/stripe/services/source_service.rbi +647 -0
  674. data/rbi/stripe/services/source_transaction_service.rbi +31 -0
  675. data/rbi/stripe/services/subscription_item_service.rbi +422 -0
  676. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +37 -0
  677. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +33 -0
  678. data/rbi/stripe/services/subscription_schedule_service.rbi +2208 -0
  679. data/rbi/stripe/services/subscription_service.rbi +1870 -0
  680. data/rbi/stripe/services/tax/association_service.rbi +25 -0
  681. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  682. data/rbi/stripe/services/tax/calculation_service.rbi +228 -0
  683. data/rbi/stripe/services/tax/form_service.rbi +85 -0
  684. data/rbi/stripe/services/tax/registration_service.rbi +1517 -0
  685. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  686. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +33 -0
  687. data/rbi/stripe/services/tax/transaction_service.rbi +142 -0
  688. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  689. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  690. data/rbi/stripe/services/tax_rate_service.rbi +183 -0
  691. data/rbi/stripe/services/tax_service.rbi +14 -0
  692. data/rbi/stripe/services/terminal/configuration_service.rbi +822 -0
  693. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  694. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  695. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +22 -0
  696. data/rbi/stripe/services/terminal/reader_service.rbi +513 -0
  697. data/rbi/stripe/services/terminal_service.rbi +13 -0
  698. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +778 -0
  699. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  700. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +836 -0
  701. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  702. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +67 -0
  703. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +705 -0
  704. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  705. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  706. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  707. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  708. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +90 -0
  709. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  710. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +123 -0
  711. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +123 -0
  712. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +114 -0
  713. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +114 -0
  714. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  715. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  716. data/rbi/stripe/services/token_service.rbi +1136 -0
  717. data/rbi/stripe/services/topup_service.rbi +172 -0
  718. data/rbi/stripe/services/transfer_reversal_service.rbi +99 -0
  719. data/rbi/stripe/services/transfer_service.rbi +150 -0
  720. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  721. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  722. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +201 -0
  723. data/rbi/stripe/services/treasury/financial_account_service.rbi +566 -0
  724. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  725. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +300 -0
  726. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +182 -0
  727. data/rbi/stripe/services/treasury/received_credit_service.rbi +70 -0
  728. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  729. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +107 -0
  730. data/rbi/stripe/services/treasury/transaction_service.rbi +114 -0
  731. data/rbi/stripe/services/treasury_service.rbi +18 -0
  732. data/rbi/stripe/services/v1_services.rbi +83 -0
  733. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  734. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  735. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  736. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  737. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  738. data/rbi/stripe/services/v2/core/event_destination_service.rbi +203 -0
  739. data/rbi/stripe/services/v2/core/event_service.rbi +39 -0
  740. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  741. data/rbi/stripe/services/v2_services.rbi +10 -0
  742. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  743. metadata +435 -4
@@ -0,0 +1,3484 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ # The `Charge` object represents a single attempt to move money into your Stripe account.
7
+ # PaymentIntent confirmation is the most common way to create Charges, but transferring
8
+ # money to a different Stripe account through Connect also creates Charges.
9
+ # Some legacy payment flows create Charges directly, which is not recommended for new integrations.
10
+ class Charge < APIResource
11
+ class BillingDetails < Stripe::StripeObject
12
+ class Address < Stripe::StripeObject
13
+ # City, district, suburb, town, or village.
14
+ sig { returns(T.nilable(String)) }
15
+ attr_reader :city
16
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
17
+ sig { returns(T.nilable(String)) }
18
+ attr_reader :country
19
+ # Address line 1 (e.g., street, PO Box, or company name).
20
+ sig { returns(T.nilable(String)) }
21
+ attr_reader :line1
22
+ # Address line 2 (e.g., apartment, suite, unit, or building).
23
+ sig { returns(T.nilable(String)) }
24
+ attr_reader :line2
25
+ # ZIP or postal code.
26
+ sig { returns(T.nilable(String)) }
27
+ attr_reader :postal_code
28
+ # State, county, province, or region.
29
+ sig { returns(T.nilable(String)) }
30
+ attr_reader :state
31
+ end
32
+ # Billing address.
33
+ sig { returns(T.nilable(Address)) }
34
+ attr_reader :address
35
+ # Email address.
36
+ sig { returns(T.nilable(String)) }
37
+ attr_reader :email
38
+ # Full name.
39
+ sig { returns(T.nilable(String)) }
40
+ attr_reader :name
41
+ # Billing phone number (including extension).
42
+ sig { returns(T.nilable(String)) }
43
+ attr_reader :phone
44
+ end
45
+ class FraudDetails < Stripe::StripeObject
46
+ # Assessments from Stripe. If set, the value is `fraudulent`.
47
+ sig { returns(String) }
48
+ attr_reader :stripe_report
49
+ # Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.
50
+ sig { returns(String) }
51
+ attr_reader :user_report
52
+ end
53
+ class Level3 < Stripe::StripeObject
54
+ class LineItem < Stripe::StripeObject
55
+ # Attribute for field discount_amount
56
+ sig { returns(T.nilable(Integer)) }
57
+ attr_reader :discount_amount
58
+ # Attribute for field product_code
59
+ sig { returns(String) }
60
+ attr_reader :product_code
61
+ # Attribute for field product_description
62
+ sig { returns(String) }
63
+ attr_reader :product_description
64
+ # Attribute for field quantity
65
+ sig { returns(T.nilable(Integer)) }
66
+ attr_reader :quantity
67
+ # Attribute for field tax_amount
68
+ sig { returns(T.nilable(Integer)) }
69
+ attr_reader :tax_amount
70
+ # Attribute for field unit_cost
71
+ sig { returns(T.nilable(Integer)) }
72
+ attr_reader :unit_cost
73
+ end
74
+ # Attribute for field customer_reference
75
+ sig { returns(String) }
76
+ attr_reader :customer_reference
77
+ # Attribute for field line_items
78
+ sig { returns(T::Array[LineItem]) }
79
+ attr_reader :line_items
80
+ # Attribute for field merchant_reference
81
+ sig { returns(String) }
82
+ attr_reader :merchant_reference
83
+ # Attribute for field shipping_address_zip
84
+ sig { returns(String) }
85
+ attr_reader :shipping_address_zip
86
+ # Attribute for field shipping_amount
87
+ sig { returns(Integer) }
88
+ attr_reader :shipping_amount
89
+ # Attribute for field shipping_from_zip
90
+ sig { returns(String) }
91
+ attr_reader :shipping_from_zip
92
+ end
93
+ class Outcome < Stripe::StripeObject
94
+ class Rule < Stripe::StripeObject
95
+ # The action taken on the payment.
96
+ sig { returns(String) }
97
+ attr_reader :action
98
+ # Unique identifier for the object.
99
+ sig { returns(String) }
100
+ attr_reader :id
101
+ # The predicate to evaluate the payment against.
102
+ sig { returns(String) }
103
+ attr_reader :predicate
104
+ end
105
+ # An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).
106
+ sig { returns(T.nilable(String)) }
107
+ attr_reader :advice_code
108
+ # For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.
109
+ sig { returns(T.nilable(String)) }
110
+ attr_reader :network_advice_code
111
+ # For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
112
+ sig { returns(T.nilable(String)) }
113
+ attr_reader :network_decline_code
114
+ # Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
115
+ sig { returns(T.nilable(String)) }
116
+ attr_reader :network_status
117
+ # An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.
118
+ sig { returns(T.nilable(String)) }
119
+ attr_reader :reason
120
+ # Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.
121
+ sig { returns(String) }
122
+ attr_reader :risk_level
123
+ # Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.
124
+ sig { returns(Integer) }
125
+ attr_reader :risk_score
126
+ # The ID of the Radar rule that matched the payment, if applicable.
127
+ sig { returns(T.any(String, Rule)) }
128
+ attr_reader :rule
129
+ # A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
130
+ sig { returns(T.nilable(String)) }
131
+ attr_reader :seller_message
132
+ # Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.
133
+ sig { returns(String) }
134
+ attr_reader :type
135
+ end
136
+ class PaymentMethodDetails < Stripe::StripeObject
137
+ class AchCreditTransfer < Stripe::StripeObject
138
+ # Account number to transfer funds to.
139
+ sig { returns(T.nilable(String)) }
140
+ attr_reader :account_number
141
+ # Name of the bank associated with the routing number.
142
+ sig { returns(T.nilable(String)) }
143
+ attr_reader :bank_name
144
+ # Routing transit number for the bank account to transfer funds to.
145
+ sig { returns(T.nilable(String)) }
146
+ attr_reader :routing_number
147
+ # SWIFT code of the bank associated with the routing number.
148
+ sig { returns(T.nilable(String)) }
149
+ attr_reader :swift_code
150
+ end
151
+ class AchDebit < Stripe::StripeObject
152
+ # Type of entity that holds the account. This can be either `individual` or `company`.
153
+ sig { returns(T.nilable(String)) }
154
+ attr_reader :account_holder_type
155
+ # Name of the bank associated with the bank account.
156
+ sig { returns(T.nilable(String)) }
157
+ attr_reader :bank_name
158
+ # Two-letter ISO code representing the country the bank account is located in.
159
+ sig { returns(T.nilable(String)) }
160
+ attr_reader :country
161
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
162
+ sig { returns(T.nilable(String)) }
163
+ attr_reader :fingerprint
164
+ # Last four digits of the bank account number.
165
+ sig { returns(T.nilable(String)) }
166
+ attr_reader :last4
167
+ # Routing transit number of the bank account.
168
+ sig { returns(T.nilable(String)) }
169
+ attr_reader :routing_number
170
+ end
171
+ class AcssDebit < Stripe::StripeObject
172
+ # Name of the bank associated with the bank account.
173
+ sig { returns(T.nilable(String)) }
174
+ attr_reader :bank_name
175
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
176
+ sig { returns(T.nilable(String)) }
177
+ attr_reader :fingerprint
178
+ # Institution number of the bank account
179
+ sig { returns(T.nilable(String)) }
180
+ attr_reader :institution_number
181
+ # Last four digits of the bank account number.
182
+ sig { returns(T.nilable(String)) }
183
+ attr_reader :last4
184
+ # ID of the mandate used to make this payment.
185
+ sig { returns(String) }
186
+ attr_reader :mandate
187
+ # Transit number of the bank account.
188
+ sig { returns(T.nilable(String)) }
189
+ attr_reader :transit_number
190
+ end
191
+ class Affirm < Stripe::StripeObject
192
+ # The Affirm transaction ID associated with this payment.
193
+ sig { returns(T.nilable(String)) }
194
+ attr_reader :transaction_id
195
+ end
196
+ class AfterpayClearpay < Stripe::StripeObject
197
+ # The Afterpay order ID associated with this payment intent.
198
+ sig { returns(T.nilable(String)) }
199
+ attr_reader :order_id
200
+ # Order identifier shown to the merchant in Afterpay’s online portal.
201
+ sig { returns(T.nilable(String)) }
202
+ attr_reader :reference
203
+ end
204
+ class Alipay < Stripe::StripeObject
205
+ # Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
206
+ sig { returns(String) }
207
+ attr_reader :buyer_id
208
+ # Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
209
+ sig { returns(T.nilable(String)) }
210
+ attr_reader :fingerprint
211
+ # Transaction ID of this particular Alipay transaction.
212
+ sig { returns(T.nilable(String)) }
213
+ attr_reader :transaction_id
214
+ end
215
+ class Alma < Stripe::StripeObject; end
216
+ class AmazonPay < Stripe::StripeObject
217
+ class Funding < Stripe::StripeObject
218
+ class Card < Stripe::StripeObject
219
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
220
+ sig { returns(T.nilable(String)) }
221
+ attr_reader :brand
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.
223
+ sig { returns(T.nilable(String)) }
224
+ attr_reader :country
225
+ # Two-digit number representing the card's expiration month.
226
+ sig { returns(T.nilable(Integer)) }
227
+ attr_reader :exp_month
228
+ # Four-digit number representing the card's expiration year.
229
+ sig { returns(T.nilable(Integer)) }
230
+ attr_reader :exp_year
231
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
232
+ sig { returns(T.nilable(String)) }
233
+ attr_reader :funding
234
+ # The last four digits of the card.
235
+ sig { returns(T.nilable(String)) }
236
+ attr_reader :last4
237
+ end
238
+ # Attribute for field card
239
+ sig { returns(Card) }
240
+ attr_reader :card
241
+ # funding type of the underlying payment method.
242
+ sig { returns(T.nilable(String)) }
243
+ attr_reader :type
244
+ end
245
+ # Attribute for field funding
246
+ sig { returns(Funding) }
247
+ attr_reader :funding
248
+ end
249
+ class AuBecsDebit < Stripe::StripeObject
250
+ # Bank-State-Branch number of the bank account.
251
+ sig { returns(T.nilable(String)) }
252
+ attr_reader :bsb_number
253
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
254
+ sig { returns(T.nilable(String)) }
255
+ attr_reader :fingerprint
256
+ # Last four digits of the bank account number.
257
+ sig { returns(T.nilable(String)) }
258
+ attr_reader :last4
259
+ # ID of the mandate used to make this payment.
260
+ sig { returns(String) }
261
+ attr_reader :mandate
262
+ end
263
+ class BacsDebit < Stripe::StripeObject
264
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
265
+ sig { returns(T.nilable(String)) }
266
+ attr_reader :fingerprint
267
+ # Last four digits of the bank account number.
268
+ sig { returns(T.nilable(String)) }
269
+ attr_reader :last4
270
+ # ID of the mandate used to make this payment.
271
+ sig { returns(T.nilable(String)) }
272
+ attr_reader :mandate
273
+ # Sort code of the bank account. (e.g., `10-20-30`)
274
+ sig { returns(T.nilable(String)) }
275
+ attr_reader :sort_code
276
+ end
277
+ class Bancontact < Stripe::StripeObject
278
+ # Bank code of bank associated with the bank account.
279
+ sig { returns(T.nilable(String)) }
280
+ attr_reader :bank_code
281
+ # Name of the bank associated with the bank account.
282
+ sig { returns(T.nilable(String)) }
283
+ attr_reader :bank_name
284
+ # Bank Identifier Code of the bank associated with the bank account.
285
+ sig { returns(T.nilable(String)) }
286
+ attr_reader :bic
287
+ # The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
288
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
289
+ attr_reader :generated_sepa_debit
290
+ # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
291
+ sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
292
+ attr_reader :generated_sepa_debit_mandate
293
+ # Last four characters of the IBAN.
294
+ sig { returns(T.nilable(String)) }
295
+ attr_reader :iban_last4
296
+ # Preferred language of the Bancontact authorization page that the customer is redirected to.
297
+ # Can be one of `en`, `de`, `fr`, or `nl`
298
+ sig { returns(T.nilable(String)) }
299
+ attr_reader :preferred_language
300
+ # Owner's verified full name. Values are verified or provided by Bancontact directly
301
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
302
+ sig { returns(T.nilable(String)) }
303
+ attr_reader :verified_name
304
+ end
305
+ class Blik < Stripe::StripeObject
306
+ # A unique and immutable identifier assigned by BLIK to every buyer.
307
+ sig { returns(T.nilable(String)) }
308
+ attr_reader :buyer_id
309
+ end
310
+ class Boleto < Stripe::StripeObject
311
+ # The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
312
+ sig { returns(String) }
313
+ attr_reader :tax_id
314
+ end
315
+ class Card < Stripe::StripeObject
316
+ class Checks < Stripe::StripeObject
317
+ # If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
318
+ sig { returns(T.nilable(String)) }
319
+ attr_reader :address_line1_check
320
+ # If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
321
+ sig { returns(T.nilable(String)) }
322
+ attr_reader :address_postal_code_check
323
+ # If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
324
+ sig { returns(T.nilable(String)) }
325
+ attr_reader :cvc_check
326
+ end
327
+ class DecrementalAuthorization < Stripe::StripeObject
328
+ # Indicates whether or not the decremental authorization feature is supported.
329
+ sig { returns(String) }
330
+ attr_reader :status
331
+ end
332
+ class ExtendedAuthorization < Stripe::StripeObject
333
+ # Indicates whether or not the capture window is extended beyond the standard authorization.
334
+ sig { returns(String) }
335
+ attr_reader :status
336
+ end
337
+ class IncrementalAuthorization < Stripe::StripeObject
338
+ # Indicates whether or not the incremental authorization feature is supported.
339
+ sig { returns(String) }
340
+ attr_reader :status
341
+ end
342
+ class Installments < Stripe::StripeObject
343
+ class Plan < Stripe::StripeObject
344
+ # For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
345
+ sig { returns(T.nilable(Integer)) }
346
+ attr_reader :count
347
+ # For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
348
+ # One of `month`.
349
+ sig { returns(T.nilable(String)) }
350
+ attr_reader :interval
351
+ # Type of installment plan, one of `fixed_count`.
352
+ sig { returns(String) }
353
+ attr_reader :type
354
+ end
355
+ # Installment plan selected for the payment.
356
+ sig { returns(T.nilable(Plan)) }
357
+ attr_reader :plan
358
+ end
359
+ class Multicapture < Stripe::StripeObject
360
+ # Indicates whether or not multiple captures are supported.
361
+ sig { returns(String) }
362
+ attr_reader :status
363
+ end
364
+ class NetworkToken < Stripe::StripeObject
365
+ # Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.
366
+ sig { returns(T::Boolean) }
367
+ attr_reader :used
368
+ end
369
+ class Overcapture < Stripe::StripeObject
370
+ # The maximum amount that can be captured.
371
+ sig { returns(Integer) }
372
+ attr_reader :maximum_amount_capturable
373
+ # Indicates whether or not the authorized amount can be over-captured.
374
+ sig { returns(String) }
375
+ attr_reader :status
376
+ end
377
+ class PartialAuthorization < Stripe::StripeObject
378
+ # Indicates whether the transaction requested for partial authorization feature and the authorization outcome.
379
+ sig { returns(String) }
380
+ attr_reader :status
381
+ end
382
+ class ThreeDSecure < Stripe::StripeObject
383
+ # For authenticated transactions: how the customer was authenticated by
384
+ # the issuing bank.
385
+ sig { returns(T.nilable(String)) }
386
+ attr_reader :authentication_flow
387
+ # The Electronic Commerce Indicator (ECI). A protocol-level field
388
+ # indicating what degree of authentication was performed.
389
+ sig { returns(T.nilable(String)) }
390
+ attr_reader :electronic_commerce_indicator
391
+ # The exemption requested via 3DS and accepted by the issuer at authentication time.
392
+ sig { returns(T.nilable(String)) }
393
+ attr_reader :exemption_indicator
394
+ # Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on
395
+ # the outcome of Stripe's internal risk assessment.
396
+ sig { returns(T::Boolean) }
397
+ attr_reader :exemption_indicator_applied
398
+ # Indicates the outcome of 3D Secure authentication.
399
+ sig { returns(T.nilable(String)) }
400
+ attr_reader :result
401
+ # Additional information about why 3D Secure succeeded or failed based
402
+ # on the `result`.
403
+ sig { returns(T.nilable(String)) }
404
+ attr_reader :result_reason
405
+ # The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
406
+ # (dsTransId) for this payment.
407
+ sig { returns(T.nilable(String)) }
408
+ attr_reader :transaction_id
409
+ # The version of 3D Secure that was used.
410
+ sig { returns(T.nilable(String)) }
411
+ attr_reader :version
412
+ end
413
+ class Wallet < Stripe::StripeObject
414
+ class AmexExpressCheckout < Stripe::StripeObject; end
415
+ class ApplePay < Stripe::StripeObject; end
416
+ class GooglePay < Stripe::StripeObject; end
417
+ class Link < Stripe::StripeObject; end
418
+ class Masterpass < Stripe::StripeObject
419
+ class BillingAddress < Stripe::StripeObject
420
+ # City, district, suburb, town, or village.
421
+ sig { returns(T.nilable(String)) }
422
+ attr_reader :city
423
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
424
+ sig { returns(T.nilable(String)) }
425
+ attr_reader :country
426
+ # Address line 1 (e.g., street, PO Box, or company name).
427
+ sig { returns(T.nilable(String)) }
428
+ attr_reader :line1
429
+ # Address line 2 (e.g., apartment, suite, unit, or building).
430
+ sig { returns(T.nilable(String)) }
431
+ attr_reader :line2
432
+ # ZIP or postal code.
433
+ sig { returns(T.nilable(String)) }
434
+ attr_reader :postal_code
435
+ # State, county, province, or region.
436
+ sig { returns(T.nilable(String)) }
437
+ attr_reader :state
438
+ end
439
+ class ShippingAddress < Stripe::StripeObject
440
+ # City, district, suburb, town, or village.
441
+ sig { returns(T.nilable(String)) }
442
+ attr_reader :city
443
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
444
+ sig { returns(T.nilable(String)) }
445
+ attr_reader :country
446
+ # Address line 1 (e.g., street, PO Box, or company name).
447
+ sig { returns(T.nilable(String)) }
448
+ attr_reader :line1
449
+ # Address line 2 (e.g., apartment, suite, unit, or building).
450
+ sig { returns(T.nilable(String)) }
451
+ attr_reader :line2
452
+ # ZIP or postal code.
453
+ sig { returns(T.nilable(String)) }
454
+ attr_reader :postal_code
455
+ # State, county, province, or region.
456
+ sig { returns(T.nilable(String)) }
457
+ attr_reader :state
458
+ end
459
+ # Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
460
+ sig { returns(T.nilable(BillingAddress)) }
461
+ attr_reader :billing_address
462
+ # Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
463
+ sig { returns(T.nilable(String)) }
464
+ attr_reader :email
465
+ # Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
466
+ sig { returns(T.nilable(String)) }
467
+ attr_reader :name
468
+ # Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
469
+ sig { returns(T.nilable(ShippingAddress)) }
470
+ attr_reader :shipping_address
471
+ end
472
+ class SamsungPay < Stripe::StripeObject; end
473
+ class VisaCheckout < Stripe::StripeObject
474
+ class BillingAddress < Stripe::StripeObject
475
+ # City, district, suburb, town, or village.
476
+ sig { returns(T.nilable(String)) }
477
+ attr_reader :city
478
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
479
+ sig { returns(T.nilable(String)) }
480
+ attr_reader :country
481
+ # Address line 1 (e.g., street, PO Box, or company name).
482
+ sig { returns(T.nilable(String)) }
483
+ attr_reader :line1
484
+ # Address line 2 (e.g., apartment, suite, unit, or building).
485
+ sig { returns(T.nilable(String)) }
486
+ attr_reader :line2
487
+ # ZIP or postal code.
488
+ sig { returns(T.nilable(String)) }
489
+ attr_reader :postal_code
490
+ # State, county, province, or region.
491
+ sig { returns(T.nilable(String)) }
492
+ attr_reader :state
493
+ end
494
+ class ShippingAddress < Stripe::StripeObject
495
+ # City, district, suburb, town, or village.
496
+ sig { returns(T.nilable(String)) }
497
+ attr_reader :city
498
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
499
+ sig { returns(T.nilable(String)) }
500
+ attr_reader :country
501
+ # Address line 1 (e.g., street, PO Box, or company name).
502
+ sig { returns(T.nilable(String)) }
503
+ attr_reader :line1
504
+ # Address line 2 (e.g., apartment, suite, unit, or building).
505
+ sig { returns(T.nilable(String)) }
506
+ attr_reader :line2
507
+ # ZIP or postal code.
508
+ sig { returns(T.nilable(String)) }
509
+ attr_reader :postal_code
510
+ # State, county, province, or region.
511
+ sig { returns(T.nilable(String)) }
512
+ attr_reader :state
513
+ end
514
+ # Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
515
+ sig { returns(T.nilable(BillingAddress)) }
516
+ attr_reader :billing_address
517
+ # Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
518
+ sig { returns(T.nilable(String)) }
519
+ attr_reader :email
520
+ # Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
521
+ sig { returns(T.nilable(String)) }
522
+ attr_reader :name
523
+ # Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
524
+ sig { returns(T.nilable(ShippingAddress)) }
525
+ attr_reader :shipping_address
526
+ end
527
+ # Attribute for field amex_express_checkout
528
+ sig { returns(AmexExpressCheckout) }
529
+ attr_reader :amex_express_checkout
530
+ # Attribute for field apple_pay
531
+ sig { returns(ApplePay) }
532
+ attr_reader :apple_pay
533
+ # (For tokenized numbers only.) The last four digits of the device account number.
534
+ sig { returns(T.nilable(String)) }
535
+ attr_reader :dynamic_last4
536
+ # Attribute for field google_pay
537
+ sig { returns(GooglePay) }
538
+ attr_reader :google_pay
539
+ # Attribute for field link
540
+ sig { returns(Link) }
541
+ attr_reader :link
542
+ # Attribute for field masterpass
543
+ sig { returns(Masterpass) }
544
+ attr_reader :masterpass
545
+ # Attribute for field samsung_pay
546
+ sig { returns(SamsungPay) }
547
+ attr_reader :samsung_pay
548
+ # The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
549
+ sig { returns(String) }
550
+ attr_reader :type
551
+ # Attribute for field visa_checkout
552
+ sig { returns(VisaCheckout) }
553
+ attr_reader :visa_checkout
554
+ end
555
+ # The authorized amount.
556
+ sig { returns(T.nilable(Integer)) }
557
+ attr_reader :amount_authorized
558
+ # The latest amount intended to be authorized by this charge.
559
+ sig { returns(T.nilable(Integer)) }
560
+ attr_reader :amount_requested
561
+ # Authorization code on the charge.
562
+ sig { returns(T.nilable(String)) }
563
+ attr_reader :authorization_code
564
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
565
+ sig { returns(T.nilable(String)) }
566
+ attr_reader :brand
567
+ # When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
568
+ sig { returns(Integer) }
569
+ attr_reader :capture_before
570
+ # Check results by Card networks on Card address and CVC at time of payment.
571
+ sig { returns(T.nilable(Checks)) }
572
+ attr_reader :checks
573
+ # 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.
574
+ sig { returns(T.nilable(String)) }
575
+ attr_reader :country
576
+ # Attribute for field decremental_authorization
577
+ sig { returns(DecrementalAuthorization) }
578
+ attr_reader :decremental_authorization
579
+ # 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.)
580
+ sig { returns(T.nilable(String)) }
581
+ attr_reader :description
582
+ # Two-digit number representing the card's expiration month.
583
+ sig { returns(Integer) }
584
+ attr_reader :exp_month
585
+ # Four-digit number representing the card's expiration year.
586
+ sig { returns(Integer) }
587
+ attr_reader :exp_year
588
+ # Attribute for field extended_authorization
589
+ sig { returns(ExtendedAuthorization) }
590
+ attr_reader :extended_authorization
591
+ # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
592
+ #
593
+ # *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
594
+ sig { returns(T.nilable(String)) }
595
+ attr_reader :fingerprint
596
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
597
+ sig { returns(T.nilable(String)) }
598
+ attr_reader :funding
599
+ # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
600
+ sig { returns(T.nilable(String)) }
601
+ attr_reader :iin
602
+ # Attribute for field incremental_authorization
603
+ sig { returns(IncrementalAuthorization) }
604
+ attr_reader :incremental_authorization
605
+ # Installment details for this payment (Mexico only).
606
+ #
607
+ # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
608
+ sig { returns(T.nilable(Installments)) }
609
+ attr_reader :installments
610
+ # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
611
+ sig { returns(T.nilable(String)) }
612
+ attr_reader :issuer
613
+ # The last four digits of the card.
614
+ sig { returns(T.nilable(String)) }
615
+ attr_reader :last4
616
+ # ID of the mandate used to make this payment or created by it.
617
+ sig { returns(T.nilable(String)) }
618
+ attr_reader :mandate
619
+ # True if this payment was marked as MOTO and out of scope for SCA.
620
+ sig { returns(T.nilable(T::Boolean)) }
621
+ attr_reader :moto
622
+ # Attribute for field multicapture
623
+ sig { returns(Multicapture) }
624
+ attr_reader :multicapture
625
+ # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
626
+ sig { returns(T.nilable(String)) }
627
+ attr_reader :network
628
+ # If this card has network token credentials, this contains the details of the network token credentials.
629
+ sig { returns(T.nilable(NetworkToken)) }
630
+ attr_reader :network_token
631
+ # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.
632
+ sig { returns(T.nilable(String)) }
633
+ attr_reader :network_transaction_id
634
+ # Attribute for field overcapture
635
+ sig { returns(Overcapture) }
636
+ attr_reader :overcapture
637
+ # Attribute for field partial_authorization
638
+ sig { returns(PartialAuthorization) }
639
+ attr_reader :partial_authorization
640
+ # Status of a card based on the card issuer.
641
+ sig { returns(T.nilable(String)) }
642
+ attr_reader :regulated_status
643
+ # Populated if this transaction used 3D Secure authentication.
644
+ sig { returns(T.nilable(ThreeDSecure)) }
645
+ attr_reader :three_d_secure
646
+ # If this Card is part of a card wallet, this contains the details of the card wallet.
647
+ sig { returns(T.nilable(Wallet)) }
648
+ attr_reader :wallet
649
+ end
650
+ class CardPresent < Stripe::StripeObject
651
+ class Offline < Stripe::StripeObject
652
+ # Time at which the payment was collected while offline
653
+ sig { returns(T.nilable(Integer)) }
654
+ attr_reader :stored_at
655
+ # The method used to process this payment method offline. Only deferred is allowed.
656
+ sig { returns(T.nilable(String)) }
657
+ attr_reader :type
658
+ end
659
+ class Receipt < Stripe::StripeObject
660
+ # The type of account being debited or credited
661
+ sig { returns(String) }
662
+ attr_reader :account_type
663
+ # EMV tag 9F26, cryptogram generated by the integrated circuit chip.
664
+ sig { returns(T.nilable(String)) }
665
+ attr_reader :application_cryptogram
666
+ # Mnenomic of the Application Identifier.
667
+ sig { returns(T.nilable(String)) }
668
+ attr_reader :application_preferred_name
669
+ # Identifier for this transaction.
670
+ sig { returns(T.nilable(String)) }
671
+ attr_reader :authorization_code
672
+ # EMV tag 8A. A code returned by the card issuer.
673
+ sig { returns(T.nilable(String)) }
674
+ attr_reader :authorization_response_code
675
+ # Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
676
+ sig { returns(T.nilable(String)) }
677
+ attr_reader :cardholder_verification_method
678
+ # EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
679
+ sig { returns(T.nilable(String)) }
680
+ attr_reader :dedicated_file_name
681
+ # The outcome of a series of EMV functions performed by the card reader.
682
+ sig { returns(T.nilable(String)) }
683
+ attr_reader :terminal_verification_results
684
+ # An indication of various EMV functions performed during the transaction.
685
+ sig { returns(T.nilable(String)) }
686
+ attr_reader :transaction_status_information
687
+ end
688
+ class Wallet < Stripe::StripeObject
689
+ # The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
690
+ sig { returns(String) }
691
+ attr_reader :type
692
+ end
693
+ # The authorized amount
694
+ sig { returns(T.nilable(Integer)) }
695
+ attr_reader :amount_authorized
696
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
697
+ sig { returns(T.nilable(String)) }
698
+ attr_reader :brand
699
+ # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
700
+ sig { returns(T.nilable(String)) }
701
+ attr_reader :brand_product
702
+ # When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
703
+ sig { returns(Integer) }
704
+ attr_reader :capture_before
705
+ # The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
706
+ sig { returns(T.nilable(String)) }
707
+ attr_reader :cardholder_name
708
+ # 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.
709
+ sig { returns(T.nilable(String)) }
710
+ attr_reader :country
711
+ # 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.)
712
+ sig { returns(T.nilable(String)) }
713
+ attr_reader :description
714
+ # Authorization response cryptogram.
715
+ sig { returns(T.nilable(String)) }
716
+ attr_reader :emv_auth_data
717
+ # Two-digit number representing the card's expiration month.
718
+ sig { returns(Integer) }
719
+ attr_reader :exp_month
720
+ # Four-digit number representing the card's expiration year.
721
+ sig { returns(Integer) }
722
+ attr_reader :exp_year
723
+ # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
724
+ #
725
+ # *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
726
+ sig { returns(T.nilable(String)) }
727
+ attr_reader :fingerprint
728
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
729
+ sig { returns(T.nilable(String)) }
730
+ attr_reader :funding
731
+ # ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
732
+ sig { returns(T.nilable(String)) }
733
+ attr_reader :generated_card
734
+ # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
735
+ sig { returns(T.nilable(String)) }
736
+ attr_reader :iin
737
+ # Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
738
+ sig { returns(T::Boolean) }
739
+ attr_reader :incremental_authorization_supported
740
+ # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
741
+ sig { returns(T.nilable(String)) }
742
+ attr_reader :issuer
743
+ # The last four digits of the card.
744
+ sig { returns(T.nilable(String)) }
745
+ attr_reader :last4
746
+ # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
747
+ sig { returns(T.nilable(String)) }
748
+ attr_reader :network
749
+ # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.
750
+ sig { returns(T.nilable(String)) }
751
+ attr_reader :network_transaction_id
752
+ # Details about payments collected offline.
753
+ sig { returns(T.nilable(Offline)) }
754
+ attr_reader :offline
755
+ # Defines whether the authorized amount can be over-captured or not
756
+ sig { returns(T::Boolean) }
757
+ attr_reader :overcapture_supported
758
+ # EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
759
+ sig { returns(T.nilable(T::Array[String])) }
760
+ attr_reader :preferred_locales
761
+ # How card details were read in this transaction.
762
+ sig { returns(T.nilable(String)) }
763
+ attr_reader :read_method
764
+ # A collection of fields required to be displayed on receipts. Only required for EMV transactions.
765
+ sig { returns(T.nilable(Receipt)) }
766
+ attr_reader :receipt
767
+ # Attribute for field wallet
768
+ sig { returns(Wallet) }
769
+ attr_reader :wallet
770
+ end
771
+ class Cashapp < Stripe::StripeObject
772
+ # A unique and immutable identifier assigned by Cash App to every buyer.
773
+ sig { returns(T.nilable(String)) }
774
+ attr_reader :buyer_id
775
+ # A public identifier for buyers using Cash App.
776
+ sig { returns(T.nilable(String)) }
777
+ attr_reader :cashtag
778
+ end
779
+ class CustomerBalance < Stripe::StripeObject; end
780
+ class Eps < Stripe::StripeObject
781
+ # The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
782
+ sig { returns(T.nilable(String)) }
783
+ attr_reader :bank
784
+ # Owner's verified full name. Values are verified or provided by EPS directly
785
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
786
+ # EPS rarely provides this information so the attribute is usually empty.
787
+ sig { returns(T.nilable(String)) }
788
+ attr_reader :verified_name
789
+ end
790
+ class Fpx < Stripe::StripeObject
791
+ # Account holder type, if provided. Can be one of `individual` or `company`.
792
+ sig { returns(T.nilable(String)) }
793
+ attr_reader :account_holder_type
794
+ # The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
795
+ sig { returns(String) }
796
+ attr_reader :bank
797
+ # Unique transaction id generated by FPX for every request from the merchant
798
+ sig { returns(T.nilable(String)) }
799
+ attr_reader :transaction_id
800
+ end
801
+ class Giropay < Stripe::StripeObject
802
+ # Bank code of bank associated with the bank account.
803
+ sig { returns(T.nilable(String)) }
804
+ attr_reader :bank_code
805
+ # Name of the bank associated with the bank account.
806
+ sig { returns(T.nilable(String)) }
807
+ attr_reader :bank_name
808
+ # Bank Identifier Code of the bank associated with the bank account.
809
+ sig { returns(T.nilable(String)) }
810
+ attr_reader :bic
811
+ # Owner's verified full name. Values are verified or provided by Giropay directly
812
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
813
+ # Giropay rarely provides this information so the attribute is usually empty.
814
+ sig { returns(T.nilable(String)) }
815
+ attr_reader :verified_name
816
+ end
817
+ class Gopay < Stripe::StripeObject; end
818
+ class Grabpay < Stripe::StripeObject
819
+ # Unique transaction id generated by GrabPay
820
+ sig { returns(T.nilable(String)) }
821
+ attr_reader :transaction_id
822
+ end
823
+ class IdBankTransfer < Stripe::StripeObject
824
+ # Account number of the bank account to transfer funds to.
825
+ sig { returns(String) }
826
+ attr_reader :account_number
827
+ # Bank where the account is located.
828
+ sig { returns(String) }
829
+ attr_reader :bank
830
+ # Local bank code of the bank.
831
+ sig { returns(String) }
832
+ attr_reader :bank_code
833
+ # Name of the bank associated with the bank account.
834
+ sig { returns(String) }
835
+ attr_reader :bank_name
836
+ # Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
837
+ sig { returns(String) }
838
+ attr_reader :display_name
839
+ end
840
+ class Ideal < Stripe::StripeObject
841
+ # 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`.
842
+ sig { returns(T.nilable(String)) }
843
+ attr_reader :bank
844
+ # The Bank Identifier Code of the customer's bank.
845
+ sig { returns(T.nilable(String)) }
846
+ attr_reader :bic
847
+ # The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
848
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
849
+ attr_reader :generated_sepa_debit
850
+ # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
851
+ sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
852
+ attr_reader :generated_sepa_debit_mandate
853
+ # Last four characters of the IBAN.
854
+ sig { returns(T.nilable(String)) }
855
+ attr_reader :iban_last4
856
+ # Owner's verified full name. Values are verified or provided by iDEAL directly
857
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
858
+ sig { returns(T.nilable(String)) }
859
+ attr_reader :verified_name
860
+ end
861
+ class InteracPresent < Stripe::StripeObject
862
+ class Receipt < Stripe::StripeObject
863
+ # The type of account being debited or credited
864
+ sig { returns(String) }
865
+ attr_reader :account_type
866
+ # EMV tag 9F26, cryptogram generated by the integrated circuit chip.
867
+ sig { returns(T.nilable(String)) }
868
+ attr_reader :application_cryptogram
869
+ # Mnenomic of the Application Identifier.
870
+ sig { returns(T.nilable(String)) }
871
+ attr_reader :application_preferred_name
872
+ # Identifier for this transaction.
873
+ sig { returns(T.nilable(String)) }
874
+ attr_reader :authorization_code
875
+ # EMV tag 8A. A code returned by the card issuer.
876
+ sig { returns(T.nilable(String)) }
877
+ attr_reader :authorization_response_code
878
+ # Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
879
+ sig { returns(T.nilable(String)) }
880
+ attr_reader :cardholder_verification_method
881
+ # EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
882
+ sig { returns(T.nilable(String)) }
883
+ attr_reader :dedicated_file_name
884
+ # The outcome of a series of EMV functions performed by the card reader.
885
+ sig { returns(T.nilable(String)) }
886
+ attr_reader :terminal_verification_results
887
+ # An indication of various EMV functions performed during the transaction.
888
+ sig { returns(T.nilable(String)) }
889
+ attr_reader :transaction_status_information
890
+ end
891
+ # Card brand. Can be `interac`, `mastercard` or `visa`.
892
+ sig { returns(T.nilable(String)) }
893
+ attr_reader :brand
894
+ # The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
895
+ sig { returns(T.nilable(String)) }
896
+ attr_reader :cardholder_name
897
+ # 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.
898
+ sig { returns(T.nilable(String)) }
899
+ attr_reader :country
900
+ # 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.)
901
+ sig { returns(T.nilable(String)) }
902
+ attr_reader :description
903
+ # Authorization response cryptogram.
904
+ sig { returns(T.nilable(String)) }
905
+ attr_reader :emv_auth_data
906
+ # Two-digit number representing the card's expiration month.
907
+ sig { returns(Integer) }
908
+ attr_reader :exp_month
909
+ # Four-digit number representing the card's expiration year.
910
+ sig { returns(Integer) }
911
+ attr_reader :exp_year
912
+ # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
913
+ #
914
+ # *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
915
+ sig { returns(T.nilable(String)) }
916
+ attr_reader :fingerprint
917
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
918
+ sig { returns(T.nilable(String)) }
919
+ attr_reader :funding
920
+ # ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
921
+ sig { returns(T.nilable(String)) }
922
+ attr_reader :generated_card
923
+ # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
924
+ sig { returns(T.nilable(String)) }
925
+ attr_reader :iin
926
+ # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
927
+ sig { returns(T.nilable(String)) }
928
+ attr_reader :issuer
929
+ # The last four digits of the card.
930
+ sig { returns(T.nilable(String)) }
931
+ attr_reader :last4
932
+ # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
933
+ sig { returns(T.nilable(String)) }
934
+ attr_reader :network
935
+ # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.
936
+ sig { returns(T.nilable(String)) }
937
+ attr_reader :network_transaction_id
938
+ # EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
939
+ sig { returns(T.nilable(T::Array[String])) }
940
+ attr_reader :preferred_locales
941
+ # How card details were read in this transaction.
942
+ sig { returns(T.nilable(String)) }
943
+ attr_reader :read_method
944
+ # A collection of fields required to be displayed on receipts. Only required for EMV transactions.
945
+ sig { returns(T.nilable(Receipt)) }
946
+ attr_reader :receipt
947
+ end
948
+ class KakaoPay < Stripe::StripeObject
949
+ # A unique identifier for the buyer as determined by the local payment processor.
950
+ sig { returns(T.nilable(String)) }
951
+ attr_reader :buyer_id
952
+ end
953
+ class Klarna < Stripe::StripeObject
954
+ class PayerDetails < Stripe::StripeObject
955
+ class Address < Stripe::StripeObject
956
+ # The payer address country
957
+ sig { returns(T.nilable(String)) }
958
+ attr_reader :country
959
+ end
960
+ # The payer's address
961
+ sig { returns(T.nilable(Address)) }
962
+ attr_reader :address
963
+ end
964
+ # The payer details for this transaction.
965
+ sig { returns(T.nilable(PayerDetails)) }
966
+ attr_reader :payer_details
967
+ # The Klarna payment method used for this transaction.
968
+ # Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`
969
+ sig { returns(T.nilable(String)) }
970
+ attr_reader :payment_method_category
971
+ # Preferred language of the Klarna authorization page that the customer is redirected to.
972
+ # Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`
973
+ sig { returns(T.nilable(String)) }
974
+ attr_reader :preferred_locale
975
+ end
976
+ class Konbini < Stripe::StripeObject
977
+ class Store < Stripe::StripeObject
978
+ # The name of the convenience store chain where the payment was completed.
979
+ sig { returns(T.nilable(String)) }
980
+ attr_reader :chain
981
+ end
982
+ # If the payment succeeded, this contains the details of the convenience store where the payment was completed.
983
+ sig { returns(T.nilable(Store)) }
984
+ attr_reader :store
985
+ end
986
+ class KrCard < Stripe::StripeObject
987
+ # The local credit or debit card brand.
988
+ sig { returns(T.nilable(String)) }
989
+ attr_reader :brand
990
+ # A unique identifier for the buyer as determined by the local payment processor.
991
+ sig { returns(T.nilable(String)) }
992
+ attr_reader :buyer_id
993
+ # The last four digits of the card. This may not be present for American Express cards.
994
+ sig { returns(T.nilable(String)) }
995
+ attr_reader :last4
996
+ end
997
+ class Link < Stripe::StripeObject
998
+ # Two-letter ISO code representing the funding source country beneath the Link payment.
999
+ # You could use this attribute to get a sense of international fees.
1000
+ sig { returns(T.nilable(String)) }
1001
+ attr_reader :country
1002
+ end
1003
+ class MbWay < Stripe::StripeObject; end
1004
+ class Mobilepay < Stripe::StripeObject
1005
+ class Card < Stripe::StripeObject
1006
+ # Brand of the card used in the transaction
1007
+ sig { returns(T.nilable(String)) }
1008
+ attr_reader :brand
1009
+ # Two-letter ISO code representing the country of the card
1010
+ sig { returns(T.nilable(String)) }
1011
+ attr_reader :country
1012
+ # Two digit number representing the card's expiration month
1013
+ sig { returns(T.nilable(Integer)) }
1014
+ attr_reader :exp_month
1015
+ # Two digit number representing the card's expiration year
1016
+ sig { returns(T.nilable(Integer)) }
1017
+ attr_reader :exp_year
1018
+ # The last 4 digits of the card
1019
+ sig { returns(T.nilable(String)) }
1020
+ attr_reader :last4
1021
+ end
1022
+ # Internal card details
1023
+ sig { returns(T.nilable(Card)) }
1024
+ attr_reader :card
1025
+ end
1026
+ class Multibanco < Stripe::StripeObject
1027
+ # Entity number associated with this Multibanco payment.
1028
+ sig { returns(T.nilable(String)) }
1029
+ attr_reader :entity
1030
+ # Reference number associated with this Multibanco payment.
1031
+ sig { returns(T.nilable(String)) }
1032
+ attr_reader :reference
1033
+ end
1034
+ class NaverPay < Stripe::StripeObject
1035
+ # A unique identifier for the buyer as determined by the local payment processor.
1036
+ sig { returns(T.nilable(String)) }
1037
+ attr_reader :buyer_id
1038
+ end
1039
+ class Oxxo < Stripe::StripeObject
1040
+ # OXXO reference number
1041
+ sig { returns(T.nilable(String)) }
1042
+ attr_reader :number
1043
+ end
1044
+ class P24 < Stripe::StripeObject
1045
+ # The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.
1046
+ sig { returns(T.nilable(String)) }
1047
+ attr_reader :bank
1048
+ # Unique reference for this Przelewy24 payment.
1049
+ sig { returns(T.nilable(String)) }
1050
+ attr_reader :reference
1051
+ # Owner's verified full name. Values are verified or provided by Przelewy24 directly
1052
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1053
+ # Przelewy24 rarely provides this information so the attribute is usually empty.
1054
+ sig { returns(T.nilable(String)) }
1055
+ attr_reader :verified_name
1056
+ end
1057
+ class Payco < Stripe::StripeObject
1058
+ # A unique identifier for the buyer as determined by the local payment processor.
1059
+ sig { returns(T.nilable(String)) }
1060
+ attr_reader :buyer_id
1061
+ end
1062
+ class Paynow < Stripe::StripeObject
1063
+ # Reference number associated with this PayNow payment
1064
+ sig { returns(T.nilable(String)) }
1065
+ attr_reader :reference
1066
+ end
1067
+ class Paypal < Stripe::StripeObject
1068
+ class SellerProtection < Stripe::StripeObject
1069
+ # An array of conditions that are covered for the transaction, if applicable.
1070
+ sig { returns(T.nilable(T::Array[String])) }
1071
+ attr_reader :dispute_categories
1072
+ # Indicates whether the transaction is eligible for PayPal's seller protection.
1073
+ sig { returns(String) }
1074
+ attr_reader :status
1075
+ end
1076
+ class Shipping < Stripe::StripeObject
1077
+ # City, district, suburb, town, or village.
1078
+ sig { returns(T.nilable(String)) }
1079
+ attr_reader :city
1080
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1081
+ sig { returns(T.nilable(String)) }
1082
+ attr_reader :country
1083
+ # Address line 1 (e.g., street, PO Box, or company name).
1084
+ sig { returns(T.nilable(String)) }
1085
+ attr_reader :line1
1086
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1087
+ sig { returns(T.nilable(String)) }
1088
+ attr_reader :line2
1089
+ # ZIP or postal code.
1090
+ sig { returns(T.nilable(String)) }
1091
+ attr_reader :postal_code
1092
+ # State, county, province, or region.
1093
+ sig { returns(T.nilable(String)) }
1094
+ attr_reader :state
1095
+ end
1096
+ class VerifiedAddress < Stripe::StripeObject
1097
+ # City, district, suburb, town, or village.
1098
+ sig { returns(T.nilable(String)) }
1099
+ attr_reader :city
1100
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1101
+ sig { returns(T.nilable(String)) }
1102
+ attr_reader :country
1103
+ # Address line 1 (e.g., street, PO Box, or company name).
1104
+ sig { returns(T.nilable(String)) }
1105
+ attr_reader :line1
1106
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1107
+ sig { returns(T.nilable(String)) }
1108
+ attr_reader :line2
1109
+ # ZIP or postal code.
1110
+ sig { returns(T.nilable(String)) }
1111
+ attr_reader :postal_code
1112
+ # State, county, province, or region.
1113
+ sig { returns(T.nilable(String)) }
1114
+ attr_reader :state
1115
+ end
1116
+ # 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.
1117
+ sig { returns(T.nilable(String)) }
1118
+ attr_reader :country
1119
+ # Owner's email. Values are provided by PayPal directly
1120
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1121
+ sig { returns(T.nilable(String)) }
1122
+ attr_reader :payer_email
1123
+ # PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
1124
+ sig { returns(T.nilable(String)) }
1125
+ attr_reader :payer_id
1126
+ # Owner's full name. Values provided by PayPal directly
1127
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1128
+ sig { returns(T.nilable(String)) }
1129
+ attr_reader :payer_name
1130
+ # The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
1131
+ sig { returns(T.nilable(SellerProtection)) }
1132
+ attr_reader :seller_protection
1133
+ # The shipping address for the customer, as supplied by the merchant at the point of payment
1134
+ # execution. This shipping address will not be updated if the merchant updates the shipping
1135
+ # address on the PaymentIntent after the PaymentIntent was successfully confirmed.
1136
+ sig { returns(T.nilable(Shipping)) }
1137
+ attr_reader :shipping
1138
+ # A unique ID generated by PayPal for this transaction.
1139
+ sig { returns(T.nilable(String)) }
1140
+ attr_reader :transaction_id
1141
+ # The shipping address for the customer, as supplied by the merchant at the point of payment
1142
+ # execution. This shipping address will not be updated if the merchant updates the shipping
1143
+ # address on the PaymentIntent after the PaymentIntent was successfully confirmed.
1144
+ sig { returns(T.nilable(VerifiedAddress)) }
1145
+ attr_reader :verified_address
1146
+ # Owner's verified email. Values are verified or provided by PayPal directly
1147
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1148
+ sig { returns(T.nilable(String)) }
1149
+ attr_reader :verified_email
1150
+ # Owner's verified full name. 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_name
1154
+ end
1155
+ class Payto < Stripe::StripeObject
1156
+ # Bank-State-Branch number of the bank account.
1157
+ sig { returns(T.nilable(String)) }
1158
+ attr_reader :bsb_number
1159
+ # Last four digits of the bank account number.
1160
+ sig { returns(T.nilable(String)) }
1161
+ attr_reader :last4
1162
+ # ID of the mandate used to make this payment.
1163
+ sig { returns(String) }
1164
+ attr_reader :mandate
1165
+ # The PayID alias for the bank account.
1166
+ sig { returns(T.nilable(String)) }
1167
+ attr_reader :pay_id
1168
+ end
1169
+ class Pix < Stripe::StripeObject
1170
+ # Unique transaction id generated by BCB
1171
+ sig { returns(T.nilable(String)) }
1172
+ attr_reader :bank_transaction_id
1173
+ end
1174
+ class Promptpay < Stripe::StripeObject
1175
+ # Bill reference generated by PromptPay
1176
+ sig { returns(T.nilable(String)) }
1177
+ attr_reader :reference
1178
+ end
1179
+ class Qris < Stripe::StripeObject; end
1180
+ class Rechnung < Stripe::StripeObject; end
1181
+ class RevolutPay < Stripe::StripeObject
1182
+ class Funding < Stripe::StripeObject
1183
+ class Card < Stripe::StripeObject
1184
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
1185
+ sig { returns(T.nilable(String)) }
1186
+ attr_reader :brand
1187
+ # 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.
1188
+ sig { returns(T.nilable(String)) }
1189
+ attr_reader :country
1190
+ # Two-digit number representing the card's expiration month.
1191
+ sig { returns(T.nilable(Integer)) }
1192
+ attr_reader :exp_month
1193
+ # Four-digit number representing the card's expiration year.
1194
+ sig { returns(T.nilable(Integer)) }
1195
+ attr_reader :exp_year
1196
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
1197
+ sig { returns(T.nilable(String)) }
1198
+ attr_reader :funding
1199
+ # The last four digits of the card.
1200
+ sig { returns(T.nilable(String)) }
1201
+ attr_reader :last4
1202
+ end
1203
+ # Attribute for field card
1204
+ sig { returns(Card) }
1205
+ attr_reader :card
1206
+ # funding type of the underlying payment method.
1207
+ sig { returns(T.nilable(String)) }
1208
+ attr_reader :type
1209
+ end
1210
+ # Attribute for field funding
1211
+ sig { returns(Funding) }
1212
+ attr_reader :funding
1213
+ end
1214
+ class SamsungPay < Stripe::StripeObject
1215
+ # A unique identifier for the buyer as determined by the local payment processor.
1216
+ sig { returns(T.nilable(String)) }
1217
+ attr_reader :buyer_id
1218
+ end
1219
+ class SepaCreditTransfer < Stripe::StripeObject
1220
+ # Name of the bank associated with the bank account.
1221
+ sig { returns(T.nilable(String)) }
1222
+ attr_reader :bank_name
1223
+ # Bank Identifier Code of the bank associated with the bank account.
1224
+ sig { returns(T.nilable(String)) }
1225
+ attr_reader :bic
1226
+ # IBAN of the bank account to transfer funds to.
1227
+ sig { returns(T.nilable(String)) }
1228
+ attr_reader :iban
1229
+ end
1230
+ class SepaDebit < Stripe::StripeObject
1231
+ # Bank code of bank associated with the bank account.
1232
+ sig { returns(T.nilable(String)) }
1233
+ attr_reader :bank_code
1234
+ # Branch code of bank associated with the bank account.
1235
+ sig { returns(T.nilable(String)) }
1236
+ attr_reader :branch_code
1237
+ # Two-letter ISO code representing the country the bank account is located in.
1238
+ sig { returns(T.nilable(String)) }
1239
+ attr_reader :country
1240
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
1241
+ sig { returns(T.nilable(String)) }
1242
+ attr_reader :fingerprint
1243
+ # Last four characters of the IBAN.
1244
+ sig { returns(T.nilable(String)) }
1245
+ attr_reader :last4
1246
+ # Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).
1247
+ sig { returns(T.nilable(String)) }
1248
+ attr_reader :mandate
1249
+ end
1250
+ class Shopeepay < Stripe::StripeObject; end
1251
+ class Sofort < Stripe::StripeObject
1252
+ # Bank code of bank associated with the bank account.
1253
+ sig { returns(T.nilable(String)) }
1254
+ attr_reader :bank_code
1255
+ # Name of the bank associated with the bank account.
1256
+ sig { returns(T.nilable(String)) }
1257
+ attr_reader :bank_name
1258
+ # Bank Identifier Code of the bank associated with the bank account.
1259
+ sig { returns(T.nilable(String)) }
1260
+ attr_reader :bic
1261
+ # Two-letter ISO code representing the country the bank account is located in.
1262
+ sig { returns(T.nilable(String)) }
1263
+ attr_reader :country
1264
+ # The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
1265
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
1266
+ attr_reader :generated_sepa_debit
1267
+ # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
1268
+ sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
1269
+ attr_reader :generated_sepa_debit_mandate
1270
+ # Last four characters of the IBAN.
1271
+ sig { returns(T.nilable(String)) }
1272
+ attr_reader :iban_last4
1273
+ # Preferred language of the SOFORT authorization page that the customer is redirected to.
1274
+ # Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`
1275
+ sig { returns(T.nilable(String)) }
1276
+ attr_reader :preferred_language
1277
+ # Owner's verified full name. Values are verified or provided by SOFORT directly
1278
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1279
+ sig { returns(T.nilable(String)) }
1280
+ attr_reader :verified_name
1281
+ end
1282
+ class StripeAccount < Stripe::StripeObject; end
1283
+ class Swish < Stripe::StripeObject
1284
+ # Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer
1285
+ sig { returns(T.nilable(String)) }
1286
+ attr_reader :fingerprint
1287
+ # Payer bank reference number for the payment
1288
+ sig { returns(T.nilable(String)) }
1289
+ attr_reader :payment_reference
1290
+ # The last four digits of the Swish account phone number
1291
+ sig { returns(T.nilable(String)) }
1292
+ attr_reader :verified_phone_last4
1293
+ end
1294
+ class Twint < Stripe::StripeObject; end
1295
+ class UsBankAccount < Stripe::StripeObject
1296
+ # Account holder type: individual or company.
1297
+ sig { returns(T.nilable(String)) }
1298
+ attr_reader :account_holder_type
1299
+ # Account type: checkings or savings. Defaults to checking if omitted.
1300
+ sig { returns(T.nilable(String)) }
1301
+ attr_reader :account_type
1302
+ # Name of the bank associated with the bank account.
1303
+ sig { returns(T.nilable(String)) }
1304
+ attr_reader :bank_name
1305
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
1306
+ sig { returns(T.nilable(String)) }
1307
+ attr_reader :fingerprint
1308
+ # Last four digits of the bank account number.
1309
+ sig { returns(T.nilable(String)) }
1310
+ attr_reader :last4
1311
+ # ID of the mandate used to make this payment.
1312
+ sig { returns(T.any(String, Stripe::Mandate)) }
1313
+ attr_reader :mandate
1314
+ # Reference number to locate ACH payments with customer's bank.
1315
+ sig { returns(T.nilable(String)) }
1316
+ attr_reader :payment_reference
1317
+ # Routing number of the bank account.
1318
+ sig { returns(T.nilable(String)) }
1319
+ attr_reader :routing_number
1320
+ end
1321
+ class Wechat < Stripe::StripeObject; end
1322
+ class WechatPay < Stripe::StripeObject
1323
+ # Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
1324
+ sig { returns(T.nilable(String)) }
1325
+ attr_reader :fingerprint
1326
+ # Transaction ID of this particular WeChat Pay transaction.
1327
+ sig { returns(T.nilable(String)) }
1328
+ attr_reader :transaction_id
1329
+ end
1330
+ class Zip < Stripe::StripeObject; end
1331
+ # Attribute for field ach_credit_transfer
1332
+ sig { returns(AchCreditTransfer) }
1333
+ attr_reader :ach_credit_transfer
1334
+ # Attribute for field ach_debit
1335
+ sig { returns(AchDebit) }
1336
+ attr_reader :ach_debit
1337
+ # Attribute for field acss_debit
1338
+ sig { returns(AcssDebit) }
1339
+ attr_reader :acss_debit
1340
+ # Attribute for field affirm
1341
+ sig { returns(Affirm) }
1342
+ attr_reader :affirm
1343
+ # Attribute for field afterpay_clearpay
1344
+ sig { returns(AfterpayClearpay) }
1345
+ attr_reader :afterpay_clearpay
1346
+ # Attribute for field alipay
1347
+ sig { returns(Alipay) }
1348
+ attr_reader :alipay
1349
+ # Attribute for field alma
1350
+ sig { returns(Alma) }
1351
+ attr_reader :alma
1352
+ # Attribute for field amazon_pay
1353
+ sig { returns(AmazonPay) }
1354
+ attr_reader :amazon_pay
1355
+ # Attribute for field au_becs_debit
1356
+ sig { returns(AuBecsDebit) }
1357
+ attr_reader :au_becs_debit
1358
+ # Attribute for field bacs_debit
1359
+ sig { returns(BacsDebit) }
1360
+ attr_reader :bacs_debit
1361
+ # Attribute for field bancontact
1362
+ sig { returns(Bancontact) }
1363
+ attr_reader :bancontact
1364
+ # Attribute for field blik
1365
+ sig { returns(Blik) }
1366
+ attr_reader :blik
1367
+ # Attribute for field boleto
1368
+ sig { returns(Boleto) }
1369
+ attr_reader :boleto
1370
+ # Attribute for field card
1371
+ sig { returns(Card) }
1372
+ attr_reader :card
1373
+ # Attribute for field card_present
1374
+ sig { returns(CardPresent) }
1375
+ attr_reader :card_present
1376
+ # Attribute for field cashapp
1377
+ sig { returns(Cashapp) }
1378
+ attr_reader :cashapp
1379
+ # Attribute for field customer_balance
1380
+ sig { returns(CustomerBalance) }
1381
+ attr_reader :customer_balance
1382
+ # Attribute for field eps
1383
+ sig { returns(Eps) }
1384
+ attr_reader :eps
1385
+ # Attribute for field fpx
1386
+ sig { returns(Fpx) }
1387
+ attr_reader :fpx
1388
+ # Attribute for field giropay
1389
+ sig { returns(Giropay) }
1390
+ attr_reader :giropay
1391
+ # Attribute for field gopay
1392
+ sig { returns(Gopay) }
1393
+ attr_reader :gopay
1394
+ # Attribute for field grabpay
1395
+ sig { returns(Grabpay) }
1396
+ attr_reader :grabpay
1397
+ # Attribute for field id_bank_transfer
1398
+ sig { returns(IdBankTransfer) }
1399
+ attr_reader :id_bank_transfer
1400
+ # Attribute for field ideal
1401
+ sig { returns(Ideal) }
1402
+ attr_reader :ideal
1403
+ # Attribute for field interac_present
1404
+ sig { returns(InteracPresent) }
1405
+ attr_reader :interac_present
1406
+ # Attribute for field kakao_pay
1407
+ sig { returns(KakaoPay) }
1408
+ attr_reader :kakao_pay
1409
+ # Attribute for field klarna
1410
+ sig { returns(Klarna) }
1411
+ attr_reader :klarna
1412
+ # Attribute for field konbini
1413
+ sig { returns(Konbini) }
1414
+ attr_reader :konbini
1415
+ # Attribute for field kr_card
1416
+ sig { returns(KrCard) }
1417
+ attr_reader :kr_card
1418
+ # Attribute for field link
1419
+ sig { returns(Link) }
1420
+ attr_reader :link
1421
+ # Attribute for field mb_way
1422
+ sig { returns(MbWay) }
1423
+ attr_reader :mb_way
1424
+ # Attribute for field mobilepay
1425
+ sig { returns(Mobilepay) }
1426
+ attr_reader :mobilepay
1427
+ # Attribute for field multibanco
1428
+ sig { returns(Multibanco) }
1429
+ attr_reader :multibanco
1430
+ # Attribute for field naver_pay
1431
+ sig { returns(NaverPay) }
1432
+ attr_reader :naver_pay
1433
+ # Attribute for field oxxo
1434
+ sig { returns(Oxxo) }
1435
+ attr_reader :oxxo
1436
+ # Attribute for field p24
1437
+ sig { returns(P24) }
1438
+ attr_reader :p24
1439
+ # Attribute for field payco
1440
+ sig { returns(Payco) }
1441
+ attr_reader :payco
1442
+ # Attribute for field paynow
1443
+ sig { returns(Paynow) }
1444
+ attr_reader :paynow
1445
+ # Attribute for field paypal
1446
+ sig { returns(Paypal) }
1447
+ attr_reader :paypal
1448
+ # Attribute for field payto
1449
+ sig { returns(Payto) }
1450
+ attr_reader :payto
1451
+ # Attribute for field pix
1452
+ sig { returns(Pix) }
1453
+ attr_reader :pix
1454
+ # Attribute for field promptpay
1455
+ sig { returns(Promptpay) }
1456
+ attr_reader :promptpay
1457
+ # Attribute for field qris
1458
+ sig { returns(Qris) }
1459
+ attr_reader :qris
1460
+ # Attribute for field rechnung
1461
+ sig { returns(Rechnung) }
1462
+ attr_reader :rechnung
1463
+ # Attribute for field revolut_pay
1464
+ sig { returns(RevolutPay) }
1465
+ attr_reader :revolut_pay
1466
+ # Attribute for field samsung_pay
1467
+ sig { returns(SamsungPay) }
1468
+ attr_reader :samsung_pay
1469
+ # Attribute for field sepa_credit_transfer
1470
+ sig { returns(SepaCreditTransfer) }
1471
+ attr_reader :sepa_credit_transfer
1472
+ # Attribute for field sepa_debit
1473
+ sig { returns(SepaDebit) }
1474
+ attr_reader :sepa_debit
1475
+ # Attribute for field shopeepay
1476
+ sig { returns(Shopeepay) }
1477
+ attr_reader :shopeepay
1478
+ # Attribute for field sofort
1479
+ sig { returns(Sofort) }
1480
+ attr_reader :sofort
1481
+ # Attribute for field stripe_account
1482
+ sig { returns(StripeAccount) }
1483
+ attr_reader :stripe_account
1484
+ # Attribute for field swish
1485
+ sig { returns(Swish) }
1486
+ attr_reader :swish
1487
+ # Attribute for field twint
1488
+ sig { returns(Twint) }
1489
+ attr_reader :twint
1490
+ # The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`.
1491
+ # An additional hash is included on `payment_method_details` with a name matching this value.
1492
+ # It contains information specific to the payment method.
1493
+ sig { returns(String) }
1494
+ attr_reader :type
1495
+ # Attribute for field us_bank_account
1496
+ sig { returns(UsBankAccount) }
1497
+ attr_reader :us_bank_account
1498
+ # Attribute for field wechat
1499
+ sig { returns(Wechat) }
1500
+ attr_reader :wechat
1501
+ # Attribute for field wechat_pay
1502
+ sig { returns(WechatPay) }
1503
+ attr_reader :wechat_pay
1504
+ # Attribute for field zip
1505
+ sig { returns(Zip) }
1506
+ attr_reader :zip
1507
+ end
1508
+ class RadarOptions < Stripe::StripeObject
1509
+ # 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.
1510
+ sig { returns(String) }
1511
+ attr_reader :session
1512
+ end
1513
+ class Shipping < Stripe::StripeObject
1514
+ class Address < Stripe::StripeObject
1515
+ # City, district, suburb, town, or village.
1516
+ sig { returns(T.nilable(String)) }
1517
+ attr_reader :city
1518
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1519
+ sig { returns(T.nilable(String)) }
1520
+ attr_reader :country
1521
+ # Address line 1 (e.g., street, PO Box, or company name).
1522
+ sig { returns(T.nilable(String)) }
1523
+ attr_reader :line1
1524
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1525
+ sig { returns(T.nilable(String)) }
1526
+ attr_reader :line2
1527
+ # ZIP or postal code.
1528
+ sig { returns(T.nilable(String)) }
1529
+ attr_reader :postal_code
1530
+ # State, county, province, or region.
1531
+ sig { returns(T.nilable(String)) }
1532
+ attr_reader :state
1533
+ end
1534
+ # Attribute for field address
1535
+ sig { returns(Address) }
1536
+ attr_reader :address
1537
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1538
+ sig { returns(T.nilable(String)) }
1539
+ attr_reader :carrier
1540
+ # Recipient name.
1541
+ sig { returns(String) }
1542
+ attr_reader :name
1543
+ # Recipient phone (including extension).
1544
+ sig { returns(T.nilable(String)) }
1545
+ attr_reader :phone
1546
+ # 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.
1547
+ sig { returns(T.nilable(String)) }
1548
+ attr_reader :tracking_number
1549
+ end
1550
+ class TransferData < Stripe::StripeObject
1551
+ # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
1552
+ sig { returns(T.nilable(Integer)) }
1553
+ attr_reader :amount
1554
+ # ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.
1555
+ sig { returns(T.any(String, Stripe::Account)) }
1556
+ attr_reader :destination
1557
+ end
1558
+ # 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).
1559
+ sig { returns(Integer) }
1560
+ attr_reader :amount
1561
+ # Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
1562
+ sig { returns(Integer) }
1563
+ attr_reader :amount_captured
1564
+ # Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
1565
+ sig { returns(Integer) }
1566
+ attr_reader :amount_refunded
1567
+ # ID of the Connect application that created the charge.
1568
+ sig { returns(T.nilable(T.any(String, Stripe::Application))) }
1569
+ attr_reader :application
1570
+ # The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
1571
+ sig { returns(T.nilable(T.any(String, Stripe::ApplicationFee))) }
1572
+ attr_reader :application_fee
1573
+ # The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
1574
+ sig { returns(T.nilable(Integer)) }
1575
+ attr_reader :application_fee_amount
1576
+ # Authorization code on the charge.
1577
+ sig { returns(String) }
1578
+ attr_reader :authorization_code
1579
+ # ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
1580
+ sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
1581
+ attr_reader :balance_transaction
1582
+ # Attribute for field billing_details
1583
+ sig { returns(BillingDetails) }
1584
+ attr_reader :billing_details
1585
+ # The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.
1586
+ sig { returns(T.nilable(String)) }
1587
+ attr_reader :calculated_statement_descriptor
1588
+ # If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
1589
+ sig { returns(T::Boolean) }
1590
+ attr_reader :captured
1591
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
1592
+ sig { returns(Integer) }
1593
+ attr_reader :created
1594
+ # 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).
1595
+ sig { returns(String) }
1596
+ attr_reader :currency
1597
+ # ID of the customer this charge is for if one exists.
1598
+ sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
1599
+ attr_reader :customer
1600
+ # An arbitrary string attached to the object. Often useful for displaying to users.
1601
+ sig { returns(T.nilable(String)) }
1602
+ attr_reader :description
1603
+ # Whether the charge has been disputed.
1604
+ sig { returns(T::Boolean) }
1605
+ attr_reader :disputed
1606
+ # ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
1607
+ sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
1608
+ attr_reader :failure_balance_transaction
1609
+ # Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).
1610
+ sig { returns(T.nilable(String)) }
1611
+ attr_reader :failure_code
1612
+ # Message to user further explaining reason for charge failure if available.
1613
+ sig { returns(T.nilable(String)) }
1614
+ attr_reader :failure_message
1615
+ # Information on fraud assessments for the charge.
1616
+ sig { returns(T.nilable(FraudDetails)) }
1617
+ attr_reader :fraud_details
1618
+ # Unique identifier for the object.
1619
+ sig { returns(String) }
1620
+ attr_reader :id
1621
+ # ID of the invoice this charge is for if one exists.
1622
+ sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
1623
+ attr_reader :invoice
1624
+ # Attribute for field level3
1625
+ sig { returns(Level3) }
1626
+ attr_reader :level3
1627
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
1628
+ sig { returns(T::Boolean) }
1629
+ attr_reader :livemode
1630
+ # 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.
1631
+ sig { returns(T::Hash[String, String]) }
1632
+ attr_reader :metadata
1633
+ # String representing the object's type. Objects of the same type share the same value.
1634
+ sig { returns(String) }
1635
+ attr_reader :object
1636
+ # The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
1637
+ sig { returns(T.nilable(T.any(String, Stripe::Account))) }
1638
+ attr_reader :on_behalf_of
1639
+ # Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.
1640
+ sig { returns(T.nilable(Outcome)) }
1641
+ attr_reader :outcome
1642
+ # `true` if the charge succeeded, or was successfully authorized for later capture.
1643
+ sig { returns(T::Boolean) }
1644
+ attr_reader :paid
1645
+ # ID of the PaymentIntent associated with this charge, if one exists.
1646
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
1647
+ attr_reader :payment_intent
1648
+ # ID of the payment method used in this charge.
1649
+ sig { returns(T.nilable(String)) }
1650
+ attr_reader :payment_method
1651
+ # Details about the payment method at the time of the transaction.
1652
+ sig { returns(T.nilable(PaymentMethodDetails)) }
1653
+ attr_reader :payment_method_details
1654
+ # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
1655
+ sig { returns(RadarOptions) }
1656
+ attr_reader :radar_options
1657
+ # This is the email address that the receipt for this charge was sent to.
1658
+ sig { returns(T.nilable(String)) }
1659
+ attr_reader :receipt_email
1660
+ # This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.
1661
+ sig { returns(T.nilable(String)) }
1662
+ attr_reader :receipt_number
1663
+ # This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
1664
+ sig { returns(T.nilable(String)) }
1665
+ attr_reader :receipt_url
1666
+ # Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
1667
+ sig { returns(T::Boolean) }
1668
+ attr_reader :refunded
1669
+ # A list of refunds that have been applied to the charge.
1670
+ sig { returns(T.nilable(Stripe::ListObject)) }
1671
+ attr_reader :refunds
1672
+ # ID of the review associated with this charge if one exists.
1673
+ sig { returns(T.nilable(T.any(String, Stripe::Review))) }
1674
+ attr_reader :review
1675
+ # Shipping information for the charge.
1676
+ sig { returns(T.nilable(Shipping)) }
1677
+ attr_reader :shipping
1678
+ # This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead.
1679
+ sig {
1680
+ returns(T.nilable(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source)))
1681
+ }
1682
+ attr_reader :source
1683
+ # The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
1684
+ sig { returns(T.nilable(T.any(String, Stripe::Transfer))) }
1685
+ attr_reader :source_transfer
1686
+ # 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).
1687
+ #
1688
+ # 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.
1689
+ sig { returns(T.nilable(String)) }
1690
+ attr_reader :statement_descriptor
1691
+ # 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.
1692
+ sig { returns(T.nilable(String)) }
1693
+ attr_reader :statement_descriptor_suffix
1694
+ # The status of the payment is either `succeeded`, `pending`, or `failed`.
1695
+ sig { returns(String) }
1696
+ attr_reader :status
1697
+ # ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).
1698
+ sig { returns(T.any(String, Stripe::Transfer)) }
1699
+ attr_reader :transfer
1700
+ # 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.
1701
+ sig { returns(T.nilable(TransferData)) }
1702
+ attr_reader :transfer_data
1703
+ # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
1704
+ sig { returns(T.nilable(String)) }
1705
+ attr_reader :transfer_group
1706
+ class ListParams < Stripe::RequestParams
1707
+ class Created < Stripe::RequestParams
1708
+ # Minimum value to filter by (exclusive)
1709
+ sig { returns(Integer) }
1710
+ attr_accessor :gt
1711
+ # Minimum value to filter by (inclusive)
1712
+ sig { returns(Integer) }
1713
+ attr_accessor :gte
1714
+ # Maximum value to filter by (exclusive)
1715
+ sig { returns(Integer) }
1716
+ attr_accessor :lt
1717
+ # Maximum value to filter by (inclusive)
1718
+ sig { returns(Integer) }
1719
+ attr_accessor :lte
1720
+ sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
1721
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
1722
+ end
1723
+ # Only return charges that were created during the given date interval.
1724
+ sig { returns(T.any(::Stripe::Charge::ListParams::Created, Integer)) }
1725
+ attr_accessor :created
1726
+ # Only return charges for the customer specified by this customer ID.
1727
+ sig { returns(String) }
1728
+ attr_accessor :customer
1729
+ # 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.
1730
+ sig { returns(String) }
1731
+ attr_accessor :ending_before
1732
+ # Specifies which fields in the response should be expanded.
1733
+ sig { returns(T::Array[String]) }
1734
+ attr_accessor :expand
1735
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1736
+ sig { returns(Integer) }
1737
+ attr_accessor :limit
1738
+ # Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
1739
+ sig { returns(String) }
1740
+ attr_accessor :payment_intent
1741
+ # 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.
1742
+ sig { returns(String) }
1743
+ attr_accessor :starting_after
1744
+ # Only return charges for this transfer group, limited to 100.
1745
+ sig { returns(String) }
1746
+ attr_accessor :transfer_group
1747
+ sig {
1748
+ 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
1749
+ }
1750
+ def initialize(
1751
+ created: nil,
1752
+ customer: nil,
1753
+ ending_before: nil,
1754
+ expand: nil,
1755
+ limit: nil,
1756
+ payment_intent: nil,
1757
+ starting_after: nil,
1758
+ transfer_group: nil
1759
+ ); end
1760
+ end
1761
+ class CreateParams < Stripe::RequestParams
1762
+ class Destination < Stripe::RequestParams
1763
+ # ID of an existing, connected Stripe account.
1764
+ sig { returns(String) }
1765
+ attr_accessor :account
1766
+ # 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.
1767
+ sig { returns(Integer) }
1768
+ attr_accessor :amount
1769
+ sig { params(account: String, amount: Integer).void }
1770
+ def initialize(account: nil, amount: nil); end
1771
+ end
1772
+ class RadarOptions < Stripe::RequestParams
1773
+ # 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.
1774
+ sig { returns(String) }
1775
+ attr_accessor :session
1776
+ sig { params(session: String).void }
1777
+ def initialize(session: nil); end
1778
+ end
1779
+ class Shipping < Stripe::RequestParams
1780
+ class Address < Stripe::RequestParams
1781
+ # City, district, suburb, town, or village.
1782
+ sig { returns(String) }
1783
+ attr_accessor :city
1784
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1785
+ sig { returns(String) }
1786
+ attr_accessor :country
1787
+ # Address line 1 (e.g., street, PO Box, or company name).
1788
+ sig { returns(String) }
1789
+ attr_accessor :line1
1790
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1791
+ sig { returns(String) }
1792
+ attr_accessor :line2
1793
+ # ZIP or postal code.
1794
+ sig { returns(String) }
1795
+ attr_accessor :postal_code
1796
+ # State, county, province, or region.
1797
+ sig { returns(String) }
1798
+ attr_accessor :state
1799
+ sig {
1800
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
1801
+ }
1802
+ def initialize(
1803
+ city: nil,
1804
+ country: nil,
1805
+ line1: nil,
1806
+ line2: nil,
1807
+ postal_code: nil,
1808
+ state: nil
1809
+ ); end
1810
+ end
1811
+ # Shipping address.
1812
+ sig { returns(::Stripe::Charge::CreateParams::Shipping::Address) }
1813
+ attr_accessor :address
1814
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1815
+ sig { returns(String) }
1816
+ attr_accessor :carrier
1817
+ # Recipient name.
1818
+ sig { returns(String) }
1819
+ attr_accessor :name
1820
+ # Recipient phone (including extension).
1821
+ sig { returns(String) }
1822
+ attr_accessor :phone
1823
+ # 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.
1824
+ sig { returns(String) }
1825
+ attr_accessor :tracking_number
1826
+ sig {
1827
+ params(address: ::Stripe::Charge::CreateParams::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
1828
+ }
1829
+ def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
1830
+ end
1831
+ class TransferData < Stripe::RequestParams
1832
+ # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
1833
+ sig { returns(Integer) }
1834
+ attr_accessor :amount
1835
+ # ID of an existing, connected Stripe account.
1836
+ sig { returns(String) }
1837
+ attr_accessor :destination
1838
+ sig { params(amount: Integer, destination: String).void }
1839
+ def initialize(amount: nil, destination: nil); end
1840
+ end
1841
+ # 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).
1842
+ sig { returns(Integer) }
1843
+ attr_accessor :amount
1844
+ # Attribute for param field application_fee
1845
+ sig { returns(Integer) }
1846
+ attr_accessor :application_fee
1847
+ # 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).
1848
+ sig { returns(Integer) }
1849
+ attr_accessor :application_fee_amount
1850
+ # 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.
1851
+ sig { returns(T::Boolean) }
1852
+ attr_accessor :capture
1853
+ # 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).
1854
+ sig { returns(String) }
1855
+ attr_accessor :currency
1856
+ # The ID of an existing customer that will be charged in this request.
1857
+ sig { returns(String) }
1858
+ attr_accessor :customer
1859
+ # 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.
1860
+ sig { returns(String) }
1861
+ attr_accessor :description
1862
+ # Attribute for param field destination
1863
+ sig { returns(::Stripe::Charge::CreateParams::Destination) }
1864
+ attr_accessor :destination
1865
+ # Specifies which fields in the response should be expanded.
1866
+ sig { returns(T::Array[String]) }
1867
+ attr_accessor :expand
1868
+ # 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`.
1869
+ sig { returns(T.nilable(T::Hash[String, String])) }
1870
+ attr_accessor :metadata
1871
+ # 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).
1872
+ sig { returns(String) }
1873
+ attr_accessor :on_behalf_of
1874
+ # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
1875
+ sig { returns(::Stripe::Charge::CreateParams::RadarOptions) }
1876
+ attr_accessor :radar_options
1877
+ # 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).
1878
+ sig { returns(String) }
1879
+ attr_accessor :receipt_email
1880
+ # Shipping information for the charge. Helps prevent fraud on charges for physical goods.
1881
+ sig { returns(::Stripe::Charge::CreateParams::Shipping) }
1882
+ attr_accessor :shipping
1883
+ # 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.
1884
+ sig { returns(String) }
1885
+ attr_accessor :source
1886
+ # 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).
1887
+ #
1888
+ # 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.
1889
+ sig { returns(String) }
1890
+ attr_accessor :statement_descriptor
1891
+ # 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.
1892
+ sig { returns(String) }
1893
+ attr_accessor :statement_descriptor_suffix
1894
+ # 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.
1895
+ sig { returns(::Stripe::Charge::CreateParams::TransferData) }
1896
+ attr_accessor :transfer_data
1897
+ # 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).
1898
+ sig { returns(String) }
1899
+ attr_accessor :transfer_group
1900
+ sig {
1901
+ 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
1902
+ }
1903
+ def initialize(
1904
+ amount: nil,
1905
+ application_fee: nil,
1906
+ application_fee_amount: nil,
1907
+ capture: nil,
1908
+ currency: nil,
1909
+ customer: nil,
1910
+ description: nil,
1911
+ destination: nil,
1912
+ expand: nil,
1913
+ metadata: nil,
1914
+ on_behalf_of: nil,
1915
+ radar_options: nil,
1916
+ receipt_email: nil,
1917
+ shipping: nil,
1918
+ source: nil,
1919
+ statement_descriptor: nil,
1920
+ statement_descriptor_suffix: nil,
1921
+ transfer_data: nil,
1922
+ transfer_group: nil
1923
+ ); end
1924
+ end
1925
+ class RetrieveParams < Stripe::RequestParams
1926
+ # Specifies which fields in the response should be expanded.
1927
+ sig { returns(T::Array[String]) }
1928
+ attr_accessor :expand
1929
+ sig { params(expand: T::Array[String]).void }
1930
+ def initialize(expand: nil); end
1931
+ end
1932
+ class UpdateParams < Stripe::RequestParams
1933
+ class FraudDetails < Stripe::RequestParams
1934
+ # Either `safe` or `fraudulent`.
1935
+ sig { returns(T.nilable(String)) }
1936
+ attr_accessor :user_report
1937
+ sig { params(user_report: T.nilable(String)).void }
1938
+ def initialize(user_report: nil); end
1939
+ end
1940
+ class PaymentDetails < Stripe::RequestParams
1941
+ class CarRental < Stripe::RequestParams
1942
+ class Affiliate < Stripe::RequestParams
1943
+ # The name of the affiliate that originated the purchase.
1944
+ sig { returns(String) }
1945
+ attr_accessor :name
1946
+ sig { params(name: String).void }
1947
+ def initialize(name: nil); end
1948
+ end
1949
+ class Delivery < Stripe::RequestParams
1950
+ class Recipient < Stripe::RequestParams
1951
+ # The email of the recipient the ticket is delivered to.
1952
+ sig { returns(String) }
1953
+ attr_accessor :email
1954
+ # The name of the recipient the ticket is delivered to.
1955
+ sig { returns(String) }
1956
+ attr_accessor :name
1957
+ # The phone number of the recipient the ticket is delivered to.
1958
+ sig { returns(String) }
1959
+ attr_accessor :phone
1960
+ sig { params(email: String, name: String, phone: String).void }
1961
+ def initialize(email: nil, name: nil, phone: nil); end
1962
+ end
1963
+ # The delivery method for the payment
1964
+ sig { returns(String) }
1965
+ attr_accessor :mode
1966
+ # Details of the recipient.
1967
+ sig {
1968
+ returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient)
1969
+ }
1970
+ attr_accessor :recipient
1971
+ sig {
1972
+ params(mode: String, recipient: ::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery::Recipient).void
1973
+ }
1974
+ def initialize(mode: nil, recipient: nil); end
1975
+ end
1976
+ class Driver < Stripe::RequestParams
1977
+ # Full name of the person or entity on the car reservation.
1978
+ sig { returns(String) }
1979
+ attr_accessor :name
1980
+ sig { params(name: String).void }
1981
+ def initialize(name: nil); end
1982
+ end
1983
+ class PickupAddress < Stripe::RequestParams
1984
+ # City, district, suburb, town, or village.
1985
+ sig { returns(String) }
1986
+ attr_accessor :city
1987
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1988
+ sig { returns(String) }
1989
+ attr_accessor :country
1990
+ # Address line 1 (e.g., street, PO Box, or company name).
1991
+ sig { returns(String) }
1992
+ attr_accessor :line1
1993
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1994
+ sig { returns(String) }
1995
+ attr_accessor :line2
1996
+ # ZIP or postal code.
1997
+ sig { returns(String) }
1998
+ attr_accessor :postal_code
1999
+ # State, county, province, or region.
2000
+ sig { returns(String) }
2001
+ attr_accessor :state
2002
+ sig {
2003
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2004
+ }
2005
+ def initialize(
2006
+ city: nil,
2007
+ country: nil,
2008
+ line1: nil,
2009
+ line2: nil,
2010
+ postal_code: nil,
2011
+ state: nil
2012
+ ); end
2013
+ end
2014
+ class ReturnAddress < Stripe::RequestParams
2015
+ # City, district, suburb, town, or village.
2016
+ sig { returns(String) }
2017
+ attr_accessor :city
2018
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2019
+ sig { returns(String) }
2020
+ attr_accessor :country
2021
+ # Address line 1 (e.g., street, PO Box, or company name).
2022
+ sig { returns(String) }
2023
+ attr_accessor :line1
2024
+ # Address line 2 (e.g., apartment, suite, unit, or building).
2025
+ sig { returns(String) }
2026
+ attr_accessor :line2
2027
+ # ZIP or postal code.
2028
+ sig { returns(String) }
2029
+ attr_accessor :postal_code
2030
+ # State, county, province, or region.
2031
+ sig { returns(String) }
2032
+ attr_accessor :state
2033
+ sig {
2034
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2035
+ }
2036
+ def initialize(
2037
+ city: nil,
2038
+ country: nil,
2039
+ line1: nil,
2040
+ line2: nil,
2041
+ postal_code: nil,
2042
+ state: nil
2043
+ ); end
2044
+ end
2045
+ # Affiliate details for this purchase.
2046
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Affiliate) }
2047
+ attr_accessor :affiliate
2048
+ # The booking number associated with the car rental.
2049
+ sig { returns(String) }
2050
+ attr_accessor :booking_number
2051
+ # Class code of the car.
2052
+ sig { returns(String) }
2053
+ attr_accessor :car_class_code
2054
+ # Make of the car.
2055
+ sig { returns(String) }
2056
+ attr_accessor :car_make
2057
+ # Model of the car.
2058
+ sig { returns(String) }
2059
+ attr_accessor :car_model
2060
+ # The name of the rental car company.
2061
+ sig { returns(String) }
2062
+ attr_accessor :company
2063
+ # The customer service phone number of the car rental company.
2064
+ sig { returns(String) }
2065
+ attr_accessor :customer_service_phone_number
2066
+ # Number of days the car is being rented.
2067
+ sig { returns(Integer) }
2068
+ attr_accessor :days_rented
2069
+ # Delivery details for this purchase.
2070
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Delivery) }
2071
+ attr_accessor :delivery
2072
+ # The details of the passengers in the travel reservation
2073
+ sig {
2074
+ returns(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::Driver])
2075
+ }
2076
+ attr_accessor :drivers
2077
+ # List of additional charges being billed.
2078
+ sig { returns(T::Array[String]) }
2079
+ attr_accessor :extra_charges
2080
+ # Indicates if the customer did not keep nor cancel their booking.
2081
+ sig { returns(T::Boolean) }
2082
+ attr_accessor :no_show
2083
+ # Car pick-up address.
2084
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::PickupAddress) }
2085
+ attr_accessor :pickup_address
2086
+ # Car pick-up time. Measured in seconds since the Unix epoch.
2087
+ sig { returns(Integer) }
2088
+ attr_accessor :pickup_at
2089
+ # Rental rate.
2090
+ sig { returns(Integer) }
2091
+ attr_accessor :rate_amount
2092
+ # The frequency at which the rate amount is applied. One of `day`, `week` or `month`
2093
+ sig { returns(String) }
2094
+ attr_accessor :rate_interval
2095
+ # The name of the person or entity renting the car.
2096
+ sig { returns(String) }
2097
+ attr_accessor :renter_name
2098
+ # Car return address.
2099
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental::ReturnAddress) }
2100
+ attr_accessor :return_address
2101
+ # Car return time. Measured in seconds since the Unix epoch.
2102
+ sig { returns(Integer) }
2103
+ attr_accessor :return_at
2104
+ # Indicates whether the goods or services are tax-exempt or tax is not collected.
2105
+ sig { returns(T::Boolean) }
2106
+ attr_accessor :tax_exempt
2107
+ sig {
2108
+ 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
2109
+ }
2110
+ def initialize(
2111
+ affiliate: nil,
2112
+ booking_number: nil,
2113
+ car_class_code: nil,
2114
+ car_make: nil,
2115
+ car_model: nil,
2116
+ company: nil,
2117
+ customer_service_phone_number: nil,
2118
+ days_rented: nil,
2119
+ delivery: nil,
2120
+ drivers: nil,
2121
+ extra_charges: nil,
2122
+ no_show: nil,
2123
+ pickup_address: nil,
2124
+ pickup_at: nil,
2125
+ rate_amount: nil,
2126
+ rate_interval: nil,
2127
+ renter_name: nil,
2128
+ return_address: nil,
2129
+ return_at: nil,
2130
+ tax_exempt: nil
2131
+ ); end
2132
+ end
2133
+ class EventDetails < Stripe::RequestParams
2134
+ class Address < Stripe::RequestParams
2135
+ # City, district, suburb, town, or village.
2136
+ sig { returns(String) }
2137
+ attr_accessor :city
2138
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2139
+ sig { returns(String) }
2140
+ attr_accessor :country
2141
+ # Address line 1 (e.g., street, PO Box, or company name).
2142
+ sig { returns(String) }
2143
+ attr_accessor :line1
2144
+ # Address line 2 (e.g., apartment, suite, unit, or building).
2145
+ sig { returns(String) }
2146
+ attr_accessor :line2
2147
+ # ZIP or postal code.
2148
+ sig { returns(String) }
2149
+ attr_accessor :postal_code
2150
+ # State, county, province, or region.
2151
+ sig { returns(String) }
2152
+ attr_accessor :state
2153
+ sig {
2154
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2155
+ }
2156
+ def initialize(
2157
+ city: nil,
2158
+ country: nil,
2159
+ line1: nil,
2160
+ line2: nil,
2161
+ postal_code: nil,
2162
+ state: nil
2163
+ ); end
2164
+ end
2165
+ class Affiliate < Stripe::RequestParams
2166
+ # The name of the affiliate that originated the purchase.
2167
+ sig { returns(String) }
2168
+ attr_accessor :name
2169
+ sig { params(name: String).void }
2170
+ def initialize(name: nil); end
2171
+ end
2172
+ class Delivery < Stripe::RequestParams
2173
+ class Recipient < Stripe::RequestParams
2174
+ # The email of the recipient the ticket is delivered to.
2175
+ sig { returns(String) }
2176
+ attr_accessor :email
2177
+ # The name of the recipient the ticket is delivered to.
2178
+ sig { returns(String) }
2179
+ attr_accessor :name
2180
+ # The phone number of the recipient the ticket is delivered to.
2181
+ sig { returns(String) }
2182
+ attr_accessor :phone
2183
+ sig { params(email: String, name: String, phone: String).void }
2184
+ def initialize(email: nil, name: nil, phone: nil); end
2185
+ end
2186
+ # The delivery method for the payment
2187
+ sig { returns(String) }
2188
+ attr_accessor :mode
2189
+ # Details of the recipient.
2190
+ sig {
2191
+ returns(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient)
2192
+ }
2193
+ attr_accessor :recipient
2194
+ sig {
2195
+ params(mode: String, recipient: ::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery::Recipient).void
2196
+ }
2197
+ def initialize(mode: nil, recipient: nil); end
2198
+ end
2199
+ # Indicates if the tickets are digitally checked when entering the venue.
2200
+ sig { returns(T::Boolean) }
2201
+ attr_accessor :access_controlled_venue
2202
+ # The event location's address.
2203
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Address) }
2204
+ attr_accessor :address
2205
+ # Affiliate details for this purchase.
2206
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Affiliate) }
2207
+ attr_accessor :affiliate
2208
+ # The name of the company
2209
+ sig { returns(String) }
2210
+ attr_accessor :company
2211
+ # Delivery details for this purchase.
2212
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails::Delivery) }
2213
+ attr_accessor :delivery
2214
+ # Event end time. Measured in seconds since the Unix epoch.
2215
+ sig { returns(Integer) }
2216
+ attr_accessor :ends_at
2217
+ # Type of the event entertainment (concert, sports event etc)
2218
+ sig { returns(String) }
2219
+ attr_accessor :genre
2220
+ # The name of the event.
2221
+ sig { returns(String) }
2222
+ attr_accessor :name
2223
+ # Event start time. Measured in seconds since the Unix epoch.
2224
+ sig { returns(Integer) }
2225
+ attr_accessor :starts_at
2226
+ sig {
2227
+ 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
2228
+ }
2229
+ def initialize(
2230
+ access_controlled_venue: nil,
2231
+ address: nil,
2232
+ affiliate: nil,
2233
+ company: nil,
2234
+ delivery: nil,
2235
+ ends_at: nil,
2236
+ genre: nil,
2237
+ name: nil,
2238
+ starts_at: nil
2239
+ ); end
2240
+ end
2241
+ class Flight < Stripe::RequestParams
2242
+ class Affiliate < Stripe::RequestParams
2243
+ # The name of the affiliate that originated the purchase.
2244
+ sig { returns(String) }
2245
+ attr_accessor :name
2246
+ sig { params(name: String).void }
2247
+ def initialize(name: nil); end
2248
+ end
2249
+ class Delivery < Stripe::RequestParams
2250
+ class Recipient < Stripe::RequestParams
2251
+ # The email of the recipient the ticket is delivered to.
2252
+ sig { returns(String) }
2253
+ attr_accessor :email
2254
+ # The name of the recipient the ticket is delivered to.
2255
+ sig { returns(String) }
2256
+ attr_accessor :name
2257
+ # The phone number of the recipient the ticket is delivered to.
2258
+ sig { returns(String) }
2259
+ attr_accessor :phone
2260
+ sig { params(email: String, name: String, phone: String).void }
2261
+ def initialize(email: nil, name: nil, phone: nil); end
2262
+ end
2263
+ # The delivery method for the payment
2264
+ sig { returns(String) }
2265
+ attr_accessor :mode
2266
+ # Details of the recipient.
2267
+ sig {
2268
+ returns(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery::Recipient)
2269
+ }
2270
+ attr_accessor :recipient
2271
+ sig {
2272
+ params(mode: String, recipient: ::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery::Recipient).void
2273
+ }
2274
+ def initialize(mode: nil, recipient: nil); end
2275
+ end
2276
+ class Passenger < Stripe::RequestParams
2277
+ # Full name of the person or entity on the flight reservation.
2278
+ sig { returns(String) }
2279
+ attr_accessor :name
2280
+ sig { params(name: String).void }
2281
+ def initialize(name: nil); end
2282
+ end
2283
+ class Segment < Stripe::RequestParams
2284
+ # The flight segment amount.
2285
+ sig { returns(Integer) }
2286
+ attr_accessor :amount
2287
+ # The International Air Transport Association (IATA) airport code for the arrival airport.
2288
+ sig { returns(String) }
2289
+ attr_accessor :arrival_airport
2290
+ # The arrival time for the flight segment. Measured in seconds since the Unix epoch.
2291
+ sig { returns(Integer) }
2292
+ attr_accessor :arrives_at
2293
+ # The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
2294
+ sig { returns(String) }
2295
+ attr_accessor :carrier
2296
+ # The departure time for the flight segment. Measured in seconds since the Unix epoch.
2297
+ sig { returns(Integer) }
2298
+ attr_accessor :departs_at
2299
+ # The International Air Transport Association (IATA) airport code for the departure airport.
2300
+ sig { returns(String) }
2301
+ attr_accessor :departure_airport
2302
+ # The flight number associated with the segment
2303
+ sig { returns(String) }
2304
+ attr_accessor :flight_number
2305
+ # The fare class for the segment.
2306
+ sig { returns(String) }
2307
+ attr_accessor :service_class
2308
+ sig {
2309
+ params(amount: Integer, arrival_airport: String, arrives_at: Integer, carrier: String, departs_at: Integer, departure_airport: String, flight_number: String, service_class: String).void
2310
+ }
2311
+ def initialize(
2312
+ amount: nil,
2313
+ arrival_airport: nil,
2314
+ arrives_at: nil,
2315
+ carrier: nil,
2316
+ departs_at: nil,
2317
+ departure_airport: nil,
2318
+ flight_number: nil,
2319
+ service_class: nil
2320
+ ); end
2321
+ end
2322
+ # Affiliate details for this purchase.
2323
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Affiliate) }
2324
+ attr_accessor :affiliate
2325
+ # The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
2326
+ sig { returns(String) }
2327
+ attr_accessor :agency_number
2328
+ # The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
2329
+ sig { returns(String) }
2330
+ attr_accessor :carrier
2331
+ # Delivery details for this purchase.
2332
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Delivery) }
2333
+ attr_accessor :delivery
2334
+ # The name of the person or entity on the reservation.
2335
+ sig { returns(String) }
2336
+ attr_accessor :passenger_name
2337
+ # The details of the passengers in the travel reservation.
2338
+ sig {
2339
+ returns(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Passenger])
2340
+ }
2341
+ attr_accessor :passengers
2342
+ # The individual flight segments associated with the trip.
2343
+ sig { returns(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Flight::Segment]) }
2344
+ attr_accessor :segments
2345
+ # The ticket number associated with the travel reservation.
2346
+ sig { returns(String) }
2347
+ attr_accessor :ticket_number
2348
+ sig {
2349
+ 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
2350
+ }
2351
+ def initialize(
2352
+ affiliate: nil,
2353
+ agency_number: nil,
2354
+ carrier: nil,
2355
+ delivery: nil,
2356
+ passenger_name: nil,
2357
+ passengers: nil,
2358
+ segments: nil,
2359
+ ticket_number: nil
2360
+ ); end
2361
+ end
2362
+ class Lodging < Stripe::RequestParams
2363
+ class Address < Stripe::RequestParams
2364
+ # City, district, suburb, town, or village.
2365
+ sig { returns(String) }
2366
+ attr_accessor :city
2367
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2368
+ sig { returns(String) }
2369
+ attr_accessor :country
2370
+ # Address line 1 (e.g., street, PO Box, or company name).
2371
+ sig { returns(String) }
2372
+ attr_accessor :line1
2373
+ # Address line 2 (e.g., apartment, suite, unit, or building).
2374
+ sig { returns(String) }
2375
+ attr_accessor :line2
2376
+ # ZIP or postal code.
2377
+ sig { returns(String) }
2378
+ attr_accessor :postal_code
2379
+ # State, county, province, or region.
2380
+ sig { returns(String) }
2381
+ attr_accessor :state
2382
+ sig {
2383
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2384
+ }
2385
+ def initialize(
2386
+ city: nil,
2387
+ country: nil,
2388
+ line1: nil,
2389
+ line2: nil,
2390
+ postal_code: nil,
2391
+ state: nil
2392
+ ); end
2393
+ end
2394
+ class Affiliate < Stripe::RequestParams
2395
+ # The name of the affiliate that originated the purchase.
2396
+ sig { returns(String) }
2397
+ attr_accessor :name
2398
+ sig { params(name: String).void }
2399
+ def initialize(name: nil); end
2400
+ end
2401
+ class Delivery < Stripe::RequestParams
2402
+ class Recipient < Stripe::RequestParams
2403
+ # The email of the recipient the ticket is delivered to.
2404
+ sig { returns(String) }
2405
+ attr_accessor :email
2406
+ # The name of the recipient the ticket is delivered to.
2407
+ sig { returns(String) }
2408
+ attr_accessor :name
2409
+ # The phone number of the recipient the ticket is delivered to.
2410
+ sig { returns(String) }
2411
+ attr_accessor :phone
2412
+ sig { params(email: String, name: String, phone: String).void }
2413
+ def initialize(email: nil, name: nil, phone: nil); end
2414
+ end
2415
+ # The delivery method for the payment
2416
+ sig { returns(String) }
2417
+ attr_accessor :mode
2418
+ # Details of the recipient.
2419
+ sig {
2420
+ returns(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient)
2421
+ }
2422
+ attr_accessor :recipient
2423
+ sig {
2424
+ params(mode: String, recipient: ::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery::Recipient).void
2425
+ }
2426
+ def initialize(mode: nil, recipient: nil); end
2427
+ end
2428
+ class Passenger < Stripe::RequestParams
2429
+ # Full name of the person or entity on the lodging reservation.
2430
+ sig { returns(String) }
2431
+ attr_accessor :name
2432
+ sig { params(name: String).void }
2433
+ def initialize(name: nil); end
2434
+ end
2435
+ # The lodging location's address.
2436
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Address) }
2437
+ attr_accessor :address
2438
+ # The number of adults on the booking
2439
+ sig { returns(Integer) }
2440
+ attr_accessor :adults
2441
+ # Affiliate details for this purchase.
2442
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Affiliate) }
2443
+ attr_accessor :affiliate
2444
+ # The booking number associated with the lodging reservation.
2445
+ sig { returns(String) }
2446
+ attr_accessor :booking_number
2447
+ # The lodging category
2448
+ sig { returns(String) }
2449
+ attr_accessor :category
2450
+ # Loding check-in time. Measured in seconds since the Unix epoch.
2451
+ sig { returns(Integer) }
2452
+ attr_accessor :checkin_at
2453
+ # Lodging check-out time. Measured in seconds since the Unix epoch.
2454
+ sig { returns(Integer) }
2455
+ attr_accessor :checkout_at
2456
+ # The customer service phone number of the lodging company.
2457
+ sig { returns(String) }
2458
+ attr_accessor :customer_service_phone_number
2459
+ # The daily lodging room rate.
2460
+ sig { returns(Integer) }
2461
+ attr_accessor :daily_room_rate_amount
2462
+ # Delivery details for this purchase.
2463
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Delivery) }
2464
+ attr_accessor :delivery
2465
+ # List of additional charges being billed.
2466
+ sig { returns(T::Array[String]) }
2467
+ attr_accessor :extra_charges
2468
+ # Indicates whether the lodging location is compliant with the Fire Safety Act.
2469
+ sig { returns(T::Boolean) }
2470
+ attr_accessor :fire_safety_act_compliance
2471
+ # The name of the lodging location.
2472
+ sig { returns(String) }
2473
+ attr_accessor :name
2474
+ # Indicates if the customer did not keep their booking while failing to cancel the reservation.
2475
+ sig { returns(T::Boolean) }
2476
+ attr_accessor :no_show
2477
+ # The number of rooms on the booking
2478
+ sig { returns(Integer) }
2479
+ attr_accessor :number_of_rooms
2480
+ # The details of the passengers in the travel reservation
2481
+ sig {
2482
+ returns(T::Array[::Stripe::Charge::UpdateParams::PaymentDetails::Lodging::Passenger])
2483
+ }
2484
+ attr_accessor :passengers
2485
+ # The phone number of the lodging location.
2486
+ sig { returns(String) }
2487
+ attr_accessor :property_phone_number
2488
+ # The room class for this purchase.
2489
+ sig { returns(String) }
2490
+ attr_accessor :room_class
2491
+ # The number of room nights
2492
+ sig { returns(Integer) }
2493
+ attr_accessor :room_nights
2494
+ # The total tax amount associating with the room reservation.
2495
+ sig { returns(Integer) }
2496
+ attr_accessor :total_room_tax_amount
2497
+ # The total tax amount
2498
+ sig { returns(Integer) }
2499
+ attr_accessor :total_tax_amount
2500
+ sig {
2501
+ 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
2502
+ }
2503
+ def initialize(
2504
+ address: nil,
2505
+ adults: nil,
2506
+ affiliate: nil,
2507
+ booking_number: nil,
2508
+ category: nil,
2509
+ checkin_at: nil,
2510
+ checkout_at: nil,
2511
+ customer_service_phone_number: nil,
2512
+ daily_room_rate_amount: nil,
2513
+ delivery: nil,
2514
+ extra_charges: nil,
2515
+ fire_safety_act_compliance: nil,
2516
+ name: nil,
2517
+ no_show: nil,
2518
+ number_of_rooms: nil,
2519
+ passengers: nil,
2520
+ property_phone_number: nil,
2521
+ room_class: nil,
2522
+ room_nights: nil,
2523
+ total_room_tax_amount: nil,
2524
+ total_tax_amount: nil
2525
+ ); end
2526
+ end
2527
+ class Subscription < Stripe::RequestParams
2528
+ class Affiliate < Stripe::RequestParams
2529
+ # The name of the affiliate that originated the purchase.
2530
+ sig { returns(String) }
2531
+ attr_accessor :name
2532
+ sig { params(name: String).void }
2533
+ def initialize(name: nil); end
2534
+ end
2535
+ class BillingInterval < Stripe::RequestParams
2536
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2537
+ sig { returns(Integer) }
2538
+ attr_accessor :count
2539
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2540
+ sig { returns(String) }
2541
+ attr_accessor :interval
2542
+ sig { params(count: Integer, interval: String).void }
2543
+ def initialize(count: nil, interval: nil); end
2544
+ end
2545
+ # Affiliate details for this purchase.
2546
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::Affiliate) }
2547
+ attr_accessor :affiliate
2548
+ # Info whether the subscription will be auto renewed upon expiry.
2549
+ sig { returns(T::Boolean) }
2550
+ attr_accessor :auto_renewal
2551
+ # Subscription billing details for this purchase.
2552
+ sig {
2553
+ returns(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription::BillingInterval)
2554
+ }
2555
+ attr_accessor :billing_interval
2556
+ # Subscription end time. Measured in seconds since the Unix epoch.
2557
+ sig { returns(Integer) }
2558
+ attr_accessor :ends_at
2559
+ # Name of the product on subscription. e.g. Apple Music Subscription
2560
+ sig { returns(String) }
2561
+ attr_accessor :name
2562
+ # Subscription start time. Measured in seconds since the Unix epoch.
2563
+ sig { returns(Integer) }
2564
+ attr_accessor :starts_at
2565
+ sig {
2566
+ 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
2567
+ }
2568
+ def initialize(
2569
+ affiliate: nil,
2570
+ auto_renewal: nil,
2571
+ billing_interval: nil,
2572
+ ends_at: nil,
2573
+ name: nil,
2574
+ starts_at: nil
2575
+ ); end
2576
+ end
2577
+ # Car rental details for this PaymentIntent.
2578
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::CarRental) }
2579
+ attr_accessor :car_rental
2580
+ # Event details for this PaymentIntent
2581
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::EventDetails) }
2582
+ attr_accessor :event_details
2583
+ # Flight reservation details for this PaymentIntent
2584
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Flight) }
2585
+ attr_accessor :flight
2586
+ # Lodging reservation details for this PaymentIntent
2587
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Lodging) }
2588
+ attr_accessor :lodging
2589
+ # Subscription details for this PaymentIntent
2590
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails::Subscription) }
2591
+ attr_accessor :subscription
2592
+ sig {
2593
+ 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
2594
+ }
2595
+ def initialize(
2596
+ car_rental: nil,
2597
+ event_details: nil,
2598
+ flight: nil,
2599
+ lodging: nil,
2600
+ subscription: nil
2601
+ ); end
2602
+ end
2603
+ class Shipping < Stripe::RequestParams
2604
+ class Address < Stripe::RequestParams
2605
+ # City, district, suburb, town, or village.
2606
+ sig { returns(String) }
2607
+ attr_accessor :city
2608
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2609
+ sig { returns(String) }
2610
+ attr_accessor :country
2611
+ # Address line 1 (e.g., street, PO Box, or company name).
2612
+ sig { returns(String) }
2613
+ attr_accessor :line1
2614
+ # Address line 2 (e.g., apartment, suite, unit, or building).
2615
+ sig { returns(String) }
2616
+ attr_accessor :line2
2617
+ # ZIP or postal code.
2618
+ sig { returns(String) }
2619
+ attr_accessor :postal_code
2620
+ # State, county, province, or region.
2621
+ sig { returns(String) }
2622
+ attr_accessor :state
2623
+ sig {
2624
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2625
+ }
2626
+ def initialize(
2627
+ city: nil,
2628
+ country: nil,
2629
+ line1: nil,
2630
+ line2: nil,
2631
+ postal_code: nil,
2632
+ state: nil
2633
+ ); end
2634
+ end
2635
+ # Shipping address.
2636
+ sig { returns(::Stripe::Charge::UpdateParams::Shipping::Address) }
2637
+ attr_accessor :address
2638
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
2639
+ sig { returns(String) }
2640
+ attr_accessor :carrier
2641
+ # Recipient name.
2642
+ sig { returns(String) }
2643
+ attr_accessor :name
2644
+ # Recipient phone (including extension).
2645
+ sig { returns(String) }
2646
+ attr_accessor :phone
2647
+ # 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.
2648
+ sig { returns(String) }
2649
+ attr_accessor :tracking_number
2650
+ sig {
2651
+ params(address: ::Stripe::Charge::UpdateParams::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
2652
+ }
2653
+ def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
2654
+ end
2655
+ # 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.
2656
+ sig { returns(String) }
2657
+ attr_accessor :customer
2658
+ # 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.
2659
+ sig { returns(String) }
2660
+ attr_accessor :description
2661
+ # Specifies which fields in the response should be expanded.
2662
+ sig { returns(T::Array[String]) }
2663
+ attr_accessor :expand
2664
+ # 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.
2665
+ sig { returns(::Stripe::Charge::UpdateParams::FraudDetails) }
2666
+ attr_accessor :fraud_details
2667
+ # 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`.
2668
+ sig { returns(T.nilable(T::Hash[String, String])) }
2669
+ attr_accessor :metadata
2670
+ # Provides industry-specific information about the charge.
2671
+ sig { returns(::Stripe::Charge::UpdateParams::PaymentDetails) }
2672
+ attr_accessor :payment_details
2673
+ # 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.
2674
+ sig { returns(String) }
2675
+ attr_accessor :receipt_email
2676
+ # Shipping information for the charge. Helps prevent fraud on charges for physical goods.
2677
+ sig { returns(::Stripe::Charge::UpdateParams::Shipping) }
2678
+ attr_accessor :shipping
2679
+ # 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.
2680
+ sig { returns(String) }
2681
+ attr_accessor :transfer_group
2682
+ sig {
2683
+ 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
2684
+ }
2685
+ def initialize(
2686
+ customer: nil,
2687
+ description: nil,
2688
+ expand: nil,
2689
+ fraud_details: nil,
2690
+ metadata: nil,
2691
+ payment_details: nil,
2692
+ receipt_email: nil,
2693
+ shipping: nil,
2694
+ transfer_group: nil
2695
+ ); end
2696
+ end
2697
+ class SearchParams < Stripe::RequestParams
2698
+ # Specifies which fields in the response should be expanded.
2699
+ sig { returns(T::Array[String]) }
2700
+ attr_accessor :expand
2701
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
2702
+ sig { returns(Integer) }
2703
+ attr_accessor :limit
2704
+ # 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.
2705
+ sig { returns(String) }
2706
+ attr_accessor :page
2707
+ # 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).
2708
+ sig { returns(String) }
2709
+ attr_accessor :query
2710
+ sig { params(expand: T::Array[String], limit: Integer, page: String, query: String).void }
2711
+ def initialize(expand: nil, limit: nil, page: nil, query: nil); end
2712
+ end
2713
+ class CaptureParams < Stripe::RequestParams
2714
+ class PaymentDetails < Stripe::RequestParams
2715
+ class CarRental < Stripe::RequestParams
2716
+ class Affiliate < Stripe::RequestParams
2717
+ # The name of the affiliate that originated the purchase.
2718
+ sig { returns(String) }
2719
+ attr_accessor :name
2720
+ sig { params(name: String).void }
2721
+ def initialize(name: nil); end
2722
+ end
2723
+ class Delivery < Stripe::RequestParams
2724
+ class Recipient < Stripe::RequestParams
2725
+ # The email of the recipient the ticket is delivered to.
2726
+ sig { returns(String) }
2727
+ attr_accessor :email
2728
+ # The name of the recipient the ticket is delivered to.
2729
+ sig { returns(String) }
2730
+ attr_accessor :name
2731
+ # The phone number of the recipient the ticket is delivered to.
2732
+ sig { returns(String) }
2733
+ attr_accessor :phone
2734
+ sig { params(email: String, name: String, phone: String).void }
2735
+ def initialize(email: nil, name: nil, phone: nil); end
2736
+ end
2737
+ # The delivery method for the payment
2738
+ sig { returns(String) }
2739
+ attr_accessor :mode
2740
+ # Details of the recipient.
2741
+ sig {
2742
+ returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient)
2743
+ }
2744
+ attr_accessor :recipient
2745
+ sig {
2746
+ params(mode: String, recipient: ::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery::Recipient).void
2747
+ }
2748
+ def initialize(mode: nil, recipient: nil); end
2749
+ end
2750
+ class Driver < Stripe::RequestParams
2751
+ # Full name of the person or entity on the car reservation.
2752
+ sig { returns(String) }
2753
+ attr_accessor :name
2754
+ sig { params(name: String).void }
2755
+ def initialize(name: nil); end
2756
+ end
2757
+ class PickupAddress < Stripe::RequestParams
2758
+ # City, district, suburb, town, or village.
2759
+ sig { returns(String) }
2760
+ attr_accessor :city
2761
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2762
+ sig { returns(String) }
2763
+ attr_accessor :country
2764
+ # Address line 1 (e.g., street, PO Box, or company name).
2765
+ sig { returns(String) }
2766
+ attr_accessor :line1
2767
+ # Address line 2 (e.g., apartment, suite, unit, or building).
2768
+ sig { returns(String) }
2769
+ attr_accessor :line2
2770
+ # ZIP or postal code.
2771
+ sig { returns(String) }
2772
+ attr_accessor :postal_code
2773
+ # State, county, province, or region.
2774
+ sig { returns(String) }
2775
+ attr_accessor :state
2776
+ sig {
2777
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2778
+ }
2779
+ def initialize(
2780
+ city: nil,
2781
+ country: nil,
2782
+ line1: nil,
2783
+ line2: nil,
2784
+ postal_code: nil,
2785
+ state: nil
2786
+ ); end
2787
+ end
2788
+ class ReturnAddress < Stripe::RequestParams
2789
+ # City, district, suburb, town, or village.
2790
+ sig { returns(String) }
2791
+ attr_accessor :city
2792
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2793
+ sig { returns(String) }
2794
+ attr_accessor :country
2795
+ # Address line 1 (e.g., street, PO Box, or company name).
2796
+ sig { returns(String) }
2797
+ attr_accessor :line1
2798
+ # Address line 2 (e.g., apartment, suite, unit, or building).
2799
+ sig { returns(String) }
2800
+ attr_accessor :line2
2801
+ # ZIP or postal code.
2802
+ sig { returns(String) }
2803
+ attr_accessor :postal_code
2804
+ # State, county, province, or region.
2805
+ sig { returns(String) }
2806
+ attr_accessor :state
2807
+ sig {
2808
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2809
+ }
2810
+ def initialize(
2811
+ city: nil,
2812
+ country: nil,
2813
+ line1: nil,
2814
+ line2: nil,
2815
+ postal_code: nil,
2816
+ state: nil
2817
+ ); end
2818
+ end
2819
+ # Affiliate details for this purchase.
2820
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Affiliate) }
2821
+ attr_accessor :affiliate
2822
+ # The booking number associated with the car rental.
2823
+ sig { returns(String) }
2824
+ attr_accessor :booking_number
2825
+ # Class code of the car.
2826
+ sig { returns(String) }
2827
+ attr_accessor :car_class_code
2828
+ # Make of the car.
2829
+ sig { returns(String) }
2830
+ attr_accessor :car_make
2831
+ # Model of the car.
2832
+ sig { returns(String) }
2833
+ attr_accessor :car_model
2834
+ # The name of the rental car company.
2835
+ sig { returns(String) }
2836
+ attr_accessor :company
2837
+ # The customer service phone number of the car rental company.
2838
+ sig { returns(String) }
2839
+ attr_accessor :customer_service_phone_number
2840
+ # Number of days the car is being rented.
2841
+ sig { returns(Integer) }
2842
+ attr_accessor :days_rented
2843
+ # Delivery details for this purchase.
2844
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Delivery) }
2845
+ attr_accessor :delivery
2846
+ # The details of the passengers in the travel reservation
2847
+ sig {
2848
+ returns(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::Driver])
2849
+ }
2850
+ attr_accessor :drivers
2851
+ # List of additional charges being billed.
2852
+ sig { returns(T::Array[String]) }
2853
+ attr_accessor :extra_charges
2854
+ # Indicates if the customer did not keep nor cancel their booking.
2855
+ sig { returns(T::Boolean) }
2856
+ attr_accessor :no_show
2857
+ # Car pick-up address.
2858
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::PickupAddress) }
2859
+ attr_accessor :pickup_address
2860
+ # Car pick-up time. Measured in seconds since the Unix epoch.
2861
+ sig { returns(Integer) }
2862
+ attr_accessor :pickup_at
2863
+ # Rental rate.
2864
+ sig { returns(Integer) }
2865
+ attr_accessor :rate_amount
2866
+ # The frequency at which the rate amount is applied. One of `day`, `week` or `month`
2867
+ sig { returns(String) }
2868
+ attr_accessor :rate_interval
2869
+ # The name of the person or entity renting the car.
2870
+ sig { returns(String) }
2871
+ attr_accessor :renter_name
2872
+ # Car return address.
2873
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental::ReturnAddress) }
2874
+ attr_accessor :return_address
2875
+ # Car return time. Measured in seconds since the Unix epoch.
2876
+ sig { returns(Integer) }
2877
+ attr_accessor :return_at
2878
+ # Indicates whether the goods or services are tax-exempt or tax is not collected.
2879
+ sig { returns(T::Boolean) }
2880
+ attr_accessor :tax_exempt
2881
+ sig {
2882
+ 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
2883
+ }
2884
+ def initialize(
2885
+ affiliate: nil,
2886
+ booking_number: nil,
2887
+ car_class_code: nil,
2888
+ car_make: nil,
2889
+ car_model: nil,
2890
+ company: nil,
2891
+ customer_service_phone_number: nil,
2892
+ days_rented: nil,
2893
+ delivery: nil,
2894
+ drivers: nil,
2895
+ extra_charges: nil,
2896
+ no_show: nil,
2897
+ pickup_address: nil,
2898
+ pickup_at: nil,
2899
+ rate_amount: nil,
2900
+ rate_interval: nil,
2901
+ renter_name: nil,
2902
+ return_address: nil,
2903
+ return_at: nil,
2904
+ tax_exempt: nil
2905
+ ); end
2906
+ end
2907
+ class EventDetails < Stripe::RequestParams
2908
+ class Address < Stripe::RequestParams
2909
+ # City, district, suburb, town, or village.
2910
+ sig { returns(String) }
2911
+ attr_accessor :city
2912
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2913
+ sig { returns(String) }
2914
+ attr_accessor :country
2915
+ # Address line 1 (e.g., street, PO Box, or company name).
2916
+ sig { returns(String) }
2917
+ attr_accessor :line1
2918
+ # Address line 2 (e.g., apartment, suite, unit, or building).
2919
+ sig { returns(String) }
2920
+ attr_accessor :line2
2921
+ # ZIP or postal code.
2922
+ sig { returns(String) }
2923
+ attr_accessor :postal_code
2924
+ # State, county, province, or region.
2925
+ sig { returns(String) }
2926
+ attr_accessor :state
2927
+ sig {
2928
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2929
+ }
2930
+ def initialize(
2931
+ city: nil,
2932
+ country: nil,
2933
+ line1: nil,
2934
+ line2: nil,
2935
+ postal_code: nil,
2936
+ state: nil
2937
+ ); end
2938
+ end
2939
+ class Affiliate < Stripe::RequestParams
2940
+ # The name of the affiliate that originated the purchase.
2941
+ sig { returns(String) }
2942
+ attr_accessor :name
2943
+ sig { params(name: String).void }
2944
+ def initialize(name: nil); end
2945
+ end
2946
+ class Delivery < Stripe::RequestParams
2947
+ class Recipient < Stripe::RequestParams
2948
+ # The email of the recipient the ticket is delivered to.
2949
+ sig { returns(String) }
2950
+ attr_accessor :email
2951
+ # The name of the recipient the ticket is delivered to.
2952
+ sig { returns(String) }
2953
+ attr_accessor :name
2954
+ # The phone number of the recipient the ticket is delivered to.
2955
+ sig { returns(String) }
2956
+ attr_accessor :phone
2957
+ sig { params(email: String, name: String, phone: String).void }
2958
+ def initialize(email: nil, name: nil, phone: nil); end
2959
+ end
2960
+ # The delivery method for the payment
2961
+ sig { returns(String) }
2962
+ attr_accessor :mode
2963
+ # Details of the recipient.
2964
+ sig {
2965
+ returns(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient)
2966
+ }
2967
+ attr_accessor :recipient
2968
+ sig {
2969
+ params(mode: String, recipient: ::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery::Recipient).void
2970
+ }
2971
+ def initialize(mode: nil, recipient: nil); end
2972
+ end
2973
+ # Indicates if the tickets are digitally checked when entering the venue.
2974
+ sig { returns(T::Boolean) }
2975
+ attr_accessor :access_controlled_venue
2976
+ # The event location's address.
2977
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Address) }
2978
+ attr_accessor :address
2979
+ # Affiliate details for this purchase.
2980
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Affiliate) }
2981
+ attr_accessor :affiliate
2982
+ # The name of the company
2983
+ sig { returns(String) }
2984
+ attr_accessor :company
2985
+ # Delivery details for this purchase.
2986
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails::Delivery) }
2987
+ attr_accessor :delivery
2988
+ # Event end time. Measured in seconds since the Unix epoch.
2989
+ sig { returns(Integer) }
2990
+ attr_accessor :ends_at
2991
+ # Type of the event entertainment (concert, sports event etc)
2992
+ sig { returns(String) }
2993
+ attr_accessor :genre
2994
+ # The name of the event.
2995
+ sig { returns(String) }
2996
+ attr_accessor :name
2997
+ # Event start time. Measured in seconds since the Unix epoch.
2998
+ sig { returns(Integer) }
2999
+ attr_accessor :starts_at
3000
+ sig {
3001
+ 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
3002
+ }
3003
+ def initialize(
3004
+ access_controlled_venue: nil,
3005
+ address: nil,
3006
+ affiliate: nil,
3007
+ company: nil,
3008
+ delivery: nil,
3009
+ ends_at: nil,
3010
+ genre: nil,
3011
+ name: nil,
3012
+ starts_at: nil
3013
+ ); end
3014
+ end
3015
+ class Flight < Stripe::RequestParams
3016
+ class Affiliate < Stripe::RequestParams
3017
+ # The name of the affiliate that originated the purchase.
3018
+ sig { returns(String) }
3019
+ attr_accessor :name
3020
+ sig { params(name: String).void }
3021
+ def initialize(name: nil); end
3022
+ end
3023
+ class Delivery < Stripe::RequestParams
3024
+ class Recipient < Stripe::RequestParams
3025
+ # The email of the recipient the ticket is delivered to.
3026
+ sig { returns(String) }
3027
+ attr_accessor :email
3028
+ # The name of the recipient the ticket is delivered to.
3029
+ sig { returns(String) }
3030
+ attr_accessor :name
3031
+ # The phone number of the recipient the ticket is delivered to.
3032
+ sig { returns(String) }
3033
+ attr_accessor :phone
3034
+ sig { params(email: String, name: String, phone: String).void }
3035
+ def initialize(email: nil, name: nil, phone: nil); end
3036
+ end
3037
+ # The delivery method for the payment
3038
+ sig { returns(String) }
3039
+ attr_accessor :mode
3040
+ # Details of the recipient.
3041
+ sig {
3042
+ returns(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery::Recipient)
3043
+ }
3044
+ attr_accessor :recipient
3045
+ sig {
3046
+ params(mode: String, recipient: ::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery::Recipient).void
3047
+ }
3048
+ def initialize(mode: nil, recipient: nil); end
3049
+ end
3050
+ class Passenger < Stripe::RequestParams
3051
+ # Full name of the person or entity on the flight reservation.
3052
+ sig { returns(String) }
3053
+ attr_accessor :name
3054
+ sig { params(name: String).void }
3055
+ def initialize(name: nil); end
3056
+ end
3057
+ class Segment < Stripe::RequestParams
3058
+ # The flight segment amount.
3059
+ sig { returns(Integer) }
3060
+ attr_accessor :amount
3061
+ # The International Air Transport Association (IATA) airport code for the arrival airport.
3062
+ sig { returns(String) }
3063
+ attr_accessor :arrival_airport
3064
+ # The arrival time for the flight segment. Measured in seconds since the Unix epoch.
3065
+ sig { returns(Integer) }
3066
+ attr_accessor :arrives_at
3067
+ # The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
3068
+ sig { returns(String) }
3069
+ attr_accessor :carrier
3070
+ # The departure time for the flight segment. Measured in seconds since the Unix epoch.
3071
+ sig { returns(Integer) }
3072
+ attr_accessor :departs_at
3073
+ # The International Air Transport Association (IATA) airport code for the departure airport.
3074
+ sig { returns(String) }
3075
+ attr_accessor :departure_airport
3076
+ # The flight number associated with the segment
3077
+ sig { returns(String) }
3078
+ attr_accessor :flight_number
3079
+ # The fare class for the segment.
3080
+ sig { returns(String) }
3081
+ attr_accessor :service_class
3082
+ sig {
3083
+ params(amount: Integer, arrival_airport: String, arrives_at: Integer, carrier: String, departs_at: Integer, departure_airport: String, flight_number: String, service_class: String).void
3084
+ }
3085
+ def initialize(
3086
+ amount: nil,
3087
+ arrival_airport: nil,
3088
+ arrives_at: nil,
3089
+ carrier: nil,
3090
+ departs_at: nil,
3091
+ departure_airport: nil,
3092
+ flight_number: nil,
3093
+ service_class: nil
3094
+ ); end
3095
+ end
3096
+ # Affiliate details for this purchase.
3097
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Affiliate) }
3098
+ attr_accessor :affiliate
3099
+ # The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
3100
+ sig { returns(String) }
3101
+ attr_accessor :agency_number
3102
+ # The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
3103
+ sig { returns(String) }
3104
+ attr_accessor :carrier
3105
+ # Delivery details for this purchase.
3106
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Delivery) }
3107
+ attr_accessor :delivery
3108
+ # The name of the person or entity on the reservation.
3109
+ sig { returns(String) }
3110
+ attr_accessor :passenger_name
3111
+ # The details of the passengers in the travel reservation.
3112
+ sig {
3113
+ returns(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Passenger])
3114
+ }
3115
+ attr_accessor :passengers
3116
+ # The individual flight segments associated with the trip.
3117
+ sig {
3118
+ returns(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Flight::Segment])
3119
+ }
3120
+ attr_accessor :segments
3121
+ # The ticket number associated with the travel reservation.
3122
+ sig { returns(String) }
3123
+ attr_accessor :ticket_number
3124
+ sig {
3125
+ 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
3126
+ }
3127
+ def initialize(
3128
+ affiliate: nil,
3129
+ agency_number: nil,
3130
+ carrier: nil,
3131
+ delivery: nil,
3132
+ passenger_name: nil,
3133
+ passengers: nil,
3134
+ segments: nil,
3135
+ ticket_number: nil
3136
+ ); end
3137
+ end
3138
+ class Lodging < Stripe::RequestParams
3139
+ class Address < Stripe::RequestParams
3140
+ # City, district, suburb, town, or village.
3141
+ sig { returns(String) }
3142
+ attr_accessor :city
3143
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3144
+ sig { returns(String) }
3145
+ attr_accessor :country
3146
+ # Address line 1 (e.g., street, PO Box, or company name).
3147
+ sig { returns(String) }
3148
+ attr_accessor :line1
3149
+ # Address line 2 (e.g., apartment, suite, unit, or building).
3150
+ sig { returns(String) }
3151
+ attr_accessor :line2
3152
+ # ZIP or postal code.
3153
+ sig { returns(String) }
3154
+ attr_accessor :postal_code
3155
+ # State, county, province, or region.
3156
+ sig { returns(String) }
3157
+ attr_accessor :state
3158
+ sig {
3159
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
3160
+ }
3161
+ def initialize(
3162
+ city: nil,
3163
+ country: nil,
3164
+ line1: nil,
3165
+ line2: nil,
3166
+ postal_code: nil,
3167
+ state: nil
3168
+ ); end
3169
+ end
3170
+ class Affiliate < Stripe::RequestParams
3171
+ # The name of the affiliate that originated the purchase.
3172
+ sig { returns(String) }
3173
+ attr_accessor :name
3174
+ sig { params(name: String).void }
3175
+ def initialize(name: nil); end
3176
+ end
3177
+ class Delivery < Stripe::RequestParams
3178
+ class Recipient < Stripe::RequestParams
3179
+ # The email of the recipient the ticket is delivered to.
3180
+ sig { returns(String) }
3181
+ attr_accessor :email
3182
+ # The name of the recipient the ticket is delivered to.
3183
+ sig { returns(String) }
3184
+ attr_accessor :name
3185
+ # The phone number of the recipient the ticket is delivered to.
3186
+ sig { returns(String) }
3187
+ attr_accessor :phone
3188
+ sig { params(email: String, name: String, phone: String).void }
3189
+ def initialize(email: nil, name: nil, phone: nil); end
3190
+ end
3191
+ # The delivery method for the payment
3192
+ sig { returns(String) }
3193
+ attr_accessor :mode
3194
+ # Details of the recipient.
3195
+ sig {
3196
+ returns(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient)
3197
+ }
3198
+ attr_accessor :recipient
3199
+ sig {
3200
+ params(mode: String, recipient: ::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery::Recipient).void
3201
+ }
3202
+ def initialize(mode: nil, recipient: nil); end
3203
+ end
3204
+ class Passenger < Stripe::RequestParams
3205
+ # Full name of the person or entity on the lodging reservation.
3206
+ sig { returns(String) }
3207
+ attr_accessor :name
3208
+ sig { params(name: String).void }
3209
+ def initialize(name: nil); end
3210
+ end
3211
+ # The lodging location's address.
3212
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Address) }
3213
+ attr_accessor :address
3214
+ # The number of adults on the booking
3215
+ sig { returns(Integer) }
3216
+ attr_accessor :adults
3217
+ # Affiliate details for this purchase.
3218
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Affiliate) }
3219
+ attr_accessor :affiliate
3220
+ # The booking number associated with the lodging reservation.
3221
+ sig { returns(String) }
3222
+ attr_accessor :booking_number
3223
+ # The lodging category
3224
+ sig { returns(String) }
3225
+ attr_accessor :category
3226
+ # Loding check-in time. Measured in seconds since the Unix epoch.
3227
+ sig { returns(Integer) }
3228
+ attr_accessor :checkin_at
3229
+ # Lodging check-out time. Measured in seconds since the Unix epoch.
3230
+ sig { returns(Integer) }
3231
+ attr_accessor :checkout_at
3232
+ # The customer service phone number of the lodging company.
3233
+ sig { returns(String) }
3234
+ attr_accessor :customer_service_phone_number
3235
+ # The daily lodging room rate.
3236
+ sig { returns(Integer) }
3237
+ attr_accessor :daily_room_rate_amount
3238
+ # Delivery details for this purchase.
3239
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Delivery) }
3240
+ attr_accessor :delivery
3241
+ # List of additional charges being billed.
3242
+ sig { returns(T::Array[String]) }
3243
+ attr_accessor :extra_charges
3244
+ # Indicates whether the lodging location is compliant with the Fire Safety Act.
3245
+ sig { returns(T::Boolean) }
3246
+ attr_accessor :fire_safety_act_compliance
3247
+ # The name of the lodging location.
3248
+ sig { returns(String) }
3249
+ attr_accessor :name
3250
+ # Indicates if the customer did not keep their booking while failing to cancel the reservation.
3251
+ sig { returns(T::Boolean) }
3252
+ attr_accessor :no_show
3253
+ # The number of rooms on the booking
3254
+ sig { returns(Integer) }
3255
+ attr_accessor :number_of_rooms
3256
+ # The details of the passengers in the travel reservation
3257
+ sig {
3258
+ returns(T::Array[::Stripe::Charge::CaptureParams::PaymentDetails::Lodging::Passenger])
3259
+ }
3260
+ attr_accessor :passengers
3261
+ # The phone number of the lodging location.
3262
+ sig { returns(String) }
3263
+ attr_accessor :property_phone_number
3264
+ # The room class for this purchase.
3265
+ sig { returns(String) }
3266
+ attr_accessor :room_class
3267
+ # The number of room nights
3268
+ sig { returns(Integer) }
3269
+ attr_accessor :room_nights
3270
+ # The total tax amount associating with the room reservation.
3271
+ sig { returns(Integer) }
3272
+ attr_accessor :total_room_tax_amount
3273
+ # The total tax amount
3274
+ sig { returns(Integer) }
3275
+ attr_accessor :total_tax_amount
3276
+ sig {
3277
+ 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
3278
+ }
3279
+ def initialize(
3280
+ address: nil,
3281
+ adults: nil,
3282
+ affiliate: nil,
3283
+ booking_number: nil,
3284
+ category: nil,
3285
+ checkin_at: nil,
3286
+ checkout_at: nil,
3287
+ customer_service_phone_number: nil,
3288
+ daily_room_rate_amount: nil,
3289
+ delivery: nil,
3290
+ extra_charges: nil,
3291
+ fire_safety_act_compliance: nil,
3292
+ name: nil,
3293
+ no_show: nil,
3294
+ number_of_rooms: nil,
3295
+ passengers: nil,
3296
+ property_phone_number: nil,
3297
+ room_class: nil,
3298
+ room_nights: nil,
3299
+ total_room_tax_amount: nil,
3300
+ total_tax_amount: nil
3301
+ ); end
3302
+ end
3303
+ class Subscription < Stripe::RequestParams
3304
+ class Affiliate < Stripe::RequestParams
3305
+ # The name of the affiliate that originated the purchase.
3306
+ sig { returns(String) }
3307
+ attr_accessor :name
3308
+ sig { params(name: String).void }
3309
+ def initialize(name: nil); end
3310
+ end
3311
+ class BillingInterval < Stripe::RequestParams
3312
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3313
+ sig { returns(Integer) }
3314
+ attr_accessor :count
3315
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3316
+ sig { returns(String) }
3317
+ attr_accessor :interval
3318
+ sig { params(count: Integer, interval: String).void }
3319
+ def initialize(count: nil, interval: nil); end
3320
+ end
3321
+ # Affiliate details for this purchase.
3322
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::Affiliate) }
3323
+ attr_accessor :affiliate
3324
+ # Info whether the subscription will be auto renewed upon expiry.
3325
+ sig { returns(T::Boolean) }
3326
+ attr_accessor :auto_renewal
3327
+ # Subscription billing details for this purchase.
3328
+ sig {
3329
+ returns(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription::BillingInterval)
3330
+ }
3331
+ attr_accessor :billing_interval
3332
+ # Subscription end time. Measured in seconds since the Unix epoch.
3333
+ sig { returns(Integer) }
3334
+ attr_accessor :ends_at
3335
+ # Name of the product on subscription. e.g. Apple Music Subscription
3336
+ sig { returns(String) }
3337
+ attr_accessor :name
3338
+ # Subscription start time. Measured in seconds since the Unix epoch.
3339
+ sig { returns(Integer) }
3340
+ attr_accessor :starts_at
3341
+ sig {
3342
+ 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
3343
+ }
3344
+ def initialize(
3345
+ affiliate: nil,
3346
+ auto_renewal: nil,
3347
+ billing_interval: nil,
3348
+ ends_at: nil,
3349
+ name: nil,
3350
+ starts_at: nil
3351
+ ); end
3352
+ end
3353
+ # Car rental details for this PaymentIntent.
3354
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::CarRental) }
3355
+ attr_accessor :car_rental
3356
+ # Event details for this PaymentIntent
3357
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::EventDetails) }
3358
+ attr_accessor :event_details
3359
+ # Flight reservation details for this PaymentIntent
3360
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Flight) }
3361
+ attr_accessor :flight
3362
+ # Lodging reservation details for this PaymentIntent
3363
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Lodging) }
3364
+ attr_accessor :lodging
3365
+ # Subscription details for this PaymentIntent
3366
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails::Subscription) }
3367
+ attr_accessor :subscription
3368
+ sig {
3369
+ 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
3370
+ }
3371
+ def initialize(
3372
+ car_rental: nil,
3373
+ event_details: nil,
3374
+ flight: nil,
3375
+ lodging: nil,
3376
+ subscription: nil
3377
+ ); end
3378
+ end
3379
+ class TransferData < Stripe::RequestParams
3380
+ # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
3381
+ sig { returns(Integer) }
3382
+ attr_accessor :amount
3383
+ sig { params(amount: Integer).void }
3384
+ def initialize(amount: nil); end
3385
+ end
3386
+ # The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.
3387
+ sig { returns(Integer) }
3388
+ attr_accessor :amount
3389
+ # An application fee to add on to this charge.
3390
+ sig { returns(Integer) }
3391
+ attr_accessor :application_fee
3392
+ # An application fee amount to add on to this charge, which must be less than or equal to the original amount.
3393
+ sig { returns(Integer) }
3394
+ attr_accessor :application_fee_amount
3395
+ # Specifies which fields in the response should be expanded.
3396
+ sig { returns(T::Array[String]) }
3397
+ attr_accessor :expand
3398
+ # Provides industry-specific information about the charge.
3399
+ sig { returns(::Stripe::Charge::CaptureParams::PaymentDetails) }
3400
+ attr_accessor :payment_details
3401
+ # 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.
3402
+ sig { returns(String) }
3403
+ attr_accessor :receipt_email
3404
+ # 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).
3405
+ #
3406
+ # 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.
3407
+ sig { returns(String) }
3408
+ attr_accessor :statement_descriptor
3409
+ # 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.
3410
+ sig { returns(String) }
3411
+ attr_accessor :statement_descriptor_suffix
3412
+ # 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.
3413
+ sig { returns(::Stripe::Charge::CaptureParams::TransferData) }
3414
+ attr_accessor :transfer_data
3415
+ # 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.
3416
+ sig { returns(String) }
3417
+ attr_accessor :transfer_group
3418
+ sig {
3419
+ 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
3420
+ }
3421
+ def initialize(
3422
+ amount: nil,
3423
+ application_fee: nil,
3424
+ application_fee_amount: nil,
3425
+ expand: nil,
3426
+ payment_details: nil,
3427
+ receipt_email: nil,
3428
+ statement_descriptor: nil,
3429
+ statement_descriptor_suffix: nil,
3430
+ transfer_data: nil,
3431
+ transfer_group: nil
3432
+ ); end
3433
+ end
3434
+ # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
3435
+ #
3436
+ # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
3437
+ #
3438
+ # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
3439
+ sig {
3440
+ params(params: T.any(::Stripe::Charge::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
3441
+ }
3442
+ def capture(params = {}, opts = {}); end
3443
+
3444
+ # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
3445
+ #
3446
+ # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
3447
+ #
3448
+ # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
3449
+ sig {
3450
+ params(charge: String, params: T.any(::Stripe::Charge::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
3451
+ }
3452
+ def self.capture(charge, params = {}, opts = {}); end
3453
+
3454
+ # This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents)
3455
+ # to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
3456
+ # object used to request payment.
3457
+ sig {
3458
+ params(params: T.any(::Stripe::Charge::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
3459
+ }
3460
+ def self.create(params = {}, opts = {}); end
3461
+
3462
+ # Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.
3463
+ sig {
3464
+ params(params: T.any(::Stripe::Charge::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
3465
+ }
3466
+ def self.list(params = {}, opts = {}); end
3467
+
3468
+ sig {
3469
+ params(params: T.any(::Stripe::Charge::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
3470
+ }
3471
+ def self.search(params = {}, opts = {}); end
3472
+
3473
+ sig {
3474
+ params(params: T.any(::Stripe::Charge::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
3475
+ }
3476
+ def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
3477
+
3478
+ # Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
3479
+ sig {
3480
+ params(id: String, params: T.any(::Stripe::Charge::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
3481
+ }
3482
+ def self.update(id, params = {}, opts = {}); end
3483
+ end
3484
+ end