stripe 14.1.0.pre.beta.1 → 15.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (574) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +689 -1512
  3. data/OPENAPI_VERSION +1 -1
  4. data/README.md +3 -3
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_operations/save.rb +2 -1
  7. data/lib/stripe/api_operations/singleton_save.rb +2 -1
  8. data/lib/stripe/api_requestor.rb +3 -29
  9. data/lib/stripe/api_resource.rb +10 -3
  10. data/lib/stripe/api_version.rb +1 -1
  11. data/lib/stripe/errors.rb +0 -54
  12. data/lib/stripe/event_types.rb +0 -75
  13. data/lib/stripe/object_types.rb +0 -48
  14. data/lib/stripe/request_options.rb +2 -1
  15. data/lib/stripe/resources/account.rb +1 -653
  16. data/lib/stripe/resources/account_session.rb +1 -247
  17. data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -2
  18. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -4
  19. data/lib/stripe/resources/billing/credit_grant.rb +0 -10
  20. data/lib/stripe/resources/billing_portal/session.rb +0 -6
  21. data/lib/stripe/resources/card.rb +0 -2
  22. data/lib/stripe/resources/cash_balance.rb +0 -2
  23. data/lib/stripe/resources/charge.rb +0 -1454
  24. data/lib/stripe/resources/checkout/session.rb +4 -260
  25. data/lib/stripe/resources/confirmation_token.rb +0 -234
  26. data/lib/stripe/resources/coupon.rb +1 -1
  27. data/lib/stripe/resources/credit_note.rb +0 -10
  28. data/lib/stripe/resources/credit_note_line_item.rb +0 -9
  29. data/lib/stripe/resources/customer.rb +0 -2
  30. data/lib/stripe/resources/customer_balance_transaction.rb +0 -2
  31. data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -2
  32. data/lib/stripe/resources/customer_session.rb +1 -6
  33. data/lib/stripe/resources/discount.rb +0 -2
  34. data/lib/stripe/resources/event.rb +0 -33
  35. data/lib/stripe/resources/financial_connections/account.rb +1 -20
  36. data/lib/stripe/resources/financial_connections/session.rb +2 -62
  37. data/lib/stripe/resources/identity/verification_session.rb +0 -10
  38. data/lib/stripe/resources/invoice.rb +16 -1176
  39. data/lib/stripe/resources/invoice_item.rb +2 -78
  40. data/lib/stripe/resources/invoice_line_item.rb +1 -55
  41. data/lib/stripe/resources/invoice_payment.rb +53 -2
  42. data/lib/stripe/resources/issuing/cardholder.rb +1 -2
  43. data/lib/stripe/resources/issuing/transaction.rb +0 -6
  44. data/lib/stripe/resources/line_item.rb +0 -37
  45. data/lib/stripe/resources/mandate.rb +0 -24
  46. data/lib/stripe/resources/payment_intent.rb +307 -5109
  47. data/lib/stripe/resources/payment_method.rb +1 -196
  48. data/lib/stripe/resources/payment_method_configuration.rb +0 -295
  49. data/lib/stripe/resources/payout.rb +0 -6
  50. data/lib/stripe/resources/price.rb +0 -30
  51. data/lib/stripe/resources/product.rb +0 -59
  52. data/lib/stripe/resources/promotion_code.rb +0 -10
  53. data/lib/stripe/resources/quote.rb +6 -2042
  54. data/lib/stripe/resources/refund.rb +0 -9
  55. data/lib/stripe/resources/setup_attempt.rb +0 -21
  56. data/lib/stripe/resources/setup_intent.rb +9 -596
  57. data/lib/stripe/resources/source.rb +1 -30
  58. data/lib/stripe/resources/subscription.rb +9 -292
  59. data/lib/stripe/resources/subscription_item.rb +3 -84
  60. data/lib/stripe/resources/subscription_schedule.rb +10 -1007
  61. data/lib/stripe/resources/tax_id.rb +2 -12
  62. data/lib/stripe/resources/terminal/reader.rb +0 -406
  63. data/lib/stripe/resources/treasury/financial_account.rb +3 -22
  64. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
  65. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -37
  66. data/lib/stripe/resources/treasury/received_credit.rb +1 -38
  67. data/lib/stripe/resources/treasury/received_debit.rb +1 -40
  68. data/lib/stripe/resources.rb +0 -85
  69. data/lib/stripe/services/account_service.rb +1 -562
  70. data/lib/stripe/services/account_session_service.rb +1 -217
  71. data/lib/stripe/services/billing/credit_balance_summary_service.rb +1 -4
  72. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -4
  73. data/lib/stripe/services/billing/credit_grant_service.rb +0 -8
  74. data/lib/stripe/services/billing_portal/session_service.rb +0 -4
  75. data/lib/stripe/services/charge_service.rb +0 -1334
  76. data/lib/stripe/services/checkout/session_service.rb +2 -172
  77. data/lib/stripe/services/credit_note_service.rb +0 -4
  78. data/lib/stripe/services/customer_session_service.rb +1 -4
  79. data/lib/stripe/services/financial_connections/account_service.rb +2 -7
  80. data/lib/stripe/services/financial_connections/session_service.rb +2 -34
  81. data/lib/stripe/services/financial_connections_service.rb +1 -2
  82. data/lib/stripe/services/identity/verification_session_service.rb +0 -8
  83. data/lib/stripe/services/invoice_item_service.rb +2 -74
  84. data/lib/stripe/services/invoice_line_item_service.rb +1 -33
  85. data/lib/stripe/services/invoice_payment_service.rb +33 -5
  86. data/lib/stripe/services/invoice_service.rb +17 -1088
  87. data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
  88. data/lib/stripe/services/issuing/transaction_service.rb +0 -4
  89. data/lib/stripe/services/issuing_service.rb +1 -5
  90. data/lib/stripe/services/payment_intent_service.rb +264 -4637
  91. data/lib/stripe/services/payment_method_configuration_service.rb +0 -210
  92. data/lib/stripe/services/payment_method_service.rb +1 -126
  93. data/lib/stripe/services/payout_service.rb +0 -4
  94. data/lib/stripe/services/price_service.rb +0 -19
  95. data/lib/stripe/services/product_service.rb +0 -38
  96. data/lib/stripe/services/promotion_code_service.rb +0 -8
  97. data/lib/stripe/services/quote_service.rb +7 -1726
  98. data/lib/stripe/services/setup_intent_service.rb +9 -556
  99. data/lib/stripe/services/subscription_item_service.rb +3 -75
  100. data/lib/stripe/services/subscription_schedule_service.rb +10 -911
  101. data/lib/stripe/services/subscription_service.rb +9 -253
  102. data/lib/stripe/services/tax_id_service.rb +2 -8
  103. data/lib/stripe/services/tax_service.rb +1 -3
  104. data/lib/stripe/services/terminal/reader_service.rb +0 -180
  105. data/lib/stripe/services/terminal_service.rb +1 -2
  106. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -148
  107. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -43
  108. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
  109. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
  110. data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
  111. data/lib/stripe/services/treasury/financial_account_service.rb +2 -16
  112. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
  113. data/lib/stripe/services/v1_services.rb +2 -10
  114. data/lib/stripe/services/v2/core/event_service.rb +5 -3
  115. data/lib/stripe/services/v2/core_service.rb +1 -4
  116. data/lib/stripe/services/v2_services.rb +2 -4
  117. data/lib/stripe/services.rb +0 -49
  118. data/lib/stripe/stripe_configuration.rb +1 -3
  119. data/lib/stripe/stripe_object.rb +14 -4
  120. data/lib/stripe/util.rb +12 -7
  121. data/lib/stripe/version.rb +1 -1
  122. data/lib/stripe.rb +0 -55
  123. data/rbi/stripe/resources/account.rbi +4840 -0
  124. data/rbi/stripe/resources/account_link.rbi +74 -0
  125. data/rbi/stripe/resources/account_session.rbi +894 -0
  126. data/rbi/stripe/resources/apple_pay_domain.rbi +90 -0
  127. data/rbi/stripe/resources/application.rbi +20 -0
  128. data/rbi/stripe/resources/application_fee.rbi +118 -0
  129. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  130. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  131. data/rbi/stripe/resources/balance.rbi +180 -0
  132. data/rbi/stripe/resources/balance_transaction.rbi +144 -0
  133. data/rbi/stripe/resources/bank_account.rbi +127 -0
  134. data/rbi/stripe/resources/billing/alert.rbi +201 -0
  135. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  136. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
  137. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
  138. data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
  139. data/rbi/stripe/resources/billing/meter.rbi +226 -0
  140. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  141. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  142. data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
  143. data/rbi/stripe/resources/billing_portal/configuration.rbi +645 -0
  144. data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
  145. data/rbi/stripe/resources/capability.rbi +125 -0
  146. data/rbi/stripe/resources/card.rbi +125 -0
  147. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  148. data/rbi/stripe/resources/charge.rbi +2054 -0
  149. data/rbi/stripe/resources/checkout/session.rbi +3951 -0
  150. data/rbi/stripe/resources/climate/order.rbi +245 -0
  151. data/rbi/stripe/resources/climate/product.rbi +75 -0
  152. data/rbi/stripe/resources/climate/supplier.rbi +72 -0
  153. data/rbi/stripe/resources/confirmation_token.rbi +1793 -0
  154. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  155. data/rbi/stripe/resources/country_spec.rbi +85 -0
  156. data/rbi/stripe/resources/coupon.rbi +252 -0
  157. data/rbi/stripe/resources/credit_note.rbi +747 -0
  158. data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
  159. data/rbi/stripe/resources/customer.rbi +1009 -0
  160. data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
  161. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  162. data/rbi/stripe/resources/customer_session.rbi +200 -0
  163. data/rbi/stripe/resources/discount.rbi +53 -0
  164. data/rbi/stripe/resources/dispute.rbi +761 -0
  165. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
  166. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  167. data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
  168. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  169. data/rbi/stripe/resources/event.rbi +146 -0
  170. data/rbi/stripe/resources/exchange_rate.rbi +66 -0
  171. data/rbi/stripe/resources/file.rbi +143 -0
  172. data/rbi/stripe/resources/file_link.rbi +141 -0
  173. data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
  174. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  175. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  176. data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
  177. data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
  178. data/rbi/stripe/resources/forwarding/request.rbi +216 -0
  179. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  180. data/rbi/stripe/resources/identity/verification_report.rbi +351 -0
  181. data/rbi/stripe/resources/identity/verification_session.rbi +517 -0
  182. data/rbi/stripe/resources/invoice.rbi +3733 -0
  183. data/rbi/stripe/resources/invoice_item.rbi +475 -0
  184. data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
  185. data/rbi/stripe/resources/invoice_payment.rbi +114 -0
  186. data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
  187. data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
  188. data/rbi/stripe/resources/issuing/card.rbi +741 -0
  189. data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
  190. data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
  191. data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
  192. data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
  193. data/rbi/stripe/resources/issuing/token.rbi +226 -0
  194. data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
  195. data/rbi/stripe/resources/line_item.rbi +72 -0
  196. data/rbi/stripe/resources/login_link.rbi +18 -0
  197. data/rbi/stripe/resources/mandate.rbi +187 -0
  198. data/rbi/stripe/resources/payment_intent.rbi +9731 -0
  199. data/rbi/stripe/resources/payment_link.rbi +1801 -0
  200. data/rbi/stripe/resources/payment_method.rbi +1822 -0
  201. data/rbi/stripe/resources/payment_method_configuration.rbi +3154 -0
  202. data/rbi/stripe/resources/payment_method_domain.rbi +212 -0
  203. data/rbi/stripe/resources/payout.rbi +300 -0
  204. data/rbi/stripe/resources/person.rbi +371 -0
  205. data/rbi/stripe/resources/plan.rbi +373 -0
  206. data/rbi/stripe/resources/price.rbi +694 -0
  207. data/rbi/stripe/resources/product.rbi +557 -0
  208. data/rbi/stripe/resources/product_feature.rbi +26 -0
  209. data/rbi/stripe/resources/promotion_code.rbi +261 -0
  210. data/rbi/stripe/resources/quote.rbi +1123 -0
  211. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
  212. data/rbi/stripe/resources/radar/value_list.rbi +170 -0
  213. data/rbi/stripe/resources/radar/value_list_item.rbi +131 -0
  214. data/rbi/stripe/resources/refund.rbi +516 -0
  215. data/rbi/stripe/resources/reporting/report_run.rbi +191 -0
  216. data/rbi/stripe/resources/reporting/report_type.rbi +57 -0
  217. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  218. data/rbi/stripe/resources/reversal.rbi +51 -0
  219. data/rbi/stripe/resources/review.rbi +154 -0
  220. data/rbi/stripe/resources/setup_attempt.rbi +477 -0
  221. data/rbi/stripe/resources/setup_intent.rbi +3860 -0
  222. data/rbi/stripe/resources/shipping_rate.rbi +305 -0
  223. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +75 -0
  224. data/rbi/stripe/resources/source.rbi +1496 -0
  225. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  226. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  227. data/rbi/stripe/resources/subscription.rbi +1964 -0
  228. data/rbi/stripe/resources/subscription_item.rbi +370 -0
  229. data/rbi/stripe/resources/subscription_schedule.rbi +1495 -0
  230. data/rbi/stripe/resources/tax/calculation.rbi +474 -0
  231. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  232. data/rbi/stripe/resources/tax/registration.rbi +2485 -0
  233. data/rbi/stripe/resources/tax/settings.rbi +141 -0
  234. data/rbi/stripe/resources/tax/transaction.rbi +351 -0
  235. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  236. data/rbi/stripe/resources/tax_code.rbi +44 -0
  237. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  238. data/rbi/stripe/resources/tax_id.rbi +167 -0
  239. data/rbi/stripe/resources/tax_rate.rbi +239 -0
  240. data/rbi/stripe/resources/terminal/configuration.rbi +1388 -0
  241. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  242. data/rbi/stripe/resources/terminal/location.rbi +224 -0
  243. data/rbi/stripe/resources/terminal/reader.rbi +587 -0
  244. data/rbi/stripe/resources/test_helpers/test_clock.rbi +134 -0
  245. data/rbi/stripe/resources/token.rbi +1217 -0
  246. data/rbi/stripe/resources/topup.rbi +222 -0
  247. data/rbi/stripe/resources/transfer.rbi +199 -0
  248. data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
  249. data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
  250. data/rbi/stripe/resources/treasury/financial_account.rbi +865 -0
  251. data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
  252. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
  253. data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
  254. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
  255. data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
  256. data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
  257. data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
  258. data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
  259. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  260. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  261. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  262. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  263. data/rbi/stripe/resources/v2/event.rbi +48 -0
  264. data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
  265. data/rbi/stripe/resources/webhook_endpoint.rbi +170 -0
  266. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  267. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  268. data/rbi/stripe/services/account_link_service.rbi +58 -0
  269. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  270. data/rbi/stripe/services/account_person_service.rbi +923 -0
  271. data/rbi/stripe/services/account_service.rbi +4143 -0
  272. data/rbi/stripe/services/account_session_service.rbi +572 -0
  273. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  274. data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
  275. data/rbi/stripe/services/application_fee_service.rbi +78 -0
  276. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  277. data/rbi/stripe/services/apps_service.rbi +9 -0
  278. data/rbi/stripe/services/balance_service.rbi +21 -0
  279. data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
  280. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  281. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
  282. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  283. data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
  284. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
  285. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  286. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  287. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  288. data/rbi/stripe/services/billing_portal/configuration_service.rbi +511 -0
  289. data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
  290. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  291. data/rbi/stripe/services/billing_service.rbi +15 -0
  292. data/rbi/stripe/services/charge_service.rbi +448 -0
  293. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  294. data/rbi/stripe/services/checkout/session_service.rbi +2585 -0
  295. data/rbi/stripe/services/checkout_service.rbi +9 -0
  296. data/rbi/stripe/services/climate/order_service.rbi +142 -0
  297. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  298. data/{lib/stripe/services/financial_connections/institution_service.rb → rbi/stripe/services/climate/supplier_service.rbi} +25 -36
  299. data/rbi/stripe/services/climate_service.rbi +11 -0
  300. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  301. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  302. data/rbi/stripe/services/coupon_service.rbi +196 -0
  303. data/{lib/stripe/services/quote_preview_subscription_schedule_service.rb → rbi/stripe/services/credit_note_line_item_service.rbi} +16 -20
  304. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  305. data/rbi/stripe/services/credit_note_service.rbi +416 -0
  306. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  307. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  308. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  309. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  310. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  311. data/rbi/stripe/services/customer_payment_source_service.rbi +232 -0
  312. data/rbi/stripe/services/customer_service.rbi +651 -0
  313. data/rbi/stripe/services/customer_session_service.rbi +116 -0
  314. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  315. data/rbi/stripe/services/dispute_service.rbi +424 -0
  316. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  317. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  318. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  319. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  320. data/rbi/stripe/services/event_service.rbi +83 -0
  321. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  322. data/rbi/stripe/services/file_link_service.rbi +124 -0
  323. data/rbi/stripe/services/file_service.rbi +116 -0
  324. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  325. data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
  326. data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
  327. data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
  328. data/rbi/stripe/services/financial_connections_service.rbi +11 -0
  329. data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
  330. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  331. data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
  332. data/rbi/stripe/services/identity/verification_session_service.rbi +323 -0
  333. data/rbi/stripe/services/identity_service.rbi +10 -0
  334. data/rbi/stripe/services/invoice_item_service.rbi +368 -0
  335. data/rbi/stripe/services/invoice_line_item_service.rbi +259 -0
  336. data/rbi/stripe/services/invoice_payment_service.rbi +71 -0
  337. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  338. data/rbi/stripe/services/invoice_service.rbi +2920 -0
  339. data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
  340. data/rbi/stripe/services/issuing/card_service.rbi +495 -0
  341. data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
  342. data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
  343. data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
  344. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  345. data/rbi/stripe/services/issuing/token_service.rbi +99 -0
  346. data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
  347. data/rbi/stripe/services/issuing_service.rbi +16 -0
  348. data/rbi/stripe/services/mandate_service.rbi +20 -0
  349. data/rbi/stripe/services/payment_intent_service.rbi +7759 -0
  350. data/{lib/stripe/services/quote_line_service.rb → rbi/stripe/services/payment_link_line_item_service.rbi} +16 -20
  351. data/rbi/stripe/services/payment_link_service.rbi +1352 -0
  352. data/rbi/stripe/services/payment_method_configuration_service.rbi +2211 -0
  353. data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
  354. data/rbi/stripe/services/payment_method_service.rbi +840 -0
  355. data/rbi/stripe/services/payout_service.rbi +205 -0
  356. data/rbi/stripe/services/plan_service.rbi +284 -0
  357. data/rbi/stripe/services/price_service.rbi +546 -0
  358. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  359. data/rbi/stripe/services/product_service.rbi +479 -0
  360. data/rbi/stripe/services/promotion_code_service.rbi +214 -0
  361. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  362. data/{lib/stripe/services/order_line_item_service.rb → rbi/stripe/services/quote_line_item_service.rbi} +16 -20
  363. data/rbi/stripe/services/quote_service.rbi +686 -0
  364. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
  365. data/rbi/stripe/services/radar/value_list_item_service.rbi +111 -0
  366. data/rbi/stripe/services/radar/value_list_service.rbi +143 -0
  367. data/rbi/stripe/services/radar_service.rbi +11 -0
  368. data/rbi/stripe/services/refund_service.rbi +185 -0
  369. data/rbi/stripe/services/reporting/report_run_service.rbi +135 -0
  370. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  371. data/rbi/stripe/services/reporting_service.rbi +10 -0
  372. data/rbi/stripe/services/review_service.rbi +84 -0
  373. data/rbi/stripe/services/setup_attempt_service.rbi +65 -0
  374. data/rbi/stripe/services/setup_intent_service.rbi +3596 -0
  375. data/rbi/stripe/services/shipping_rate_service.rbi +241 -0
  376. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  377. data/rbi/stripe/services/sigma_service.rbi +9 -0
  378. data/rbi/stripe/services/source_service.rbi +663 -0
  379. data/{lib/stripe/services/quote_preview_invoice_service.rb → rbi/stripe/services/source_transaction_service.rbi} +16 -20
  380. data/rbi/stripe/services/subscription_item_service.rbi +324 -0
  381. data/rbi/stripe/services/subscription_schedule_service.rbi +1192 -0
  382. data/rbi/stripe/services/subscription_service.rbi +1596 -0
  383. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  384. data/rbi/stripe/services/tax/calculation_service.rbi +230 -0
  385. data/rbi/stripe/services/tax/registration_service.rbi +1689 -0
  386. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  387. data/{lib/stripe/services/financial_connections/account_inferred_balance_service.rb → rbi/stripe/services/tax/transaction_line_item_service.rbi} +17 -21
  388. data/rbi/stripe/services/tax/transaction_service.rbi +146 -0
  389. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  390. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  391. data/rbi/stripe/services/tax_rate_service.rbi +185 -0
  392. data/rbi/stripe/services/tax_service.rbi +12 -0
  393. data/rbi/stripe/services/terminal/configuration_service.rbi +1120 -0
  394. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  395. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  396. data/rbi/stripe/services/terminal/reader_service.rbi +344 -0
  397. data/rbi/stripe/services/terminal_service.rbi +12 -0
  398. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +746 -0
  399. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  400. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +848 -0
  401. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  402. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +69 -0
  403. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +711 -0
  404. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  405. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  406. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  407. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  408. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +92 -0
  409. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  410. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
  411. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
  412. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
  413. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
  414. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  415. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  416. data/rbi/stripe/services/token_service.rbi +1189 -0
  417. data/rbi/stripe/services/topup_service.rbi +176 -0
  418. data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
  419. data/rbi/stripe/services/transfer_service.rbi +152 -0
  420. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  421. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  422. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
  423. data/rbi/stripe/services/treasury/financial_account_service.rbi +562 -0
  424. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  425. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
  426. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
  427. data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
  428. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  429. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
  430. data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
  431. data/rbi/stripe/services/treasury_service.rbi +18 -0
  432. data/rbi/stripe/services/v1_services.rbi +77 -0
  433. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  434. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  435. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  436. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  437. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  438. data/rbi/stripe/services/v2/core/event_destination_service.rbi +200 -0
  439. data/rbi/stripe/services/v2/core/event_service.rbi +38 -0
  440. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  441. data/rbi/stripe/services/v2_services.rbi +10 -0
  442. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  443. data/stripe.gemspec +1 -4
  444. metadata +324 -140
  445. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +0 -23
  446. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +0 -21
  447. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +0 -23
  448. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +0 -21
  449. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +0 -23
  450. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +0 -21
  451. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +0 -21
  452. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +0 -21
  453. data/lib/stripe/events/v2_core_account_link_completed_event.rb +0 -13
  454. data/lib/stripe/events/v2_core_account_person_created_event.rb +0 -23
  455. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +0 -23
  456. data/lib/stripe/events/v2_core_account_person_updated_event.rb +0 -23
  457. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +0 -21
  458. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +0 -21
  459. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +0 -21
  460. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +0 -23
  461. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +0 -21
  462. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +0 -21
  463. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +0 -21
  464. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +0 -21
  465. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +0 -21
  466. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +0 -21
  467. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +0 -21
  468. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +0 -21
  469. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +0 -21
  470. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +0 -21
  471. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -21
  472. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -21
  473. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -21
  474. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -21
  475. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -21
  476. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +0 -23
  477. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +0 -21
  478. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +0 -21
  479. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +0 -21
  480. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -21
  481. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -21
  482. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -21
  483. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -21
  484. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -21
  485. data/lib/stripe/request_signing_authenticator.rb +0 -79
  486. data/lib/stripe/resources/account_notice.rb +0 -123
  487. data/lib/stripe/resources/balance_settings.rb +0 -101
  488. data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
  489. data/lib/stripe/resources/capital/financing_offer.rb +0 -179
  490. data/lib/stripe/resources/capital/financing_summary.rb +0 -55
  491. data/lib/stripe/resources/capital/financing_transaction.rb +0 -114
  492. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  493. data/lib/stripe/resources/financial_connections/institution.rb +0 -90
  494. data/lib/stripe/resources/gift_cards/card.rb +0 -208
  495. data/lib/stripe/resources/gift_cards/transaction.rb +0 -272
  496. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -602
  497. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -82
  498. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -86
  499. data/lib/stripe/resources/issuing/settlement.rb +0 -53
  500. data/lib/stripe/resources/margin.rb +0 -115
  501. data/lib/stripe/resources/order.rb +0 -2859
  502. data/lib/stripe/resources/payment_attempt_record.rb +0 -1078
  503. data/lib/stripe/resources/payment_record.rb +0 -1607
  504. data/lib/stripe/resources/quote_line.rb +0 -274
  505. data/lib/stripe/resources/quote_preview_invoice.rb +0 -663
  506. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -337
  507. data/lib/stripe/resources/tax/association.rb +0 -89
  508. data/lib/stripe/resources/tax/form.rb +0 -211
  509. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -31
  510. data/lib/stripe/resources/v2/core/account.rb +0 -1715
  511. data/lib/stripe/resources/v2/core/account_link.rb +0 -54
  512. data/lib/stripe/resources/v2/core/person.rb +0 -272
  513. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -72
  514. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -37
  515. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -18
  516. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -20
  517. data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -49
  518. data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -56
  519. data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -66
  520. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -92
  521. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -127
  522. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -74
  523. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -43
  524. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -115
  525. data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -73
  526. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -47
  527. data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -134
  528. data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -106
  529. data/lib/stripe/resources/v2/money_management/transaction.rb +0 -76
  530. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -66
  531. data/lib/stripe/services/account_notice_service.rb +0 -101
  532. data/lib/stripe/services/balance_settings_service.rb +0 -96
  533. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  534. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  535. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  536. data/lib/stripe/services/capital_service.rb +0 -15
  537. data/lib/stripe/services/external_account_service.rb +0 -206
  538. data/lib/stripe/services/gift_cards/card_service.rb +0 -170
  539. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
  540. data/lib/stripe/services/gift_cards_service.rb +0 -14
  541. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  542. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  543. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  544. data/lib/stripe/services/margin_service.rb +0 -119
  545. data/lib/stripe/services/order_service.rb +0 -2268
  546. data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
  547. data/lib/stripe/services/payment_record_service.rb +0 -542
  548. data/lib/stripe/services/tax/association_service.rb +0 -31
  549. data/lib/stripe/services/tax/form_service.rb +0 -100
  550. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  551. data/lib/stripe/services/v2/core/account_link_service.rb +0 -76
  552. data/lib/stripe/services/v2/core/account_service.rb +0 -4130
  553. data/lib/stripe/services/v2/core/accounts/person_service.rb +0 -1040
  554. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -135
  555. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -109
  556. data/lib/stripe/services/v2/core/vault_service.rb +0 -18
  557. data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -75
  558. data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -44
  559. data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -81
  560. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -126
  561. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -80
  562. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -202
  563. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -237
  564. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -174
  565. data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -95
  566. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -32
  567. data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -71
  568. data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -44
  569. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -70
  570. data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -74
  571. data/lib/stripe/services/v2/money_management_service.rb +0 -31
  572. data/lib/stripe/services/v2/test_helper_service.rb +0 -15
  573. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -50
  574. data/rbi/stripe.rbi +0 -189274
