stripe 15.4.0 → 15.5.0.pre.beta.2

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