stripe 13.4.1 → 13.5.0.pre.beta.1

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