@@ -0,0 +1,1496 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ # `Source` objects allow you to accept a variety of payment methods. They
7
+ # represent a customer's payment instrument, and can be used with the Stripe API
8
+ # just like a `Card` object: once chargeable, they can be charged, or can be
9
+ # attached to customers.
10
+ #
11
+ # Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).
12
+ # We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).
13
+ # This newer API provides access to our latest features and payment method types.
14
+ #
15
+ # Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
16
+ class Source < APIResource
17
+ class AchCreditTransfer < Stripe::StripeObject
18
+ # Attribute for field account_number
19
+ sig { returns(T.nilable(String)) }
20
+ attr_reader :account_number
21
+ # Attribute for field bank_name
22
+ sig { returns(T.nilable(String)) }
23
+ attr_reader :bank_name
24
+ # Attribute for field fingerprint
25
+ sig { returns(T.nilable(String)) }
26
+ attr_reader :fingerprint
27
+ # Attribute for field refund_account_holder_name
28
+ sig { returns(T.nilable(String)) }
29
+ attr_reader :refund_account_holder_name
30
+ # Attribute for field refund_account_holder_type
31
+ sig { returns(T.nilable(String)) }
32
+ attr_reader :refund_account_holder_type
33
+ # Attribute for field refund_routing_number
34
+ sig { returns(T.nilable(String)) }
35
+ attr_reader :refund_routing_number
36
+ # Attribute for field routing_number
37
+ sig { returns(T.nilable(String)) }
38
+ attr_reader :routing_number
39
+ # Attribute for field swift_code
40
+ sig { returns(T.nilable(String)) }
41
+ attr_reader :swift_code
42
+ end
43
+ class AchDebit < Stripe::StripeObject
44
+ # Attribute for field bank_name
45
+ sig { returns(T.nilable(String)) }
46
+ attr_reader :bank_name
47
+ # Attribute for field country
48
+ sig { returns(T.nilable(String)) }
49
+ attr_reader :country
50
+ # Attribute for field fingerprint
51
+ sig { returns(T.nilable(String)) }
52
+ attr_reader :fingerprint
53
+ # Attribute for field last4
54
+ sig { returns(T.nilable(String)) }
55
+ attr_reader :last4
56
+ # Attribute for field routing_number
57
+ sig { returns(T.nilable(String)) }
58
+ attr_reader :routing_number
59
+ # Attribute for field type
60
+ sig { returns(T.nilable(String)) }
61
+ attr_reader :type
62
+ end
63
+ class AcssDebit < Stripe::StripeObject
64
+ # Attribute for field bank_address_city
65
+ sig { returns(T.nilable(String)) }
66
+ attr_reader :bank_address_city
67
+ # Attribute for field bank_address_line_1
68
+ sig { returns(T.nilable(String)) }
69
+ attr_reader :bank_address_line_1
70
+ # Attribute for field bank_address_line_2
71
+ sig { returns(T.nilable(String)) }
72
+ attr_reader :bank_address_line_2
73
+ # Attribute for field bank_address_postal_code
74
+ sig { returns(T.nilable(String)) }
75
+ attr_reader :bank_address_postal_code
76
+ # Attribute for field bank_name
77
+ sig { returns(T.nilable(String)) }
78
+ attr_reader :bank_name
79
+ # Attribute for field category
80
+ sig { returns(T.nilable(String)) }
81
+ attr_reader :category
82
+ # Attribute for field country
83
+ sig { returns(T.nilable(String)) }
84
+ attr_reader :country
85
+ # Attribute for field fingerprint
86
+ sig { returns(T.nilable(String)) }
87
+ attr_reader :fingerprint
88
+ # Attribute for field last4
89
+ sig { returns(T.nilable(String)) }
90
+ attr_reader :last4
91
+ # Attribute for field routing_number
92
+ sig { returns(T.nilable(String)) }
93
+ attr_reader :routing_number
94
+ end
95
+ class Alipay < Stripe::StripeObject
96
+ # Attribute for field data_string
97
+ sig { returns(T.nilable(String)) }
98
+ attr_reader :data_string
99
+ # Attribute for field native_url
100
+ sig { returns(T.nilable(String)) }
101
+ attr_reader :native_url
102
+ # Attribute for field statement_descriptor
103
+ sig { returns(T.nilable(String)) }
104
+ attr_reader :statement_descriptor
105
+ end
106
+ class AuBecsDebit < Stripe::StripeObject
107
+ # Attribute for field bsb_number
108
+ sig { returns(T.nilable(String)) }
109
+ attr_reader :bsb_number
110
+ # Attribute for field fingerprint
111
+ sig { returns(T.nilable(String)) }
112
+ attr_reader :fingerprint
113
+ # Attribute for field last4
114
+ sig { returns(T.nilable(String)) }
115
+ attr_reader :last4
116
+ end
117
+ class Bancontact < Stripe::StripeObject
118
+ # Attribute for field bank_code
119
+ sig { returns(T.nilable(String)) }
120
+ attr_reader :bank_code
121
+ # Attribute for field bank_name
122
+ sig { returns(T.nilable(String)) }
123
+ attr_reader :bank_name
124
+ # Attribute for field bic
125
+ sig { returns(T.nilable(String)) }
126
+ attr_reader :bic
127
+ # Attribute for field iban_last4
128
+ sig { returns(T.nilable(String)) }
129
+ attr_reader :iban_last4
130
+ # Attribute for field preferred_language
131
+ sig { returns(T.nilable(String)) }
132
+ attr_reader :preferred_language
133
+ # Attribute for field statement_descriptor
134
+ sig { returns(T.nilable(String)) }
135
+ attr_reader :statement_descriptor
136
+ end
137
+ class Card < Stripe::StripeObject
138
+ # Attribute for field address_line1_check
139
+ sig { returns(T.nilable(String)) }
140
+ attr_reader :address_line1_check
141
+ # Attribute for field address_zip_check
142
+ sig { returns(T.nilable(String)) }
143
+ attr_reader :address_zip_check
144
+ # Attribute for field brand
145
+ sig { returns(T.nilable(String)) }
146
+ attr_reader :brand
147
+ # Attribute for field country
148
+ sig { returns(T.nilable(String)) }
149
+ attr_reader :country
150
+ # Attribute for field cvc_check
151
+ sig { returns(T.nilable(String)) }
152
+ attr_reader :cvc_check
153
+ # Attribute for field description
154
+ sig { returns(String) }
155
+ attr_reader :description
156
+ # Attribute for field dynamic_last4
157
+ sig { returns(T.nilable(String)) }
158
+ attr_reader :dynamic_last4
159
+ # Attribute for field exp_month
160
+ sig { returns(T.nilable(Integer)) }
161
+ attr_reader :exp_month
162
+ # Attribute for field exp_year
163
+ sig { returns(T.nilable(Integer)) }
164
+ attr_reader :exp_year
165
+ # Attribute for field fingerprint
166
+ sig { returns(String) }
167
+ attr_reader :fingerprint
168
+ # Attribute for field funding
169
+ sig { returns(T.nilable(String)) }
170
+ attr_reader :funding
171
+ # Attribute for field iin
172
+ sig { returns(String) }
173
+ attr_reader :iin
174
+ # Attribute for field issuer
175
+ sig { returns(String) }
176
+ attr_reader :issuer
177
+ # Attribute for field last4
178
+ sig { returns(T.nilable(String)) }
179
+ attr_reader :last4
180
+ # Attribute for field name
181
+ sig { returns(T.nilable(String)) }
182
+ attr_reader :name
183
+ # Attribute for field three_d_secure
184
+ sig { returns(String) }
185
+ attr_reader :three_d_secure
186
+ # Attribute for field tokenization_method
187
+ sig { returns(T.nilable(String)) }
188
+ attr_reader :tokenization_method
189
+ end
190
+ class CardPresent < Stripe::StripeObject
191
+ # Attribute for field application_cryptogram
192
+ sig { returns(String) }
193
+ attr_reader :application_cryptogram
194
+ # Attribute for field application_preferred_name
195
+ sig { returns(String) }
196
+ attr_reader :application_preferred_name
197
+ # Attribute for field authorization_code
198
+ sig { returns(T.nilable(String)) }
199
+ attr_reader :authorization_code
200
+ # Attribute for field authorization_response_code
201
+ sig { returns(String) }
202
+ attr_reader :authorization_response_code
203
+ # Attribute for field brand
204
+ sig { returns(T.nilable(String)) }
205
+ attr_reader :brand
206
+ # Attribute for field country
207
+ sig { returns(T.nilable(String)) }
208
+ attr_reader :country
209
+ # Attribute for field cvm_type
210
+ sig { returns(String) }
211
+ attr_reader :cvm_type
212
+ # Attribute for field data_type
213
+ sig { returns(T.nilable(String)) }
214
+ attr_reader :data_type
215
+ # Attribute for field dedicated_file_name
216
+ sig { returns(String) }
217
+ attr_reader :dedicated_file_name
218
+ # Attribute for field description
219
+ sig { returns(String) }
220
+ attr_reader :description
221
+ # Attribute for field emv_auth_data
222
+ sig { returns(String) }
223
+ attr_reader :emv_auth_data
224
+ # Attribute for field evidence_customer_signature
225
+ sig { returns(T.nilable(String)) }
226
+ attr_reader :evidence_customer_signature
227
+ # Attribute for field evidence_transaction_certificate
228
+ sig { returns(T.nilable(String)) }
229
+ attr_reader :evidence_transaction_certificate
230
+ # Attribute for field exp_month
231
+ sig { returns(T.nilable(Integer)) }
232
+ attr_reader :exp_month
233
+ # Attribute for field exp_year
234
+ sig { returns(T.nilable(Integer)) }
235
+ attr_reader :exp_year
236
+ # Attribute for field fingerprint
237
+ sig { returns(String) }
238
+ attr_reader :fingerprint
239
+ # Attribute for field funding
240
+ sig { returns(T.nilable(String)) }
241
+ attr_reader :funding
242
+ # Attribute for field iin
243
+ sig { returns(String) }
244
+ attr_reader :iin
245
+ # Attribute for field issuer
246
+ sig { returns(String) }
247
+ attr_reader :issuer
248
+ # Attribute for field last4
249
+ sig { returns(T.nilable(String)) }
250
+ attr_reader :last4
251
+ # Attribute for field pos_device_id
252
+ sig { returns(T.nilable(String)) }
253
+ attr_reader :pos_device_id
254
+ # Attribute for field pos_entry_mode
255
+ sig { returns(String) }
256
+ attr_reader :pos_entry_mode
257
+ # Attribute for field read_method
258
+ sig { returns(T.nilable(String)) }
259
+ attr_reader :read_method
260
+ # Attribute for field reader
261
+ sig { returns(T.nilable(String)) }
262
+ attr_reader :reader
263
+ # Attribute for field terminal_verification_results
264
+ sig { returns(String) }
265
+ attr_reader :terminal_verification_results
266
+ # Attribute for field transaction_status_information
267
+ sig { returns(String) }
268
+ attr_reader :transaction_status_information
269
+ end
270
+ class CodeVerification < Stripe::StripeObject
271
+ # The number of attempts remaining to authenticate the source object with a verification code.
272
+ sig { returns(Integer) }
273
+ attr_reader :attempts_remaining
274
+ # The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0).
275
+ sig { returns(String) }
276
+ attr_reader :status
277
+ end
278
+ class Eps < Stripe::StripeObject
279
+ # Attribute for field reference
280
+ sig { returns(T.nilable(String)) }
281
+ attr_reader :reference
282
+ # Attribute for field statement_descriptor
283
+ sig { returns(T.nilable(String)) }
284
+ attr_reader :statement_descriptor
285
+ end
286
+ class Giropay < Stripe::StripeObject
287
+ # Attribute for field bank_code
288
+ sig { returns(T.nilable(String)) }
289
+ attr_reader :bank_code
290
+ # Attribute for field bank_name
291
+ sig { returns(T.nilable(String)) }
292
+ attr_reader :bank_name
293
+ # Attribute for field bic
294
+ sig { returns(T.nilable(String)) }
295
+ attr_reader :bic
296
+ # Attribute for field statement_descriptor
297
+ sig { returns(T.nilable(String)) }
298
+ attr_reader :statement_descriptor
299
+ end
300
+ class Ideal < Stripe::StripeObject
301
+ # Attribute for field bank
302
+ sig { returns(T.nilable(String)) }
303
+ attr_reader :bank
304
+ # Attribute for field bic
305
+ sig { returns(T.nilable(String)) }
306
+ attr_reader :bic
307
+ # Attribute for field iban_last4
308
+ sig { returns(T.nilable(String)) }
309
+ attr_reader :iban_last4
310
+ # Attribute for field statement_descriptor
311
+ sig { returns(T.nilable(String)) }
312
+ attr_reader :statement_descriptor
313
+ end
314
+ class Klarna < Stripe::StripeObject
315
+ # Attribute for field background_image_url
316
+ sig { returns(String) }
317
+ attr_reader :background_image_url
318
+ # Attribute for field client_token
319
+ sig { returns(T.nilable(String)) }
320
+ attr_reader :client_token
321
+ # Attribute for field first_name
322
+ sig { returns(String) }
323
+ attr_reader :first_name
324
+ # Attribute for field last_name
325
+ sig { returns(String) }
326
+ attr_reader :last_name
327
+ # Attribute for field locale
328
+ sig { returns(String) }
329
+ attr_reader :locale
330
+ # Attribute for field logo_url
331
+ sig { returns(String) }
332
+ attr_reader :logo_url
333
+ # Attribute for field page_title
334
+ sig { returns(String) }
335
+ attr_reader :page_title
336
+ # Attribute for field pay_later_asset_urls_descriptive
337
+ sig { returns(String) }
338
+ attr_reader :pay_later_asset_urls_descriptive
339
+ # Attribute for field pay_later_asset_urls_standard
340
+ sig { returns(String) }
341
+ attr_reader :pay_later_asset_urls_standard
342
+ # Attribute for field pay_later_name
343
+ sig { returns(String) }
344
+ attr_reader :pay_later_name
345
+ # Attribute for field pay_later_redirect_url
346
+ sig { returns(String) }
347
+ attr_reader :pay_later_redirect_url
348
+ # Attribute for field pay_now_asset_urls_descriptive
349
+ sig { returns(String) }
350
+ attr_reader :pay_now_asset_urls_descriptive
351
+ # Attribute for field pay_now_asset_urls_standard
352
+ sig { returns(String) }
353
+ attr_reader :pay_now_asset_urls_standard
354
+ # Attribute for field pay_now_name
355
+ sig { returns(String) }
356
+ attr_reader :pay_now_name
357
+ # Attribute for field pay_now_redirect_url
358
+ sig { returns(String) }
359
+ attr_reader :pay_now_redirect_url
360
+ # Attribute for field pay_over_time_asset_urls_descriptive
361
+ sig { returns(String) }
362
+ attr_reader :pay_over_time_asset_urls_descriptive
363
+ # Attribute for field pay_over_time_asset_urls_standard
364
+ sig { returns(String) }
365
+ attr_reader :pay_over_time_asset_urls_standard
366
+ # Attribute for field pay_over_time_name
367
+ sig { returns(String) }
368
+ attr_reader :pay_over_time_name
369
+ # Attribute for field pay_over_time_redirect_url
370
+ sig { returns(String) }
371
+ attr_reader :pay_over_time_redirect_url
372
+ # Attribute for field payment_method_categories
373
+ sig { returns(String) }
374
+ attr_reader :payment_method_categories
375
+ # Attribute for field purchase_country
376
+ sig { returns(String) }
377
+ attr_reader :purchase_country
378
+ # Attribute for field purchase_type
379
+ sig { returns(String) }
380
+ attr_reader :purchase_type
381
+ # Attribute for field redirect_url
382
+ sig { returns(String) }
383
+ attr_reader :redirect_url
384
+ # Attribute for field shipping_delay
385
+ sig { returns(Integer) }
386
+ attr_reader :shipping_delay
387
+ # Attribute for field shipping_first_name
388
+ sig { returns(String) }
389
+ attr_reader :shipping_first_name
390
+ # Attribute for field shipping_last_name
391
+ sig { returns(String) }
392
+ attr_reader :shipping_last_name
393
+ end
394
+ class Multibanco < Stripe::StripeObject
395
+ # Attribute for field entity
396
+ sig { returns(T.nilable(String)) }
397
+ attr_reader :entity
398
+ # Attribute for field reference
399
+ sig { returns(T.nilable(String)) }
400
+ attr_reader :reference
401
+ # Attribute for field refund_account_holder_address_city
402
+ sig { returns(T.nilable(String)) }
403
+ attr_reader :refund_account_holder_address_city
404
+ # Attribute for field refund_account_holder_address_country
405
+ sig { returns(T.nilable(String)) }
406
+ attr_reader :refund_account_holder_address_country
407
+ # Attribute for field refund_account_holder_address_line1
408
+ sig { returns(T.nilable(String)) }
409
+ attr_reader :refund_account_holder_address_line1
410
+ # Attribute for field refund_account_holder_address_line2
411
+ sig { returns(T.nilable(String)) }
412
+ attr_reader :refund_account_holder_address_line2
413
+ # Attribute for field refund_account_holder_address_postal_code
414
+ sig { returns(T.nilable(String)) }
415
+ attr_reader :refund_account_holder_address_postal_code
416
+ # Attribute for field refund_account_holder_address_state
417
+ sig { returns(T.nilable(String)) }
418
+ attr_reader :refund_account_holder_address_state
419
+ # Attribute for field refund_account_holder_name
420
+ sig { returns(T.nilable(String)) }
421
+ attr_reader :refund_account_holder_name
422
+ # Attribute for field refund_iban
423
+ sig { returns(T.nilable(String)) }
424
+ attr_reader :refund_iban
425
+ end
426
+ class Owner < Stripe::StripeObject
427
+ class Address < Stripe::StripeObject
428
+ # City, district, suburb, town, or village.
429
+ sig { returns(T.nilable(String)) }
430
+ attr_reader :city
431
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
432
+ sig { returns(T.nilable(String)) }
433
+ attr_reader :country
434
+ # Address line 1 (e.g., street, PO Box, or company name).
435
+ sig { returns(T.nilable(String)) }
436
+ attr_reader :line1
437
+ # Address line 2 (e.g., apartment, suite, unit, or building).
438
+ sig { returns(T.nilable(String)) }
439
+ attr_reader :line2
440
+ # ZIP or postal code.
441
+ sig { returns(T.nilable(String)) }
442
+ attr_reader :postal_code
443
+ # State, county, province, or region.
444
+ sig { returns(T.nilable(String)) }
445
+ attr_reader :state
446
+ end
447
+ class VerifiedAddress < Stripe::StripeObject
448
+ # City, district, suburb, town, or village.
449
+ sig { returns(T.nilable(String)) }
450
+ attr_reader :city
451
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
452
+ sig { returns(T.nilable(String)) }
453
+ attr_reader :country
454
+ # Address line 1 (e.g., street, PO Box, or company name).
455
+ sig { returns(T.nilable(String)) }
456
+ attr_reader :line1
457
+ # Address line 2 (e.g., apartment, suite, unit, or building).
458
+ sig { returns(T.nilable(String)) }
459
+ attr_reader :line2
460
+ # ZIP or postal code.
461
+ sig { returns(T.nilable(String)) }
462
+ attr_reader :postal_code
463
+ # State, county, province, or region.
464
+ sig { returns(T.nilable(String)) }
465
+ attr_reader :state
466
+ end
467
+ # Owner's address.
468
+ sig { returns(T.nilable(Address)) }
469
+ attr_reader :address
470
+ # Owner's email address.
471
+ sig { returns(T.nilable(String)) }
472
+ attr_reader :email
473
+ # Owner's full name.
474
+ sig { returns(T.nilable(String)) }
475
+ attr_reader :name
476
+ # Owner's phone number (including extension).
477
+ sig { returns(T.nilable(String)) }
478
+ attr_reader :phone
479
+ # Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
480
+ sig { returns(T.nilable(VerifiedAddress)) }
481
+ attr_reader :verified_address
482
+ # Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
483
+ sig { returns(T.nilable(String)) }
484
+ attr_reader :verified_email
485
+ # Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
486
+ sig { returns(T.nilable(String)) }
487
+ attr_reader :verified_name
488
+ # Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
489
+ sig { returns(T.nilable(String)) }
490
+ attr_reader :verified_phone
491
+ end
492
+ class P24 < Stripe::StripeObject
493
+ # Attribute for field reference
494
+ sig { returns(T.nilable(String)) }
495
+ attr_reader :reference
496
+ end
497
+ class Receiver < Stripe::StripeObject
498
+ # The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
499
+ sig { returns(T.nilable(String)) }
500
+ attr_reader :address
501
+ # The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
502
+ sig { returns(Integer) }
503
+ attr_reader :amount_charged
504
+ # The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
505
+ sig { returns(Integer) }
506
+ attr_reader :amount_received
507
+ # The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
508
+ sig { returns(Integer) }
509
+ attr_reader :amount_returned
510
+ # Type of refund attribute method, one of `email`, `manual`, or `none`.
511
+ sig { returns(String) }
512
+ attr_reader :refund_attributes_method
513
+ # Type of refund attribute status, one of `missing`, `requested`, or `available`.
514
+ sig { returns(String) }
515
+ attr_reader :refund_attributes_status
516
+ end
517
+ class Redirect < Stripe::StripeObject
518
+ # The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`.
519
+ sig { returns(T.nilable(String)) }
520
+ attr_reader :failure_reason
521
+ # The URL you provide to redirect the customer to after they authenticated their payment.
522
+ sig { returns(String) }
523
+ attr_reader :return_url
524
+ # The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused).
525
+ sig { returns(String) }
526
+ attr_reader :status
527
+ # The URL provided to you to redirect a customer to as part of a `redirect` authentication flow.
528
+ sig { returns(String) }
529
+ attr_reader :url
530
+ end
531
+ class SepaCreditTransfer < Stripe::StripeObject
532
+ # Attribute for field bank_name
533
+ sig { returns(T.nilable(String)) }
534
+ attr_reader :bank_name
535
+ # Attribute for field bic
536
+ sig { returns(T.nilable(String)) }
537
+ attr_reader :bic
538
+ # Attribute for field iban
539
+ sig { returns(T.nilable(String)) }
540
+ attr_reader :iban
541
+ # Attribute for field refund_account_holder_address_city
542
+ sig { returns(T.nilable(String)) }
543
+ attr_reader :refund_account_holder_address_city
544
+ # Attribute for field refund_account_holder_address_country
545
+ sig { returns(T.nilable(String)) }
546
+ attr_reader :refund_account_holder_address_country
547
+ # Attribute for field refund_account_holder_address_line1
548
+ sig { returns(T.nilable(String)) }
549
+ attr_reader :refund_account_holder_address_line1
550
+ # Attribute for field refund_account_holder_address_line2
551
+ sig { returns(T.nilable(String)) }
552
+ attr_reader :refund_account_holder_address_line2
553
+ # Attribute for field refund_account_holder_address_postal_code
554
+ sig { returns(T.nilable(String)) }
555
+ attr_reader :refund_account_holder_address_postal_code
556
+ # Attribute for field refund_account_holder_address_state
557
+ sig { returns(T.nilable(String)) }
558
+ attr_reader :refund_account_holder_address_state
559
+ # Attribute for field refund_account_holder_name
560
+ sig { returns(T.nilable(String)) }
561
+ attr_reader :refund_account_holder_name
562
+ # Attribute for field refund_iban
563
+ sig { returns(T.nilable(String)) }
564
+ attr_reader :refund_iban
565
+ end
566
+ class SepaDebit < Stripe::StripeObject
567
+ # Attribute for field bank_code
568
+ sig { returns(T.nilable(String)) }
569
+ attr_reader :bank_code
570
+ # Attribute for field branch_code
571
+ sig { returns(T.nilable(String)) }
572
+ attr_reader :branch_code
573
+ # Attribute for field country
574
+ sig { returns(T.nilable(String)) }
575
+ attr_reader :country
576
+ # Attribute for field fingerprint
577
+ sig { returns(T.nilable(String)) }
578
+ attr_reader :fingerprint
579
+ # Attribute for field last4
580
+ sig { returns(T.nilable(String)) }
581
+ attr_reader :last4
582
+ # Attribute for field mandate_reference
583
+ sig { returns(T.nilable(String)) }
584
+ attr_reader :mandate_reference
585
+ # Attribute for field mandate_url
586
+ sig { returns(T.nilable(String)) }
587
+ attr_reader :mandate_url
588
+ end
589
+ class Sofort < Stripe::StripeObject
590
+ # Attribute for field bank_code
591
+ sig { returns(T.nilable(String)) }
592
+ attr_reader :bank_code
593
+ # Attribute for field bank_name
594
+ sig { returns(T.nilable(String)) }
595
+ attr_reader :bank_name
596
+ # Attribute for field bic
597
+ sig { returns(T.nilable(String)) }
598
+ attr_reader :bic
599
+ # Attribute for field country
600
+ sig { returns(T.nilable(String)) }
601
+ attr_reader :country
602
+ # Attribute for field iban_last4
603
+ sig { returns(T.nilable(String)) }
604
+ attr_reader :iban_last4
605
+ # Attribute for field preferred_language
606
+ sig { returns(T.nilable(String)) }
607
+ attr_reader :preferred_language
608
+ # Attribute for field statement_descriptor
609
+ sig { returns(T.nilable(String)) }
610
+ attr_reader :statement_descriptor
611
+ end
612
+ class SourceOrder < Stripe::StripeObject
613
+ class Item < Stripe::StripeObject
614
+ # The amount (price) for this order item.
615
+ sig { returns(T.nilable(Integer)) }
616
+ attr_reader :amount
617
+ # This currency of this order item. Required when `amount` is present.
618
+ sig { returns(T.nilable(String)) }
619
+ attr_reader :currency
620
+ # Human-readable description for this order item.
621
+ sig { returns(T.nilable(String)) }
622
+ attr_reader :description
623
+ # The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).
624
+ sig { returns(T.nilable(String)) }
625
+ attr_reader :parent
626
+ # The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
627
+ sig { returns(Integer) }
628
+ attr_reader :quantity
629
+ # The type of this order item. Must be `sku`, `tax`, or `shipping`.
630
+ sig { returns(T.nilable(String)) }
631
+ attr_reader :type
632
+ end
633
+ class Shipping < Stripe::StripeObject
634
+ class Address < Stripe::StripeObject
635
+ # City, district, suburb, town, or village.
636
+ sig { returns(T.nilable(String)) }
637
+ attr_reader :city
638
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
639
+ sig { returns(T.nilable(String)) }
640
+ attr_reader :country
641
+ # Address line 1 (e.g., street, PO Box, or company name).
642
+ sig { returns(T.nilable(String)) }
643
+ attr_reader :line1
644
+ # Address line 2 (e.g., apartment, suite, unit, or building).
645
+ sig { returns(T.nilable(String)) }
646
+ attr_reader :line2
647
+ # ZIP or postal code.
648
+ sig { returns(T.nilable(String)) }
649
+ attr_reader :postal_code
650
+ # State, county, province, or region.
651
+ sig { returns(T.nilable(String)) }
652
+ attr_reader :state
653
+ end
654
+ # Attribute for field address
655
+ sig { returns(Address) }
656
+ attr_reader :address
657
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
658
+ sig { returns(T.nilable(String)) }
659
+ attr_reader :carrier
660
+ # Recipient name.
661
+ sig { returns(String) }
662
+ attr_reader :name
663
+ # Recipient phone (including extension).
664
+ sig { returns(T.nilable(String)) }
665
+ attr_reader :phone
666
+ # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
667
+ sig { returns(T.nilable(String)) }
668
+ attr_reader :tracking_number
669
+ end
670
+ # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
671
+ sig { returns(Integer) }
672
+ attr_reader :amount
673
+ # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
674
+ sig { returns(String) }
675
+ attr_reader :currency
676
+ # The email address of the customer placing the order.
677
+ sig { returns(String) }
678
+ attr_reader :email
679
+ # List of items constituting the order.
680
+ sig { returns(T.nilable(T::Array[Item])) }
681
+ attr_reader :items
682
+ # Attribute for field shipping
683
+ sig { returns(Shipping) }
684
+ attr_reader :shipping
685
+ end
686
+ class ThreeDSecure < Stripe::StripeObject
687
+ # Attribute for field address_line1_check
688
+ sig { returns(T.nilable(String)) }
689
+ attr_reader :address_line1_check
690
+ # Attribute for field address_zip_check
691
+ sig { returns(T.nilable(String)) }
692
+ attr_reader :address_zip_check
693
+ # Attribute for field authenticated
694
+ sig { returns(T.nilable(T::Boolean)) }
695
+ attr_reader :authenticated
696
+ # Attribute for field brand
697
+ sig { returns(T.nilable(String)) }
698
+ attr_reader :brand
699
+ # Attribute for field card
700
+ sig { returns(T.nilable(String)) }
701
+ attr_reader :card
702
+ # Attribute for field country
703
+ sig { returns(T.nilable(String)) }
704
+ attr_reader :country
705
+ # Attribute for field customer
706
+ sig { returns(T.nilable(String)) }
707
+ attr_reader :customer
708
+ # Attribute for field cvc_check
709
+ sig { returns(T.nilable(String)) }
710
+ attr_reader :cvc_check
711
+ # Attribute for field description
712
+ sig { returns(String) }
713
+ attr_reader :description
714
+ # Attribute for field dynamic_last4
715
+ sig { returns(T.nilable(String)) }
716
+ attr_reader :dynamic_last4
717
+ # Attribute for field exp_month
718
+ sig { returns(T.nilable(Integer)) }
719
+ attr_reader :exp_month
720
+ # Attribute for field exp_year
721
+ sig { returns(T.nilable(Integer)) }
722
+ attr_reader :exp_year
723
+ # Attribute for field fingerprint
724
+ sig { returns(String) }
725
+ attr_reader :fingerprint
726
+ # Attribute for field funding
727
+ sig { returns(T.nilable(String)) }
728
+ attr_reader :funding
729
+ # Attribute for field iin
730
+ sig { returns(String) }
731
+ attr_reader :iin
732
+ # Attribute for field issuer
733
+ sig { returns(String) }
734
+ attr_reader :issuer
735
+ # Attribute for field last4
736
+ sig { returns(T.nilable(String)) }
737
+ attr_reader :last4
738
+ # Attribute for field name
739
+ sig { returns(T.nilable(String)) }
740
+ attr_reader :name
741
+ # Attribute for field three_d_secure
742
+ sig { returns(String) }
743
+ attr_reader :three_d_secure
744
+ # Attribute for field tokenization_method
745
+ sig { returns(T.nilable(String)) }
746
+ attr_reader :tokenization_method
747
+ end
748
+ class Wechat < Stripe::StripeObject
749
+ # Attribute for field prepay_id
750
+ sig { returns(String) }
751
+ attr_reader :prepay_id
752
+ # Attribute for field qr_code_url
753
+ sig { returns(T.nilable(String)) }
754
+ attr_reader :qr_code_url
755
+ # Attribute for field statement_descriptor
756
+ sig { returns(String) }
757
+ attr_reader :statement_descriptor
758
+ end
759
+ # Attribute for field ach_credit_transfer
760
+ sig { returns(AchCreditTransfer) }
761
+ attr_reader :ach_credit_transfer
762
+ # Attribute for field ach_debit
763
+ sig { returns(AchDebit) }
764
+ attr_reader :ach_debit
765
+ # Attribute for field acss_debit
766
+ sig { returns(AcssDebit) }
767
+ attr_reader :acss_debit
768
+ # Attribute for field alipay
769
+ sig { returns(Alipay) }
770
+ attr_reader :alipay
771
+ # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
772
+ sig { returns(T.nilable(String)) }
773
+ attr_reader :allow_redisplay
774
+ # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.
775
+ sig { returns(T.nilable(Integer)) }
776
+ attr_reader :amount
777
+ # Attribute for field au_becs_debit
778
+ sig { returns(AuBecsDebit) }
779
+ attr_reader :au_becs_debit
780
+ # Attribute for field bancontact
781
+ sig { returns(Bancontact) }
782
+ attr_reader :bancontact
783
+ # Attribute for field card
784
+ sig { returns(Card) }
785
+ attr_reader :card
786
+ # Attribute for field card_present
787
+ sig { returns(CardPresent) }
788
+ attr_reader :card_present
789
+ # The client secret of the source. Used for client-side retrieval using a publishable key.
790
+ sig { returns(String) }
791
+ attr_reader :client_secret
792
+ # Attribute for field code_verification
793
+ sig { returns(CodeVerification) }
794
+ attr_reader :code_verification
795
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
796
+ sig { returns(Integer) }
797
+ attr_reader :created
798
+ # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.
799
+ sig { returns(T.nilable(String)) }
800
+ attr_reader :currency
801
+ # The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
802
+ sig { returns(String) }
803
+ attr_reader :customer
804
+ # Attribute for field eps
805
+ sig { returns(Eps) }
806
+ attr_reader :eps
807
+ # The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.
808
+ sig { returns(String) }
809
+ attr_reader :flow
810
+ # Attribute for field giropay
811
+ sig { returns(Giropay) }
812
+ attr_reader :giropay
813
+ # Unique identifier for the object.
814
+ sig { returns(String) }
815
+ attr_reader :id
816
+ # Attribute for field ideal
817
+ sig { returns(Ideal) }
818
+ attr_reader :ideal
819
+ # Attribute for field klarna
820
+ sig { returns(Klarna) }
821
+ attr_reader :klarna
822
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
823
+ sig { returns(T::Boolean) }
824
+ attr_reader :livemode
825
+ # 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.
826
+ sig { returns(T.nilable(T::Hash[String, String])) }
827
+ attr_reader :metadata
828
+ # Attribute for field multibanco
829
+ sig { returns(Multibanco) }
830
+ attr_reader :multibanco
831
+ # String representing the object's type. Objects of the same type share the same value.
832
+ sig { returns(String) }
833
+ attr_reader :object
834
+ # Information about the owner of the payment instrument that may be used or required by particular source types.
835
+ sig { returns(T.nilable(Owner)) }
836
+ attr_reader :owner
837
+ # Attribute for field p24
838
+ sig { returns(P24) }
839
+ attr_reader :p24
840
+ # Attribute for field receiver
841
+ sig { returns(Receiver) }
842
+ attr_reader :receiver
843
+ # Attribute for field redirect
844
+ sig { returns(Redirect) }
845
+ attr_reader :redirect
846
+ # Attribute for field sepa_credit_transfer
847
+ sig { returns(SepaCreditTransfer) }
848
+ attr_reader :sepa_credit_transfer
849
+ # Attribute for field sepa_debit
850
+ sig { returns(SepaDebit) }
851
+ attr_reader :sepa_debit
852
+ # Attribute for field sofort
853
+ sig { returns(Sofort) }
854
+ attr_reader :sofort
855
+ # Attribute for field source_order
856
+ sig { returns(SourceOrder) }
857
+ attr_reader :source_order
858
+ # Extra information about a source. This will appear on your customer's statement every time you charge the source.
859
+ sig { returns(T.nilable(String)) }
860
+ attr_reader :statement_descriptor
861
+ # The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.
862
+ sig { returns(String) }
863
+ attr_reader :status
864
+ # Attribute for field three_d_secure
865
+ sig { returns(ThreeDSecure) }
866
+ attr_reader :three_d_secure
867
+ # The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.
868
+ sig { returns(String) }
869
+ attr_reader :type
870
+ # Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
871
+ sig { returns(T.nilable(String)) }
872
+ attr_reader :usage
873
+ # Attribute for field wechat
874
+ sig { returns(Wechat) }
875
+ attr_reader :wechat
876
+ class UpdateParams < Stripe::RequestParams
877
+ class Mandate < Stripe::RequestParams
878
+ class Acceptance < Stripe::RequestParams
879
+ class Offline < Stripe::RequestParams
880
+ # An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.
881
+ sig { returns(String) }
882
+ attr_accessor :contact_email
883
+ sig { params(contact_email: String).void }
884
+ def initialize(contact_email: nil); end
885
+ end
886
+ class Online < Stripe::RequestParams
887
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
888
+ sig { returns(T.nilable(Integer)) }
889
+ attr_accessor :date
890
+ # The IP address from which the mandate was accepted or refused by the customer.
891
+ sig { returns(T.nilable(String)) }
892
+ attr_accessor :ip
893
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
894
+ sig { returns(T.nilable(String)) }
895
+ attr_accessor :user_agent
896
+ sig {
897
+ params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
898
+ }
899
+ def initialize(date: nil, ip: nil, user_agent: nil); end
900
+ end
901
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
902
+ sig { returns(T.nilable(Integer)) }
903
+ attr_accessor :date
904
+ # The IP address from which the mandate was accepted or refused by the customer.
905
+ sig { returns(T.nilable(String)) }
906
+ attr_accessor :ip
907
+ # The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`
908
+ sig { returns(T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Offline)) }
909
+ attr_accessor :offline
910
+ # The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`
911
+ sig { returns(T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Online)) }
912
+ attr_accessor :online
913
+ # The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).
914
+ sig { returns(String) }
915
+ attr_accessor :status
916
+ # The type of acceptance information included with the mandate. Either `online` or `offline`
917
+ sig { returns(T.nilable(String)) }
918
+ attr_accessor :type
919
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
920
+ sig { returns(T.nilable(String)) }
921
+ attr_accessor :user_agent
922
+ sig {
923
+ params(date: T.nilable(Integer), ip: T.nilable(String), offline: T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Offline), online: T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance::Online), status: String, type: T.nilable(String), user_agent: T.nilable(String)).void
924
+ }
925
+ def initialize(
926
+ date: nil,
927
+ ip: nil,
928
+ offline: nil,
929
+ online: nil,
930
+ status: nil,
931
+ type: nil,
932
+ user_agent: nil
933
+ ); end
934
+ end
935
+ # The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
936
+ sig { returns(T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance)) }
937
+ attr_accessor :acceptance
938
+ # The amount specified by the mandate. (Leave null for a mandate covering all amounts)
939
+ sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
940
+ attr_accessor :amount
941
+ # The currency specified by the mandate. (Must match `currency` of the source)
942
+ sig { returns(T.nilable(String)) }
943
+ attr_accessor :currency
944
+ # The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)
945
+ sig { returns(T.nilable(String)) }
946
+ attr_accessor :interval
947
+ # The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).
948
+ sig { returns(T.nilable(String)) }
949
+ attr_accessor :notification_method
950
+ sig {
951
+ params(acceptance: T.nilable(::Stripe::Source::UpdateParams::Mandate::Acceptance), amount: T.nilable(T.nilable(T.any(String, Integer))), currency: T.nilable(String), interval: T.nilable(String), notification_method: T.nilable(String)).void
952
+ }
953
+ def initialize(
954
+ acceptance: nil,
955
+ amount: nil,
956
+ currency: nil,
957
+ interval: nil,
958
+ notification_method: nil
959
+ ); end
960
+ end
961
+ class Owner < Stripe::RequestParams
962
+ class Address < Stripe::RequestParams
963
+ # City, district, suburb, town, or village.
964
+ sig { returns(T.nilable(String)) }
965
+ attr_accessor :city
966
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
967
+ sig { returns(T.nilable(String)) }
968
+ attr_accessor :country
969
+ # Address line 1 (e.g., street, PO Box, or company name).
970
+ sig { returns(T.nilable(String)) }
971
+ attr_accessor :line1
972
+ # Address line 2 (e.g., apartment, suite, unit, or building).
973
+ sig { returns(T.nilable(String)) }
974
+ attr_accessor :line2
975
+ # ZIP or postal code.
976
+ sig { returns(T.nilable(String)) }
977
+ attr_accessor :postal_code
978
+ # State, county, province, or region.
979
+ sig { returns(T.nilable(String)) }
980
+ attr_accessor :state
981
+ sig {
982
+ 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
983
+ }
984
+ def initialize(
985
+ city: nil,
986
+ country: nil,
987
+ line1: nil,
988
+ line2: nil,
989
+ postal_code: nil,
990
+ state: nil
991
+ ); end
992
+ end
993
+ # Owner's address.
994
+ sig { returns(T.nilable(::Stripe::Source::UpdateParams::Owner::Address)) }
995
+ attr_accessor :address
996
+ # Owner's email address.
997
+ sig { returns(T.nilable(String)) }
998
+ attr_accessor :email
999
+ # Owner's full name.
1000
+ sig { returns(T.nilable(String)) }
1001
+ attr_accessor :name
1002
+ # Owner's phone number.
1003
+ sig { returns(T.nilable(String)) }
1004
+ attr_accessor :phone
1005
+ sig {
1006
+ params(address: T.nilable(::Stripe::Source::UpdateParams::Owner::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
1007
+ }
1008
+ def initialize(address: nil, email: nil, name: nil, phone: nil); end
1009
+ end
1010
+ class SourceOrder < Stripe::RequestParams
1011
+ class Item < Stripe::RequestParams
1012
+ # Attribute for param field amount
1013
+ sig { returns(T.nilable(Integer)) }
1014
+ attr_accessor :amount
1015
+ # Attribute for param field currency
1016
+ sig { returns(T.nilable(String)) }
1017
+ attr_accessor :currency
1018
+ # Attribute for param field description
1019
+ sig { returns(T.nilable(String)) }
1020
+ attr_accessor :description
1021
+ # The ID of the SKU being ordered.
1022
+ sig { returns(T.nilable(String)) }
1023
+ attr_accessor :parent
1024
+ # The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
1025
+ sig { returns(T.nilable(Integer)) }
1026
+ attr_accessor :quantity
1027
+ # Attribute for param field type
1028
+ sig { returns(T.nilable(String)) }
1029
+ attr_accessor :type
1030
+ sig {
1031
+ params(amount: T.nilable(Integer), currency: T.nilable(String), description: T.nilable(String), parent: T.nilable(String), quantity: T.nilable(Integer), type: T.nilable(String)).void
1032
+ }
1033
+ def initialize(
1034
+ amount: nil,
1035
+ currency: nil,
1036
+ description: nil,
1037
+ parent: nil,
1038
+ quantity: nil,
1039
+ type: nil
1040
+ ); end
1041
+ end
1042
+ class Shipping < Stripe::RequestParams
1043
+ class Address < Stripe::RequestParams
1044
+ # City, district, suburb, town, or village.
1045
+ sig { returns(T.nilable(String)) }
1046
+ attr_accessor :city
1047
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1048
+ sig { returns(T.nilable(String)) }
1049
+ attr_accessor :country
1050
+ # Address line 1 (e.g., street, PO Box, or company name).
1051
+ sig { returns(String) }
1052
+ attr_accessor :line1
1053
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1054
+ sig { returns(T.nilable(String)) }
1055
+ attr_accessor :line2
1056
+ # ZIP or postal code.
1057
+ sig { returns(T.nilable(String)) }
1058
+ attr_accessor :postal_code
1059
+ # State, county, province, or region.
1060
+ sig { returns(T.nilable(String)) }
1061
+ attr_accessor :state
1062
+ sig {
1063
+ params(city: T.nilable(String), country: T.nilable(String), line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
1064
+ }
1065
+ def initialize(
1066
+ city: nil,
1067
+ country: nil,
1068
+ line1: nil,
1069
+ line2: nil,
1070
+ postal_code: nil,
1071
+ state: nil
1072
+ ); end
1073
+ end
1074
+ # Shipping address.
1075
+ sig { returns(::Stripe::Source::UpdateParams::SourceOrder::Shipping::Address) }
1076
+ attr_accessor :address
1077
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1078
+ sig { returns(T.nilable(String)) }
1079
+ attr_accessor :carrier
1080
+ # Recipient name.
1081
+ sig { returns(T.nilable(String)) }
1082
+ attr_accessor :name
1083
+ # Recipient phone (including extension).
1084
+ sig { returns(T.nilable(String)) }
1085
+ attr_accessor :phone
1086
+ # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
1087
+ sig { returns(T.nilable(String)) }
1088
+ attr_accessor :tracking_number
1089
+ sig {
1090
+ params(address: ::Stripe::Source::UpdateParams::SourceOrder::Shipping::Address, carrier: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tracking_number: T.nilable(String)).void
1091
+ }
1092
+ def initialize(
1093
+ address: nil,
1094
+ carrier: nil,
1095
+ name: nil,
1096
+ phone: nil,
1097
+ tracking_number: nil
1098
+ ); end
1099
+ end
1100
+ # List of items constituting the order.
1101
+ sig { returns(T.nilable(T::Array[::Stripe::Source::UpdateParams::SourceOrder::Item])) }
1102
+ attr_accessor :items
1103
+ # Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.
1104
+ sig { returns(T.nilable(::Stripe::Source::UpdateParams::SourceOrder::Shipping)) }
1105
+ attr_accessor :shipping
1106
+ sig {
1107
+ params(items: T.nilable(T::Array[::Stripe::Source::UpdateParams::SourceOrder::Item]), shipping: T.nilable(::Stripe::Source::UpdateParams::SourceOrder::Shipping)).void
1108
+ }
1109
+ def initialize(items: nil, shipping: nil); end
1110
+ end
1111
+ # Amount associated with the source.
1112
+ sig { returns(T.nilable(Integer)) }
1113
+ attr_accessor :amount
1114
+ # Specifies which fields in the response should be expanded.
1115
+ sig { returns(T.nilable(T::Array[String])) }
1116
+ attr_accessor :expand
1117
+ # Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
1118
+ sig { returns(T.nilable(::Stripe::Source::UpdateParams::Mandate)) }
1119
+ attr_accessor :mandate
1120
+ # 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`.
1121
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
1122
+ attr_accessor :metadata
1123
+ # Information about the owner of the payment instrument that may be used or required by particular source types.
1124
+ sig { returns(T.nilable(::Stripe::Source::UpdateParams::Owner)) }
1125
+ attr_accessor :owner
1126
+ # Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
1127
+ sig { returns(T.nilable(::Stripe::Source::UpdateParams::SourceOrder)) }
1128
+ attr_accessor :source_order
1129
+ sig {
1130
+ params(amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), mandate: T.nilable(::Stripe::Source::UpdateParams::Mandate), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), owner: T.nilable(::Stripe::Source::UpdateParams::Owner), source_order: T.nilable(::Stripe::Source::UpdateParams::SourceOrder)).void
1131
+ }
1132
+ def initialize(
1133
+ amount: nil,
1134
+ expand: nil,
1135
+ mandate: nil,
1136
+ metadata: nil,
1137
+ owner: nil,
1138
+ source_order: nil
1139
+ ); end
1140
+ end
1141
+ class CreateParams < Stripe::RequestParams
1142
+ class Mandate < Stripe::RequestParams
1143
+ class Acceptance < Stripe::RequestParams
1144
+ class Offline < Stripe::RequestParams
1145
+ # An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.
1146
+ sig { returns(String) }
1147
+ attr_accessor :contact_email
1148
+ sig { params(contact_email: String).void }
1149
+ def initialize(contact_email: nil); end
1150
+ end
1151
+ class Online < Stripe::RequestParams
1152
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
1153
+ sig { returns(T.nilable(Integer)) }
1154
+ attr_accessor :date
1155
+ # The IP address from which the mandate was accepted or refused by the customer.
1156
+ sig { returns(T.nilable(String)) }
1157
+ attr_accessor :ip
1158
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
1159
+ sig { returns(T.nilable(String)) }
1160
+ attr_accessor :user_agent
1161
+ sig {
1162
+ params(date: T.nilable(Integer), ip: T.nilable(String), user_agent: T.nilable(String)).void
1163
+ }
1164
+ def initialize(date: nil, ip: nil, user_agent: nil); end
1165
+ end
1166
+ # The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
1167
+ sig { returns(T.nilable(Integer)) }
1168
+ attr_accessor :date
1169
+ # The IP address from which the mandate was accepted or refused by the customer.
1170
+ sig { returns(T.nilable(String)) }
1171
+ attr_accessor :ip
1172
+ # The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`
1173
+ sig { returns(T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Offline)) }
1174
+ attr_accessor :offline
1175
+ # The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`
1176
+ sig { returns(T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Online)) }
1177
+ attr_accessor :online
1178
+ # The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).
1179
+ sig { returns(String) }
1180
+ attr_accessor :status
1181
+ # The type of acceptance information included with the mandate. Either `online` or `offline`
1182
+ sig { returns(T.nilable(String)) }
1183
+ attr_accessor :type
1184
+ # The user agent of the browser from which the mandate was accepted or refused by the customer.
1185
+ sig { returns(T.nilable(String)) }
1186
+ attr_accessor :user_agent
1187
+ sig {
1188
+ params(date: T.nilable(Integer), ip: T.nilable(String), offline: T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Offline), online: T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance::Online), status: String, type: T.nilable(String), user_agent: T.nilable(String)).void
1189
+ }
1190
+ def initialize(
1191
+ date: nil,
1192
+ ip: nil,
1193
+ offline: nil,
1194
+ online: nil,
1195
+ status: nil,
1196
+ type: nil,
1197
+ user_agent: nil
1198
+ ); end
1199
+ end
1200
+ # The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
1201
+ sig { returns(T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance)) }
1202
+ attr_accessor :acceptance
1203
+ # The amount specified by the mandate. (Leave null for a mandate covering all amounts)
1204
+ sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
1205
+ attr_accessor :amount
1206
+ # The currency specified by the mandate. (Must match `currency` of the source)
1207
+ sig { returns(T.nilable(String)) }
1208
+ attr_accessor :currency
1209
+ # The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)
1210
+ sig { returns(T.nilable(String)) }
1211
+ attr_accessor :interval
1212
+ # The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).
1213
+ sig { returns(T.nilable(String)) }
1214
+ attr_accessor :notification_method
1215
+ sig {
1216
+ params(acceptance: T.nilable(::Stripe::Source::CreateParams::Mandate::Acceptance), amount: T.nilable(T.nilable(T.any(String, Integer))), currency: T.nilable(String), interval: T.nilable(String), notification_method: T.nilable(String)).void
1217
+ }
1218
+ def initialize(
1219
+ acceptance: nil,
1220
+ amount: nil,
1221
+ currency: nil,
1222
+ interval: nil,
1223
+ notification_method: nil
1224
+ ); end
1225
+ end
1226
+ class Owner < Stripe::RequestParams
1227
+ class Address < Stripe::RequestParams
1228
+ # City, district, suburb, town, or village.
1229
+ sig { returns(T.nilable(String)) }
1230
+ attr_accessor :city
1231
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1232
+ sig { returns(T.nilable(String)) }
1233
+ attr_accessor :country
1234
+ # Address line 1 (e.g., street, PO Box, or company name).
1235
+ sig { returns(T.nilable(String)) }
1236
+ attr_accessor :line1
1237
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1238
+ sig { returns(T.nilable(String)) }
1239
+ attr_accessor :line2
1240
+ # ZIP or postal code.
1241
+ sig { returns(T.nilable(String)) }
1242
+ attr_accessor :postal_code
1243
+ # State, county, province, or region.
1244
+ sig { returns(T.nilable(String)) }
1245
+ attr_accessor :state
1246
+ sig {
1247
+ 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
1248
+ }
1249
+ def initialize(
1250
+ city: nil,
1251
+ country: nil,
1252
+ line1: nil,
1253
+ line2: nil,
1254
+ postal_code: nil,
1255
+ state: nil
1256
+ ); end
1257
+ end
1258
+ # Owner's address.
1259
+ sig { returns(T.nilable(::Stripe::Source::CreateParams::Owner::Address)) }
1260
+ attr_accessor :address
1261
+ # Owner's email address.
1262
+ sig { returns(T.nilable(String)) }
1263
+ attr_accessor :email
1264
+ # Owner's full name.
1265
+ sig { returns(T.nilable(String)) }
1266
+ attr_accessor :name
1267
+ # Owner's phone number.
1268
+ sig { returns(T.nilable(String)) }
1269
+ attr_accessor :phone
1270
+ sig {
1271
+ params(address: T.nilable(::Stripe::Source::CreateParams::Owner::Address), email: T.nilable(String), name: T.nilable(String), phone: T.nilable(String)).void
1272
+ }
1273
+ def initialize(address: nil, email: nil, name: nil, phone: nil); end
1274
+ end
1275
+ class Receiver < Stripe::RequestParams
1276
+ # The method Stripe should use to request information needed to process a refund or mispayment. Either `email` (an email is sent directly to the customer) or `manual` (a `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each payment method's documentation to learn which refund attributes may be required.
1277
+ sig { returns(T.nilable(String)) }
1278
+ attr_accessor :refund_attributes_method
1279
+ sig { params(refund_attributes_method: T.nilable(String)).void }
1280
+ def initialize(refund_attributes_method: nil); end
1281
+ end
1282
+ class Redirect < Stripe::RequestParams
1283
+ # The URL you provide to redirect the customer back to you after they authenticated their payment. It can use your application URI scheme in the context of a mobile application.
1284
+ sig { returns(String) }
1285
+ attr_accessor :return_url
1286
+ sig { params(return_url: String).void }
1287
+ def initialize(return_url: nil); end
1288
+ end
1289
+ class SourceOrder < Stripe::RequestParams
1290
+ class Item < Stripe::RequestParams
1291
+ # Attribute for param field amount
1292
+ sig { returns(T.nilable(Integer)) }
1293
+ attr_accessor :amount
1294
+ # Attribute for param field currency
1295
+ sig { returns(T.nilable(String)) }
1296
+ attr_accessor :currency
1297
+ # Attribute for param field description
1298
+ sig { returns(T.nilable(String)) }
1299
+ attr_accessor :description
1300
+ # The ID of the SKU being ordered.
1301
+ sig { returns(T.nilable(String)) }
1302
+ attr_accessor :parent
1303
+ # The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.
1304
+ sig { returns(T.nilable(Integer)) }
1305
+ attr_accessor :quantity
1306
+ # Attribute for param field type
1307
+ sig { returns(T.nilable(String)) }
1308
+ attr_accessor :type
1309
+ sig {
1310
+ params(amount: T.nilable(Integer), currency: T.nilable(String), description: T.nilable(String), parent: T.nilable(String), quantity: T.nilable(Integer), type: T.nilable(String)).void
1311
+ }
1312
+ def initialize(
1313
+ amount: nil,
1314
+ currency: nil,
1315
+ description: nil,
1316
+ parent: nil,
1317
+ quantity: nil,
1318
+ type: nil
1319
+ ); end
1320
+ end
1321
+ class Shipping < Stripe::RequestParams
1322
+ class Address < Stripe::RequestParams
1323
+ # City, district, suburb, town, or village.
1324
+ sig { returns(T.nilable(String)) }
1325
+ attr_accessor :city
1326
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1327
+ sig { returns(T.nilable(String)) }
1328
+ attr_accessor :country
1329
+ # Address line 1 (e.g., street, PO Box, or company name).
1330
+ sig { returns(String) }
1331
+ attr_accessor :line1
1332
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1333
+ sig { returns(T.nilable(String)) }
1334
+ attr_accessor :line2
1335
+ # ZIP or postal code.
1336
+ sig { returns(T.nilable(String)) }
1337
+ attr_accessor :postal_code
1338
+ # State, county, province, or region.
1339
+ sig { returns(T.nilable(String)) }
1340
+ attr_accessor :state
1341
+ sig {
1342
+ params(city: T.nilable(String), country: T.nilable(String), line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
1343
+ }
1344
+ def initialize(
1345
+ city: nil,
1346
+ country: nil,
1347
+ line1: nil,
1348
+ line2: nil,
1349
+ postal_code: nil,
1350
+ state: nil
1351
+ ); end
1352
+ end
1353
+ # Shipping address.
1354
+ sig { returns(::Stripe::Source::CreateParams::SourceOrder::Shipping::Address) }
1355
+ attr_accessor :address
1356
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1357
+ sig { returns(T.nilable(String)) }
1358
+ attr_accessor :carrier
1359
+ # Recipient name.
1360
+ sig { returns(T.nilable(String)) }
1361
+ attr_accessor :name
1362
+ # Recipient phone (including extension).
1363
+ sig { returns(T.nilable(String)) }
1364
+ attr_accessor :phone
1365
+ # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
1366
+ sig { returns(T.nilable(String)) }
1367
+ attr_accessor :tracking_number
1368
+ sig {
1369
+ params(address: ::Stripe::Source::CreateParams::SourceOrder::Shipping::Address, carrier: T.nilable(String), name: T.nilable(String), phone: T.nilable(String), tracking_number: T.nilable(String)).void
1370
+ }
1371
+ def initialize(
1372
+ address: nil,
1373
+ carrier: nil,
1374
+ name: nil,
1375
+ phone: nil,
1376
+ tracking_number: nil
1377
+ ); end
1378
+ end
1379
+ # List of items constituting the order.
1380
+ sig { returns(T.nilable(T::Array[::Stripe::Source::CreateParams::SourceOrder::Item])) }
1381
+ attr_accessor :items
1382
+ # Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.
1383
+ sig { returns(T.nilable(::Stripe::Source::CreateParams::SourceOrder::Shipping)) }
1384
+ attr_accessor :shipping
1385
+ sig {
1386
+ params(items: T.nilable(T::Array[::Stripe::Source::CreateParams::SourceOrder::Item]), shipping: T.nilable(::Stripe::Source::CreateParams::SourceOrder::Shipping)).void
1387
+ }
1388
+ def initialize(items: nil, shipping: nil); end
1389
+ end
1390
+ # Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land.
1391
+ sig { returns(T.nilable(Integer)) }
1392
+ attr_accessor :amount
1393
+ # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.
1394
+ sig { returns(T.nilable(String)) }
1395
+ attr_accessor :currency
1396
+ # The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`).
1397
+ sig { returns(T.nilable(String)) }
1398
+ attr_accessor :customer
1399
+ # Specifies which fields in the response should be expanded.
1400
+ sig { returns(T.nilable(T::Array[String])) }
1401
+ attr_accessor :expand
1402
+ # The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.
1403
+ sig { returns(T.nilable(String)) }
1404
+ attr_accessor :flow
1405
+ # Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
1406
+ sig { returns(T.nilable(::Stripe::Source::CreateParams::Mandate)) }
1407
+ attr_accessor :mandate
1408
+ # Attribute for param field metadata
1409
+ sig { returns(T.nilable(T::Hash[String, String])) }
1410
+ attr_accessor :metadata
1411
+ # The source to share.
1412
+ sig { returns(T.nilable(String)) }
1413
+ attr_accessor :original_source
1414
+ # Information about the owner of the payment instrument that may be used or required by particular source types.
1415
+ sig { returns(T.nilable(::Stripe::Source::CreateParams::Owner)) }
1416
+ attr_accessor :owner
1417
+ # Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).
1418
+ sig { returns(T.nilable(::Stripe::Source::CreateParams::Receiver)) }
1419
+ attr_accessor :receiver
1420
+ # Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).
1421
+ sig { returns(T.nilable(::Stripe::Source::CreateParams::Redirect)) }
1422
+ attr_accessor :redirect
1423
+ # Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
1424
+ sig { returns(T.nilable(::Stripe::Source::CreateParams::SourceOrder)) }
1425
+ attr_accessor :source_order
1426
+ # An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.
1427
+ sig { returns(T.nilable(String)) }
1428
+ attr_accessor :statement_descriptor
1429
+ # An optional token used to create the source. When passed, token properties will override source parameters.
1430
+ sig { returns(T.nilable(String)) }
1431
+ attr_accessor :token
1432
+ # The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide)
1433
+ sig { returns(T.nilable(String)) }
1434
+ attr_accessor :type
1435
+ # Attribute for param field usage
1436
+ sig { returns(T.nilable(String)) }
1437
+ attr_accessor :usage
1438
+ sig {
1439
+ params(amount: T.nilable(Integer), currency: T.nilable(String), customer: T.nilable(String), expand: T.nilable(T::Array[String]), flow: T.nilable(String), mandate: T.nilable(::Stripe::Source::CreateParams::Mandate), metadata: T.nilable(T::Hash[String, String]), original_source: T.nilable(String), owner: T.nilable(::Stripe::Source::CreateParams::Owner), receiver: T.nilable(::Stripe::Source::CreateParams::Receiver), redirect: T.nilable(::Stripe::Source::CreateParams::Redirect), source_order: T.nilable(::Stripe::Source::CreateParams::SourceOrder), statement_descriptor: T.nilable(String), token: T.nilable(String), type: T.nilable(String), usage: T.nilable(String)).void
1440
+ }
1441
+ def initialize(
1442
+ amount: nil,
1443
+ currency: nil,
1444
+ customer: nil,
1445
+ expand: nil,
1446
+ flow: nil,
1447
+ mandate: nil,
1448
+ metadata: nil,
1449
+ original_source: nil,
1450
+ owner: nil,
1451
+ receiver: nil,
1452
+ redirect: nil,
1453
+ source_order: nil,
1454
+ statement_descriptor: nil,
1455
+ token: nil,
1456
+ type: nil,
1457
+ usage: nil
1458
+ ); end
1459
+ end
1460
+ class VerifyParams < Stripe::RequestParams
1461
+ # Specifies which fields in the response should be expanded.
1462
+ sig { returns(T.nilable(T::Array[String])) }
1463
+ attr_accessor :expand
1464
+ # The values needed to verify the source.
1465
+ sig { returns(T::Array[String]) }
1466
+ attr_accessor :values
1467
+ sig { params(expand: T.nilable(T::Array[String]), values: T::Array[String]).void }
1468
+ def initialize(expand: nil, values: nil); end
1469
+ end
1470
+ # Creates a new source object.
1471
+ sig {
1472
+ params(params: T.any(::Stripe::Source::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
1473
+ }
1474
+ def self.create(params = {}, opts = {}); end
1475
+
1476
+ # Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
1477
+ #
1478
+ # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://stripe.com/docs/sources) for more detail.
1479
+ sig {
1480
+ params(source: String, params: T.any(::Stripe::Source::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
1481
+ }
1482
+ def self.update(source, params = {}, opts = {}); end
1483
+
1484
+ # Verify a given source.
1485
+ sig {
1486
+ params(params: T.any(::Stripe::Source::VerifyParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
1487
+ }
1488
+ def verify(params = {}, opts = {}); end
1489
+
1490
+ # Verify a given source.
1491
+ sig {
1492
+ params(source: String, params: T.any(::Stripe::Source::VerifyParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source)
1493
+ }
1494
+ def self.verify(source, params = {}, opts = {}); end
1495
+ end
1496
+ end