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