stripe 13.5.0.pre.beta.1 → 13.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (744) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +651 -1426
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_operations/request.rb +0 -1
  6. data/lib/stripe/api_requestor.rb +0 -1
  7. data/lib/stripe/api_version.rb +1 -1
  8. data/lib/stripe/object_types.rb +0 -32
  9. data/lib/stripe/resources/account.rb +0 -5165
  10. data/lib/stripe/resources/account_link.rb +0 -54
  11. data/lib/stripe/resources/account_session.rb +0 -985
  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 -88
  21. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -116
  22. data/lib/stripe/resources/billing/credit_grant.rb +0 -220
  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 -3034
  33. data/lib/stripe/resources/checkout/session.rb +0 -3690
  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 +1 -334
  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 -700
  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 -48
  161. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -40
  162. data/lib/stripe/services/billing/credit_grant_service.rb +0 -162
  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 -2485
  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 +4 -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 -5188
  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 -1143
  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 -116
  388. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -154
  389. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  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 -35
  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 -3494
  404. data/rbi/stripe/resources/checkout/session.rbi +0 -4036
  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 -803
  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 -68
  558. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  559. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -205
  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 -2604
  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,2604 +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
- class Restrictions < Stripe::RequestParams
916
- # Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.
917
- sig { returns(T::Array[String]) }
918
- attr_accessor :brands_blocked
919
- sig { params(brands_blocked: T::Array[String]).void }
920
- def initialize(brands_blocked: nil); end
921
- end
922
- # Installment options for card payments
923
- sig {
924
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Installments)
925
- }
926
- attr_accessor :installments
927
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
928
- sig { returns(String) }
929
- attr_accessor :request_decremental_authorization
930
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
931
- sig { returns(String) }
932
- attr_accessor :request_extended_authorization
933
- # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
934
- sig { returns(String) }
935
- attr_accessor :request_incremental_authorization
936
- # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
937
- sig { returns(String) }
938
- attr_accessor :request_multicapture
939
- # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
940
- sig { returns(String) }
941
- attr_accessor :request_overcapture
942
- # 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.
943
- sig { returns(String) }
944
- attr_accessor :request_three_d_secure
945
- # Restrictions to apply to the card payment method. For example, you can block specific card brands.
946
- sig {
947
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Restrictions)
948
- }
949
- attr_accessor :restrictions
950
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
951
- #
952
- # 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.
953
- #
954
- # 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.
955
- #
956
- # 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).
957
- sig { returns(String) }
958
- attr_accessor :setup_future_usage
959
- # 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.
960
- sig { returns(String) }
961
- attr_accessor :statement_descriptor_suffix_kana
962
- # 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.
963
- sig { returns(String) }
964
- attr_accessor :statement_descriptor_suffix_kanji
965
- sig {
966
- 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, restrictions: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Restrictions, setup_future_usage: String, statement_descriptor_suffix_kana: String, statement_descriptor_suffix_kanji: String).void
967
- }
968
- def initialize(
969
- installments: nil,
970
- request_decremental_authorization: nil,
971
- request_extended_authorization: nil,
972
- request_incremental_authorization: nil,
973
- request_multicapture: nil,
974
- request_overcapture: nil,
975
- request_three_d_secure: nil,
976
- restrictions: nil,
977
- setup_future_usage: nil,
978
- statement_descriptor_suffix_kana: nil,
979
- statement_descriptor_suffix_kanji: nil
980
- ); end
981
- end
982
- class Cashapp < Stripe::RequestParams
983
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
984
- #
985
- # 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.
986
- #
987
- # 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.
988
- #
989
- # 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).
990
- sig { returns(String) }
991
- attr_accessor :setup_future_usage
992
- sig { params(setup_future_usage: String).void }
993
- def initialize(setup_future_usage: nil); end
994
- end
995
- class CustomerBalance < Stripe::RequestParams
996
- class BankTransfer < Stripe::RequestParams
997
- class EuBankTransfer < Stripe::RequestParams
998
- # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
999
- sig { returns(String) }
1000
- attr_accessor :country
1001
- sig { params(country: String).void }
1002
- def initialize(country: nil); end
1003
- end
1004
- # Configuration for eu_bank_transfer funding type.
1005
- sig {
1006
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
1007
- }
1008
- attr_accessor :eu_bank_transfer
1009
- # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
1010
- #
1011
- # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
1012
- sig { returns(T::Array[String]) }
1013
- attr_accessor :requested_address_types
1014
- # The list of bank transfer types that this PaymentIntent is allowed to use for funding.
1015
- sig { returns(String) }
1016
- attr_accessor :type
1017
- sig {
1018
- params(eu_bank_transfer: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, requested_address_types: T::Array[String], type: String).void
1019
- }
1020
- def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
1021
- end
1022
- # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
1023
- sig {
1024
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)
1025
- }
1026
- attr_accessor :bank_transfer
1027
- # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
1028
- sig { returns(String) }
1029
- attr_accessor :funding_type
1030
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1031
- #
1032
- # 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.
1033
- #
1034
- # 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.
1035
- #
1036
- # 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).
1037
- sig { returns(String) }
1038
- attr_accessor :setup_future_usage
1039
- sig {
1040
- params(bank_transfer: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String, setup_future_usage: String).void
1041
- }
1042
- def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
1043
- end
1044
- class Eps < 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 Fpx < 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 Giropay < 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 Grabpay < 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 Ideal < Stripe::RequestParams
1097
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1098
- #
1099
- # 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.
1100
- #
1101
- # 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.
1102
- #
1103
- # 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).
1104
- sig { returns(String) }
1105
- attr_accessor :setup_future_usage
1106
- sig { params(setup_future_usage: String).void }
1107
- def initialize(setup_future_usage: nil); end
1108
- end
1109
- class KakaoPay < Stripe::RequestParams
1110
- # Controls when the funds will be captured from the customer's account.
1111
- sig { returns(String) }
1112
- attr_accessor :capture_method
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(capture_method: String, setup_future_usage: String).void }
1123
- def initialize(capture_method: nil, setup_future_usage: nil); end
1124
- end
1125
- class Klarna < Stripe::RequestParams
1126
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1127
- #
1128
- # 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.
1129
- #
1130
- # 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.
1131
- #
1132
- # 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).
1133
- sig { returns(String) }
1134
- attr_accessor :setup_future_usage
1135
- sig { params(setup_future_usage: String).void }
1136
- def initialize(setup_future_usage: nil); end
1137
- end
1138
- class Konbini < Stripe::RequestParams
1139
- # 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.
1140
- sig { returns(Integer) }
1141
- attr_accessor :expires_after_days
1142
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1143
- #
1144
- # 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.
1145
- #
1146
- # 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.
1147
- #
1148
- # 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).
1149
- sig { returns(String) }
1150
- attr_accessor :setup_future_usage
1151
- sig { params(expires_after_days: Integer, setup_future_usage: String).void }
1152
- def initialize(expires_after_days: nil, setup_future_usage: nil); end
1153
- end
1154
- class KrCard < Stripe::RequestParams
1155
- # Controls when the funds will be captured from the customer's account.
1156
- sig { returns(String) }
1157
- attr_accessor :capture_method
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(capture_method: String, setup_future_usage: String).void }
1168
- def initialize(capture_method: nil, setup_future_usage: nil); end
1169
- end
1170
- class Link < 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 Mobilepay < 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 Multibanco < Stripe::RequestParams
1197
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1198
- #
1199
- # 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.
1200
- #
1201
- # 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.
1202
- #
1203
- # 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).
1204
- sig { returns(String) }
1205
- attr_accessor :setup_future_usage
1206
- sig { params(setup_future_usage: String).void }
1207
- def initialize(setup_future_usage: nil); end
1208
- end
1209
- class NaverPay < Stripe::RequestParams
1210
- # Controls when the funds will be captured from the customer's account.
1211
- sig { returns(String) }
1212
- attr_accessor :capture_method
1213
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1214
- #
1215
- # 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.
1216
- #
1217
- # 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.
1218
- #
1219
- # 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).
1220
- sig { returns(String) }
1221
- attr_accessor :setup_future_usage
1222
- sig { params(capture_method: String, setup_future_usage: String).void }
1223
- def initialize(capture_method: nil, setup_future_usage: nil); end
1224
- end
1225
- class Oxxo < Stripe::RequestParams
1226
- # 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.
1227
- sig { returns(Integer) }
1228
- attr_accessor :expires_after_days
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
- sig { params(expires_after_days: Integer, setup_future_usage: String).void }
1239
- def initialize(expires_after_days: nil, setup_future_usage: nil); end
1240
- end
1241
- class P24 < Stripe::RequestParams
1242
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1243
- #
1244
- # 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.
1245
- #
1246
- # 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.
1247
- #
1248
- # 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).
1249
- sig { returns(String) }
1250
- attr_accessor :setup_future_usage
1251
- # Confirm that the payer has accepted the P24 terms and conditions.
1252
- sig { returns(T::Boolean) }
1253
- attr_accessor :tos_shown_and_accepted
1254
- sig { params(setup_future_usage: String, tos_shown_and_accepted: T::Boolean).void }
1255
- def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
1256
- end
1257
- class PayByBank < Stripe::RequestParams
1258
-
1259
- end
1260
- class Payco < Stripe::RequestParams
1261
- # Controls when the funds will be captured from the customer's account.
1262
- sig { returns(String) }
1263
- attr_accessor :capture_method
1264
- sig { params(capture_method: String).void }
1265
- def initialize(capture_method: nil); end
1266
- end
1267
- class Paynow < Stripe::RequestParams
1268
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1269
- #
1270
- # 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.
1271
- #
1272
- # 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.
1273
- #
1274
- # 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).
1275
- sig { returns(String) }
1276
- attr_accessor :setup_future_usage
1277
- sig { params(setup_future_usage: String).void }
1278
- def initialize(setup_future_usage: nil); end
1279
- end
1280
- class Paypal < Stripe::RequestParams
1281
- # Controls when the funds will be captured from the customer's account.
1282
- sig { returns(T.nilable(String)) }
1283
- attr_accessor :capture_method
1284
- # [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
1285
- sig { returns(String) }
1286
- attr_accessor :preferred_locale
1287
- # 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.
1288
- sig { returns(String) }
1289
- attr_accessor :reference
1290
- # 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.
1291
- sig { returns(String) }
1292
- attr_accessor :reference_id
1293
- # The risk correlation ID for an on-session payment using a saved PayPal payment method.
1294
- sig { returns(String) }
1295
- attr_accessor :risk_correlation_id
1296
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1297
- #
1298
- # 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.
1299
- #
1300
- # 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.
1301
- #
1302
- # 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).
1303
- #
1304
- # 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`.
1305
- sig { returns(T.nilable(String)) }
1306
- attr_accessor :setup_future_usage
1307
- # 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.
1308
- sig { returns(T::Array[String]) }
1309
- attr_accessor :subsellers
1310
- sig {
1311
- 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
1312
- }
1313
- def initialize(
1314
- capture_method: nil,
1315
- preferred_locale: nil,
1316
- reference: nil,
1317
- reference_id: nil,
1318
- risk_correlation_id: nil,
1319
- setup_future_usage: nil,
1320
- subsellers: nil
1321
- ); end
1322
- end
1323
- class Payto < Stripe::RequestParams
1324
- class MandateOptions < Stripe::RequestParams
1325
- # Amount that will be collected. It is required when `amount_type` is `fixed`.
1326
- sig { returns(Integer) }
1327
- attr_accessor :amount
1328
- # 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.
1329
- sig { returns(String) }
1330
- attr_accessor :amount_type
1331
- # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
1332
- sig { returns(String) }
1333
- attr_accessor :end_date
1334
- # The periodicity at which payments will be collected.
1335
- sig { returns(String) }
1336
- attr_accessor :payment_schedule
1337
- # 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.
1338
- sig { returns(Integer) }
1339
- attr_accessor :payments_per_period
1340
- # The purpose for which payments are made. Defaults to retail.
1341
- sig { returns(String) }
1342
- attr_accessor :purpose
1343
- # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
1344
- sig { returns(String) }
1345
- attr_accessor :start_date
1346
- sig {
1347
- params(amount: Integer, amount_type: String, end_date: String, payment_schedule: String, payments_per_period: Integer, purpose: String, start_date: String).void
1348
- }
1349
- def initialize(
1350
- amount: nil,
1351
- amount_type: nil,
1352
- end_date: nil,
1353
- payment_schedule: nil,
1354
- payments_per_period: nil,
1355
- purpose: nil,
1356
- start_date: nil
1357
- ); end
1358
- end
1359
- # Additional fields for Mandate creation
1360
- sig {
1361
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto::MandateOptions)
1362
- }
1363
- attr_accessor :mandate_options
1364
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1365
- #
1366
- # 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.
1367
- #
1368
- # 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.
1369
- #
1370
- # 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).
1371
- sig { returns(String) }
1372
- attr_accessor :setup_future_usage
1373
- sig {
1374
- params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto::MandateOptions, setup_future_usage: String).void
1375
- }
1376
- def initialize(mandate_options: nil, setup_future_usage: nil); end
1377
- end
1378
- class Pix < Stripe::RequestParams
1379
- # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
1380
- sig { returns(Integer) }
1381
- attr_accessor :expires_after_seconds
1382
- sig { params(expires_after_seconds: Integer).void }
1383
- def initialize(expires_after_seconds: nil); end
1384
- end
1385
- class RevolutPay < Stripe::RequestParams
1386
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1387
- #
1388
- # 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.
1389
- #
1390
- # 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.
1391
- #
1392
- # 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).
1393
- sig { returns(String) }
1394
- attr_accessor :setup_future_usage
1395
- sig { params(setup_future_usage: String).void }
1396
- def initialize(setup_future_usage: nil); end
1397
- end
1398
- class SamsungPay < Stripe::RequestParams
1399
- # Controls when the funds will be captured from the customer's account.
1400
- sig { returns(String) }
1401
- attr_accessor :capture_method
1402
- sig { params(capture_method: String).void }
1403
- def initialize(capture_method: nil); end
1404
- end
1405
- class SepaDebit < Stripe::RequestParams
1406
- class MandateOptions < Stripe::RequestParams
1407
- # 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'.
1408
- sig { returns(T.nilable(String)) }
1409
- attr_accessor :reference_prefix
1410
- sig { params(reference_prefix: T.nilable(String)).void }
1411
- def initialize(reference_prefix: nil); end
1412
- end
1413
- # Additional fields for Mandate creation
1414
- sig {
1415
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)
1416
- }
1417
- attr_accessor :mandate_options
1418
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1419
- #
1420
- # 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.
1421
- #
1422
- # 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.
1423
- #
1424
- # 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).
1425
- sig { returns(String) }
1426
- attr_accessor :setup_future_usage
1427
- sig {
1428
- params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: String).void
1429
- }
1430
- def initialize(mandate_options: nil, setup_future_usage: nil); end
1431
- end
1432
- class Sofort < Stripe::RequestParams
1433
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1434
- #
1435
- # 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.
1436
- #
1437
- # 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.
1438
- #
1439
- # 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).
1440
- sig { returns(String) }
1441
- attr_accessor :setup_future_usage
1442
- sig { params(setup_future_usage: String).void }
1443
- def initialize(setup_future_usage: nil); end
1444
- end
1445
- class Swish < Stripe::RequestParams
1446
- # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
1447
- sig { returns(String) }
1448
- attr_accessor :reference
1449
- sig { params(reference: String).void }
1450
- def initialize(reference: nil); end
1451
- end
1452
- class UsBankAccount < Stripe::RequestParams
1453
- class FinancialConnections < Stripe::RequestParams
1454
- # 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`.
1455
- sig { returns(T::Array[String]) }
1456
- attr_accessor :permissions
1457
- # List of data features that you would like to retrieve upon account creation.
1458
- sig { returns(T::Array[String]) }
1459
- attr_accessor :prefetch
1460
- sig { params(permissions: T::Array[String], prefetch: T::Array[String]).void }
1461
- def initialize(permissions: nil, prefetch: nil); end
1462
- end
1463
- # Additional fields for Financial Connections Session creation
1464
- sig {
1465
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)
1466
- }
1467
- attr_accessor :financial_connections
1468
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1469
- #
1470
- # 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.
1471
- #
1472
- # 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.
1473
- #
1474
- # 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).
1475
- sig { returns(String) }
1476
- attr_accessor :setup_future_usage
1477
- # Verification method for the intent
1478
- sig { returns(String) }
1479
- attr_accessor :verification_method
1480
- sig {
1481
- params(financial_connections: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, setup_future_usage: String, verification_method: String).void
1482
- }
1483
- def initialize(
1484
- financial_connections: nil,
1485
- setup_future_usage: nil,
1486
- verification_method: nil
1487
- ); end
1488
- end
1489
- class WechatPay < Stripe::RequestParams
1490
- # The app ID registered with WeChat Pay. Only required when client is ios or android.
1491
- sig { returns(String) }
1492
- attr_accessor :app_id
1493
- # The client type that the end customer will pay from
1494
- sig { returns(String) }
1495
- attr_accessor :client
1496
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1497
- #
1498
- # 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.
1499
- #
1500
- # 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.
1501
- #
1502
- # 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).
1503
- sig { returns(String) }
1504
- attr_accessor :setup_future_usage
1505
- sig { params(app_id: String, client: String, setup_future_usage: String).void }
1506
- def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
1507
- end
1508
- # contains details about the ACSS Debit payment method options.
1509
- sig {
1510
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit)
1511
- }
1512
- attr_accessor :acss_debit
1513
- # contains details about the Affirm payment method options.
1514
- sig {
1515
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm)
1516
- }
1517
- attr_accessor :affirm
1518
- # contains details about the Afterpay Clearpay payment method options.
1519
- sig {
1520
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay)
1521
- }
1522
- attr_accessor :afterpay_clearpay
1523
- # contains details about the Alipay payment method options.
1524
- sig {
1525
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay)
1526
- }
1527
- attr_accessor :alipay
1528
- # contains details about the AmazonPay payment method options.
1529
- sig {
1530
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay)
1531
- }
1532
- attr_accessor :amazon_pay
1533
- # contains details about the AU Becs Debit payment method options.
1534
- sig {
1535
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit)
1536
- }
1537
- attr_accessor :au_becs_debit
1538
- # contains details about the Bacs Debit payment method options.
1539
- sig {
1540
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit)
1541
- }
1542
- attr_accessor :bacs_debit
1543
- # contains details about the Bancontact payment method options.
1544
- sig {
1545
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact)
1546
- }
1547
- attr_accessor :bancontact
1548
- # contains details about the Boleto payment method options.
1549
- sig {
1550
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto)
1551
- }
1552
- attr_accessor :boleto
1553
- # contains details about the Card payment method options.
1554
- sig {
1555
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card)
1556
- }
1557
- attr_accessor :card
1558
- # contains details about the Cashapp Pay payment method options.
1559
- sig {
1560
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp)
1561
- }
1562
- attr_accessor :cashapp
1563
- # contains details about the Customer Balance payment method options.
1564
- sig {
1565
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance)
1566
- }
1567
- attr_accessor :customer_balance
1568
- # contains details about the EPS payment method options.
1569
- sig {
1570
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps)
1571
- }
1572
- attr_accessor :eps
1573
- # contains details about the FPX payment method options.
1574
- sig {
1575
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx)
1576
- }
1577
- attr_accessor :fpx
1578
- # contains details about the Giropay payment method options.
1579
- sig {
1580
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay)
1581
- }
1582
- attr_accessor :giropay
1583
- # contains details about the Grabpay payment method options.
1584
- sig {
1585
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay)
1586
- }
1587
- attr_accessor :grabpay
1588
- # contains details about the Ideal payment method options.
1589
- sig {
1590
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal)
1591
- }
1592
- attr_accessor :ideal
1593
- # contains details about the Kakao Pay payment method options.
1594
- sig {
1595
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay)
1596
- }
1597
- attr_accessor :kakao_pay
1598
- # contains details about the Klarna payment method options.
1599
- sig {
1600
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna)
1601
- }
1602
- attr_accessor :klarna
1603
- # contains details about the Konbini payment method options.
1604
- sig {
1605
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini)
1606
- }
1607
- attr_accessor :konbini
1608
- # contains details about the Korean card payment method options.
1609
- sig {
1610
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard)
1611
- }
1612
- attr_accessor :kr_card
1613
- # contains details about the Link payment method options.
1614
- sig {
1615
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link)
1616
- }
1617
- attr_accessor :link
1618
- # contains details about the Mobilepay payment method options.
1619
- sig {
1620
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay)
1621
- }
1622
- attr_accessor :mobilepay
1623
- # contains details about the Multibanco payment method options.
1624
- sig {
1625
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco)
1626
- }
1627
- attr_accessor :multibanco
1628
- # contains details about the Naver Pay payment method options.
1629
- sig {
1630
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay)
1631
- }
1632
- attr_accessor :naver_pay
1633
- # contains details about the OXXO payment method options.
1634
- sig {
1635
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo)
1636
- }
1637
- attr_accessor :oxxo
1638
- # contains details about the P24 payment method options.
1639
- sig {
1640
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24)
1641
- }
1642
- attr_accessor :p24
1643
- # contains details about the Pay By Bank payment method options.
1644
- sig {
1645
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::PayByBank)
1646
- }
1647
- attr_accessor :pay_by_bank
1648
- # contains details about the PAYCO payment method options.
1649
- sig {
1650
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco)
1651
- }
1652
- attr_accessor :payco
1653
- # contains details about the PayNow payment method options.
1654
- sig {
1655
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow)
1656
- }
1657
- attr_accessor :paynow
1658
- # contains details about the PayPal payment method options.
1659
- sig {
1660
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal)
1661
- }
1662
- attr_accessor :paypal
1663
- # contains details about the PayTo payment method options.
1664
- sig {
1665
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto)
1666
- }
1667
- attr_accessor :payto
1668
- # contains details about the Pix payment method options.
1669
- sig {
1670
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix)
1671
- }
1672
- attr_accessor :pix
1673
- # contains details about the RevolutPay payment method options.
1674
- sig {
1675
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay)
1676
- }
1677
- attr_accessor :revolut_pay
1678
- # contains details about the Samsung Pay payment method options.
1679
- sig {
1680
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay)
1681
- }
1682
- attr_accessor :samsung_pay
1683
- # contains details about the Sepa Debit payment method options.
1684
- sig {
1685
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit)
1686
- }
1687
- attr_accessor :sepa_debit
1688
- # contains details about the Sofort payment method options.
1689
- sig {
1690
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort)
1691
- }
1692
- attr_accessor :sofort
1693
- # contains details about the Swish payment method options.
1694
- sig {
1695
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish)
1696
- }
1697
- attr_accessor :swish
1698
- # contains details about the Us Bank Account payment method options.
1699
- sig {
1700
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount)
1701
- }
1702
- attr_accessor :us_bank_account
1703
- # contains details about the WeChat Pay payment method options.
1704
- sig {
1705
- returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay)
1706
- }
1707
- attr_accessor :wechat_pay
1708
- sig {
1709
- 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
1710
- }
1711
- def initialize(
1712
- acss_debit: nil,
1713
- affirm: nil,
1714
- afterpay_clearpay: nil,
1715
- alipay: nil,
1716
- amazon_pay: nil,
1717
- au_becs_debit: nil,
1718
- bacs_debit: nil,
1719
- bancontact: nil,
1720
- boleto: nil,
1721
- card: nil,
1722
- cashapp: nil,
1723
- customer_balance: nil,
1724
- eps: nil,
1725
- fpx: nil,
1726
- giropay: nil,
1727
- grabpay: nil,
1728
- ideal: nil,
1729
- kakao_pay: nil,
1730
- klarna: nil,
1731
- konbini: nil,
1732
- kr_card: nil,
1733
- link: nil,
1734
- mobilepay: nil,
1735
- multibanco: nil,
1736
- naver_pay: nil,
1737
- oxxo: nil,
1738
- p24: nil,
1739
- pay_by_bank: nil,
1740
- payco: nil,
1741
- paynow: nil,
1742
- paypal: nil,
1743
- payto: nil,
1744
- pix: nil,
1745
- revolut_pay: nil,
1746
- samsung_pay: nil,
1747
- sepa_debit: nil,
1748
- sofort: nil,
1749
- swish: nil,
1750
- us_bank_account: nil,
1751
- wechat_pay: nil
1752
- ); end
1753
- end
1754
- class Permissions < Stripe::RequestParams
1755
- class Update < Stripe::RequestParams
1756
- # Determines which entity is allowed to update the line items.
1757
- #
1758
- # 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.
1759
- #
1760
- # 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.
1761
- sig { returns(String) }
1762
- attr_accessor :line_items
1763
- # Determines which entity is allowed to update the shipping details.
1764
- #
1765
- # 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.
1766
- #
1767
- # 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.
1768
- sig { returns(String) }
1769
- attr_accessor :shipping_details
1770
- sig { params(line_items: String, shipping_details: String).void }
1771
- def initialize(line_items: nil, shipping_details: nil); end
1772
- end
1773
- # Permissions for updating the Checkout Session.
1774
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::Permissions::Update) }
1775
- attr_accessor :update
1776
- sig {
1777
- params(update: ::Stripe::Checkout::SessionService::CreateParams::Permissions::Update).void
1778
- }
1779
- def initialize(update: nil); end
1780
- end
1781
- class PhoneNumberCollection < Stripe::RequestParams
1782
- # Set to `true` to enable phone number collection.
1783
- #
1784
- # Can only be set in `payment` and `subscription` mode.
1785
- sig { returns(T::Boolean) }
1786
- attr_accessor :enabled
1787
- sig { params(enabled: T::Boolean).void }
1788
- def initialize(enabled: nil); end
1789
- end
1790
- class SavedPaymentMethodOptions < Stripe::RequestParams
1791
- # 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.
1792
- sig { returns(T::Array[String]) }
1793
- attr_accessor :allow_redisplay_filters
1794
- # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
1795
- sig { returns(String) }
1796
- attr_accessor :payment_method_save
1797
- sig {
1798
- params(allow_redisplay_filters: T::Array[String], payment_method_save: String).void
1799
- }
1800
- def initialize(allow_redisplay_filters: nil, payment_method_save: nil); end
1801
- end
1802
- class SetupIntentData < Stripe::RequestParams
1803
- # An arbitrary string attached to the object. Often useful for displaying to users.
1804
- sig { returns(String) }
1805
- attr_accessor :description
1806
- # 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`.
1807
- sig { returns(T::Hash[String, String]) }
1808
- attr_accessor :metadata
1809
- # The Stripe account for which the setup is intended.
1810
- sig { returns(String) }
1811
- attr_accessor :on_behalf_of
1812
- sig {
1813
- params(description: String, metadata: T::Hash[String, String], on_behalf_of: String).void
1814
- }
1815
- def initialize(description: nil, metadata: nil, on_behalf_of: nil); end
1816
- end
1817
- class ShippingAddressCollection < Stripe::RequestParams
1818
- # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1819
- # shipping locations.
1820
- sig { returns(T::Array[String]) }
1821
- attr_accessor :allowed_countries
1822
- sig { params(allowed_countries: T::Array[String]).void }
1823
- def initialize(allowed_countries: nil); end
1824
- end
1825
- class ShippingOption < Stripe::RequestParams
1826
- class ShippingRateData < Stripe::RequestParams
1827
- class DeliveryEstimate < Stripe::RequestParams
1828
- class Maximum < Stripe::RequestParams
1829
- # A unit of time.
1830
- sig { returns(String) }
1831
- attr_accessor :unit
1832
- # Must be greater than 0.
1833
- sig { returns(Integer) }
1834
- attr_accessor :value
1835
- sig { params(unit: String, value: Integer).void }
1836
- def initialize(unit: nil, value: nil); end
1837
- end
1838
- class Minimum < Stripe::RequestParams
1839
- # A unit of time.
1840
- sig { returns(String) }
1841
- attr_accessor :unit
1842
- # Must be greater than 0.
1843
- sig { returns(Integer) }
1844
- attr_accessor :value
1845
- sig { params(unit: String, value: Integer).void }
1846
- def initialize(unit: nil, value: nil); end
1847
- end
1848
- # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
1849
- sig {
1850
- returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
1851
- }
1852
- attr_accessor :maximum
1853
- # The lower bound of the estimated range. If empty, represents no lower bound.
1854
- sig {
1855
- returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
1856
- }
1857
- attr_accessor :minimum
1858
- sig {
1859
- params(maximum: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
1860
- }
1861
- def initialize(maximum: nil, minimum: nil); end
1862
- end
1863
- class FixedAmount < Stripe::RequestParams
1864
- class CurrencyOptions < Stripe::RequestParams
1865
- # A non-negative integer in cents representing how much to charge.
1866
- sig { returns(Integer) }
1867
- attr_accessor :amount
1868
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1869
- sig { returns(String) }
1870
- attr_accessor :tax_behavior
1871
- sig { params(amount: Integer, tax_behavior: String).void }
1872
- def initialize(amount: nil, tax_behavior: nil); end
1873
- end
1874
- # A non-negative integer in cents representing how much to charge.
1875
- sig { returns(Integer) }
1876
- attr_accessor :amount
1877
- # 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).
1878
- sig { returns(String) }
1879
- attr_accessor :currency
1880
- # 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).
1881
- sig {
1882
- returns(T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
1883
- }
1884
- attr_accessor :currency_options
1885
- sig {
1886
- params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
1887
- }
1888
- def initialize(amount: nil, currency: nil, currency_options: nil); end
1889
- end
1890
- # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
1891
- sig {
1892
- returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
1893
- }
1894
- attr_accessor :delivery_estimate
1895
- # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
1896
- sig { returns(String) }
1897
- attr_accessor :display_name
1898
- # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
1899
- sig {
1900
- returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount)
1901
- }
1902
- attr_accessor :fixed_amount
1903
- # 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`.
1904
- sig { returns(T::Hash[String, String]) }
1905
- attr_accessor :metadata
1906
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1907
- sig { returns(String) }
1908
- attr_accessor :tax_behavior
1909
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
1910
- sig { returns(String) }
1911
- attr_accessor :tax_code
1912
- # The type of calculation to use on the shipping rate.
1913
- sig { returns(String) }
1914
- attr_accessor :type
1915
- sig {
1916
- 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
1917
- }
1918
- def initialize(
1919
- delivery_estimate: nil,
1920
- display_name: nil,
1921
- fixed_amount: nil,
1922
- metadata: nil,
1923
- tax_behavior: nil,
1924
- tax_code: nil,
1925
- type: nil
1926
- ); end
1927
- end
1928
- # The ID of the Shipping Rate to use for this shipping option.
1929
- sig { returns(String) }
1930
- attr_accessor :shipping_rate
1931
- # Parameters to be passed to Shipping Rate creation for this shipping option.
1932
- sig {
1933
- returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData)
1934
- }
1935
- attr_accessor :shipping_rate_data
1936
- sig {
1937
- params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData).void
1938
- }
1939
- def initialize(shipping_rate: nil, shipping_rate_data: nil); end
1940
- end
1941
- class SubscriptionData < Stripe::RequestParams
1942
- class InvoiceSettings < Stripe::RequestParams
1943
- class Issuer < Stripe::RequestParams
1944
- # The connected account being referenced when `type` is `account`.
1945
- sig { returns(String) }
1946
- attr_accessor :account
1947
- # Type of the account referenced in the request.
1948
- sig { returns(String) }
1949
- attr_accessor :type
1950
- sig { params(account: String, type: String).void }
1951
- def initialize(account: nil, type: nil); end
1952
- end
1953
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1954
- sig {
1955
- returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)
1956
- }
1957
- attr_accessor :issuer
1958
- sig {
1959
- params(issuer: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer).void
1960
- }
1961
- def initialize(issuer: nil); end
1962
- end
1963
- class TransferData < Stripe::RequestParams
1964
- # 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.
1965
- sig { returns(Float) }
1966
- attr_accessor :amount_percent
1967
- # ID of an existing, connected Stripe account.
1968
- sig { returns(String) }
1969
- attr_accessor :destination
1970
- sig { params(amount_percent: Float, destination: String).void }
1971
- def initialize(amount_percent: nil, destination: nil); end
1972
- end
1973
- class TrialSettings < Stripe::RequestParams
1974
- class EndBehavior < Stripe::RequestParams
1975
- # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
1976
- sig { returns(String) }
1977
- attr_accessor :missing_payment_method
1978
- sig { params(missing_payment_method: String).void }
1979
- def initialize(missing_payment_method: nil); end
1980
- end
1981
- # Defines how the subscription should behave when the user's free trial ends.
1982
- sig {
1983
- returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
1984
- }
1985
- attr_accessor :end_behavior
1986
- sig {
1987
- params(end_behavior: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
1988
- }
1989
- def initialize(end_behavior: nil); end
1990
- end
1991
- # 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).
1992
- sig { returns(Float) }
1993
- attr_accessor :application_fee_percent
1994
- # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
1995
- sig { returns(Integer) }
1996
- attr_accessor :billing_cycle_anchor
1997
- # The tax rates that will apply to any subscription item that does not have
1998
- # `tax_rates` set. Invoices created will have their `default_tax_rates` populated
1999
- # from the subscription.
2000
- sig { returns(T::Array[String]) }
2001
- attr_accessor :default_tax_rates
2002
- # The subscription's description, meant to be displayable to the customer.
2003
- # Use this field to optionally store an explanation of the subscription
2004
- # for rendering in the [customer portal](https://stripe.com/docs/customer-management).
2005
- sig { returns(String) }
2006
- attr_accessor :description
2007
- # All invoices will be billed using the specified settings.
2008
- sig {
2009
- returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings)
2010
- }
2011
- attr_accessor :invoice_settings
2012
- # 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`.
2013
- sig { returns(T::Hash[String, String]) }
2014
- attr_accessor :metadata
2015
- # The account on behalf of which to charge, for each of the subscription's invoices.
2016
- sig { returns(String) }
2017
- attr_accessor :on_behalf_of
2018
- # Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
2019
- sig { returns(String) }
2020
- attr_accessor :proration_behavior
2021
- # 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.
2022
- sig {
2023
- returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData)
2024
- }
2025
- attr_accessor :transfer_data
2026
- # Unix timestamp representing the end of the trial period the customer
2027
- # will get before being charged for the first time. Has to be at least
2028
- # 48 hours in the future.
2029
- sig { returns(Integer) }
2030
- attr_accessor :trial_end
2031
- # Integer representing the number of trial period days before the
2032
- # customer is charged for the first time. Has to be at least 1.
2033
- sig { returns(Integer) }
2034
- attr_accessor :trial_period_days
2035
- # Settings related to subscription trials.
2036
- sig {
2037
- returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings)
2038
- }
2039
- attr_accessor :trial_settings
2040
- sig {
2041
- 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
2042
- }
2043
- def initialize(
2044
- application_fee_percent: nil,
2045
- billing_cycle_anchor: nil,
2046
- default_tax_rates: nil,
2047
- description: nil,
2048
- invoice_settings: nil,
2049
- metadata: nil,
2050
- on_behalf_of: nil,
2051
- proration_behavior: nil,
2052
- transfer_data: nil,
2053
- trial_end: nil,
2054
- trial_period_days: nil,
2055
- trial_settings: nil
2056
- ); end
2057
- end
2058
- class TaxIdCollection < Stripe::RequestParams
2059
- # Enable tax ID collection during checkout. Defaults to `false`.
2060
- sig { returns(T::Boolean) }
2061
- attr_accessor :enabled
2062
- # Describes whether a tax ID is required during checkout. Defaults to `never`.
2063
- sig { returns(String) }
2064
- attr_accessor :required
2065
- sig { params(enabled: T::Boolean, required: String).void }
2066
- def initialize(enabled: nil, required: nil); end
2067
- end
2068
- # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
2069
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing) }
2070
- attr_accessor :adaptive_pricing
2071
- # Configure actions after a Checkout Session has expired.
2072
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration) }
2073
- attr_accessor :after_expiration
2074
- # Enables user redeemable promotion codes.
2075
- sig { returns(T::Boolean) }
2076
- attr_accessor :allow_promotion_codes
2077
- # Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
2078
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax) }
2079
- attr_accessor :automatic_tax
2080
- # Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
2081
- sig { returns(String) }
2082
- attr_accessor :billing_address_collection
2083
- # 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`.
2084
- sig { returns(String) }
2085
- attr_accessor :cancel_url
2086
- # A unique string to reference the Checkout Session. This can be a
2087
- # customer ID, a cart ID, or similar, and can be used to reconcile the
2088
- # session with your internal systems.
2089
- sig { returns(String) }
2090
- attr_accessor :client_reference_id
2091
- # Configure fields for the Checkout Session to gather active consent from customers.
2092
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection) }
2093
- attr_accessor :consent_collection
2094
- # 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.
2095
- sig { returns(String) }
2096
- attr_accessor :currency
2097
- # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
2098
- sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField]) }
2099
- attr_accessor :custom_fields
2100
- # Display additional text for your customers using custom text.
2101
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomText) }
2102
- attr_accessor :custom_text
2103
- # ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
2104
- # payment method will be used to prefill the email, name, card details, and billing address
2105
- # 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)
2106
- # 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.
2107
- #
2108
- # 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.
2109
- # If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
2110
- #
2111
- # 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.
2112
- #
2113
- # 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.
2114
- sig { returns(String) }
2115
- attr_accessor :customer
2116
- # Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
2117
- #
2118
- # When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
2119
- # with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
2120
- #
2121
- # Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
2122
- # in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
2123
- #
2124
- # Can only be set in `payment` and `setup` mode.
2125
- sig { returns(String) }
2126
- attr_accessor :customer_creation
2127
- # If provided, this value will be used when the Customer object is created.
2128
- # If not provided, customers will be asked to enter their email address.
2129
- # Use this parameter to prefill customer data if you already have an email
2130
- # on file. To access information about the customer once a session is
2131
- # complete, use the `customer` field.
2132
- sig { returns(String) }
2133
- attr_accessor :customer_email
2134
- # Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
2135
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate) }
2136
- attr_accessor :customer_update
2137
- # The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
2138
- sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount]) }
2139
- attr_accessor :discounts
2140
- # Specifies which fields in the response should be expanded.
2141
- sig { returns(T::Array[String]) }
2142
- attr_accessor :expand
2143
- # 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.
2144
- sig { returns(Integer) }
2145
- attr_accessor :expires_at
2146
- # Generate a post-purchase Invoice for one-time payments.
2147
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation) }
2148
- attr_accessor :invoice_creation
2149
- # A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
2150
- #
2151
- # 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.
2152
- #
2153
- # 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.
2154
- sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem]) }
2155
- attr_accessor :line_items
2156
- # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
2157
- sig { returns(String) }
2158
- attr_accessor :locale
2159
- # 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`.
2160
- sig { returns(T::Hash[String, String]) }
2161
- attr_accessor :metadata
2162
- # The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
2163
- sig { returns(String) }
2164
- attr_accessor :mode
2165
- # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
2166
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData) }
2167
- attr_accessor :payment_intent_data
2168
- # 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.
2169
- # This may occur if the Checkout Session includes a free trial or a discount.
2170
- #
2171
- # Can only be set in `subscription` mode. Defaults to `always`.
2172
- #
2173
- # 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).
2174
- sig { returns(String) }
2175
- attr_accessor :payment_method_collection
2176
- # The ID of the payment method configuration to use with this Checkout session.
2177
- sig { returns(String) }
2178
- attr_accessor :payment_method_configuration
2179
- # This parameter allows you to set some attributes on the payment method created during a Checkout session.
2180
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData) }
2181
- attr_accessor :payment_method_data
2182
- # Payment-method-specific configuration.
2183
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions) }
2184
- attr_accessor :payment_method_options
2185
- # A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
2186
- #
2187
- # You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
2188
- # See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
2189
- #
2190
- # Read more about the supported payment methods and their requirements in our [payment
2191
- # method details guide](/docs/payments/checkout/payment-methods).
2192
- #
2193
- # If multiple payment methods are passed, Checkout will dynamically reorder them to
2194
- # prioritize the most relevant payment methods based on the customer's location and
2195
- # other characteristics.
2196
- sig { returns(T::Array[String]) }
2197
- attr_accessor :payment_method_types
2198
- # This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
2199
- #
2200
- # For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
2201
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::Permissions) }
2202
- attr_accessor :permissions
2203
- # Controls phone number collection settings for the session.
2204
- #
2205
- # We recommend that you review your privacy policy and check with your legal contacts
2206
- # before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
2207
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection) }
2208
- attr_accessor :phone_number_collection
2209
- # 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`.
2210
- sig { returns(String) }
2211
- attr_accessor :redirect_on_completion
2212
- # The URL to redirect your customer back to after they authenticate or cancel their payment on the
2213
- # payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
2214
- # and redirect-based payment methods are enabled on the session.
2215
- sig { returns(String) }
2216
- attr_accessor :return_url
2217
- # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
2218
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions) }
2219
- attr_accessor :saved_payment_method_options
2220
- # A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
2221
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData) }
2222
- attr_accessor :setup_intent_data
2223
- # When set, provides configuration for Checkout to collect a shipping address from a customer.
2224
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection) }
2225
- attr_accessor :shipping_address_collection
2226
- # The shipping rate options to apply to this Session. Up to a maximum of 5.
2227
- sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption]) }
2228
- attr_accessor :shipping_options
2229
- # Describes the type of transaction being performed by Checkout in order to customize
2230
- # relevant text on the page, such as the submit button. `submit_type` can only be
2231
- # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
2232
- sig { returns(String) }
2233
- attr_accessor :submit_type
2234
- # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
2235
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData) }
2236
- attr_accessor :subscription_data
2237
- # The URL to which Stripe should send customers when payment or setup
2238
- # is complete.
2239
- # This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
2240
- # information from the successful Checkout Session on your page, read the
2241
- # guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
2242
- sig { returns(String) }
2243
- attr_accessor :success_url
2244
- # Controls tax ID collection during checkout.
2245
- sig { returns(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection) }
2246
- attr_accessor :tax_id_collection
2247
- # The UI mode of the Session. Defaults to `hosted`.
2248
- sig { returns(String) }
2249
- attr_accessor :ui_mode
2250
- sig {
2251
- 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
2252
- }
2253
- def initialize(
2254
- adaptive_pricing: nil,
2255
- after_expiration: nil,
2256
- allow_promotion_codes: nil,
2257
- automatic_tax: nil,
2258
- billing_address_collection: nil,
2259
- cancel_url: nil,
2260
- client_reference_id: nil,
2261
- consent_collection: nil,
2262
- currency: nil,
2263
- custom_fields: nil,
2264
- custom_text: nil,
2265
- customer: nil,
2266
- customer_creation: nil,
2267
- customer_email: nil,
2268
- customer_update: nil,
2269
- discounts: nil,
2270
- expand: nil,
2271
- expires_at: nil,
2272
- invoice_creation: nil,
2273
- line_items: nil,
2274
- locale: nil,
2275
- metadata: nil,
2276
- mode: nil,
2277
- payment_intent_data: nil,
2278
- payment_method_collection: nil,
2279
- payment_method_configuration: nil,
2280
- payment_method_data: nil,
2281
- payment_method_options: nil,
2282
- payment_method_types: nil,
2283
- permissions: nil,
2284
- phone_number_collection: nil,
2285
- redirect_on_completion: nil,
2286
- return_url: nil,
2287
- saved_payment_method_options: nil,
2288
- setup_intent_data: nil,
2289
- shipping_address_collection: nil,
2290
- shipping_options: nil,
2291
- submit_type: nil,
2292
- subscription_data: nil,
2293
- success_url: nil,
2294
- tax_id_collection: nil,
2295
- ui_mode: nil
2296
- ); end
2297
- end
2298
- class RetrieveParams < Stripe::RequestParams
2299
- # Specifies which fields in the response should be expanded.
2300
- sig { returns(T::Array[String]) }
2301
- attr_accessor :expand
2302
- sig { params(expand: T::Array[String]).void }
2303
- def initialize(expand: nil); end
2304
- end
2305
- class UpdateParams < Stripe::RequestParams
2306
- class CollectedInformation < Stripe::RequestParams
2307
- class ShippingDetails < Stripe::RequestParams
2308
- class Address < Stripe::RequestParams
2309
- # City, district, suburb, town, or village.
2310
- sig { returns(String) }
2311
- attr_accessor :city
2312
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2313
- sig { returns(String) }
2314
- attr_accessor :country
2315
- # Address line 1 (e.g., street, PO Box, or company name).
2316
- sig { returns(String) }
2317
- attr_accessor :line1
2318
- # Address line 2 (e.g., apartment, suite, unit, or building).
2319
- sig { returns(String) }
2320
- attr_accessor :line2
2321
- # ZIP or postal code.
2322
- sig { returns(String) }
2323
- attr_accessor :postal_code
2324
- # State, county, province, or region.
2325
- sig { returns(String) }
2326
- attr_accessor :state
2327
- sig {
2328
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2329
- }
2330
- def initialize(
2331
- city: nil,
2332
- country: nil,
2333
- line1: nil,
2334
- line2: nil,
2335
- postal_code: nil,
2336
- state: nil
2337
- ); end
2338
- end
2339
- # The address of the customer
2340
- sig {
2341
- returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address)
2342
- }
2343
- attr_accessor :address
2344
- # The name of customer
2345
- sig { returns(String) }
2346
- attr_accessor :name
2347
- sig {
2348
- params(address: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address, name: String).void
2349
- }
2350
- def initialize(address: nil, name: nil); end
2351
- end
2352
- # The shipping details to apply to this Session.
2353
- sig {
2354
- returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails)
2355
- }
2356
- attr_accessor :shipping_details
2357
- sig {
2358
- params(shipping_details: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails).void
2359
- }
2360
- def initialize(shipping_details: nil); end
2361
- end
2362
- class LineItem < Stripe::RequestParams
2363
- class AdjustableQuantity < Stripe::RequestParams
2364
- # Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
2365
- sig { returns(T::Boolean) }
2366
- attr_accessor :enabled
2367
- # 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.
2368
- sig { returns(Integer) }
2369
- attr_accessor :maximum
2370
- # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
2371
- sig { returns(Integer) }
2372
- attr_accessor :minimum
2373
- sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
2374
- def initialize(enabled: nil, maximum: nil, minimum: nil); end
2375
- end
2376
- # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
2377
- sig {
2378
- returns(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity)
2379
- }
2380
- attr_accessor :adjustable_quantity
2381
- # ID of an existing line item.
2382
- sig { returns(String) }
2383
- attr_accessor :id
2384
- # 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`.
2385
- sig { returns(T.nilable(T::Hash[String, String])) }
2386
- attr_accessor :metadata
2387
- # The ID of the [Price](https://stripe.com/docs/api/prices).
2388
- sig { returns(String) }
2389
- attr_accessor :price
2390
- # The quantity of the line item being purchased.
2391
- sig { returns(Integer) }
2392
- attr_accessor :quantity
2393
- # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
2394
- sig { returns(T.nilable(T::Array[String])) }
2395
- attr_accessor :tax_rates
2396
- sig {
2397
- 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
2398
- }
2399
- def initialize(
2400
- adjustable_quantity: nil,
2401
- id: nil,
2402
- metadata: nil,
2403
- price: nil,
2404
- quantity: nil,
2405
- tax_rates: nil
2406
- ); end
2407
- end
2408
- class ShippingOption < Stripe::RequestParams
2409
- class ShippingRateData < Stripe::RequestParams
2410
- class DeliveryEstimate < Stripe::RequestParams
2411
- class Maximum < Stripe::RequestParams
2412
- # A unit of time.
2413
- sig { returns(String) }
2414
- attr_accessor :unit
2415
- # Must be greater than 0.
2416
- sig { returns(Integer) }
2417
- attr_accessor :value
2418
- sig { params(unit: String, value: Integer).void }
2419
- def initialize(unit: nil, value: nil); end
2420
- end
2421
- class Minimum < Stripe::RequestParams
2422
- # A unit of time.
2423
- sig { returns(String) }
2424
- attr_accessor :unit
2425
- # Must be greater than 0.
2426
- sig { returns(Integer) }
2427
- attr_accessor :value
2428
- sig { params(unit: String, value: Integer).void }
2429
- def initialize(unit: nil, value: nil); end
2430
- end
2431
- # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
2432
- sig {
2433
- returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
2434
- }
2435
- attr_accessor :maximum
2436
- # The lower bound of the estimated range. If empty, represents no lower bound.
2437
- sig {
2438
- returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
2439
- }
2440
- attr_accessor :minimum
2441
- sig {
2442
- params(maximum: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
2443
- }
2444
- def initialize(maximum: nil, minimum: nil); end
2445
- end
2446
- class FixedAmount < Stripe::RequestParams
2447
- class CurrencyOptions < Stripe::RequestParams
2448
- # A non-negative integer in cents representing how much to charge.
2449
- sig { returns(Integer) }
2450
- attr_accessor :amount
2451
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
2452
- sig { returns(String) }
2453
- attr_accessor :tax_behavior
2454
- sig { params(amount: Integer, tax_behavior: String).void }
2455
- def initialize(amount: nil, tax_behavior: nil); end
2456
- end
2457
- # A non-negative integer in cents representing how much to charge.
2458
- sig { returns(Integer) }
2459
- attr_accessor :amount
2460
- # 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).
2461
- sig { returns(String) }
2462
- attr_accessor :currency
2463
- # 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).
2464
- sig {
2465
- returns(T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
2466
- }
2467
- attr_accessor :currency_options
2468
- sig {
2469
- params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
2470
- }
2471
- def initialize(amount: nil, currency: nil, currency_options: nil); end
2472
- end
2473
- # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
2474
- sig {
2475
- returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
2476
- }
2477
- attr_accessor :delivery_estimate
2478
- # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
2479
- sig { returns(String) }
2480
- attr_accessor :display_name
2481
- # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
2482
- sig {
2483
- returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount)
2484
- }
2485
- attr_accessor :fixed_amount
2486
- # 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`.
2487
- sig { returns(T::Hash[String, String]) }
2488
- attr_accessor :metadata
2489
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
2490
- sig { returns(String) }
2491
- attr_accessor :tax_behavior
2492
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
2493
- sig { returns(String) }
2494
- attr_accessor :tax_code
2495
- # The type of calculation to use on the shipping rate.
2496
- sig { returns(String) }
2497
- attr_accessor :type
2498
- sig {
2499
- 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
2500
- }
2501
- def initialize(
2502
- delivery_estimate: nil,
2503
- display_name: nil,
2504
- fixed_amount: nil,
2505
- metadata: nil,
2506
- tax_behavior: nil,
2507
- tax_code: nil,
2508
- type: nil
2509
- ); end
2510
- end
2511
- # The ID of the Shipping Rate to use for this shipping option.
2512
- sig { returns(String) }
2513
- attr_accessor :shipping_rate
2514
- # Parameters to be passed to Shipping Rate creation for this shipping option.
2515
- sig {
2516
- returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData)
2517
- }
2518
- attr_accessor :shipping_rate_data
2519
- sig {
2520
- params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData).void
2521
- }
2522
- def initialize(shipping_rate: nil, shipping_rate_data: nil); end
2523
- end
2524
- # Information about the customer collected within the Checkout Session.
2525
- sig { returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation) }
2526
- attr_accessor :collected_information
2527
- # Specifies which fields in the response should be expanded.
2528
- sig { returns(T::Array[String]) }
2529
- attr_accessor :expand
2530
- # A list of items the customer is purchasing.
2531
- #
2532
- # When updating line items, you must retransmit the entire array of line items.
2533
- #
2534
- # To retain an existing line item, specify its `id`.
2535
- #
2536
- # To update an existing line item, specify its `id` along with the new values of the fields to update.
2537
- #
2538
- # To add a new line item, specify a `price` and `quantity`. We don't currently support recurring prices.
2539
- #
2540
- # To remove an existing line item, omit the line item's ID from the retransmitted array.
2541
- #
2542
- # To reorder a line item, specify it at the desired position in the retransmitted array.
2543
- sig { returns(T::Array[::Stripe::Checkout::SessionService::UpdateParams::LineItem]) }
2544
- attr_accessor :line_items
2545
- # 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`.
2546
- sig { returns(T.nilable(T::Hash[String, String])) }
2547
- attr_accessor :metadata
2548
- # The shipping rate options to apply to this Session. Up to a maximum of 5.
2549
- sig {
2550
- returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::UpdateParams::ShippingOption]))
2551
- }
2552
- attr_accessor :shipping_options
2553
- sig {
2554
- 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
2555
- }
2556
- def initialize(
2557
- collected_information: nil,
2558
- expand: nil,
2559
- line_items: nil,
2560
- metadata: nil,
2561
- shipping_options: nil
2562
- ); end
2563
- end
2564
- class ExpireParams < Stripe::RequestParams
2565
- # Specifies which fields in the response should be expanded.
2566
- sig { returns(T::Array[String]) }
2567
- attr_accessor :expand
2568
- sig { params(expand: T::Array[String]).void }
2569
- def initialize(expand: nil); end
2570
- end
2571
- # Creates a Session object.
2572
- sig {
2573
- params(params: T.any(::Stripe::Checkout::SessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2574
- }
2575
- def create(params = {}, opts = {}); end
2576
-
2577
- # A Session can be expired when it is in one of these statuses: open
2578
- #
2579
- # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
2580
- sig {
2581
- params(session: String, params: T.any(::Stripe::Checkout::SessionService::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2582
- }
2583
- def expire(session, params = {}, opts = {}); end
2584
-
2585
- # Returns a list of Checkout Sessions.
2586
- sig {
2587
- params(params: T.any(::Stripe::Checkout::SessionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
2588
- }
2589
- def list(params = {}, opts = {}); end
2590
-
2591
- # Retrieves a Session object.
2592
- sig {
2593
- params(session: String, params: T.any(::Stripe::Checkout::SessionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2594
- }
2595
- def retrieve(session, params = {}, opts = {}); end
2596
-
2597
- # Updates a Session object.
2598
- sig {
2599
- params(session: String, params: T.any(::Stripe::Checkout::SessionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2600
- }
2601
- def update(session, params = {}, opts = {}); end
2602
- end
2603
- end
2604
- end