stripe 15.1.0.pre.beta.2 → 15.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (597) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +696 -1554
  3. data/OPENAPI_VERSION +1 -1
  4. data/README.md +6 -0
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_requestor.rb +0 -28
  7. data/lib/stripe/api_version.rb +1 -1
  8. data/lib/stripe/errors.rb +0 -54
  9. data/lib/stripe/event_types.rb +1 -75
  10. data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb +1 -1
  11. data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb +1 -1
  12. data/lib/stripe/events/{v2_core_account_including_identity_updated_event.rb → v2_core_event_destination_ping_event.rb} +3 -3
  13. data/lib/stripe/object_types.rb +0 -53
  14. data/lib/stripe/resources/account.rb +3 -655
  15. data/lib/stripe/resources/account_session.rb +1 -299
  16. data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -2
  17. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -4
  18. data/lib/stripe/resources/billing/credit_grant.rb +0 -10
  19. data/lib/stripe/resources/billing_portal/session.rb +0 -6
  20. data/lib/stripe/resources/card.rb +0 -2
  21. data/lib/stripe/resources/cash_balance.rb +0 -2
  22. data/lib/stripe/resources/charge.rb +0 -1470
  23. data/lib/stripe/resources/checkout/session.rb +3 -327
  24. data/lib/stripe/resources/confirmation_token.rb +3 -177
  25. data/lib/stripe/resources/coupon.rb +1 -30
  26. data/lib/stripe/resources/credit_note.rb +0 -10
  27. data/lib/stripe/resources/credit_note_line_item.rb +0 -9
  28. data/lib/stripe/resources/customer.rb +2 -4
  29. data/lib/stripe/resources/customer_balance_transaction.rb +0 -2
  30. data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -2
  31. data/lib/stripe/resources/customer_session.rb +1 -6
  32. data/lib/stripe/resources/discount.rb +0 -2
  33. data/lib/stripe/resources/event.rb +0 -31
  34. data/lib/stripe/resources/financial_connections/account.rb +1 -20
  35. data/lib/stripe/resources/financial_connections/session.rb +2 -62
  36. data/lib/stripe/resources/identity/verification_session.rb +0 -10
  37. data/lib/stripe/resources/invoice.rb +17 -1123
  38. data/lib/stripe/resources/invoice_item.rb +2 -78
  39. data/lib/stripe/resources/invoice_line_item.rb +1 -55
  40. data/lib/stripe/resources/invoice_payment.rb +53 -2
  41. data/lib/stripe/resources/issuing/cardholder.rb +1 -2
  42. data/lib/stripe/resources/issuing/transaction.rb +0 -6
  43. data/lib/stripe/resources/line_item.rb +0 -37
  44. data/lib/stripe/resources/mandate.rb +0 -24
  45. data/lib/stripe/resources/payment_intent.rb +331 -5153
  46. data/lib/stripe/resources/payment_method.rb +1 -196
  47. data/lib/stripe/resources/payment_method_configuration.rb +0 -295
  48. data/lib/stripe/resources/payout.rb +0 -6
  49. data/lib/stripe/resources/price.rb +0 -30
  50. data/lib/stripe/resources/product.rb +0 -59
  51. data/lib/stripe/resources/promotion_code.rb +0 -10
  52. data/lib/stripe/resources/quote.rb +6 -2040
  53. data/lib/stripe/resources/refund.rb +0 -9
  54. data/lib/stripe/resources/setup_attempt.rb +0 -21
  55. data/lib/stripe/resources/setup_intent.rb +9 -596
  56. data/lib/stripe/resources/source.rb +0 -29
  57. data/lib/stripe/resources/subscription.rb +11 -294
  58. data/lib/stripe/resources/subscription_item.rb +3 -84
  59. data/lib/stripe/resources/subscription_schedule.rb +10 -1007
  60. data/lib/stripe/resources/tax/calculation.rb +2 -2
  61. data/lib/stripe/resources/tax/registration.rb +60 -0
  62. data/lib/stripe/resources/tax/transaction.rb +1 -1
  63. data/lib/stripe/resources/tax_id.rb +4 -14
  64. data/lib/stripe/resources/terminal/reader.rb +0 -406
  65. data/lib/stripe/resources/transfer.rb +0 -6
  66. data/lib/stripe/resources/treasury/financial_account.rb +3 -22
  67. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
  68. data/lib/stripe/resources/treasury/outbound_payment.rb +1 -4
  69. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -37
  70. data/lib/stripe/resources/treasury/received_credit.rb +1 -38
  71. data/lib/stripe/resources/treasury/received_debit.rb +1 -40
  72. data/lib/stripe/resources/v2/billing/meter_event.rb +2 -2
  73. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +2 -2
  74. data/lib/stripe/resources/v2/billing/meter_event_session.rb +2 -2
  75. data/lib/stripe/resources/v2/event.rb +2 -2
  76. data/lib/stripe/resources/v2/event_destination.rb +2 -2
  77. data/lib/stripe/resources.rb +1 -90
  78. data/lib/stripe/services/account_external_account_service.rb +1 -1
  79. data/lib/stripe/services/account_service.rb +3 -564
  80. data/lib/stripe/services/account_session_service.rb +1 -269
  81. data/lib/stripe/services/billing/credit_balance_summary_service.rb +1 -4
  82. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -4
  83. data/lib/stripe/services/billing/credit_grant_service.rb +0 -8
  84. data/lib/stripe/services/billing_portal/session_service.rb +0 -4
  85. data/lib/stripe/services/charge_service.rb +0 -1350
  86. data/lib/stripe/services/checkout/session_service.rb +2 -243
  87. data/lib/stripe/services/coupon_service.rb +1 -17
  88. data/lib/stripe/services/credit_note_service.rb +0 -4
  89. data/lib/stripe/services/customer_payment_method_service.rb +1 -1
  90. data/lib/stripe/services/customer_service.rb +1 -1
  91. data/lib/stripe/services/customer_session_service.rb +1 -4
  92. data/lib/stripe/services/customer_tax_id_service.rb +1 -1
  93. data/lib/stripe/services/financial_connections/account_service.rb +2 -7
  94. data/lib/stripe/services/financial_connections/session_service.rb +2 -34
  95. data/lib/stripe/services/financial_connections_service.rb +1 -2
  96. data/lib/stripe/services/identity/verification_session_service.rb +0 -8
  97. data/lib/stripe/services/invoice_item_service.rb +2 -74
  98. data/lib/stripe/services/invoice_line_item_service.rb +1 -33
  99. data/lib/stripe/services/invoice_payment_service.rb +83 -0
  100. data/lib/stripe/services/invoice_service.rb +16 -1052
  101. data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
  102. data/lib/stripe/services/issuing/transaction_service.rb +0 -4
  103. data/lib/stripe/services/issuing_service.rb +1 -5
  104. data/lib/stripe/services/payment_intent_service.rb +283 -4656
  105. data/lib/stripe/services/payment_method_configuration_service.rb +0 -210
  106. data/lib/stripe/services/payment_method_service.rb +1 -126
  107. data/lib/stripe/services/payout_service.rb +0 -4
  108. data/lib/stripe/services/price_service.rb +0 -19
  109. data/lib/stripe/services/product_service.rb +0 -38
  110. data/lib/stripe/services/promotion_code_service.rb +0 -8
  111. data/lib/stripe/services/quote_service.rb +7 -1726
  112. data/lib/stripe/services/setup_intent_service.rb +9 -556
  113. data/lib/stripe/services/subscription_item_service.rb +3 -75
  114. data/lib/stripe/services/subscription_schedule_service.rb +10 -911
  115. data/lib/stripe/services/subscription_service.rb +10 -254
  116. data/lib/stripe/services/tax/calculation_service.rb +1 -1
  117. data/lib/stripe/services/tax/registration_service.rb +39 -0
  118. data/lib/stripe/services/tax_id_service.rb +3 -9
  119. data/lib/stripe/services/tax_service.rb +1 -3
  120. data/lib/stripe/services/terminal/reader_service.rb +0 -180
  121. data/lib/stripe/services/terminal_service.rb +1 -2
  122. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +3 -106
  123. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -43
  124. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
  125. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
  126. data/lib/stripe/services/transfer_service.rb +0 -4
  127. data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
  128. data/lib/stripe/services/treasury/financial_account_service.rb +2 -16
  129. data/lib/stripe/services/treasury/outbound_payment_service.rb +1 -4
  130. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
  131. data/lib/stripe/services/v1_services.rb +2 -12
  132. data/lib/stripe/services/v2/core_service.rb +1 -4
  133. data/lib/stripe/services/v2_services.rb +2 -4
  134. data/lib/stripe/services.rb +1 -54
  135. data/lib/stripe/stripe_configuration.rb +1 -3
  136. data/lib/stripe/stripe_object.rb +1 -1
  137. data/lib/stripe/util.rb +1 -7
  138. data/lib/stripe/version.rb +1 -1
  139. data/lib/stripe.rb +0 -53
  140. data/rbi/stripe/resources/account.rbi +4903 -0
  141. data/rbi/stripe/resources/account_link.rbi +74 -0
  142. data/rbi/stripe/resources/account_session.rbi +894 -0
  143. data/rbi/stripe/resources/apple_pay_domain.rbi +90 -0
  144. data/rbi/stripe/resources/application.rbi +20 -0
  145. data/rbi/stripe/resources/application_fee.rbi +118 -0
  146. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  147. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  148. data/rbi/stripe/resources/balance.rbi +180 -0
  149. data/rbi/stripe/resources/balance_transaction.rbi +144 -0
  150. data/rbi/stripe/resources/bank_account.rbi +127 -0
  151. data/rbi/stripe/resources/billing/alert.rbi +201 -0
  152. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  153. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
  154. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
  155. data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
  156. data/rbi/stripe/resources/billing/meter.rbi +226 -0
  157. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  158. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  159. data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
  160. data/rbi/stripe/resources/billing_portal/configuration.rbi +645 -0
  161. data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
  162. data/rbi/stripe/resources/capability.rbi +125 -0
  163. data/rbi/stripe/resources/card.rbi +125 -0
  164. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  165. data/rbi/stripe/resources/charge.rbi +2057 -0
  166. data/rbi/stripe/resources/checkout/session.rbi +3988 -0
  167. data/rbi/stripe/resources/climate/order.rbi +245 -0
  168. data/rbi/stripe/resources/climate/product.rbi +75 -0
  169. data/rbi/stripe/resources/climate/supplier.rbi +72 -0
  170. data/rbi/stripe/resources/confirmation_token.rbi +1873 -0
  171. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  172. data/rbi/stripe/resources/country_spec.rbi +85 -0
  173. data/rbi/stripe/resources/coupon.rbi +252 -0
  174. data/rbi/stripe/resources/credit_note.rbi +747 -0
  175. data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
  176. data/rbi/stripe/resources/customer.rbi +1009 -0
  177. data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
  178. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  179. data/rbi/stripe/resources/customer_session.rbi +200 -0
  180. data/rbi/stripe/resources/discount.rbi +53 -0
  181. data/rbi/stripe/resources/dispute.rbi +761 -0
  182. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
  183. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  184. data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
  185. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  186. data/rbi/stripe/resources/event.rbi +149 -0
  187. data/rbi/stripe/resources/exchange_rate.rbi +66 -0
  188. data/rbi/stripe/resources/file.rbi +143 -0
  189. data/rbi/stripe/resources/file_link.rbi +141 -0
  190. data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
  191. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  192. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  193. data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
  194. data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
  195. data/rbi/stripe/resources/forwarding/request.rbi +216 -0
  196. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  197. data/rbi/stripe/resources/identity/verification_report.rbi +351 -0
  198. data/rbi/stripe/resources/identity/verification_session.rbi +517 -0
  199. data/rbi/stripe/resources/invoice.rbi +3736 -0
  200. data/rbi/stripe/resources/invoice_item.rbi +475 -0
  201. data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
  202. data/rbi/stripe/resources/invoice_payment.rbi +114 -0
  203. data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
  204. data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
  205. data/rbi/stripe/resources/issuing/card.rbi +741 -0
  206. data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
  207. data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
  208. data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
  209. data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
  210. data/rbi/stripe/resources/issuing/token.rbi +226 -0
  211. data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
  212. data/rbi/stripe/resources/line_item.rbi +72 -0
  213. data/rbi/stripe/resources/login_link.rbi +19 -0
  214. data/rbi/stripe/resources/mandate.rbi +187 -0
  215. data/rbi/stripe/resources/payment_intent.rbi +9795 -0
  216. data/rbi/stripe/resources/payment_link.rbi +1801 -0
  217. data/rbi/stripe/resources/payment_method.rbi +1831 -0
  218. data/rbi/stripe/resources/payment_method_configuration.rbi +3220 -0
  219. data/rbi/stripe/resources/payment_method_domain.rbi +228 -0
  220. data/rbi/stripe/resources/payout.rbi +300 -0
  221. data/rbi/stripe/resources/person.rbi +401 -0
  222. data/rbi/stripe/resources/plan.rbi +373 -0
  223. data/rbi/stripe/resources/price.rbi +694 -0
  224. data/rbi/stripe/resources/product.rbi +557 -0
  225. data/rbi/stripe/resources/product_feature.rbi +26 -0
  226. data/rbi/stripe/resources/promotion_code.rbi +261 -0
  227. data/rbi/stripe/resources/quote.rbi +1126 -0
  228. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
  229. data/rbi/stripe/resources/radar/value_list.rbi +170 -0
  230. data/rbi/stripe/resources/radar/value_list_item.rbi +131 -0
  231. data/rbi/stripe/resources/refund.rbi +519 -0
  232. data/rbi/stripe/resources/reporting/report_run.rbi +191 -0
  233. data/rbi/stripe/resources/reporting/report_type.rbi +57 -0
  234. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  235. data/rbi/stripe/resources/reversal.rbi +51 -0
  236. data/rbi/stripe/resources/review.rbi +154 -0
  237. data/rbi/stripe/resources/setup_attempt.rbi +477 -0
  238. data/rbi/stripe/resources/setup_intent.rbi +3869 -0
  239. data/rbi/stripe/resources/shipping_rate.rbi +305 -0
  240. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +75 -0
  241. data/rbi/stripe/resources/source.rbi +1496 -0
  242. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  243. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  244. data/rbi/stripe/resources/subscription.rbi +1964 -0
  245. data/rbi/stripe/resources/subscription_item.rbi +370 -0
  246. data/rbi/stripe/resources/subscription_schedule.rbi +1495 -0
  247. data/rbi/stripe/resources/tax/calculation.rbi +474 -0
  248. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  249. data/rbi/stripe/resources/tax/registration.rbi +2713 -0
  250. data/rbi/stripe/resources/tax/settings.rbi +141 -0
  251. data/rbi/stripe/resources/tax/transaction.rbi +351 -0
  252. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  253. data/rbi/stripe/resources/tax_code.rbi +44 -0
  254. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  255. data/rbi/stripe/resources/tax_id.rbi +167 -0
  256. data/rbi/stripe/resources/tax_rate.rbi +239 -0
  257. data/rbi/stripe/resources/terminal/configuration.rbi +1388 -0
  258. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  259. data/rbi/stripe/resources/terminal/location.rbi +224 -0
  260. data/rbi/stripe/resources/terminal/reader.rbi +587 -0
  261. data/rbi/stripe/resources/test_helpers/test_clock.rbi +134 -0
  262. data/rbi/stripe/resources/token.rbi +1283 -0
  263. data/rbi/stripe/resources/topup.rbi +222 -0
  264. data/rbi/stripe/resources/transfer.rbi +199 -0
  265. data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
  266. data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
  267. data/rbi/stripe/resources/treasury/financial_account.rbi +865 -0
  268. data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
  269. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
  270. data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
  271. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
  272. data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
  273. data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
  274. data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
  275. data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
  276. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  277. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  278. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  279. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  280. data/rbi/stripe/resources/v2/event.rbi +48 -0
  281. data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
  282. data/rbi/stripe/resources/webhook_endpoint.rbi +170 -0
  283. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  284. data/{lib/stripe/services/external_account_service.rb → rbi/stripe/services/account_external_account_service.rbi} +124 -136
  285. data/rbi/stripe/services/account_link_service.rbi +58 -0
  286. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  287. data/rbi/stripe/services/account_person_service.rbi +1013 -0
  288. data/rbi/stripe/services/account_service.rbi +4189 -0
  289. data/rbi/stripe/services/account_session_service.rbi +572 -0
  290. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  291. data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
  292. data/rbi/stripe/services/application_fee_service.rbi +78 -0
  293. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  294. data/rbi/stripe/services/apps_service.rbi +9 -0
  295. data/rbi/stripe/services/balance_service.rbi +21 -0
  296. data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
  297. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  298. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
  299. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  300. data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
  301. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
  302. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  303. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  304. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  305. data/rbi/stripe/services/billing_portal/configuration_service.rbi +511 -0
  306. data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
  307. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  308. data/rbi/stripe/services/billing_service.rbi +15 -0
  309. data/rbi/stripe/services/charge_service.rbi +448 -0
  310. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  311. data/rbi/stripe/services/checkout/session_service.rbi +2607 -0
  312. data/rbi/stripe/services/checkout_service.rbi +9 -0
  313. data/rbi/stripe/services/climate/order_service.rbi +142 -0
  314. data/{lib/stripe/services/financial_connections/institution_service.rb → rbi/stripe/services/climate/product_service.rbi} +25 -36
  315. data/{lib/stripe/services/privacy/redaction_job_validation_error_service.rb → rbi/stripe/services/climate/supplier_service.rbi} +25 -36
  316. data/rbi/stripe/services/climate_service.rbi +11 -0
  317. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  318. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  319. data/rbi/stripe/services/coupon_service.rbi +196 -0
  320. data/{lib/stripe/services/quote_preview_invoice_service.rb → rbi/stripe/services/credit_note_line_item_service.rbi} +16 -20
  321. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  322. data/rbi/stripe/services/credit_note_service.rbi +416 -0
  323. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  324. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  325. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  326. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  327. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  328. data/rbi/stripe/services/customer_payment_source_service.rbi +232 -0
  329. data/rbi/stripe/services/customer_service.rbi +651 -0
  330. data/rbi/stripe/services/customer_session_service.rbi +116 -0
  331. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  332. data/rbi/stripe/services/dispute_service.rbi +424 -0
  333. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  334. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  335. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  336. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  337. data/rbi/stripe/services/event_service.rbi +83 -0
  338. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  339. data/rbi/stripe/services/file_link_service.rbi +124 -0
  340. data/rbi/stripe/services/file_service.rbi +116 -0
  341. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  342. data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
  343. data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
  344. data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
  345. data/rbi/stripe/services/financial_connections_service.rbi +11 -0
  346. data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
  347. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  348. data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
  349. data/rbi/stripe/services/identity/verification_session_service.rbi +323 -0
  350. data/rbi/stripe/services/identity_service.rbi +10 -0
  351. data/rbi/stripe/services/invoice_item_service.rbi +368 -0
  352. data/rbi/stripe/services/invoice_line_item_service.rbi +259 -0
  353. data/rbi/stripe/services/invoice_payment_service.rbi +71 -0
  354. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  355. data/rbi/stripe/services/invoice_service.rbi +2920 -0
  356. data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
  357. data/rbi/stripe/services/issuing/card_service.rbi +495 -0
  358. data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
  359. data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
  360. data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
  361. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  362. data/rbi/stripe/services/issuing/token_service.rbi +99 -0
  363. data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
  364. data/rbi/stripe/services/issuing_service.rbi +16 -0
  365. data/rbi/stripe/services/mandate_service.rbi +20 -0
  366. data/rbi/stripe/services/payment_intent_service.rbi +7819 -0
  367. data/{lib/stripe/services/payment_intent_amount_details_line_item_service.rb → rbi/stripe/services/payment_link_line_item_service.rbi} +16 -20
  368. data/rbi/stripe/services/payment_link_service.rbi +1352 -0
  369. data/rbi/stripe/services/payment_method_configuration_service.rbi +2255 -0
  370. data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
  371. data/rbi/stripe/services/payment_method_service.rbi +846 -0
  372. data/rbi/stripe/services/payout_service.rbi +205 -0
  373. data/rbi/stripe/services/plan_service.rbi +284 -0
  374. data/rbi/stripe/services/price_service.rbi +546 -0
  375. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  376. data/rbi/stripe/services/product_service.rbi +479 -0
  377. data/rbi/stripe/services/promotion_code_service.rbi +214 -0
  378. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  379. data/{lib/stripe/services/order_line_item_service.rb → rbi/stripe/services/quote_line_item_service.rbi} +16 -20
  380. data/rbi/stripe/services/quote_service.rbi +686 -0
  381. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
  382. data/rbi/stripe/services/radar/value_list_item_service.rbi +111 -0
  383. data/rbi/stripe/services/radar/value_list_service.rbi +143 -0
  384. data/rbi/stripe/services/radar_service.rbi +11 -0
  385. data/rbi/stripe/services/refund_service.rbi +185 -0
  386. data/rbi/stripe/services/reporting/report_run_service.rbi +135 -0
  387. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  388. data/rbi/stripe/services/reporting_service.rbi +10 -0
  389. data/rbi/stripe/services/review_service.rbi +84 -0
  390. data/rbi/stripe/services/setup_attempt_service.rbi +65 -0
  391. data/rbi/stripe/services/setup_intent_service.rbi +3605 -0
  392. data/rbi/stripe/services/shipping_rate_service.rbi +241 -0
  393. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  394. data/rbi/stripe/services/sigma_service.rbi +9 -0
  395. data/rbi/stripe/services/source_service.rbi +663 -0
  396. data/{lib/stripe/services/quote_line_service.rb → rbi/stripe/services/source_transaction_service.rbi} +16 -20
  397. data/rbi/stripe/services/subscription_item_service.rbi +324 -0
  398. data/rbi/stripe/services/subscription_schedule_service.rbi +1192 -0
  399. data/rbi/stripe/services/subscription_service.rbi +1596 -0
  400. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  401. data/rbi/stripe/services/tax/calculation_service.rbi +230 -0
  402. data/rbi/stripe/services/tax/registration_service.rbi +1845 -0
  403. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  404. data/{lib/stripe/services/financial_connections/account_inferred_balance_service.rb → rbi/stripe/services/tax/transaction_line_item_service.rbi} +17 -21
  405. data/rbi/stripe/services/tax/transaction_service.rbi +146 -0
  406. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  407. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  408. data/rbi/stripe/services/tax_rate_service.rbi +185 -0
  409. data/rbi/stripe/services/tax_service.rbi +12 -0
  410. data/rbi/stripe/services/terminal/configuration_service.rbi +1120 -0
  411. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  412. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  413. data/rbi/stripe/services/terminal/reader_service.rbi +344 -0
  414. data/rbi/stripe/services/terminal_service.rbi +12 -0
  415. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +805 -0
  416. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  417. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +848 -0
  418. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  419. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +69 -0
  420. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +711 -0
  421. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  422. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  423. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  424. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  425. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +92 -0
  426. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  427. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
  428. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
  429. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
  430. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
  431. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  432. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  433. data/rbi/stripe/services/token_service.rbi +1257 -0
  434. data/rbi/stripe/services/topup_service.rbi +176 -0
  435. data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
  436. data/rbi/stripe/services/transfer_service.rbi +152 -0
  437. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  438. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  439. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
  440. data/rbi/stripe/services/treasury/financial_account_service.rbi +562 -0
  441. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  442. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
  443. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
  444. data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
  445. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  446. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
  447. data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
  448. data/rbi/stripe/services/treasury_service.rbi +18 -0
  449. data/rbi/stripe/services/v1_services.rbi +77 -0
  450. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  451. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  452. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  453. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  454. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  455. data/rbi/stripe/services/v2/core/event_destination_service.rbi +200 -0
  456. data/rbi/stripe/services/v2/core/event_service.rbi +38 -0
  457. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  458. data/rbi/stripe/services/v2_services.rbi +10 -0
  459. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  460. data/stripe.gemspec +1 -4
  461. metadata +326 -149
  462. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +0 -23
  463. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +0 -21
  464. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +0 -23
  465. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +0 -21
  466. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +0 -23
  467. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +0 -21
  468. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +0 -21
  469. data/lib/stripe/events/v2_core_account_link_completed_event.rb +0 -13
  470. data/lib/stripe/events/v2_core_account_person_created_event.rb +0 -23
  471. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +0 -23
  472. data/lib/stripe/events/v2_core_account_person_updated_event.rb +0 -23
  473. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +0 -21
  474. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +0 -21
  475. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +0 -21
  476. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +0 -23
  477. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +0 -21
  478. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +0 -21
  479. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +0 -21
  480. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +0 -21
  481. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +0 -21
  482. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +0 -21
  483. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +0 -21
  484. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +0 -21
  485. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +0 -21
  486. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +0 -21
  487. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -21
  488. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -21
  489. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -21
  490. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -21
  491. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -21
  492. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +0 -23
  493. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +0 -21
  494. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +0 -21
  495. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +0 -21
  496. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -21
  497. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -21
  498. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -21
  499. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -21
  500. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -21
  501. data/lib/stripe/resources/account_notice.rb +0 -123
  502. data/lib/stripe/resources/balance_settings.rb +0 -105
  503. data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
  504. data/lib/stripe/resources/capital/financing_offer.rb +0 -179
  505. data/lib/stripe/resources/capital/financing_summary.rb +0 -55
  506. data/lib/stripe/resources/capital/financing_transaction.rb +0 -114
  507. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  508. data/lib/stripe/resources/financial_connections/institution.rb +0 -90
  509. data/lib/stripe/resources/fx_quote.rb +0 -184
  510. data/lib/stripe/resources/gift_cards/card.rb +0 -208
  511. data/lib/stripe/resources/gift_cards/transaction.rb +0 -272
  512. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -602
  513. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -82
  514. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -86
  515. data/lib/stripe/resources/issuing/settlement.rb +0 -53
  516. data/lib/stripe/resources/margin.rb +0 -115
  517. data/lib/stripe/resources/order.rb +0 -2859
  518. data/lib/stripe/resources/payment_attempt_record.rb +0 -1078
  519. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +0 -65
  520. data/lib/stripe/resources/payment_record.rb +0 -1607
  521. data/lib/stripe/resources/privacy/redaction_job.rb +0 -254
  522. data/lib/stripe/resources/privacy/redaction_job_root_objects.rb +0 -35
  523. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -25
  524. data/lib/stripe/resources/quote_line.rb +0 -274
  525. data/lib/stripe/resources/quote_preview_invoice.rb +0 -663
  526. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -337
  527. data/lib/stripe/resources/tax/association.rb +0 -89
  528. data/lib/stripe/resources/tax/form.rb +0 -211
  529. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -31
  530. data/lib/stripe/resources/v2/core/account.rb +0 -1715
  531. data/lib/stripe/resources/v2/core/account_link.rb +0 -54
  532. data/lib/stripe/resources/v2/core/person.rb +0 -272
  533. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -72
  534. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -37
  535. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -18
  536. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -20
  537. data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -49
  538. data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -56
  539. data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -66
  540. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -92
  541. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -127
  542. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -74
  543. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -43
  544. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -115
  545. data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -73
  546. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -47
  547. data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -134
  548. data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -106
  549. data/lib/stripe/resources/v2/money_management/transaction.rb +0 -76
  550. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -66
  551. data/lib/stripe/services/account_notice_service.rb +0 -101
  552. data/lib/stripe/services/balance_settings_service.rb +0 -96
  553. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  554. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  555. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  556. data/lib/stripe/services/capital_service.rb +0 -15
  557. data/lib/stripe/services/fx_quote_service.rb +0 -123
  558. data/lib/stripe/services/gift_cards/card_service.rb +0 -170
  559. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
  560. data/lib/stripe/services/gift_cards_service.rb +0 -14
  561. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  562. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  563. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  564. data/lib/stripe/services/margin_service.rb +0 -119
  565. data/lib/stripe/services/order_service.rb +0 -2268
  566. data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
  567. data/lib/stripe/services/payment_record_service.rb +0 -542
  568. data/lib/stripe/services/privacy/redaction_job_service.rb +0 -231
  569. data/lib/stripe/services/privacy_service.rb +0 -13
  570. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
  571. data/lib/stripe/services/tax/association_service.rb +0 -31
  572. data/lib/stripe/services/tax/form_service.rb +0 -100
  573. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  574. data/lib/stripe/services/v2/core/account_link_service.rb +0 -76
  575. data/lib/stripe/services/v2/core/account_service.rb +0 -4130
  576. data/lib/stripe/services/v2/core/accounts/person_service.rb +0 -1040
  577. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -135
  578. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -109
  579. data/lib/stripe/services/v2/core/vault_service.rb +0 -18
  580. data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -75
  581. data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -44
  582. data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -81
  583. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -126
  584. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -80
  585. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -202
  586. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -237
  587. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -174
  588. data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -95
  589. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -32
  590. data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -71
  591. data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -44
  592. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -70
  593. data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -74
  594. data/lib/stripe/services/v2/money_management_service.rb +0 -31
  595. data/lib/stripe/services/v2/test_helper_service.rb +0 -15
  596. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -50
  597. data/rbi/stripe.rbi +0 -191592
