stripe 13.4.0.pre.beta.4 → 13.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (744) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +653 -1422
  3. data/CONTRIBUTING.md +25 -0
  4. data/OPENAPI_VERSION +1 -1
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_operations/request.rb +0 -1
  7. data/lib/stripe/api_requestor.rb +0 -1
  8. data/lib/stripe/object_types.rb +0 -32
  9. data/lib/stripe/resources/account.rb +0 -5163
  10. data/lib/stripe/resources/account_link.rb +0 -54
  11. data/lib/stripe/resources/account_session.rb +0 -967
  12. data/lib/stripe/resources/apple_pay_domain.rb +0 -63
  13. data/lib/stripe/resources/application_fee.rb +0 -96
  14. data/lib/stripe/resources/application_fee_refund.rb +0 -17
  15. data/lib/stripe/resources/apps/secret.rb +0 -141
  16. data/lib/stripe/resources/balance.rb +0 -131
  17. data/lib/stripe/resources/balance_transaction.rb +0 -112
  18. data/lib/stripe/resources/bank_account.rb +2 -84
  19. data/lib/stripe/resources/billing/alert.rb +0 -144
  20. data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -77
  21. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -116
  22. data/lib/stripe/resources/billing/credit_grant.rb +0 -203
  23. data/lib/stripe/resources/billing/meter.rb +0 -178
  24. data/lib/stripe/resources/billing/meter_event.rb +0 -35
  25. data/lib/stripe/resources/billing/meter_event_adjustment.rb +0 -43
  26. data/lib/stripe/resources/billing/meter_event_summary.rb +0 -15
  27. data/lib/stripe/resources/billing_portal/configuration.rb +0 -562
  28. data/lib/stripe/resources/billing_portal/session.rb +0 -271
  29. data/lib/stripe/resources/capability.rb +0 -84
  30. data/lib/stripe/resources/card.rb +0 -79
  31. data/lib/stripe/resources/cash_balance.rb +0 -17
  32. data/lib/stripe/resources/charge.rb +0 -3030
  33. data/lib/stripe/resources/checkout/session.rb +0 -3670
  34. data/lib/stripe/resources/climate/order.rb +0 -176
  35. data/lib/stripe/resources/climate/product.rb +0 -56
  36. data/lib/stripe/resources/climate/supplier.rb +0 -54
  37. data/lib/stripe/resources/confirmation_token.rb +0 -1530
  38. data/lib/stripe/resources/country_spec.rb +0 -63
  39. data/lib/stripe/resources/coupon.rb +0 -198
  40. data/lib/stripe/resources/credit_note.rb +0 -660
  41. data/lib/stripe/resources/credit_note_line_item.rb +0 -65
  42. data/lib/stripe/resources/customer.rb +0 -840
  43. data/lib/stripe/resources/customer_balance_transaction.rb +0 -27
  44. data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -109
  45. data/lib/stripe/resources/customer_session.rb +0 -159
  46. data/lib/stripe/resources/discount.rb +0 -29
  47. data/lib/stripe/resources/dispute.rb +0 -619
  48. data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -46
  49. data/lib/stripe/resources/entitlements/feature.rb +0 -90
  50. data/lib/stripe/resources/ephemeral_key.rb +0 -21
  51. data/lib/stripe/resources/event.rb +0 -130
  52. data/lib/stripe/resources/exchange_rate.rb +0 -33
  53. data/lib/stripe/resources/file.rb +0 -111
  54. data/lib/stripe/resources/file_link.rb +0 -112
  55. data/lib/stripe/resources/financial_connections/account.rb +0 -260
  56. data/lib/stripe/resources/financial_connections/account_owner.rb +0 -17
  57. data/lib/stripe/resources/financial_connections/account_ownership.rb +0 -9
  58. data/lib/stripe/resources/financial_connections/session.rb +0 -159
  59. data/lib/stripe/resources/financial_connections/transaction.rb +0 -101
  60. data/lib/stripe/resources/forwarding/request.rb +0 -165
  61. data/lib/stripe/resources/funding_instructions.rb +0 -308
  62. data/lib/stripe/resources/identity/verification_report.rb +0 -266
  63. data/lib/stripe/resources/identity/verification_session.rb +0 -361
  64. data/lib/stripe/resources/invoice.rb +0 -8078
  65. data/lib/stripe/resources/invoice_item.rb +0 -445
  66. data/lib/stripe/resources/invoice_line_item.rb +0 -333
  67. data/lib/stripe/resources/invoice_rendering_template.rb +0 -67
  68. data/lib/stripe/resources/issuing/authorization.rb +0 -1113
  69. data/lib/stripe/resources/issuing/card.rb +0 -666
  70. data/lib/stripe/resources/issuing/cardholder.rb +0 -658
  71. data/lib/stripe/resources/issuing/dispute.rb +0 -790
  72. data/lib/stripe/resources/issuing/personalization_design.rb +0 -285
  73. data/lib/stripe/resources/issuing/physical_bundle.rb +0 -63
  74. data/lib/stripe/resources/issuing/token.rb +0 -175
  75. data/lib/stripe/resources/issuing/transaction.rb +0 -927
  76. data/lib/stripe/resources/line_item.rb +0 -75
  77. data/lib/stripe/resources/login_link.rb +0 -7
  78. data/lib/stripe/resources/mandate.rb +0 -169
  79. data/lib/stripe/resources/payment_intent.rb +0 -12910
  80. data/lib/stripe/resources/payment_link.rb +0 -1563
  81. data/lib/stripe/resources/payment_method.rb +0 -1655
  82. data/lib/stripe/resources/payment_method_configuration.rb +0 -2903
  83. data/lib/stripe/resources/payment_method_domain.rb +0 -153
  84. data/lib/stripe/resources/payout.rb +0 -218
  85. data/lib/stripe/resources/person.rb +0 -263
  86. data/lib/stripe/resources/plan.rb +0 -317
  87. data/lib/stripe/resources/price.rb +0 -649
  88. data/lib/stripe/resources/product.rb +0 -536
  89. data/lib/stripe/resources/product_feature.rb +0 -12
  90. data/lib/stripe/resources/promotion_code.rb +0 -221
  91. data/lib/stripe/resources/quote.rb +0 -2946
  92. data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -77
  93. data/lib/stripe/resources/radar/value_list.rb +0 -125
  94. data/lib/stripe/resources/radar/value_list_item.rb +0 -95
  95. data/lib/stripe/resources/refund.rb +0 -397
  96. data/lib/stripe/resources/reporting/report_run.rb +0 -150
  97. data/lib/stripe/resources/reporting/report_type.rb +0 -36
  98. data/lib/stripe/resources/reversal.rb +0 -21
  99. data/lib/stripe/resources/review.rb +0 -108
  100. data/lib/stripe/resources/setup_attempt.rb +0 -373
  101. data/lib/stripe/resources/setup_intent.rb +0 -3855
  102. data/lib/stripe/resources/shipping_rate.rb +0 -259
  103. data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -54
  104. data/lib/stripe/resources/source.rb +0 -1239
  105. data/lib/stripe/resources/source_transaction.rb +0 -85
  106. data/lib/stripe/resources/subscription.rb +0 -2057
  107. data/lib/stripe/resources/subscription_item.rb +0 -433
  108. data/lib/stripe/resources/subscription_schedule.rb +0 -2402
  109. data/lib/stripe/resources/tax/calculation.rb +0 -387
  110. data/lib/stripe/resources/tax/calculation_line_item.rb +0 -56
  111. data/lib/stripe/resources/tax/registration.rb +0 -2382
  112. data/lib/stripe/resources/tax/settings.rb +0 -126
  113. data/lib/stripe/resources/tax/transaction.rb +0 -267
  114. data/lib/stripe/resources/tax/transaction_line_item.rb +0 -31
  115. data/lib/stripe/resources/tax_code.rb +0 -35
  116. data/lib/stripe/resources/tax_id.rb +0 -121
  117. data/lib/stripe/resources/tax_rate.rb +0 -200
  118. data/lib/stripe/resources/terminal/configuration.rb +0 -1060
  119. data/lib/stripe/resources/terminal/connection_token.rb +0 -18
  120. data/lib/stripe/resources/terminal/location.rb +0 -175
  121. data/lib/stripe/resources/terminal/reader.rb +0 -774
  122. data/lib/stripe/resources/test_helpers/test_clock.rb +0 -86
  123. data/lib/stripe/resources/token.rb +0 -1168
  124. data/lib/stripe/resources/topup.rb +0 -174
  125. data/lib/stripe/resources/transfer.rb +0 -153
  126. data/lib/stripe/resources/treasury/credit_reversal.rb +0 -92
  127. data/lib/stripe/resources/treasury/debit_reversal.rb +0 -103
  128. data/lib/stripe/resources/treasury/financial_account.rb +0 -752
  129. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -191
  130. data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -235
  131. data/lib/stripe/resources/treasury/outbound_payment.rb +0 -495
  132. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -387
  133. data/lib/stripe/resources/treasury/received_credit.rb +0 -283
  134. data/lib/stripe/resources/treasury/received_debit.rb +0 -244
  135. data/lib/stripe/resources/treasury/transaction.rb +0 -176
  136. data/lib/stripe/resources/treasury/transaction_entry.rb +0 -157
  137. data/lib/stripe/resources/usage_record.rb +0 -13
  138. data/lib/stripe/resources/usage_record_summary.rb +0 -21
  139. data/lib/stripe/resources/v2/billing/meter_event.rb +0 -18
  140. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +0 -21
  141. data/lib/stripe/resources/v2/billing/meter_event_session.rb +0 -14
  142. data/lib/stripe/resources/v2/event.rb +0 -27
  143. data/lib/stripe/resources/v2/event_destination.rb +0 -59
  144. data/lib/stripe/resources/webhook_endpoint.rb +0 -122
  145. data/lib/stripe/resources.rb +0 -31
  146. data/lib/stripe/services/account_capability_service.rb +0 -32
  147. data/lib/stripe/services/account_external_account_service.rb +0 -250
  148. data/lib/stripe/services/account_link_service.rb +0 -46
  149. data/lib/stripe/services/account_login_link_service.rb +0 -9
  150. data/lib/stripe/services/account_person_service.rb +0 -875
  151. data/lib/stripe/services/account_service.rb +0 -4441
  152. data/lib/stripe/services/account_session_service.rb +0 -682
  153. data/lib/stripe/services/apple_pay_domain_service.rb +0 -51
  154. data/lib/stripe/services/application_fee_refund_service.rb +0 -54
  155. data/lib/stripe/services/application_fee_service.rb +0 -57
  156. data/lib/stripe/services/apps/secret_service.rb +0 -116
  157. data/lib/stripe/services/balance_service.rb +0 -9
  158. data/lib/stripe/services/balance_transaction_service.rb +0 -69
  159. data/lib/stripe/services/billing/alert_service.rb +0 -113
  160. data/lib/stripe/services/billing/credit_balance_summary_service.rb +0 -37
  161. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -40
  162. data/lib/stripe/services/billing/credit_grant_service.rb +0 -151
  163. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +0 -26
  164. data/lib/stripe/services/billing/meter_event_service.rb +0 -21
  165. data/lib/stripe/services/billing/meter_event_summary_service.rb +0 -39
  166. data/lib/stripe/services/billing/meter_service.rb +0 -130
  167. data/lib/stripe/services/billing_portal/configuration_service.rb +0 -444
  168. data/lib/stripe/services/billing_portal/session_service.rb +0 -173
  169. data/lib/stripe/services/charge_service.rb +0 -1736
  170. data/lib/stripe/services/checkout/session_line_item_service.rb +0 -18
  171. data/lib/stripe/services/checkout/session_service.rb +0 -2472
  172. data/lib/stripe/services/climate/order_service.rb +0 -102
  173. data/lib/stripe/services/climate/product_service.rb +0 -27
  174. data/lib/stripe/services/climate/supplier_service.rb +0 -27
  175. data/lib/stripe/services/confirmation_token_service.rb +0 -9
  176. data/lib/stripe/services/country_spec_service.rb +0 -27
  177. data/lib/stripe/services/coupon_service.rb +0 -152
  178. data/lib/stripe/services/credit_note_line_item_service.rb +0 -18
  179. data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -156
  180. data/lib/stripe/services/credit_note_service.rb +0 -373
  181. data/lib/stripe/services/customer_balance_transaction_service.rb +0 -63
  182. data/lib/stripe/services/customer_cash_balance_service.rb +0 -29
  183. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +0 -27
  184. data/lib/stripe/services/customer_funding_instructions_service.rb +0 -42
  185. data/lib/stripe/services/customer_payment_method_service.rb +0 -40
  186. data/lib/stripe/services/customer_payment_source_service.rb +0 -179
  187. data/lib/stripe/services/customer_service.rb +0 -593
  188. data/lib/stripe/services/customer_session_service.rb +0 -96
  189. data/lib/stripe/services/customer_tax_id_service.rb +0 -45
  190. data/lib/stripe/services/dispute_service.rb +0 -374
  191. data/lib/stripe/services/entitlements/active_entitlement_service.rb +0 -36
  192. data/lib/stripe/services/entitlements/feature_service.rb +0 -76
  193. data/lib/stripe/services/ephemeral_key_service.rb +0 -36
  194. data/lib/stripe/services/event_service.rb +0 -65
  195. data/lib/stripe/services/exchange_rate_service.rb +0 -27
  196. data/lib/stripe/services/file_link_service.rb +0 -94
  197. data/lib/stripe/services/file_service.rb +0 -89
  198. data/lib/stripe/services/financial_connections/account_owner_service.rb +0 -27
  199. data/lib/stripe/services/financial_connections/account_service.rb +1 -99
  200. data/lib/stripe/services/financial_connections/session_service.rb +0 -97
  201. data/lib/stripe/services/financial_connections/transaction_service.rb +0 -70
  202. data/lib/stripe/services/financial_connections_service.rb +1 -2
  203. data/lib/stripe/services/forwarding/request_service.rb +0 -106
  204. data/lib/stripe/services/identity/verification_report_service.rb +0 -65
  205. data/lib/stripe/services/identity/verification_session_service.rb +0 -231
  206. data/lib/stripe/services/invoice_item_service.rb +0 -388
  207. data/lib/stripe/services/invoice_line_item_service.rb +0 -237
  208. data/lib/stripe/services/invoice_rendering_template_service.rb +0 -51
  209. data/lib/stripe/services/invoice_service.rb +1 -5567
  210. data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -1864
  211. data/lib/stripe/services/issuing/authorization_service.rb +0 -104
  212. data/lib/stripe/services/issuing/card_service.rb +0 -455
  213. data/lib/stripe/services/issuing/cardholder_service.rb +0 -526
  214. data/lib/stripe/services/issuing/dispute_service.rb +0 -633
  215. data/lib/stripe/services/issuing/personalization_design_service.rb +0 -193
  216. data/lib/stripe/services/issuing/physical_bundle_service.rb +0 -40
  217. data/lib/stripe/services/issuing/token_service.rb +0 -73
  218. data/lib/stripe/services/issuing/transaction_service.rb +0 -81
  219. data/lib/stripe/services/issuing_service.rb +1 -5
  220. data/lib/stripe/services/mandate_service.rb +0 -9
  221. data/lib/stripe/services/payment_intent_service.rb +0 -10936
  222. data/lib/stripe/services/payment_link_line_item_service.rb +0 -18
  223. data/lib/stripe/services/payment_link_service.rb +0 -1223
  224. data/lib/stripe/services/payment_method_configuration_service.rb +0 -2088
  225. data/lib/stripe/services/payment_method_domain_service.rb +0 -76
  226. data/lib/stripe/services/payment_method_service.rb +0 -878
  227. data/lib/stripe/services/payout_service.rb +0 -159
  228. data/lib/stripe/services/plan_service.rb +0 -253
  229. data/lib/stripe/services/price_service.rb +0 -516
  230. data/lib/stripe/services/product_feature_service.rb +0 -42
  231. data/lib/stripe/services/product_service.rb +0 -459
  232. data/lib/stripe/services/promotion_code_service.rb +0 -178
  233. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +0 -18
  234. data/lib/stripe/services/quote_line_item_service.rb +0 -18
  235. data/lib/stripe/services/quote_service.rb +1 -2319
  236. data/lib/stripe/services/radar/early_fraud_warning_service.rb +0 -61
  237. data/lib/stripe/services/radar/value_list_item_service.rb +0 -79
  238. data/lib/stripe/services/radar/value_list_service.rb +0 -103
  239. data/lib/stripe/services/refund_service.rb +0 -137
  240. data/lib/stripe/services/reporting/report_run_service.rb +0 -106
  241. data/lib/stripe/services/reporting/report_type_service.rb +0 -18
  242. data/lib/stripe/services/review_service.rb +0 -56
  243. data/lib/stripe/services/setup_attempt_service.rb +0 -51
  244. data/lib/stripe/services/setup_intent_service.rb +0 -3497
  245. data/lib/stripe/services/shipping_rate_service.rb +0 -200
  246. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +0 -27
  247. data/lib/stripe/services/source_service.rb +0 -601
  248. data/lib/stripe/services/source_transaction_service.rb +0 -18
  249. data/lib/stripe/services/subscription_item_service.rb +0 -383
  250. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -18
  251. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -18
  252. data/lib/stripe/services/subscription_schedule_service.rb +0 -2053
  253. data/lib/stripe/services/subscription_service.rb +0 -1722
  254. data/lib/stripe/services/tax/calculation_line_item_service.rb +0 -18
  255. data/lib/stripe/services/tax/calculation_service.rb +0 -205
  256. data/lib/stripe/services/tax/registration_service.rb +0 -1564
  257. data/lib/stripe/services/tax/settings_service.rb +0 -74
  258. data/lib/stripe/services/tax/transaction_line_item_service.rb +0 -18
  259. data/lib/stripe/services/tax/transaction_service.rb +0 -111
  260. data/lib/stripe/services/tax_code_service.rb +0 -27
  261. data/lib/stripe/services/tax_id_service.rb +0 -79
  262. data/lib/stripe/services/tax_rate_service.rb +0 -155
  263. data/lib/stripe/services/tax_service.rb +1 -3
  264. data/lib/stripe/services/terminal/configuration_service.rb +0 -831
  265. data/lib/stripe/services/terminal/connection_token_service.rb +0 -12
  266. data/lib/stripe/services/terminal/location_service.rb +0 -144
  267. data/lib/stripe/services/terminal/reader_service.rb +0 -443
  268. data/lib/stripe/services/terminal_service.rb +1 -2
  269. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -680
  270. data/lib/stripe/services/test_helpers/customer_service.rb +0 -18
  271. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +0 -745
  272. data/lib/stripe/services/test_helpers/issuing/card_service.rb +0 -45
  273. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +0 -41
  274. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +0 -632
  275. data/lib/stripe/services/test_helpers/refund_service.rb +0 -9
  276. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -44
  277. data/lib/stripe/services/test_helpers/test_clock_service.rb +0 -57
  278. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +0 -38
  279. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +0 -87
  280. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +0 -87
  281. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +0 -84
  282. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +0 -84
  283. data/lib/stripe/services/token_service.rb +0 -1140
  284. data/lib/stripe/services/topup_service.rb +0 -142
  285. data/lib/stripe/services/transfer_reversal_service.rb +0 -66
  286. data/lib/stripe/services/transfer_service.rb +0 -119
  287. data/lib/stripe/services/treasury/credit_reversal_service.rb +0 -59
  288. data/lib/stripe/services/treasury/debit_reversal_service.rb +0 -63
  289. data/lib/stripe/services/treasury/financial_account_features_service.rb +0 -169
  290. data/lib/stripe/services/treasury/financial_account_service.rb +0 -498
  291. data/lib/stripe/services/treasury/inbound_transfer_service.rb +0 -88
  292. data/lib/stripe/services/treasury/outbound_payment_service.rb +0 -258
  293. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -148
  294. data/lib/stripe/services/treasury/received_credit_service.rb +0 -52
  295. data/lib/stripe/services/treasury/received_debit_service.rb +0 -40
  296. data/lib/stripe/services/treasury/transaction_entry_service.rb +0 -87
  297. data/lib/stripe/services/treasury/transaction_service.rb +0 -95
  298. data/lib/stripe/services/v1_services.rb +1 -8
  299. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +0 -23
  300. data/lib/stripe/services/v2/billing/meter_event_service.rb +0 -25
  301. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +0 -3
  302. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +0 -33
  303. data/lib/stripe/services/v2/core/event_destination_service.rb +0 -146
  304. data/lib/stripe/services/v2/core/event_service.rb +0 -18
  305. data/lib/stripe/services/webhook_endpoint_service.rb +0 -96
  306. data/lib/stripe/services.rb +0 -25
  307. data/lib/stripe/stripe_client.rb +1 -1
  308. data/lib/stripe/stripe_configuration.rb +1 -3
  309. data/lib/stripe/stripe_object.rb +0 -5
  310. data/lib/stripe/util.rb +1 -7
  311. data/lib/stripe/version.rb +1 -1
  312. data/lib/stripe.rb +0 -46
  313. metadata +5 -435
  314. data/lib/stripe/request_params.rb +0 -24
  315. data/lib/stripe/request_signing_authenticator.rb +0 -79
  316. data/lib/stripe/resources/account_notice.rb +0 -132
  317. data/lib/stripe/resources/application.rb +0 -20
  318. data/lib/stripe/resources/billing/alert_triggered.rb +0 -26
  319. data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
  320. data/lib/stripe/resources/capital/financing_offer.rb +0 -188
  321. data/lib/stripe/resources/capital/financing_summary.rb +0 -64
  322. data/lib/stripe/resources/capital/financing_transaction.rb +0 -123
  323. data/lib/stripe/resources/connect_collection_transfer.rb +0 -24
  324. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +0 -23
  325. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  326. data/lib/stripe/resources/financial_connections/institution.rb +0 -99
  327. data/lib/stripe/resources/gift_cards/card.rb +0 -217
  328. data/lib/stripe/resources/gift_cards/transaction.rb +0 -281
  329. data/lib/stripe/resources/invoice_payment.rb +0 -56
  330. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -611
  331. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -84
  332. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -95
  333. data/lib/stripe/resources/issuing/settlement.rb +0 -49
  334. data/lib/stripe/resources/margin.rb +0 -124
  335. data/lib/stripe/resources/order.rb +0 -2850
  336. data/lib/stripe/resources/payment_attempt_record.rb +0 -184
  337. data/lib/stripe/resources/payment_record.rb +0 -715
  338. data/lib/stripe/resources/quote_line.rb +0 -274
  339. data/lib/stripe/resources/quote_preview_invoice.rb +0 -652
  340. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -362
  341. data/lib/stripe/resources/reserve_transaction.rb +0 -22
  342. data/lib/stripe/resources/source_mandate_notification.rb +0 -66
  343. data/lib/stripe/resources/tax/association.rb +0 -89
  344. data/lib/stripe/resources/tax/form.rb +0 -220
  345. data/lib/stripe/resources/tax_deducted_at_source.rb +0 -22
  346. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -40
  347. data/lib/stripe/resources/v2/amount.rb +0 -9
  348. data/lib/stripe/services/account_notice_service.rb +0 -101
  349. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  350. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  351. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  352. data/lib/stripe/services/capital_service.rb +0 -15
  353. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -37
  354. data/lib/stripe/services/financial_connections/institution_service.rb +0 -57
  355. data/lib/stripe/services/gift_cards/card_service.rb +0 -170
  356. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
  357. data/lib/stripe/services/gift_cards_service.rb +0 -14
  358. data/lib/stripe/services/invoice_payment_service.rb +0 -55
  359. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  360. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  361. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  362. data/lib/stripe/services/margin_service.rb +0 -119
  363. data/lib/stripe/services/order_line_item_service.rb +0 -35
  364. data/lib/stripe/services/order_service.rb +0 -2254
  365. data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
  366. data/lib/stripe/services/payment_record_service.rb +0 -542
  367. data/lib/stripe/services/quote_line_service.rb +0 -35
  368. data/lib/stripe/services/quote_preview_invoice_service.rb +0 -35
  369. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
  370. data/lib/stripe/services/tax/association_service.rb +0 -31
  371. data/lib/stripe/services/tax/form_service.rb +0 -100
  372. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  373. data/rbi/stripe/resources/account.rbi +0 -5185
  374. data/rbi/stripe/resources/account_link.rbi +0 -74
  375. data/rbi/stripe/resources/account_notice.rbi +0 -139
  376. data/rbi/stripe/resources/account_session.rbi +0 -1122
  377. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -97
  378. data/rbi/stripe/resources/application.rbi +0 -20
  379. data/rbi/stripe/resources/application_fee.rbi +0 -123
  380. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  381. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  382. data/rbi/stripe/resources/balance.rbi +0 -187
  383. data/rbi/stripe/resources/balance_transaction.rbi +0 -149
  384. data/rbi/stripe/resources/bank_account.rbi +0 -127
  385. data/rbi/stripe/resources/billing/alert.rbi +0 -206
  386. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  387. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -102
  388. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -154
  389. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -269
  390. data/rbi/stripe/resources/billing/meter.rbi +0 -233
  391. data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -71
  392. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  393. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  394. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -33
  395. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -640
  396. data/rbi/stripe/resources/billing_portal/session.rbi +0 -341
  397. data/rbi/stripe/resources/capability.rbi +0 -125
  398. data/rbi/stripe/resources/capital/financing_offer.rbi +0 -190
  399. data/rbi/stripe/resources/capital/financing_summary.rbi +0 -74
  400. data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -130
  401. data/rbi/stripe/resources/card.rbi +0 -128
  402. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  403. data/rbi/stripe/resources/charge.rbi +0 -3488
  404. data/rbi/stripe/resources/checkout/session.rbi +0 -4015
  405. data/rbi/stripe/resources/climate/order.rbi +0 -250
  406. data/rbi/stripe/resources/climate/product.rbi +0 -82
  407. data/rbi/stripe/resources/climate/supplier.rbi +0 -79
  408. data/rbi/stripe/resources/confirmation_token.rbi +0 -1787
  409. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  410. data/rbi/stripe/resources/country_spec.rbi +0 -92
  411. data/rbi/stripe/resources/coupon.rbi +0 -257
  412. data/rbi/stripe/resources/credit_note.rbi +0 -759
  413. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -99
  414. data/rbi/stripe/resources/customer.rbi +0 -1001
  415. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -53
  416. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  417. data/rbi/stripe/resources/customer_session.rbi +0 -196
  418. data/rbi/stripe/resources/discount.rbi +0 -53
  419. data/rbi/stripe/resources/dispute.rbi +0 -764
  420. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -65
  421. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  422. data/rbi/stripe/resources/entitlements/feature.rbi +0 -124
  423. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  424. data/rbi/stripe/resources/event.rbi +0 -190
  425. data/rbi/stripe/resources/exchange_rate.rbi +0 -73
  426. data/rbi/stripe/resources/file.rbi +0 -148
  427. data/rbi/stripe/resources/file_link.rbi +0 -146
  428. data/rbi/stripe/resources/financial_connections/account.rbi +0 -358
  429. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -27
  430. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  431. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  432. data/rbi/stripe/resources/financial_connections/institution.rbi +0 -99
  433. data/rbi/stripe/resources/financial_connections/session.rbi +0 -186
  434. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -127
  435. data/rbi/stripe/resources/forwarding/request.rbi +0 -219
  436. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  437. data/rbi/stripe/resources/gift_cards/card.rbi +0 -206
  438. data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -257
  439. data/rbi/stripe/resources/identity/verification_report.rbi +0 -354
  440. data/rbi/stripe/resources/identity/verification_session.rbi +0 -518
  441. data/rbi/stripe/resources/invoice.rbi +0 -8928
  442. data/rbi/stripe/resources/invoice_item.rbi +0 -514
  443. data/rbi/stripe/resources/invoice_line_item.rbi +0 -400
  444. data/rbi/stripe/resources/invoice_payment.rbi +0 -70
  445. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -114
  446. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1266
  447. data/rbi/stripe/resources/issuing/card.rbi +0 -738
  448. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -732
  449. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -622
  450. data/rbi/stripe/resources/issuing/dispute.rbi +0 -900
  451. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -83
  452. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -90
  453. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -333
  454. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -86
  455. data/rbi/stripe/resources/issuing/settlement.rbi +0 -62
  456. data/rbi/stripe/resources/issuing/token.rbi +0 -231
  457. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1057
  458. data/rbi/stripe/resources/line_item.rbi +0 -108
  459. data/rbi/stripe/resources/login_link.rbi +0 -18
  460. data/rbi/stripe/resources/mandate.rbi +0 -219
  461. data/rbi/stripe/resources/margin.rbi +0 -127
  462. data/rbi/stripe/resources/order.rbi +0 -3016
  463. data/rbi/stripe/resources/payment_attempt_record.rbi +0 -215
  464. data/rbi/stripe/resources/payment_intent.rbi +0 -13895
  465. data/rbi/stripe/resources/payment_link.rbi +0 -1666
  466. data/rbi/stripe/resources/payment_method.rbi +0 -1926
  467. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3237
  468. data/rbi/stripe/resources/payment_method_domain.rbi +0 -217
  469. data/rbi/stripe/resources/payment_record.rbi +0 -722
  470. data/rbi/stripe/resources/payout.rbi +0 -299
  471. data/rbi/stripe/resources/person.rbi +0 -371
  472. data/rbi/stripe/resources/plan.rbi +0 -385
  473. data/rbi/stripe/resources/price.rbi +0 -731
  474. data/rbi/stripe/resources/product.rbi +0 -615
  475. data/rbi/stripe/resources/product_feature.rbi +0 -26
  476. data/rbi/stripe/resources/promotion_code.rbi +0 -266
  477. data/rbi/stripe/resources/quote.rbi +0 -3186
  478. data/rbi/stripe/resources/quote_line.rbi +0 -350
  479. data/rbi/stripe/resources/quote_preview_invoice.rbi +0 -850
  480. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -474
  481. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -101
  482. data/rbi/stripe/resources/radar/value_list.rbi +0 -175
  483. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -134
  484. data/rbi/stripe/resources/refund.rbi +0 -515
  485. data/rbi/stripe/resources/reporting/report_run.rbi +0 -194
  486. data/rbi/stripe/resources/reporting/report_type.rbi +0 -64
  487. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  488. data/rbi/stripe/resources/reversal.rbi +0 -51
  489. data/rbi/stripe/resources/review.rbi +0 -159
  490. data/rbi/stripe/resources/setup_attempt.rbi +0 -484
  491. data/rbi/stripe/resources/setup_intent.rbi +0 -4062
  492. data/rbi/stripe/resources/shipping_rate.rbi +0 -310
  493. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -82
  494. data/rbi/stripe/resources/source.rbi +0 -1543
  495. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  496. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  497. data/rbi/stripe/resources/subscription.rbi +0 -2308
  498. data/rbi/stripe/resources/subscription_item.rbi +0 -478
  499. data/rbi/stripe/resources/subscription_schedule.rbi +0 -2653
  500. data/rbi/stripe/resources/tax/association.rbi +0 -94
  501. data/rbi/stripe/resources/tax/calculation.rbi +0 -479
  502. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -88
  503. data/rbi/stripe/resources/tax/form.rbi +0 -224
  504. data/rbi/stripe/resources/tax/registration.rbi +0 -2438
  505. data/rbi/stripe/resources/tax/settings.rbi +0 -148
  506. data/rbi/stripe/resources/tax/transaction.rbi +0 -356
  507. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  508. data/rbi/stripe/resources/tax_code.rbi +0 -51
  509. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  510. data/rbi/stripe/resources/tax_id.rbi +0 -174
  511. data/rbi/stripe/resources/tax_rate.rbi +0 -244
  512. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1143
  513. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  514. data/rbi/stripe/resources/terminal/location.rbi +0 -231
  515. data/rbi/stripe/resources/terminal/reader.rbi +0 -940
  516. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -41
  517. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -139
  518. data/rbi/stripe/resources/token.rbi +0 -1192
  519. data/rbi/stripe/resources/topup.rbi +0 -225
  520. data/rbi/stripe/resources/transfer.rbi +0 -204
  521. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -126
  522. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -138
  523. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -870
  524. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -263
  525. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -302
  526. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -589
  527. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -473
  528. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -348
  529. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -305
  530. data/rbi/stripe/resources/treasury/transaction.rbi +0 -216
  531. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -193
  532. data/rbi/stripe/resources/usage_record.rbi +0 -32
  533. data/rbi/stripe/resources/usage_record_summary.rbi +0 -38
  534. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  535. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  536. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  537. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  538. data/rbi/stripe/resources/v2/event.rbi +0 -47
  539. data/rbi/stripe/resources/v2/event_destination.rbi +0 -90
  540. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -177
  541. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  542. data/rbi/stripe/services/account_external_account_service.rbi +0 -306
  543. data/rbi/stripe/services/account_link_service.rbi +0 -58
  544. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  545. data/rbi/stripe/services/account_notice_service.rbi +0 -90
  546. data/rbi/stripe/services/account_person_service.rbi +0 -903
  547. data/rbi/stripe/services/account_service.rbi +0 -4267
  548. data/rbi/stripe/services/account_session_service.rbi +0 -780
  549. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -78
  550. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -91
  551. data/rbi/stripe/services/application_fee_service.rbi +0 -74
  552. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  553. data/rbi/stripe/services/apps_service.rbi +0 -9
  554. data/rbi/stripe/services/balance_service.rbi +0 -21
  555. data/rbi/stripe/services/balance_transaction_service.rbi +0 -89
  556. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  557. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -54
  558. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  559. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -191
  560. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -40
  561. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  562. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  563. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  564. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -497
  565. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -202
  566. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  567. data/rbi/stripe/services/billing_service.rbi +0 -15
  568. data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -95
  569. data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -22
  570. data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -68
  571. data/rbi/stripe/services/capital_service.rbi +0 -11
  572. data/rbi/stripe/services/charge_service.rbi +0 -1816
  573. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  574. data/rbi/stripe/services/checkout/session_service.rbi +0 -2591
  575. data/rbi/stripe/services/checkout_service.rbi +0 -9
  576. data/rbi/stripe/services/climate/order_service.rbi +0 -140
  577. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  578. data/rbi/stripe/services/climate/supplier_service.rbi +0 -46
  579. data/rbi/stripe/services/climate_service.rbi +0 -11
  580. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  581. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  582. data/rbi/stripe/services/coupon_service.rbi +0 -190
  583. data/rbi/stripe/services/credit_note_line_item_service.rbi +0 -31
  584. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  585. data/rbi/stripe/services/credit_note_service.rbi +0 -420
  586. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  587. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  588. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  589. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  590. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  591. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -228
  592. data/rbi/stripe/services/customer_service.rbi +0 -647
  593. data/rbi/stripe/services/customer_session_service.rbi +0 -110
  594. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -72
  595. data/rbi/stripe/services/dispute_service.rbi +0 -422
  596. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  597. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  598. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  599. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  600. data/rbi/stripe/services/event_service.rbi +0 -81
  601. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  602. data/rbi/stripe/services/file_link_service.rbi +0 -122
  603. data/rbi/stripe/services/file_service.rbi +0 -114
  604. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -33
  605. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  606. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -132
  607. data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -46
  608. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -111
  609. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -90
  610. data/rbi/stripe/services/financial_connections_service.rbi +0 -12
  611. data/rbi/stripe/services/forwarding/request_service.rbi +0 -132
  612. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  613. data/rbi/stripe/services/gift_cards/card_service.rbi +0 -142
  614. data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -174
  615. data/rbi/stripe/services/gift_cards_service.rbi +0 -10
  616. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -85
  617. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -317
  618. data/rbi/stripe/services/identity_service.rbi +0 -10
  619. data/rbi/stripe/services/invoice_item_service.rbi +0 -424
  620. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -270
  621. data/rbi/stripe/services/invoice_payment_service.rbi +0 -44
  622. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  623. data/rbi/stripe/services/invoice_service.rbi +0 -6040
  624. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +0 -2023
  625. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -140
  626. data/rbi/stripe/services/issuing/card_service.rbi +0 -479
  627. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -568
  628. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -498
  629. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -701
  630. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -55
  631. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -73
  632. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -233
  633. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  634. data/rbi/stripe/services/issuing/token_service.rbi +0 -95
  635. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -103
  636. data/rbi/stripe/services/issuing_service.rbi +0 -19
  637. data/rbi/stripe/services/mandate_service.rbi +0 -20
  638. data/rbi/stripe/services/margin_service.rbi +0 -104
  639. data/rbi/stripe/services/order_line_item_service.rbi +0 -31
  640. data/rbi/stripe/services/order_service.rbi +0 -2306
  641. data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -36
  642. data/rbi/stripe/services/payment_intent_service.rbi +0 -11477
  643. data/rbi/stripe/services/payment_link_line_item_service.rbi +0 -31
  644. data/rbi/stripe/services/payment_link_service.rbi +0 -1250
  645. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2215
  646. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -110
  647. data/rbi/stripe/services/payment_method_service.rbi +0 -897
  648. data/rbi/stripe/services/payment_record_service.rbi +0 -521
  649. data/rbi/stripe/services/payout_service.rbi +0 -197
  650. data/rbi/stripe/services/plan_service.rbi +0 -286
  651. data/rbi/stripe/services/price_service.rbi +0 -551
  652. data/rbi/stripe/services/product_feature_service.rbi +0 -69
  653. data/rbi/stripe/services/product_service.rbi +0 -503
  654. data/rbi/stripe/services/promotion_code_service.rbi +0 -210
  655. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  656. data/rbi/stripe/services/quote_line_item_service.rbi +0 -31
  657. data/rbi/stripe/services/quote_line_service.rbi +0 -31
  658. data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -31
  659. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -31
  660. data/rbi/stripe/services/quote_service.rbi +0 -2390
  661. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -83
  662. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -107
  663. data/rbi/stripe/services/radar/value_list_service.rbi +0 -139
  664. data/rbi/stripe/services/radar_service.rbi +0 -11
  665. data/rbi/stripe/services/refund_service.rbi +0 -181
  666. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -131
  667. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  668. data/rbi/stripe/services/reporting_service.rbi +0 -10
  669. data/rbi/stripe/services/review_service.rbi +0 -82
  670. data/rbi/stripe/services/setup_attempt_service.rbi +0 -63
  671. data/rbi/stripe/services/setup_intent_service.rbi +0 -3630
  672. data/rbi/stripe/services/shipping_rate_service.rbi +0 -235
  673. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  674. data/rbi/stripe/services/sigma_service.rbi +0 -9
  675. data/rbi/stripe/services/source_service.rbi +0 -647
  676. data/rbi/stripe/services/source_transaction_service.rbi +0 -31
  677. data/rbi/stripe/services/subscription_item_service.rbi +0 -422
  678. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -37
  679. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -33
  680. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -2208
  681. data/rbi/stripe/services/subscription_service.rbi +0 -1870
  682. data/rbi/stripe/services/tax/association_service.rbi +0 -25
  683. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -33
  684. data/rbi/stripe/services/tax/calculation_service.rbi +0 -228
  685. data/rbi/stripe/services/tax/form_service.rbi +0 -85
  686. data/rbi/stripe/services/tax/registration_service.rbi +0 -1517
  687. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  688. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +0 -33
  689. data/rbi/stripe/services/tax/transaction_service.rbi +0 -142
  690. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  691. data/rbi/stripe/services/tax_id_service.rbi +0 -112
  692. data/rbi/stripe/services/tax_rate_service.rbi +0 -183
  693. data/rbi/stripe/services/tax_service.rbi +0 -14
  694. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -860
  695. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  696. data/rbi/stripe/services/terminal/location_service.rbi +0 -184
  697. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -22
  698. data/rbi/stripe/services/terminal/reader_service.rbi +0 -513
  699. data/rbi/stripe/services/terminal_service.rbi +0 -13
  700. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -787
  701. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  702. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -836
  703. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  704. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -67
  705. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -705
  706. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  707. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  708. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -62
  709. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  710. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  711. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  712. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -123
  713. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -123
  714. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -114
  715. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -114
  716. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  717. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  718. data/rbi/stripe/services/token_service.rbi +0 -1155
  719. data/rbi/stripe/services/topup_service.rbi +0 -172
  720. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -99
  721. data/rbi/stripe/services/transfer_service.rbi +0 -150
  722. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  723. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  724. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -201
  725. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  726. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  727. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -300
  728. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -182
  729. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -70
  730. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  731. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -107
  732. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -114
  733. data/rbi/stripe/services/treasury_service.rbi +0 -18
  734. data/rbi/stripe/services/v1_services.rbi +0 -83
  735. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  736. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  737. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -20
  738. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  739. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  740. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -203
  741. data/rbi/stripe/services/v2/core/event_service.rbi +0 -39
  742. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  743. data/rbi/stripe/services/v2_services.rbi +0 -10
  744. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -131
