stripe 13.3.0 → 13.4.0.pre.beta.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (743) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1416 -645
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_operations/request.rb +1 -0
  6. data/lib/stripe/api_requestor.rb +1 -0
  7. data/lib/stripe/object_types.rb +32 -0
  8. data/lib/stripe/request_params.rb +24 -0
  9. data/lib/stripe/request_signing_authenticator.rb +79 -0
  10. data/lib/stripe/resources/account.rb +5071 -0
  11. data/lib/stripe/resources/account_link.rb +54 -0
  12. data/lib/stripe/resources/account_notice.rb +132 -0
  13. data/lib/stripe/resources/account_session.rb +877 -0
  14. data/lib/stripe/resources/apple_pay_domain.rb +63 -0
  15. data/lib/stripe/resources/application.rb +20 -0
  16. data/lib/stripe/resources/application_fee.rb +96 -0
  17. data/lib/stripe/resources/application_fee_refund.rb +17 -0
  18. data/lib/stripe/resources/apps/secret.rb +141 -0
  19. data/lib/stripe/resources/balance.rb +131 -0
  20. data/lib/stripe/resources/balance_transaction.rb +112 -0
  21. data/lib/stripe/resources/bank_account.rb +84 -2
  22. data/lib/stripe/resources/billing/alert.rb +144 -0
  23. data/lib/stripe/resources/billing/alert_triggered.rb +26 -0
  24. data/lib/stripe/resources/billing/credit_balance_summary.rb +77 -0
  25. data/lib/stripe/resources/billing/credit_balance_transaction.rb +116 -0
  26. data/lib/stripe/resources/billing/credit_grant.rb +203 -0
  27. data/lib/stripe/resources/billing/meter.rb +178 -0
  28. data/lib/stripe/resources/billing/meter_error_report.rb +59 -0
  29. data/lib/stripe/resources/billing/meter_event.rb +35 -0
  30. data/lib/stripe/resources/billing/meter_event_adjustment.rb +43 -0
  31. data/lib/stripe/resources/billing/meter_event_summary.rb +15 -0
  32. data/lib/stripe/resources/billing_portal/configuration.rb +562 -0
  33. data/lib/stripe/resources/billing_portal/session.rb +271 -0
  34. data/lib/stripe/resources/capability.rb +84 -0
  35. data/lib/stripe/resources/capital/financing_offer.rb +188 -0
  36. data/lib/stripe/resources/capital/financing_summary.rb +64 -0
  37. data/lib/stripe/resources/capital/financing_transaction.rb +123 -0
  38. data/lib/stripe/resources/card.rb +79 -0
  39. data/lib/stripe/resources/cash_balance.rb +17 -0
  40. data/lib/stripe/resources/charge.rb +3026 -0
  41. data/lib/stripe/resources/checkout/session.rb +3654 -0
  42. data/lib/stripe/resources/climate/order.rb +176 -0
  43. data/lib/stripe/resources/climate/product.rb +56 -0
  44. data/lib/stripe/resources/climate/supplier.rb +54 -0
  45. data/lib/stripe/resources/confirmation_token.rb +1520 -0
  46. data/lib/stripe/resources/connect_collection_transfer.rb +24 -0
  47. data/lib/stripe/resources/country_spec.rb +63 -0
  48. data/lib/stripe/resources/coupon.rb +198 -0
  49. data/lib/stripe/resources/credit_note.rb +660 -0
  50. data/lib/stripe/resources/credit_note_line_item.rb +65 -0
  51. data/lib/stripe/resources/customer.rb +840 -0
  52. data/lib/stripe/resources/customer_balance_transaction.rb +27 -0
  53. data/lib/stripe/resources/customer_cash_balance_transaction.rb +109 -0
  54. data/lib/stripe/resources/customer_session.rb +159 -0
  55. data/lib/stripe/resources/discount.rb +29 -0
  56. data/lib/stripe/resources/dispute.rb +619 -0
  57. data/lib/stripe/resources/entitlements/active_entitlement.rb +46 -0
  58. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +23 -0
  59. data/lib/stripe/resources/entitlements/feature.rb +90 -0
  60. data/lib/stripe/resources/ephemeral_key.rb +21 -0
  61. data/lib/stripe/resources/event.rb +130 -0
  62. data/lib/stripe/resources/exchange_rate.rb +33 -0
  63. data/lib/stripe/resources/file.rb +111 -0
  64. data/lib/stripe/resources/file_link.rb +112 -0
  65. data/lib/stripe/resources/financial_connections/account.rb +260 -0
  66. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  67. data/lib/stripe/resources/financial_connections/account_owner.rb +17 -0
  68. data/lib/stripe/resources/financial_connections/account_ownership.rb +9 -0
  69. data/lib/stripe/resources/financial_connections/institution.rb +99 -0
  70. data/lib/stripe/resources/financial_connections/session.rb +159 -0
  71. data/lib/stripe/resources/financial_connections/transaction.rb +101 -0
  72. data/lib/stripe/resources/forwarding/request.rb +165 -0
  73. data/lib/stripe/resources/funding_instructions.rb +308 -0
  74. data/lib/stripe/resources/gift_cards/card.rb +217 -0
  75. data/lib/stripe/resources/gift_cards/transaction.rb +281 -0
  76. data/lib/stripe/resources/identity/verification_report.rb +266 -0
  77. data/lib/stripe/resources/identity/verification_session.rb +361 -0
  78. data/lib/stripe/resources/invoice.rb +8078 -0
  79. data/lib/stripe/resources/invoice_item.rb +445 -0
  80. data/lib/stripe/resources/invoice_line_item.rb +333 -0
  81. data/lib/stripe/resources/invoice_payment.rb +56 -0
  82. data/lib/stripe/resources/invoice_rendering_template.rb +67 -0
  83. data/lib/stripe/resources/issuing/authorization.rb +1117 -2
  84. data/lib/stripe/resources/issuing/card.rb +666 -0
  85. data/lib/stripe/resources/issuing/cardholder.rb +658 -0
  86. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +611 -0
  87. data/lib/stripe/resources/issuing/dispute.rb +790 -0
  88. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +84 -0
  89. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +95 -0
  90. data/lib/stripe/resources/issuing/personalization_design.rb +285 -0
  91. data/lib/stripe/resources/issuing/physical_bundle.rb +63 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +49 -0
  93. data/lib/stripe/resources/issuing/token.rb +175 -0
  94. data/lib/stripe/resources/issuing/transaction.rb +927 -0
  95. data/lib/stripe/resources/line_item.rb +75 -0
  96. data/lib/stripe/resources/login_link.rb +7 -0
  97. data/lib/stripe/resources/mandate.rb +169 -0
  98. data/lib/stripe/resources/margin.rb +124 -0
  99. data/lib/stripe/resources/order.rb +2850 -0
  100. data/lib/stripe/resources/payment_attempt_record.rb +184 -0
  101. data/lib/stripe/resources/payment_intent.rb +12864 -0
  102. data/lib/stripe/resources/payment_link.rb +1563 -0
  103. data/lib/stripe/resources/payment_method.rb +1638 -0
  104. data/lib/stripe/resources/payment_method_configuration.rb +2844 -0
  105. data/lib/stripe/resources/payment_method_domain.rb +153 -0
  106. data/lib/stripe/resources/payment_record.rb +715 -0
  107. data/lib/stripe/resources/payout.rb +218 -0
  108. data/lib/stripe/resources/person.rb +263 -0
  109. data/lib/stripe/resources/plan.rb +317 -0
  110. data/lib/stripe/resources/price.rb +649 -0
  111. data/lib/stripe/resources/product.rb +536 -0
  112. data/lib/stripe/resources/product_feature.rb +12 -0
  113. data/lib/stripe/resources/promotion_code.rb +221 -0
  114. data/lib/stripe/resources/quote.rb +2946 -0
  115. data/lib/stripe/resources/quote_line.rb +274 -0
  116. data/lib/stripe/resources/quote_preview_invoice.rb +652 -0
  117. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +362 -0
  118. data/lib/stripe/resources/radar/early_fraud_warning.rb +77 -0
  119. data/lib/stripe/resources/radar/value_list.rb +125 -0
  120. data/lib/stripe/resources/radar/value_list_item.rb +95 -0
  121. data/lib/stripe/resources/refund.rb +397 -0
  122. data/lib/stripe/resources/reporting/report_run.rb +150 -0
  123. data/lib/stripe/resources/reporting/report_type.rb +36 -0
  124. data/lib/stripe/resources/reserve_transaction.rb +22 -0
  125. data/lib/stripe/resources/reversal.rb +21 -0
  126. data/lib/stripe/resources/review.rb +108 -0
  127. data/lib/stripe/resources/setup_attempt.rb +373 -0
  128. data/lib/stripe/resources/setup_intent.rb +3834 -0
  129. data/lib/stripe/resources/shipping_rate.rb +259 -0
  130. data/lib/stripe/resources/sigma/scheduled_query_run.rb +54 -0
  131. data/lib/stripe/resources/source.rb +1239 -0
  132. data/lib/stripe/resources/source_mandate_notification.rb +66 -0
  133. data/lib/stripe/resources/source_transaction.rb +85 -0
  134. data/lib/stripe/resources/subscription.rb +2057 -0
  135. data/lib/stripe/resources/subscription_item.rb +433 -0
  136. data/lib/stripe/resources/subscription_schedule.rb +2402 -0
  137. data/lib/stripe/resources/tax/association.rb +89 -0
  138. data/lib/stripe/resources/tax/calculation.rb +387 -0
  139. data/lib/stripe/resources/tax/calculation_line_item.rb +56 -0
  140. data/lib/stripe/resources/tax/form.rb +220 -0
  141. data/lib/stripe/resources/tax/registration.rb +2382 -0
  142. data/lib/stripe/resources/tax/settings.rb +126 -0
  143. data/lib/stripe/resources/tax/transaction.rb +267 -0
  144. data/lib/stripe/resources/tax/transaction_line_item.rb +31 -0
  145. data/lib/stripe/resources/tax_code.rb +35 -0
  146. data/lib/stripe/resources/tax_deducted_at_source.rb +22 -0
  147. data/lib/stripe/resources/tax_id.rb +121 -0
  148. data/lib/stripe/resources/tax_rate.rb +200 -0
  149. data/lib/stripe/resources/terminal/configuration.rb +1011 -0
  150. data/lib/stripe/resources/terminal/connection_token.rb +18 -0
  151. data/lib/stripe/resources/terminal/location.rb +175 -0
  152. data/lib/stripe/resources/terminal/reader.rb +782 -0
  153. data/lib/stripe/resources/terminal/reader_collected_data.rb +40 -0
  154. data/lib/stripe/resources/test_helpers/test_clock.rb +86 -0
  155. data/lib/stripe/resources/token.rb +1149 -0
  156. data/lib/stripe/resources/topup.rb +174 -0
  157. data/lib/stripe/resources/transfer.rb +153 -0
  158. data/lib/stripe/resources/treasury/credit_reversal.rb +92 -0
  159. data/lib/stripe/resources/treasury/debit_reversal.rb +103 -0
  160. data/lib/stripe/resources/treasury/financial_account.rb +772 -0
  161. data/lib/stripe/resources/treasury/financial_account_features.rb +191 -0
  162. data/lib/stripe/resources/treasury/inbound_transfer.rb +235 -0
  163. data/lib/stripe/resources/treasury/outbound_payment.rb +495 -0
  164. data/lib/stripe/resources/treasury/outbound_transfer.rb +387 -0
  165. data/lib/stripe/resources/treasury/received_credit.rb +283 -0
  166. data/lib/stripe/resources/treasury/received_debit.rb +244 -0
  167. data/lib/stripe/resources/treasury/transaction.rb +176 -0
  168. data/lib/stripe/resources/treasury/transaction_entry.rb +157 -0
  169. data/lib/stripe/resources/usage_record.rb +13 -0
  170. data/lib/stripe/resources/usage_record_summary.rb +21 -0
  171. data/lib/stripe/resources/v2/amount.rb +9 -0
  172. data/lib/stripe/resources/v2/billing/meter_event.rb +18 -0
  173. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +21 -0
  174. data/lib/stripe/resources/v2/billing/meter_event_session.rb +14 -0
  175. data/lib/stripe/resources/v2/event.rb +27 -0
  176. data/lib/stripe/resources/v2/event_destination.rb +59 -0
  177. data/lib/stripe/resources/webhook_endpoint.rb +122 -0
  178. data/lib/stripe/resources.rb +31 -0
  179. data/lib/stripe/services/account_capability_service.rb +32 -0
  180. data/lib/stripe/services/account_external_account_service.rb +250 -0
  181. data/lib/stripe/services/account_link_service.rb +46 -0
  182. data/lib/stripe/services/account_login_link_service.rb +9 -0
  183. data/lib/stripe/services/account_notice_service.rb +101 -0
  184. data/lib/stripe/services/account_person_service.rb +875 -0
  185. data/lib/stripe/services/account_service.rb +4351 -0
  186. data/lib/stripe/services/account_session_service.rb +664 -0
  187. data/lib/stripe/services/apple_pay_domain_service.rb +51 -0
  188. data/lib/stripe/services/application_fee_refund_service.rb +54 -0
  189. data/lib/stripe/services/application_fee_service.rb +57 -0
  190. data/lib/stripe/services/apps/secret_service.rb +116 -0
  191. data/lib/stripe/services/balance_service.rb +9 -0
  192. data/lib/stripe/services/balance_transaction_service.rb +69 -0
  193. data/lib/stripe/services/billing/alert_service.rb +113 -0
  194. data/lib/stripe/services/billing/credit_balance_summary_service.rb +37 -0
  195. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +40 -0
  196. data/lib/stripe/services/billing/credit_grant_service.rb +151 -0
  197. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +26 -0
  198. data/lib/stripe/services/billing/meter_event_service.rb +21 -0
  199. data/lib/stripe/services/billing/meter_event_summary_service.rb +39 -0
  200. data/lib/stripe/services/billing/meter_service.rb +130 -0
  201. data/lib/stripe/services/billing_portal/configuration_service.rb +444 -0
  202. data/lib/stripe/services/billing_portal/session_service.rb +173 -0
  203. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  204. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  205. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  206. data/lib/stripe/services/capital_service.rb +15 -0
  207. data/lib/stripe/services/charge_service.rb +1736 -0
  208. data/lib/stripe/services/checkout/session_line_item_service.rb +18 -0
  209. data/lib/stripe/services/checkout/session_service.rb +2465 -0
  210. data/lib/stripe/services/climate/order_service.rb +102 -0
  211. data/lib/stripe/services/climate/product_service.rb +27 -0
  212. data/lib/stripe/services/climate/supplier_service.rb +27 -0
  213. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  214. data/lib/stripe/services/country_spec_service.rb +27 -0
  215. data/lib/stripe/services/coupon_service.rb +152 -0
  216. data/lib/stripe/services/credit_note_line_item_service.rb +18 -0
  217. data/lib/stripe/services/credit_note_preview_lines_service.rb +156 -0
  218. data/lib/stripe/services/credit_note_service.rb +373 -0
  219. data/lib/stripe/services/customer_balance_transaction_service.rb +63 -0
  220. data/lib/stripe/services/customer_cash_balance_service.rb +29 -0
  221. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +27 -0
  222. data/lib/stripe/services/customer_funding_instructions_service.rb +42 -0
  223. data/lib/stripe/services/customer_payment_method_service.rb +40 -0
  224. data/lib/stripe/services/customer_payment_source_service.rb +179 -0
  225. data/lib/stripe/services/customer_service.rb +593 -0
  226. data/lib/stripe/services/customer_session_service.rb +96 -0
  227. data/lib/stripe/services/customer_tax_id_service.rb +45 -0
  228. data/lib/stripe/services/dispute_service.rb +374 -0
  229. data/lib/stripe/services/entitlements/active_entitlement_service.rb +36 -0
  230. data/lib/stripe/services/entitlements/feature_service.rb +76 -0
  231. data/lib/stripe/services/ephemeral_key_service.rb +36 -0
  232. data/lib/stripe/services/event_service.rb +65 -0
  233. data/lib/stripe/services/exchange_rate_service.rb +27 -0
  234. data/lib/stripe/services/file_link_service.rb +94 -0
  235. data/lib/stripe/services/file_service.rb +89 -0
  236. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +37 -0
  237. data/lib/stripe/services/financial_connections/account_owner_service.rb +27 -0
  238. data/lib/stripe/services/financial_connections/account_service.rb +99 -1
  239. data/lib/stripe/services/financial_connections/institution_service.rb +57 -0
  240. data/lib/stripe/services/financial_connections/session_service.rb +97 -0
  241. data/lib/stripe/services/financial_connections/transaction_service.rb +70 -0
  242. data/lib/stripe/services/financial_connections_service.rb +2 -1
  243. data/lib/stripe/services/forwarding/request_service.rb +106 -0
  244. data/lib/stripe/services/gift_cards/card_service.rb +170 -0
  245. data/lib/stripe/services/gift_cards/transaction_service.rb +209 -0
  246. data/lib/stripe/services/gift_cards_service.rb +14 -0
  247. data/lib/stripe/services/identity/verification_report_service.rb +65 -0
  248. data/lib/stripe/services/identity/verification_session_service.rb +231 -0
  249. data/lib/stripe/services/invoice_item_service.rb +388 -0
  250. data/lib/stripe/services/invoice_line_item_service.rb +237 -0
  251. data/lib/stripe/services/invoice_payment_service.rb +55 -0
  252. data/lib/stripe/services/invoice_rendering_template_service.rb +51 -0
  253. data/lib/stripe/services/invoice_service.rb +5567 -1
  254. data/lib/stripe/services/invoice_upcoming_lines_service.rb +1864 -0
  255. data/lib/stripe/services/issuing/authorization_service.rb +104 -0
  256. data/lib/stripe/services/issuing/card_service.rb +455 -0
  257. data/lib/stripe/services/issuing/cardholder_service.rb +526 -0
  258. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  259. data/lib/stripe/services/issuing/dispute_service.rb +633 -0
  260. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  261. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  262. data/lib/stripe/services/issuing/personalization_design_service.rb +193 -0
  263. data/lib/stripe/services/issuing/physical_bundle_service.rb +40 -0
  264. data/lib/stripe/services/issuing/token_service.rb +73 -0
  265. data/lib/stripe/services/issuing/transaction_service.rb +81 -0
  266. data/lib/stripe/services/issuing_service.rb +5 -1
  267. data/lib/stripe/services/mandate_service.rb +9 -0
  268. data/lib/stripe/services/margin_service.rb +119 -0
  269. data/lib/stripe/services/order_line_item_service.rb +35 -0
  270. data/lib/stripe/services/order_service.rb +2254 -0
  271. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  272. data/lib/stripe/services/payment_intent_service.rb +10894 -0
  273. data/lib/stripe/services/payment_link_line_item_service.rb +18 -0
  274. data/lib/stripe/services/payment_link_service.rb +1223 -0
  275. data/lib/stripe/services/payment_method_configuration_service.rb +2046 -0
  276. data/lib/stripe/services/payment_method_domain_service.rb +76 -0
  277. data/lib/stripe/services/payment_method_service.rb +864 -0
  278. data/lib/stripe/services/payment_record_service.rb +542 -0
  279. data/lib/stripe/services/payout_service.rb +159 -0
  280. data/lib/stripe/services/plan_service.rb +253 -0
  281. data/lib/stripe/services/price_service.rb +516 -0
  282. data/lib/stripe/services/product_feature_service.rb +42 -0
  283. data/lib/stripe/services/product_service.rb +459 -0
  284. data/lib/stripe/services/promotion_code_service.rb +178 -0
  285. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +18 -0
  286. data/lib/stripe/services/quote_line_item_service.rb +18 -0
  287. data/lib/stripe/services/quote_line_service.rb +35 -0
  288. data/lib/stripe/services/quote_preview_invoice_service.rb +35 -0
  289. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  290. data/lib/stripe/services/quote_service.rb +2319 -1
  291. data/lib/stripe/services/radar/early_fraud_warning_service.rb +61 -0
  292. data/lib/stripe/services/radar/value_list_item_service.rb +79 -0
  293. data/lib/stripe/services/radar/value_list_service.rb +103 -0
  294. data/lib/stripe/services/refund_service.rb +137 -0
  295. data/lib/stripe/services/reporting/report_run_service.rb +106 -0
  296. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  297. data/lib/stripe/services/review_service.rb +56 -0
  298. data/lib/stripe/services/setup_attempt_service.rb +51 -0
  299. data/lib/stripe/services/setup_intent_service.rb +3476 -0
  300. data/lib/stripe/services/shipping_rate_service.rb +200 -0
  301. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +27 -0
  302. data/lib/stripe/services/source_service.rb +601 -0
  303. data/lib/stripe/services/source_transaction_service.rb +18 -0
  304. data/lib/stripe/services/subscription_item_service.rb +383 -0
  305. data/lib/stripe/services/subscription_item_usage_record_service.rb +18 -0
  306. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +18 -0
  307. data/lib/stripe/services/subscription_schedule_service.rb +2053 -0
  308. data/lib/stripe/services/subscription_service.rb +1722 -0
  309. data/lib/stripe/services/tax/association_service.rb +31 -0
  310. data/lib/stripe/services/tax/calculation_line_item_service.rb +18 -0
  311. data/lib/stripe/services/tax/calculation_service.rb +205 -0
  312. data/lib/stripe/services/tax/form_service.rb +100 -0
  313. data/lib/stripe/services/tax/registration_service.rb +1564 -0
  314. data/lib/stripe/services/tax/settings_service.rb +74 -0
  315. data/lib/stripe/services/tax/transaction_line_item_service.rb +18 -0
  316. data/lib/stripe/services/tax/transaction_service.rb +111 -0
  317. data/lib/stripe/services/tax_code_service.rb +27 -0
  318. data/lib/stripe/services/tax_id_service.rb +79 -0
  319. data/lib/stripe/services/tax_rate_service.rb +155 -0
  320. data/lib/stripe/services/tax_service.rb +3 -1
  321. data/lib/stripe/services/terminal/configuration_service.rb +793 -0
  322. data/lib/stripe/services/terminal/connection_token_service.rb +12 -0
  323. data/lib/stripe/services/terminal/location_service.rb +144 -0
  324. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  325. data/lib/stripe/services/terminal/reader_service.rb +443 -0
  326. data/lib/stripe/services/terminal_service.rb +2 -1
  327. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +673 -0
  328. data/lib/stripe/services/test_helpers/customer_service.rb +18 -0
  329. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +745 -0
  330. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  331. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +41 -0
  332. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +632 -0
  333. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  334. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +44 -0
  335. data/lib/stripe/services/test_helpers/test_clock_service.rb +57 -0
  336. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +38 -0
  337. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +87 -0
  338. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +87 -0
  339. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +84 -0
  340. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +84 -0
  341. data/lib/stripe/services/token_service.rb +1121 -0
  342. data/lib/stripe/services/topup_service.rb +142 -0
  343. data/lib/stripe/services/transfer_reversal_service.rb +66 -0
  344. data/lib/stripe/services/transfer_service.rb +119 -0
  345. data/lib/stripe/services/treasury/credit_reversal_service.rb +59 -0
  346. data/lib/stripe/services/treasury/debit_reversal_service.rb +63 -0
  347. data/lib/stripe/services/treasury/financial_account_features_service.rb +169 -0
  348. data/lib/stripe/services/treasury/financial_account_service.rb +509 -0
  349. data/lib/stripe/services/treasury/inbound_transfer_service.rb +88 -0
  350. data/lib/stripe/services/treasury/outbound_payment_service.rb +258 -0
  351. data/lib/stripe/services/treasury/outbound_transfer_service.rb +148 -0
  352. data/lib/stripe/services/treasury/received_credit_service.rb +52 -0
  353. data/lib/stripe/services/treasury/received_debit_service.rb +40 -0
  354. data/lib/stripe/services/treasury/transaction_entry_service.rb +87 -0
  355. data/lib/stripe/services/treasury/transaction_service.rb +95 -0
  356. data/lib/stripe/services/v1_services.rb +8 -1
  357. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +23 -0
  358. data/lib/stripe/services/v2/billing/meter_event_service.rb +25 -0
  359. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  360. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +33 -0
  361. data/lib/stripe/services/v2/core/event_destination_service.rb +146 -0
  362. data/lib/stripe/services/v2/core/event_service.rb +18 -0
  363. data/lib/stripe/services/webhook_endpoint_service.rb +96 -0
  364. data/lib/stripe/services.rb +25 -0
  365. data/lib/stripe/stripe_client.rb +1 -1
  366. data/lib/stripe/stripe_configuration.rb +3 -1
  367. data/lib/stripe/stripe_object.rb +5 -0
  368. data/lib/stripe/util.rb +7 -1
  369. data/lib/stripe/version.rb +1 -1
  370. data/lib/stripe.rb +46 -0
  371. data/rbi/stripe/resources/account.rbi +5100 -0
  372. data/rbi/stripe/resources/account_link.rbi +74 -0
  373. data/rbi/stripe/resources/account_notice.rbi +139 -0
  374. data/rbi/stripe/resources/account_session.rbi +1007 -0
  375. data/rbi/stripe/resources/apple_pay_domain.rbi +97 -0
  376. data/rbi/stripe/resources/application.rbi +20 -0
  377. data/rbi/stripe/resources/application_fee.rbi +123 -0
  378. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  379. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  380. data/rbi/stripe/resources/balance.rbi +187 -0
  381. data/rbi/stripe/resources/balance_transaction.rbi +149 -0
  382. data/rbi/stripe/resources/bank_account.rbi +127 -0
  383. data/rbi/stripe/resources/billing/alert.rbi +206 -0
  384. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  385. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +102 -0
  386. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +154 -0
  387. data/rbi/stripe/resources/billing/credit_grant.rbi +269 -0
  388. data/rbi/stripe/resources/billing/meter.rbi +233 -0
  389. data/rbi/stripe/resources/billing/meter_error_report.rbi +71 -0
  390. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  391. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  392. data/rbi/stripe/resources/billing/meter_event_summary.rbi +33 -0
  393. data/rbi/stripe/resources/billing_portal/configuration.rbi +640 -0
  394. data/rbi/stripe/resources/billing_portal/session.rbi +341 -0
  395. data/rbi/stripe/resources/capability.rbi +125 -0
  396. data/rbi/stripe/resources/capital/financing_offer.rbi +190 -0
  397. data/rbi/stripe/resources/capital/financing_summary.rbi +74 -0
  398. data/rbi/stripe/resources/capital/financing_transaction.rbi +130 -0
  399. data/rbi/stripe/resources/card.rbi +128 -0
  400. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  401. data/rbi/stripe/resources/charge.rbi +3484 -0
  402. data/rbi/stripe/resources/checkout/session.rbi +3995 -0
  403. data/rbi/stripe/resources/climate/order.rbi +250 -0
  404. data/rbi/stripe/resources/climate/product.rbi +82 -0
  405. data/rbi/stripe/resources/climate/supplier.rbi +79 -0
  406. data/rbi/stripe/resources/confirmation_token.rbi +1776 -0
  407. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  408. data/rbi/stripe/resources/country_spec.rbi +92 -0
  409. data/rbi/stripe/resources/coupon.rbi +257 -0
  410. data/rbi/stripe/resources/credit_note.rbi +759 -0
  411. data/rbi/stripe/resources/credit_note_line_item.rbi +99 -0
  412. data/rbi/stripe/resources/customer.rbi +1001 -0
  413. data/rbi/stripe/resources/customer_balance_transaction.rbi +53 -0
  414. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  415. data/rbi/stripe/resources/customer_session.rbi +196 -0
  416. data/rbi/stripe/resources/discount.rbi +53 -0
  417. data/rbi/stripe/resources/dispute.rbi +764 -0
  418. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +65 -0
  419. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  420. data/rbi/stripe/resources/entitlements/feature.rbi +124 -0
  421. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  422. data/rbi/stripe/resources/event.rbi +190 -0
  423. data/rbi/stripe/resources/exchange_rate.rbi +73 -0
  424. data/rbi/stripe/resources/file.rbi +148 -0
  425. data/rbi/stripe/resources/file_link.rbi +146 -0
  426. data/rbi/stripe/resources/financial_connections/account.rbi +358 -0
  427. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +27 -0
  428. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  429. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  430. data/rbi/stripe/resources/financial_connections/institution.rbi +99 -0
  431. data/rbi/stripe/resources/financial_connections/session.rbi +186 -0
  432. data/rbi/stripe/resources/financial_connections/transaction.rbi +127 -0
  433. data/rbi/stripe/resources/forwarding/request.rbi +219 -0
  434. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  435. data/rbi/stripe/resources/gift_cards/card.rbi +206 -0
  436. data/rbi/stripe/resources/gift_cards/transaction.rbi +257 -0
  437. data/rbi/stripe/resources/identity/verification_report.rbi +354 -0
  438. data/rbi/stripe/resources/identity/verification_session.rbi +518 -0
  439. data/rbi/stripe/resources/invoice.rbi +8928 -0
  440. data/rbi/stripe/resources/invoice_item.rbi +514 -0
  441. data/rbi/stripe/resources/invoice_line_item.rbi +400 -0
  442. data/rbi/stripe/resources/invoice_payment.rbi +70 -0
  443. data/rbi/stripe/resources/invoice_rendering_template.rbi +114 -0
  444. data/rbi/stripe/resources/issuing/authorization.rbi +1266 -0
  445. data/rbi/stripe/resources/issuing/card.rbi +738 -0
  446. data/rbi/stripe/resources/issuing/cardholder.rbi +732 -0
  447. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +622 -0
  448. data/rbi/stripe/resources/issuing/dispute.rbi +900 -0
  449. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +83 -0
  450. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +90 -0
  451. data/rbi/stripe/resources/issuing/personalization_design.rbi +333 -0
  452. data/rbi/stripe/resources/issuing/physical_bundle.rbi +86 -0
  453. data/rbi/stripe/resources/issuing/settlement.rbi +62 -0
  454. data/rbi/stripe/resources/issuing/token.rbi +231 -0
  455. data/rbi/stripe/resources/issuing/transaction.rbi +1057 -0
  456. data/rbi/stripe/resources/line_item.rbi +108 -0
  457. data/rbi/stripe/resources/login_link.rbi +18 -0
  458. data/rbi/stripe/resources/mandate.rbi +219 -0
  459. data/rbi/stripe/resources/margin.rbi +127 -0
  460. data/rbi/stripe/resources/order.rbi +3016 -0
  461. data/rbi/stripe/resources/payment_attempt_record.rbi +215 -0
  462. data/rbi/stripe/resources/payment_intent.rbi +13843 -0
  463. data/rbi/stripe/resources/payment_link.rbi +1666 -0
  464. data/rbi/stripe/resources/payment_method.rbi +1908 -0
  465. data/rbi/stripe/resources/payment_method_configuration.rbi +3171 -0
  466. data/rbi/stripe/resources/payment_method_domain.rbi +217 -0
  467. data/rbi/stripe/resources/payment_record.rbi +722 -0
  468. data/rbi/stripe/resources/payout.rbi +299 -0
  469. data/rbi/stripe/resources/person.rbi +371 -0
  470. data/rbi/stripe/resources/plan.rbi +385 -0
  471. data/rbi/stripe/resources/price.rbi +731 -0
  472. data/rbi/stripe/resources/product.rbi +615 -0
  473. data/rbi/stripe/resources/product_feature.rbi +26 -0
  474. data/rbi/stripe/resources/promotion_code.rbi +266 -0
  475. data/rbi/stripe/resources/quote.rbi +3186 -0
  476. data/rbi/stripe/resources/quote_line.rbi +350 -0
  477. data/rbi/stripe/resources/quote_preview_invoice.rbi +850 -0
  478. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +474 -0
  479. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +101 -0
  480. data/rbi/stripe/resources/radar/value_list.rbi +175 -0
  481. data/rbi/stripe/resources/radar/value_list_item.rbi +134 -0
  482. data/rbi/stripe/resources/refund.rbi +515 -0
  483. data/rbi/stripe/resources/reporting/report_run.rbi +194 -0
  484. data/rbi/stripe/resources/reporting/report_type.rbi +64 -0
  485. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  486. data/rbi/stripe/resources/reversal.rbi +51 -0
  487. data/rbi/stripe/resources/review.rbi +159 -0
  488. data/rbi/stripe/resources/setup_attempt.rbi +484 -0
  489. data/rbi/stripe/resources/setup_intent.rbi +4041 -0
  490. data/rbi/stripe/resources/shipping_rate.rbi +310 -0
  491. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +82 -0
  492. data/rbi/stripe/resources/source.rbi +1543 -0
  493. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  494. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  495. data/rbi/stripe/resources/subscription.rbi +2308 -0
  496. data/rbi/stripe/resources/subscription_item.rbi +478 -0
  497. data/rbi/stripe/resources/subscription_schedule.rbi +2653 -0
  498. data/rbi/stripe/resources/tax/association.rbi +94 -0
  499. data/rbi/stripe/resources/tax/calculation.rbi +479 -0
  500. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  501. data/rbi/stripe/resources/tax/form.rbi +224 -0
  502. data/rbi/stripe/resources/tax/registration.rbi +2438 -0
  503. data/rbi/stripe/resources/tax/settings.rbi +148 -0
  504. data/rbi/stripe/resources/tax/transaction.rbi +356 -0
  505. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  506. data/rbi/stripe/resources/tax_code.rbi +51 -0
  507. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  508. data/rbi/stripe/resources/tax_id.rbi +174 -0
  509. data/rbi/stripe/resources/tax_rate.rbi +244 -0
  510. data/rbi/stripe/resources/terminal/configuration.rbi +1091 -0
  511. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  512. data/rbi/stripe/resources/terminal/location.rbi +231 -0
  513. data/rbi/stripe/resources/terminal/reader.rbi +952 -0
  514. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +41 -0
  515. data/rbi/stripe/resources/test_helpers/test_clock.rbi +139 -0
  516. data/rbi/stripe/resources/token.rbi +1175 -0
  517. data/rbi/stripe/resources/topup.rbi +225 -0
  518. data/rbi/stripe/resources/transfer.rbi +204 -0
  519. data/rbi/stripe/resources/treasury/credit_reversal.rbi +126 -0
  520. data/rbi/stripe/resources/treasury/debit_reversal.rbi +138 -0
  521. data/rbi/stripe/resources/treasury/financial_account.rbi +870 -0
  522. data/rbi/stripe/resources/treasury/financial_account_features.rbi +263 -0
  523. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +302 -0
  524. data/rbi/stripe/resources/treasury/outbound_payment.rbi +589 -0
  525. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +473 -0
  526. data/rbi/stripe/resources/treasury/received_credit.rbi +348 -0
  527. data/rbi/stripe/resources/treasury/received_debit.rbi +305 -0
  528. data/rbi/stripe/resources/treasury/transaction.rbi +216 -0
  529. data/rbi/stripe/resources/treasury/transaction_entry.rbi +193 -0
  530. data/rbi/stripe/resources/usage_record.rbi +32 -0
  531. data/rbi/stripe/resources/usage_record_summary.rbi +38 -0
  532. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  533. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  534. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  535. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  536. data/rbi/stripe/resources/v2/event.rbi +47 -0
  537. data/rbi/stripe/resources/v2/event_destination.rbi +90 -0
  538. data/rbi/stripe/resources/webhook_endpoint.rbi +177 -0
  539. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  540. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  541. data/rbi/stripe/services/account_link_service.rbi +58 -0
  542. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  543. data/rbi/stripe/services/account_notice_service.rbi +90 -0
  544. data/rbi/stripe/services/account_person_service.rbi +903 -0
  545. data/rbi/stripe/services/account_service.rbi +4185 -0
  546. data/rbi/stripe/services/account_session_service.rbi +757 -0
  547. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  548. data/rbi/stripe/services/application_fee_refund_service.rbi +91 -0
  549. data/rbi/stripe/services/application_fee_service.rbi +74 -0
  550. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  551. data/rbi/stripe/services/apps_service.rbi +9 -0
  552. data/rbi/stripe/services/balance_service.rbi +21 -0
  553. data/rbi/stripe/services/balance_transaction_service.rbi +89 -0
  554. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  555. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +54 -0
  556. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  557. data/rbi/stripe/services/billing/credit_grant_service.rbi +191 -0
  558. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +40 -0
  559. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  560. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  561. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  562. data/rbi/stripe/services/billing_portal/configuration_service.rbi +497 -0
  563. data/rbi/stripe/services/billing_portal/session_service.rbi +202 -0
  564. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  565. data/rbi/stripe/services/billing_service.rbi +15 -0
  566. data/rbi/stripe/services/capital/financing_offer_service.rbi +95 -0
  567. data/rbi/stripe/services/capital/financing_summary_service.rbi +22 -0
  568. data/rbi/stripe/services/capital/financing_transaction_service.rbi +68 -0
  569. data/rbi/stripe/services/capital_service.rbi +11 -0
  570. data/rbi/stripe/services/charge_service.rbi +1816 -0
  571. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  572. data/rbi/stripe/services/checkout/session_service.rbi +2582 -0
  573. data/rbi/stripe/services/checkout_service.rbi +9 -0
  574. data/rbi/stripe/services/climate/order_service.rbi +140 -0
  575. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  576. data/rbi/stripe/services/climate/supplier_service.rbi +46 -0
  577. data/rbi/stripe/services/climate_service.rbi +11 -0
  578. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  579. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  580. data/rbi/stripe/services/coupon_service.rbi +190 -0
  581. data/rbi/stripe/services/credit_note_line_item_service.rbi +31 -0
  582. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  583. data/rbi/stripe/services/credit_note_service.rbi +420 -0
  584. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  585. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  586. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  587. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  588. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  589. data/rbi/stripe/services/customer_payment_source_service.rbi +228 -0
  590. data/rbi/stripe/services/customer_service.rbi +647 -0
  591. data/rbi/stripe/services/customer_session_service.rbi +110 -0
  592. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  593. data/rbi/stripe/services/dispute_service.rbi +422 -0
  594. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  595. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  596. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  597. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  598. data/rbi/stripe/services/event_service.rbi +81 -0
  599. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  600. data/rbi/stripe/services/file_link_service.rbi +122 -0
  601. data/rbi/stripe/services/file_service.rbi +114 -0
  602. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +33 -0
  603. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  604. data/rbi/stripe/services/financial_connections/account_service.rbi +132 -0
  605. data/rbi/stripe/services/financial_connections/institution_service.rbi +46 -0
  606. data/rbi/stripe/services/financial_connections/session_service.rbi +111 -0
  607. data/rbi/stripe/services/financial_connections/transaction_service.rbi +90 -0
  608. data/rbi/stripe/services/financial_connections_service.rbi +12 -0
  609. data/rbi/stripe/services/forwarding/request_service.rbi +132 -0
  610. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  611. data/rbi/stripe/services/gift_cards/card_service.rbi +142 -0
  612. data/rbi/stripe/services/gift_cards/transaction_service.rbi +174 -0
  613. data/rbi/stripe/services/gift_cards_service.rbi +10 -0
  614. data/rbi/stripe/services/identity/verification_report_service.rbi +85 -0
  615. data/rbi/stripe/services/identity/verification_session_service.rbi +317 -0
  616. data/rbi/stripe/services/identity_service.rbi +10 -0
  617. data/rbi/stripe/services/invoice_item_service.rbi +424 -0
  618. data/rbi/stripe/services/invoice_line_item_service.rbi +270 -0
  619. data/rbi/stripe/services/invoice_payment_service.rbi +44 -0
  620. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  621. data/rbi/stripe/services/invoice_service.rbi +6040 -0
  622. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +2023 -0
  623. data/rbi/stripe/services/issuing/authorization_service.rbi +140 -0
  624. data/rbi/stripe/services/issuing/card_service.rbi +479 -0
  625. data/rbi/stripe/services/issuing/cardholder_service.rbi +568 -0
  626. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +498 -0
  627. data/rbi/stripe/services/issuing/dispute_service.rbi +701 -0
  628. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +55 -0
  629. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +73 -0
  630. data/rbi/stripe/services/issuing/personalization_design_service.rbi +233 -0
  631. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  632. data/rbi/stripe/services/issuing/token_service.rbi +95 -0
  633. data/rbi/stripe/services/issuing/transaction_service.rbi +103 -0
  634. data/rbi/stripe/services/issuing_service.rbi +19 -0
  635. data/rbi/stripe/services/mandate_service.rbi +20 -0
  636. data/rbi/stripe/services/margin_service.rbi +104 -0
  637. data/rbi/stripe/services/order_line_item_service.rbi +31 -0
  638. data/rbi/stripe/services/order_service.rbi +2306 -0
  639. data/rbi/stripe/services/payment_attempt_record_service.rbi +36 -0
  640. data/rbi/stripe/services/payment_intent_service.rbi +11429 -0
  641. data/rbi/stripe/services/payment_link_line_item_service.rbi +31 -0
  642. data/rbi/stripe/services/payment_link_service.rbi +1250 -0
  643. data/rbi/stripe/services/payment_method_configuration_service.rbi +2171 -0
  644. data/rbi/stripe/services/payment_method_domain_service.rbi +110 -0
  645. data/rbi/stripe/services/payment_method_service.rbi +883 -0
  646. data/rbi/stripe/services/payment_record_service.rbi +521 -0
  647. data/rbi/stripe/services/payout_service.rbi +197 -0
  648. data/rbi/stripe/services/plan_service.rbi +286 -0
  649. data/rbi/stripe/services/price_service.rbi +551 -0
  650. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  651. data/rbi/stripe/services/product_service.rbi +503 -0
  652. data/rbi/stripe/services/promotion_code_service.rbi +210 -0
  653. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  654. data/rbi/stripe/services/quote_line_item_service.rbi +31 -0
  655. data/rbi/stripe/services/quote_line_service.rbi +31 -0
  656. data/rbi/stripe/services/quote_preview_invoice_service.rbi +31 -0
  657. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +31 -0
  658. data/rbi/stripe/services/quote_service.rbi +2390 -0
  659. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +83 -0
  660. data/rbi/stripe/services/radar/value_list_item_service.rbi +107 -0
  661. data/rbi/stripe/services/radar/value_list_service.rbi +139 -0
  662. data/rbi/stripe/services/radar_service.rbi +11 -0
  663. data/rbi/stripe/services/refund_service.rbi +181 -0
  664. data/rbi/stripe/services/reporting/report_run_service.rbi +131 -0
  665. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  666. data/rbi/stripe/services/reporting_service.rbi +10 -0
  667. data/rbi/stripe/services/review_service.rbi +82 -0
  668. data/rbi/stripe/services/setup_attempt_service.rbi +63 -0
  669. data/rbi/stripe/services/setup_intent_service.rbi +3609 -0
  670. data/rbi/stripe/services/shipping_rate_service.rbi +235 -0
  671. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  672. data/rbi/stripe/services/sigma_service.rbi +9 -0
  673. data/rbi/stripe/services/source_service.rbi +647 -0
  674. data/rbi/stripe/services/source_transaction_service.rbi +31 -0
  675. data/rbi/stripe/services/subscription_item_service.rbi +422 -0
  676. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +37 -0
  677. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +33 -0
  678. data/rbi/stripe/services/subscription_schedule_service.rbi +2208 -0
  679. data/rbi/stripe/services/subscription_service.rbi +1870 -0
  680. data/rbi/stripe/services/tax/association_service.rbi +25 -0
  681. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  682. data/rbi/stripe/services/tax/calculation_service.rbi +228 -0
  683. data/rbi/stripe/services/tax/form_service.rbi +85 -0
  684. data/rbi/stripe/services/tax/registration_service.rbi +1517 -0
  685. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  686. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +33 -0
  687. data/rbi/stripe/services/tax/transaction_service.rbi +142 -0
  688. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  689. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  690. data/rbi/stripe/services/tax_rate_service.rbi +183 -0
  691. data/rbi/stripe/services/tax_service.rbi +14 -0
  692. data/rbi/stripe/services/terminal/configuration_service.rbi +822 -0
  693. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  694. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  695. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +22 -0
  696. data/rbi/stripe/services/terminal/reader_service.rbi +513 -0
  697. data/rbi/stripe/services/terminal_service.rbi +13 -0
  698. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +778 -0
  699. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  700. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +836 -0
  701. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  702. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +67 -0
  703. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +705 -0
  704. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  705. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  706. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  707. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  708. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +90 -0
  709. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  710. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +123 -0
  711. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +123 -0
  712. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +114 -0
  713. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +114 -0
  714. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  715. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  716. data/rbi/stripe/services/token_service.rbi +1136 -0
  717. data/rbi/stripe/services/topup_service.rbi +172 -0
  718. data/rbi/stripe/services/transfer_reversal_service.rbi +99 -0
  719. data/rbi/stripe/services/transfer_service.rbi +150 -0
  720. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  721. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  722. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +201 -0
  723. data/rbi/stripe/services/treasury/financial_account_service.rbi +566 -0
  724. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  725. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +300 -0
  726. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +182 -0
  727. data/rbi/stripe/services/treasury/received_credit_service.rbi +70 -0
  728. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  729. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +107 -0
  730. data/rbi/stripe/services/treasury/transaction_service.rbi +114 -0
  731. data/rbi/stripe/services/treasury_service.rbi +18 -0
  732. data/rbi/stripe/services/v1_services.rbi +83 -0
  733. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  734. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  735. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  736. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  737. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  738. data/rbi/stripe/services/v2/core/event_destination_service.rbi +203 -0
  739. data/rbi/stripe/services/v2/core/event_service.rbi +39 -0
  740. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  741. data/rbi/stripe/services/v2_services.rbi +10 -0
  742. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  743. metadata +435 -4