@@ -0,0 +1,1283 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ # Tokenization is the process Stripe uses to collect sensitive card or bank
7
+ # account details, or personally identifiable information (PII), directly from
8
+ # your customers in a secure manner. A token representing this information is
9
+ # returned to your server to use. Use our
10
+ # [recommended payments integrations](https://stripe.com/docs/payments) to perform this process
11
+ # on the client-side. This guarantees that no sensitive card data touches your server,
12
+ # and allows your integration to operate in a PCI-compliant way.
13
+ #
14
+ # If you can't use client-side tokenization, you can also create tokens using
15
+ # the API with either your publishable or secret API key. If
16
+ # your integration uses this method, you're responsible for any PCI compliance
17
+ # that it might require, and you must keep your secret API key safe. Unlike with
18
+ # client-side tokenization, your customer's information isn't sent directly to
19
+ # Stripe, so we can't determine how it's handled or stored.
20
+ #
21
+ # You can't store or use tokens more than once. To store card or bank account
22
+ # information for later use, create [Customer](https://stripe.com/docs/api#customers)
23
+ # objects or [External accounts](https://stripe.com/api#external_accounts).
24
+ # [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,
25
+ # performs best with integrations that use client-side tokenization.
26
+ class Token < APIResource
27
+ # These bank accounts are payment methods on `Customer` objects.
28
+ #
29
+ # On the other hand [External Accounts](/api#external_accounts) are transfer
30
+ # destinations on `Account` objects for connected accounts.
31
+ # They can be bank accounts or debit cards as well, and are documented in the links above.
32
+ #
33
+ # Related guide: [Bank debits and transfers](/payments/bank-debits-transfers)
34
+ sig { returns(Stripe::BankAccount) }
35
+ attr_reader :bank_account
36
+ # You can store multiple cards on a customer in order to charge the customer
37
+ # later. You can also store multiple debit cards on a recipient in order to
38
+ # transfer to those cards later.
39
+ #
40
+ # Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
41
+ sig { returns(Stripe::Card) }
42
+ attr_reader :card
43
+ # IP address of the client that generates the token.
44
+ sig { returns(T.nilable(String)) }
45
+ attr_reader :client_ip
46
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
47
+ sig { returns(Integer) }
48
+ attr_reader :created
49
+ # Unique identifier for the object.
50
+ sig { returns(String) }
51
+ attr_reader :id
52
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
53
+ sig { returns(T::Boolean) }
54
+ attr_reader :livemode
55
+ # String representing the object's type. Objects of the same type share the same value.
56
+ sig { returns(String) }
57
+ attr_reader :object
58
+ # Type of the token: `account`, `bank_account`, `card`, or `pii`.
59
+ sig { returns(String) }
60
+ attr_reader :type
61
+ # Determines if you have already used this token (you can only use tokens once).
62
+ sig { returns(T::Boolean) }
63
+ attr_reader :used
64
+ class CreateParams < Stripe::RequestParams
65
+ class Account < Stripe::RequestParams
66
+ class Company < Stripe::RequestParams
67
+ class Address < Stripe::RequestParams
68
+ # City, district, suburb, town, or village.
69
+ sig { returns(T.nilable(String)) }
70
+ attr_accessor :city
71
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
72
+ sig { returns(T.nilable(String)) }
73
+ attr_accessor :country
74
+ # Address line 1 (e.g., street, PO Box, or company name).
75
+ sig { returns(T.nilable(String)) }
76
+ attr_accessor :line1
77
+ # Address line 2 (e.g., apartment, suite, unit, or building).
78
+ sig { returns(T.nilable(String)) }
79
+ attr_accessor :line2
80
+ # ZIP or postal code.
81
+ sig { returns(T.nilable(String)) }
82
+ attr_accessor :postal_code
83
+ # State, county, province, or region.
84
+ sig { returns(T.nilable(String)) }
85
+ attr_accessor :state
86
+ sig {
87
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
88
+ }
89
+ def initialize(
90
+ city: nil,
91
+ country: nil,
92
+ line1: nil,
93
+ line2: nil,
94
+ postal_code: nil,
95
+ state: nil
96
+ ); end
97
+ end
98
+ class AddressKana < Stripe::RequestParams
99
+ # City or ward.
100
+ sig { returns(T.nilable(String)) }
101
+ attr_accessor :city
102
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
103
+ sig { returns(T.nilable(String)) }
104
+ attr_accessor :country
105
+ # Block or building number.
106
+ sig { returns(T.nilable(String)) }
107
+ attr_accessor :line1
108
+ # Building details.
109
+ sig { returns(T.nilable(String)) }
110
+ attr_accessor :line2
111
+ # Postal code.
112
+ sig { returns(T.nilable(String)) }
113
+ attr_accessor :postal_code
114
+ # Prefecture.
115
+ sig { returns(T.nilable(String)) }
116
+ attr_accessor :state
117
+ # Town or cho-me.
118
+ sig { returns(T.nilable(String)) }
119
+ attr_accessor :town
120
+ sig {
121
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
122
+ }
123
+ def initialize(
124
+ city: nil,
125
+ country: nil,
126
+ line1: nil,
127
+ line2: nil,
128
+ postal_code: nil,
129
+ state: nil,
130
+ town: nil
131
+ ); end
132
+ end
133
+ class AddressKanji < Stripe::RequestParams
134
+ # City or ward.
135
+ sig { returns(T.nilable(String)) }
136
+ attr_accessor :city
137
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
138
+ sig { returns(T.nilable(String)) }
139
+ attr_accessor :country
140
+ # Block or building number.
141
+ sig { returns(T.nilable(String)) }
142
+ attr_accessor :line1
143
+ # Building details.
144
+ sig { returns(T.nilable(String)) }
145
+ attr_accessor :line2
146
+ # Postal code.
147
+ sig { returns(T.nilable(String)) }
148
+ attr_accessor :postal_code
149
+ # Prefecture.
150
+ sig { returns(T.nilable(String)) }
151
+ attr_accessor :state
152
+ # Town or cho-me.
153
+ sig { returns(T.nilable(String)) }
154
+ attr_accessor :town
155
+ sig {
156
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
157
+ }
158
+ def initialize(
159
+ city: nil,
160
+ country: nil,
161
+ line1: nil,
162
+ line2: nil,
163
+ postal_code: nil,
164
+ state: nil,
165
+ town: nil
166
+ ); end
167
+ end
168
+ class DirectorshipDeclaration < Stripe::RequestParams
169
+ # The Unix timestamp marking when the directorship declaration attestation was made.
170
+ sig { returns(T.nilable(Integer)) }
171
+ attr_accessor :date
172
+ # The IP address from which the directorship declaration attestation was made.
173
+ sig { returns(T.nilable(String)) }
174
+ attr_accessor :ip
175
+ # The user agent of the browser from which the directorship declaration attestation was made.
176
+ sig { returns(T.nilable(String)) }
177
+ attr_accessor :user_agent
178
+ sig {
179
+ params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
180
+ }
181
+ def initialize(date: nil, ip: nil, user_agent: nil); end
182
+ end
183
+ class OwnershipDeclaration < Stripe::RequestParams
184
+ # The Unix timestamp marking when the beneficial owner attestation was made.
185
+ sig { returns(T.nilable(Integer)) }
186
+ attr_accessor :date
187
+ # The IP address from which the beneficial owner attestation was made.
188
+ sig { returns(T.nilable(String)) }
189
+ attr_accessor :ip
190
+ # The user agent of the browser from which the beneficial owner attestation was made.
191
+ sig { returns(T.nilable(String)) }
192
+ attr_accessor :user_agent
193
+ sig {
194
+ params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
195
+ }
196
+ def initialize(date: nil, ip: nil, user_agent: nil); end
197
+ end
198
+ class RegistrationDate < Stripe::RequestParams
199
+ # The day of registration, between 1 and 31.
200
+ sig { returns(Integer) }
201
+ attr_accessor :day
202
+ # The month of registration, between 1 and 12.
203
+ sig { returns(Integer) }
204
+ attr_accessor :month
205
+ # The four-digit year of registration.
206
+ sig { returns(Integer) }
207
+ attr_accessor :year
208
+ sig { params(day: Integer, month: Integer, year: Integer).void }
209
+ def initialize(day: nil, month: nil, year: nil); end
210
+ end
211
+ class Verification < Stripe::RequestParams
212
+ class Document < Stripe::RequestParams
213
+ # The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
214
+ sig { returns(T.nilable(String)) }
215
+ attr_accessor :back
216
+ # The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
217
+ sig { returns(T.nilable(String)) }
218
+ attr_accessor :front
219
+ sig { params(back: T.nilable(String), front: T.nilable(String)).void }
220
+ def initialize(back: nil, front: nil); end
221
+ end
222
+ # A document verifying the business.
223
+ sig {
224
+ returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification::Document))
225
+ }
226
+ attr_accessor :document
227
+ sig {
228
+ params(document: T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification::Document)).void
229
+ }
230
+ def initialize(document: nil); end
231
+ end
232
+ # The company's primary address.
233
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::Address)) }
234
+ attr_accessor :address
235
+ # The Kana variation of the company's primary address (Japan only).
236
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKana)) }
237
+ attr_accessor :address_kana
238
+ # The Kanji variation of the company's primary address (Japan only).
239
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKanji)) }
240
+ attr_accessor :address_kanji
241
+ # Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
242
+ sig { returns(T.nilable(T::Boolean)) }
243
+ attr_accessor :directors_provided
244
+ # This hash is used to attest that the directors information provided to Stripe is both current and correct.
245
+ sig {
246
+ returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::DirectorshipDeclaration))
247
+ }
248
+ attr_accessor :directorship_declaration
249
+ # Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.
250
+ sig { returns(T.nilable(T::Boolean)) }
251
+ attr_accessor :executives_provided
252
+ # The export license ID number of the company, also referred as Import Export Code (India only).
253
+ sig { returns(T.nilable(String)) }
254
+ attr_accessor :export_license_id
255
+ # The purpose code to use for export transactions (India only).
256
+ sig { returns(T.nilable(String)) }
257
+ attr_accessor :export_purpose_code
258
+ # The company's legal name.
259
+ sig { returns(T.nilable(String)) }
260
+ attr_accessor :name
261
+ # The Kana variation of the company's legal name (Japan only).
262
+ sig { returns(T.nilable(String)) }
263
+ attr_accessor :name_kana
264
+ # The Kanji variation of the company's legal name (Japan only).
265
+ sig { returns(T.nilable(String)) }
266
+ attr_accessor :name_kanji
267
+ # Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.
268
+ sig { returns(T.nilable(T::Boolean)) }
269
+ attr_accessor :owners_provided
270
+ # This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
271
+ sig {
272
+ returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::OwnershipDeclaration))
273
+ }
274
+ attr_accessor :ownership_declaration
275
+ # Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.
276
+ sig { returns(T.nilable(T::Boolean)) }
277
+ attr_accessor :ownership_declaration_shown_and_signed
278
+ # This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
279
+ sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
280
+ attr_accessor :ownership_exemption_reason
281
+ # The company's phone number (used for verification).
282
+ sig { returns(T.nilable(String)) }
283
+ attr_accessor :phone
284
+ # Attribute for param field registration_date
285
+ sig {
286
+ returns(T.nilable(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Company::RegistrationDate))))
287
+ }
288
+ attr_accessor :registration_date
289
+ # The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
290
+ sig { returns(T.nilable(String)) }
291
+ attr_accessor :registration_number
292
+ # The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
293
+ sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
294
+ attr_accessor :structure
295
+ # The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
296
+ sig { returns(T.nilable(String)) }
297
+ attr_accessor :tax_id
298
+ # The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
299
+ sig { returns(T.nilable(String)) }
300
+ attr_accessor :tax_id_registrar
301
+ # The VAT number of the company.
302
+ sig { returns(T.nilable(String)) }
303
+ attr_accessor :vat_id
304
+ # Information on the verification state of the company.
305
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification)) }
306
+ attr_accessor :verification
307
+ sig {
308
+ params(address: T.nilable(::Stripe::Token::CreateParams::Account::Company::Address), address_kana: T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKana), address_kanji: T.nilable(::Stripe::Token::CreateParams::Account::Company::AddressKanji), directors_provided: T.nilable(T::Boolean), directorship_declaration: T.nilable(::Stripe::Token::CreateParams::Account::Company::DirectorshipDeclaration), executives_provided: T.nilable(T::Boolean), export_license_id: T.nilable(String), export_purpose_code: T.nilable(String), name: T.nilable(String), name_kana: T.nilable(String), name_kanji: T.nilable(String), owners_provided: T.nilable(T::Boolean), ownership_declaration: T.nilable(::Stripe::Token::CreateParams::Account::Company::OwnershipDeclaration), ownership_declaration_shown_and_signed: T.nilable(T::Boolean), ownership_exemption_reason: T.nilable(T.nilable(T.any(String, String))), phone: T.nilable(String), registration_date: T.nilable(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Company::RegistrationDate))), registration_number: T.nilable(String), structure: T.nilable(T.nilable(T.any(String, String))), tax_id: T.nilable(String), tax_id_registrar: T.nilable(String), vat_id: T.nilable(String), verification: T.nilable(::Stripe::Token::CreateParams::Account::Company::Verification)).void
309
+ }
310
+ def initialize(
311
+ address: nil,
312
+ address_kana: nil,
313
+ address_kanji: nil,
314
+ directors_provided: nil,
315
+ directorship_declaration: nil,
316
+ executives_provided: nil,
317
+ export_license_id: nil,
318
+ export_purpose_code: nil,
319
+ name: nil,
320
+ name_kana: nil,
321
+ name_kanji: nil,
322
+ owners_provided: nil,
323
+ ownership_declaration: nil,
324
+ ownership_declaration_shown_and_signed: nil,
325
+ ownership_exemption_reason: nil,
326
+ phone: nil,
327
+ registration_date: nil,
328
+ registration_number: nil,
329
+ structure: nil,
330
+ tax_id: nil,
331
+ tax_id_registrar: nil,
332
+ vat_id: nil,
333
+ verification: nil
334
+ ); end
335
+ end
336
+ class Individual < Stripe::RequestParams
337
+ class Address < Stripe::RequestParams
338
+ # City, district, suburb, town, or village.
339
+ sig { returns(T.nilable(String)) }
340
+ attr_accessor :city
341
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
342
+ sig { returns(T.nilable(String)) }
343
+ attr_accessor :country
344
+ # Address line 1 (e.g., street, PO Box, or company name).
345
+ sig { returns(T.nilable(String)) }
346
+ attr_accessor :line1
347
+ # Address line 2 (e.g., apartment, suite, unit, or building).
348
+ sig { returns(T.nilable(String)) }
349
+ attr_accessor :line2
350
+ # ZIP or postal code.
351
+ sig { returns(T.nilable(String)) }
352
+ attr_accessor :postal_code
353
+ # State, county, province, or region.
354
+ sig { returns(T.nilable(String)) }
355
+ attr_accessor :state
356
+ sig {
357
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
358
+ }
359
+ def initialize(
360
+ city: nil,
361
+ country: nil,
362
+ line1: nil,
363
+ line2: nil,
364
+ postal_code: nil,
365
+ state: nil
366
+ ); end
367
+ end
368
+ class AddressKana < Stripe::RequestParams
369
+ # City or ward.
370
+ sig { returns(T.nilable(String)) }
371
+ attr_accessor :city
372
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
373
+ sig { returns(T.nilable(String)) }
374
+ attr_accessor :country
375
+ # Block or building number.
376
+ sig { returns(T.nilable(String)) }
377
+ attr_accessor :line1
378
+ # Building details.
379
+ sig { returns(T.nilable(String)) }
380
+ attr_accessor :line2
381
+ # Postal code.
382
+ sig { returns(T.nilable(String)) }
383
+ attr_accessor :postal_code
384
+ # Prefecture.
385
+ sig { returns(T.nilable(String)) }
386
+ attr_accessor :state
387
+ # Town or cho-me.
388
+ sig { returns(T.nilable(String)) }
389
+ attr_accessor :town
390
+ sig {
391
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
392
+ }
393
+ def initialize(
394
+ city: nil,
395
+ country: nil,
396
+ line1: nil,
397
+ line2: nil,
398
+ postal_code: nil,
399
+ state: nil,
400
+ town: nil
401
+ ); end
402
+ end
403
+ class AddressKanji < Stripe::RequestParams
404
+ # City or ward.
405
+ sig { returns(T.nilable(String)) }
406
+ attr_accessor :city
407
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
408
+ sig { returns(T.nilable(String)) }
409
+ attr_accessor :country
410
+ # Block or building number.
411
+ sig { returns(T.nilable(String)) }
412
+ attr_accessor :line1
413
+ # Building details.
414
+ sig { returns(T.nilable(String)) }
415
+ attr_accessor :line2
416
+ # Postal code.
417
+ sig { returns(T.nilable(String)) }
418
+ attr_accessor :postal_code
419
+ # Prefecture.
420
+ sig { returns(T.nilable(String)) }
421
+ attr_accessor :state
422
+ # Town or cho-me.
423
+ sig { returns(T.nilable(String)) }
424
+ attr_accessor :town
425
+ sig {
426
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
427
+ }
428
+ def initialize(
429
+ city: nil,
430
+ country: nil,
431
+ line1: nil,
432
+ line2: nil,
433
+ postal_code: nil,
434
+ state: nil,
435
+ town: nil
436
+ ); end
437
+ end
438
+ class Dob < Stripe::RequestParams
439
+ # The day of birth, between 1 and 31.
440
+ sig { returns(Integer) }
441
+ attr_accessor :day
442
+ # The month of birth, between 1 and 12.
443
+ sig { returns(Integer) }
444
+ attr_accessor :month
445
+ # The four-digit year of birth.
446
+ sig { returns(Integer) }
447
+ attr_accessor :year
448
+ sig { params(day: Integer, month: Integer, year: Integer).void }
449
+ def initialize(day: nil, month: nil, year: nil); end
450
+ end
451
+ class RegisteredAddress < Stripe::RequestParams
452
+ # City, district, suburb, town, or village.
453
+ sig { returns(T.nilable(String)) }
454
+ attr_accessor :city
455
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
456
+ sig { returns(T.nilable(String)) }
457
+ attr_accessor :country
458
+ # Address line 1 (e.g., street, PO Box, or company name).
459
+ sig { returns(T.nilable(String)) }
460
+ attr_accessor :line1
461
+ # Address line 2 (e.g., apartment, suite, unit, or building).
462
+ sig { returns(T.nilable(String)) }
463
+ attr_accessor :line2
464
+ # ZIP or postal code.
465
+ sig { returns(T.nilable(String)) }
466
+ attr_accessor :postal_code
467
+ # State, county, province, or region.
468
+ sig { returns(T.nilable(String)) }
469
+ attr_accessor :state
470
+ sig {
471
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
472
+ }
473
+ def initialize(
474
+ city: nil,
475
+ country: nil,
476
+ line1: nil,
477
+ line2: nil,
478
+ postal_code: nil,
479
+ state: nil
480
+ ); end
481
+ end
482
+ class Relationship < Stripe::RequestParams
483
+ # Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
484
+ sig { returns(T.nilable(T::Boolean)) }
485
+ attr_accessor :director
486
+ # Whether the person has significant responsibility to control, manage, or direct the organization.
487
+ sig { returns(T.nilable(T::Boolean)) }
488
+ attr_accessor :executive
489
+ # Whether the person is an owner of the account’s legal entity.
490
+ sig { returns(T.nilable(T::Boolean)) }
491
+ attr_accessor :owner
492
+ # The percent owned by the person of the account's legal entity.
493
+ sig { returns(T.nilable(T.nilable(T.any(String, Float)))) }
494
+ attr_accessor :percent_ownership
495
+ # The person's title (e.g., CEO, Support Engineer).
496
+ sig { returns(T.nilable(String)) }
497
+ attr_accessor :title
498
+ sig {
499
+ params(director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.nilable(T.any(String, Float))), title: T.nilable(String)).void
500
+ }
501
+ def initialize(
502
+ director: nil,
503
+ executive: nil,
504
+ owner: nil,
505
+ percent_ownership: nil,
506
+ title: nil
507
+ ); end
508
+ end
509
+ class Verification < Stripe::RequestParams
510
+ class AdditionalDocument < Stripe::RequestParams
511
+ # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
512
+ sig { returns(T.nilable(String)) }
513
+ attr_accessor :back
514
+ # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
515
+ sig { returns(T.nilable(String)) }
516
+ attr_accessor :front
517
+ sig { params(back: T.nilable(String), front: T.nilable(String)).void }
518
+ def initialize(back: nil, front: nil); end
519
+ end
520
+ class Document < Stripe::RequestParams
521
+ # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
522
+ sig { returns(T.nilable(String)) }
523
+ attr_accessor :back
524
+ # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
525
+ sig { returns(T.nilable(String)) }
526
+ attr_accessor :front
527
+ sig { params(back: T.nilable(String), front: T.nilable(String)).void }
528
+ def initialize(back: nil, front: nil); end
529
+ end
530
+ # A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
531
+ sig {
532
+ returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::AdditionalDocument))
533
+ }
534
+ attr_accessor :additional_document
535
+ # An identifying document, either a passport or local ID card.
536
+ sig {
537
+ returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::Document))
538
+ }
539
+ attr_accessor :document
540
+ sig {
541
+ params(additional_document: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::AdditionalDocument), document: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification::Document)).void
542
+ }
543
+ def initialize(additional_document: nil, document: nil); end
544
+ end
545
+ # The individual's primary address.
546
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Address)) }
547
+ attr_accessor :address
548
+ # The Kana variation of the individual's primary address (Japan only).
549
+ sig {
550
+ returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKana))
551
+ }
552
+ attr_accessor :address_kana
553
+ # The Kanji variation of the individual's primary address (Japan only).
554
+ sig {
555
+ returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKanji))
556
+ }
557
+ attr_accessor :address_kanji
558
+ # The individual's date of birth.
559
+ sig {
560
+ returns(T.nilable(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Individual::Dob))))
561
+ }
562
+ attr_accessor :dob
563
+ # The individual's email address.
564
+ sig { returns(T.nilable(String)) }
565
+ attr_accessor :email
566
+ # The individual's first name.
567
+ sig { returns(T.nilable(String)) }
568
+ attr_accessor :first_name
569
+ # The Kana variation of the individual's first name (Japan only).
570
+ sig { returns(T.nilable(String)) }
571
+ attr_accessor :first_name_kana
572
+ # The Kanji variation of the individual's first name (Japan only).
573
+ sig { returns(T.nilable(String)) }
574
+ attr_accessor :first_name_kanji
575
+ # A list of alternate names or aliases that the individual is known by.
576
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
577
+ attr_accessor :full_name_aliases
578
+ # The individual's gender
579
+ sig { returns(T.nilable(String)) }
580
+ attr_accessor :gender
581
+ # The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
582
+ sig { returns(T.nilable(String)) }
583
+ attr_accessor :id_number
584
+ # The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).
585
+ sig { returns(T.nilable(String)) }
586
+ attr_accessor :id_number_secondary
587
+ # The individual's last name.
588
+ sig { returns(T.nilable(String)) }
589
+ attr_accessor :last_name
590
+ # The Kana variation of the individual's last name (Japan only).
591
+ sig { returns(T.nilable(String)) }
592
+ attr_accessor :last_name_kana
593
+ # The Kanji variation of the individual's last name (Japan only).
594
+ sig { returns(T.nilable(String)) }
595
+ attr_accessor :last_name_kanji
596
+ # The individual's maiden name.
597
+ sig { returns(T.nilable(String)) }
598
+ attr_accessor :maiden_name
599
+ # 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`.
600
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
601
+ attr_accessor :metadata
602
+ # The individual's phone number.
603
+ sig { returns(T.nilable(String)) }
604
+ attr_accessor :phone
605
+ # Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
606
+ sig { returns(T.nilable(String)) }
607
+ attr_accessor :political_exposure
608
+ # The individual's registered address.
609
+ sig {
610
+ returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::RegisteredAddress))
611
+ }
612
+ attr_accessor :registered_address
613
+ # Describes the person’s relationship to the account.
614
+ sig {
615
+ returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Relationship))
616
+ }
617
+ attr_accessor :relationship
618
+ # The last four digits of the individual's Social Security Number (U.S. only).
619
+ sig { returns(T.nilable(String)) }
620
+ attr_accessor :ssn_last_4
621
+ # The individual's verification document information.
622
+ sig {
623
+ returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification))
624
+ }
625
+ attr_accessor :verification
626
+ sig {
627
+ params(address: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Address), address_kana: T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKana), address_kanji: T.nilable(::Stripe::Token::CreateParams::Account::Individual::AddressKanji), dob: T.nilable(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Individual::Dob))), email: T.nilable(String), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.nilable(T.any(String, T::Array[String]))), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::Token::CreateParams::Account::Individual::RegisteredAddress), relationship: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Relationship), ssn_last_4: T.nilable(String), verification: T.nilable(::Stripe::Token::CreateParams::Account::Individual::Verification)).void
628
+ }
629
+ def initialize(
630
+ address: nil,
631
+ address_kana: nil,
632
+ address_kanji: nil,
633
+ dob: nil,
634
+ email: nil,
635
+ first_name: nil,
636
+ first_name_kana: nil,
637
+ first_name_kanji: nil,
638
+ full_name_aliases: nil,
639
+ gender: nil,
640
+ id_number: nil,
641
+ id_number_secondary: nil,
642
+ last_name: nil,
643
+ last_name_kana: nil,
644
+ last_name_kanji: nil,
645
+ maiden_name: nil,
646
+ metadata: nil,
647
+ phone: nil,
648
+ political_exposure: nil,
649
+ registered_address: nil,
650
+ relationship: nil,
651
+ ssn_last_4: nil,
652
+ verification: nil
653
+ ); end
654
+ end
655
+ # The business type.
656
+ sig { returns(T.nilable(String)) }
657
+ attr_accessor :business_type
658
+ # Information about the company or business.
659
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Company)) }
660
+ attr_accessor :company
661
+ # Information about the person represented by the account.
662
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Account::Individual)) }
663
+ attr_accessor :individual
664
+ # Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.
665
+ sig { returns(T.nilable(T::Boolean)) }
666
+ attr_accessor :tos_shown_and_accepted
667
+ sig {
668
+ params(business_type: T.nilable(String), company: T.nilable(::Stripe::Token::CreateParams::Account::Company), individual: T.nilable(::Stripe::Token::CreateParams::Account::Individual), tos_shown_and_accepted: T.nilable(T::Boolean)).void
669
+ }
670
+ def initialize(
671
+ business_type: nil,
672
+ company: nil,
673
+ individual: nil,
674
+ tos_shown_and_accepted: nil
675
+ ); end
676
+ end
677
+ class BankAccount < Stripe::RequestParams
678
+ # The name of the person or business that owns the bank account. This field is required when attaching the bank account to a `Customer` object.
679
+ sig { returns(T.nilable(String)) }
680
+ attr_accessor :account_holder_name
681
+ # The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
682
+ sig { returns(T.nilable(String)) }
683
+ attr_accessor :account_holder_type
684
+ # The account number for the bank account, in string form. Must be a checking account.
685
+ sig { returns(String) }
686
+ attr_accessor :account_number
687
+ # The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
688
+ sig { returns(T.nilable(String)) }
689
+ attr_accessor :account_type
690
+ # The country in which the bank account is located.
691
+ sig { returns(String) }
692
+ attr_accessor :country
693
+ # The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts)
694
+ sig { returns(T.nilable(String)) }
695
+ attr_accessor :currency
696
+ # The ID of a Payment Method with a `type` of `us_bank_account`. The Payment Method's bank account information will be copied and returned as a Bank Account Token. This parameter is exclusive with respect to all other parameters in the `bank_account` hash. You must include the top-level `customer` parameter if the Payment Method is attached to a `Customer` object. If the Payment Method is not attached to a `Customer` object, it will be consumed and cannot be used again. You may not use Payment Methods which were created by a Setup Intent with `attach_to_self=true`.
697
+ sig { returns(T.nilable(String)) }
698
+ attr_accessor :payment_method
699
+ # The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
700
+ sig { returns(T.nilable(String)) }
701
+ attr_accessor :routing_number
702
+ sig {
703
+ params(account_holder_name: T.nilable(String), account_holder_type: T.nilable(String), account_number: String, account_type: T.nilable(String), country: String, currency: T.nilable(String), payment_method: T.nilable(String), routing_number: T.nilable(String)).void
704
+ }
705
+ def initialize(
706
+ account_holder_name: nil,
707
+ account_holder_type: nil,
708
+ account_number: nil,
709
+ account_type: nil,
710
+ country: nil,
711
+ currency: nil,
712
+ payment_method: nil,
713
+ routing_number: nil
714
+ ); end
715
+ end
716
+ class Card < Stripe::RequestParams
717
+ class Networks < Stripe::RequestParams
718
+ # The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.
719
+ sig { returns(T.nilable(String)) }
720
+ attr_accessor :preferred
721
+ sig { params(preferred: T.nilable(String)).void }
722
+ def initialize(preferred: nil); end
723
+ end
724
+ # City / District / Suburb / Town / Village.
725
+ sig { returns(T.nilable(String)) }
726
+ attr_accessor :address_city
727
+ # Billing address country, if provided.
728
+ sig { returns(T.nilable(String)) }
729
+ attr_accessor :address_country
730
+ # Address line 1 (Street address / PO Box / Company name).
731
+ sig { returns(T.nilable(String)) }
732
+ attr_accessor :address_line1
733
+ # Address line 2 (Apartment / Suite / Unit / Building).
734
+ sig { returns(T.nilable(String)) }
735
+ attr_accessor :address_line2
736
+ # State / County / Province / Region.
737
+ sig { returns(T.nilable(String)) }
738
+ attr_accessor :address_state
739
+ # ZIP or postal code.
740
+ sig { returns(T.nilable(String)) }
741
+ attr_accessor :address_zip
742
+ # Required in order to add the card to an account; in all other cases, this parameter is not used. When added to an account, the card (which must be a debit card) can be used as a transfer destination for funds in this currency.
743
+ sig { returns(T.nilable(String)) }
744
+ attr_accessor :currency
745
+ # Card security code. Highly recommended to always include this value.
746
+ sig { returns(T.nilable(String)) }
747
+ attr_accessor :cvc
748
+ # Two-digit number representing the card's expiration month.
749
+ sig { returns(String) }
750
+ attr_accessor :exp_month
751
+ # Two- or four-digit number representing the card's expiration year.
752
+ sig { returns(String) }
753
+ attr_accessor :exp_year
754
+ # Cardholder's full name.
755
+ sig { returns(T.nilable(String)) }
756
+ attr_accessor :name
757
+ # Contains information about card networks used to process the payment.
758
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Card::Networks)) }
759
+ attr_accessor :networks
760
+ # The card number, as a string without any separators.
761
+ sig { returns(String) }
762
+ attr_accessor :number
763
+ sig {
764
+ params(address_city: T.nilable(String), address_country: T.nilable(String), address_line1: T.nilable(String), address_line2: T.nilable(String), address_state: T.nilable(String), address_zip: T.nilable(String), currency: T.nilable(String), cvc: T.nilable(String), exp_month: String, exp_year: String, name: T.nilable(String), networks: T.nilable(::Stripe::Token::CreateParams::Card::Networks), number: String).void
765
+ }
766
+ def initialize(
767
+ address_city: nil,
768
+ address_country: nil,
769
+ address_line1: nil,
770
+ address_line2: nil,
771
+ address_state: nil,
772
+ address_zip: nil,
773
+ currency: nil,
774
+ cvc: nil,
775
+ exp_month: nil,
776
+ exp_year: nil,
777
+ name: nil,
778
+ networks: nil,
779
+ number: nil
780
+ ); end
781
+ end
782
+ class CvcUpdate < Stripe::RequestParams
783
+ # The CVC value, in string form.
784
+ sig { returns(String) }
785
+ attr_accessor :cvc
786
+ sig { params(cvc: String).void }
787
+ def initialize(cvc: nil); end
788
+ end
789
+ class Person < Stripe::RequestParams
790
+ class AdditionalTosAcceptances < Stripe::RequestParams
791
+ class Account < Stripe::RequestParams
792
+ # The Unix timestamp marking when the account representative accepted the service agreement.
793
+ sig { returns(T.nilable(Integer)) }
794
+ attr_accessor :date
795
+ # The IP address from which the account representative accepted the service agreement.
796
+ sig { returns(T.nilable(String)) }
797
+ attr_accessor :ip
798
+ # The user agent of the browser from which the account representative accepted the service agreement.
799
+ sig { returns(T.nilable(T.nilable(String))) }
800
+ attr_accessor :user_agent
801
+ sig {
802
+ params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(T.nilable(String))).void
803
+ }
804
+ def initialize(date: nil, ip: nil, user_agent: nil); end
805
+ end
806
+ # Details on the legal guardian's acceptance of the main Stripe service agreement.
807
+ sig {
808
+ returns(T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances::Account))
809
+ }
810
+ attr_accessor :account
811
+ sig {
812
+ params(account: T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances::Account)).void
813
+ }
814
+ def initialize(account: nil); end
815
+ end
816
+ class Address < Stripe::RequestParams
817
+ # City, district, suburb, town, or village.
818
+ sig { returns(T.nilable(String)) }
819
+ attr_accessor :city
820
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
821
+ sig { returns(T.nilable(String)) }
822
+ attr_accessor :country
823
+ # Address line 1 (e.g., street, PO Box, or company name).
824
+ sig { returns(T.nilable(String)) }
825
+ attr_accessor :line1
826
+ # Address line 2 (e.g., apartment, suite, unit, or building).
827
+ sig { returns(T.nilable(String)) }
828
+ attr_accessor :line2
829
+ # ZIP or postal code.
830
+ sig { returns(T.nilable(String)) }
831
+ attr_accessor :postal_code
832
+ # State, county, province, or region.
833
+ sig { returns(T.nilable(String)) }
834
+ attr_accessor :state
835
+ sig {
836
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
837
+ }
838
+ def initialize(
839
+ city: nil,
840
+ country: nil,
841
+ line1: nil,
842
+ line2: nil,
843
+ postal_code: nil,
844
+ state: nil
845
+ ); end
846
+ end
847
+ class AddressKana < Stripe::RequestParams
848
+ # City or ward.
849
+ sig { returns(T.nilable(String)) }
850
+ attr_accessor :city
851
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
852
+ sig { returns(T.nilable(String)) }
853
+ attr_accessor :country
854
+ # Block or building number.
855
+ sig { returns(T.nilable(String)) }
856
+ attr_accessor :line1
857
+ # Building details.
858
+ sig { returns(T.nilable(String)) }
859
+ attr_accessor :line2
860
+ # Postal code.
861
+ sig { returns(T.nilable(String)) }
862
+ attr_accessor :postal_code
863
+ # Prefecture.
864
+ sig { returns(T.nilable(String)) }
865
+ attr_accessor :state
866
+ # Town or cho-me.
867
+ sig { returns(T.nilable(String)) }
868
+ attr_accessor :town
869
+ sig {
870
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
871
+ }
872
+ def initialize(
873
+ city: nil,
874
+ country: nil,
875
+ line1: nil,
876
+ line2: nil,
877
+ postal_code: nil,
878
+ state: nil,
879
+ town: nil
880
+ ); end
881
+ end
882
+ class AddressKanji < Stripe::RequestParams
883
+ # City or ward.
884
+ sig { returns(T.nilable(String)) }
885
+ attr_accessor :city
886
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
887
+ sig { returns(T.nilable(String)) }
888
+ attr_accessor :country
889
+ # Block or building number.
890
+ sig { returns(T.nilable(String)) }
891
+ attr_accessor :line1
892
+ # Building details.
893
+ sig { returns(T.nilable(String)) }
894
+ attr_accessor :line2
895
+ # Postal code.
896
+ sig { returns(T.nilable(String)) }
897
+ attr_accessor :postal_code
898
+ # Prefecture.
899
+ sig { returns(T.nilable(String)) }
900
+ attr_accessor :state
901
+ # Town or cho-me.
902
+ sig { returns(T.nilable(String)) }
903
+ attr_accessor :town
904
+ sig {
905
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String), town: T.nilable(String)).void
906
+ }
907
+ def initialize(
908
+ city: nil,
909
+ country: nil,
910
+ line1: nil,
911
+ line2: nil,
912
+ postal_code: nil,
913
+ state: nil,
914
+ town: nil
915
+ ); end
916
+ end
917
+ class Dob < Stripe::RequestParams
918
+ # The day of birth, between 1 and 31.
919
+ sig { returns(Integer) }
920
+ attr_accessor :day
921
+ # The month of birth, between 1 and 12.
922
+ sig { returns(Integer) }
923
+ attr_accessor :month
924
+ # The four-digit year of birth.
925
+ sig { returns(Integer) }
926
+ attr_accessor :year
927
+ sig { params(day: Integer, month: Integer, year: Integer).void }
928
+ def initialize(day: nil, month: nil, year: nil); end
929
+ end
930
+ class Documents < Stripe::RequestParams
931
+ class CompanyAuthorization < Stripe::RequestParams
932
+ # One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
933
+ sig { returns(T.nilable(T::Array[String])) }
934
+ attr_accessor :files
935
+ sig { params(files: T.nilable(T::Array[String])).void }
936
+ def initialize(files: nil); end
937
+ end
938
+ class Passport < Stripe::RequestParams
939
+ # One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
940
+ sig { returns(T.nilable(T::Array[String])) }
941
+ attr_accessor :files
942
+ sig { params(files: T.nilable(T::Array[String])).void }
943
+ def initialize(files: nil); end
944
+ end
945
+ class Visa < Stripe::RequestParams
946
+ # One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
947
+ sig { returns(T.nilable(T::Array[String])) }
948
+ attr_accessor :files
949
+ sig { params(files: T.nilable(T::Array[String])).void }
950
+ def initialize(files: nil); end
951
+ end
952
+ # One or more documents that demonstrate proof that this person is authorized to represent the company.
953
+ sig {
954
+ returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents::CompanyAuthorization))
955
+ }
956
+ attr_accessor :company_authorization
957
+ # One or more documents showing the person's passport page with photo and personal data.
958
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents::Passport)) }
959
+ attr_accessor :passport
960
+ # One or more documents showing the person's visa required for living in the country where they are residing.
961
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents::Visa)) }
962
+ attr_accessor :visa
963
+ sig {
964
+ params(company_authorization: T.nilable(::Stripe::Token::CreateParams::Person::Documents::CompanyAuthorization), passport: T.nilable(::Stripe::Token::CreateParams::Person::Documents::Passport), visa: T.nilable(::Stripe::Token::CreateParams::Person::Documents::Visa)).void
965
+ }
966
+ def initialize(company_authorization: nil, passport: nil, visa: nil); end
967
+ end
968
+ class RegisteredAddress < Stripe::RequestParams
969
+ # City, district, suburb, town, or village.
970
+ sig { returns(T.nilable(String)) }
971
+ attr_accessor :city
972
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
973
+ sig { returns(T.nilable(String)) }
974
+ attr_accessor :country
975
+ # Address line 1 (e.g., street, PO Box, or company name).
976
+ sig { returns(T.nilable(String)) }
977
+ attr_accessor :line1
978
+ # Address line 2 (e.g., apartment, suite, unit, or building).
979
+ sig { returns(T.nilable(String)) }
980
+ attr_accessor :line2
981
+ # ZIP or postal code.
982
+ sig { returns(T.nilable(String)) }
983
+ attr_accessor :postal_code
984
+ # State, county, province, or region.
985
+ sig { returns(T.nilable(String)) }
986
+ attr_accessor :state
987
+ sig {
988
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
989
+ }
990
+ def initialize(
991
+ city: nil,
992
+ country: nil,
993
+ line1: nil,
994
+ line2: nil,
995
+ postal_code: nil,
996
+ state: nil
997
+ ); end
998
+ end
999
+ class Relationship < Stripe::RequestParams
1000
+ # Whether the person is the authorizer of the account's representative.
1001
+ sig { returns(T.nilable(T::Boolean)) }
1002
+ attr_accessor :authorizer
1003
+ # Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
1004
+ sig { returns(T.nilable(T::Boolean)) }
1005
+ attr_accessor :director
1006
+ # Whether the person has significant responsibility to control, manage, or direct the organization.
1007
+ sig { returns(T.nilable(T::Boolean)) }
1008
+ attr_accessor :executive
1009
+ # Whether the person is the legal guardian of the account's representative.
1010
+ sig { returns(T.nilable(T::Boolean)) }
1011
+ attr_accessor :legal_guardian
1012
+ # Whether the person is an owner of the account’s legal entity.
1013
+ sig { returns(T.nilable(T::Boolean)) }
1014
+ attr_accessor :owner
1015
+ # The percent owned by the person of the account's legal entity.
1016
+ sig { returns(T.nilable(T.nilable(T.any(String, Float)))) }
1017
+ attr_accessor :percent_ownership
1018
+ # Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
1019
+ sig { returns(T.nilable(T::Boolean)) }
1020
+ attr_accessor :representative
1021
+ # The person's title (e.g., CEO, Support Engineer).
1022
+ sig { returns(T.nilable(String)) }
1023
+ attr_accessor :title
1024
+ sig {
1025
+ params(authorizer: T.nilable(T::Boolean), director: T.nilable(T::Boolean), executive: T.nilable(T::Boolean), legal_guardian: T.nilable(T::Boolean), owner: T.nilable(T::Boolean), percent_ownership: T.nilable(T.nilable(T.any(String, Float))), representative: T.nilable(T::Boolean), title: T.nilable(String)).void
1026
+ }
1027
+ def initialize(
1028
+ authorizer: nil,
1029
+ director: nil,
1030
+ executive: nil,
1031
+ legal_guardian: nil,
1032
+ owner: nil,
1033
+ percent_ownership: nil,
1034
+ representative: nil,
1035
+ title: nil
1036
+ ); end
1037
+ end
1038
+ class UsCfpbData < Stripe::RequestParams
1039
+ class EthnicityDetails < Stripe::RequestParams
1040
+ # The persons ethnicity
1041
+ sig { returns(T.nilable(T::Array[String])) }
1042
+ attr_accessor :ethnicity
1043
+ # Please specify your origin, when other is selected.
1044
+ sig { returns(T.nilable(String)) }
1045
+ attr_accessor :ethnicity_other
1046
+ sig {
1047
+ params(ethnicity: T.nilable(T::Array[String]), ethnicity_other: T.nilable(String)).void
1048
+ }
1049
+ def initialize(ethnicity: nil, ethnicity_other: nil); end
1050
+ end
1051
+ class RaceDetails < Stripe::RequestParams
1052
+ # The persons race.
1053
+ sig { returns(T.nilable(T::Array[String])) }
1054
+ attr_accessor :race
1055
+ # Please specify your race, when other is selected.
1056
+ sig { returns(T.nilable(String)) }
1057
+ attr_accessor :race_other
1058
+ sig { params(race: T.nilable(T::Array[String]), race_other: T.nilable(String)).void }
1059
+ def initialize(race: nil, race_other: nil); end
1060
+ end
1061
+ # The persons ethnicity details
1062
+ sig {
1063
+ returns(T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::EthnicityDetails))
1064
+ }
1065
+ attr_accessor :ethnicity_details
1066
+ # The persons race details
1067
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::RaceDetails)) }
1068
+ attr_accessor :race_details
1069
+ # The persons self-identified gender
1070
+ sig { returns(T.nilable(String)) }
1071
+ attr_accessor :self_identified_gender
1072
+ sig {
1073
+ params(ethnicity_details: T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::EthnicityDetails), race_details: T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData::RaceDetails), self_identified_gender: T.nilable(String)).void
1074
+ }
1075
+ def initialize(
1076
+ ethnicity_details: nil,
1077
+ race_details: nil,
1078
+ self_identified_gender: nil
1079
+ ); end
1080
+ end
1081
+ class Verification < Stripe::RequestParams
1082
+ class AdditionalDocument < Stripe::RequestParams
1083
+ # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
1084
+ sig { returns(T.nilable(String)) }
1085
+ attr_accessor :back
1086
+ # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
1087
+ sig { returns(T.nilable(String)) }
1088
+ attr_accessor :front
1089
+ sig { params(back: T.nilable(String), front: T.nilable(String)).void }
1090
+ def initialize(back: nil, front: nil); end
1091
+ end
1092
+ class Document < Stripe::RequestParams
1093
+ # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
1094
+ sig { returns(T.nilable(String)) }
1095
+ attr_accessor :back
1096
+ # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
1097
+ sig { returns(T.nilable(String)) }
1098
+ attr_accessor :front
1099
+ sig { params(back: T.nilable(String), front: T.nilable(String)).void }
1100
+ def initialize(back: nil, front: nil); end
1101
+ end
1102
+ # A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
1103
+ sig {
1104
+ returns(T.nilable(::Stripe::Token::CreateParams::Person::Verification::AdditionalDocument))
1105
+ }
1106
+ attr_accessor :additional_document
1107
+ # An identifying document, either a passport or local ID card.
1108
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Verification::Document)) }
1109
+ attr_accessor :document
1110
+ sig {
1111
+ params(additional_document: T.nilable(::Stripe::Token::CreateParams::Person::Verification::AdditionalDocument), document: T.nilable(::Stripe::Token::CreateParams::Person::Verification::Document)).void
1112
+ }
1113
+ def initialize(additional_document: nil, document: nil); end
1114
+ end
1115
+ # Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
1116
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances)) }
1117
+ attr_accessor :additional_tos_acceptances
1118
+ # The person's address.
1119
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Address)) }
1120
+ attr_accessor :address
1121
+ # The Kana variation of the person's address (Japan only).
1122
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::AddressKana)) }
1123
+ attr_accessor :address_kana
1124
+ # The Kanji variation of the person's address (Japan only).
1125
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::AddressKanji)) }
1126
+ attr_accessor :address_kanji
1127
+ # The person's date of birth.
1128
+ sig {
1129
+ returns(T.nilable(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Person::Dob))))
1130
+ }
1131
+ attr_accessor :dob
1132
+ # Documents that may be submitted to satisfy various informational requests.
1133
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Documents)) }
1134
+ attr_accessor :documents
1135
+ # The person's email address.
1136
+ sig { returns(T.nilable(String)) }
1137
+ attr_accessor :email
1138
+ # The person's first name.
1139
+ sig { returns(T.nilable(String)) }
1140
+ attr_accessor :first_name
1141
+ # The Kana variation of the person's first name (Japan only).
1142
+ sig { returns(T.nilable(String)) }
1143
+ attr_accessor :first_name_kana
1144
+ # The Kanji variation of the person's first name (Japan only).
1145
+ sig { returns(T.nilable(String)) }
1146
+ attr_accessor :first_name_kanji
1147
+ # A list of alternate names or aliases that the person is known by.
1148
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
1149
+ attr_accessor :full_name_aliases
1150
+ # The person's gender (International regulations require either "male" or "female").
1151
+ sig { returns(T.nilable(String)) }
1152
+ attr_accessor :gender
1153
+ # The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
1154
+ sig { returns(T.nilable(String)) }
1155
+ attr_accessor :id_number
1156
+ # The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
1157
+ sig { returns(T.nilable(String)) }
1158
+ attr_accessor :id_number_secondary
1159
+ # The person's last name.
1160
+ sig { returns(T.nilable(String)) }
1161
+ attr_accessor :last_name
1162
+ # The Kana variation of the person's last name (Japan only).
1163
+ sig { returns(T.nilable(String)) }
1164
+ attr_accessor :last_name_kana
1165
+ # The Kanji variation of the person's last name (Japan only).
1166
+ sig { returns(T.nilable(String)) }
1167
+ attr_accessor :last_name_kanji
1168
+ # The person's maiden name.
1169
+ sig { returns(T.nilable(String)) }
1170
+ attr_accessor :maiden_name
1171
+ # 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`.
1172
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
1173
+ attr_accessor :metadata
1174
+ # The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable.
1175
+ sig { returns(T.nilable(String)) }
1176
+ attr_accessor :nationality
1177
+ # The person's phone number.
1178
+ sig { returns(T.nilable(String)) }
1179
+ attr_accessor :phone
1180
+ # Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
1181
+ sig { returns(T.nilable(String)) }
1182
+ attr_accessor :political_exposure
1183
+ # The person's registered address.
1184
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::RegisteredAddress)) }
1185
+ attr_accessor :registered_address
1186
+ # The relationship that this person has with the account's legal entity.
1187
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Relationship)) }
1188
+ attr_accessor :relationship
1189
+ # The last four digits of the person's Social Security number (U.S. only).
1190
+ sig { returns(T.nilable(String)) }
1191
+ attr_accessor :ssn_last_4
1192
+ # Demographic data related to the person.
1193
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData)) }
1194
+ attr_accessor :us_cfpb_data
1195
+ # The person's verification status.
1196
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person::Verification)) }
1197
+ attr_accessor :verification
1198
+ sig {
1199
+ params(additional_tos_acceptances: T.nilable(::Stripe::Token::CreateParams::Person::AdditionalTosAcceptances), address: T.nilable(::Stripe::Token::CreateParams::Person::Address), address_kana: T.nilable(::Stripe::Token::CreateParams::Person::AddressKana), address_kanji: T.nilable(::Stripe::Token::CreateParams::Person::AddressKanji), dob: T.nilable(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Person::Dob))), documents: T.nilable(::Stripe::Token::CreateParams::Person::Documents), email: T.nilable(String), first_name: T.nilable(String), first_name_kana: T.nilable(String), first_name_kanji: T.nilable(String), full_name_aliases: T.nilable(T.nilable(T.any(String, T::Array[String]))), gender: T.nilable(String), id_number: T.nilable(String), id_number_secondary: T.nilable(String), last_name: T.nilable(String), last_name_kana: T.nilable(String), last_name_kanji: T.nilable(String), maiden_name: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), nationality: T.nilable(String), phone: T.nilable(String), political_exposure: T.nilable(String), registered_address: T.nilable(::Stripe::Token::CreateParams::Person::RegisteredAddress), relationship: T.nilable(::Stripe::Token::CreateParams::Person::Relationship), ssn_last_4: T.nilable(String), us_cfpb_data: T.nilable(::Stripe::Token::CreateParams::Person::UsCfpbData), verification: T.nilable(::Stripe::Token::CreateParams::Person::Verification)).void
1200
+ }
1201
+ def initialize(
1202
+ additional_tos_acceptances: nil,
1203
+ address: nil,
1204
+ address_kana: nil,
1205
+ address_kanji: nil,
1206
+ dob: nil,
1207
+ documents: nil,
1208
+ email: nil,
1209
+ first_name: nil,
1210
+ first_name_kana: nil,
1211
+ first_name_kanji: nil,
1212
+ full_name_aliases: nil,
1213
+ gender: nil,
1214
+ id_number: nil,
1215
+ id_number_secondary: nil,
1216
+ last_name: nil,
1217
+ last_name_kana: nil,
1218
+ last_name_kanji: nil,
1219
+ maiden_name: nil,
1220
+ metadata: nil,
1221
+ nationality: nil,
1222
+ phone: nil,
1223
+ political_exposure: nil,
1224
+ registered_address: nil,
1225
+ relationship: nil,
1226
+ ssn_last_4: nil,
1227
+ us_cfpb_data: nil,
1228
+ verification: nil
1229
+ ); end
1230
+ end
1231
+ class Pii < Stripe::RequestParams
1232
+ # The `id_number` for the PII, in string form.
1233
+ sig { returns(T.nilable(String)) }
1234
+ attr_accessor :id_number
1235
+ sig { params(id_number: T.nilable(String)).void }
1236
+ def initialize(id_number: nil); end
1237
+ end
1238
+ # Information for the account this token represents.
1239
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Account)) }
1240
+ attr_accessor :account
1241
+ # The bank account this token will represent.
1242
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::BankAccount)) }
1243
+ attr_accessor :bank_account
1244
+ # The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.
1245
+ sig { returns(T.nilable(T.any(::Stripe::Token::CreateParams::Card, String))) }
1246
+ attr_accessor :card
1247
+ # Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods).
1248
+ sig { returns(T.nilable(String)) }
1249
+ attr_accessor :customer
1250
+ # The updated CVC value this token represents.
1251
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::CvcUpdate)) }
1252
+ attr_accessor :cvc_update
1253
+ # Specifies which fields in the response should be expanded.
1254
+ sig { returns(T.nilable(T::Array[String])) }
1255
+ attr_accessor :expand
1256
+ # Information for the person this token represents.
1257
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Person)) }
1258
+ attr_accessor :person
1259
+ # The PII this token represents.
1260
+ sig { returns(T.nilable(::Stripe::Token::CreateParams::Pii)) }
1261
+ attr_accessor :pii
1262
+ sig {
1263
+ params(account: T.nilable(::Stripe::Token::CreateParams::Account), bank_account: T.nilable(::Stripe::Token::CreateParams::BankAccount), card: T.nilable(T.any(::Stripe::Token::CreateParams::Card, String)), customer: T.nilable(String), cvc_update: T.nilable(::Stripe::Token::CreateParams::CvcUpdate), expand: T.nilable(T::Array[String]), person: T.nilable(::Stripe::Token::CreateParams::Person), pii: T.nilable(::Stripe::Token::CreateParams::Pii)).void
1264
+ }
1265
+ def initialize(
1266
+ account: nil,
1267
+ bank_account: nil,
1268
+ card: nil,
1269
+ customer: nil,
1270
+ cvc_update: nil,
1271
+ expand: nil,
1272
+ person: nil,
1273
+ pii: nil
1274
+ ); end
1275
+ end
1276
+ # Creates a single-use token that represents a bank account's details.
1277
+ # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
1278
+ sig {
1279
+ params(params: T.any(::Stripe::Token::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Token)
1280
+ }
1281
+ def self.create(params = {}, opts = {}); end
1282
+ end
1283
+ end