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