stripe 13.4.0.pre.beta.4 → 13.4.0

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