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