@@ -0,0 +1,1001 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ # This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information,
7
+ # and track payments that belong to the same customer.
8
+ class Customer < APIResource
9
+ class Address < Stripe::StripeObject
10
+ # City, district, suburb, town, or village.
11
+ sig { returns(T.nilable(String)) }
12
+ attr_reader :city
13
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
14
+ sig { returns(T.nilable(String)) }
15
+ attr_reader :country
16
+ # Address line 1 (e.g., street, PO Box, or company name).
17
+ sig { returns(T.nilable(String)) }
18
+ attr_reader :line1
19
+ # Address line 2 (e.g., apartment, suite, unit, or building).
20
+ sig { returns(T.nilable(String)) }
21
+ attr_reader :line2
22
+ # ZIP or postal code.
23
+ sig { returns(T.nilable(String)) }
24
+ attr_reader :postal_code
25
+ # State, county, province, or region.
26
+ sig { returns(T.nilable(String)) }
27
+ attr_reader :state
28
+ end
29
+ class InvoiceSettings < Stripe::StripeObject
30
+ class CustomField < Stripe::StripeObject
31
+ # The name of the custom field.
32
+ sig { returns(String) }
33
+ attr_reader :name
34
+ # The value of the custom field.
35
+ sig { returns(String) }
36
+ attr_reader :value
37
+ end
38
+ class RenderingOptions < Stripe::StripeObject
39
+ # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
40
+ sig { returns(T.nilable(String)) }
41
+ attr_reader :amount_tax_display
42
+ # ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.
43
+ sig { returns(T.nilable(String)) }
44
+ attr_reader :template
45
+ end
46
+ # Default custom fields to be displayed on invoices for this customer.
47
+ sig { returns(T.nilable(T::Array[CustomField])) }
48
+ attr_reader :custom_fields
49
+ # ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
50
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
51
+ attr_reader :default_payment_method
52
+ # Default footer to be displayed on invoices for this customer.
53
+ sig { returns(T.nilable(String)) }
54
+ attr_reader :footer
55
+ # Default options for invoice PDF rendering for this customer.
56
+ sig { returns(T.nilable(RenderingOptions)) }
57
+ attr_reader :rendering_options
58
+ end
59
+ class Shipping < Stripe::StripeObject
60
+ class Address < Stripe::StripeObject
61
+ # City, district, suburb, town, or village.
62
+ sig { returns(T.nilable(String)) }
63
+ attr_reader :city
64
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
65
+ sig { returns(T.nilable(String)) }
66
+ attr_reader :country
67
+ # Address line 1 (e.g., street, PO Box, or company name).
68
+ sig { returns(T.nilable(String)) }
69
+ attr_reader :line1
70
+ # Address line 2 (e.g., apartment, suite, unit, or building).
71
+ sig { returns(T.nilable(String)) }
72
+ attr_reader :line2
73
+ # ZIP or postal code.
74
+ sig { returns(T.nilable(String)) }
75
+ attr_reader :postal_code
76
+ # State, county, province, or region.
77
+ sig { returns(T.nilable(String)) }
78
+ attr_reader :state
79
+ end
80
+ # Attribute for field address
81
+ sig { returns(Address) }
82
+ attr_reader :address
83
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
84
+ sig { returns(T.nilable(String)) }
85
+ attr_reader :carrier
86
+ # Recipient name.
87
+ sig { returns(String) }
88
+ attr_reader :name
89
+ # Recipient phone (including extension).
90
+ sig { returns(T.nilable(String)) }
91
+ attr_reader :phone
92
+ # 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.
93
+ sig { returns(T.nilable(String)) }
94
+ attr_reader :tracking_number
95
+ end
96
+ class Tax < Stripe::StripeObject
97
+ class Location < Stripe::StripeObject
98
+ # The customer's country as identified by Stripe Tax.
99
+ sig { returns(String) }
100
+ attr_reader :country
101
+ # The data source used to infer the customer's location.
102
+ sig { returns(String) }
103
+ attr_reader :source
104
+ # The customer's state, county, province, or region as identified by Stripe Tax.
105
+ sig { returns(T.nilable(String)) }
106
+ attr_reader :state
107
+ end
108
+ # Surfaces if automatic tax computation is possible given the current customer location information.
109
+ sig { returns(String) }
110
+ attr_reader :automatic_tax
111
+ # A recent IP address of the customer used for tax reporting and tax location inference.
112
+ sig { returns(T.nilable(String)) }
113
+ attr_reader :ip_address
114
+ # The customer's location as identified by Stripe Tax.
115
+ sig { returns(T.nilable(Location)) }
116
+ attr_reader :location
117
+ end
118
+ # The customer's address.
119
+ sig { returns(T.nilable(Address)) }
120
+ attr_reader :address
121
+ # The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize.
122
+ sig { returns(Integer) }
123
+ attr_reader :balance
124
+ # The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.
125
+ sig { returns(T.nilable(Stripe::CashBalance)) }
126
+ attr_reader :cash_balance
127
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
128
+ sig { returns(Integer) }
129
+ attr_reader :created
130
+ # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.
131
+ sig { returns(T.nilable(String)) }
132
+ attr_reader :currency
133
+ # ID of the default payment source for the customer.
134
+ #
135
+ # If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.
136
+ sig {
137
+ returns(T.nilable(T.any(String, T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))))
138
+ }
139
+ attr_reader :default_source
140
+ # Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.
141
+ #
142
+ # If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.
143
+ #
144
+ # If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.
145
+ sig { returns(T.nilable(T::Boolean)) }
146
+ attr_reader :delinquent
147
+ # An arbitrary string attached to the object. Often useful for displaying to users.
148
+ sig { returns(T.nilable(String)) }
149
+ attr_reader :description
150
+ # Describes the current discount active on the customer, if there is one.
151
+ sig { returns(T.nilable(Stripe::Discount)) }
152
+ attr_reader :discount
153
+ # The customer's email address.
154
+ sig { returns(T.nilable(String)) }
155
+ attr_reader :email
156
+ # Unique identifier for the object.
157
+ sig { returns(String) }
158
+ attr_reader :id
159
+ # The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.
160
+ sig { returns(T::Hash[String, Integer]) }
161
+ attr_reader :invoice_credit_balance
162
+ # The prefix for the customer used to generate unique invoice numbers.
163
+ sig { returns(T.nilable(String)) }
164
+ attr_reader :invoice_prefix
165
+ # Attribute for field invoice_settings
166
+ sig { returns(InvoiceSettings) }
167
+ attr_reader :invoice_settings
168
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
169
+ sig { returns(T::Boolean) }
170
+ attr_reader :livemode
171
+ # 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.
172
+ sig { returns(T::Hash[String, String]) }
173
+ attr_reader :metadata
174
+ # The customer's full name or business name.
175
+ sig { returns(T.nilable(String)) }
176
+ attr_reader :name
177
+ # The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.
178
+ sig { returns(Integer) }
179
+ attr_reader :next_invoice_sequence
180
+ # String representing the object's type. Objects of the same type share the same value.
181
+ sig { returns(String) }
182
+ attr_reader :object
183
+ # The customer's phone number.
184
+ sig { returns(T.nilable(String)) }
185
+ attr_reader :phone
186
+ # The customer's preferred locales (languages), ordered by preference.
187
+ sig { returns(T.nilable(T::Array[String])) }
188
+ attr_reader :preferred_locales
189
+ # Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
190
+ sig { returns(T.nilable(Shipping)) }
191
+ attr_reader :shipping
192
+ # The customer's payment sources, if any.
193
+ sig { returns(Stripe::ListObject) }
194
+ attr_reader :sources
195
+ # The customer's current subscriptions, if any.
196
+ sig { returns(Stripe::ListObject) }
197
+ attr_reader :subscriptions
198
+ # Attribute for field tax
199
+ sig { returns(Tax) }
200
+ attr_reader :tax
201
+ # Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**.
202
+ sig { returns(T.nilable(String)) }
203
+ attr_reader :tax_exempt
204
+ # The customer's tax IDs.
205
+ sig { returns(Stripe::ListObject) }
206
+ attr_reader :tax_ids
207
+ # ID of the test clock that this customer belongs to.
208
+ sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
209
+ attr_reader :test_clock
210
+ # Always true for a deleted object
211
+ sig { returns(T::Boolean) }
212
+ attr_reader :deleted
213
+ class DeleteParams < Stripe::RequestParams
214
+
215
+ end
216
+ class RetrieveParams < Stripe::RequestParams
217
+ # Specifies which fields in the response should be expanded.
218
+ sig { returns(T::Array[String]) }
219
+ attr_accessor :expand
220
+ sig { params(expand: T::Array[String]).void }
221
+ def initialize(expand: nil); end
222
+ end
223
+ class UpdateParams < Stripe::RequestParams
224
+ class Address < Stripe::RequestParams
225
+ # City, district, suburb, town, or village.
226
+ sig { returns(String) }
227
+ attr_accessor :city
228
+ # A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
229
+ sig { returns(String) }
230
+ attr_accessor :country
231
+ # Address line 1 (e.g., street, PO Box, or company name).
232
+ sig { returns(String) }
233
+ attr_accessor :line1
234
+ # Address line 2 (e.g., apartment, suite, unit, or building).
235
+ sig { returns(String) }
236
+ attr_accessor :line2
237
+ # ZIP or postal code.
238
+ sig { returns(String) }
239
+ attr_accessor :postal_code
240
+ # State, county, province, or region.
241
+ sig { returns(String) }
242
+ attr_accessor :state
243
+ sig {
244
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
245
+ }
246
+ def initialize(
247
+ city: nil,
248
+ country: nil,
249
+ line1: nil,
250
+ line2: nil,
251
+ postal_code: nil,
252
+ state: nil
253
+ ); end
254
+ end
255
+ class CashBalance < Stripe::RequestParams
256
+ class Settings < Stripe::RequestParams
257
+ # Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
258
+ sig { returns(String) }
259
+ attr_accessor :reconciliation_mode
260
+ sig { params(reconciliation_mode: String).void }
261
+ def initialize(reconciliation_mode: nil); end
262
+ end
263
+ # Settings controlling the behavior of the customer's cash balance,
264
+ # such as reconciliation of funds received.
265
+ sig { returns(::Stripe::Customer::UpdateParams::CashBalance::Settings) }
266
+ attr_accessor :settings
267
+ sig { params(settings: ::Stripe::Customer::UpdateParams::CashBalance::Settings).void }
268
+ def initialize(settings: nil); end
269
+ end
270
+ class InvoiceSettings < Stripe::RequestParams
271
+ class CustomField < Stripe::RequestParams
272
+ # The name of the custom field. This may be up to 40 characters.
273
+ sig { returns(String) }
274
+ attr_accessor :name
275
+ # The value of the custom field. This may be up to 140 characters.
276
+ sig { returns(String) }
277
+ attr_accessor :value
278
+ sig { params(name: String, value: String).void }
279
+ def initialize(name: nil, value: nil); end
280
+ end
281
+ class RenderingOptions < Stripe::RequestParams
282
+ # 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.
283
+ sig { returns(T.nilable(String)) }
284
+ attr_accessor :amount_tax_display
285
+ # ID of the invoice rendering template to use for future invoices.
286
+ sig { returns(String) }
287
+ attr_accessor :template
288
+ sig { params(amount_tax_display: T.nilable(String), template: String).void }
289
+ def initialize(amount_tax_display: nil, template: nil); end
290
+ end
291
+ # The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
292
+ sig {
293
+ returns(T.nilable(T::Array[::Stripe::Customer::UpdateParams::InvoiceSettings::CustomField]))
294
+ }
295
+ attr_accessor :custom_fields
296
+ # ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
297
+ sig { returns(String) }
298
+ attr_accessor :default_payment_method
299
+ # Default footer to be displayed on invoices for this customer.
300
+ sig { returns(String) }
301
+ attr_accessor :footer
302
+ # Default options for invoice PDF rendering for this customer.
303
+ sig {
304
+ returns(T.nilable(::Stripe::Customer::UpdateParams::InvoiceSettings::RenderingOptions))
305
+ }
306
+ attr_accessor :rendering_options
307
+ sig {
308
+ params(custom_fields: T.nilable(T::Array[::Stripe::Customer::UpdateParams::InvoiceSettings::CustomField]), default_payment_method: String, footer: String, rendering_options: T.nilable(::Stripe::Customer::UpdateParams::InvoiceSettings::RenderingOptions)).void
309
+ }
310
+ def initialize(
311
+ custom_fields: nil,
312
+ default_payment_method: nil,
313
+ footer: nil,
314
+ rendering_options: nil
315
+ ); end
316
+ end
317
+ class Shipping < Stripe::RequestParams
318
+ class Address < Stripe::RequestParams
319
+ # City, district, suburb, town, or village.
320
+ sig { returns(String) }
321
+ attr_accessor :city
322
+ # A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
323
+ sig { returns(String) }
324
+ attr_accessor :country
325
+ # Address line 1 (e.g., street, PO Box, or company name).
326
+ sig { returns(String) }
327
+ attr_accessor :line1
328
+ # Address line 2 (e.g., apartment, suite, unit, or building).
329
+ sig { returns(String) }
330
+ attr_accessor :line2
331
+ # ZIP or postal code.
332
+ sig { returns(String) }
333
+ attr_accessor :postal_code
334
+ # State, county, province, or region.
335
+ sig { returns(String) }
336
+ attr_accessor :state
337
+ sig {
338
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
339
+ }
340
+ def initialize(
341
+ city: nil,
342
+ country: nil,
343
+ line1: nil,
344
+ line2: nil,
345
+ postal_code: nil,
346
+ state: nil
347
+ ); end
348
+ end
349
+ # Customer shipping address.
350
+ sig { returns(::Stripe::Customer::UpdateParams::Shipping::Address) }
351
+ attr_accessor :address
352
+ # Customer name.
353
+ sig { returns(String) }
354
+ attr_accessor :name
355
+ # Customer phone (including extension).
356
+ sig { returns(String) }
357
+ attr_accessor :phone
358
+ sig {
359
+ params(address: ::Stripe::Customer::UpdateParams::Shipping::Address, name: String, phone: String).void
360
+ }
361
+ def initialize(address: nil, name: nil, phone: nil); end
362
+ end
363
+ class Tax < Stripe::RequestParams
364
+ # A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
365
+ sig { returns(T.nilable(String)) }
366
+ attr_accessor :ip_address
367
+ # A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.
368
+ sig { returns(String) }
369
+ attr_accessor :validate_location
370
+ sig { params(ip_address: T.nilable(String), validate_location: String).void }
371
+ def initialize(ip_address: nil, validate_location: nil); end
372
+ end
373
+ # The customer's address.
374
+ sig { returns(T.nilable(::Stripe::Customer::UpdateParams::Address)) }
375
+ attr_accessor :address
376
+ # An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
377
+ sig { returns(Integer) }
378
+ attr_accessor :balance
379
+ # Balance information and default balance settings for this customer.
380
+ sig { returns(::Stripe::Customer::UpdateParams::CashBalance) }
381
+ attr_accessor :cash_balance
382
+ # Attribute for param field coupon
383
+ sig { returns(String) }
384
+ attr_accessor :coupon
385
+ # If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.
386
+ #
387
+ # Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.
388
+ #
389
+ # If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.
390
+ sig { returns(String) }
391
+ attr_accessor :default_source
392
+ # An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
393
+ sig { returns(String) }
394
+ attr_accessor :description
395
+ # Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
396
+ sig { returns(String) }
397
+ attr_accessor :email
398
+ # Specifies which fields in the response should be expanded.
399
+ sig { returns(T::Array[String]) }
400
+ attr_accessor :expand
401
+ # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
402
+ sig { returns(String) }
403
+ attr_accessor :invoice_prefix
404
+ # Default invoice settings for this customer.
405
+ sig { returns(::Stripe::Customer::UpdateParams::InvoiceSettings) }
406
+ attr_accessor :invoice_settings
407
+ # 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`.
408
+ sig { returns(T.nilable(T::Hash[String, String])) }
409
+ attr_accessor :metadata
410
+ # The customer's full name or business name.
411
+ sig { returns(String) }
412
+ attr_accessor :name
413
+ # The sequence to be used on the customer's next invoice. Defaults to 1.
414
+ sig { returns(Integer) }
415
+ attr_accessor :next_invoice_sequence
416
+ # The customer's phone number.
417
+ sig { returns(String) }
418
+ attr_accessor :phone
419
+ # Customer's preferred languages, ordered by preference.
420
+ sig { returns(T::Array[String]) }
421
+ attr_accessor :preferred_locales
422
+ # The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
423
+ sig { returns(String) }
424
+ attr_accessor :promotion_code
425
+ # The customer's shipping information. Appears on invoices emailed to this customer.
426
+ sig { returns(T.nilable(::Stripe::Customer::UpdateParams::Shipping)) }
427
+ attr_accessor :shipping
428
+ # Attribute for param field source
429
+ sig { returns(String) }
430
+ attr_accessor :source
431
+ # Tax details about the customer.
432
+ sig { returns(::Stripe::Customer::UpdateParams::Tax) }
433
+ attr_accessor :tax
434
+ # The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
435
+ sig { returns(T.nilable(String)) }
436
+ attr_accessor :tax_exempt
437
+ # Attribute for param field validate
438
+ sig { returns(T::Boolean) }
439
+ attr_accessor :validate
440
+ sig {
441
+ params(address: T.nilable(::Stripe::Customer::UpdateParams::Address), balance: Integer, cash_balance: ::Stripe::Customer::UpdateParams::CashBalance, coupon: String, default_source: String, description: String, email: String, expand: T::Array[String], invoice_prefix: String, invoice_settings: ::Stripe::Customer::UpdateParams::InvoiceSettings, metadata: T.nilable(T::Hash[String, String]), name: String, next_invoice_sequence: Integer, phone: String, preferred_locales: T::Array[String], promotion_code: String, shipping: T.nilable(::Stripe::Customer::UpdateParams::Shipping), source: String, tax: ::Stripe::Customer::UpdateParams::Tax, tax_exempt: T.nilable(String), validate: T::Boolean).void
442
+ }
443
+ def initialize(
444
+ address: nil,
445
+ balance: nil,
446
+ cash_balance: nil,
447
+ coupon: nil,
448
+ default_source: nil,
449
+ description: nil,
450
+ email: nil,
451
+ expand: nil,
452
+ invoice_prefix: nil,
453
+ invoice_settings: nil,
454
+ metadata: nil,
455
+ name: nil,
456
+ next_invoice_sequence: nil,
457
+ phone: nil,
458
+ preferred_locales: nil,
459
+ promotion_code: nil,
460
+ shipping: nil,
461
+ source: nil,
462
+ tax: nil,
463
+ tax_exempt: nil,
464
+ validate: nil
465
+ ); end
466
+ end
467
+ class DeleteDiscountParams < Stripe::RequestParams
468
+
469
+ end
470
+ class ListParams < Stripe::RequestParams
471
+ class Created < Stripe::RequestParams
472
+ # Minimum value to filter by (exclusive)
473
+ sig { returns(Integer) }
474
+ attr_accessor :gt
475
+ # Minimum value to filter by (inclusive)
476
+ sig { returns(Integer) }
477
+ attr_accessor :gte
478
+ # Maximum value to filter by (exclusive)
479
+ sig { returns(Integer) }
480
+ attr_accessor :lt
481
+ # Maximum value to filter by (inclusive)
482
+ sig { returns(Integer) }
483
+ attr_accessor :lte
484
+ sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
485
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
486
+ end
487
+ # Only return customers that were created during the given date interval.
488
+ sig { returns(T.any(::Stripe::Customer::ListParams::Created, Integer)) }
489
+ attr_accessor :created
490
+ # A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.
491
+ sig { returns(String) }
492
+ attr_accessor :email
493
+ # 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.
494
+ sig { returns(String) }
495
+ attr_accessor :ending_before
496
+ # Specifies which fields in the response should be expanded.
497
+ sig { returns(T::Array[String]) }
498
+ attr_accessor :expand
499
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
500
+ sig { returns(Integer) }
501
+ attr_accessor :limit
502
+ # 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.
503
+ sig { returns(String) }
504
+ attr_accessor :starting_after
505
+ # Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.
506
+ sig { returns(String) }
507
+ attr_accessor :test_clock
508
+ sig {
509
+ params(created: T.any(::Stripe::Customer::ListParams::Created, Integer), email: String, ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, test_clock: String).void
510
+ }
511
+ def initialize(
512
+ created: nil,
513
+ email: nil,
514
+ ending_before: nil,
515
+ expand: nil,
516
+ limit: nil,
517
+ starting_after: nil,
518
+ test_clock: nil
519
+ ); end
520
+ end
521
+ class CreateParams < Stripe::RequestParams
522
+ class Address < Stripe::RequestParams
523
+ # City, district, suburb, town, or village.
524
+ sig { returns(String) }
525
+ attr_accessor :city
526
+ # A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
527
+ sig { returns(String) }
528
+ attr_accessor :country
529
+ # Address line 1 (e.g., street, PO Box, or company name).
530
+ sig { returns(String) }
531
+ attr_accessor :line1
532
+ # Address line 2 (e.g., apartment, suite, unit, or building).
533
+ sig { returns(String) }
534
+ attr_accessor :line2
535
+ # ZIP or postal code.
536
+ sig { returns(String) }
537
+ attr_accessor :postal_code
538
+ # State, county, province, or region.
539
+ sig { returns(String) }
540
+ attr_accessor :state
541
+ sig {
542
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
543
+ }
544
+ def initialize(
545
+ city: nil,
546
+ country: nil,
547
+ line1: nil,
548
+ line2: nil,
549
+ postal_code: nil,
550
+ state: nil
551
+ ); end
552
+ end
553
+ class CashBalance < Stripe::RequestParams
554
+ class Settings < Stripe::RequestParams
555
+ # Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
556
+ sig { returns(String) }
557
+ attr_accessor :reconciliation_mode
558
+ sig { params(reconciliation_mode: String).void }
559
+ def initialize(reconciliation_mode: nil); end
560
+ end
561
+ # Settings controlling the behavior of the customer's cash balance,
562
+ # such as reconciliation of funds received.
563
+ sig { returns(::Stripe::Customer::CreateParams::CashBalance::Settings) }
564
+ attr_accessor :settings
565
+ sig { params(settings: ::Stripe::Customer::CreateParams::CashBalance::Settings).void }
566
+ def initialize(settings: nil); end
567
+ end
568
+ class InvoiceSettings < Stripe::RequestParams
569
+ class CustomField < Stripe::RequestParams
570
+ # The name of the custom field. This may be up to 40 characters.
571
+ sig { returns(String) }
572
+ attr_accessor :name
573
+ # The value of the custom field. This may be up to 140 characters.
574
+ sig { returns(String) }
575
+ attr_accessor :value
576
+ sig { params(name: String, value: String).void }
577
+ def initialize(name: nil, value: nil); end
578
+ end
579
+ class RenderingOptions < Stripe::RequestParams
580
+ # 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.
581
+ sig { returns(T.nilable(String)) }
582
+ attr_accessor :amount_tax_display
583
+ # ID of the invoice rendering template to use for future invoices.
584
+ sig { returns(String) }
585
+ attr_accessor :template
586
+ sig { params(amount_tax_display: T.nilable(String), template: String).void }
587
+ def initialize(amount_tax_display: nil, template: nil); end
588
+ end
589
+ # The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
590
+ sig {
591
+ returns(T.nilable(T::Array[::Stripe::Customer::CreateParams::InvoiceSettings::CustomField]))
592
+ }
593
+ attr_accessor :custom_fields
594
+ # ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
595
+ sig { returns(String) }
596
+ attr_accessor :default_payment_method
597
+ # Default footer to be displayed on invoices for this customer.
598
+ sig { returns(String) }
599
+ attr_accessor :footer
600
+ # Default options for invoice PDF rendering for this customer.
601
+ sig {
602
+ returns(T.nilable(::Stripe::Customer::CreateParams::InvoiceSettings::RenderingOptions))
603
+ }
604
+ attr_accessor :rendering_options
605
+ sig {
606
+ params(custom_fields: T.nilable(T::Array[::Stripe::Customer::CreateParams::InvoiceSettings::CustomField]), default_payment_method: String, footer: String, rendering_options: T.nilable(::Stripe::Customer::CreateParams::InvoiceSettings::RenderingOptions)).void
607
+ }
608
+ def initialize(
609
+ custom_fields: nil,
610
+ default_payment_method: nil,
611
+ footer: nil,
612
+ rendering_options: nil
613
+ ); end
614
+ end
615
+ class Shipping < Stripe::RequestParams
616
+ class Address < Stripe::RequestParams
617
+ # City, district, suburb, town, or village.
618
+ sig { returns(String) }
619
+ attr_accessor :city
620
+ # A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
621
+ sig { returns(String) }
622
+ attr_accessor :country
623
+ # Address line 1 (e.g., street, PO Box, or company name).
624
+ sig { returns(String) }
625
+ attr_accessor :line1
626
+ # Address line 2 (e.g., apartment, suite, unit, or building).
627
+ sig { returns(String) }
628
+ attr_accessor :line2
629
+ # ZIP or postal code.
630
+ sig { returns(String) }
631
+ attr_accessor :postal_code
632
+ # State, county, province, or region.
633
+ sig { returns(String) }
634
+ attr_accessor :state
635
+ sig {
636
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
637
+ }
638
+ def initialize(
639
+ city: nil,
640
+ country: nil,
641
+ line1: nil,
642
+ line2: nil,
643
+ postal_code: nil,
644
+ state: nil
645
+ ); end
646
+ end
647
+ # Customer shipping address.
648
+ sig { returns(::Stripe::Customer::CreateParams::Shipping::Address) }
649
+ attr_accessor :address
650
+ # Customer name.
651
+ sig { returns(String) }
652
+ attr_accessor :name
653
+ # Customer phone (including extension).
654
+ sig { returns(String) }
655
+ attr_accessor :phone
656
+ sig {
657
+ params(address: ::Stripe::Customer::CreateParams::Shipping::Address, name: String, phone: String).void
658
+ }
659
+ def initialize(address: nil, name: nil, phone: nil); end
660
+ end
661
+ class Tax < Stripe::RequestParams
662
+ # A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
663
+ sig { returns(T.nilable(String)) }
664
+ attr_accessor :ip_address
665
+ # A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.
666
+ sig { returns(String) }
667
+ attr_accessor :validate_location
668
+ sig { params(ip_address: T.nilable(String), validate_location: String).void }
669
+ def initialize(ip_address: nil, validate_location: nil); end
670
+ end
671
+ class TaxIdDatum < Stripe::RequestParams
672
+ # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
673
+ sig { returns(String) }
674
+ attr_accessor :type
675
+ # Value of the tax ID.
676
+ sig { returns(String) }
677
+ attr_accessor :value
678
+ sig { params(type: String, value: String).void }
679
+ def initialize(type: nil, value: nil); end
680
+ end
681
+ # The customer's address.
682
+ sig { returns(T.nilable(::Stripe::Customer::CreateParams::Address)) }
683
+ attr_accessor :address
684
+ # An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
685
+ sig { returns(Integer) }
686
+ attr_accessor :balance
687
+ # Balance information and default balance settings for this customer.
688
+ sig { returns(::Stripe::Customer::CreateParams::CashBalance) }
689
+ attr_accessor :cash_balance
690
+ # Attribute for param field coupon
691
+ sig { returns(String) }
692
+ attr_accessor :coupon
693
+ # An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
694
+ sig { returns(String) }
695
+ attr_accessor :description
696
+ # Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
697
+ sig { returns(String) }
698
+ attr_accessor :email
699
+ # Specifies which fields in the response should be expanded.
700
+ sig { returns(T::Array[String]) }
701
+ attr_accessor :expand
702
+ # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
703
+ sig { returns(String) }
704
+ attr_accessor :invoice_prefix
705
+ # Default invoice settings for this customer.
706
+ sig { returns(::Stripe::Customer::CreateParams::InvoiceSettings) }
707
+ attr_accessor :invoice_settings
708
+ # 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`.
709
+ sig { returns(T.nilable(T::Hash[String, String])) }
710
+ attr_accessor :metadata
711
+ # The customer's full name or business name.
712
+ sig { returns(String) }
713
+ attr_accessor :name
714
+ # The sequence to be used on the customer's next invoice. Defaults to 1.
715
+ sig { returns(Integer) }
716
+ attr_accessor :next_invoice_sequence
717
+ # Attribute for param field payment_method
718
+ sig { returns(String) }
719
+ attr_accessor :payment_method
720
+ # The customer's phone number.
721
+ sig { returns(String) }
722
+ attr_accessor :phone
723
+ # Customer's preferred languages, ordered by preference.
724
+ sig { returns(T::Array[String]) }
725
+ attr_accessor :preferred_locales
726
+ # The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
727
+ sig { returns(String) }
728
+ attr_accessor :promotion_code
729
+ # The customer's shipping information. Appears on invoices emailed to this customer.
730
+ sig { returns(T.nilable(::Stripe::Customer::CreateParams::Shipping)) }
731
+ attr_accessor :shipping
732
+ # Attribute for param field source
733
+ sig { returns(String) }
734
+ attr_accessor :source
735
+ # Tax details about the customer.
736
+ sig { returns(::Stripe::Customer::CreateParams::Tax) }
737
+ attr_accessor :tax
738
+ # The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
739
+ sig { returns(T.nilable(String)) }
740
+ attr_accessor :tax_exempt
741
+ # The customer's tax IDs.
742
+ sig { returns(T::Array[::Stripe::Customer::CreateParams::TaxIdDatum]) }
743
+ attr_accessor :tax_id_data
744
+ # ID of the test clock to attach to the customer.
745
+ sig { returns(String) }
746
+ attr_accessor :test_clock
747
+ # Attribute for param field validate
748
+ sig { returns(T::Boolean) }
749
+ attr_accessor :validate
750
+ sig {
751
+ params(address: T.nilable(::Stripe::Customer::CreateParams::Address), balance: Integer, cash_balance: ::Stripe::Customer::CreateParams::CashBalance, coupon: String, description: String, email: String, expand: T::Array[String], invoice_prefix: String, invoice_settings: ::Stripe::Customer::CreateParams::InvoiceSettings, metadata: T.nilable(T::Hash[String, String]), name: String, next_invoice_sequence: Integer, payment_method: String, phone: String, preferred_locales: T::Array[String], promotion_code: String, shipping: T.nilable(::Stripe::Customer::CreateParams::Shipping), source: String, tax: ::Stripe::Customer::CreateParams::Tax, tax_exempt: T.nilable(String), tax_id_data: T::Array[::Stripe::Customer::CreateParams::TaxIdDatum], test_clock: String, validate: T::Boolean).void
752
+ }
753
+ def initialize(
754
+ address: nil,
755
+ balance: nil,
756
+ cash_balance: nil,
757
+ coupon: nil,
758
+ description: nil,
759
+ email: nil,
760
+ expand: nil,
761
+ invoice_prefix: nil,
762
+ invoice_settings: nil,
763
+ metadata: nil,
764
+ name: nil,
765
+ next_invoice_sequence: nil,
766
+ payment_method: nil,
767
+ phone: nil,
768
+ preferred_locales: nil,
769
+ promotion_code: nil,
770
+ shipping: nil,
771
+ source: nil,
772
+ tax: nil,
773
+ tax_exempt: nil,
774
+ tax_id_data: nil,
775
+ test_clock: nil,
776
+ validate: nil
777
+ ); end
778
+ end
779
+ class ListPaymentMethodsParams < Stripe::RequestParams
780
+ # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
781
+ sig { returns(String) }
782
+ attr_accessor :allow_redisplay
783
+ # 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.
784
+ sig { returns(String) }
785
+ attr_accessor :ending_before
786
+ # Specifies which fields in the response should be expanded.
787
+ sig { returns(T::Array[String]) }
788
+ attr_accessor :expand
789
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
790
+ sig { returns(Integer) }
791
+ attr_accessor :limit
792
+ # 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.
793
+ sig { returns(String) }
794
+ attr_accessor :starting_after
795
+ # An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
796
+ sig { returns(String) }
797
+ attr_accessor :type
798
+ sig {
799
+ params(allow_redisplay: String, ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, type: String).void
800
+ }
801
+ def initialize(
802
+ allow_redisplay: nil,
803
+ ending_before: nil,
804
+ expand: nil,
805
+ limit: nil,
806
+ starting_after: nil,
807
+ type: nil
808
+ ); end
809
+ end
810
+ class RetrievePaymentMethodParams < Stripe::RequestParams
811
+ # Specifies which fields in the response should be expanded.
812
+ sig { returns(T::Array[String]) }
813
+ attr_accessor :expand
814
+ sig { params(expand: T::Array[String]).void }
815
+ def initialize(expand: nil); end
816
+ end
817
+ class SearchParams < Stripe::RequestParams
818
+ # Specifies which fields in the response should be expanded.
819
+ sig { returns(T::Array[String]) }
820
+ attr_accessor :expand
821
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
822
+ sig { returns(Integer) }
823
+ attr_accessor :limit
824
+ # A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
825
+ sig { returns(String) }
826
+ attr_accessor :page
827
+ # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers).
828
+ sig { returns(String) }
829
+ attr_accessor :query
830
+ sig { params(expand: T::Array[String], limit: Integer, page: String, query: String).void }
831
+ def initialize(expand: nil, limit: nil, page: nil, query: nil); end
832
+ end
833
+ class CreateFundingInstructionsParams < Stripe::RequestParams
834
+ class BankTransfer < Stripe::RequestParams
835
+ class EuBankTransfer < Stripe::RequestParams
836
+ # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
837
+ sig { returns(String) }
838
+ attr_accessor :country
839
+ sig { params(country: String).void }
840
+ def initialize(country: nil); end
841
+ end
842
+ # Configuration for eu_bank_transfer funding type.
843
+ sig {
844
+ returns(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer::EuBankTransfer)
845
+ }
846
+ attr_accessor :eu_bank_transfer
847
+ # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
848
+ #
849
+ # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
850
+ sig { returns(T::Array[String]) }
851
+ attr_accessor :requested_address_types
852
+ # The type of the `bank_transfer`
853
+ sig { returns(String) }
854
+ attr_accessor :type
855
+ sig {
856
+ params(eu_bank_transfer: ::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer::EuBankTransfer, requested_address_types: T::Array[String], type: String).void
857
+ }
858
+ def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
859
+ end
860
+ # Additional parameters for `bank_transfer` funding types
861
+ sig { returns(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer) }
862
+ attr_accessor :bank_transfer
863
+ # 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).
864
+ sig { returns(String) }
865
+ attr_accessor :currency
866
+ # Specifies which fields in the response should be expanded.
867
+ sig { returns(T::Array[String]) }
868
+ attr_accessor :expand
869
+ # The `funding_type` to get the instructions for.
870
+ sig { returns(String) }
871
+ attr_accessor :funding_type
872
+ sig {
873
+ params(bank_transfer: ::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer, currency: String, expand: T::Array[String], funding_type: String).void
874
+ }
875
+ def initialize(bank_transfer: nil, currency: nil, expand: nil, funding_type: nil); end
876
+ end
877
+ class FundCashBalanceParams < Stripe::RequestParams
878
+ # Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
879
+ sig { returns(Integer) }
880
+ attr_accessor :amount
881
+ # 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).
882
+ sig { returns(String) }
883
+ attr_accessor :currency
884
+ # Specifies which fields in the response should be expanded.
885
+ sig { returns(T::Array[String]) }
886
+ attr_accessor :expand
887
+ # A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs.
888
+ sig { returns(String) }
889
+ attr_accessor :reference
890
+ sig {
891
+ params(amount: Integer, currency: String, expand: T::Array[String], reference: String).void
892
+ }
893
+ def initialize(amount: nil, currency: nil, expand: nil, reference: nil); end
894
+ end
895
+ # Creates a new customer object.
896
+ sig {
897
+ params(params: T.any(::Stripe::Customer::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
898
+ }
899
+ def self.create(params = {}, opts = {}); end
900
+
901
+ # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
902
+ # funding instructions will be created. If funding instructions have already been created for a given customer, the same
903
+ # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
904
+ sig {
905
+ params(params: T.any(::Stripe::Customer::CreateFundingInstructionsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FundingInstructions)
906
+ }
907
+ def create_funding_instructions(params = {}, opts = {}); end
908
+
909
+ # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
910
+ # funding instructions will be created. If funding instructions have already been created for a given customer, the same
911
+ # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
912
+ sig {
913
+ params(customer: String, params: T.any(::Stripe::Customer::CreateFundingInstructionsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FundingInstructions)
914
+ }
915
+ def self.create_funding_instructions(customer, params = {}, opts = {}); end
916
+
917
+ # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
918
+ sig {
919
+ params(id: String, params: T.any(::Stripe::Customer::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
920
+ }
921
+ def self.delete(id, params = {}, opts = {}); end
922
+
923
+ # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
924
+ sig {
925
+ params(params: T.any(::Stripe::Customer::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
926
+ }
927
+ def delete(params = {}, opts = {}); end
928
+
929
+ # Removes the currently applied discount on a customer.
930
+ sig {
931
+ params(params: T.any(::Stripe::Customer::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
932
+ }
933
+ def delete_discount(params = {}, opts = {}); end
934
+
935
+ # Removes the currently applied discount on a customer.
936
+ sig {
937
+ params(customer: String, params: T.any(::Stripe::Customer::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
938
+ }
939
+ def self.delete_discount(customer, params = {}, opts = {}); end
940
+
941
+ # Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
942
+ sig {
943
+ params(params: T.any(::Stripe::Customer::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
944
+ }
945
+ def self.list(params = {}, opts = {}); end
946
+
947
+ # Returns a list of PaymentMethods for a given Customer
948
+ sig {
949
+ params(params: T.any(::Stripe::Customer::ListPaymentMethodsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
950
+ }
951
+ def list_payment_methods(params = {}, opts = {}); end
952
+
953
+ # Returns a list of PaymentMethods for a given Customer
954
+ sig {
955
+ params(customer: String, params: T.any(::Stripe::Customer::ListPaymentMethodsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
956
+ }
957
+ def self.list_payment_methods(customer, params = {}, opts = {}); end
958
+
959
+ # Retrieves a customer's cash balance.
960
+ sig {
961
+ params(customer: String, params: T.any(::Stripe::Customer::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.untyped)
962
+ }
963
+ def self.retrieve_cash_balance(customer, params = {}, opts = {}); end
964
+
965
+ # Retrieves a PaymentMethod object for a given Customer.
966
+ sig {
967
+ params(payment_method: String, params: T.any(::Stripe::Customer::RetrievePaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
968
+ }
969
+ def retrieve_payment_method(payment_method, params = {}, opts = {}); end
970
+
971
+ # Retrieves a PaymentMethod object for a given Customer.
972
+ sig {
973
+ params(customer: String, payment_method: String, params: T.any(::Stripe::Customer::RetrievePaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
974
+ }
975
+ def self.retrieve_payment_method(customer, payment_method, params = {}, opts = {}); end
976
+
977
+ sig {
978
+ params(params: T.any(::Stripe::Customer::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
979
+ }
980
+ def self.search(params = {}, opts = {}); end
981
+
982
+ sig {
983
+ params(params: T.any(::Stripe::Customer::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
984
+ }
985
+ def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
986
+
987
+ # Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer's active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer's current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
988
+ #
989
+ # This request accepts mostly the same arguments as the customer creation call.
990
+ sig {
991
+ params(id: String, params: T.any(::Stripe::Customer::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
992
+ }
993
+ def self.update(id, params = {}, opts = {}); end
994
+
995
+ # Changes the settings on a customer's cash balance.
996
+ sig {
997
+ params(customer: String, params: T.any(::Stripe::Customer::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.untyped)
998
+ }
999
+ def self.update_cash_balance(customer, params = {}, opts = {}); end
1000
+ end
1001
+ end