@@ -1,4015 +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
- # A Checkout Session represents your customer's session as they pay for
8
- # one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)
9
- # or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a
10
- # new Session each time your customer attempts to pay.
11
- #
12
- # Once payment is successful, the Checkout Session will contain a reference
13
- # to the [Customer](https://stripe.com/docs/api/customers), and either the successful
14
- # [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active
15
- # [Subscription](https://stripe.com/docs/api/subscriptions).
16
- #
17
- # You can create a Checkout Session on your server and redirect to its URL
18
- # to begin Checkout.
19
- #
20
- # Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)
21
- class Session < APIResource
22
- class AdaptivePricing < Stripe::StripeObject
23
- # Whether Adaptive Pricing is enabled.
24
- sig { returns(T::Boolean) }
25
- attr_reader :enabled
26
- end
27
- class AfterExpiration < Stripe::StripeObject
28
- class Recovery < Stripe::StripeObject
29
- # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
30
- sig { returns(T::Boolean) }
31
- attr_reader :allow_promotion_codes
32
- # If `true`, a recovery url will be generated to recover this Checkout Session if it
33
- # expires before a transaction is completed. It will be attached to the
34
- # Checkout Session object upon expiration.
35
- sig { returns(T::Boolean) }
36
- attr_reader :enabled
37
- # The timestamp at which the recovery URL will expire.
38
- sig { returns(T.nilable(Integer)) }
39
- attr_reader :expires_at
40
- # URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
41
- sig { returns(T.nilable(String)) }
42
- attr_reader :url
43
- end
44
- # When set, configuration used to recover the Checkout Session on expiry.
45
- sig { returns(T.nilable(Recovery)) }
46
- attr_reader :recovery
47
- end
48
- class AutomaticTax < Stripe::StripeObject
49
- class Liability < Stripe::StripeObject
50
- # The connected account being referenced when `type` is `account`.
51
- sig { returns(T.any(String, Stripe::Account)) }
52
- attr_reader :account
53
- # Type of the account referenced.
54
- sig { returns(String) }
55
- attr_reader :type
56
- end
57
- # Indicates whether automatic tax is enabled for the session
58
- sig { returns(T::Boolean) }
59
- attr_reader :enabled
60
- # 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.
61
- sig { returns(T.nilable(Liability)) }
62
- attr_reader :liability
63
- # The status of the most recent automated tax calculation for this session.
64
- sig { returns(T.nilable(String)) }
65
- attr_reader :status
66
- end
67
- class CollectedInformation < Stripe::StripeObject
68
- class ShippingDetails < Stripe::StripeObject
69
- class Address < Stripe::StripeObject
70
- # City, district, suburb, town, or village.
71
- sig { returns(T.nilable(String)) }
72
- attr_reader :city
73
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
74
- sig { returns(T.nilable(String)) }
75
- attr_reader :country
76
- # Address line 1 (e.g., street, PO Box, or company name).
77
- sig { returns(T.nilable(String)) }
78
- attr_reader :line1
79
- # Address line 2 (e.g., apartment, suite, unit, or building).
80
- sig { returns(T.nilable(String)) }
81
- attr_reader :line2
82
- # ZIP or postal code.
83
- sig { returns(T.nilable(String)) }
84
- attr_reader :postal_code
85
- # State, county, province, or region.
86
- sig { returns(T.nilable(String)) }
87
- attr_reader :state
88
- end
89
- # Attribute for field address
90
- sig { returns(Address) }
91
- attr_reader :address
92
- # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
93
- sig { returns(T.nilable(String)) }
94
- attr_reader :carrier
95
- # Recipient name.
96
- sig { returns(String) }
97
- attr_reader :name
98
- # Recipient phone (including extension).
99
- sig { returns(T.nilable(String)) }
100
- attr_reader :phone
101
- # 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.
102
- sig { returns(T.nilable(String)) }
103
- attr_reader :tracking_number
104
- end
105
- class TaxId < Stripe::StripeObject
106
- # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`
107
- sig { returns(String) }
108
- attr_reader :type
109
- # The value of the tax ID.
110
- sig { returns(T.nilable(String)) }
111
- attr_reader :value
112
- end
113
- # Customer’s business name for this Checkout Session
114
- sig { returns(T.nilable(String)) }
115
- attr_reader :business_name
116
- # Customer’s email for this Checkout Session
117
- sig { returns(T.nilable(String)) }
118
- attr_reader :email
119
- # Customer’s phone number for this Checkout Session
120
- sig { returns(T.nilable(String)) }
121
- attr_reader :phone
122
- # Shipping information for this Checkout Session.
123
- sig { returns(T.nilable(ShippingDetails)) }
124
- attr_reader :shipping_details
125
- # Customer’s tax ids for this Checkout Session.
126
- sig { returns(T.nilable(T::Array[TaxId])) }
127
- attr_reader :tax_ids
128
- end
129
- class Consent < Stripe::StripeObject
130
- # If `opt_in`, the customer consents to receiving promotional communications
131
- # from the merchant about this Checkout Session.
132
- sig { returns(T.nilable(String)) }
133
- attr_reader :promotions
134
- # If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.
135
- sig { returns(T.nilable(String)) }
136
- attr_reader :terms_of_service
137
- end
138
- class ConsentCollection < Stripe::StripeObject
139
- class PaymentMethodReuseAgreement < Stripe::StripeObject
140
- # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.
141
- #
142
- # When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
143
- sig { returns(String) }
144
- attr_reader :position
145
- end
146
- # If set to `hidden`, it will hide legal text related to the reuse of a payment method.
147
- sig { returns(T.nilable(PaymentMethodReuseAgreement)) }
148
- attr_reader :payment_method_reuse_agreement
149
- # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
150
- # Session will determine whether to display an option to opt into promotional communication
151
- # from the merchant depending on the customer's locale. Only available to US merchants.
152
- sig { returns(T.nilable(String)) }
153
- attr_reader :promotions
154
- # If set to `required`, it requires customers to accept the terms of service before being able to pay.
155
- sig { returns(T.nilable(String)) }
156
- attr_reader :terms_of_service
157
- end
158
- class CurrencyConversion < Stripe::StripeObject
159
- # Total of all items in source currency before discounts or taxes are applied.
160
- sig { returns(Integer) }
161
- attr_reader :amount_subtotal
162
- # Total of all items in source currency after discounts and taxes are applied.
163
- sig { returns(Integer) }
164
- attr_reader :amount_total
165
- # Exchange rate used to convert source currency amounts to customer currency amounts
166
- sig { returns(String) }
167
- attr_reader :fx_rate
168
- # Creation currency of the CheckoutSession before localization
169
- sig { returns(String) }
170
- attr_reader :source_currency
171
- end
172
- class CustomField < Stripe::StripeObject
173
- class Dropdown < Stripe::StripeObject
174
- class Option < Stripe::StripeObject
175
- # The label for the option, displayed to the customer. Up to 100 characters.
176
- sig { returns(String) }
177
- attr_reader :label
178
- # 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.
179
- sig { returns(String) }
180
- attr_reader :value
181
- end
182
- # The value that will pre-fill on the payment page.
183
- sig { returns(T.nilable(String)) }
184
- attr_reader :default_value
185
- # The options available for the customer to select. Up to 200 options allowed.
186
- sig { returns(T::Array[Option]) }
187
- attr_reader :options
188
- # The option selected by the customer. This will be the `value` for the option.
189
- sig { returns(T.nilable(String)) }
190
- attr_reader :value
191
- end
192
- class Label < Stripe::StripeObject
193
- # Custom text for the label, displayed to the customer. Up to 50 characters.
194
- sig { returns(T.nilable(String)) }
195
- attr_reader :custom
196
- # The type of the label.
197
- sig { returns(String) }
198
- attr_reader :type
199
- end
200
- class Numeric < Stripe::StripeObject
201
- # The value that will pre-fill the field on the payment page.
202
- sig { returns(T.nilable(String)) }
203
- attr_reader :default_value
204
- # The maximum character length constraint for the customer's input.
205
- sig { returns(T.nilable(Integer)) }
206
- attr_reader :maximum_length
207
- # The minimum character length requirement for the customer's input.
208
- sig { returns(T.nilable(Integer)) }
209
- attr_reader :minimum_length
210
- # The value entered by the customer, containing only digits.
211
- sig { returns(T.nilable(String)) }
212
- attr_reader :value
213
- end
214
- class Text < Stripe::StripeObject
215
- # The value that will pre-fill the field on the payment page.
216
- sig { returns(T.nilable(String)) }
217
- attr_reader :default_value
218
- # The maximum character length constraint for the customer's input.
219
- sig { returns(T.nilable(Integer)) }
220
- attr_reader :maximum_length
221
- # The minimum character length requirement for the customer's input.
222
- sig { returns(T.nilable(Integer)) }
223
- attr_reader :minimum_length
224
- # The value entered by the customer.
225
- sig { returns(T.nilable(String)) }
226
- attr_reader :value
227
- end
228
- # Attribute for field dropdown
229
- sig { returns(Dropdown) }
230
- attr_reader :dropdown
231
- # 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.
232
- sig { returns(String) }
233
- attr_reader :key
234
- # Attribute for field label
235
- sig { returns(Label) }
236
- attr_reader :label
237
- # Attribute for field numeric
238
- sig { returns(Numeric) }
239
- attr_reader :numeric
240
- # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
241
- sig { returns(T::Boolean) }
242
- attr_reader :optional
243
- # Attribute for field text
244
- sig { returns(Text) }
245
- attr_reader :text
246
- # The type of the field.
247
- sig { returns(String) }
248
- attr_reader :type
249
- end
250
- class CustomText < Stripe::StripeObject
251
- class AfterSubmit < Stripe::StripeObject
252
- # Text may be up to 1200 characters in length.
253
- sig { returns(String) }
254
- attr_reader :message
255
- end
256
- class ShippingAddress < Stripe::StripeObject
257
- # Text may be up to 1200 characters in length.
258
- sig { returns(String) }
259
- attr_reader :message
260
- end
261
- class Submit < Stripe::StripeObject
262
- # Text may be up to 1200 characters in length.
263
- sig { returns(String) }
264
- attr_reader :message
265
- end
266
- class TermsOfServiceAcceptance < Stripe::StripeObject
267
- # Text may be up to 1200 characters in length.
268
- sig { returns(String) }
269
- attr_reader :message
270
- end
271
- # Custom text that should be displayed after the payment confirmation button.
272
- sig { returns(T.nilable(AfterSubmit)) }
273
- attr_reader :after_submit
274
- # Custom text that should be displayed alongside shipping address collection.
275
- sig { returns(T.nilable(ShippingAddress)) }
276
- attr_reader :shipping_address
277
- # Custom text that should be displayed alongside the payment confirmation button.
278
- sig { returns(T.nilable(Submit)) }
279
- attr_reader :submit
280
- # Custom text that should be displayed in place of the default terms of service agreement text.
281
- sig { returns(T.nilable(TermsOfServiceAcceptance)) }
282
- attr_reader :terms_of_service_acceptance
283
- end
284
- class CustomerDetails < Stripe::StripeObject
285
- class Address < Stripe::StripeObject
286
- # City, district, suburb, town, or village.
287
- sig { returns(T.nilable(String)) }
288
- attr_reader :city
289
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
290
- sig { returns(T.nilable(String)) }
291
- attr_reader :country
292
- # Address line 1 (e.g., street, PO Box, or company name).
293
- sig { returns(T.nilable(String)) }
294
- attr_reader :line1
295
- # Address line 2 (e.g., apartment, suite, unit, or building).
296
- sig { returns(T.nilable(String)) }
297
- attr_reader :line2
298
- # ZIP or postal code.
299
- sig { returns(T.nilable(String)) }
300
- attr_reader :postal_code
301
- # State, county, province, or region.
302
- sig { returns(T.nilable(String)) }
303
- attr_reader :state
304
- end
305
- class TaxId < Stripe::StripeObject
306
- # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`
307
- sig { returns(String) }
308
- attr_reader :type
309
- # The value of the tax ID.
310
- sig { returns(T.nilable(String)) }
311
- attr_reader :value
312
- end
313
- # The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
314
- sig { returns(T.nilable(Address)) }
315
- attr_reader :address
316
- # The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
317
- # Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
318
- sig { returns(T.nilable(String)) }
319
- attr_reader :email
320
- # The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
321
- sig { returns(T.nilable(String)) }
322
- attr_reader :name
323
- # The customer's phone number after a completed Checkout Session.
324
- sig { returns(T.nilable(String)) }
325
- attr_reader :phone
326
- # The customer’s tax exempt status after a completed Checkout Session.
327
- sig { returns(T.nilable(String)) }
328
- attr_reader :tax_exempt
329
- # The customer’s tax IDs after a completed Checkout Session.
330
- sig { returns(T.nilable(T::Array[TaxId])) }
331
- attr_reader :tax_ids
332
- end
333
- class Discount < Stripe::StripeObject
334
- # Coupon attached to the Checkout Session.
335
- sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
336
- attr_reader :coupon
337
- # Promotion code attached to the Checkout Session.
338
- sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
339
- attr_reader :promotion_code
340
- end
341
- class InvoiceCreation < Stripe::StripeObject
342
- class InvoiceData < Stripe::StripeObject
343
- class CustomField < Stripe::StripeObject
344
- # The name of the custom field.
345
- sig { returns(String) }
346
- attr_reader :name
347
- # The value of the custom field.
348
- sig { returns(String) }
349
- attr_reader :value
350
- end
351
- class Issuer < Stripe::StripeObject
352
- # The connected account being referenced when `type` is `account`.
353
- sig { returns(T.any(String, Stripe::Account)) }
354
- attr_reader :account
355
- # Type of the account referenced.
356
- sig { returns(String) }
357
- attr_reader :type
358
- end
359
- class RenderingOptions < Stripe::StripeObject
360
- # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
361
- sig { returns(T.nilable(String)) }
362
- attr_reader :amount_tax_display
363
- end
364
- # The account tax IDs associated with the invoice.
365
- sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
366
- attr_reader :account_tax_ids
367
- # Custom fields displayed on the invoice.
368
- sig { returns(T.nilable(T::Array[CustomField])) }
369
- attr_reader :custom_fields
370
- # An arbitrary string attached to the object. Often useful for displaying to users.
371
- sig { returns(T.nilable(String)) }
372
- attr_reader :description
373
- # Footer displayed on the invoice.
374
- sig { returns(T.nilable(String)) }
375
- attr_reader :footer
376
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
377
- sig { returns(T.nilable(Issuer)) }
378
- attr_reader :issuer
379
- # 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.
380
- sig { returns(T.nilable(T::Hash[String, String])) }
381
- attr_reader :metadata
382
- # Options for invoice PDF rendering.
383
- sig { returns(T.nilable(RenderingOptions)) }
384
- attr_reader :rendering_options
385
- end
386
- # Indicates whether invoice creation is enabled for the Checkout Session.
387
- sig { returns(T::Boolean) }
388
- attr_reader :enabled
389
- # Attribute for field invoice_data
390
- sig { returns(InvoiceData) }
391
- attr_reader :invoice_data
392
- end
393
- class PaymentMethodConfigurationDetails < Stripe::StripeObject
394
- # ID of the payment method configuration used.
395
- sig { returns(String) }
396
- attr_reader :id
397
- # ID of the parent payment method configuration used.
398
- sig { returns(T.nilable(String)) }
399
- attr_reader :parent
400
- end
401
- class PaymentMethodOptions < Stripe::StripeObject
402
- class AcssDebit < Stripe::StripeObject
403
- class MandateOptions < Stripe::StripeObject
404
- # A URL for custom mandate text
405
- sig { returns(String) }
406
- attr_reader :custom_mandate_url
407
- # List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
408
- sig { returns(T::Array[String]) }
409
- attr_reader :default_for
410
- # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
411
- sig { returns(T.nilable(String)) }
412
- attr_reader :interval_description
413
- # Payment schedule for the mandate.
414
- sig { returns(T.nilable(String)) }
415
- attr_reader :payment_schedule
416
- # Transaction type of the mandate.
417
- sig { returns(T.nilable(String)) }
418
- attr_reader :transaction_type
419
- end
420
- # Currency supported by the bank account. Returned when the Session is in `setup` mode.
421
- sig { returns(String) }
422
- attr_reader :currency
423
- # Attribute for field mandate_options
424
- sig { returns(MandateOptions) }
425
- attr_reader :mandate_options
426
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
427
- #
428
- # 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.
429
- #
430
- # 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.
431
- #
432
- # 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).
433
- sig { returns(String) }
434
- attr_reader :setup_future_usage
435
- # Bank account verification method.
436
- sig { returns(String) }
437
- attr_reader :verification_method
438
- end
439
- class Affirm < Stripe::StripeObject
440
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
441
- #
442
- # 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.
443
- #
444
- # 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.
445
- #
446
- # 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).
447
- sig { returns(String) }
448
- attr_reader :setup_future_usage
449
- end
450
- class AfterpayClearpay < Stripe::StripeObject
451
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
452
- #
453
- # 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.
454
- #
455
- # 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.
456
- #
457
- # 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).
458
- sig { returns(String) }
459
- attr_reader :setup_future_usage
460
- end
461
- class Alipay < Stripe::StripeObject
462
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
463
- #
464
- # 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.
465
- #
466
- # 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.
467
- #
468
- # 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).
469
- sig { returns(String) }
470
- attr_reader :setup_future_usage
471
- end
472
- class AmazonPay < Stripe::StripeObject
473
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
474
- #
475
- # 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.
476
- #
477
- # 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.
478
- #
479
- # 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).
480
- sig { returns(String) }
481
- attr_reader :setup_future_usage
482
- end
483
- class AuBecsDebit < Stripe::StripeObject
484
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
485
- #
486
- # 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.
487
- #
488
- # 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.
489
- #
490
- # 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).
491
- sig { returns(String) }
492
- attr_reader :setup_future_usage
493
- end
494
- class BacsDebit < Stripe::StripeObject
495
- class MandateOptions < Stripe::StripeObject
496
- # 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'.
497
- sig { returns(String) }
498
- attr_reader :reference_prefix
499
- end
500
- # Attribute for field mandate_options
501
- sig { returns(MandateOptions) }
502
- attr_reader :mandate_options
503
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
504
- #
505
- # 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.
506
- #
507
- # 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.
508
- #
509
- # 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).
510
- sig { returns(String) }
511
- attr_reader :setup_future_usage
512
- end
513
- class Bancontact < Stripe::StripeObject
514
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
515
- #
516
- # 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.
517
- #
518
- # 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.
519
- #
520
- # 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).
521
- sig { returns(String) }
522
- attr_reader :setup_future_usage
523
- end
524
- class Boleto < Stripe::StripeObject
525
- # 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 voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
526
- sig { returns(Integer) }
527
- attr_reader :expires_after_days
528
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
529
- #
530
- # 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.
531
- #
532
- # 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.
533
- #
534
- # 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).
535
- sig { returns(String) }
536
- attr_reader :setup_future_usage
537
- end
538
- class Card < Stripe::StripeObject
539
- class Installments < Stripe::StripeObject
540
- # Indicates if installments are enabled
541
- sig { returns(T::Boolean) }
542
- attr_reader :enabled
543
- end
544
- # Attribute for field installments
545
- sig { returns(Installments) }
546
- attr_reader :installments
547
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
548
- sig { returns(String) }
549
- attr_reader :request_decremental_authorization
550
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
551
- sig { returns(String) }
552
- attr_reader :request_extended_authorization
553
- # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
554
- sig { returns(String) }
555
- attr_reader :request_incremental_authorization
556
- # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
557
- sig { returns(String) }
558
- attr_reader :request_multicapture
559
- # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
560
- sig { returns(String) }
561
- attr_reader :request_overcapture
562
- # 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.
563
- sig { returns(String) }
564
- attr_reader :request_three_d_secure
565
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
566
- #
567
- # 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.
568
- #
569
- # 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.
570
- #
571
- # 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).
572
- sig { returns(String) }
573
- attr_reader :setup_future_usage
574
- # 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.
575
- sig { returns(String) }
576
- attr_reader :statement_descriptor_suffix_kana
577
- # 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.
578
- sig { returns(String) }
579
- attr_reader :statement_descriptor_suffix_kanji
580
- end
581
- class Cashapp < Stripe::StripeObject
582
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
583
- #
584
- # 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.
585
- #
586
- # 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.
587
- #
588
- # 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).
589
- sig { returns(String) }
590
- attr_reader :setup_future_usage
591
- end
592
- class CustomerBalance < Stripe::StripeObject
593
- class BankTransfer < Stripe::StripeObject
594
- class EuBankTransfer < Stripe::StripeObject
595
- # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
596
- sig { returns(String) }
597
- attr_reader :country
598
- end
599
- # Attribute for field eu_bank_transfer
600
- sig { returns(EuBankTransfer) }
601
- attr_reader :eu_bank_transfer
602
- # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
603
- #
604
- # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
605
- sig { returns(T::Array[String]) }
606
- attr_reader :requested_address_types
607
- # The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
608
- sig { returns(T.nilable(String)) }
609
- attr_reader :type
610
- end
611
- # Attribute for field bank_transfer
612
- sig { returns(BankTransfer) }
613
- attr_reader :bank_transfer
614
- # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
615
- sig { returns(T.nilable(String)) }
616
- attr_reader :funding_type
617
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
618
- #
619
- # 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.
620
- #
621
- # 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.
622
- #
623
- # 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).
624
- sig { returns(String) }
625
- attr_reader :setup_future_usage
626
- end
627
- class Eps < Stripe::StripeObject
628
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
629
- #
630
- # 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.
631
- #
632
- # 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.
633
- #
634
- # 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).
635
- sig { returns(String) }
636
- attr_reader :setup_future_usage
637
- end
638
- class Fpx < Stripe::StripeObject
639
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
640
- #
641
- # 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.
642
- #
643
- # 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.
644
- #
645
- # 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).
646
- sig { returns(String) }
647
- attr_reader :setup_future_usage
648
- end
649
- class Giropay < Stripe::StripeObject
650
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
651
- #
652
- # 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.
653
- #
654
- # 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.
655
- #
656
- # 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).
657
- sig { returns(String) }
658
- attr_reader :setup_future_usage
659
- end
660
- class Grabpay < Stripe::StripeObject
661
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
662
- #
663
- # 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.
664
- #
665
- # 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.
666
- #
667
- # 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).
668
- sig { returns(String) }
669
- attr_reader :setup_future_usage
670
- end
671
- class Ideal < Stripe::StripeObject
672
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
673
- #
674
- # 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.
675
- #
676
- # 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.
677
- #
678
- # 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).
679
- sig { returns(String) }
680
- attr_reader :setup_future_usage
681
- end
682
- class KakaoPay < Stripe::StripeObject
683
- # Controls when the funds will be captured from the customer's account.
684
- sig { returns(String) }
685
- attr_reader :capture_method
686
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
687
- #
688
- # 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.
689
- #
690
- # 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.
691
- #
692
- # 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).
693
- sig { returns(String) }
694
- attr_reader :setup_future_usage
695
- end
696
- class Klarna < Stripe::StripeObject
697
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
698
- #
699
- # 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.
700
- #
701
- # 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.
702
- #
703
- # 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).
704
- sig { returns(String) }
705
- attr_reader :setup_future_usage
706
- end
707
- class Konbini < Stripe::StripeObject
708
- # 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.
709
- sig { returns(T.nilable(Integer)) }
710
- attr_reader :expires_after_days
711
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
712
- #
713
- # 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.
714
- #
715
- # 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.
716
- #
717
- # 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).
718
- sig { returns(String) }
719
- attr_reader :setup_future_usage
720
- end
721
- class KrCard < Stripe::StripeObject
722
- # Controls when the funds will be captured from the customer's account.
723
- sig { returns(String) }
724
- attr_reader :capture_method
725
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
726
- #
727
- # 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.
728
- #
729
- # 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.
730
- #
731
- # 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).
732
- sig { returns(String) }
733
- attr_reader :setup_future_usage
734
- end
735
- class Link < Stripe::StripeObject
736
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
737
- #
738
- # 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.
739
- #
740
- # 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.
741
- #
742
- # 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).
743
- sig { returns(String) }
744
- attr_reader :setup_future_usage
745
- end
746
- class Mobilepay < Stripe::StripeObject
747
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
748
- #
749
- # 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.
750
- #
751
- # 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.
752
- #
753
- # 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).
754
- sig { returns(String) }
755
- attr_reader :setup_future_usage
756
- end
757
- class Multibanco < Stripe::StripeObject
758
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
759
- #
760
- # 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.
761
- #
762
- # 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.
763
- #
764
- # 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).
765
- sig { returns(String) }
766
- attr_reader :setup_future_usage
767
- end
768
- class NaverPay < Stripe::StripeObject
769
- # Controls when the funds will be captured from the customer's account.
770
- sig { returns(String) }
771
- attr_reader :capture_method
772
- end
773
- class Oxxo < Stripe::StripeObject
774
- # The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
775
- sig { returns(Integer) }
776
- attr_reader :expires_after_days
777
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
778
- #
779
- # 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.
780
- #
781
- # 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.
782
- #
783
- # 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).
784
- sig { returns(String) }
785
- attr_reader :setup_future_usage
786
- end
787
- class P24 < Stripe::StripeObject
788
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
789
- #
790
- # 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.
791
- #
792
- # 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.
793
- #
794
- # 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).
795
- sig { returns(String) }
796
- attr_reader :setup_future_usage
797
- end
798
- class Payco < Stripe::StripeObject
799
- # Controls when the funds will be captured from the customer's account.
800
- sig { returns(String) }
801
- attr_reader :capture_method
802
- end
803
- class Paynow < Stripe::StripeObject
804
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
805
- #
806
- # 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.
807
- #
808
- # 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.
809
- #
810
- # 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).
811
- sig { returns(String) }
812
- attr_reader :setup_future_usage
813
- end
814
- class Paypal < Stripe::StripeObject
815
- # Controls when the funds will be captured from the customer's account.
816
- sig { returns(String) }
817
- attr_reader :capture_method
818
- # Preferred locale of the PayPal checkout page that the customer is redirected to.
819
- sig { returns(T.nilable(String)) }
820
- attr_reader :preferred_locale
821
- # 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.
822
- sig { returns(T.nilable(String)) }
823
- attr_reader :reference
824
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
825
- #
826
- # 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.
827
- #
828
- # 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.
829
- #
830
- # 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).
831
- sig { returns(String) }
832
- attr_reader :setup_future_usage
833
- # 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.
834
- sig { returns(T::Array[String]) }
835
- attr_reader :subsellers
836
- end
837
- class Payto < Stripe::StripeObject
838
- class MandateOptions < Stripe::StripeObject
839
- # Amount that will be collected. It is required when `amount_type` is `fixed`.
840
- sig { returns(T.nilable(Integer)) }
841
- attr_reader :amount
842
- # 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.
843
- sig { returns(T.nilable(String)) }
844
- attr_reader :amount_type
845
- # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
846
- sig { returns(T.nilable(String)) }
847
- attr_reader :end_date
848
- # The periodicity at which payments will be collected.
849
- sig { returns(T.nilable(String)) }
850
- attr_reader :payment_schedule
851
- # 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.
852
- sig { returns(T.nilable(Integer)) }
853
- attr_reader :payments_per_period
854
- # The purpose for which payments are made. Defaults to retail.
855
- sig { returns(T.nilable(String)) }
856
- attr_reader :purpose
857
- # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
858
- sig { returns(T.nilable(String)) }
859
- attr_reader :start_date
860
- end
861
- # Attribute for field mandate_options
862
- sig { returns(MandateOptions) }
863
- attr_reader :mandate_options
864
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
865
- #
866
- # 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.
867
- #
868
- # 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.
869
- #
870
- # 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).
871
- sig { returns(String) }
872
- attr_reader :setup_future_usage
873
- end
874
- class Pix < Stripe::StripeObject
875
- # The number of seconds after which Pix payment will expire.
876
- sig { returns(T.nilable(Integer)) }
877
- attr_reader :expires_after_seconds
878
- end
879
- class RevolutPay < Stripe::StripeObject
880
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
881
- #
882
- # 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.
883
- #
884
- # 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.
885
- #
886
- # 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).
887
- sig { returns(String) }
888
- attr_reader :setup_future_usage
889
- end
890
- class SamsungPay < Stripe::StripeObject
891
- # Controls when the funds will be captured from the customer's account.
892
- sig { returns(String) }
893
- attr_reader :capture_method
894
- end
895
- class SepaDebit < Stripe::StripeObject
896
- class MandateOptions < Stripe::StripeObject
897
- # 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'.
898
- sig { returns(String) }
899
- attr_reader :reference_prefix
900
- end
901
- # Attribute for field mandate_options
902
- sig { returns(MandateOptions) }
903
- attr_reader :mandate_options
904
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
905
- #
906
- # 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.
907
- #
908
- # 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.
909
- #
910
- # 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).
911
- sig { returns(String) }
912
- attr_reader :setup_future_usage
913
- end
914
- class Sofort < Stripe::StripeObject
915
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
916
- #
917
- # 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.
918
- #
919
- # 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.
920
- #
921
- # 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).
922
- sig { returns(String) }
923
- attr_reader :setup_future_usage
924
- end
925
- class Swish < Stripe::StripeObject
926
- # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
927
- sig { returns(T.nilable(String)) }
928
- attr_reader :reference
929
- end
930
- class UsBankAccount < Stripe::StripeObject
931
- class FinancialConnections < Stripe::StripeObject
932
- class Filters < Stripe::StripeObject
933
- # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
934
- sig { returns(T::Array[String]) }
935
- attr_reader :account_subcategories
936
- # The institution to use to filter for possible accounts to link.
937
- sig { returns(String) }
938
- attr_reader :institution
939
- end
940
- class ManualEntry < Stripe::StripeObject
941
- # Settings for configuring manual entry of account details.
942
- sig { returns(String) }
943
- attr_reader :mode
944
- end
945
- # Attribute for field filters
946
- sig { returns(Filters) }
947
- attr_reader :filters
948
- # Attribute for field manual_entry
949
- sig { returns(ManualEntry) }
950
- attr_reader :manual_entry
951
- # The list of permissions to request. The `payment_method` permission must be included.
952
- sig { returns(T::Array[String]) }
953
- attr_reader :permissions
954
- # Data features requested to be retrieved upon account creation.
955
- sig { returns(T.nilable(T::Array[String])) }
956
- attr_reader :prefetch
957
- # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
958
- sig { returns(String) }
959
- attr_reader :return_url
960
- end
961
- # Attribute for field financial_connections
962
- sig { returns(FinancialConnections) }
963
- attr_reader :financial_connections
964
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
965
- #
966
- # 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.
967
- #
968
- # 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.
969
- #
970
- # 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).
971
- sig { returns(String) }
972
- attr_reader :setup_future_usage
973
- # Bank account verification method.
974
- sig { returns(String) }
975
- attr_reader :verification_method
976
- end
977
- # Attribute for field acss_debit
978
- sig { returns(AcssDebit) }
979
- attr_reader :acss_debit
980
- # Attribute for field affirm
981
- sig { returns(Affirm) }
982
- attr_reader :affirm
983
- # Attribute for field afterpay_clearpay
984
- sig { returns(AfterpayClearpay) }
985
- attr_reader :afterpay_clearpay
986
- # Attribute for field alipay
987
- sig { returns(Alipay) }
988
- attr_reader :alipay
989
- # Attribute for field amazon_pay
990
- sig { returns(AmazonPay) }
991
- attr_reader :amazon_pay
992
- # Attribute for field au_becs_debit
993
- sig { returns(AuBecsDebit) }
994
- attr_reader :au_becs_debit
995
- # Attribute for field bacs_debit
996
- sig { returns(BacsDebit) }
997
- attr_reader :bacs_debit
998
- # Attribute for field bancontact
999
- sig { returns(Bancontact) }
1000
- attr_reader :bancontact
1001
- # Attribute for field boleto
1002
- sig { returns(Boleto) }
1003
- attr_reader :boleto
1004
- # Attribute for field card
1005
- sig { returns(Card) }
1006
- attr_reader :card
1007
- # Attribute for field cashapp
1008
- sig { returns(Cashapp) }
1009
- attr_reader :cashapp
1010
- # Attribute for field customer_balance
1011
- sig { returns(CustomerBalance) }
1012
- attr_reader :customer_balance
1013
- # Attribute for field eps
1014
- sig { returns(Eps) }
1015
- attr_reader :eps
1016
- # Attribute for field fpx
1017
- sig { returns(Fpx) }
1018
- attr_reader :fpx
1019
- # Attribute for field giropay
1020
- sig { returns(Giropay) }
1021
- attr_reader :giropay
1022
- # Attribute for field grabpay
1023
- sig { returns(Grabpay) }
1024
- attr_reader :grabpay
1025
- # Attribute for field ideal
1026
- sig { returns(Ideal) }
1027
- attr_reader :ideal
1028
- # Attribute for field kakao_pay
1029
- sig { returns(KakaoPay) }
1030
- attr_reader :kakao_pay
1031
- # Attribute for field klarna
1032
- sig { returns(Klarna) }
1033
- attr_reader :klarna
1034
- # Attribute for field konbini
1035
- sig { returns(Konbini) }
1036
- attr_reader :konbini
1037
- # Attribute for field kr_card
1038
- sig { returns(KrCard) }
1039
- attr_reader :kr_card
1040
- # Attribute for field link
1041
- sig { returns(Link) }
1042
- attr_reader :link
1043
- # Attribute for field mobilepay
1044
- sig { returns(Mobilepay) }
1045
- attr_reader :mobilepay
1046
- # Attribute for field multibanco
1047
- sig { returns(Multibanco) }
1048
- attr_reader :multibanco
1049
- # Attribute for field naver_pay
1050
- sig { returns(NaverPay) }
1051
- attr_reader :naver_pay
1052
- # Attribute for field oxxo
1053
- sig { returns(Oxxo) }
1054
- attr_reader :oxxo
1055
- # Attribute for field p24
1056
- sig { returns(P24) }
1057
- attr_reader :p24
1058
- # Attribute for field payco
1059
- sig { returns(Payco) }
1060
- attr_reader :payco
1061
- # Attribute for field paynow
1062
- sig { returns(Paynow) }
1063
- attr_reader :paynow
1064
- # Attribute for field paypal
1065
- sig { returns(Paypal) }
1066
- attr_reader :paypal
1067
- # Attribute for field payto
1068
- sig { returns(Payto) }
1069
- attr_reader :payto
1070
- # Attribute for field pix
1071
- sig { returns(Pix) }
1072
- attr_reader :pix
1073
- # Attribute for field revolut_pay
1074
- sig { returns(RevolutPay) }
1075
- attr_reader :revolut_pay
1076
- # Attribute for field samsung_pay
1077
- sig { returns(SamsungPay) }
1078
- attr_reader :samsung_pay
1079
- # Attribute for field sepa_debit
1080
- sig { returns(SepaDebit) }
1081
- attr_reader :sepa_debit
1082
- # Attribute for field sofort
1083
- sig { returns(Sofort) }
1084
- attr_reader :sofort
1085
- # Attribute for field swish
1086
- sig { returns(Swish) }
1087
- attr_reader :swish
1088
- # Attribute for field us_bank_account
1089
- sig { returns(UsBankAccount) }
1090
- attr_reader :us_bank_account
1091
- end
1092
- class Permissions < Stripe::StripeObject
1093
- class Update < Stripe::StripeObject
1094
- # Determines which entity is allowed to update the line items.
1095
- #
1096
- # 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.
1097
- #
1098
- # 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.
1099
- sig { returns(T.nilable(String)) }
1100
- attr_reader :line_items
1101
- # Determines which entity is allowed to update the shipping details.
1102
- #
1103
- # 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.
1104
- #
1105
- # 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.
1106
- sig { returns(T.nilable(String)) }
1107
- attr_reader :shipping_details
1108
- end
1109
- # Permissions for updating the Checkout Session.
1110
- sig { returns(T.nilable(Update)) }
1111
- attr_reader :update
1112
- end
1113
- class PhoneNumberCollection < Stripe::StripeObject
1114
- # Indicates whether phone number collection is enabled for the session
1115
- sig { returns(T::Boolean) }
1116
- attr_reader :enabled
1117
- end
1118
- class SavedPaymentMethodOptions < Stripe::StripeObject
1119
- # 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.
1120
- sig { returns(T.nilable(T::Array[String])) }
1121
- attr_reader :allow_redisplay_filters
1122
- # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
1123
- sig { returns(T.nilable(String)) }
1124
- attr_reader :payment_method_remove
1125
- # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
1126
- sig { returns(T.nilable(String)) }
1127
- attr_reader :payment_method_save
1128
- end
1129
- class ShippingAddressCollection < Stripe::StripeObject
1130
- # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1131
- # shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.
1132
- sig { returns(T::Array[String]) }
1133
- attr_reader :allowed_countries
1134
- end
1135
- class ShippingCost < Stripe::StripeObject
1136
- class Tax < Stripe::StripeObject
1137
- # Amount of tax applied for this rate.
1138
- sig { returns(Integer) }
1139
- attr_reader :amount
1140
- # Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
1141
- #
1142
- # Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
1143
- sig { returns(Stripe::TaxRate) }
1144
- attr_reader :rate
1145
- # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
1146
- sig { returns(T.nilable(String)) }
1147
- attr_reader :taxability_reason
1148
- # The amount on which tax is calculated, in cents (or local equivalent).
1149
- sig { returns(T.nilable(Integer)) }
1150
- attr_reader :taxable_amount
1151
- end
1152
- # Total shipping cost before any discounts or taxes are applied.
1153
- sig { returns(Integer) }
1154
- attr_reader :amount_subtotal
1155
- # Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
1156
- sig { returns(Integer) }
1157
- attr_reader :amount_tax
1158
- # Total shipping cost after discounts and taxes are applied.
1159
- sig { returns(Integer) }
1160
- attr_reader :amount_total
1161
- # The ID of the ShippingRate for this order.
1162
- sig { returns(T.nilable(T.any(String, Stripe::ShippingRate))) }
1163
- attr_reader :shipping_rate
1164
- # The taxes applied to the shipping rate.
1165
- sig { returns(T::Array[Tax]) }
1166
- attr_reader :taxes
1167
- end
1168
- class ShippingDetails < Stripe::StripeObject
1169
- class Address < Stripe::StripeObject
1170
- # City, district, suburb, town, or village.
1171
- sig { returns(T.nilable(String)) }
1172
- attr_reader :city
1173
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1174
- sig { returns(T.nilable(String)) }
1175
- attr_reader :country
1176
- # Address line 1 (e.g., street, PO Box, or company name).
1177
- sig { returns(T.nilable(String)) }
1178
- attr_reader :line1
1179
- # Address line 2 (e.g., apartment, suite, unit, or building).
1180
- sig { returns(T.nilable(String)) }
1181
- attr_reader :line2
1182
- # ZIP or postal code.
1183
- sig { returns(T.nilable(String)) }
1184
- attr_reader :postal_code
1185
- # State, county, province, or region.
1186
- sig { returns(T.nilable(String)) }
1187
- attr_reader :state
1188
- end
1189
- # Attribute for field address
1190
- sig { returns(Address) }
1191
- attr_reader :address
1192
- # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1193
- sig { returns(T.nilable(String)) }
1194
- attr_reader :carrier
1195
- # Recipient name.
1196
- sig { returns(String) }
1197
- attr_reader :name
1198
- # Recipient phone (including extension).
1199
- sig { returns(T.nilable(String)) }
1200
- attr_reader :phone
1201
- # 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.
1202
- sig { returns(T.nilable(String)) }
1203
- attr_reader :tracking_number
1204
- end
1205
- class ShippingOption < Stripe::StripeObject
1206
- # A non-negative integer in cents representing how much to charge.
1207
- sig { returns(Integer) }
1208
- attr_reader :shipping_amount
1209
- # The shipping rate.
1210
- sig { returns(T.any(String, Stripe::ShippingRate)) }
1211
- attr_reader :shipping_rate
1212
- end
1213
- class TaxIdCollection < Stripe::StripeObject
1214
- # Indicates whether tax ID collection is enabled for the session
1215
- sig { returns(T::Boolean) }
1216
- attr_reader :enabled
1217
- # Indicates whether a tax ID is required on the payment page
1218
- sig { returns(String) }
1219
- attr_reader :required
1220
- end
1221
- class TotalDetails < Stripe::StripeObject
1222
- class Breakdown < Stripe::StripeObject
1223
- class Discount < Stripe::StripeObject
1224
- # The amount discounted.
1225
- sig { returns(Integer) }
1226
- attr_reader :amount
1227
- # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
1228
- # It contains information about when the discount began, when it will end, and what it is applied to.
1229
- #
1230
- # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
1231
- sig { returns(Stripe::Discount) }
1232
- attr_reader :discount
1233
- end
1234
- class Tax < Stripe::StripeObject
1235
- # Amount of tax applied for this rate.
1236
- sig { returns(Integer) }
1237
- attr_reader :amount
1238
- # Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
1239
- #
1240
- # Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
1241
- sig { returns(Stripe::TaxRate) }
1242
- attr_reader :rate
1243
- # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
1244
- sig { returns(T.nilable(String)) }
1245
- attr_reader :taxability_reason
1246
- # The amount on which tax is calculated, in cents (or local equivalent).
1247
- sig { returns(T.nilable(Integer)) }
1248
- attr_reader :taxable_amount
1249
- end
1250
- # The aggregated discounts.
1251
- sig { returns(T::Array[Discount]) }
1252
- attr_reader :discounts
1253
- # The aggregated tax amounts by rate.
1254
- sig { returns(T::Array[Tax]) }
1255
- attr_reader :taxes
1256
- end
1257
- # This is the sum of all the discounts.
1258
- sig { returns(Integer) }
1259
- attr_reader :amount_discount
1260
- # This is the sum of all the shipping amounts.
1261
- sig { returns(T.nilable(Integer)) }
1262
- attr_reader :amount_shipping
1263
- # This is the sum of all the tax amounts.
1264
- sig { returns(Integer) }
1265
- attr_reader :amount_tax
1266
- # Attribute for field breakdown
1267
- sig { returns(Breakdown) }
1268
- attr_reader :breakdown
1269
- end
1270
- # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
1271
- sig { returns(T.nilable(AdaptivePricing)) }
1272
- attr_reader :adaptive_pricing
1273
- # When set, provides configuration for actions to take if this Checkout Session expires.
1274
- sig { returns(T.nilable(AfterExpiration)) }
1275
- attr_reader :after_expiration
1276
- # Enables user redeemable promotion codes.
1277
- sig { returns(T.nilable(T::Boolean)) }
1278
- attr_reader :allow_promotion_codes
1279
- # Total of all items before discounts or taxes are applied.
1280
- sig { returns(T.nilable(Integer)) }
1281
- attr_reader :amount_subtotal
1282
- # Total of all items after discounts and taxes are applied.
1283
- sig { returns(T.nilable(Integer)) }
1284
- attr_reader :amount_total
1285
- # Attribute for field automatic_tax
1286
- sig { returns(AutomaticTax) }
1287
- attr_reader :automatic_tax
1288
- # Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.
1289
- sig { returns(T.nilable(String)) }
1290
- attr_reader :billing_address_collection
1291
- # 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.
1292
- sig { returns(T.nilable(String)) }
1293
- attr_reader :cancel_url
1294
- # A unique string to reference the Checkout Session. This can be a
1295
- # customer ID, a cart ID, or similar, and can be used to reconcile the
1296
- # Session with your internal systems.
1297
- sig { returns(T.nilable(String)) }
1298
- attr_reader :client_reference_id
1299
- # The client secret of the Session. Use this with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
1300
- sig { returns(T.nilable(String)) }
1301
- attr_reader :client_secret
1302
- # Information about the customer collected within the Checkout Session.
1303
- sig { returns(T.nilable(CollectedInformation)) }
1304
- attr_reader :collected_information
1305
- # Results of `consent_collection` for this session.
1306
- sig { returns(T.nilable(Consent)) }
1307
- attr_reader :consent
1308
- # When set, provides configuration for the Checkout Session to gather active consent from customers.
1309
- sig { returns(T.nilable(ConsentCollection)) }
1310
- attr_reader :consent_collection
1311
- # Time at which the object was created. Measured in seconds since the Unix epoch.
1312
- sig { returns(Integer) }
1313
- attr_reader :created
1314
- # 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).
1315
- sig { returns(T.nilable(String)) }
1316
- attr_reader :currency
1317
- # Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions
1318
- sig { returns(T.nilable(CurrencyConversion)) }
1319
- attr_reader :currency_conversion
1320
- # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
1321
- sig { returns(T::Array[CustomField]) }
1322
- attr_reader :custom_fields
1323
- # Attribute for field custom_text
1324
- sig { returns(CustomText) }
1325
- attr_reader :custom_text
1326
- # The ID of the customer for this Session.
1327
- # For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout
1328
- # will create a new customer object based on information provided
1329
- # during the payment flow unless an existing customer was provided when
1330
- # the Session was created.
1331
- sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
1332
- attr_reader :customer
1333
- # Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
1334
- sig { returns(T.nilable(String)) }
1335
- attr_reader :customer_creation
1336
- # The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.
1337
- sig { returns(T.nilable(CustomerDetails)) }
1338
- attr_reader :customer_details
1339
- # If provided, this value will be used when the Customer object is created.
1340
- # If not provided, customers will be asked to enter their email address.
1341
- # Use this parameter to prefill customer data if you already have an email
1342
- # on file. To access information about the customer once the payment flow is
1343
- # complete, use the `customer` attribute.
1344
- sig { returns(T.nilable(String)) }
1345
- attr_reader :customer_email
1346
- # List of coupons and promotion codes attached to the Checkout Session.
1347
- sig { returns(T.nilable(T::Array[Discount])) }
1348
- attr_reader :discounts
1349
- # The timestamp at which the Checkout Session will expire.
1350
- sig { returns(Integer) }
1351
- attr_reader :expires_at
1352
- # Unique identifier for the object.
1353
- sig { returns(String) }
1354
- attr_reader :id
1355
- # ID of the invoice created by the Checkout Session, if it exists.
1356
- sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
1357
- attr_reader :invoice
1358
- # Details on the state of invoice creation for the Checkout Session.
1359
- sig { returns(T.nilable(InvoiceCreation)) }
1360
- attr_reader :invoice_creation
1361
- # The line items purchased by the customer.
1362
- sig { returns(Stripe::ListObject) }
1363
- attr_reader :line_items
1364
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
1365
- sig { returns(T::Boolean) }
1366
- attr_reader :livemode
1367
- # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
1368
- sig { returns(T.nilable(String)) }
1369
- attr_reader :locale
1370
- # 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.
1371
- sig { returns(T.nilable(T::Hash[String, String])) }
1372
- attr_reader :metadata
1373
- # The mode of the Checkout Session.
1374
- sig { returns(String) }
1375
- attr_reader :mode
1376
- # String representing the object's type. Objects of the same type share the same value.
1377
- sig { returns(String) }
1378
- attr_reader :object
1379
- # The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
1380
- sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
1381
- attr_reader :payment_intent
1382
- # The ID of the Payment Link that created this Session.
1383
- sig { returns(T.nilable(T.any(String, Stripe::PaymentLink))) }
1384
- attr_reader :payment_link
1385
- # Configure whether a Checkout Session should collect a payment method. Defaults to `always`.
1386
- sig { returns(T.nilable(String)) }
1387
- attr_reader :payment_method_collection
1388
- # Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
1389
- sig { returns(T.nilable(PaymentMethodConfigurationDetails)) }
1390
- attr_reader :payment_method_configuration_details
1391
- # Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
1392
- sig { returns(T.nilable(PaymentMethodOptions)) }
1393
- attr_reader :payment_method_options
1394
- # A list of the types of payment methods (e.g. card) this Checkout
1395
- # Session is allowed to accept.
1396
- sig { returns(T::Array[String]) }
1397
- attr_reader :payment_method_types
1398
- # The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.
1399
- # You can use this value to decide when to fulfill your customer's order.
1400
- sig { returns(String) }
1401
- attr_reader :payment_status
1402
- # This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
1403
- #
1404
- # For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
1405
- sig { returns(T.nilable(Permissions)) }
1406
- attr_reader :permissions
1407
- # Attribute for field phone_number_collection
1408
- sig { returns(PhoneNumberCollection) }
1409
- attr_reader :phone_number_collection
1410
- # The ID of the original expired Checkout Session that triggered the recovery flow.
1411
- sig { returns(T.nilable(String)) }
1412
- attr_reader :recovered_from
1413
- # 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`.
1414
- sig { returns(String) }
1415
- attr_reader :redirect_on_completion
1416
- # Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
1417
- sig { returns(String) }
1418
- attr_reader :return_url
1419
- # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
1420
- sig { returns(T.nilable(SavedPaymentMethodOptions)) }
1421
- attr_reader :saved_payment_method_options
1422
- # The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
1423
- sig { returns(T.nilable(T.any(String, Stripe::SetupIntent))) }
1424
- attr_reader :setup_intent
1425
- # When set, provides configuration for Checkout to collect a shipping address from a customer.
1426
- sig { returns(T.nilable(ShippingAddressCollection)) }
1427
- attr_reader :shipping_address_collection
1428
- # The details of the customer cost of shipping, including the customer chosen ShippingRate.
1429
- sig { returns(T.nilable(ShippingCost)) }
1430
- attr_reader :shipping_cost
1431
- # Shipping information for this Checkout Session.
1432
- sig { returns(T.nilable(ShippingDetails)) }
1433
- attr_reader :shipping_details
1434
- # The shipping rate options applied to this Session.
1435
- sig { returns(T::Array[ShippingOption]) }
1436
- attr_reader :shipping_options
1437
- # The status of the Checkout Session, one of `open`, `complete`, or `expired`.
1438
- sig { returns(T.nilable(String)) }
1439
- attr_reader :status
1440
- # Describes the type of transaction being performed by Checkout in order to customize
1441
- # relevant text on the page, such as the submit button. `submit_type` can only be
1442
- # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
1443
- sig { returns(T.nilable(String)) }
1444
- attr_reader :submit_type
1445
- # The ID of the subscription for Checkout Sessions in `subscription` mode.
1446
- sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
1447
- attr_reader :subscription
1448
- # The URL the customer will be directed to after the payment or
1449
- # subscription creation is successful.
1450
- sig { returns(T.nilable(String)) }
1451
- attr_reader :success_url
1452
- # Attribute for field tax_id_collection
1453
- sig { returns(TaxIdCollection) }
1454
- attr_reader :tax_id_collection
1455
- # Tax and discount details for the computed total amount.
1456
- sig { returns(T.nilable(TotalDetails)) }
1457
- attr_reader :total_details
1458
- # The UI mode of the Session. Defaults to `hosted`.
1459
- sig { returns(T.nilable(String)) }
1460
- attr_reader :ui_mode
1461
- # The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`
1462
- # This value is only present when the session is active.
1463
- sig { returns(T.nilable(String)) }
1464
- attr_reader :url
1465
- class ListParams < Stripe::RequestParams
1466
- class Created < Stripe::RequestParams
1467
- # Minimum value to filter by (exclusive)
1468
- sig { returns(Integer) }
1469
- attr_accessor :gt
1470
- # Minimum value to filter by (inclusive)
1471
- sig { returns(Integer) }
1472
- attr_accessor :gte
1473
- # Maximum value to filter by (exclusive)
1474
- sig { returns(Integer) }
1475
- attr_accessor :lt
1476
- # Maximum value to filter by (inclusive)
1477
- sig { returns(Integer) }
1478
- attr_accessor :lte
1479
- sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
1480
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
1481
- end
1482
- class CustomerDetails < Stripe::RequestParams
1483
- # Customer's email address.
1484
- sig { returns(String) }
1485
- attr_accessor :email
1486
- sig { params(email: String).void }
1487
- def initialize(email: nil); end
1488
- end
1489
- # Only return Checkout Sessions that were created during the given date interval.
1490
- sig { returns(T.any(::Stripe::Checkout::Session::ListParams::Created, Integer)) }
1491
- attr_accessor :created
1492
- # Only return the Checkout Sessions for the Customer specified.
1493
- sig { returns(String) }
1494
- attr_accessor :customer
1495
- # Only return the Checkout Sessions for the Customer details specified.
1496
- sig { returns(::Stripe::Checkout::Session::ListParams::CustomerDetails) }
1497
- attr_accessor :customer_details
1498
- # 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.
1499
- sig { returns(String) }
1500
- attr_accessor :ending_before
1501
- # Specifies which fields in the response should be expanded.
1502
- sig { returns(T::Array[String]) }
1503
- attr_accessor :expand
1504
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1505
- sig { returns(Integer) }
1506
- attr_accessor :limit
1507
- # Only return the Checkout Session for the PaymentIntent specified.
1508
- sig { returns(String) }
1509
- attr_accessor :payment_intent
1510
- # Only return the Checkout Sessions for the Payment Link specified.
1511
- sig { returns(String) }
1512
- attr_accessor :payment_link
1513
- # 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.
1514
- sig { returns(String) }
1515
- attr_accessor :starting_after
1516
- # Only return the Checkout Sessions matching the given status.
1517
- sig { returns(String) }
1518
- attr_accessor :status
1519
- # Only return the Checkout Session for the subscription specified.
1520
- sig { returns(String) }
1521
- attr_accessor :subscription
1522
- sig {
1523
- params(created: T.any(::Stripe::Checkout::Session::ListParams::Created, Integer), customer: String, customer_details: ::Stripe::Checkout::Session::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
1524
- }
1525
- def initialize(
1526
- created: nil,
1527
- customer: nil,
1528
- customer_details: nil,
1529
- ending_before: nil,
1530
- expand: nil,
1531
- limit: nil,
1532
- payment_intent: nil,
1533
- payment_link: nil,
1534
- starting_after: nil,
1535
- status: nil,
1536
- subscription: nil
1537
- ); end
1538
- end
1539
- class CreateParams < Stripe::RequestParams
1540
- class AdaptivePricing < Stripe::RequestParams
1541
- # 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).
1542
- sig { returns(T::Boolean) }
1543
- attr_accessor :enabled
1544
- sig { params(enabled: T::Boolean).void }
1545
- def initialize(enabled: nil); end
1546
- end
1547
- class AfterExpiration < Stripe::RequestParams
1548
- class Recovery < Stripe::RequestParams
1549
- # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
1550
- sig { returns(T::Boolean) }
1551
- attr_accessor :allow_promotion_codes
1552
- # If `true`, a recovery URL will be generated to recover this Checkout Session if it
1553
- # expires before a successful transaction is completed. It will be attached to the
1554
- # Checkout Session object upon expiration.
1555
- sig { returns(T::Boolean) }
1556
- attr_accessor :enabled
1557
- sig { params(allow_promotion_codes: T::Boolean, enabled: T::Boolean).void }
1558
- def initialize(allow_promotion_codes: nil, enabled: nil); end
1559
- end
1560
- # Configure a Checkout Session that can be used to recover an expired session.
1561
- sig { returns(::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery) }
1562
- attr_accessor :recovery
1563
- sig {
1564
- params(recovery: ::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery).void
1565
- }
1566
- def initialize(recovery: nil); end
1567
- end
1568
- class AutomaticTax < Stripe::RequestParams
1569
- class Liability < Stripe::RequestParams
1570
- # The connected account being referenced when `type` is `account`.
1571
- sig { returns(String) }
1572
- attr_accessor :account
1573
- # Type of the account referenced in the request.
1574
- sig { returns(String) }
1575
- attr_accessor :type
1576
- sig { params(account: String, type: String).void }
1577
- def initialize(account: nil, type: nil); end
1578
- end
1579
- # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
1580
- #
1581
- # Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
1582
- sig { returns(T::Boolean) }
1583
- attr_accessor :enabled
1584
- # 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.
1585
- sig { returns(::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability) }
1586
- attr_accessor :liability
1587
- sig {
1588
- params(enabled: T::Boolean, liability: ::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability).void
1589
- }
1590
- def initialize(enabled: nil, liability: nil); end
1591
- end
1592
- class ConsentCollection < Stripe::RequestParams
1593
- class PaymentMethodReuseAgreement < Stripe::RequestParams
1594
- # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
1595
- # defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
1596
- sig { returns(String) }
1597
- attr_accessor :position
1598
- sig { params(position: String).void }
1599
- def initialize(position: nil); end
1600
- end
1601
- # 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.
1602
- sig {
1603
- returns(::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)
1604
- }
1605
- attr_accessor :payment_method_reuse_agreement
1606
- # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
1607
- # Session will determine whether to display an option to opt into promotional communication
1608
- # from the merchant depending on the customer's locale. Only available to US merchants.
1609
- sig { returns(String) }
1610
- attr_accessor :promotions
1611
- # If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
1612
- # There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
1613
- sig { returns(String) }
1614
- attr_accessor :terms_of_service
1615
- sig {
1616
- params(payment_method_reuse_agreement: ::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement, promotions: String, terms_of_service: String).void
1617
- }
1618
- def initialize(
1619
- payment_method_reuse_agreement: nil,
1620
- promotions: nil,
1621
- terms_of_service: nil
1622
- ); end
1623
- end
1624
- class CustomField < Stripe::RequestParams
1625
- class Dropdown < Stripe::RequestParams
1626
- class Option < Stripe::RequestParams
1627
- # The label for the option, displayed to the customer. Up to 100 characters.
1628
- sig { returns(String) }
1629
- attr_accessor :label
1630
- # 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.
1631
- sig { returns(String) }
1632
- attr_accessor :value
1633
- sig { params(label: String, value: String).void }
1634
- def initialize(label: nil, value: nil); end
1635
- end
1636
- # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
1637
- sig { returns(String) }
1638
- attr_accessor :default_value
1639
- # The options available for the customer to select. Up to 200 options allowed.
1640
- sig {
1641
- returns(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option])
1642
- }
1643
- attr_accessor :options
1644
- sig {
1645
- params(default_value: String, options: T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option]).void
1646
- }
1647
- def initialize(default_value: nil, options: nil); end
1648
- end
1649
- class Label < Stripe::RequestParams
1650
- # Custom text for the label, displayed to the customer. Up to 50 characters.
1651
- sig { returns(String) }
1652
- attr_accessor :custom
1653
- # The type of the label.
1654
- sig { returns(String) }
1655
- attr_accessor :type
1656
- sig { params(custom: String, type: String).void }
1657
- def initialize(custom: nil, type: nil); end
1658
- end
1659
- class Numeric < Stripe::RequestParams
1660
- # The value that will pre-fill the field on the payment page.
1661
- sig { returns(String) }
1662
- attr_accessor :default_value
1663
- # The maximum character length constraint for the customer's input.
1664
- sig { returns(Integer) }
1665
- attr_accessor :maximum_length
1666
- # The minimum character length requirement for the customer's input.
1667
- sig { returns(Integer) }
1668
- attr_accessor :minimum_length
1669
- sig {
1670
- params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
1671
- }
1672
- def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
1673
- end
1674
- class Text < Stripe::RequestParams
1675
- # The value that will pre-fill the field on the payment page.
1676
- sig { returns(String) }
1677
- attr_accessor :default_value
1678
- # The maximum character length constraint for the customer's input.
1679
- sig { returns(Integer) }
1680
- attr_accessor :maximum_length
1681
- # The minimum character length requirement for the customer's input.
1682
- sig { returns(Integer) }
1683
- attr_accessor :minimum_length
1684
- sig {
1685
- params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
1686
- }
1687
- def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
1688
- end
1689
- # Configuration for `type=dropdown` fields.
1690
- sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown) }
1691
- attr_accessor :dropdown
1692
- # 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.
1693
- sig { returns(String) }
1694
- attr_accessor :key
1695
- # The label for the field, displayed to the customer.
1696
- sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Label) }
1697
- attr_accessor :label
1698
- # Configuration for `type=numeric` fields.
1699
- sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Numeric) }
1700
- attr_accessor :numeric
1701
- # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
1702
- sig { returns(T::Boolean) }
1703
- attr_accessor :optional
1704
- # Configuration for `type=text` fields.
1705
- sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Text) }
1706
- attr_accessor :text
1707
- # The type of the field.
1708
- sig { returns(String) }
1709
- attr_accessor :type
1710
- sig {
1711
- params(dropdown: ::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown, key: String, label: ::Stripe::Checkout::Session::CreateParams::CustomField::Label, numeric: ::Stripe::Checkout::Session::CreateParams::CustomField::Numeric, optional: T::Boolean, text: ::Stripe::Checkout::Session::CreateParams::CustomField::Text, type: String).void
1712
- }
1713
- def initialize(
1714
- dropdown: nil,
1715
- key: nil,
1716
- label: nil,
1717
- numeric: nil,
1718
- optional: nil,
1719
- text: nil,
1720
- type: nil
1721
- ); end
1722
- end
1723
- class CustomText < Stripe::RequestParams
1724
- class AfterSubmit < Stripe::RequestParams
1725
- # Text may be up to 1200 characters in length.
1726
- sig { returns(String) }
1727
- attr_accessor :message
1728
- sig { params(message: String).void }
1729
- def initialize(message: nil); end
1730
- end
1731
- class ShippingAddress < Stripe::RequestParams
1732
- # Text may be up to 1200 characters in length.
1733
- sig { returns(String) }
1734
- attr_accessor :message
1735
- sig { params(message: String).void }
1736
- def initialize(message: nil); end
1737
- end
1738
- class Submit < Stripe::RequestParams
1739
- # Text may be up to 1200 characters in length.
1740
- sig { returns(String) }
1741
- attr_accessor :message
1742
- sig { params(message: String).void }
1743
- def initialize(message: nil); end
1744
- end
1745
- class TermsOfServiceAcceptance < Stripe::RequestParams
1746
- # Text may be up to 1200 characters in length.
1747
- sig { returns(String) }
1748
- attr_accessor :message
1749
- sig { params(message: String).void }
1750
- def initialize(message: nil); end
1751
- end
1752
- # Custom text that should be displayed after the payment confirmation button.
1753
- sig {
1754
- returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit))
1755
- }
1756
- attr_accessor :after_submit
1757
- # Custom text that should be displayed alongside shipping address collection.
1758
- sig {
1759
- returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress))
1760
- }
1761
- attr_accessor :shipping_address
1762
- # Custom text that should be displayed alongside the payment confirmation button.
1763
- sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::Submit)) }
1764
- attr_accessor :submit
1765
- # Custom text that should be displayed in place of the default terms of service agreement text.
1766
- sig {
1767
- returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance))
1768
- }
1769
- attr_accessor :terms_of_service_acceptance
1770
- sig {
1771
- params(after_submit: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit), shipping_address: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress), submit: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::Submit), terms_of_service_acceptance: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance)).void
1772
- }
1773
- def initialize(
1774
- after_submit: nil,
1775
- shipping_address: nil,
1776
- submit: nil,
1777
- terms_of_service_acceptance: nil
1778
- ); end
1779
- end
1780
- class CustomerUpdate < Stripe::RequestParams
1781
- # Describes whether Checkout saves the billing address onto `customer.address`.
1782
- # To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
1783
- sig { returns(String) }
1784
- attr_accessor :address
1785
- # Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
1786
- sig { returns(String) }
1787
- attr_accessor :name
1788
- # Describes whether Checkout saves shipping information onto `customer.shipping`.
1789
- # To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
1790
- sig { returns(String) }
1791
- attr_accessor :shipping
1792
- sig { params(address: String, name: String, shipping: String).void }
1793
- def initialize(address: nil, name: nil, shipping: nil); end
1794
- end
1795
- class Discount < Stripe::RequestParams
1796
- # The ID of the coupon to apply to this Session.
1797
- sig { returns(String) }
1798
- attr_accessor :coupon
1799
- # The ID of a promotion code to apply to this Session.
1800
- sig { returns(String) }
1801
- attr_accessor :promotion_code
1802
- sig { params(coupon: String, promotion_code: String).void }
1803
- def initialize(coupon: nil, promotion_code: nil); end
1804
- end
1805
- class InvoiceCreation < Stripe::RequestParams
1806
- class InvoiceData < Stripe::RequestParams
1807
- class CustomField < Stripe::RequestParams
1808
- # The name of the custom field. This may be up to 40 characters.
1809
- sig { returns(String) }
1810
- attr_accessor :name
1811
- # The value of the custom field. This may be up to 140 characters.
1812
- sig { returns(String) }
1813
- attr_accessor :value
1814
- sig { params(name: String, value: String).void }
1815
- def initialize(name: nil, value: nil); end
1816
- end
1817
- class Issuer < Stripe::RequestParams
1818
- # The connected account being referenced when `type` is `account`.
1819
- sig { returns(String) }
1820
- attr_accessor :account
1821
- # Type of the account referenced in the request.
1822
- sig { returns(String) }
1823
- attr_accessor :type
1824
- sig { params(account: String, type: String).void }
1825
- def initialize(account: nil, type: nil); end
1826
- end
1827
- class RenderingOptions < Stripe::RequestParams
1828
- # 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.
1829
- sig { returns(T.nilable(String)) }
1830
- attr_accessor :amount_tax_display
1831
- sig { params(amount_tax_display: T.nilable(String)).void }
1832
- def initialize(amount_tax_display: nil); end
1833
- end
1834
- # The account tax IDs associated with the invoice.
1835
- sig { returns(T.nilable(T::Array[String])) }
1836
- attr_accessor :account_tax_ids
1837
- # Default custom fields to be displayed on invoices for this customer.
1838
- sig {
1839
- returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField]))
1840
- }
1841
- attr_accessor :custom_fields
1842
- # An arbitrary string attached to the object. Often useful for displaying to users.
1843
- sig { returns(String) }
1844
- attr_accessor :description
1845
- # Default footer to be displayed on invoices for this customer.
1846
- sig { returns(String) }
1847
- attr_accessor :footer
1848
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1849
- sig {
1850
- returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer)
1851
- }
1852
- attr_accessor :issuer
1853
- # 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`.
1854
- sig { returns(T::Hash[String, String]) }
1855
- attr_accessor :metadata
1856
- # Default options for invoice PDF rendering for this customer.
1857
- sig {
1858
- returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))
1859
- }
1860
- attr_accessor :rendering_options
1861
- sig {
1862
- params(account_tax_ids: T.nilable(T::Array[String]), custom_fields: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField]), description: String, footer: String, issuer: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer, metadata: T::Hash[String, String], rendering_options: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)).void
1863
- }
1864
- def initialize(
1865
- account_tax_ids: nil,
1866
- custom_fields: nil,
1867
- description: nil,
1868
- footer: nil,
1869
- issuer: nil,
1870
- metadata: nil,
1871
- rendering_options: nil
1872
- ); end
1873
- end
1874
- # Set to `true` to enable invoice creation.
1875
- sig { returns(T::Boolean) }
1876
- attr_accessor :enabled
1877
- # Parameters passed when creating invoices for payment-mode Checkout Sessions.
1878
- sig { returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData) }
1879
- attr_accessor :invoice_data
1880
- sig {
1881
- params(enabled: T::Boolean, invoice_data: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData).void
1882
- }
1883
- def initialize(enabled: nil, invoice_data: nil); end
1884
- end
1885
- class LineItem < Stripe::RequestParams
1886
- class AdjustableQuantity < Stripe::RequestParams
1887
- # Set to true if the quantity can be adjusted to any non-negative integer.
1888
- sig { returns(T::Boolean) }
1889
- attr_accessor :enabled
1890
- # 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.
1891
- sig { returns(Integer) }
1892
- attr_accessor :maximum
1893
- # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
1894
- sig { returns(Integer) }
1895
- attr_accessor :minimum
1896
- sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
1897
- def initialize(enabled: nil, maximum: nil, minimum: nil); end
1898
- end
1899
- class PriceData < Stripe::RequestParams
1900
- class ProductData < Stripe::RequestParams
1901
- # 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.
1902
- sig { returns(String) }
1903
- attr_accessor :description
1904
- # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
1905
- sig { returns(T::Array[String]) }
1906
- attr_accessor :images
1907
- # 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`.
1908
- sig { returns(T::Hash[String, String]) }
1909
- attr_accessor :metadata
1910
- # The product's name, meant to be displayable to the customer.
1911
- sig { returns(String) }
1912
- attr_accessor :name
1913
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
1914
- sig { returns(String) }
1915
- attr_accessor :tax_code
1916
- sig {
1917
- params(description: String, images: T::Array[String], metadata: T::Hash[String, String], name: String, tax_code: String).void
1918
- }
1919
- def initialize(
1920
- description: nil,
1921
- images: nil,
1922
- metadata: nil,
1923
- name: nil,
1924
- tax_code: nil
1925
- ); end
1926
- end
1927
- class Recurring < Stripe::RequestParams
1928
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1929
- sig { returns(String) }
1930
- attr_accessor :interval
1931
- # 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).
1932
- sig { returns(Integer) }
1933
- attr_accessor :interval_count
1934
- sig { params(interval: String, interval_count: Integer).void }
1935
- def initialize(interval: nil, interval_count: nil); end
1936
- end
1937
- # 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).
1938
- sig { returns(String) }
1939
- attr_accessor :currency
1940
- # The ID of the product that this price will belong to. One of `product` or `product_data` is required.
1941
- sig { returns(String) }
1942
- attr_accessor :product
1943
- # Data used to generate a new product object inline. One of `product` or `product_data` is required.
1944
- sig {
1945
- returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData)
1946
- }
1947
- attr_accessor :product_data
1948
- # The recurring components of a price such as `interval` and `interval_count`.
1949
- sig {
1950
- returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring)
1951
- }
1952
- attr_accessor :recurring
1953
- # 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.
1954
- sig { returns(String) }
1955
- attr_accessor :tax_behavior
1956
- # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
1957
- sig { returns(Integer) }
1958
- attr_accessor :unit_amount
1959
- # 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.
1960
- sig { returns(String) }
1961
- attr_accessor :unit_amount_decimal
1962
- sig {
1963
- params(currency: String, product: String, product_data: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData, recurring: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1964
- }
1965
- def initialize(
1966
- currency: nil,
1967
- product: nil,
1968
- product_data: nil,
1969
- recurring: nil,
1970
- tax_behavior: nil,
1971
- unit_amount: nil,
1972
- unit_amount_decimal: nil
1973
- ); end
1974
- end
1975
- # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
1976
- sig { returns(::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity) }
1977
- attr_accessor :adjustable_quantity
1978
- # 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.
1979
- sig { returns(T::Array[String]) }
1980
- attr_accessor :dynamic_tax_rates
1981
- # 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`.
1982
- sig { returns(T::Hash[String, String]) }
1983
- attr_accessor :metadata
1984
- # 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.
1985
- sig { returns(String) }
1986
- attr_accessor :price
1987
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
1988
- sig { returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData) }
1989
- attr_accessor :price_data
1990
- # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
1991
- sig { returns(Integer) }
1992
- attr_accessor :quantity
1993
- # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
1994
- sig { returns(T::Array[String]) }
1995
- attr_accessor :tax_rates
1996
- sig {
1997
- params(adjustable_quantity: ::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity, dynamic_tax_rates: T::Array[String], metadata: T::Hash[String, String], price: String, price_data: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData, quantity: Integer, tax_rates: T::Array[String]).void
1998
- }
1999
- def initialize(
2000
- adjustable_quantity: nil,
2001
- dynamic_tax_rates: nil,
2002
- metadata: nil,
2003
- price: nil,
2004
- price_data: nil,
2005
- quantity: nil,
2006
- tax_rates: nil
2007
- ); end
2008
- end
2009
- class PaymentIntentData < Stripe::RequestParams
2010
- class Shipping < Stripe::RequestParams
2011
- class Address < Stripe::RequestParams
2012
- # City, district, suburb, town, or village.
2013
- sig { returns(String) }
2014
- attr_accessor :city
2015
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2016
- sig { returns(String) }
2017
- attr_accessor :country
2018
- # Address line 1 (e.g., street, PO Box, or company name).
2019
- sig { returns(String) }
2020
- attr_accessor :line1
2021
- # Address line 2 (e.g., apartment, suite, unit, or building).
2022
- sig { returns(String) }
2023
- attr_accessor :line2
2024
- # ZIP or postal code.
2025
- sig { returns(String) }
2026
- attr_accessor :postal_code
2027
- # State, county, province, or region.
2028
- sig { returns(String) }
2029
- attr_accessor :state
2030
- sig {
2031
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2032
- }
2033
- def initialize(
2034
- city: nil,
2035
- country: nil,
2036
- line1: nil,
2037
- line2: nil,
2038
- postal_code: nil,
2039
- state: nil
2040
- ); end
2041
- end
2042
- # Shipping address.
2043
- sig {
2044
- returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address)
2045
- }
2046
- attr_accessor :address
2047
- # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
2048
- sig { returns(String) }
2049
- attr_accessor :carrier
2050
- # Recipient name.
2051
- sig { returns(String) }
2052
- attr_accessor :name
2053
- # Recipient phone (including extension).
2054
- sig { returns(String) }
2055
- attr_accessor :phone
2056
- # 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.
2057
- sig { returns(String) }
2058
- attr_accessor :tracking_number
2059
- sig {
2060
- params(address: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
2061
- }
2062
- def initialize(
2063
- address: nil,
2064
- carrier: nil,
2065
- name: nil,
2066
- phone: nil,
2067
- tracking_number: nil
2068
- ); end
2069
- end
2070
- class TransferData < Stripe::RequestParams
2071
- # The amount that will be transferred automatically when a charge succeeds.
2072
- sig { returns(Integer) }
2073
- attr_accessor :amount
2074
- # If specified, successful charges will be attributed to the destination
2075
- # account for tax reporting, and the funds from charges will be transferred
2076
- # to the destination account. The ID of the resulting transfer will be
2077
- # returned on the successful charge's `transfer` field.
2078
- sig { returns(String) }
2079
- attr_accessor :destination
2080
- sig { params(amount: Integer, destination: String).void }
2081
- def initialize(amount: nil, destination: nil); end
2082
- end
2083
- # 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).
2084
- sig { returns(Integer) }
2085
- attr_accessor :application_fee_amount
2086
- # Controls when the funds will be captured from the customer's account.
2087
- sig { returns(String) }
2088
- attr_accessor :capture_method
2089
- # An arbitrary string attached to the object. Often useful for displaying to users.
2090
- sig { returns(String) }
2091
- attr_accessor :description
2092
- # 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`.
2093
- sig { returns(T::Hash[String, String]) }
2094
- attr_accessor :metadata
2095
- # The Stripe account ID for which these funds are intended. For details,
2096
- # see the PaymentIntents [use case for connected
2097
- # accounts](/docs/payments/connected-accounts).
2098
- sig { returns(String) }
2099
- attr_accessor :on_behalf_of
2100
- # 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).
2101
- sig { returns(String) }
2102
- attr_accessor :receipt_email
2103
- # Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
2104
- # method collected by this Checkout Session.
2105
- #
2106
- # When setting this to `on_session`, Checkout will show a notice to the
2107
- # customer that their payment details will be saved.
2108
- #
2109
- # When setting this to `off_session`, Checkout will show a notice to the
2110
- # customer that their payment details will be saved and used for future
2111
- # payments.
2112
- #
2113
- # If a Customer has been provided or Checkout creates a new Customer,
2114
- # Checkout will attach the payment method to the Customer.
2115
- #
2116
- # If Checkout does not create a Customer, the payment method is not attached
2117
- # to a Customer. To reuse the payment method, you can retrieve it from the
2118
- # Checkout Session's PaymentIntent.
2119
- #
2120
- # When processing card payments, Checkout also uses `setup_future_usage`
2121
- # to dynamically optimize your payment flow and comply with regional
2122
- # legislation and network rules, such as SCA.
2123
- sig { returns(String) }
2124
- attr_accessor :setup_future_usage
2125
- # Shipping information for this payment.
2126
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping) }
2127
- attr_accessor :shipping
2128
- # 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).
2129
- #
2130
- # 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.
2131
- sig { returns(String) }
2132
- attr_accessor :statement_descriptor
2133
- # 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.
2134
- sig { returns(String) }
2135
- attr_accessor :statement_descriptor_suffix
2136
- # The parameters used to automatically create a Transfer when the payment succeeds.
2137
- # For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
2138
- sig {
2139
- returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData)
2140
- }
2141
- attr_accessor :transfer_data
2142
- # 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.
2143
- sig { returns(String) }
2144
- attr_accessor :transfer_group
2145
- sig {
2146
- 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::Session::CreateParams::PaymentIntentData::Shipping, statement_descriptor: String, statement_descriptor_suffix: String, transfer_data: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData, transfer_group: String).void
2147
- }
2148
- def initialize(
2149
- application_fee_amount: nil,
2150
- capture_method: nil,
2151
- description: nil,
2152
- metadata: nil,
2153
- on_behalf_of: nil,
2154
- receipt_email: nil,
2155
- setup_future_usage: nil,
2156
- shipping: nil,
2157
- statement_descriptor: nil,
2158
- statement_descriptor_suffix: nil,
2159
- transfer_data: nil,
2160
- transfer_group: nil
2161
- ); end
2162
- end
2163
- class PaymentMethodData < Stripe::RequestParams
2164
- # 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.
2165
- sig { returns(String) }
2166
- attr_accessor :allow_redisplay
2167
- sig { params(allow_redisplay: String).void }
2168
- def initialize(allow_redisplay: nil); end
2169
- end
2170
- class PaymentMethodOptions < Stripe::RequestParams
2171
- class AcssDebit < Stripe::RequestParams
2172
- class MandateOptions < Stripe::RequestParams
2173
- # A URL for custom mandate text to render during confirmation step.
2174
- # The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
2175
- # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
2176
- sig { returns(T.nilable(String)) }
2177
- attr_accessor :custom_mandate_url
2178
- # List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
2179
- sig { returns(T::Array[String]) }
2180
- attr_accessor :default_for
2181
- # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
2182
- sig { returns(String) }
2183
- attr_accessor :interval_description
2184
- # Payment schedule for the mandate.
2185
- sig { returns(String) }
2186
- attr_accessor :payment_schedule
2187
- # Transaction type of the mandate.
2188
- sig { returns(String) }
2189
- attr_accessor :transaction_type
2190
- sig {
2191
- params(custom_mandate_url: T.nilable(String), default_for: T::Array[String], interval_description: String, payment_schedule: String, transaction_type: String).void
2192
- }
2193
- def initialize(
2194
- custom_mandate_url: nil,
2195
- default_for: nil,
2196
- interval_description: nil,
2197
- payment_schedule: nil,
2198
- transaction_type: nil
2199
- ); end
2200
- end
2201
- # 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.
2202
- sig { returns(String) }
2203
- attr_accessor :currency
2204
- # Additional fields for Mandate creation
2205
- sig {
2206
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)
2207
- }
2208
- attr_accessor :mandate_options
2209
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2210
- #
2211
- # 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.
2212
- #
2213
- # 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.
2214
- #
2215
- # 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).
2216
- sig { returns(String) }
2217
- attr_accessor :setup_future_usage
2218
- # Verification method for the intent
2219
- sig { returns(String) }
2220
- attr_accessor :verification_method
2221
- sig {
2222
- params(currency: String, mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: String, verification_method: String).void
2223
- }
2224
- def initialize(
2225
- currency: nil,
2226
- mandate_options: nil,
2227
- setup_future_usage: nil,
2228
- verification_method: nil
2229
- ); end
2230
- end
2231
- class Affirm < Stripe::RequestParams
2232
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2233
- #
2234
- # 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.
2235
- #
2236
- # 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.
2237
- #
2238
- # 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).
2239
- sig { returns(String) }
2240
- attr_accessor :setup_future_usage
2241
- sig { params(setup_future_usage: String).void }
2242
- def initialize(setup_future_usage: nil); end
2243
- end
2244
- class AfterpayClearpay < Stripe::RequestParams
2245
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2246
- #
2247
- # 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.
2248
- #
2249
- # 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.
2250
- #
2251
- # 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).
2252
- sig { returns(String) }
2253
- attr_accessor :setup_future_usage
2254
- sig { params(setup_future_usage: String).void }
2255
- def initialize(setup_future_usage: nil); end
2256
- end
2257
- class Alipay < Stripe::RequestParams
2258
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2259
- #
2260
- # 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.
2261
- #
2262
- # 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.
2263
- #
2264
- # 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).
2265
- sig { returns(String) }
2266
- attr_accessor :setup_future_usage
2267
- sig { params(setup_future_usage: String).void }
2268
- def initialize(setup_future_usage: nil); end
2269
- end
2270
- class AmazonPay < Stripe::RequestParams
2271
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2272
- #
2273
- # 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.
2274
- #
2275
- # 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.
2276
- #
2277
- # 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).
2278
- sig { returns(String) }
2279
- attr_accessor :setup_future_usage
2280
- sig { params(setup_future_usage: String).void }
2281
- def initialize(setup_future_usage: nil); end
2282
- end
2283
- class AuBecsDebit < Stripe::RequestParams
2284
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2285
- #
2286
- # 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.
2287
- #
2288
- # 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.
2289
- #
2290
- # 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).
2291
- sig { returns(String) }
2292
- attr_accessor :setup_future_usage
2293
- sig { params(setup_future_usage: String).void }
2294
- def initialize(setup_future_usage: nil); end
2295
- end
2296
- class BacsDebit < Stripe::RequestParams
2297
- class MandateOptions < Stripe::RequestParams
2298
- # 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'.
2299
- sig { returns(T.nilable(String)) }
2300
- attr_accessor :reference_prefix
2301
- sig { params(reference_prefix: T.nilable(String)).void }
2302
- def initialize(reference_prefix: nil); end
2303
- end
2304
- # Additional fields for Mandate creation
2305
- sig {
2306
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)
2307
- }
2308
- attr_accessor :mandate_options
2309
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2310
- #
2311
- # 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.
2312
- #
2313
- # 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.
2314
- #
2315
- # 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).
2316
- sig { returns(String) }
2317
- attr_accessor :setup_future_usage
2318
- sig {
2319
- params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: String).void
2320
- }
2321
- def initialize(mandate_options: nil, setup_future_usage: nil); end
2322
- end
2323
- class Bancontact < Stripe::RequestParams
2324
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2325
- #
2326
- # 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.
2327
- #
2328
- # 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.
2329
- #
2330
- # 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).
2331
- sig { returns(String) }
2332
- attr_accessor :setup_future_usage
2333
- sig { params(setup_future_usage: String).void }
2334
- def initialize(setup_future_usage: nil); end
2335
- end
2336
- class Boleto < Stripe::RequestParams
2337
- # 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.
2338
- sig { returns(Integer) }
2339
- attr_accessor :expires_after_days
2340
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2341
- #
2342
- # 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.
2343
- #
2344
- # 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.
2345
- #
2346
- # 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).
2347
- sig { returns(String) }
2348
- attr_accessor :setup_future_usage
2349
- sig { params(expires_after_days: Integer, setup_future_usage: String).void }
2350
- def initialize(expires_after_days: nil, setup_future_usage: nil); end
2351
- end
2352
- class Card < Stripe::RequestParams
2353
- class Installments < Stripe::RequestParams
2354
- # Setting to true enables installments for this Checkout Session.
2355
- # Setting to false will prevent any installment plan from applying to a payment.
2356
- sig { returns(T::Boolean) }
2357
- attr_accessor :enabled
2358
- sig { params(enabled: T::Boolean).void }
2359
- def initialize(enabled: nil); end
2360
- end
2361
- # Installment options for card payments
2362
- sig {
2363
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments)
2364
- }
2365
- attr_accessor :installments
2366
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
2367
- sig { returns(String) }
2368
- attr_accessor :request_decremental_authorization
2369
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
2370
- sig { returns(String) }
2371
- attr_accessor :request_extended_authorization
2372
- # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
2373
- sig { returns(String) }
2374
- attr_accessor :request_incremental_authorization
2375
- # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
2376
- sig { returns(String) }
2377
- attr_accessor :request_multicapture
2378
- # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
2379
- sig { returns(String) }
2380
- attr_accessor :request_overcapture
2381
- # 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.
2382
- sig { returns(String) }
2383
- attr_accessor :request_three_d_secure
2384
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2385
- #
2386
- # 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.
2387
- #
2388
- # 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.
2389
- #
2390
- # 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).
2391
- sig { returns(String) }
2392
- attr_accessor :setup_future_usage
2393
- # 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.
2394
- sig { returns(String) }
2395
- attr_accessor :statement_descriptor_suffix_kana
2396
- # 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.
2397
- sig { returns(String) }
2398
- attr_accessor :statement_descriptor_suffix_kanji
2399
- sig {
2400
- params(installments: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments, request_decremental_authorization: String, request_extended_authorization: String, request_incremental_authorization: String, request_multicapture: String, request_overcapture: String, request_three_d_secure: String, setup_future_usage: String, statement_descriptor_suffix_kana: String, statement_descriptor_suffix_kanji: String).void
2401
- }
2402
- def initialize(
2403
- installments: nil,
2404
- request_decremental_authorization: nil,
2405
- request_extended_authorization: nil,
2406
- request_incremental_authorization: nil,
2407
- request_multicapture: nil,
2408
- request_overcapture: nil,
2409
- request_three_d_secure: nil,
2410
- setup_future_usage: nil,
2411
- statement_descriptor_suffix_kana: nil,
2412
- statement_descriptor_suffix_kanji: nil
2413
- ); end
2414
- end
2415
- class Cashapp < Stripe::RequestParams
2416
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2417
- #
2418
- # 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.
2419
- #
2420
- # 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.
2421
- #
2422
- # 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).
2423
- sig { returns(String) }
2424
- attr_accessor :setup_future_usage
2425
- sig { params(setup_future_usage: String).void }
2426
- def initialize(setup_future_usage: nil); end
2427
- end
2428
- class CustomerBalance < Stripe::RequestParams
2429
- class BankTransfer < Stripe::RequestParams
2430
- class EuBankTransfer < Stripe::RequestParams
2431
- # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
2432
- sig { returns(String) }
2433
- attr_accessor :country
2434
- sig { params(country: String).void }
2435
- def initialize(country: nil); end
2436
- end
2437
- # Configuration for eu_bank_transfer funding type.
2438
- sig {
2439
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
2440
- }
2441
- attr_accessor :eu_bank_transfer
2442
- # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
2443
- #
2444
- # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
2445
- sig { returns(T::Array[String]) }
2446
- attr_accessor :requested_address_types
2447
- # The list of bank transfer types that this PaymentIntent is allowed to use for funding.
2448
- sig { returns(String) }
2449
- attr_accessor :type
2450
- sig {
2451
- params(eu_bank_transfer: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, requested_address_types: T::Array[String], type: String).void
2452
- }
2453
- def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
2454
- end
2455
- # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
2456
- sig {
2457
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)
2458
- }
2459
- attr_accessor :bank_transfer
2460
- # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
2461
- sig { returns(String) }
2462
- attr_accessor :funding_type
2463
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2464
- #
2465
- # 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.
2466
- #
2467
- # 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.
2468
- #
2469
- # 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).
2470
- sig { returns(String) }
2471
- attr_accessor :setup_future_usage
2472
- sig {
2473
- params(bank_transfer: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String, setup_future_usage: String).void
2474
- }
2475
- def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
2476
- end
2477
- class Eps < Stripe::RequestParams
2478
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2479
- #
2480
- # 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.
2481
- #
2482
- # 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.
2483
- #
2484
- # 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).
2485
- sig { returns(String) }
2486
- attr_accessor :setup_future_usage
2487
- sig { params(setup_future_usage: String).void }
2488
- def initialize(setup_future_usage: nil); end
2489
- end
2490
- class Fpx < Stripe::RequestParams
2491
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2492
- #
2493
- # 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.
2494
- #
2495
- # 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.
2496
- #
2497
- # 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).
2498
- sig { returns(String) }
2499
- attr_accessor :setup_future_usage
2500
- sig { params(setup_future_usage: String).void }
2501
- def initialize(setup_future_usage: nil); end
2502
- end
2503
- class Giropay < Stripe::RequestParams
2504
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2505
- #
2506
- # 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.
2507
- #
2508
- # 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.
2509
- #
2510
- # 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).
2511
- sig { returns(String) }
2512
- attr_accessor :setup_future_usage
2513
- sig { params(setup_future_usage: String).void }
2514
- def initialize(setup_future_usage: nil); end
2515
- end
2516
- class Grabpay < Stripe::RequestParams
2517
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2518
- #
2519
- # 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.
2520
- #
2521
- # 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.
2522
- #
2523
- # 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).
2524
- sig { returns(String) }
2525
- attr_accessor :setup_future_usage
2526
- sig { params(setup_future_usage: String).void }
2527
- def initialize(setup_future_usage: nil); end
2528
- end
2529
- class Ideal < Stripe::RequestParams
2530
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2531
- #
2532
- # 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.
2533
- #
2534
- # 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.
2535
- #
2536
- # 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).
2537
- sig { returns(String) }
2538
- attr_accessor :setup_future_usage
2539
- sig { params(setup_future_usage: String).void }
2540
- def initialize(setup_future_usage: nil); end
2541
- end
2542
- class KakaoPay < Stripe::RequestParams
2543
- # Controls when the funds will be captured from the customer's account.
2544
- sig { returns(String) }
2545
- attr_accessor :capture_method
2546
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2547
- #
2548
- # 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.
2549
- #
2550
- # 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.
2551
- #
2552
- # 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).
2553
- sig { returns(String) }
2554
- attr_accessor :setup_future_usage
2555
- sig { params(capture_method: String, setup_future_usage: String).void }
2556
- def initialize(capture_method: nil, setup_future_usage: nil); end
2557
- end
2558
- class Klarna < Stripe::RequestParams
2559
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2560
- #
2561
- # 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.
2562
- #
2563
- # 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.
2564
- #
2565
- # 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).
2566
- sig { returns(String) }
2567
- attr_accessor :setup_future_usage
2568
- sig { params(setup_future_usage: String).void }
2569
- def initialize(setup_future_usage: nil); end
2570
- end
2571
- class Konbini < Stripe::RequestParams
2572
- # 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.
2573
- sig { returns(Integer) }
2574
- attr_accessor :expires_after_days
2575
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2576
- #
2577
- # 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.
2578
- #
2579
- # 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.
2580
- #
2581
- # 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).
2582
- sig { returns(String) }
2583
- attr_accessor :setup_future_usage
2584
- sig { params(expires_after_days: Integer, setup_future_usage: String).void }
2585
- def initialize(expires_after_days: nil, setup_future_usage: nil); end
2586
- end
2587
- class KrCard < Stripe::RequestParams
2588
- # Controls when the funds will be captured from the customer's account.
2589
- sig { returns(String) }
2590
- attr_accessor :capture_method
2591
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2592
- #
2593
- # 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.
2594
- #
2595
- # 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.
2596
- #
2597
- # 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).
2598
- sig { returns(String) }
2599
- attr_accessor :setup_future_usage
2600
- sig { params(capture_method: String, setup_future_usage: String).void }
2601
- def initialize(capture_method: nil, setup_future_usage: nil); end
2602
- end
2603
- class Link < Stripe::RequestParams
2604
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2605
- #
2606
- # 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.
2607
- #
2608
- # 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.
2609
- #
2610
- # 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).
2611
- sig { returns(String) }
2612
- attr_accessor :setup_future_usage
2613
- sig { params(setup_future_usage: String).void }
2614
- def initialize(setup_future_usage: nil); end
2615
- end
2616
- class Mobilepay < Stripe::RequestParams
2617
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2618
- #
2619
- # 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.
2620
- #
2621
- # 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.
2622
- #
2623
- # 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).
2624
- sig { returns(String) }
2625
- attr_accessor :setup_future_usage
2626
- sig { params(setup_future_usage: String).void }
2627
- def initialize(setup_future_usage: nil); end
2628
- end
2629
- class Multibanco < Stripe::RequestParams
2630
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2631
- #
2632
- # 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.
2633
- #
2634
- # 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.
2635
- #
2636
- # 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).
2637
- sig { returns(String) }
2638
- attr_accessor :setup_future_usage
2639
- sig { params(setup_future_usage: String).void }
2640
- def initialize(setup_future_usage: nil); end
2641
- end
2642
- class NaverPay < Stripe::RequestParams
2643
- # Controls when the funds will be captured from the customer's account.
2644
- sig { returns(String) }
2645
- attr_accessor :capture_method
2646
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2647
- #
2648
- # 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.
2649
- #
2650
- # 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.
2651
- #
2652
- # 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).
2653
- sig { returns(String) }
2654
- attr_accessor :setup_future_usage
2655
- sig { params(capture_method: String, setup_future_usage: String).void }
2656
- def initialize(capture_method: nil, setup_future_usage: nil); end
2657
- end
2658
- class Oxxo < Stripe::RequestParams
2659
- # 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.
2660
- sig { returns(Integer) }
2661
- attr_accessor :expires_after_days
2662
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2663
- #
2664
- # 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.
2665
- #
2666
- # 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.
2667
- #
2668
- # 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).
2669
- sig { returns(String) }
2670
- attr_accessor :setup_future_usage
2671
- sig { params(expires_after_days: Integer, setup_future_usage: String).void }
2672
- def initialize(expires_after_days: nil, setup_future_usage: nil); end
2673
- end
2674
- class P24 < Stripe::RequestParams
2675
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2676
- #
2677
- # 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.
2678
- #
2679
- # 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.
2680
- #
2681
- # 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).
2682
- sig { returns(String) }
2683
- attr_accessor :setup_future_usage
2684
- # Confirm that the payer has accepted the P24 terms and conditions.
2685
- sig { returns(T::Boolean) }
2686
- attr_accessor :tos_shown_and_accepted
2687
- sig { params(setup_future_usage: String, tos_shown_and_accepted: T::Boolean).void }
2688
- def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
2689
- end
2690
- class PayByBank < Stripe::RequestParams
2691
-
2692
- end
2693
- class Payco < Stripe::RequestParams
2694
- # Controls when the funds will be captured from the customer's account.
2695
- sig { returns(String) }
2696
- attr_accessor :capture_method
2697
- sig { params(capture_method: String).void }
2698
- def initialize(capture_method: nil); end
2699
- end
2700
- class Paynow < Stripe::RequestParams
2701
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2702
- #
2703
- # 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.
2704
- #
2705
- # 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.
2706
- #
2707
- # 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).
2708
- sig { returns(String) }
2709
- attr_accessor :setup_future_usage
2710
- sig { params(setup_future_usage: String).void }
2711
- def initialize(setup_future_usage: nil); end
2712
- end
2713
- class Paypal < Stripe::RequestParams
2714
- # Controls when the funds will be captured from the customer's account.
2715
- sig { returns(T.nilable(String)) }
2716
- attr_accessor :capture_method
2717
- # [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
2718
- sig { returns(String) }
2719
- attr_accessor :preferred_locale
2720
- # 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.
2721
- sig { returns(String) }
2722
- attr_accessor :reference
2723
- # 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.
2724
- sig { returns(String) }
2725
- attr_accessor :reference_id
2726
- # The risk correlation ID for an on-session payment using a saved PayPal payment method.
2727
- sig { returns(String) }
2728
- attr_accessor :risk_correlation_id
2729
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2730
- #
2731
- # 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.
2732
- #
2733
- # 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.
2734
- #
2735
- # 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).
2736
- #
2737
- # 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`.
2738
- sig { returns(T.nilable(String)) }
2739
- attr_accessor :setup_future_usage
2740
- # 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.
2741
- sig { returns(T::Array[String]) }
2742
- attr_accessor :subsellers
2743
- sig {
2744
- 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
2745
- }
2746
- def initialize(
2747
- capture_method: nil,
2748
- preferred_locale: nil,
2749
- reference: nil,
2750
- reference_id: nil,
2751
- risk_correlation_id: nil,
2752
- setup_future_usage: nil,
2753
- subsellers: nil
2754
- ); end
2755
- end
2756
- class Payto < Stripe::RequestParams
2757
- class MandateOptions < Stripe::RequestParams
2758
- # Amount that will be collected. It is required when `amount_type` is `fixed`.
2759
- sig { returns(Integer) }
2760
- attr_accessor :amount
2761
- # 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.
2762
- sig { returns(String) }
2763
- attr_accessor :amount_type
2764
- # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
2765
- sig { returns(String) }
2766
- attr_accessor :end_date
2767
- # The periodicity at which payments will be collected.
2768
- sig { returns(String) }
2769
- attr_accessor :payment_schedule
2770
- # 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.
2771
- sig { returns(Integer) }
2772
- attr_accessor :payments_per_period
2773
- # The purpose for which payments are made. Defaults to retail.
2774
- sig { returns(String) }
2775
- attr_accessor :purpose
2776
- # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
2777
- sig { returns(String) }
2778
- attr_accessor :start_date
2779
- sig {
2780
- params(amount: Integer, amount_type: String, end_date: String, payment_schedule: String, payments_per_period: Integer, purpose: String, start_date: String).void
2781
- }
2782
- def initialize(
2783
- amount: nil,
2784
- amount_type: nil,
2785
- end_date: nil,
2786
- payment_schedule: nil,
2787
- payments_per_period: nil,
2788
- purpose: nil,
2789
- start_date: nil
2790
- ); end
2791
- end
2792
- # Additional fields for Mandate creation
2793
- sig {
2794
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions)
2795
- }
2796
- attr_accessor :mandate_options
2797
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2798
- #
2799
- # 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.
2800
- #
2801
- # 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.
2802
- #
2803
- # 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).
2804
- sig { returns(String) }
2805
- attr_accessor :setup_future_usage
2806
- sig {
2807
- params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions, setup_future_usage: String).void
2808
- }
2809
- def initialize(mandate_options: nil, setup_future_usage: nil); end
2810
- end
2811
- class Pix < Stripe::RequestParams
2812
- # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
2813
- sig { returns(Integer) }
2814
- attr_accessor :expires_after_seconds
2815
- sig { params(expires_after_seconds: Integer).void }
2816
- def initialize(expires_after_seconds: nil); end
2817
- end
2818
- class RevolutPay < Stripe::RequestParams
2819
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2820
- #
2821
- # 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.
2822
- #
2823
- # 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.
2824
- #
2825
- # 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).
2826
- sig { returns(String) }
2827
- attr_accessor :setup_future_usage
2828
- sig { params(setup_future_usage: String).void }
2829
- def initialize(setup_future_usage: nil); end
2830
- end
2831
- class SamsungPay < Stripe::RequestParams
2832
- # Controls when the funds will be captured from the customer's account.
2833
- sig { returns(String) }
2834
- attr_accessor :capture_method
2835
- sig { params(capture_method: String).void }
2836
- def initialize(capture_method: nil); end
2837
- end
2838
- class SepaDebit < Stripe::RequestParams
2839
- class MandateOptions < Stripe::RequestParams
2840
- # 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'.
2841
- sig { returns(T.nilable(String)) }
2842
- attr_accessor :reference_prefix
2843
- sig { params(reference_prefix: T.nilable(String)).void }
2844
- def initialize(reference_prefix: nil); end
2845
- end
2846
- # Additional fields for Mandate creation
2847
- sig {
2848
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)
2849
- }
2850
- attr_accessor :mandate_options
2851
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2852
- #
2853
- # 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.
2854
- #
2855
- # 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.
2856
- #
2857
- # 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).
2858
- sig { returns(String) }
2859
- attr_accessor :setup_future_usage
2860
- sig {
2861
- params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: String).void
2862
- }
2863
- def initialize(mandate_options: nil, setup_future_usage: nil); end
2864
- end
2865
- class Sofort < Stripe::RequestParams
2866
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2867
- #
2868
- # 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.
2869
- #
2870
- # 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.
2871
- #
2872
- # 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).
2873
- sig { returns(String) }
2874
- attr_accessor :setup_future_usage
2875
- sig { params(setup_future_usage: String).void }
2876
- def initialize(setup_future_usage: nil); end
2877
- end
2878
- class Swish < Stripe::RequestParams
2879
- # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
2880
- sig { returns(String) }
2881
- attr_accessor :reference
2882
- sig { params(reference: String).void }
2883
- def initialize(reference: nil); end
2884
- end
2885
- class UsBankAccount < Stripe::RequestParams
2886
- class FinancialConnections < Stripe::RequestParams
2887
- # 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`.
2888
- sig { returns(T::Array[String]) }
2889
- attr_accessor :permissions
2890
- # List of data features that you would like to retrieve upon account creation.
2891
- sig { returns(T::Array[String]) }
2892
- attr_accessor :prefetch
2893
- sig { params(permissions: T::Array[String], prefetch: T::Array[String]).void }
2894
- def initialize(permissions: nil, prefetch: nil); end
2895
- end
2896
- # Additional fields for Financial Connections Session creation
2897
- sig {
2898
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)
2899
- }
2900
- attr_accessor :financial_connections
2901
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2902
- #
2903
- # 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.
2904
- #
2905
- # 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.
2906
- #
2907
- # 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).
2908
- sig { returns(String) }
2909
- attr_accessor :setup_future_usage
2910
- # Verification method for the intent
2911
- sig { returns(String) }
2912
- attr_accessor :verification_method
2913
- sig {
2914
- params(financial_connections: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, setup_future_usage: String, verification_method: String).void
2915
- }
2916
- def initialize(
2917
- financial_connections: nil,
2918
- setup_future_usage: nil,
2919
- verification_method: nil
2920
- ); end
2921
- end
2922
- class WechatPay < Stripe::RequestParams
2923
- # The app ID registered with WeChat Pay. Only required when client is ios or android.
2924
- sig { returns(String) }
2925
- attr_accessor :app_id
2926
- # The client type that the end customer will pay from
2927
- sig { returns(String) }
2928
- attr_accessor :client
2929
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2930
- #
2931
- # 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.
2932
- #
2933
- # 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.
2934
- #
2935
- # 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).
2936
- sig { returns(String) }
2937
- attr_accessor :setup_future_usage
2938
- sig { params(app_id: String, client: String, setup_future_usage: String).void }
2939
- def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
2940
- end
2941
- # contains details about the ACSS Debit payment method options.
2942
- sig {
2943
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit)
2944
- }
2945
- attr_accessor :acss_debit
2946
- # contains details about the Affirm payment method options.
2947
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm) }
2948
- attr_accessor :affirm
2949
- # contains details about the Afterpay Clearpay payment method options.
2950
- sig {
2951
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay)
2952
- }
2953
- attr_accessor :afterpay_clearpay
2954
- # contains details about the Alipay payment method options.
2955
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay) }
2956
- attr_accessor :alipay
2957
- # contains details about the AmazonPay payment method options.
2958
- sig {
2959
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay)
2960
- }
2961
- attr_accessor :amazon_pay
2962
- # contains details about the AU Becs Debit payment method options.
2963
- sig {
2964
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit)
2965
- }
2966
- attr_accessor :au_becs_debit
2967
- # contains details about the Bacs Debit payment method options.
2968
- sig {
2969
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit)
2970
- }
2971
- attr_accessor :bacs_debit
2972
- # contains details about the Bancontact payment method options.
2973
- sig {
2974
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact)
2975
- }
2976
- attr_accessor :bancontact
2977
- # contains details about the Boleto payment method options.
2978
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto) }
2979
- attr_accessor :boleto
2980
- # contains details about the Card payment method options.
2981
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card) }
2982
- attr_accessor :card
2983
- # contains details about the Cashapp Pay payment method options.
2984
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp) }
2985
- attr_accessor :cashapp
2986
- # contains details about the Customer Balance payment method options.
2987
- sig {
2988
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance)
2989
- }
2990
- attr_accessor :customer_balance
2991
- # contains details about the EPS payment method options.
2992
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps) }
2993
- attr_accessor :eps
2994
- # contains details about the FPX payment method options.
2995
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx) }
2996
- attr_accessor :fpx
2997
- # contains details about the Giropay payment method options.
2998
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay) }
2999
- attr_accessor :giropay
3000
- # contains details about the Grabpay payment method options.
3001
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay) }
3002
- attr_accessor :grabpay
3003
- # contains details about the Ideal payment method options.
3004
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal) }
3005
- attr_accessor :ideal
3006
- # contains details about the Kakao Pay payment method options.
3007
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay) }
3008
- attr_accessor :kakao_pay
3009
- # contains details about the Klarna payment method options.
3010
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna) }
3011
- attr_accessor :klarna
3012
- # contains details about the Konbini payment method options.
3013
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini) }
3014
- attr_accessor :konbini
3015
- # contains details about the Korean card payment method options.
3016
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard) }
3017
- attr_accessor :kr_card
3018
- # contains details about the Link payment method options.
3019
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link) }
3020
- attr_accessor :link
3021
- # contains details about the Mobilepay payment method options.
3022
- sig {
3023
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay)
3024
- }
3025
- attr_accessor :mobilepay
3026
- # contains details about the Multibanco payment method options.
3027
- sig {
3028
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco)
3029
- }
3030
- attr_accessor :multibanco
3031
- # contains details about the Naver Pay payment method options.
3032
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay) }
3033
- attr_accessor :naver_pay
3034
- # contains details about the OXXO payment method options.
3035
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo) }
3036
- attr_accessor :oxxo
3037
- # contains details about the P24 payment method options.
3038
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24) }
3039
- attr_accessor :p24
3040
- # contains details about the Pay By Bank payment method options.
3041
- sig {
3042
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::PayByBank)
3043
- }
3044
- attr_accessor :pay_by_bank
3045
- # contains details about the PAYCO payment method options.
3046
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco) }
3047
- attr_accessor :payco
3048
- # contains details about the PayNow payment method options.
3049
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow) }
3050
- attr_accessor :paynow
3051
- # contains details about the PayPal payment method options.
3052
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal) }
3053
- attr_accessor :paypal
3054
- # contains details about the PayTo payment method options.
3055
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto) }
3056
- attr_accessor :payto
3057
- # contains details about the Pix payment method options.
3058
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix) }
3059
- attr_accessor :pix
3060
- # contains details about the RevolutPay payment method options.
3061
- sig {
3062
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay)
3063
- }
3064
- attr_accessor :revolut_pay
3065
- # contains details about the Samsung Pay payment method options.
3066
- sig {
3067
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay)
3068
- }
3069
- attr_accessor :samsung_pay
3070
- # contains details about the Sepa Debit payment method options.
3071
- sig {
3072
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit)
3073
- }
3074
- attr_accessor :sepa_debit
3075
- # contains details about the Sofort payment method options.
3076
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort) }
3077
- attr_accessor :sofort
3078
- # contains details about the Swish payment method options.
3079
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish) }
3080
- attr_accessor :swish
3081
- # contains details about the Us Bank Account payment method options.
3082
- sig {
3083
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount)
3084
- }
3085
- attr_accessor :us_bank_account
3086
- # contains details about the WeChat Pay payment method options.
3087
- sig {
3088
- returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay)
3089
- }
3090
- attr_accessor :wechat_pay
3091
- sig {
3092
- params(acss_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit, affirm: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm, afterpay_clearpay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay, alipay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay, amazon_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay, au_becs_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit, bacs_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit, bancontact: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact, boleto: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto, card: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card, cashapp: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp, customer_balance: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance, eps: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps, fpx: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx, giropay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay, grabpay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay, ideal: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal, kakao_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay, klarna: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna, konbini: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini, kr_card: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard, link: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link, mobilepay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay, multibanco: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco, naver_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay, oxxo: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo, p24: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24, pay_by_bank: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::PayByBank, payco: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco, paynow: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow, paypal: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal, payto: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto, pix: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix, revolut_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay, samsung_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay, sepa_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit, sofort: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort, swish: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish, us_bank_account: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount, wechat_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay).void
3093
- }
3094
- def initialize(
3095
- acss_debit: nil,
3096
- affirm: nil,
3097
- afterpay_clearpay: nil,
3098
- alipay: nil,
3099
- amazon_pay: nil,
3100
- au_becs_debit: nil,
3101
- bacs_debit: nil,
3102
- bancontact: nil,
3103
- boleto: nil,
3104
- card: nil,
3105
- cashapp: nil,
3106
- customer_balance: nil,
3107
- eps: nil,
3108
- fpx: nil,
3109
- giropay: nil,
3110
- grabpay: nil,
3111
- ideal: nil,
3112
- kakao_pay: nil,
3113
- klarna: nil,
3114
- konbini: nil,
3115
- kr_card: nil,
3116
- link: nil,
3117
- mobilepay: nil,
3118
- multibanco: nil,
3119
- naver_pay: nil,
3120
- oxxo: nil,
3121
- p24: nil,
3122
- pay_by_bank: nil,
3123
- payco: nil,
3124
- paynow: nil,
3125
- paypal: nil,
3126
- payto: nil,
3127
- pix: nil,
3128
- revolut_pay: nil,
3129
- samsung_pay: nil,
3130
- sepa_debit: nil,
3131
- sofort: nil,
3132
- swish: nil,
3133
- us_bank_account: nil,
3134
- wechat_pay: nil
3135
- ); end
3136
- end
3137
- class Permissions < Stripe::RequestParams
3138
- class Update < Stripe::RequestParams
3139
- # Determines which entity is allowed to update the line items.
3140
- #
3141
- # 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.
3142
- #
3143
- # 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.
3144
- sig { returns(String) }
3145
- attr_accessor :line_items
3146
- # Determines which entity is allowed to update the shipping details.
3147
- #
3148
- # 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.
3149
- #
3150
- # 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.
3151
- sig { returns(String) }
3152
- attr_accessor :shipping_details
3153
- sig { params(line_items: String, shipping_details: String).void }
3154
- def initialize(line_items: nil, shipping_details: nil); end
3155
- end
3156
- # Permissions for updating the Checkout Session.
3157
- sig { returns(::Stripe::Checkout::Session::CreateParams::Permissions::Update) }
3158
- attr_accessor :update
3159
- sig {
3160
- params(update: ::Stripe::Checkout::Session::CreateParams::Permissions::Update).void
3161
- }
3162
- def initialize(update: nil); end
3163
- end
3164
- class PhoneNumberCollection < Stripe::RequestParams
3165
- # Set to `true` to enable phone number collection.
3166
- #
3167
- # Can only be set in `payment` and `subscription` mode.
3168
- sig { returns(T::Boolean) }
3169
- attr_accessor :enabled
3170
- sig { params(enabled: T::Boolean).void }
3171
- def initialize(enabled: nil); end
3172
- end
3173
- class SavedPaymentMethodOptions < Stripe::RequestParams
3174
- # 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.
3175
- sig { returns(T::Array[String]) }
3176
- attr_accessor :allow_redisplay_filters
3177
- # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
3178
- sig { returns(String) }
3179
- attr_accessor :payment_method_save
3180
- sig {
3181
- params(allow_redisplay_filters: T::Array[String], payment_method_save: String).void
3182
- }
3183
- def initialize(allow_redisplay_filters: nil, payment_method_save: nil); end
3184
- end
3185
- class SetupIntentData < Stripe::RequestParams
3186
- # An arbitrary string attached to the object. Often useful for displaying to users.
3187
- sig { returns(String) }
3188
- attr_accessor :description
3189
- # 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`.
3190
- sig { returns(T::Hash[String, String]) }
3191
- attr_accessor :metadata
3192
- # The Stripe account for which the setup is intended.
3193
- sig { returns(String) }
3194
- attr_accessor :on_behalf_of
3195
- sig {
3196
- params(description: String, metadata: T::Hash[String, String], on_behalf_of: String).void
3197
- }
3198
- def initialize(description: nil, metadata: nil, on_behalf_of: nil); end
3199
- end
3200
- class ShippingAddressCollection < Stripe::RequestParams
3201
- # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
3202
- # shipping locations.
3203
- sig { returns(T::Array[String]) }
3204
- attr_accessor :allowed_countries
3205
- sig { params(allowed_countries: T::Array[String]).void }
3206
- def initialize(allowed_countries: nil); end
3207
- end
3208
- class ShippingOption < Stripe::RequestParams
3209
- class ShippingRateData < Stripe::RequestParams
3210
- class DeliveryEstimate < Stripe::RequestParams
3211
- class Maximum < Stripe::RequestParams
3212
- # A unit of time.
3213
- sig { returns(String) }
3214
- attr_accessor :unit
3215
- # Must be greater than 0.
3216
- sig { returns(Integer) }
3217
- attr_accessor :value
3218
- sig { params(unit: String, value: Integer).void }
3219
- def initialize(unit: nil, value: nil); end
3220
- end
3221
- class Minimum < Stripe::RequestParams
3222
- # A unit of time.
3223
- sig { returns(String) }
3224
- attr_accessor :unit
3225
- # Must be greater than 0.
3226
- sig { returns(Integer) }
3227
- attr_accessor :value
3228
- sig { params(unit: String, value: Integer).void }
3229
- def initialize(unit: nil, value: nil); end
3230
- end
3231
- # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
3232
- sig {
3233
- returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
3234
- }
3235
- attr_accessor :maximum
3236
- # The lower bound of the estimated range. If empty, represents no lower bound.
3237
- sig {
3238
- returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
3239
- }
3240
- attr_accessor :minimum
3241
- sig {
3242
- params(maximum: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
3243
- }
3244
- def initialize(maximum: nil, minimum: nil); end
3245
- end
3246
- class FixedAmount < Stripe::RequestParams
3247
- class CurrencyOptions < Stripe::RequestParams
3248
- # A non-negative integer in cents representing how much to charge.
3249
- sig { returns(Integer) }
3250
- attr_accessor :amount
3251
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3252
- sig { returns(String) }
3253
- attr_accessor :tax_behavior
3254
- sig { params(amount: Integer, tax_behavior: String).void }
3255
- def initialize(amount: nil, tax_behavior: nil); end
3256
- end
3257
- # A non-negative integer in cents representing how much to charge.
3258
- sig { returns(Integer) }
3259
- attr_accessor :amount
3260
- # 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).
3261
- sig { returns(String) }
3262
- attr_accessor :currency
3263
- # 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).
3264
- sig {
3265
- returns(T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
3266
- }
3267
- attr_accessor :currency_options
3268
- sig {
3269
- params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
3270
- }
3271
- def initialize(amount: nil, currency: nil, currency_options: nil); end
3272
- end
3273
- # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
3274
- sig {
3275
- returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
3276
- }
3277
- attr_accessor :delivery_estimate
3278
- # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
3279
- sig { returns(String) }
3280
- attr_accessor :display_name
3281
- # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
3282
- sig {
3283
- returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount)
3284
- }
3285
- attr_accessor :fixed_amount
3286
- # 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`.
3287
- sig { returns(T::Hash[String, String]) }
3288
- attr_accessor :metadata
3289
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3290
- sig { returns(String) }
3291
- attr_accessor :tax_behavior
3292
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
3293
- sig { returns(String) }
3294
- attr_accessor :tax_code
3295
- # The type of calculation to use on the shipping rate.
3296
- sig { returns(String) }
3297
- attr_accessor :type
3298
- sig {
3299
- params(delivery_estimate: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
3300
- }
3301
- def initialize(
3302
- delivery_estimate: nil,
3303
- display_name: nil,
3304
- fixed_amount: nil,
3305
- metadata: nil,
3306
- tax_behavior: nil,
3307
- tax_code: nil,
3308
- type: nil
3309
- ); end
3310
- end
3311
- # The ID of the Shipping Rate to use for this shipping option.
3312
- sig { returns(String) }
3313
- attr_accessor :shipping_rate
3314
- # Parameters to be passed to Shipping Rate creation for this shipping option.
3315
- sig {
3316
- returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData)
3317
- }
3318
- attr_accessor :shipping_rate_data
3319
- sig {
3320
- params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData).void
3321
- }
3322
- def initialize(shipping_rate: nil, shipping_rate_data: nil); end
3323
- end
3324
- class SubscriptionData < Stripe::RequestParams
3325
- class InvoiceSettings < Stripe::RequestParams
3326
- class Issuer < Stripe::RequestParams
3327
- # The connected account being referenced when `type` is `account`.
3328
- sig { returns(String) }
3329
- attr_accessor :account
3330
- # Type of the account referenced in the request.
3331
- sig { returns(String) }
3332
- attr_accessor :type
3333
- sig { params(account: String, type: String).void }
3334
- def initialize(account: nil, type: nil); end
3335
- end
3336
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
3337
- sig {
3338
- returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer)
3339
- }
3340
- attr_accessor :issuer
3341
- sig {
3342
- params(issuer: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer).void
3343
- }
3344
- def initialize(issuer: nil); end
3345
- end
3346
- class TransferData < Stripe::RequestParams
3347
- # 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.
3348
- sig { returns(Float) }
3349
- attr_accessor :amount_percent
3350
- # ID of an existing, connected Stripe account.
3351
- sig { returns(String) }
3352
- attr_accessor :destination
3353
- sig { params(amount_percent: Float, destination: String).void }
3354
- def initialize(amount_percent: nil, destination: nil); end
3355
- end
3356
- class TrialSettings < Stripe::RequestParams
3357
- class EndBehavior < Stripe::RequestParams
3358
- # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
3359
- sig { returns(String) }
3360
- attr_accessor :missing_payment_method
3361
- sig { params(missing_payment_method: String).void }
3362
- def initialize(missing_payment_method: nil); end
3363
- end
3364
- # Defines how the subscription should behave when the user's free trial ends.
3365
- sig {
3366
- returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
3367
- }
3368
- attr_accessor :end_behavior
3369
- sig {
3370
- params(end_behavior: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
3371
- }
3372
- def initialize(end_behavior: nil); end
3373
- end
3374
- # 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).
3375
- sig { returns(Float) }
3376
- attr_accessor :application_fee_percent
3377
- # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
3378
- sig { returns(Integer) }
3379
- attr_accessor :billing_cycle_anchor
3380
- # The tax rates that will apply to any subscription item that does not have
3381
- # `tax_rates` set. Invoices created will have their `default_tax_rates` populated
3382
- # from the subscription.
3383
- sig { returns(T::Array[String]) }
3384
- attr_accessor :default_tax_rates
3385
- # The subscription's description, meant to be displayable to the customer.
3386
- # Use this field to optionally store an explanation of the subscription
3387
- # for rendering in the [customer portal](https://stripe.com/docs/customer-management).
3388
- sig { returns(String) }
3389
- attr_accessor :description
3390
- # All invoices will be billed using the specified settings.
3391
- sig {
3392
- returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings)
3393
- }
3394
- attr_accessor :invoice_settings
3395
- # 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`.
3396
- sig { returns(T::Hash[String, String]) }
3397
- attr_accessor :metadata
3398
- # The account on behalf of which to charge, for each of the subscription's invoices.
3399
- sig { returns(String) }
3400
- attr_accessor :on_behalf_of
3401
- # Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
3402
- sig { returns(String) }
3403
- attr_accessor :proration_behavior
3404
- # 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.
3405
- sig { returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData) }
3406
- attr_accessor :transfer_data
3407
- # Unix timestamp representing the end of the trial period the customer
3408
- # will get before being charged for the first time. Has to be at least
3409
- # 48 hours in the future.
3410
- sig { returns(Integer) }
3411
- attr_accessor :trial_end
3412
- # Integer representing the number of trial period days before the
3413
- # customer is charged for the first time. Has to be at least 1.
3414
- sig { returns(Integer) }
3415
- attr_accessor :trial_period_days
3416
- # Settings related to subscription trials.
3417
- sig {
3418
- returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings)
3419
- }
3420
- attr_accessor :trial_settings
3421
- sig {
3422
- params(application_fee_percent: Float, billing_cycle_anchor: Integer, default_tax_rates: T::Array[String], description: String, invoice_settings: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings, metadata: T::Hash[String, String], on_behalf_of: String, proration_behavior: String, transfer_data: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData, trial_end: Integer, trial_period_days: Integer, trial_settings: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings).void
3423
- }
3424
- def initialize(
3425
- application_fee_percent: nil,
3426
- billing_cycle_anchor: nil,
3427
- default_tax_rates: nil,
3428
- description: nil,
3429
- invoice_settings: nil,
3430
- metadata: nil,
3431
- on_behalf_of: nil,
3432
- proration_behavior: nil,
3433
- transfer_data: nil,
3434
- trial_end: nil,
3435
- trial_period_days: nil,
3436
- trial_settings: nil
3437
- ); end
3438
- end
3439
- class TaxIdCollection < Stripe::RequestParams
3440
- # Enable tax ID collection during checkout. Defaults to `false`.
3441
- sig { returns(T::Boolean) }
3442
- attr_accessor :enabled
3443
- # Describes whether a tax ID is required during checkout. Defaults to `never`.
3444
- sig { returns(String) }
3445
- attr_accessor :required
3446
- sig { params(enabled: T::Boolean, required: String).void }
3447
- def initialize(enabled: nil, required: nil); end
3448
- end
3449
- # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
3450
- sig { returns(::Stripe::Checkout::Session::CreateParams::AdaptivePricing) }
3451
- attr_accessor :adaptive_pricing
3452
- # Configure actions after a Checkout Session has expired.
3453
- sig { returns(::Stripe::Checkout::Session::CreateParams::AfterExpiration) }
3454
- attr_accessor :after_expiration
3455
- # Enables user redeemable promotion codes.
3456
- sig { returns(T::Boolean) }
3457
- attr_accessor :allow_promotion_codes
3458
- # Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
3459
- sig { returns(::Stripe::Checkout::Session::CreateParams::AutomaticTax) }
3460
- attr_accessor :automatic_tax
3461
- # Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
3462
- sig { returns(String) }
3463
- attr_accessor :billing_address_collection
3464
- # 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`.
3465
- sig { returns(String) }
3466
- attr_accessor :cancel_url
3467
- # A unique string to reference the Checkout Session. This can be a
3468
- # customer ID, a cart ID, or similar, and can be used to reconcile the
3469
- # session with your internal systems.
3470
- sig { returns(String) }
3471
- attr_accessor :client_reference_id
3472
- # Configure fields for the Checkout Session to gather active consent from customers.
3473
- sig { returns(::Stripe::Checkout::Session::CreateParams::ConsentCollection) }
3474
- attr_accessor :consent_collection
3475
- # 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.
3476
- sig { returns(String) }
3477
- attr_accessor :currency
3478
- # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
3479
- sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField]) }
3480
- attr_accessor :custom_fields
3481
- # Display additional text for your customers using custom text.
3482
- sig { returns(::Stripe::Checkout::Session::CreateParams::CustomText) }
3483
- attr_accessor :custom_text
3484
- # ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
3485
- # payment method will be used to prefill the email, name, card details, and billing address
3486
- # 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)
3487
- # 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.
3488
- #
3489
- # 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.
3490
- # If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
3491
- #
3492
- # 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.
3493
- #
3494
- # 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.
3495
- sig { returns(String) }
3496
- attr_accessor :customer
3497
- # Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
3498
- #
3499
- # When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
3500
- # with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
3501
- #
3502
- # Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
3503
- # in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
3504
- #
3505
- # Can only be set in `payment` and `setup` mode.
3506
- sig { returns(String) }
3507
- attr_accessor :customer_creation
3508
- # If provided, this value will be used when the Customer object is created.
3509
- # If not provided, customers will be asked to enter their email address.
3510
- # Use this parameter to prefill customer data if you already have an email
3511
- # on file. To access information about the customer once a session is
3512
- # complete, use the `customer` field.
3513
- sig { returns(String) }
3514
- attr_accessor :customer_email
3515
- # Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
3516
- sig { returns(::Stripe::Checkout::Session::CreateParams::CustomerUpdate) }
3517
- attr_accessor :customer_update
3518
- # The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
3519
- sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::Discount]) }
3520
- attr_accessor :discounts
3521
- # Specifies which fields in the response should be expanded.
3522
- sig { returns(T::Array[String]) }
3523
- attr_accessor :expand
3524
- # 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.
3525
- sig { returns(Integer) }
3526
- attr_accessor :expires_at
3527
- # Generate a post-purchase Invoice for one-time payments.
3528
- sig { returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation) }
3529
- attr_accessor :invoice_creation
3530
- # A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
3531
- #
3532
- # 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.
3533
- #
3534
- # 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.
3535
- sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::LineItem]) }
3536
- attr_accessor :line_items
3537
- # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
3538
- sig { returns(String) }
3539
- attr_accessor :locale
3540
- # 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`.
3541
- sig { returns(T::Hash[String, String]) }
3542
- attr_accessor :metadata
3543
- # The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
3544
- sig { returns(String) }
3545
- attr_accessor :mode
3546
- # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
3547
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData) }
3548
- attr_accessor :payment_intent_data
3549
- # 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.
3550
- # This may occur if the Checkout Session includes a free trial or a discount.
3551
- #
3552
- # Can only be set in `subscription` mode. Defaults to `always`.
3553
- #
3554
- # 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).
3555
- sig { returns(String) }
3556
- attr_accessor :payment_method_collection
3557
- # The ID of the payment method configuration to use with this Checkout session.
3558
- sig { returns(String) }
3559
- attr_accessor :payment_method_configuration
3560
- # This parameter allows you to set some attributes on the payment method created during a Checkout session.
3561
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodData) }
3562
- attr_accessor :payment_method_data
3563
- # Payment-method-specific configuration.
3564
- sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions) }
3565
- attr_accessor :payment_method_options
3566
- # A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
3567
- #
3568
- # You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
3569
- # See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
3570
- #
3571
- # Read more about the supported payment methods and their requirements in our [payment
3572
- # method details guide](/docs/payments/checkout/payment-methods).
3573
- #
3574
- # If multiple payment methods are passed, Checkout will dynamically reorder them to
3575
- # prioritize the most relevant payment methods based on the customer's location and
3576
- # other characteristics.
3577
- sig { returns(T::Array[String]) }
3578
- attr_accessor :payment_method_types
3579
- # This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
3580
- #
3581
- # For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
3582
- sig { returns(::Stripe::Checkout::Session::CreateParams::Permissions) }
3583
- attr_accessor :permissions
3584
- # Controls phone number collection settings for the session.
3585
- #
3586
- # We recommend that you review your privacy policy and check with your legal contacts
3587
- # before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
3588
- sig { returns(::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection) }
3589
- attr_accessor :phone_number_collection
3590
- # 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`.
3591
- sig { returns(String) }
3592
- attr_accessor :redirect_on_completion
3593
- # The URL to redirect your customer back to after they authenticate or cancel their payment on the
3594
- # payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
3595
- # and redirect-based payment methods are enabled on the session.
3596
- sig { returns(String) }
3597
- attr_accessor :return_url
3598
- # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
3599
- sig { returns(::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions) }
3600
- attr_accessor :saved_payment_method_options
3601
- # A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
3602
- sig { returns(::Stripe::Checkout::Session::CreateParams::SetupIntentData) }
3603
- attr_accessor :setup_intent_data
3604
- # When set, provides configuration for Checkout to collect a shipping address from a customer.
3605
- sig { returns(::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection) }
3606
- attr_accessor :shipping_address_collection
3607
- # The shipping rate options to apply to this Session. Up to a maximum of 5.
3608
- sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption]) }
3609
- attr_accessor :shipping_options
3610
- # Describes the type of transaction being performed by Checkout in order to customize
3611
- # relevant text on the page, such as the submit button. `submit_type` can only be
3612
- # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
3613
- sig { returns(String) }
3614
- attr_accessor :submit_type
3615
- # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
3616
- sig { returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData) }
3617
- attr_accessor :subscription_data
3618
- # The URL to which Stripe should send customers when payment or setup
3619
- # is complete.
3620
- # This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
3621
- # information from the successful Checkout Session on your page, read the
3622
- # guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
3623
- sig { returns(String) }
3624
- attr_accessor :success_url
3625
- # Controls tax ID collection during checkout.
3626
- sig { returns(::Stripe::Checkout::Session::CreateParams::TaxIdCollection) }
3627
- attr_accessor :tax_id_collection
3628
- # The UI mode of the Session. Defaults to `hosted`.
3629
- sig { returns(String) }
3630
- attr_accessor :ui_mode
3631
- sig {
3632
- params(adaptive_pricing: ::Stripe::Checkout::Session::CreateParams::AdaptivePricing, after_expiration: ::Stripe::Checkout::Session::CreateParams::AfterExpiration, allow_promotion_codes: T::Boolean, automatic_tax: ::Stripe::Checkout::Session::CreateParams::AutomaticTax, billing_address_collection: String, cancel_url: String, client_reference_id: String, consent_collection: ::Stripe::Checkout::Session::CreateParams::ConsentCollection, currency: String, custom_fields: T::Array[::Stripe::Checkout::Session::CreateParams::CustomField], custom_text: ::Stripe::Checkout::Session::CreateParams::CustomText, customer: String, customer_creation: String, customer_email: String, customer_update: ::Stripe::Checkout::Session::CreateParams::CustomerUpdate, discounts: T::Array[::Stripe::Checkout::Session::CreateParams::Discount], expand: T::Array[String], expires_at: Integer, invoice_creation: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation, line_items: T::Array[::Stripe::Checkout::Session::CreateParams::LineItem], locale: String, metadata: T::Hash[String, String], mode: String, payment_intent_data: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData, payment_method_collection: String, payment_method_configuration: String, payment_method_data: ::Stripe::Checkout::Session::CreateParams::PaymentMethodData, payment_method_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions, payment_method_types: T::Array[String], permissions: ::Stripe::Checkout::Session::CreateParams::Permissions, phone_number_collection: ::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection, redirect_on_completion: String, return_url: String, saved_payment_method_options: ::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions, setup_intent_data: ::Stripe::Checkout::Session::CreateParams::SetupIntentData, shipping_address_collection: ::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection, shipping_options: T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption], submit_type: String, subscription_data: ::Stripe::Checkout::Session::CreateParams::SubscriptionData, success_url: String, tax_id_collection: ::Stripe::Checkout::Session::CreateParams::TaxIdCollection, ui_mode: String).void
3633
- }
3634
- def initialize(
3635
- adaptive_pricing: nil,
3636
- after_expiration: nil,
3637
- allow_promotion_codes: nil,
3638
- automatic_tax: nil,
3639
- billing_address_collection: nil,
3640
- cancel_url: nil,
3641
- client_reference_id: nil,
3642
- consent_collection: nil,
3643
- currency: nil,
3644
- custom_fields: nil,
3645
- custom_text: nil,
3646
- customer: nil,
3647
- customer_creation: nil,
3648
- customer_email: nil,
3649
- customer_update: nil,
3650
- discounts: nil,
3651
- expand: nil,
3652
- expires_at: nil,
3653
- invoice_creation: nil,
3654
- line_items: nil,
3655
- locale: nil,
3656
- metadata: nil,
3657
- mode: nil,
3658
- payment_intent_data: nil,
3659
- payment_method_collection: nil,
3660
- payment_method_configuration: nil,
3661
- payment_method_data: nil,
3662
- payment_method_options: nil,
3663
- payment_method_types: nil,
3664
- permissions: nil,
3665
- phone_number_collection: nil,
3666
- redirect_on_completion: nil,
3667
- return_url: nil,
3668
- saved_payment_method_options: nil,
3669
- setup_intent_data: nil,
3670
- shipping_address_collection: nil,
3671
- shipping_options: nil,
3672
- submit_type: nil,
3673
- subscription_data: nil,
3674
- success_url: nil,
3675
- tax_id_collection: nil,
3676
- ui_mode: nil
3677
- ); end
3678
- end
3679
- class RetrieveParams < Stripe::RequestParams
3680
- # Specifies which fields in the response should be expanded.
3681
- sig { returns(T::Array[String]) }
3682
- attr_accessor :expand
3683
- sig { params(expand: T::Array[String]).void }
3684
- def initialize(expand: nil); end
3685
- end
3686
- class UpdateParams < Stripe::RequestParams
3687
- class CollectedInformation < Stripe::RequestParams
3688
- class ShippingDetails < Stripe::RequestParams
3689
- class Address < Stripe::RequestParams
3690
- # City, district, suburb, town, or village.
3691
- sig { returns(String) }
3692
- attr_accessor :city
3693
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3694
- sig { returns(String) }
3695
- attr_accessor :country
3696
- # Address line 1 (e.g., street, PO Box, or company name).
3697
- sig { returns(String) }
3698
- attr_accessor :line1
3699
- # Address line 2 (e.g., apartment, suite, unit, or building).
3700
- sig { returns(String) }
3701
- attr_accessor :line2
3702
- # ZIP or postal code.
3703
- sig { returns(String) }
3704
- attr_accessor :postal_code
3705
- # State, county, province, or region.
3706
- sig { returns(String) }
3707
- attr_accessor :state
3708
- sig {
3709
- params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
3710
- }
3711
- def initialize(
3712
- city: nil,
3713
- country: nil,
3714
- line1: nil,
3715
- line2: nil,
3716
- postal_code: nil,
3717
- state: nil
3718
- ); end
3719
- end
3720
- # The address of the customer
3721
- sig {
3722
- returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address)
3723
- }
3724
- attr_accessor :address
3725
- # The name of customer
3726
- sig { returns(String) }
3727
- attr_accessor :name
3728
- sig {
3729
- params(address: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address, name: String).void
3730
- }
3731
- def initialize(address: nil, name: nil); end
3732
- end
3733
- # The shipping details to apply to this Session.
3734
- sig {
3735
- returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails)
3736
- }
3737
- attr_accessor :shipping_details
3738
- sig {
3739
- params(shipping_details: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails).void
3740
- }
3741
- def initialize(shipping_details: nil); end
3742
- end
3743
- class LineItem < Stripe::RequestParams
3744
- class AdjustableQuantity < Stripe::RequestParams
3745
- # Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
3746
- sig { returns(T::Boolean) }
3747
- attr_accessor :enabled
3748
- # 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.
3749
- sig { returns(Integer) }
3750
- attr_accessor :maximum
3751
- # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
3752
- sig { returns(Integer) }
3753
- attr_accessor :minimum
3754
- sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
3755
- def initialize(enabled: nil, maximum: nil, minimum: nil); end
3756
- end
3757
- # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
3758
- sig { returns(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity) }
3759
- attr_accessor :adjustable_quantity
3760
- # ID of an existing line item.
3761
- sig { returns(String) }
3762
- attr_accessor :id
3763
- # 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`.
3764
- sig { returns(T.nilable(T::Hash[String, String])) }
3765
- attr_accessor :metadata
3766
- # The ID of the [Price](https://stripe.com/docs/api/prices).
3767
- sig { returns(String) }
3768
- attr_accessor :price
3769
- # The quantity of the line item being purchased.
3770
- sig { returns(Integer) }
3771
- attr_accessor :quantity
3772
- # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
3773
- sig { returns(T.nilable(T::Array[String])) }
3774
- attr_accessor :tax_rates
3775
- sig {
3776
- params(adjustable_quantity: ::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity, id: String, metadata: T.nilable(T::Hash[String, String]), price: String, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
3777
- }
3778
- def initialize(
3779
- adjustable_quantity: nil,
3780
- id: nil,
3781
- metadata: nil,
3782
- price: nil,
3783
- quantity: nil,
3784
- tax_rates: nil
3785
- ); end
3786
- end
3787
- class ShippingOption < Stripe::RequestParams
3788
- class ShippingRateData < Stripe::RequestParams
3789
- class DeliveryEstimate < Stripe::RequestParams
3790
- class Maximum < Stripe::RequestParams
3791
- # A unit of time.
3792
- sig { returns(String) }
3793
- attr_accessor :unit
3794
- # Must be greater than 0.
3795
- sig { returns(Integer) }
3796
- attr_accessor :value
3797
- sig { params(unit: String, value: Integer).void }
3798
- def initialize(unit: nil, value: nil); end
3799
- end
3800
- class Minimum < Stripe::RequestParams
3801
- # A unit of time.
3802
- sig { returns(String) }
3803
- attr_accessor :unit
3804
- # Must be greater than 0.
3805
- sig { returns(Integer) }
3806
- attr_accessor :value
3807
- sig { params(unit: String, value: Integer).void }
3808
- def initialize(unit: nil, value: nil); end
3809
- end
3810
- # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
3811
- sig {
3812
- returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
3813
- }
3814
- attr_accessor :maximum
3815
- # The lower bound of the estimated range. If empty, represents no lower bound.
3816
- sig {
3817
- returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
3818
- }
3819
- attr_accessor :minimum
3820
- sig {
3821
- params(maximum: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
3822
- }
3823
- def initialize(maximum: nil, minimum: nil); end
3824
- end
3825
- class FixedAmount < Stripe::RequestParams
3826
- class CurrencyOptions < Stripe::RequestParams
3827
- # A non-negative integer in cents representing how much to charge.
3828
- sig { returns(Integer) }
3829
- attr_accessor :amount
3830
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3831
- sig { returns(String) }
3832
- attr_accessor :tax_behavior
3833
- sig { params(amount: Integer, tax_behavior: String).void }
3834
- def initialize(amount: nil, tax_behavior: nil); end
3835
- end
3836
- # A non-negative integer in cents representing how much to charge.
3837
- sig { returns(Integer) }
3838
- attr_accessor :amount
3839
- # 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).
3840
- sig { returns(String) }
3841
- attr_accessor :currency
3842
- # 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).
3843
- sig {
3844
- returns(T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
3845
- }
3846
- attr_accessor :currency_options
3847
- sig {
3848
- params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
3849
- }
3850
- def initialize(amount: nil, currency: nil, currency_options: nil); end
3851
- end
3852
- # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
3853
- sig {
3854
- returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
3855
- }
3856
- attr_accessor :delivery_estimate
3857
- # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
3858
- sig { returns(String) }
3859
- attr_accessor :display_name
3860
- # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
3861
- sig {
3862
- returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount)
3863
- }
3864
- attr_accessor :fixed_amount
3865
- # 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`.
3866
- sig { returns(T::Hash[String, String]) }
3867
- attr_accessor :metadata
3868
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3869
- sig { returns(String) }
3870
- attr_accessor :tax_behavior
3871
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
3872
- sig { returns(String) }
3873
- attr_accessor :tax_code
3874
- # The type of calculation to use on the shipping rate.
3875
- sig { returns(String) }
3876
- attr_accessor :type
3877
- sig {
3878
- params(delivery_estimate: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
3879
- }
3880
- def initialize(
3881
- delivery_estimate: nil,
3882
- display_name: nil,
3883
- fixed_amount: nil,
3884
- metadata: nil,
3885
- tax_behavior: nil,
3886
- tax_code: nil,
3887
- type: nil
3888
- ); end
3889
- end
3890
- # The ID of the Shipping Rate to use for this shipping option.
3891
- sig { returns(String) }
3892
- attr_accessor :shipping_rate
3893
- # Parameters to be passed to Shipping Rate creation for this shipping option.
3894
- sig {
3895
- returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData)
3896
- }
3897
- attr_accessor :shipping_rate_data
3898
- sig {
3899
- params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData).void
3900
- }
3901
- def initialize(shipping_rate: nil, shipping_rate_data: nil); end
3902
- end
3903
- # Information about the customer collected within the Checkout Session.
3904
- sig { returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation) }
3905
- attr_accessor :collected_information
3906
- # Specifies which fields in the response should be expanded.
3907
- sig { returns(T::Array[String]) }
3908
- attr_accessor :expand
3909
- # A list of items the customer is purchasing.
3910
- #
3911
- # When updating line items, you must retransmit the entire array of line items.
3912
- #
3913
- # To retain an existing line item, specify its `id`.
3914
- #
3915
- # To update an existing line item, specify its `id` along with the new values of the fields to update.
3916
- #
3917
- # To add a new line item, specify a `price` and `quantity`. We don't currently support recurring prices.
3918
- #
3919
- # To remove an existing line item, omit the line item's ID from the retransmitted array.
3920
- #
3921
- # To reorder a line item, specify it at the desired position in the retransmitted array.
3922
- sig { returns(T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem]) }
3923
- attr_accessor :line_items
3924
- # 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`.
3925
- sig { returns(T.nilable(T::Hash[String, String])) }
3926
- attr_accessor :metadata
3927
- # The shipping rate options to apply to this Session. Up to a maximum of 5.
3928
- sig {
3929
- returns(T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption]))
3930
- }
3931
- attr_accessor :shipping_options
3932
- sig {
3933
- params(collected_information: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation, expand: T::Array[String], line_items: T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), shipping_options: T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption])).void
3934
- }
3935
- def initialize(
3936
- collected_information: nil,
3937
- expand: nil,
3938
- line_items: nil,
3939
- metadata: nil,
3940
- shipping_options: nil
3941
- ); end
3942
- end
3943
- class ListLineItemsParams < Stripe::RequestParams
3944
- # 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.
3945
- sig { returns(String) }
3946
- attr_accessor :ending_before
3947
- # Specifies which fields in the response should be expanded.
3948
- sig { returns(T::Array[String]) }
3949
- attr_accessor :expand
3950
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
3951
- sig { returns(Integer) }
3952
- attr_accessor :limit
3953
- # 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.
3954
- sig { returns(String) }
3955
- attr_accessor :starting_after
3956
- sig {
3957
- params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
3958
- }
3959
- def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
3960
- end
3961
- class ExpireParams < Stripe::RequestParams
3962
- # Specifies which fields in the response should be expanded.
3963
- sig { returns(T::Array[String]) }
3964
- attr_accessor :expand
3965
- sig { params(expand: T::Array[String]).void }
3966
- def initialize(expand: nil); end
3967
- end
3968
- # Creates a Session object.
3969
- sig {
3970
- params(params: T.any(::Stripe::Checkout::Session::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
3971
- }
3972
- def self.create(params = {}, opts = {}); end
3973
-
3974
- # A Session can be expired when it is in one of these statuses: open
3975
- #
3976
- # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
3977
- sig {
3978
- params(params: T.any(::Stripe::Checkout::Session::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
3979
- }
3980
- def expire(params = {}, opts = {}); end
3981
-
3982
- # A Session can be expired when it is in one of these statuses: open
3983
- #
3984
- # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
3985
- sig {
3986
- params(session: String, params: T.any(::Stripe::Checkout::Session::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
3987
- }
3988
- def self.expire(session, params = {}, opts = {}); end
3989
-
3990
- # Returns a list of Checkout Sessions.
3991
- sig {
3992
- params(params: T.any(::Stripe::Checkout::Session::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
3993
- }
3994
- def self.list(params = {}, opts = {}); end
3995
-
3996
- # When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
3997
- sig {
3998
- params(params: T.any(::Stripe::Checkout::Session::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
3999
- }
4000
- def list_line_items(params = {}, opts = {}); end
4001
-
4002
- # When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
4003
- sig {
4004
- params(session: String, params: T.any(::Stripe::Checkout::Session::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
4005
- }
4006
- def self.list_line_items(session, params = {}, opts = {}); end
4007
-
4008
- # Updates a Session object.
4009
- sig {
4010
- params(id: String, params: T.any(::Stripe::Checkout::Session::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
4011
- }
4012
- def self.update(id, params = {}, opts = {}); end
4013
- end
4014
- end
4015
- end