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,2591 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- module Checkout
7
- class SessionService < StripeService
8
- attr_reader :line_items
9
- class ListParams < Stripe::RequestParams
10
- class Created < Stripe::RequestParams
11
- # Minimum value to filter by (exclusive)
12
- sig { returns(Integer) }
13
- attr_accessor :gt
14
- # Minimum value to filter by (inclusive)
15
- sig { returns(Integer) }
16
- attr_accessor :gte
17
- # Maximum value to filter by (exclusive)
18
- sig { returns(Integer) }
19
- attr_accessor :lt
20
- # Maximum value to filter by (inclusive)
21
- sig { returns(Integer) }
22
- attr_accessor :lte
23
- sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
24
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
25
- end
26
- class CustomerDetails < Stripe::RequestParams
27
- # Customer's email address.
28
- sig { returns(String) }
29
- attr_accessor :email
30
- sig { params(email: String).void }
31
- def initialize(email: nil); end
32
- end
33
- # Only return Checkout Sessions that were created during the given date interval.
34
- sig { returns(T.any(::Stripe::Checkout::SessionService::ListParams::Created, Integer)) }
35
- attr_accessor :created
36
- # Only return the Checkout Sessions for the Customer specified.
37
- sig { returns(String) }
38
- attr_accessor :customer
39
- # Only return the Checkout Sessions for the Customer details specified.
40
- sig { returns(::Stripe::Checkout::SessionService::ListParams::CustomerDetails) }
41
- attr_accessor :customer_details
42
- # 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.
43
- sig { returns(String) }
44
- attr_accessor :ending_before
45
- # Specifies which fields in the response should be expanded.
46
- sig { returns(T::Array[String]) }
47
- attr_accessor :expand
48
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
49
- sig { returns(Integer) }
50
- attr_accessor :limit
51
- # Only return the Checkout Session for the PaymentIntent specified.
52
- sig { returns(String) }
53
- attr_accessor :payment_intent
54
- # Only return the Checkout Sessions for the Payment Link specified.
55
- sig { returns(String) }
56
- attr_accessor :payment_link
57
- # 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.
58
- sig { returns(String) }
59
- attr_accessor :starting_after
60
- # Only return the Checkout Sessions matching the given status.
61
- sig { returns(String) }
62
- attr_accessor :status
63
- # Only return the Checkout Session for the subscription specified.
64
- sig { returns(String) }
65
- attr_accessor :subscription
66
- sig {
67
- params(created: T.any(::Stripe::Checkout::SessionService::ListParams::Created, Integer), customer: String, customer_details: ::Stripe::Checkout::SessionService::ListParams::CustomerDetails, ending_before: String, expand: T::Array[String], limit: Integer, payment_intent: String, payment_link: String, starting_after: String, status: String, subscription: String).void
68
- }
69
- def initialize(
70
- created: nil,
71
- customer: nil,
72
- customer_details: nil,
73
- ending_before: nil,
74
- expand: nil,
75
- limit: nil,
76
- payment_intent: nil,
77
- payment_link: nil,
78
- starting_after: nil,
79
- status: nil,
80
- subscription: nil
81
- ); end
82
- end
83
- class CreateParams < Stripe::RequestParams
84
- class AdaptivePricing < Stripe::RequestParams
85
- # Set to `true` to enable [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
86
- sig { returns(T::Boolean) }
87
- attr_accessor :enabled
88
- sig { params(enabled: T::Boolean).void }
89
- def initialize(enabled: nil); end
90
- end
91
- class AfterExpiration < Stripe::RequestParams
92
- class Recovery < Stripe::RequestParams
93
- # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
94
- sig { returns(T::Boolean) }
95
- attr_accessor :allow_promotion_codes
96
- # If `true`, a recovery URL will be generated to recover this Checkout Session if it
97
- # expires before a successful transaction is completed. It will be attached to the
98
- # Checkout Session object upon expiration.
99
- sig { returns(T::Boolean) }
100
- attr_accessor :enabled
101
- sig { params(allow_promotion_codes: T::Boolean, enabled: T::Boolean).void }
102
- def initialize(allow_promotion_codes: nil, enabled: nil); end
103
- end
104
- # Configure a Checkout Session that can be used to recover an expired session.
105
- sig {
106
- returns(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration::Recovery)
107
- }
108
- attr_accessor :recovery
109
- sig {
110
- params(recovery: ::Stripe::Checkout::SessionService::CreateParams::AfterExpiration::Recovery).void
111
- }
112
- def initialize(recovery: nil); end
113
- end
114
- class AutomaticTax < Stripe::RequestParams
115
- class Liability < Stripe::RequestParams
116
- # The connected account being referenced when `type` is `account`.
117
- sig { returns(String) }
118
- attr_accessor :account
119
- # Type of the account referenced in the request.
120
- sig { returns(String) }
121
- attr_accessor :type
122
- sig { params(account: String, type: String).void }
123
- def initialize(account: nil, type: nil); end
124
- end
125
- # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
126
- #
127
- # Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
128
- sig { returns(T::Boolean) }
129
- attr_accessor :enabled
130
- # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
131
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax::Liability) }
132
- attr_accessor :liability
133
- sig {
134
- params(enabled: T::Boolean, liability: ::Stripe::Checkout::SessionService::CreateParams::AutomaticTax::Liability).void
135
- }
136
- def initialize(enabled: nil, liability: nil); end
137
- end
138
- class ConsentCollection < Stripe::RequestParams
139
- class PaymentMethodReuseAgreement < Stripe::RequestParams
140
- # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
141
- # defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
142
- sig { returns(String) }
143
- attr_accessor :position
144
- sig { params(position: String).void }
145
- def initialize(position: nil); end
146
- end
147
- # Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
148
- sig {
149
- returns(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)
150
- }
151
- attr_accessor :payment_method_reuse_agreement
152
- # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
153
- # Session will determine whether to display an option to opt into promotional communication
154
- # from the merchant depending on the customer's locale. Only available to US merchants.
155
- sig { returns(String) }
156
- attr_accessor :promotions
157
- # If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
158
- # There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
159
- sig { returns(String) }
160
- attr_accessor :terms_of_service
161
- sig {
162
- params(payment_method_reuse_agreement: ::Stripe::Checkout::SessionService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement, promotions: String, terms_of_service: String).void
163
- }
164
- def initialize(
165
- payment_method_reuse_agreement: nil,
166
- promotions: nil,
167
- terms_of_service: nil
168
- ); end
169
- end
170
- class CustomField < Stripe::RequestParams
171
- class Dropdown < Stripe::RequestParams
172
- class Option < Stripe::RequestParams
173
- # The label for the option, displayed to the customer. Up to 100 characters.
174
- sig { returns(String) }
175
- attr_accessor :label
176
- # The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
177
- sig { returns(String) }
178
- attr_accessor :value
179
- sig { params(label: String, value: String).void }
180
- def initialize(label: nil, value: nil); end
181
- end
182
- # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
183
- sig { returns(String) }
184
- attr_accessor :default_value
185
- # The options available for the customer to select. Up to 200 options allowed.
186
- sig {
187
- returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown::Option])
188
- }
189
- attr_accessor :options
190
- sig {
191
- params(default_value: String, options: T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown::Option]).void
192
- }
193
- def initialize(default_value: nil, options: nil); end
194
- end
195
- class Label < Stripe::RequestParams
196
- # Custom text for the label, displayed to the customer. Up to 50 characters.
197
- sig { returns(String) }
198
- attr_accessor :custom
199
- # The type of the label.
200
- sig { returns(String) }
201
- attr_accessor :type
202
- sig { params(custom: String, type: String).void }
203
- def initialize(custom: nil, type: nil); end
204
- end
205
- class Numeric < Stripe::RequestParams
206
- # The value that will pre-fill the field on the payment page.
207
- sig { returns(String) }
208
- attr_accessor :default_value
209
- # The maximum character length constraint for the customer's input.
210
- sig { returns(Integer) }
211
- attr_accessor :maximum_length
212
- # The minimum character length requirement for the customer's input.
213
- sig { returns(Integer) }
214
- attr_accessor :minimum_length
215
- sig {
216
- params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
217
- }
218
- def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
219
- end
220
- class Text < Stripe::RequestParams
221
- # The value that will pre-fill the field on the payment page.
222
- sig { returns(String) }
223
- attr_accessor :default_value
224
- # The maximum character length constraint for the customer's input.
225
- sig { returns(Integer) }
226
- attr_accessor :maximum_length
227
- # The minimum character length requirement for the customer's input.
228
- sig { returns(Integer) }
229
- attr_accessor :minimum_length
230
- sig {
231
- params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
232
- }
233
- def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
234
- end
235
- # Configuration for `type=dropdown` fields.
236
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown) }
237
- attr_accessor :dropdown
238
- # String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
239
- sig { returns(String) }
240
- attr_accessor :key
241
- # The label for the field, displayed to the customer.
242
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Label) }
243
- attr_accessor :label
244
- # Configuration for `type=numeric` fields.
245
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Numeric) }
246
- attr_accessor :numeric
247
- # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
248
- sig { returns(T::Boolean) }
249
- attr_accessor :optional
250
- # Configuration for `type=text` fields.
251
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Text) }
252
- attr_accessor :text
253
- # The type of the field.
254
- sig { returns(String) }
255
- attr_accessor :type
256
- sig {
257
- params(dropdown: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown, key: String, label: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Label, numeric: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Numeric, optional: T::Boolean, text: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Text, type: String).void
258
- }
259
- def initialize(
260
- dropdown: nil,
261
- key: nil,
262
- label: nil,
263
- numeric: nil,
264
- optional: nil,
265
- text: nil,
266
- type: nil
267
- ); end
268
- end
269
- class CustomText < Stripe::RequestParams
270
- class AfterSubmit < Stripe::RequestParams
271
- # Text may be up to 1200 characters in length.
272
- sig { returns(String) }
273
- attr_accessor :message
274
- sig { params(message: String).void }
275
- def initialize(message: nil); end
276
- end
277
- class ShippingAddress < Stripe::RequestParams
278
- # Text may be up to 1200 characters in length.
279
- sig { returns(String) }
280
- attr_accessor :message
281
- sig { params(message: String).void }
282
- def initialize(message: nil); end
283
- end
284
- class Submit < Stripe::RequestParams
285
- # Text may be up to 1200 characters in length.
286
- sig { returns(String) }
287
- attr_accessor :message
288
- sig { params(message: String).void }
289
- def initialize(message: nil); end
290
- end
291
- class TermsOfServiceAcceptance < Stripe::RequestParams
292
- # Text may be up to 1200 characters in length.
293
- sig { returns(String) }
294
- attr_accessor :message
295
- sig { params(message: String).void }
296
- def initialize(message: nil); end
297
- end
298
- # Custom text that should be displayed after the payment confirmation button.
299
- sig {
300
- returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::AfterSubmit))
301
- }
302
- attr_accessor :after_submit
303
- # Custom text that should be displayed alongside shipping address collection.
304
- sig {
305
- returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::ShippingAddress))
306
- }
307
- attr_accessor :shipping_address
308
- # Custom text that should be displayed alongside the payment confirmation button.
309
- sig {
310
- returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::Submit))
311
- }
312
- attr_accessor :submit
313
- # Custom text that should be displayed in place of the default terms of service agreement text.
314
- sig {
315
- returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::TermsOfServiceAcceptance))
316
- }
317
- attr_accessor :terms_of_service_acceptance
318
- sig {
319
- params(after_submit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::AfterSubmit), shipping_address: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::ShippingAddress), submit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::Submit), terms_of_service_acceptance: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::TermsOfServiceAcceptance)).void
320
- }
321
- def initialize(
322
- after_submit: nil,
323
- shipping_address: nil,
324
- submit: nil,
325
- terms_of_service_acceptance: nil
326
- ); end
327
- end
328
- class CustomerUpdate < Stripe::RequestParams
329
- # Describes whether Checkout saves the billing address onto `customer.address`.
330
- # To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
331
- sig { returns(String) }
332
- attr_accessor :address
333
- # Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
334
- sig { returns(String) }
335
- attr_accessor :name
336
- # Describes whether Checkout saves shipping information onto `customer.shipping`.
337
- # To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
338
- sig { returns(String) }
339
- attr_accessor :shipping
340
- sig { params(address: String, name: String, shipping: String).void }
341
- def initialize(address: nil, name: nil, shipping: nil); end
342
- end
343
- class Discount < Stripe::RequestParams
344
- # The ID of the coupon to apply to this Session.
345
- sig { returns(String) }
346
- attr_accessor :coupon
347
- # The ID of a promotion code to apply to this Session.
348
- sig { returns(String) }
349
- attr_accessor :promotion_code
350
- sig { params(coupon: String, promotion_code: String).void }
351
- def initialize(coupon: nil, promotion_code: nil); end
352
- end
353
- class InvoiceCreation < Stripe::RequestParams
354
- class InvoiceData < Stripe::RequestParams
355
- class CustomField < Stripe::RequestParams
356
- # The name of the custom field. This may be up to 40 characters.
357
- sig { returns(String) }
358
- attr_accessor :name
359
- # The value of the custom field. This may be up to 140 characters.
360
- sig { returns(String) }
361
- attr_accessor :value
362
- sig { params(name: String, value: String).void }
363
- def initialize(name: nil, value: nil); end
364
- end
365
- class Issuer < Stripe::RequestParams
366
- # The connected account being referenced when `type` is `account`.
367
- sig { returns(String) }
368
- attr_accessor :account
369
- # Type of the account referenced in the request.
370
- sig { returns(String) }
371
- attr_accessor :type
372
- sig { params(account: String, type: String).void }
373
- def initialize(account: nil, type: nil); end
374
- end
375
- class RenderingOptions < Stripe::RequestParams
376
- # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
377
- sig { returns(T.nilable(String)) }
378
- attr_accessor :amount_tax_display
379
- sig { params(amount_tax_display: T.nilable(String)).void }
380
- def initialize(amount_tax_display: nil); end
381
- end
382
- # The account tax IDs associated with the invoice.
383
- sig { returns(T.nilable(T::Array[String])) }
384
- attr_accessor :account_tax_ids
385
- # Default custom fields to be displayed on invoices for this customer.
386
- sig {
387
- returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))
388
- }
389
- attr_accessor :custom_fields
390
- # An arbitrary string attached to the object. Often useful for displaying to users.
391
- sig { returns(String) }
392
- attr_accessor :description
393
- # Default footer to be displayed on invoices for this customer.
394
- sig { returns(String) }
395
- attr_accessor :footer
396
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
397
- sig {
398
- returns(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::Issuer)
399
- }
400
- attr_accessor :issuer
401
- # 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`.
402
- sig { returns(T::Hash[String, String]) }
403
- attr_accessor :metadata
404
- # Default options for invoice PDF rendering for this customer.
405
- sig {
406
- returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))
407
- }
408
- attr_accessor :rendering_options
409
- sig {
410
- params(account_tax_ids: T.nilable(T::Array[String]), custom_fields: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::CustomField]), description: String, footer: String, issuer: ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::Issuer, metadata: T::Hash[String, String], rendering_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)).void
411
- }
412
- def initialize(
413
- account_tax_ids: nil,
414
- custom_fields: nil,
415
- description: nil,
416
- footer: nil,
417
- issuer: nil,
418
- metadata: nil,
419
- rendering_options: nil
420
- ); end
421
- end
422
- # Set to `true` to enable invoice creation.
423
- sig { returns(T::Boolean) }
424
- attr_accessor :enabled
425
- # Parameters passed when creating invoices for payment-mode Checkout Sessions.
426
- sig {
427
- returns(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData)
428
- }
429
- attr_accessor :invoice_data
430
- sig {
431
- params(enabled: T::Boolean, invoice_data: ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData).void
432
- }
433
- def initialize(enabled: nil, invoice_data: nil); end
434
- end
435
- class LineItem < Stripe::RequestParams
436
- class AdjustableQuantity < Stripe::RequestParams
437
- # Set to true if the quantity can be adjusted to any non-negative integer.
438
- sig { returns(T::Boolean) }
439
- attr_accessor :enabled
440
- # The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
441
- sig { returns(Integer) }
442
- attr_accessor :maximum
443
- # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
444
- sig { returns(Integer) }
445
- attr_accessor :minimum
446
- sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
447
- def initialize(enabled: nil, maximum: nil, minimum: nil); end
448
- end
449
- class PriceData < Stripe::RequestParams
450
- class ProductData < Stripe::RequestParams
451
- # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
452
- sig { returns(String) }
453
- attr_accessor :description
454
- # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
455
- sig { returns(T::Array[String]) }
456
- attr_accessor :images
457
- # 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`.
458
- sig { returns(T::Hash[String, String]) }
459
- attr_accessor :metadata
460
- # The product's name, meant to be displayable to the customer.
461
- sig { returns(String) }
462
- attr_accessor :name
463
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
464
- sig { returns(String) }
465
- attr_accessor :tax_code
466
- sig {
467
- params(description: String, images: T::Array[String], metadata: T::Hash[String, String], name: String, tax_code: String).void
468
- }
469
- def initialize(
470
- description: nil,
471
- images: nil,
472
- metadata: nil,
473
- name: nil,
474
- tax_code: nil
475
- ); end
476
- end
477
- class Recurring < Stripe::RequestParams
478
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
479
- sig { returns(String) }
480
- attr_accessor :interval
481
- # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
482
- sig { returns(Integer) }
483
- attr_accessor :interval_count
484
- sig { params(interval: String, interval_count: Integer).void }
485
- def initialize(interval: nil, interval_count: nil); end
486
- end
487
- # 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).
488
- sig { returns(String) }
489
- attr_accessor :currency
490
- # The ID of the product that this price will belong to. One of `product` or `product_data` is required.
491
- sig { returns(String) }
492
- attr_accessor :product
493
- # Data used to generate a new product object inline. One of `product` or `product_data` is required.
494
- sig {
495
- returns(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::ProductData)
496
- }
497
- attr_accessor :product_data
498
- # The recurring components of a price such as `interval` and `interval_count`.
499
- sig {
500
- returns(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::Recurring)
501
- }
502
- attr_accessor :recurring
503
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
504
- sig { returns(String) }
505
- attr_accessor :tax_behavior
506
- # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
507
- sig { returns(Integer) }
508
- attr_accessor :unit_amount
509
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
510
- sig { returns(String) }
511
- attr_accessor :unit_amount_decimal
512
- sig {
513
- params(currency: String, product: String, product_data: ::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::ProductData, recurring: ::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
514
- }
515
- def initialize(
516
- currency: nil,
517
- product: nil,
518
- product_data: nil,
519
- recurring: nil,
520
- tax_behavior: nil,
521
- unit_amount: nil,
522
- unit_amount_decimal: nil
523
- ); end
524
- end
525
- # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
526
- sig {
527
- returns(::Stripe::Checkout::SessionService::CreateParams::LineItem::AdjustableQuantity)
528
- }
529
- attr_accessor :adjustable_quantity
530
- # The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.
531
- sig { returns(T::Array[String]) }
532
- attr_accessor :dynamic_tax_rates
533
- # 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`.
534
- sig { returns(T::Hash[String, String]) }
535
- attr_accessor :metadata
536
- # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
537
- sig { returns(String) }
538
- attr_accessor :price
539
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
540
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData) }
541
- attr_accessor :price_data
542
- # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
543
- sig { returns(Integer) }
544
- attr_accessor :quantity
545
- # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
546
- sig { returns(T::Array[String]) }
547
- attr_accessor :tax_rates
548
- sig {
549
- params(adjustable_quantity: ::Stripe::Checkout::SessionService::CreateParams::LineItem::AdjustableQuantity, dynamic_tax_rates: T::Array[String], metadata: T::Hash[String, String], price: String, price_data: ::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData, quantity: Integer, tax_rates: T::Array[String]).void
550
- }
551
- def initialize(
552
- adjustable_quantity: nil,
553
- dynamic_tax_rates: nil,
554
- metadata: nil,
555
- price: nil,
556
- price_data: nil,
557
- quantity: nil,
558
- tax_rates: nil
559
- ); end
560
- end
561
- class PaymentIntentData < Stripe::RequestParams
562
- class Shipping < Stripe::RequestParams
563
- class Address < Stripe::RequestParams
564
- # City, district, suburb, town, or village.
565
- sig { returns(String) }
566
- attr_accessor :city
567
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
568
- sig { returns(String) }
569
- attr_accessor :country
570
- # Address line 1 (e.g., street, PO Box, or company name).
571
- sig { returns(String) }
572
- attr_accessor :line1
573
- # Address line 2 (e.g., apartment, suite, unit, or building).
574
- sig { returns(String) }
575
- attr_accessor :line2
576
- # ZIP or postal code.
577
- sig { returns(String) }
578
- attr_accessor :postal_code
579
- # State, county, province, or region.
580
- sig { returns(String) }
581
- attr_accessor :state
582
- sig {
583
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
584
- }
585
- def initialize(
586
- city: nil,
587
- country: nil,
588
- line1: nil,
589
- line2: nil,
590
- postal_code: nil,
591
- state: nil
592
- ); end
593
- end
594
- # Shipping address.
595
- sig {
596
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping::Address)
597
- }
598
- attr_accessor :address
599
- # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
600
- sig { returns(String) }
601
- attr_accessor :carrier
602
- # Recipient name.
603
- sig { returns(String) }
604
- attr_accessor :name
605
- # Recipient phone (including extension).
606
- sig { returns(String) }
607
- attr_accessor :phone
608
- # 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.
609
- sig { returns(String) }
610
- attr_accessor :tracking_number
611
- sig {
612
- params(address: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
613
- }
614
- def initialize(
615
- address: nil,
616
- carrier: nil,
617
- name: nil,
618
- phone: nil,
619
- tracking_number: nil
620
- ); end
621
- end
622
- class TransferData < Stripe::RequestParams
623
- # The amount that will be transferred automatically when a charge succeeds.
624
- sig { returns(Integer) }
625
- attr_accessor :amount
626
- # If specified, successful charges will be attributed to the destination
627
- # account for tax reporting, and the funds from charges will be transferred
628
- # to the destination account. The ID of the resulting transfer will be
629
- # returned on the successful charge's `transfer` field.
630
- sig { returns(String) }
631
- attr_accessor :destination
632
- sig { params(amount: Integer, destination: String).void }
633
- def initialize(amount: nil, destination: nil); end
634
- end
635
- # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
636
- sig { returns(Integer) }
637
- attr_accessor :application_fee_amount
638
- # Controls when the funds will be captured from the customer's account.
639
- sig { returns(String) }
640
- attr_accessor :capture_method
641
- # An arbitrary string attached to the object. Often useful for displaying to users.
642
- sig { returns(String) }
643
- attr_accessor :description
644
- # 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`.
645
- sig { returns(T::Hash[String, String]) }
646
- attr_accessor :metadata
647
- # The Stripe account ID for which these funds are intended. For details,
648
- # see the PaymentIntents [use case for connected
649
- # accounts](/docs/payments/connected-accounts).
650
- sig { returns(String) }
651
- attr_accessor :on_behalf_of
652
- # Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
653
- sig { returns(String) }
654
- attr_accessor :receipt_email
655
- # Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
656
- # method collected by this Checkout Session.
657
- #
658
- # When setting this to `on_session`, Checkout will show a notice to the
659
- # customer that their payment details will be saved.
660
- #
661
- # When setting this to `off_session`, Checkout will show a notice to the
662
- # customer that their payment details will be saved and used for future
663
- # payments.
664
- #
665
- # If a Customer has been provided or Checkout creates a new Customer,
666
- # Checkout will attach the payment method to the Customer.
667
- #
668
- # If Checkout does not create a Customer, the payment method is not attached
669
- # to a Customer. To reuse the payment method, you can retrieve it from the
670
- # Checkout Session's PaymentIntent.
671
- #
672
- # When processing card payments, Checkout also uses `setup_future_usage`
673
- # to dynamically optimize your payment flow and comply with regional
674
- # legislation and network rules, such as SCA.
675
- sig { returns(String) }
676
- attr_accessor :setup_future_usage
677
- # Shipping information for this payment.
678
- sig {
679
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping)
680
- }
681
- attr_accessor :shipping
682
- # Text that appears on the customer's statement as the statement descriptor for a non-card charge. 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).
683
- #
684
- # Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
685
- sig { returns(String) }
686
- attr_accessor :statement_descriptor
687
- # 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.
688
- sig { returns(String) }
689
- attr_accessor :statement_descriptor_suffix
690
- # The parameters used to automatically create a Transfer when the payment succeeds.
691
- # For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
692
- sig {
693
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::TransferData)
694
- }
695
- attr_accessor :transfer_data
696
- # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
697
- sig { returns(String) }
698
- attr_accessor :transfer_group
699
- sig {
700
- params(application_fee_amount: Integer, capture_method: String, description: String, metadata: T::Hash[String, String], on_behalf_of: String, receipt_email: String, setup_future_usage: String, shipping: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping, statement_descriptor: String, statement_descriptor_suffix: String, transfer_data: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::TransferData, transfer_group: String).void
701
- }
702
- def initialize(
703
- application_fee_amount: nil,
704
- capture_method: nil,
705
- description: nil,
706
- metadata: nil,
707
- on_behalf_of: nil,
708
- receipt_email: nil,
709
- setup_future_usage: nil,
710
- shipping: nil,
711
- statement_descriptor: nil,
712
- statement_descriptor_suffix: nil,
713
- transfer_data: nil,
714
- transfer_group: nil
715
- ); end
716
- end
717
- class PaymentMethodData < Stripe::RequestParams
718
- # Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.
719
- sig { returns(String) }
720
- attr_accessor :allow_redisplay
721
- sig { params(allow_redisplay: String).void }
722
- def initialize(allow_redisplay: nil); end
723
- end
724
- class PaymentMethodOptions < Stripe::RequestParams
725
- class AcssDebit < Stripe::RequestParams
726
- class MandateOptions < Stripe::RequestParams
727
- # A URL for custom mandate text to render during confirmation step.
728
- # The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
729
- # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
730
- sig { returns(T.nilable(String)) }
731
- attr_accessor :custom_mandate_url
732
- # List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
733
- sig { returns(T::Array[String]) }
734
- attr_accessor :default_for
735
- # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
736
- sig { returns(String) }
737
- attr_accessor :interval_description
738
- # Payment schedule for the mandate.
739
- sig { returns(String) }
740
- attr_accessor :payment_schedule
741
- # Transaction type of the mandate.
742
- sig { returns(String) }
743
- attr_accessor :transaction_type
744
- sig {
745
- params(custom_mandate_url: T.nilable(String), default_for: T::Array[String], interval_description: String, payment_schedule: String, transaction_type: String).void
746
- }
747
- def initialize(
748
- custom_mandate_url: nil,
749
- default_for: nil,
750
- interval_description: nil,
751
- payment_schedule: nil,
752
- transaction_type: nil
753
- ); end
754
- end
755
- # 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). This is only accepted for Checkout Sessions in `setup` mode.
756
- sig { returns(String) }
757
- attr_accessor :currency
758
- # Additional fields for Mandate creation
759
- sig {
760
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)
761
- }
762
- attr_accessor :mandate_options
763
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
764
- #
765
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
766
- #
767
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
768
- #
769
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
770
- sig { returns(String) }
771
- attr_accessor :setup_future_usage
772
- # Verification method for the intent
773
- sig { returns(String) }
774
- attr_accessor :verification_method
775
- sig {
776
- params(currency: String, mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: String, verification_method: String).void
777
- }
778
- def initialize(
779
- currency: nil,
780
- mandate_options: nil,
781
- setup_future_usage: nil,
782
- verification_method: nil
783
- ); end
784
- end
785
- class Affirm < Stripe::RequestParams
786
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
787
- #
788
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
789
- #
790
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
791
- #
792
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
793
- sig { returns(String) }
794
- attr_accessor :setup_future_usage
795
- sig { params(setup_future_usage: String).void }
796
- def initialize(setup_future_usage: nil); end
797
- end
798
- class AfterpayClearpay < Stripe::RequestParams
799
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
800
- #
801
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
802
- #
803
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
804
- #
805
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
806
- sig { returns(String) }
807
- attr_accessor :setup_future_usage
808
- sig { params(setup_future_usage: String).void }
809
- def initialize(setup_future_usage: nil); end
810
- end
811
- class Alipay < Stripe::RequestParams
812
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
813
- #
814
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
815
- #
816
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
817
- #
818
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
819
- sig { returns(String) }
820
- attr_accessor :setup_future_usage
821
- sig { params(setup_future_usage: String).void }
822
- def initialize(setup_future_usage: nil); end
823
- end
824
- class AmazonPay < Stripe::RequestParams
825
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
826
- #
827
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
828
- #
829
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
830
- #
831
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
832
- sig { returns(String) }
833
- attr_accessor :setup_future_usage
834
- sig { params(setup_future_usage: String).void }
835
- def initialize(setup_future_usage: nil); end
836
- end
837
- class AuBecsDebit < Stripe::RequestParams
838
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
839
- #
840
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
841
- #
842
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
843
- #
844
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
845
- sig { returns(String) }
846
- attr_accessor :setup_future_usage
847
- sig { params(setup_future_usage: String).void }
848
- def initialize(setup_future_usage: nil); end
849
- end
850
- class BacsDebit < Stripe::RequestParams
851
- class MandateOptions < Stripe::RequestParams
852
- # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
853
- sig { returns(T.nilable(String)) }
854
- attr_accessor :reference_prefix
855
- sig { params(reference_prefix: T.nilable(String)).void }
856
- def initialize(reference_prefix: nil); end
857
- end
858
- # Additional fields for Mandate creation
859
- sig {
860
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)
861
- }
862
- attr_accessor :mandate_options
863
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
864
- #
865
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
866
- #
867
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
868
- #
869
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
870
- sig { returns(String) }
871
- attr_accessor :setup_future_usage
872
- sig {
873
- params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: String).void
874
- }
875
- def initialize(mandate_options: nil, setup_future_usage: nil); end
876
- end
877
- class Bancontact < Stripe::RequestParams
878
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
879
- #
880
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
881
- #
882
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
883
- #
884
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
885
- sig { returns(String) }
886
- attr_accessor :setup_future_usage
887
- sig { params(setup_future_usage: String).void }
888
- def initialize(setup_future_usage: nil); end
889
- end
890
- class Boleto < Stripe::RequestParams
891
- # The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
892
- sig { returns(Integer) }
893
- attr_accessor :expires_after_days
894
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
895
- #
896
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
897
- #
898
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
899
- #
900
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
901
- sig { returns(String) }
902
- attr_accessor :setup_future_usage
903
- sig { params(expires_after_days: Integer, setup_future_usage: String).void }
904
- def initialize(expires_after_days: nil, setup_future_usage: nil); end
905
- end
906
- class Card < Stripe::RequestParams
907
- class Installments < Stripe::RequestParams
908
- # Setting to true enables installments for this Checkout Session.
909
- # Setting to false will prevent any installment plan from applying to a payment.
910
- sig { returns(T::Boolean) }
911
- attr_accessor :enabled
912
- sig { params(enabled: T::Boolean).void }
913
- def initialize(enabled: nil); end
914
- end
915
- # Installment options for card payments
916
- sig {
917
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Installments)
918
- }
919
- attr_accessor :installments
920
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
921
- sig { returns(String) }
922
- attr_accessor :request_decremental_authorization
923
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
924
- sig { returns(String) }
925
- attr_accessor :request_extended_authorization
926
- # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
927
- sig { returns(String) }
928
- attr_accessor :request_incremental_authorization
929
- # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
930
- sig { returns(String) }
931
- attr_accessor :request_multicapture
932
- # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
933
- sig { returns(String) }
934
- attr_accessor :request_overcapture
935
- # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
936
- sig { returns(String) }
937
- attr_accessor :request_three_d_secure
938
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
939
- #
940
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
941
- #
942
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
943
- #
944
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
945
- sig { returns(String) }
946
- attr_accessor :setup_future_usage
947
- # Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
948
- sig { returns(String) }
949
- attr_accessor :statement_descriptor_suffix_kana
950
- # Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
951
- sig { returns(String) }
952
- attr_accessor :statement_descriptor_suffix_kanji
953
- sig {
954
- params(installments: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Installments, request_decremental_authorization: String, request_extended_authorization: String, request_incremental_authorization: String, request_multicapture: String, request_overcapture: String, request_three_d_secure: String, setup_future_usage: String, statement_descriptor_suffix_kana: String, statement_descriptor_suffix_kanji: String).void
955
- }
956
- def initialize(
957
- installments: nil,
958
- request_decremental_authorization: nil,
959
- request_extended_authorization: nil,
960
- request_incremental_authorization: nil,
961
- request_multicapture: nil,
962
- request_overcapture: nil,
963
- request_three_d_secure: nil,
964
- setup_future_usage: nil,
965
- statement_descriptor_suffix_kana: nil,
966
- statement_descriptor_suffix_kanji: nil
967
- ); end
968
- end
969
- class Cashapp < Stripe::RequestParams
970
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
971
- #
972
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
973
- #
974
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
975
- #
976
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
977
- sig { returns(String) }
978
- attr_accessor :setup_future_usage
979
- sig { params(setup_future_usage: String).void }
980
- def initialize(setup_future_usage: nil); end
981
- end
982
- class CustomerBalance < Stripe::RequestParams
983
- class BankTransfer < Stripe::RequestParams
984
- class EuBankTransfer < Stripe::RequestParams
985
- # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
986
- sig { returns(String) }
987
- attr_accessor :country
988
- sig { params(country: String).void }
989
- def initialize(country: nil); end
990
- end
991
- # Configuration for eu_bank_transfer funding type.
992
- sig {
993
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
994
- }
995
- attr_accessor :eu_bank_transfer
996
- # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
997
- #
998
- # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
999
- sig { returns(T::Array[String]) }
1000
- attr_accessor :requested_address_types
1001
- # The list of bank transfer types that this PaymentIntent is allowed to use for funding.
1002
- sig { returns(String) }
1003
- attr_accessor :type
1004
- sig {
1005
- params(eu_bank_transfer: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, requested_address_types: T::Array[String], type: String).void
1006
- }
1007
- def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
1008
- end
1009
- # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
1010
- sig {
1011
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)
1012
- }
1013
- attr_accessor :bank_transfer
1014
- # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
1015
- sig { returns(String) }
1016
- attr_accessor :funding_type
1017
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1018
- #
1019
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1020
- #
1021
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1022
- #
1023
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1024
- sig { returns(String) }
1025
- attr_accessor :setup_future_usage
1026
- sig {
1027
- params(bank_transfer: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String, setup_future_usage: String).void
1028
- }
1029
- def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
1030
- end
1031
- class Eps < Stripe::RequestParams
1032
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1033
- #
1034
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1035
- #
1036
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1037
- #
1038
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1039
- sig { returns(String) }
1040
- attr_accessor :setup_future_usage
1041
- sig { params(setup_future_usage: String).void }
1042
- def initialize(setup_future_usage: nil); end
1043
- end
1044
- class Fpx < Stripe::RequestParams
1045
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1046
- #
1047
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1048
- #
1049
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1050
- #
1051
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1052
- sig { returns(String) }
1053
- attr_accessor :setup_future_usage
1054
- sig { params(setup_future_usage: String).void }
1055
- def initialize(setup_future_usage: nil); end
1056
- end
1057
- class Giropay < Stripe::RequestParams
1058
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1059
- #
1060
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1061
- #
1062
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1063
- #
1064
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1065
- sig { returns(String) }
1066
- attr_accessor :setup_future_usage
1067
- sig { params(setup_future_usage: String).void }
1068
- def initialize(setup_future_usage: nil); end
1069
- end
1070
- class Grabpay < Stripe::RequestParams
1071
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1072
- #
1073
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1074
- #
1075
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1076
- #
1077
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1078
- sig { returns(String) }
1079
- attr_accessor :setup_future_usage
1080
- sig { params(setup_future_usage: String).void }
1081
- def initialize(setup_future_usage: nil); end
1082
- end
1083
- class Ideal < Stripe::RequestParams
1084
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1085
- #
1086
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1087
- #
1088
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1089
- #
1090
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1091
- sig { returns(String) }
1092
- attr_accessor :setup_future_usage
1093
- sig { params(setup_future_usage: String).void }
1094
- def initialize(setup_future_usage: nil); end
1095
- end
1096
- class KakaoPay < Stripe::RequestParams
1097
- # Controls when the funds will be captured from the customer's account.
1098
- sig { returns(String) }
1099
- attr_accessor :capture_method
1100
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1101
- #
1102
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1103
- #
1104
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1105
- #
1106
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1107
- sig { returns(String) }
1108
- attr_accessor :setup_future_usage
1109
- sig { params(capture_method: String, setup_future_usage: String).void }
1110
- def initialize(capture_method: nil, setup_future_usage: nil); end
1111
- end
1112
- class Klarna < Stripe::RequestParams
1113
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1114
- #
1115
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1116
- #
1117
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1118
- #
1119
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1120
- sig { returns(String) }
1121
- attr_accessor :setup_future_usage
1122
- sig { params(setup_future_usage: String).void }
1123
- def initialize(setup_future_usage: nil); end
1124
- end
1125
- class Konbini < Stripe::RequestParams
1126
- # The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
1127
- sig { returns(Integer) }
1128
- attr_accessor :expires_after_days
1129
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1130
- #
1131
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1132
- #
1133
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1134
- #
1135
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1136
- sig { returns(String) }
1137
- attr_accessor :setup_future_usage
1138
- sig { params(expires_after_days: Integer, setup_future_usage: String).void }
1139
- def initialize(expires_after_days: nil, setup_future_usage: nil); end
1140
- end
1141
- class KrCard < Stripe::RequestParams
1142
- # Controls when the funds will be captured from the customer's account.
1143
- sig { returns(String) }
1144
- attr_accessor :capture_method
1145
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1146
- #
1147
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1148
- #
1149
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1150
- #
1151
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1152
- sig { returns(String) }
1153
- attr_accessor :setup_future_usage
1154
- sig { params(capture_method: String, setup_future_usage: String).void }
1155
- def initialize(capture_method: nil, setup_future_usage: nil); end
1156
- end
1157
- class Link < Stripe::RequestParams
1158
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1159
- #
1160
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1161
- #
1162
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1163
- #
1164
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1165
- sig { returns(String) }
1166
- attr_accessor :setup_future_usage
1167
- sig { params(setup_future_usage: String).void }
1168
- def initialize(setup_future_usage: nil); end
1169
- end
1170
- class Mobilepay < Stripe::RequestParams
1171
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1172
- #
1173
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1174
- #
1175
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1176
- #
1177
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1178
- sig { returns(String) }
1179
- attr_accessor :setup_future_usage
1180
- sig { params(setup_future_usage: String).void }
1181
- def initialize(setup_future_usage: nil); end
1182
- end
1183
- class Multibanco < Stripe::RequestParams
1184
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1185
- #
1186
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1187
- #
1188
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1189
- #
1190
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1191
- sig { returns(String) }
1192
- attr_accessor :setup_future_usage
1193
- sig { params(setup_future_usage: String).void }
1194
- def initialize(setup_future_usage: nil); end
1195
- end
1196
- class NaverPay < Stripe::RequestParams
1197
- # Controls when the funds will be captured from the customer's account.
1198
- sig { returns(String) }
1199
- attr_accessor :capture_method
1200
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1201
- #
1202
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1203
- #
1204
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1205
- #
1206
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1207
- sig { returns(String) }
1208
- attr_accessor :setup_future_usage
1209
- sig { params(capture_method: String, setup_future_usage: String).void }
1210
- def initialize(capture_method: nil, setup_future_usage: nil); end
1211
- end
1212
- class Oxxo < Stripe::RequestParams
1213
- # The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
1214
- sig { returns(Integer) }
1215
- attr_accessor :expires_after_days
1216
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1217
- #
1218
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1219
- #
1220
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1221
- #
1222
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1223
- sig { returns(String) }
1224
- attr_accessor :setup_future_usage
1225
- sig { params(expires_after_days: Integer, setup_future_usage: String).void }
1226
- def initialize(expires_after_days: nil, setup_future_usage: nil); end
1227
- end
1228
- class P24 < Stripe::RequestParams
1229
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1230
- #
1231
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1232
- #
1233
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1234
- #
1235
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1236
- sig { returns(String) }
1237
- attr_accessor :setup_future_usage
1238
- # Confirm that the payer has accepted the P24 terms and conditions.
1239
- sig { returns(T::Boolean) }
1240
- attr_accessor :tos_shown_and_accepted
1241
- sig { params(setup_future_usage: String, tos_shown_and_accepted: T::Boolean).void }
1242
- def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
1243
- end
1244
- class PayByBank < Stripe::RequestParams
1245
-
1246
- end
1247
- class Payco < Stripe::RequestParams
1248
- # Controls when the funds will be captured from the customer's account.
1249
- sig { returns(String) }
1250
- attr_accessor :capture_method
1251
- sig { params(capture_method: String).void }
1252
- def initialize(capture_method: nil); end
1253
- end
1254
- class Paynow < Stripe::RequestParams
1255
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1256
- #
1257
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1258
- #
1259
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1260
- #
1261
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1262
- sig { returns(String) }
1263
- attr_accessor :setup_future_usage
1264
- sig { params(setup_future_usage: String).void }
1265
- def initialize(setup_future_usage: nil); end
1266
- end
1267
- class Paypal < Stripe::RequestParams
1268
- # Controls when the funds will be captured from the customer's account.
1269
- sig { returns(T.nilable(String)) }
1270
- attr_accessor :capture_method
1271
- # [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
1272
- sig { returns(String) }
1273
- attr_accessor :preferred_locale
1274
- # A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
1275
- sig { returns(String) }
1276
- attr_accessor :reference
1277
- # A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
1278
- sig { returns(String) }
1279
- attr_accessor :reference_id
1280
- # The risk correlation ID for an on-session payment using a saved PayPal payment method.
1281
- sig { returns(String) }
1282
- attr_accessor :risk_correlation_id
1283
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1284
- #
1285
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1286
- #
1287
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1288
- #
1289
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1290
- #
1291
- # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
1292
- sig { returns(T.nilable(String)) }
1293
- attr_accessor :setup_future_usage
1294
- # The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
1295
- sig { returns(T::Array[String]) }
1296
- attr_accessor :subsellers
1297
- sig {
1298
- params(capture_method: T.nilable(String), preferred_locale: String, reference: String, reference_id: String, risk_correlation_id: String, setup_future_usage: T.nilable(String), subsellers: T::Array[String]).void
1299
- }
1300
- def initialize(
1301
- capture_method: nil,
1302
- preferred_locale: nil,
1303
- reference: nil,
1304
- reference_id: nil,
1305
- risk_correlation_id: nil,
1306
- setup_future_usage: nil,
1307
- subsellers: nil
1308
- ); end
1309
- end
1310
- class Payto < Stripe::RequestParams
1311
- class MandateOptions < Stripe::RequestParams
1312
- # Amount that will be collected. It is required when `amount_type` is `fixed`.
1313
- sig { returns(Integer) }
1314
- attr_accessor :amount
1315
- # The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
1316
- sig { returns(String) }
1317
- attr_accessor :amount_type
1318
- # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
1319
- sig { returns(String) }
1320
- attr_accessor :end_date
1321
- # The periodicity at which payments will be collected.
1322
- sig { returns(String) }
1323
- attr_accessor :payment_schedule
1324
- # The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
1325
- sig { returns(Integer) }
1326
- attr_accessor :payments_per_period
1327
- # The purpose for which payments are made. Defaults to retail.
1328
- sig { returns(String) }
1329
- attr_accessor :purpose
1330
- # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
1331
- sig { returns(String) }
1332
- attr_accessor :start_date
1333
- sig {
1334
- params(amount: Integer, amount_type: String, end_date: String, payment_schedule: String, payments_per_period: Integer, purpose: String, start_date: String).void
1335
- }
1336
- def initialize(
1337
- amount: nil,
1338
- amount_type: nil,
1339
- end_date: nil,
1340
- payment_schedule: nil,
1341
- payments_per_period: nil,
1342
- purpose: nil,
1343
- start_date: nil
1344
- ); end
1345
- end
1346
- # Additional fields for Mandate creation
1347
- sig {
1348
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto::MandateOptions)
1349
- }
1350
- attr_accessor :mandate_options
1351
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1352
- #
1353
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1354
- #
1355
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1356
- #
1357
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1358
- sig { returns(String) }
1359
- attr_accessor :setup_future_usage
1360
- sig {
1361
- params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto::MandateOptions, setup_future_usage: String).void
1362
- }
1363
- def initialize(mandate_options: nil, setup_future_usage: nil); end
1364
- end
1365
- class Pix < Stripe::RequestParams
1366
- # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
1367
- sig { returns(Integer) }
1368
- attr_accessor :expires_after_seconds
1369
- sig { params(expires_after_seconds: Integer).void }
1370
- def initialize(expires_after_seconds: nil); end
1371
- end
1372
- class RevolutPay < Stripe::RequestParams
1373
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1374
- #
1375
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1376
- #
1377
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1378
- #
1379
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1380
- sig { returns(String) }
1381
- attr_accessor :setup_future_usage
1382
- sig { params(setup_future_usage: String).void }
1383
- def initialize(setup_future_usage: nil); end
1384
- end
1385
- class SamsungPay < Stripe::RequestParams
1386
- # Controls when the funds will be captured from the customer's account.
1387
- sig { returns(String) }
1388
- attr_accessor :capture_method
1389
- sig { params(capture_method: String).void }
1390
- def initialize(capture_method: nil); end
1391
- end
1392
- class SepaDebit < Stripe::RequestParams
1393
- class MandateOptions < Stripe::RequestParams
1394
- # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
1395
- sig { returns(T.nilable(String)) }
1396
- attr_accessor :reference_prefix
1397
- sig { params(reference_prefix: T.nilable(String)).void }
1398
- def initialize(reference_prefix: nil); end
1399
- end
1400
- # Additional fields for Mandate creation
1401
- sig {
1402
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)
1403
- }
1404
- attr_accessor :mandate_options
1405
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1406
- #
1407
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1408
- #
1409
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1410
- #
1411
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1412
- sig { returns(String) }
1413
- attr_accessor :setup_future_usage
1414
- sig {
1415
- params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: String).void
1416
- }
1417
- def initialize(mandate_options: nil, setup_future_usage: nil); end
1418
- end
1419
- class Sofort < Stripe::RequestParams
1420
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1421
- #
1422
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1423
- #
1424
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1425
- #
1426
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1427
- sig { returns(String) }
1428
- attr_accessor :setup_future_usage
1429
- sig { params(setup_future_usage: String).void }
1430
- def initialize(setup_future_usage: nil); end
1431
- end
1432
- class Swish < Stripe::RequestParams
1433
- # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
1434
- sig { returns(String) }
1435
- attr_accessor :reference
1436
- sig { params(reference: String).void }
1437
- def initialize(reference: nil); end
1438
- end
1439
- class UsBankAccount < Stripe::RequestParams
1440
- class FinancialConnections < Stripe::RequestParams
1441
- # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
1442
- sig { returns(T::Array[String]) }
1443
- attr_accessor :permissions
1444
- # List of data features that you would like to retrieve upon account creation.
1445
- sig { returns(T::Array[String]) }
1446
- attr_accessor :prefetch
1447
- sig { params(permissions: T::Array[String], prefetch: T::Array[String]).void }
1448
- def initialize(permissions: nil, prefetch: nil); end
1449
- end
1450
- # Additional fields for Financial Connections Session creation
1451
- sig {
1452
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)
1453
- }
1454
- attr_accessor :financial_connections
1455
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1456
- #
1457
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1458
- #
1459
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1460
- #
1461
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1462
- sig { returns(String) }
1463
- attr_accessor :setup_future_usage
1464
- # Verification method for the intent
1465
- sig { returns(String) }
1466
- attr_accessor :verification_method
1467
- sig {
1468
- params(financial_connections: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, setup_future_usage: String, verification_method: String).void
1469
- }
1470
- def initialize(
1471
- financial_connections: nil,
1472
- setup_future_usage: nil,
1473
- verification_method: nil
1474
- ); end
1475
- end
1476
- class WechatPay < Stripe::RequestParams
1477
- # The app ID registered with WeChat Pay. Only required when client is ios or android.
1478
- sig { returns(String) }
1479
- attr_accessor :app_id
1480
- # The client type that the end customer will pay from
1481
- sig { returns(String) }
1482
- attr_accessor :client
1483
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1484
- #
1485
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1486
- #
1487
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1488
- #
1489
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1490
- sig { returns(String) }
1491
- attr_accessor :setup_future_usage
1492
- sig { params(app_id: String, client: String, setup_future_usage: String).void }
1493
- def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
1494
- end
1495
- # contains details about the ACSS Debit payment method options.
1496
- sig {
1497
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit)
1498
- }
1499
- attr_accessor :acss_debit
1500
- # contains details about the Affirm payment method options.
1501
- sig {
1502
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm)
1503
- }
1504
- attr_accessor :affirm
1505
- # contains details about the Afterpay Clearpay payment method options.
1506
- sig {
1507
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay)
1508
- }
1509
- attr_accessor :afterpay_clearpay
1510
- # contains details about the Alipay payment method options.
1511
- sig {
1512
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay)
1513
- }
1514
- attr_accessor :alipay
1515
- # contains details about the AmazonPay payment method options.
1516
- sig {
1517
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay)
1518
- }
1519
- attr_accessor :amazon_pay
1520
- # contains details about the AU Becs Debit payment method options.
1521
- sig {
1522
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit)
1523
- }
1524
- attr_accessor :au_becs_debit
1525
- # contains details about the Bacs Debit payment method options.
1526
- sig {
1527
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit)
1528
- }
1529
- attr_accessor :bacs_debit
1530
- # contains details about the Bancontact payment method options.
1531
- sig {
1532
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact)
1533
- }
1534
- attr_accessor :bancontact
1535
- # contains details about the Boleto payment method options.
1536
- sig {
1537
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto)
1538
- }
1539
- attr_accessor :boleto
1540
- # contains details about the Card payment method options.
1541
- sig {
1542
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card)
1543
- }
1544
- attr_accessor :card
1545
- # contains details about the Cashapp Pay payment method options.
1546
- sig {
1547
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp)
1548
- }
1549
- attr_accessor :cashapp
1550
- # contains details about the Customer Balance payment method options.
1551
- sig {
1552
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance)
1553
- }
1554
- attr_accessor :customer_balance
1555
- # contains details about the EPS payment method options.
1556
- sig {
1557
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps)
1558
- }
1559
- attr_accessor :eps
1560
- # contains details about the FPX payment method options.
1561
- sig {
1562
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx)
1563
- }
1564
- attr_accessor :fpx
1565
- # contains details about the Giropay payment method options.
1566
- sig {
1567
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay)
1568
- }
1569
- attr_accessor :giropay
1570
- # contains details about the Grabpay payment method options.
1571
- sig {
1572
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay)
1573
- }
1574
- attr_accessor :grabpay
1575
- # contains details about the Ideal payment method options.
1576
- sig {
1577
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal)
1578
- }
1579
- attr_accessor :ideal
1580
- # contains details about the Kakao Pay payment method options.
1581
- sig {
1582
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay)
1583
- }
1584
- attr_accessor :kakao_pay
1585
- # contains details about the Klarna payment method options.
1586
- sig {
1587
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna)
1588
- }
1589
- attr_accessor :klarna
1590
- # contains details about the Konbini payment method options.
1591
- sig {
1592
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini)
1593
- }
1594
- attr_accessor :konbini
1595
- # contains details about the Korean card payment method options.
1596
- sig {
1597
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard)
1598
- }
1599
- attr_accessor :kr_card
1600
- # contains details about the Link payment method options.
1601
- sig {
1602
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link)
1603
- }
1604
- attr_accessor :link
1605
- # contains details about the Mobilepay payment method options.
1606
- sig {
1607
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay)
1608
- }
1609
- attr_accessor :mobilepay
1610
- # contains details about the Multibanco payment method options.
1611
- sig {
1612
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco)
1613
- }
1614
- attr_accessor :multibanco
1615
- # contains details about the Naver Pay payment method options.
1616
- sig {
1617
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay)
1618
- }
1619
- attr_accessor :naver_pay
1620
- # contains details about the OXXO payment method options.
1621
- sig {
1622
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo)
1623
- }
1624
- attr_accessor :oxxo
1625
- # contains details about the P24 payment method options.
1626
- sig {
1627
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24)
1628
- }
1629
- attr_accessor :p24
1630
- # contains details about the Pay By Bank payment method options.
1631
- sig {
1632
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::PayByBank)
1633
- }
1634
- attr_accessor :pay_by_bank
1635
- # contains details about the PAYCO payment method options.
1636
- sig {
1637
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco)
1638
- }
1639
- attr_accessor :payco
1640
- # contains details about the PayNow payment method options.
1641
- sig {
1642
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow)
1643
- }
1644
- attr_accessor :paynow
1645
- # contains details about the PayPal payment method options.
1646
- sig {
1647
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal)
1648
- }
1649
- attr_accessor :paypal
1650
- # contains details about the PayTo payment method options.
1651
- sig {
1652
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto)
1653
- }
1654
- attr_accessor :payto
1655
- # contains details about the Pix payment method options.
1656
- sig {
1657
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix)
1658
- }
1659
- attr_accessor :pix
1660
- # contains details about the RevolutPay payment method options.
1661
- sig {
1662
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay)
1663
- }
1664
- attr_accessor :revolut_pay
1665
- # contains details about the Samsung Pay payment method options.
1666
- sig {
1667
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay)
1668
- }
1669
- attr_accessor :samsung_pay
1670
- # contains details about the Sepa Debit payment method options.
1671
- sig {
1672
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit)
1673
- }
1674
- attr_accessor :sepa_debit
1675
- # contains details about the Sofort payment method options.
1676
- sig {
1677
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort)
1678
- }
1679
- attr_accessor :sofort
1680
- # contains details about the Swish payment method options.
1681
- sig {
1682
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish)
1683
- }
1684
- attr_accessor :swish
1685
- # contains details about the Us Bank Account payment method options.
1686
- sig {
1687
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount)
1688
- }
1689
- attr_accessor :us_bank_account
1690
- # contains details about the WeChat Pay payment method options.
1691
- sig {
1692
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay)
1693
- }
1694
- attr_accessor :wechat_pay
1695
- sig {
1696
- params(acss_debit: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit, affirm: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm, afterpay_clearpay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay, alipay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay, amazon_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay, au_becs_debit: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit, bacs_debit: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit, bancontact: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact, boleto: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto, card: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card, cashapp: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp, customer_balance: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance, eps: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps, fpx: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx, giropay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay, grabpay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay, ideal: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal, kakao_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay, klarna: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna, konbini: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini, kr_card: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard, link: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link, mobilepay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay, multibanco: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco, naver_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay, oxxo: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo, p24: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24, pay_by_bank: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::PayByBank, payco: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco, paynow: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow, paypal: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal, payto: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto, pix: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix, revolut_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay, samsung_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay, sepa_debit: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit, sofort: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort, swish: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish, us_bank_account: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount, wechat_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay).void
1697
- }
1698
- def initialize(
1699
- acss_debit: nil,
1700
- affirm: nil,
1701
- afterpay_clearpay: nil,
1702
- alipay: nil,
1703
- amazon_pay: nil,
1704
- au_becs_debit: nil,
1705
- bacs_debit: nil,
1706
- bancontact: nil,
1707
- boleto: nil,
1708
- card: nil,
1709
- cashapp: nil,
1710
- customer_balance: nil,
1711
- eps: nil,
1712
- fpx: nil,
1713
- giropay: nil,
1714
- grabpay: nil,
1715
- ideal: nil,
1716
- kakao_pay: nil,
1717
- klarna: nil,
1718
- konbini: nil,
1719
- kr_card: nil,
1720
- link: nil,
1721
- mobilepay: nil,
1722
- multibanco: nil,
1723
- naver_pay: nil,
1724
- oxxo: nil,
1725
- p24: nil,
1726
- pay_by_bank: nil,
1727
- payco: nil,
1728
- paynow: nil,
1729
- paypal: nil,
1730
- payto: nil,
1731
- pix: nil,
1732
- revolut_pay: nil,
1733
- samsung_pay: nil,
1734
- sepa_debit: nil,
1735
- sofort: nil,
1736
- swish: nil,
1737
- us_bank_account: nil,
1738
- wechat_pay: nil
1739
- ); end
1740
- end
1741
- class Permissions < Stripe::RequestParams
1742
- class Update < Stripe::RequestParams
1743
- # Determines which entity is allowed to update the line items.
1744
- #
1745
- # Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
1746
- #
1747
- # When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
1748
- sig { returns(String) }
1749
- attr_accessor :line_items
1750
- # Determines which entity is allowed to update the shipping details.
1751
- #
1752
- # Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
1753
- #
1754
- # When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
1755
- sig { returns(String) }
1756
- attr_accessor :shipping_details
1757
- sig { params(line_items: String, shipping_details: String).void }
1758
- def initialize(line_items: nil, shipping_details: nil); end
1759
- end
1760
- # Permissions for updating the Checkout Session.
1761
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::Permissions::Update) }
1762
- attr_accessor :update
1763
- sig {
1764
- params(update: ::Stripe::Checkout::SessionService::CreateParams::Permissions::Update).void
1765
- }
1766
- def initialize(update: nil); end
1767
- end
1768
- class PhoneNumberCollection < Stripe::RequestParams
1769
- # Set to `true` to enable phone number collection.
1770
- #
1771
- # Can only be set in `payment` and `subscription` mode.
1772
- sig { returns(T::Boolean) }
1773
- attr_accessor :enabled
1774
- sig { params(enabled: T::Boolean).void }
1775
- def initialize(enabled: nil); end
1776
- end
1777
- class SavedPaymentMethodOptions < Stripe::RequestParams
1778
- # Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
1779
- sig { returns(T::Array[String]) }
1780
- attr_accessor :allow_redisplay_filters
1781
- # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
1782
- sig { returns(String) }
1783
- attr_accessor :payment_method_save
1784
- sig {
1785
- params(allow_redisplay_filters: T::Array[String], payment_method_save: String).void
1786
- }
1787
- def initialize(allow_redisplay_filters: nil, payment_method_save: nil); end
1788
- end
1789
- class SetupIntentData < Stripe::RequestParams
1790
- # An arbitrary string attached to the object. Often useful for displaying to users.
1791
- sig { returns(String) }
1792
- attr_accessor :description
1793
- # 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`.
1794
- sig { returns(T::Hash[String, String]) }
1795
- attr_accessor :metadata
1796
- # The Stripe account for which the setup is intended.
1797
- sig { returns(String) }
1798
- attr_accessor :on_behalf_of
1799
- sig {
1800
- params(description: String, metadata: T::Hash[String, String], on_behalf_of: String).void
1801
- }
1802
- def initialize(description: nil, metadata: nil, on_behalf_of: nil); end
1803
- end
1804
- class ShippingAddressCollection < Stripe::RequestParams
1805
- # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1806
- # shipping locations.
1807
- sig { returns(T::Array[String]) }
1808
- attr_accessor :allowed_countries
1809
- sig { params(allowed_countries: T::Array[String]).void }
1810
- def initialize(allowed_countries: nil); end
1811
- end
1812
- class ShippingOption < Stripe::RequestParams
1813
- class ShippingRateData < Stripe::RequestParams
1814
- class DeliveryEstimate < Stripe::RequestParams
1815
- class Maximum < Stripe::RequestParams
1816
- # A unit of time.
1817
- sig { returns(String) }
1818
- attr_accessor :unit
1819
- # Must be greater than 0.
1820
- sig { returns(Integer) }
1821
- attr_accessor :value
1822
- sig { params(unit: String, value: Integer).void }
1823
- def initialize(unit: nil, value: nil); end
1824
- end
1825
- class Minimum < Stripe::RequestParams
1826
- # A unit of time.
1827
- sig { returns(String) }
1828
- attr_accessor :unit
1829
- # Must be greater than 0.
1830
- sig { returns(Integer) }
1831
- attr_accessor :value
1832
- sig { params(unit: String, value: Integer).void }
1833
- def initialize(unit: nil, value: nil); end
1834
- end
1835
- # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
1836
- sig {
1837
- returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
1838
- }
1839
- attr_accessor :maximum
1840
- # The lower bound of the estimated range. If empty, represents no lower bound.
1841
- sig {
1842
- returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
1843
- }
1844
- attr_accessor :minimum
1845
- sig {
1846
- params(maximum: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
1847
- }
1848
- def initialize(maximum: nil, minimum: nil); end
1849
- end
1850
- class FixedAmount < Stripe::RequestParams
1851
- class CurrencyOptions < Stripe::RequestParams
1852
- # A non-negative integer in cents representing how much to charge.
1853
- sig { returns(Integer) }
1854
- attr_accessor :amount
1855
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1856
- sig { returns(String) }
1857
- attr_accessor :tax_behavior
1858
- sig { params(amount: Integer, tax_behavior: String).void }
1859
- def initialize(amount: nil, tax_behavior: nil); end
1860
- end
1861
- # A non-negative integer in cents representing how much to charge.
1862
- sig { returns(Integer) }
1863
- attr_accessor :amount
1864
- # 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).
1865
- sig { returns(String) }
1866
- attr_accessor :currency
1867
- # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
1868
- sig {
1869
- returns(T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
1870
- }
1871
- attr_accessor :currency_options
1872
- sig {
1873
- params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
1874
- }
1875
- def initialize(amount: nil, currency: nil, currency_options: nil); end
1876
- end
1877
- # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
1878
- sig {
1879
- returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
1880
- }
1881
- attr_accessor :delivery_estimate
1882
- # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
1883
- sig { returns(String) }
1884
- attr_accessor :display_name
1885
- # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
1886
- sig {
1887
- returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount)
1888
- }
1889
- attr_accessor :fixed_amount
1890
- # 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`.
1891
- sig { returns(T::Hash[String, String]) }
1892
- attr_accessor :metadata
1893
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1894
- sig { returns(String) }
1895
- attr_accessor :tax_behavior
1896
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
1897
- sig { returns(String) }
1898
- attr_accessor :tax_code
1899
- # The type of calculation to use on the shipping rate.
1900
- sig { returns(String) }
1901
- attr_accessor :type
1902
- sig {
1903
- params(delivery_estimate: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
1904
- }
1905
- def initialize(
1906
- delivery_estimate: nil,
1907
- display_name: nil,
1908
- fixed_amount: nil,
1909
- metadata: nil,
1910
- tax_behavior: nil,
1911
- tax_code: nil,
1912
- type: nil
1913
- ); end
1914
- end
1915
- # The ID of the Shipping Rate to use for this shipping option.
1916
- sig { returns(String) }
1917
- attr_accessor :shipping_rate
1918
- # Parameters to be passed to Shipping Rate creation for this shipping option.
1919
- sig {
1920
- returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData)
1921
- }
1922
- attr_accessor :shipping_rate_data
1923
- sig {
1924
- params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData).void
1925
- }
1926
- def initialize(shipping_rate: nil, shipping_rate_data: nil); end
1927
- end
1928
- class SubscriptionData < Stripe::RequestParams
1929
- class InvoiceSettings < Stripe::RequestParams
1930
- class Issuer < Stripe::RequestParams
1931
- # The connected account being referenced when `type` is `account`.
1932
- sig { returns(String) }
1933
- attr_accessor :account
1934
- # Type of the account referenced in the request.
1935
- sig { returns(String) }
1936
- attr_accessor :type
1937
- sig { params(account: String, type: String).void }
1938
- def initialize(account: nil, type: nil); end
1939
- end
1940
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1941
- sig {
1942
- returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)
1943
- }
1944
- attr_accessor :issuer
1945
- sig {
1946
- params(issuer: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer).void
1947
- }
1948
- def initialize(issuer: nil); end
1949
- end
1950
- class TransferData < Stripe::RequestParams
1951
- # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
1952
- sig { returns(Float) }
1953
- attr_accessor :amount_percent
1954
- # ID of an existing, connected Stripe account.
1955
- sig { returns(String) }
1956
- attr_accessor :destination
1957
- sig { params(amount_percent: Float, destination: String).void }
1958
- def initialize(amount_percent: nil, destination: nil); end
1959
- end
1960
- class TrialSettings < Stripe::RequestParams
1961
- class EndBehavior < Stripe::RequestParams
1962
- # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
1963
- sig { returns(String) }
1964
- attr_accessor :missing_payment_method
1965
- sig { params(missing_payment_method: String).void }
1966
- def initialize(missing_payment_method: nil); end
1967
- end
1968
- # Defines how the subscription should behave when the user's free trial ends.
1969
- sig {
1970
- returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
1971
- }
1972
- attr_accessor :end_behavior
1973
- sig {
1974
- params(end_behavior: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
1975
- }
1976
- def initialize(end_behavior: nil); end
1977
- end
1978
- # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
1979
- sig { returns(Float) }
1980
- attr_accessor :application_fee_percent
1981
- # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
1982
- sig { returns(Integer) }
1983
- attr_accessor :billing_cycle_anchor
1984
- # The tax rates that will apply to any subscription item that does not have
1985
- # `tax_rates` set. Invoices created will have their `default_tax_rates` populated
1986
- # from the subscription.
1987
- sig { returns(T::Array[String]) }
1988
- attr_accessor :default_tax_rates
1989
- # The subscription's description, meant to be displayable to the customer.
1990
- # Use this field to optionally store an explanation of the subscription
1991
- # for rendering in the [customer portal](https://stripe.com/docs/customer-management).
1992
- sig { returns(String) }
1993
- attr_accessor :description
1994
- # All invoices will be billed using the specified settings.
1995
- sig {
1996
- returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings)
1997
- }
1998
- attr_accessor :invoice_settings
1999
- # 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`.
2000
- sig { returns(T::Hash[String, String]) }
2001
- attr_accessor :metadata
2002
- # The account on behalf of which to charge, for each of the subscription's invoices.
2003
- sig { returns(String) }
2004
- attr_accessor :on_behalf_of
2005
- # Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
2006
- sig { returns(String) }
2007
- attr_accessor :proration_behavior
2008
- # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
2009
- sig {
2010
- returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData)
2011
- }
2012
- attr_accessor :transfer_data
2013
- # Unix timestamp representing the end of the trial period the customer
2014
- # will get before being charged for the first time. Has to be at least
2015
- # 48 hours in the future.
2016
- sig { returns(Integer) }
2017
- attr_accessor :trial_end
2018
- # Integer representing the number of trial period days before the
2019
- # customer is charged for the first time. Has to be at least 1.
2020
- sig { returns(Integer) }
2021
- attr_accessor :trial_period_days
2022
- # Settings related to subscription trials.
2023
- sig {
2024
- returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings)
2025
- }
2026
- attr_accessor :trial_settings
2027
- sig {
2028
- params(application_fee_percent: Float, billing_cycle_anchor: Integer, default_tax_rates: T::Array[String], description: String, invoice_settings: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings, metadata: T::Hash[String, String], on_behalf_of: String, proration_behavior: String, transfer_data: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData, trial_end: Integer, trial_period_days: Integer, trial_settings: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings).void
2029
- }
2030
- def initialize(
2031
- application_fee_percent: nil,
2032
- billing_cycle_anchor: nil,
2033
- default_tax_rates: nil,
2034
- description: nil,
2035
- invoice_settings: nil,
2036
- metadata: nil,
2037
- on_behalf_of: nil,
2038
- proration_behavior: nil,
2039
- transfer_data: nil,
2040
- trial_end: nil,
2041
- trial_period_days: nil,
2042
- trial_settings: nil
2043
- ); end
2044
- end
2045
- class TaxIdCollection < Stripe::RequestParams
2046
- # Enable tax ID collection during checkout. Defaults to `false`.
2047
- sig { returns(T::Boolean) }
2048
- attr_accessor :enabled
2049
- # Describes whether a tax ID is required during checkout. Defaults to `never`.
2050
- sig { returns(String) }
2051
- attr_accessor :required
2052
- sig { params(enabled: T::Boolean, required: String).void }
2053
- def initialize(enabled: nil, required: nil); end
2054
- end
2055
- # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
2056
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing) }
2057
- attr_accessor :adaptive_pricing
2058
- # Configure actions after a Checkout Session has expired.
2059
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration) }
2060
- attr_accessor :after_expiration
2061
- # Enables user redeemable promotion codes.
2062
- sig { returns(T::Boolean) }
2063
- attr_accessor :allow_promotion_codes
2064
- # Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
2065
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax) }
2066
- attr_accessor :automatic_tax
2067
- # Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
2068
- sig { returns(String) }
2069
- attr_accessor :billing_address_collection
2070
- # If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`.
2071
- sig { returns(String) }
2072
- attr_accessor :cancel_url
2073
- # A unique string to reference the Checkout Session. This can be a
2074
- # customer ID, a cart ID, or similar, and can be used to reconcile the
2075
- # session with your internal systems.
2076
- sig { returns(String) }
2077
- attr_accessor :client_reference_id
2078
- # Configure fields for the Checkout Session to gather active consent from customers.
2079
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection) }
2080
- attr_accessor :consent_collection
2081
- # 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). Required in `setup` mode when `payment_method_types` is not set.
2082
- sig { returns(String) }
2083
- attr_accessor :currency
2084
- # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
2085
- sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField]) }
2086
- attr_accessor :custom_fields
2087
- # Display additional text for your customers using custom text.
2088
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomText) }
2089
- attr_accessor :custom_text
2090
- # ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
2091
- # payment method will be used to prefill the email, name, card details, and billing address
2092
- # on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)
2093
- # will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.
2094
- #
2095
- # If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.
2096
- # If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
2097
- #
2098
- # If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.
2099
- #
2100
- # You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
2101
- sig { returns(String) }
2102
- attr_accessor :customer
2103
- # Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
2104
- #
2105
- # When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
2106
- # with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
2107
- #
2108
- # Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
2109
- # in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
2110
- #
2111
- # Can only be set in `payment` and `setup` mode.
2112
- sig { returns(String) }
2113
- attr_accessor :customer_creation
2114
- # If provided, this value will be used when the Customer object is created.
2115
- # If not provided, customers will be asked to enter their email address.
2116
- # Use this parameter to prefill customer data if you already have an email
2117
- # on file. To access information about the customer once a session is
2118
- # complete, use the `customer` field.
2119
- sig { returns(String) }
2120
- attr_accessor :customer_email
2121
- # Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
2122
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate) }
2123
- attr_accessor :customer_update
2124
- # The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
2125
- sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount]) }
2126
- attr_accessor :discounts
2127
- # Specifies which fields in the response should be expanded.
2128
- sig { returns(T::Array[String]) }
2129
- attr_accessor :expand
2130
- # The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
2131
- sig { returns(Integer) }
2132
- attr_accessor :expires_at
2133
- # Generate a post-purchase Invoice for one-time payments.
2134
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation) }
2135
- attr_accessor :invoice_creation
2136
- # A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
2137
- #
2138
- # For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.
2139
- #
2140
- # For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.
2141
- sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem]) }
2142
- attr_accessor :line_items
2143
- # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
2144
- sig { returns(String) }
2145
- attr_accessor :locale
2146
- # 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`.
2147
- sig { returns(T::Hash[String, String]) }
2148
- attr_accessor :metadata
2149
- # The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
2150
- sig { returns(String) }
2151
- attr_accessor :mode
2152
- # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
2153
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData) }
2154
- attr_accessor :payment_intent_data
2155
- # Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.
2156
- # This may occur if the Checkout Session includes a free trial or a discount.
2157
- #
2158
- # Can only be set in `subscription` mode. Defaults to `always`.
2159
- #
2160
- # If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
2161
- sig { returns(String) }
2162
- attr_accessor :payment_method_collection
2163
- # The ID of the payment method configuration to use with this Checkout session.
2164
- sig { returns(String) }
2165
- attr_accessor :payment_method_configuration
2166
- # This parameter allows you to set some attributes on the payment method created during a Checkout session.
2167
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData) }
2168
- attr_accessor :payment_method_data
2169
- # Payment-method-specific configuration.
2170
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions) }
2171
- attr_accessor :payment_method_options
2172
- # A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
2173
- #
2174
- # You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
2175
- # See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
2176
- #
2177
- # Read more about the supported payment methods and their requirements in our [payment
2178
- # method details guide](/docs/payments/checkout/payment-methods).
2179
- #
2180
- # If multiple payment methods are passed, Checkout will dynamically reorder them to
2181
- # prioritize the most relevant payment methods based on the customer's location and
2182
- # other characteristics.
2183
- sig { returns(T::Array[String]) }
2184
- attr_accessor :payment_method_types
2185
- # This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
2186
- #
2187
- # For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
2188
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::Permissions) }
2189
- attr_accessor :permissions
2190
- # Controls phone number collection settings for the session.
2191
- #
2192
- # We recommend that you review your privacy policy and check with your legal contacts
2193
- # before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
2194
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection) }
2195
- attr_accessor :phone_number_collection
2196
- # This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
2197
- sig { returns(String) }
2198
- attr_accessor :redirect_on_completion
2199
- # The URL to redirect your customer back to after they authenticate or cancel their payment on the
2200
- # payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
2201
- # and redirect-based payment methods are enabled on the session.
2202
- sig { returns(String) }
2203
- attr_accessor :return_url
2204
- # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
2205
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions) }
2206
- attr_accessor :saved_payment_method_options
2207
- # A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
2208
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData) }
2209
- attr_accessor :setup_intent_data
2210
- # When set, provides configuration for Checkout to collect a shipping address from a customer.
2211
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection) }
2212
- attr_accessor :shipping_address_collection
2213
- # The shipping rate options to apply to this Session. Up to a maximum of 5.
2214
- sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption]) }
2215
- attr_accessor :shipping_options
2216
- # Describes the type of transaction being performed by Checkout in order to customize
2217
- # relevant text on the page, such as the submit button. `submit_type` can only be
2218
- # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
2219
- sig { returns(String) }
2220
- attr_accessor :submit_type
2221
- # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
2222
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData) }
2223
- attr_accessor :subscription_data
2224
- # The URL to which Stripe should send customers when payment or setup
2225
- # is complete.
2226
- # This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
2227
- # information from the successful Checkout Session on your page, read the
2228
- # guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
2229
- sig { returns(String) }
2230
- attr_accessor :success_url
2231
- # Controls tax ID collection during checkout.
2232
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection) }
2233
- attr_accessor :tax_id_collection
2234
- # The UI mode of the Session. Defaults to `hosted`.
2235
- sig { returns(String) }
2236
- attr_accessor :ui_mode
2237
- sig {
2238
- params(adaptive_pricing: ::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing, after_expiration: ::Stripe::Checkout::SessionService::CreateParams::AfterExpiration, allow_promotion_codes: T::Boolean, automatic_tax: ::Stripe::Checkout::SessionService::CreateParams::AutomaticTax, billing_address_collection: String, cancel_url: String, client_reference_id: String, consent_collection: ::Stripe::Checkout::SessionService::CreateParams::ConsentCollection, currency: String, custom_fields: T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField], custom_text: ::Stripe::Checkout::SessionService::CreateParams::CustomText, customer: String, customer_creation: String, customer_email: String, customer_update: ::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate, discounts: T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount], expand: T::Array[String], expires_at: Integer, invoice_creation: ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation, line_items: T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem], locale: String, metadata: T::Hash[String, String], mode: String, payment_intent_data: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData, payment_method_collection: String, payment_method_configuration: String, payment_method_data: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData, payment_method_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions, payment_method_types: T::Array[String], permissions: ::Stripe::Checkout::SessionService::CreateParams::Permissions, phone_number_collection: ::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection, redirect_on_completion: String, return_url: String, saved_payment_method_options: ::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions, setup_intent_data: ::Stripe::Checkout::SessionService::CreateParams::SetupIntentData, shipping_address_collection: ::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection, shipping_options: T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption], submit_type: String, subscription_data: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData, success_url: String, tax_id_collection: ::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection, ui_mode: String).void
2239
- }
2240
- def initialize(
2241
- adaptive_pricing: nil,
2242
- after_expiration: nil,
2243
- allow_promotion_codes: nil,
2244
- automatic_tax: nil,
2245
- billing_address_collection: nil,
2246
- cancel_url: nil,
2247
- client_reference_id: nil,
2248
- consent_collection: nil,
2249
- currency: nil,
2250
- custom_fields: nil,
2251
- custom_text: nil,
2252
- customer: nil,
2253
- customer_creation: nil,
2254
- customer_email: nil,
2255
- customer_update: nil,
2256
- discounts: nil,
2257
- expand: nil,
2258
- expires_at: nil,
2259
- invoice_creation: nil,
2260
- line_items: nil,
2261
- locale: nil,
2262
- metadata: nil,
2263
- mode: nil,
2264
- payment_intent_data: nil,
2265
- payment_method_collection: nil,
2266
- payment_method_configuration: nil,
2267
- payment_method_data: nil,
2268
- payment_method_options: nil,
2269
- payment_method_types: nil,
2270
- permissions: nil,
2271
- phone_number_collection: nil,
2272
- redirect_on_completion: nil,
2273
- return_url: nil,
2274
- saved_payment_method_options: nil,
2275
- setup_intent_data: nil,
2276
- shipping_address_collection: nil,
2277
- shipping_options: nil,
2278
- submit_type: nil,
2279
- subscription_data: nil,
2280
- success_url: nil,
2281
- tax_id_collection: nil,
2282
- ui_mode: nil
2283
- ); end
2284
- end
2285
- class RetrieveParams < Stripe::RequestParams
2286
- # Specifies which fields in the response should be expanded.
2287
- sig { returns(T::Array[String]) }
2288
- attr_accessor :expand
2289
- sig { params(expand: T::Array[String]).void }
2290
- def initialize(expand: nil); end
2291
- end
2292
- class UpdateParams < Stripe::RequestParams
2293
- class CollectedInformation < Stripe::RequestParams
2294
- class ShippingDetails < Stripe::RequestParams
2295
- class Address < Stripe::RequestParams
2296
- # City, district, suburb, town, or village.
2297
- sig { returns(String) }
2298
- attr_accessor :city
2299
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2300
- sig { returns(String) }
2301
- attr_accessor :country
2302
- # Address line 1 (e.g., street, PO Box, or company name).
2303
- sig { returns(String) }
2304
- attr_accessor :line1
2305
- # Address line 2 (e.g., apartment, suite, unit, or building).
2306
- sig { returns(String) }
2307
- attr_accessor :line2
2308
- # ZIP or postal code.
2309
- sig { returns(String) }
2310
- attr_accessor :postal_code
2311
- # State, county, province, or region.
2312
- sig { returns(String) }
2313
- attr_accessor :state
2314
- sig {
2315
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2316
- }
2317
- def initialize(
2318
- city: nil,
2319
- country: nil,
2320
- line1: nil,
2321
- line2: nil,
2322
- postal_code: nil,
2323
- state: nil
2324
- ); end
2325
- end
2326
- # The address of the customer
2327
- sig {
2328
- returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address)
2329
- }
2330
- attr_accessor :address
2331
- # The name of customer
2332
- sig { returns(String) }
2333
- attr_accessor :name
2334
- sig {
2335
- params(address: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address, name: String).void
2336
- }
2337
- def initialize(address: nil, name: nil); end
2338
- end
2339
- # The shipping details to apply to this Session.
2340
- sig {
2341
- returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails)
2342
- }
2343
- attr_accessor :shipping_details
2344
- sig {
2345
- params(shipping_details: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails).void
2346
- }
2347
- def initialize(shipping_details: nil); end
2348
- end
2349
- class LineItem < Stripe::RequestParams
2350
- class AdjustableQuantity < Stripe::RequestParams
2351
- # Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
2352
- sig { returns(T::Boolean) }
2353
- attr_accessor :enabled
2354
- # The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
2355
- sig { returns(Integer) }
2356
- attr_accessor :maximum
2357
- # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
2358
- sig { returns(Integer) }
2359
- attr_accessor :minimum
2360
- sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
2361
- def initialize(enabled: nil, maximum: nil, minimum: nil); end
2362
- end
2363
- # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
2364
- sig {
2365
- returns(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity)
2366
- }
2367
- attr_accessor :adjustable_quantity
2368
- # ID of an existing line item.
2369
- sig { returns(String) }
2370
- attr_accessor :id
2371
- # 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`.
2372
- sig { returns(T.nilable(T::Hash[String, String])) }
2373
- attr_accessor :metadata
2374
- # The ID of the [Price](https://stripe.com/docs/api/prices).
2375
- sig { returns(String) }
2376
- attr_accessor :price
2377
- # The quantity of the line item being purchased.
2378
- sig { returns(Integer) }
2379
- attr_accessor :quantity
2380
- # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
2381
- sig { returns(T.nilable(T::Array[String])) }
2382
- attr_accessor :tax_rates
2383
- sig {
2384
- params(adjustable_quantity: ::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity, id: String, metadata: T.nilable(T::Hash[String, String]), price: String, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
2385
- }
2386
- def initialize(
2387
- adjustable_quantity: nil,
2388
- id: nil,
2389
- metadata: nil,
2390
- price: nil,
2391
- quantity: nil,
2392
- tax_rates: nil
2393
- ); end
2394
- end
2395
- class ShippingOption < Stripe::RequestParams
2396
- class ShippingRateData < Stripe::RequestParams
2397
- class DeliveryEstimate < Stripe::RequestParams
2398
- class Maximum < Stripe::RequestParams
2399
- # A unit of time.
2400
- sig { returns(String) }
2401
- attr_accessor :unit
2402
- # Must be greater than 0.
2403
- sig { returns(Integer) }
2404
- attr_accessor :value
2405
- sig { params(unit: String, value: Integer).void }
2406
- def initialize(unit: nil, value: nil); end
2407
- end
2408
- class Minimum < Stripe::RequestParams
2409
- # A unit of time.
2410
- sig { returns(String) }
2411
- attr_accessor :unit
2412
- # Must be greater than 0.
2413
- sig { returns(Integer) }
2414
- attr_accessor :value
2415
- sig { params(unit: String, value: Integer).void }
2416
- def initialize(unit: nil, value: nil); end
2417
- end
2418
- # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
2419
- sig {
2420
- returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
2421
- }
2422
- attr_accessor :maximum
2423
- # The lower bound of the estimated range. If empty, represents no lower bound.
2424
- sig {
2425
- returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
2426
- }
2427
- attr_accessor :minimum
2428
- sig {
2429
- params(maximum: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
2430
- }
2431
- def initialize(maximum: nil, minimum: nil); end
2432
- end
2433
- class FixedAmount < Stripe::RequestParams
2434
- class CurrencyOptions < Stripe::RequestParams
2435
- # A non-negative integer in cents representing how much to charge.
2436
- sig { returns(Integer) }
2437
- attr_accessor :amount
2438
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
2439
- sig { returns(String) }
2440
- attr_accessor :tax_behavior
2441
- sig { params(amount: Integer, tax_behavior: String).void }
2442
- def initialize(amount: nil, tax_behavior: nil); end
2443
- end
2444
- # A non-negative integer in cents representing how much to charge.
2445
- sig { returns(Integer) }
2446
- attr_accessor :amount
2447
- # 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).
2448
- sig { returns(String) }
2449
- attr_accessor :currency
2450
- # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
2451
- sig {
2452
- returns(T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
2453
- }
2454
- attr_accessor :currency_options
2455
- sig {
2456
- params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
2457
- }
2458
- def initialize(amount: nil, currency: nil, currency_options: nil); end
2459
- end
2460
- # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
2461
- sig {
2462
- returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
2463
- }
2464
- attr_accessor :delivery_estimate
2465
- # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
2466
- sig { returns(String) }
2467
- attr_accessor :display_name
2468
- # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
2469
- sig {
2470
- returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount)
2471
- }
2472
- attr_accessor :fixed_amount
2473
- # 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`.
2474
- sig { returns(T::Hash[String, String]) }
2475
- attr_accessor :metadata
2476
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
2477
- sig { returns(String) }
2478
- attr_accessor :tax_behavior
2479
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
2480
- sig { returns(String) }
2481
- attr_accessor :tax_code
2482
- # The type of calculation to use on the shipping rate.
2483
- sig { returns(String) }
2484
- attr_accessor :type
2485
- sig {
2486
- params(delivery_estimate: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
2487
- }
2488
- def initialize(
2489
- delivery_estimate: nil,
2490
- display_name: nil,
2491
- fixed_amount: nil,
2492
- metadata: nil,
2493
- tax_behavior: nil,
2494
- tax_code: nil,
2495
- type: nil
2496
- ); end
2497
- end
2498
- # The ID of the Shipping Rate to use for this shipping option.
2499
- sig { returns(String) }
2500
- attr_accessor :shipping_rate
2501
- # Parameters to be passed to Shipping Rate creation for this shipping option.
2502
- sig {
2503
- returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData)
2504
- }
2505
- attr_accessor :shipping_rate_data
2506
- sig {
2507
- params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData).void
2508
- }
2509
- def initialize(shipping_rate: nil, shipping_rate_data: nil); end
2510
- end
2511
- # Information about the customer collected within the Checkout Session.
2512
- sig { returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation) }
2513
- attr_accessor :collected_information
2514
- # Specifies which fields in the response should be expanded.
2515
- sig { returns(T::Array[String]) }
2516
- attr_accessor :expand
2517
- # A list of items the customer is purchasing.
2518
- #
2519
- # When updating line items, you must retransmit the entire array of line items.
2520
- #
2521
- # To retain an existing line item, specify its `id`.
2522
- #
2523
- # To update an existing line item, specify its `id` along with the new values of the fields to update.
2524
- #
2525
- # To add a new line item, specify a `price` and `quantity`. We don't currently support recurring prices.
2526
- #
2527
- # To remove an existing line item, omit the line item's ID from the retransmitted array.
2528
- #
2529
- # To reorder a line item, specify it at the desired position in the retransmitted array.
2530
- sig { returns(T::Array[::Stripe::Checkout::SessionService::UpdateParams::LineItem]) }
2531
- attr_accessor :line_items
2532
- # 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`.
2533
- sig { returns(T.nilable(T::Hash[String, String])) }
2534
- attr_accessor :metadata
2535
- # The shipping rate options to apply to this Session. Up to a maximum of 5.
2536
- sig {
2537
- returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::UpdateParams::ShippingOption]))
2538
- }
2539
- attr_accessor :shipping_options
2540
- sig {
2541
- params(collected_information: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation, expand: T::Array[String], line_items: T::Array[::Stripe::Checkout::SessionService::UpdateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), shipping_options: T.nilable(T::Array[::Stripe::Checkout::SessionService::UpdateParams::ShippingOption])).void
2542
- }
2543
- def initialize(
2544
- collected_information: nil,
2545
- expand: nil,
2546
- line_items: nil,
2547
- metadata: nil,
2548
- shipping_options: nil
2549
- ); end
2550
- end
2551
- class ExpireParams < Stripe::RequestParams
2552
- # Specifies which fields in the response should be expanded.
2553
- sig { returns(T::Array[String]) }
2554
- attr_accessor :expand
2555
- sig { params(expand: T::Array[String]).void }
2556
- def initialize(expand: nil); end
2557
- end
2558
- # Creates a Session object.
2559
- sig {
2560
- params(params: T.any(::Stripe::Checkout::SessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2561
- }
2562
- def create(params = {}, opts = {}); end
2563
-
2564
- # A Session can be expired when it is in one of these statuses: open
2565
- #
2566
- # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
2567
- sig {
2568
- params(session: String, params: T.any(::Stripe::Checkout::SessionService::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2569
- }
2570
- def expire(session, params = {}, opts = {}); end
2571
-
2572
- # Returns a list of Checkout Sessions.
2573
- sig {
2574
- params(params: T.any(::Stripe::Checkout::SessionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
2575
- }
2576
- def list(params = {}, opts = {}); end
2577
-
2578
- # Retrieves a Session object.
2579
- sig {
2580
- params(session: String, params: T.any(::Stripe::Checkout::SessionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2581
- }
2582
- def retrieve(session, params = {}, opts = {}); end
2583
-
2584
- # Updates a Session object.
2585
- sig {
2586
- params(session: String, params: T.any(::Stripe::Checkout::SessionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2587
- }
2588
- def update(session, params = {}, opts = {}); end
2589
- end
2590
- end
2591
- end