stripe 13.3.0 → 13.4.0.pre.beta.1

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 +1410 -650
  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 +5793 -0
  11. data/lib/stripe/resources/account_link.rb +64 -0
  12. data/lib/stripe/resources/account_notice.rb +154 -0
  13. data/lib/stripe/resources/account_session.rb +1002 -0
  14. data/lib/stripe/resources/apple_pay_domain.rb +73 -0
  15. data/lib/stripe/resources/application.rb +23 -0
  16. data/lib/stripe/resources/application_fee.rb +120 -0
  17. data/lib/stripe/resources/application_fee_refund.rb +24 -0
  18. data/lib/stripe/resources/apps/secret.rb +166 -0
  19. data/lib/stripe/resources/balance.rb +162 -0
  20. data/lib/stripe/resources/balance_transaction.rb +141 -0
  21. data/lib/stripe/resources/bank_account.rb +113 -2
  22. data/lib/stripe/resources/billing/alert.rb +166 -0
  23. data/lib/stripe/resources/billing/alert_triggered.rb +31 -0
  24. data/lib/stripe/resources/billing/credit_balance_summary.rb +89 -0
  25. data/lib/stripe/resources/billing/credit_balance_transaction.rb +140 -0
  26. data/lib/stripe/resources/billing/credit_grant.rb +235 -0
  27. data/lib/stripe/resources/billing/meter.rb +203 -0
  28. data/lib/stripe/resources/billing/meter_error_report.rb +70 -0
  29. data/lib/stripe/resources/billing/meter_event.rb +45 -0
  30. data/lib/stripe/resources/billing/meter_event_adjustment.rb +51 -0
  31. data/lib/stripe/resources/billing/meter_event_summary.rb +21 -0
  32. data/lib/stripe/resources/billing_portal/configuration.rb +639 -0
  33. data/lib/stripe/resources/billing_portal/session.rb +313 -0
  34. data/lib/stripe/resources/capability.rb +111 -0
  35. data/lib/stripe/resources/capital/financing_offer.rb +221 -0
  36. data/lib/stripe/resources/capital/financing_summary.rb +77 -0
  37. data/lib/stripe/resources/capital/financing_transaction.rb +147 -0
  38. data/lib/stripe/resources/card.rb +111 -0
  39. data/lib/stripe/resources/cash_balance.rb +22 -0
  40. data/lib/stripe/resources/charge.rb +3687 -0
  41. data/lib/stripe/resources/checkout/session.rb +4162 -0
  42. data/lib/stripe/resources/climate/order.rb +216 -0
  43. data/lib/stripe/resources/climate/product.rb +69 -0
  44. data/lib/stripe/resources/climate/supplier.rb +67 -0
  45. data/lib/stripe/resources/confirmation_token.rb +1855 -0
  46. data/lib/stripe/resources/connect_collection_transfer.rb +29 -0
  47. data/lib/stripe/resources/country_spec.rb +76 -0
  48. data/lib/stripe/resources/coupon.rb +237 -0
  49. data/lib/stripe/resources/credit_note.rb +798 -0
  50. data/lib/stripe/resources/credit_note_line_item.rb +89 -0
  51. data/lib/stripe/resources/customer.rb +995 -0
  52. data/lib/stripe/resources/customer_balance_transaction.rb +39 -0
  53. data/lib/stripe/resources/customer_cash_balance_transaction.rb +136 -0
  54. data/lib/stripe/resources/customer_session.rb +183 -0
  55. data/lib/stripe/resources/discount.rb +41 -0
  56. data/lib/stripe/resources/dispute.rb +767 -0
  57. data/lib/stripe/resources/entitlements/active_entitlement.rb +54 -0
  58. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +26 -0
  59. data/lib/stripe/resources/entitlements/feature.rb +107 -0
  60. data/lib/stripe/resources/ephemeral_key.rb +26 -0
  61. data/lib/stripe/resources/event.rb +157 -0
  62. data/lib/stripe/resources/exchange_rate.rb +38 -0
  63. data/lib/stripe/resources/file.rb +134 -0
  64. data/lib/stripe/resources/file_link.rb +134 -0
  65. data/lib/stripe/resources/financial_connections/account.rb +307 -0
  66. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +30 -0
  67. data/lib/stripe/resources/financial_connections/account_owner.rb +24 -0
  68. data/lib/stripe/resources/financial_connections/account_ownership.rb +12 -0
  69. data/lib/stripe/resources/financial_connections/institution.rb +112 -0
  70. data/lib/stripe/resources/financial_connections/session.rb +187 -0
  71. data/lib/stripe/resources/financial_connections/transaction.rb +122 -0
  72. data/lib/stripe/resources/forwarding/request.rb +196 -0
  73. data/lib/stripe/resources/funding_instructions.rb +415 -0
  74. data/lib/stripe/resources/gift_cards/card.rb +245 -0
  75. data/lib/stripe/resources/gift_cards/transaction.rb +313 -0
  76. data/lib/stripe/resources/identity/verification_report.rb +335 -0
  77. data/lib/stripe/resources/identity/verification_session.rb +430 -0
  78. data/lib/stripe/resources/invoice.rb +9348 -0
  79. data/lib/stripe/resources/invoice_item.rb +536 -0
  80. data/lib/stripe/resources/invoice_line_item.rb +409 -0
  81. data/lib/stripe/resources/invoice_payment.rb +72 -0
  82. data/lib/stripe/resources/invoice_rendering_template.rb +79 -0
  83. data/lib/stripe/resources/issuing/authorization.rb +1316 -2
  84. data/lib/stripe/resources/issuing/card.rb +794 -0
  85. data/lib/stripe/resources/issuing/cardholder.rb +768 -0
  86. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +693 -0
  87. data/lib/stripe/resources/issuing/dispute.rb +941 -0
  88. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +98 -0
  89. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +109 -0
  90. data/lib/stripe/resources/issuing/personalization_design.rb +333 -0
  91. data/lib/stripe/resources/issuing/physical_bundle.rb +76 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +65 -0
  93. data/lib/stripe/resources/issuing/token.rb +221 -0
  94. data/lib/stripe/resources/issuing/transaction.rb +1098 -0
  95. data/lib/stripe/resources/line_item.rb +98 -0
  96. data/lib/stripe/resources/login_link.rb +9 -0
  97. data/lib/stripe/resources/mandate.rb +214 -0
  98. data/lib/stripe/resources/margin.rb +143 -0
  99. data/lib/stripe/resources/order.rb +3238 -0
  100. data/lib/stripe/resources/payment_attempt_record.rb +226 -0
  101. data/lib/stripe/resources/payment_intent.rb +14630 -0
  102. data/lib/stripe/resources/payment_link.rb +1761 -0
  103. data/lib/stripe/resources/payment_method.rb +1981 -0
  104. data/lib/stripe/resources/payment_method_configuration.rb +3137 -0
  105. data/lib/stripe/resources/payment_method_domain.rb +176 -0
  106. data/lib/stripe/resources/payment_record.rb +824 -0
  107. data/lib/stripe/resources/payout.rb +267 -0
  108. data/lib/stripe/resources/person.rb +353 -0
  109. data/lib/stripe/resources/plan.rb +386 -0
  110. data/lib/stripe/resources/price.rb +782 -0
  111. data/lib/stripe/resources/product.rb +636 -0
  112. data/lib/stripe/resources/product_feature.rb +16 -0
  113. data/lib/stripe/resources/promotion_code.rb +261 -0
  114. data/lib/stripe/resources/quote.rb +3404 -0
  115. data/lib/stripe/resources/quote_line.rb +340 -0
  116. data/lib/stripe/resources/quote_preview_invoice.rb +833 -0
  117. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +463 -0
  118. data/lib/stripe/resources/radar/early_fraud_warning.rb +93 -0
  119. data/lib/stripe/resources/radar/value_list.rb +151 -0
  120. data/lib/stripe/resources/radar/value_list_item.rb +113 -0
  121. data/lib/stripe/resources/refund.rb +489 -0
  122. data/lib/stripe/resources/reporting/report_run.rb +182 -0
  123. data/lib/stripe/resources/reporting/report_type.rb +44 -0
  124. data/lib/stripe/resources/reserve_transaction.rb +26 -0
  125. data/lib/stripe/resources/reversal.rb +30 -0
  126. data/lib/stripe/resources/review.rb +135 -0
  127. data/lib/stripe/resources/setup_attempt.rb +474 -0
  128. data/lib/stripe/resources/setup_intent.rb +4371 -0
  129. data/lib/stripe/resources/shipping_rate.rb +303 -0
  130. data/lib/stripe/resources/sigma/scheduled_query_run.rb +67 -0
  131. data/lib/stripe/resources/source.rb +1571 -0
  132. data/lib/stripe/resources/source_mandate_notification.rb +79 -0
  133. data/lib/stripe/resources/source_transaction.rb +114 -0
  134. data/lib/stripe/resources/subscription.rb +2395 -0
  135. data/lib/stripe/resources/subscription_item.rb +502 -0
  136. data/lib/stripe/resources/subscription_schedule.rb +2790 -0
  137. data/lib/stripe/resources/tax/association.rb +100 -0
  138. data/lib/stripe/resources/tax/calculation.rb +474 -0
  139. data/lib/stripe/resources/tax/calculation_line_item.rb +76 -0
  140. data/lib/stripe/resources/tax/form.rb +253 -0
  141. data/lib/stripe/resources/tax/registration.rb +2174 -0
  142. data/lib/stripe/resources/tax/settings.rb +146 -0
  143. data/lib/stripe/resources/tax/transaction.rb +332 -0
  144. data/lib/stripe/resources/tax/transaction_line_item.rb +43 -0
  145. data/lib/stripe/resources/tax_code.rb +41 -0
  146. data/lib/stripe/resources/tax_deducted_at_source.rb +26 -0
  147. data/lib/stripe/resources/tax_id.rb +147 -0
  148. data/lib/stripe/resources/tax_rate.rb +245 -0
  149. data/lib/stripe/resources/terminal/configuration.rb +1175 -0
  150. data/lib/stripe/resources/terminal/connection_token.rb +21 -0
  151. data/lib/stripe/resources/terminal/location.rb +208 -0
  152. data/lib/stripe/resources/terminal/reader.rb +911 -0
  153. data/lib/stripe/resources/terminal/reader_collected_data.rb +45 -0
  154. data/lib/stripe/resources/test_helpers/test_clock.rb +101 -0
  155. data/lib/stripe/resources/token.rb +1337 -0
  156. data/lib/stripe/resources/topup.rb +210 -0
  157. data/lib/stripe/resources/transfer.rb +188 -0
  158. data/lib/stripe/resources/treasury/credit_reversal.rb +113 -0
  159. data/lib/stripe/resources/treasury/debit_reversal.rb +126 -0
  160. data/lib/stripe/resources/treasury/financial_account.rb +766 -0
  161. data/lib/stripe/resources/treasury/financial_account_features.rb +237 -0
  162. data/lib/stripe/resources/treasury/inbound_transfer.rb +285 -0
  163. data/lib/stripe/resources/treasury/outbound_payment.rb +587 -0
  164. data/lib/stripe/resources/treasury/outbound_transfer.rb +428 -0
  165. data/lib/stripe/resources/treasury/received_credit.rb +335 -0
  166. data/lib/stripe/resources/treasury/received_debit.rb +298 -0
  167. data/lib/stripe/resources/treasury/transaction.rb +215 -0
  168. data/lib/stripe/resources/treasury/transaction_entry.rb +193 -0
  169. data/lib/stripe/resources/usage_record.rb +18 -0
  170. data/lib/stripe/resources/usage_record_summary.rb +28 -0
  171. data/lib/stripe/resources/v2/amount.rb +9 -0
  172. data/lib/stripe/resources/v2/billing/meter_event.rb +24 -0
  173. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +28 -0
  174. data/lib/stripe/resources/v2/billing/meter_event_session.rb +19 -0
  175. data/lib/stripe/resources/v2/event.rb +35 -0
  176. data/lib/stripe/resources/v2/event_destination.rb +78 -0
  177. data/lib/stripe/resources/webhook_endpoint.rb +148 -0
  178. data/lib/stripe/resources.rb +31 -0
  179. data/lib/stripe/services/account_capability_service.rb +33 -0
  180. data/lib/stripe/services/account_external_account_service.rb +293 -0
  181. data/lib/stripe/services/account_link_service.rb +53 -0
  182. data/lib/stripe/services/account_login_link_service.rb +9 -0
  183. data/lib/stripe/services/account_notice_service.rb +110 -0
  184. data/lib/stripe/services/account_person_service.rb +1014 -0
  185. data/lib/stripe/services/account_service.rb +4862 -0
  186. data/lib/stripe/services/account_session_service.rb +740 -0
  187. data/lib/stripe/services/apple_pay_domain_service.rb +56 -0
  188. data/lib/stripe/services/application_fee_refund_service.rb +60 -0
  189. data/lib/stripe/services/application_fee_service.rb +65 -0
  190. data/lib/stripe/services/apps/secret_service.rb +132 -0
  191. data/lib/stripe/services/balance_service.rb +9 -0
  192. data/lib/stripe/services/balance_transaction_service.rb +80 -0
  193. data/lib/stripe/services/billing/alert_service.rb +125 -0
  194. data/lib/stripe/services/billing/credit_balance_summary_service.rb +41 -0
  195. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +45 -0
  196. data/lib/stripe/services/billing/credit_grant_service.rb +167 -0
  197. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +29 -0
  198. data/lib/stripe/services/billing/meter_event_service.rb +25 -0
  199. data/lib/stripe/services/billing/meter_event_summary_service.rb +46 -0
  200. data/lib/stripe/services/billing/meter_service.rb +142 -0
  201. data/lib/stripe/services/billing_portal/configuration_service.rb +492 -0
  202. data/lib/stripe/services/billing_portal/session_service.rb +192 -0
  203. data/lib/stripe/services/capital/financing_offer_service.rb +121 -0
  204. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  205. data/lib/stripe/services/capital/financing_transaction_service.rb +86 -0
  206. data/lib/stripe/services/capital_service.rb +15 -0
  207. data/lib/stripe/services/charge_service.rb +2010 -0
  208. data/lib/stripe/services/checkout/session_line_item_service.rb +21 -0
  209. data/lib/stripe/services/checkout/session_service.rb +2736 -0
  210. data/lib/stripe/services/climate/order_service.rb +113 -0
  211. data/lib/stripe/services/climate/product_service.rb +30 -0
  212. data/lib/stripe/services/climate/supplier_service.rb +30 -0
  213. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  214. data/lib/stripe/services/country_spec_service.rb +30 -0
  215. data/lib/stripe/services/coupon_service.rb +174 -0
  216. data/lib/stripe/services/credit_note_line_item_service.rb +21 -0
  217. data/lib/stripe/services/credit_note_preview_lines_service.rb +184 -0
  218. data/lib/stripe/services/credit_note_service.rb +434 -0
  219. data/lib/stripe/services/customer_balance_transaction_service.rb +72 -0
  220. data/lib/stripe/services/customer_cash_balance_service.rb +30 -0
  221. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +30 -0
  222. data/lib/stripe/services/customer_funding_instructions_service.rb +47 -0
  223. data/lib/stripe/services/customer_payment_method_service.rb +45 -0
  224. data/lib/stripe/services/customer_payment_source_service.rb +208 -0
  225. data/lib/stripe/services/customer_service.rb +684 -0
  226. data/lib/stripe/services/customer_session_service.rb +106 -0
  227. data/lib/stripe/services/customer_tax_id_service.rb +50 -0
  228. data/lib/stripe/services/dispute_service.rb +439 -0
  229. data/lib/stripe/services/entitlements/active_entitlement_service.rb +40 -0
  230. data/lib/stripe/services/entitlements/feature_service.rb +87 -0
  231. data/lib/stripe/services/ephemeral_key_service.rb +40 -0
  232. data/lib/stripe/services/event_service.rb +75 -0
  233. data/lib/stripe/services/exchange_rate_service.rb +30 -0
  234. data/lib/stripe/services/file_link_service.rb +108 -0
  235. data/lib/stripe/services/file_service.rb +102 -0
  236. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +40 -0
  237. data/lib/stripe/services/financial_connections/account_owner_service.rb +31 -0
  238. data/lib/stripe/services/financial_connections/account_service.rb +108 -1
  239. data/lib/stripe/services/financial_connections/institution_service.rb +60 -0
  240. data/lib/stripe/services/financial_connections/session_service.rb +108 -0
  241. data/lib/stripe/services/financial_connections/transaction_service.rb +79 -0
  242. data/lib/stripe/services/financial_connections_service.rb +2 -1
  243. data/lib/stripe/services/forwarding/request_service.rb +120 -0
  244. data/lib/stripe/services/gift_cards/card_service.rb +183 -0
  245. data/lib/stripe/services/gift_cards/transaction_service.rb +225 -0
  246. data/lib/stripe/services/gift_cards_service.rb +14 -0
  247. data/lib/stripe/services/identity/verification_report_service.rb +75 -0
  248. data/lib/stripe/services/identity/verification_session_service.rb +261 -0
  249. data/lib/stripe/services/invoice_item_service.rb +454 -0
  250. data/lib/stripe/services/invoice_line_item_service.rb +277 -0
  251. data/lib/stripe/services/invoice_payment_service.rb +58 -0
  252. data/lib/stripe/services/invoice_rendering_template_service.rb +56 -0
  253. data/lib/stripe/services/invoice_service.rb +6375 -1
  254. data/lib/stripe/services/invoice_upcoming_lines_service.rb +2142 -0
  255. data/lib/stripe/services/issuing/authorization_service.rb +118 -0
  256. data/lib/stripe/services/issuing/card_service.rb +525 -0
  257. data/lib/stripe/services/issuing/cardholder_service.rb +599 -0
  258. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +560 -0
  259. data/lib/stripe/services/issuing/dispute_service.rb +731 -0
  260. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +70 -0
  261. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +90 -0
  262. data/lib/stripe/services/issuing/personalization_design_service.rb +222 -0
  263. data/lib/stripe/services/issuing/physical_bundle_service.rb +45 -0
  264. data/lib/stripe/services/issuing/token_service.rb +83 -0
  265. data/lib/stripe/services/issuing/transaction_service.rb +93 -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 +130 -0
  269. data/lib/stripe/services/order_line_item_service.rb +38 -0
  270. data/lib/stripe/services/order_service.rb +2518 -0
  271. data/lib/stripe/services/payment_attempt_record_service.rb +50 -0
  272. data/lib/stripe/services/payment_intent_service.rb +12203 -0
  273. data/lib/stripe/services/payment_link_line_item_service.rb +21 -0
  274. data/lib/stripe/services/payment_link_service.rb +1343 -0
  275. data/lib/stripe/services/payment_method_configuration_service.rb +2148 -0
  276. data/lib/stripe/services/payment_method_domain_service.rb +84 -0
  277. data/lib/stripe/services/payment_method_service.rb +977 -0
  278. data/lib/stripe/services/payment_record_service.rb +610 -0
  279. data/lib/stripe/services/payout_service.rb +182 -0
  280. data/lib/stripe/services/plan_service.rb +296 -0
  281. data/lib/stripe/services/price_service.rb +603 -0
  282. data/lib/stripe/services/product_feature_service.rb +46 -0
  283. data/lib/stripe/services/product_service.rb +533 -0
  284. data/lib/stripe/services/promotion_code_service.rb +203 -0
  285. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +21 -0
  286. data/lib/stripe/services/quote_line_item_service.rb +21 -0
  287. data/lib/stripe/services/quote_line_service.rb +38 -0
  288. data/lib/stripe/services/quote_preview_invoice_service.rb +38 -0
  289. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +38 -0
  290. data/lib/stripe/services/quote_service.rb +2628 -1
  291. data/lib/stripe/services/radar/early_fraud_warning_service.rb +70 -0
  292. data/lib/stripe/services/radar/value_list_item_service.rb +90 -0
  293. data/lib/stripe/services/radar/value_list_service.rb +119 -0
  294. data/lib/stripe/services/refund_service.rb +158 -0
  295. data/lib/stripe/services/reporting/report_run_service.rb +122 -0
  296. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  297. data/lib/stripe/services/review_service.rb +63 -0
  298. data/lib/stripe/services/setup_attempt_service.rb +59 -0
  299. data/lib/stripe/services/setup_intent_service.rb +3923 -0
  300. data/lib/stripe/services/shipping_rate_service.rb +227 -0
  301. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +30 -0
  302. data/lib/stripe/services/source_service.rb +693 -0
  303. data/lib/stripe/services/source_transaction_service.rb +21 -0
  304. data/lib/stripe/services/subscription_item_service.rb +439 -0
  305. data/lib/stripe/services/subscription_item_usage_record_service.rb +21 -0
  306. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +21 -0
  307. data/lib/stripe/services/subscription_schedule_service.rb +2343 -0
  308. data/lib/stripe/services/subscription_service.rb +1967 -0
  309. data/lib/stripe/services/tax/association_service.rb +32 -0
  310. data/lib/stripe/services/tax/calculation_line_item_service.rb +21 -0
  311. data/lib/stripe/services/tax/calculation_service.rb +235 -0
  312. data/lib/stripe/services/tax/form_service.rb +107 -0
  313. data/lib/stripe/services/tax/registration_service.rb +1398 -0
  314. data/lib/stripe/services/tax/settings_service.rb +82 -0
  315. data/lib/stripe/services/tax/transaction_line_item_service.rb +21 -0
  316. data/lib/stripe/services/tax/transaction_service.rb +128 -0
  317. data/lib/stripe/services/tax_code_service.rb +30 -0
  318. data/lib/stripe/services/tax_id_service.rb +90 -0
  319. data/lib/stripe/services/tax_rate_service.rb +182 -0
  320. data/lib/stripe/services/tax_service.rb +3 -1
  321. data/lib/stripe/services/terminal/configuration_service.rb +901 -0
  322. data/lib/stripe/services/terminal/connection_token_service.rb +13 -0
  323. data/lib/stripe/services/terminal/location_service.rb +165 -0
  324. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  325. data/lib/stripe/services/terminal/reader_service.rb +496 -0
  326. data/lib/stripe/services/terminal_service.rb +2 -1
  327. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +762 -0
  328. data/lib/stripe/services/test_helpers/customer_service.rb +21 -0
  329. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +844 -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 +43 -0
  332. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +723 -0
  333. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  334. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +48 -0
  335. data/lib/stripe/services/test_helpers/test_clock_service.rb +63 -0
  336. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +39 -0
  337. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +93 -0
  338. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +93 -0
  339. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +95 -0
  340. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +95 -0
  341. data/lib/stripe/services/token_service.rb +1301 -0
  342. data/lib/stripe/services/topup_service.rb +163 -0
  343. data/lib/stripe/services/transfer_reversal_service.rb +74 -0
  344. data/lib/stripe/services/transfer_service.rb +138 -0
  345. data/lib/stripe/services/treasury/credit_reversal_service.rb +67 -0
  346. data/lib/stripe/services/treasury/debit_reversal_service.rb +72 -0
  347. data/lib/stripe/services/treasury/financial_account_features_service.rb +179 -0
  348. data/lib/stripe/services/treasury/financial_account_service.rb +481 -0
  349. data/lib/stripe/services/treasury/inbound_transfer_service.rb +100 -0
  350. data/lib/stripe/services/treasury/outbound_payment_service.rb +296 -0
  351. data/lib/stripe/services/treasury/outbound_transfer_service.rb +147 -0
  352. data/lib/stripe/services/treasury/received_credit_service.rb +58 -0
  353. data/lib/stripe/services/treasury/received_debit_service.rb +45 -0
  354. data/lib/stripe/services/treasury/transaction_entry_service.rb +101 -0
  355. data/lib/stripe/services/treasury/transaction_service.rb +109 -0
  356. data/lib/stripe/services/v1_services.rb +8 -1
  357. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +25 -0
  358. data/lib/stripe/services/v2/billing/meter_event_service.rb +28 -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 +36 -0
  361. data/lib/stripe/services/v2/core/event_destination_service.rb +164 -0
  362. data/lib/stripe/services/v2/core/event_service.rb +20 -0
  363. data/lib/stripe/services/webhook_endpoint_service.rb +110 -0
  364. data/lib/stripe/services.rb +25 -0
  365. data/lib/stripe/stripe_client.rb +2 -2
  366. data/lib/stripe/stripe_configuration.rb +3 -1
  367. data/lib/stripe/stripe_object.rb +8 -3
  368. data/lib/stripe/util.rb +8 -2
  369. data/lib/stripe/version.rb +1 -1
  370. data/lib/stripe.rb +46 -0
  371. data/rbi/stripe/resources/account.rbi +6072 -0
  372. data/rbi/stripe/resources/account_link.rbi +87 -0
  373. data/rbi/stripe/resources/account_notice.rbi +166 -0
  374. data/rbi/stripe/resources/account_session.rbi +1173 -0
  375. data/rbi/stripe/resources/apple_pay_domain.rbi +111 -0
  376. data/rbi/stripe/resources/application.rbi +23 -0
  377. data/rbi/stripe/resources/application_fee.rbi +151 -0
  378. data/rbi/stripe/resources/application_fee_refund.rbi +44 -0
  379. data/rbi/stripe/resources/apps/secret.rbi +229 -0
  380. data/rbi/stripe/resources/balance.rbi +220 -0
  381. data/rbi/stripe/resources/balance_transaction.rbi +182 -0
  382. data/rbi/stripe/resources/bank_account.rbi +156 -0
  383. data/rbi/stripe/resources/billing/alert.rbi +237 -0
  384. data/rbi/stripe/resources/billing/alert_triggered.rbi +33 -0
  385. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +118 -0
  386. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +181 -0
  387. data/rbi/stripe/resources/billing/credit_grant.rbi +312 -0
  388. data/rbi/stripe/resources/billing/meter.rbi +268 -0
  389. data/rbi/stripe/resources/billing/meter_error_report.rbi +82 -0
  390. data/rbi/stripe/resources/billing/meter_event.rbi +76 -0
  391. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +75 -0
  392. data/rbi/stripe/resources/billing/meter_event_summary.rbi +39 -0
  393. data/rbi/stripe/resources/billing_portal/configuration.rbi +746 -0
  394. data/rbi/stripe/resources/billing_portal/session.rbi +396 -0
  395. data/rbi/stripe/resources/capability.rbi +152 -0
  396. data/rbi/stripe/resources/capital/financing_offer.rbi +228 -0
  397. data/rbi/stripe/resources/capital/financing_summary.rbi +89 -0
  398. data/rbi/stripe/resources/capital/financing_transaction.rbi +157 -0
  399. data/rbi/stripe/resources/card.rbi +159 -0
  400. data/rbi/stripe/resources/cash_balance.rbi +37 -0
  401. data/rbi/stripe/resources/charge.rbi +4216 -0
  402. data/rbi/stripe/resources/checkout/session.rbi +4627 -0
  403. data/rbi/stripe/resources/climate/order.rbi +298 -0
  404. data/rbi/stripe/resources/climate/product.rbi +98 -0
  405. data/rbi/stripe/resources/climate/supplier.rbi +95 -0
  406. data/rbi/stripe/resources/confirmation_token.rbi +2137 -0
  407. data/rbi/stripe/resources/connect_collection_transfer.rbi +31 -0
  408. data/rbi/stripe/resources/country_spec.rbi +108 -0
  409. data/rbi/stripe/resources/coupon.rbi +305 -0
  410. data/rbi/stripe/resources/credit_note.rbi +918 -0
  411. data/rbi/stripe/resources/credit_note_line_item.rbi +123 -0
  412. data/rbi/stripe/resources/customer.rbi +1188 -0
  413. data/rbi/stripe/resources/customer_balance_transaction.rbi +65 -0
  414. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +178 -0
  415. data/rbi/stripe/resources/customer_session.rbi +227 -0
  416. data/rbi/stripe/resources/discount.rbi +65 -0
  417. data/rbi/stripe/resources/dispute.rbi +926 -0
  418. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +76 -0
  419. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +26 -0
  420. data/rbi/stripe/resources/entitlements/feature.rbi +146 -0
  421. data/rbi/stripe/resources/ephemeral_key.rbi +51 -0
  422. data/rbi/stripe/resources/event.rbi +221 -0
  423. data/rbi/stripe/resources/exchange_rate.rbi +81 -0
  424. data/rbi/stripe/resources/file.rbi +177 -0
  425. data/rbi/stripe/resources/file_link.rbi +174 -0
  426. data/rbi/stripe/resources/financial_connections/account.rbi +414 -0
  427. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +30 -0
  428. data/rbi/stripe/resources/financial_connections/account_owner.rbi +42 -0
  429. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +26 -0
  430. data/rbi/stripe/resources/financial_connections/institution.rbi +115 -0
  431. data/rbi/stripe/resources/financial_connections/session.rbi +221 -0
  432. data/rbi/stripe/resources/financial_connections/transaction.rbi +153 -0
  433. data/rbi/stripe/resources/forwarding/request.rbi +257 -0
  434. data/rbi/stripe/resources/funding_instructions.rbi +544 -0
  435. data/rbi/stripe/resources/gift_cards/card.rbi +242 -0
  436. data/rbi/stripe/resources/gift_cards/transaction.rbi +298 -0
  437. data/rbi/stripe/resources/identity/verification_report.rbi +427 -0
  438. data/rbi/stripe/resources/identity/verification_session.rbi +601 -0
  439. data/rbi/stripe/resources/invoice.rbi +10584 -0
  440. data/rbi/stripe/resources/invoice_item.rbi +621 -0
  441. data/rbi/stripe/resources/invoice_line_item.rbi +486 -0
  442. data/rbi/stripe/resources/invoice_payment.rbi +86 -0
  443. data/rbi/stripe/resources/invoice_rendering_template.rbi +131 -0
  444. data/rbi/stripe/resources/issuing/authorization.rbi +1511 -0
  445. data/rbi/stripe/resources/issuing/card.rbi +891 -0
  446. data/rbi/stripe/resources/issuing/cardholder.rbi +870 -0
  447. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +731 -0
  448. data/rbi/stripe/resources/issuing/dispute.rbi +1077 -0
  449. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +100 -0
  450. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +108 -0
  451. data/rbi/stripe/resources/issuing/personalization_design.rbi +395 -0
  452. data/rbi/stripe/resources/issuing/physical_bundle.rbi +102 -0
  453. data/rbi/stripe/resources/issuing/settlement.rbi +78 -0
  454. data/rbi/stripe/resources/issuing/token.rbi +282 -0
  455. data/rbi/stripe/resources/issuing/transaction.rbi +1262 -0
  456. data/rbi/stripe/resources/line_item.rbi +131 -0
  457. data/rbi/stripe/resources/login_link.rbi +20 -0
  458. data/rbi/stripe/resources/mandate.rbi +266 -0
  459. data/rbi/stripe/resources/margin.rbi +151 -0
  460. data/rbi/stripe/resources/order.rbi +3505 -0
  461. data/rbi/stripe/resources/payment_attempt_record.rbi +260 -0
  462. data/rbi/stripe/resources/payment_intent.rbi +16064 -0
  463. data/rbi/stripe/resources/payment_link.rbi +1943 -0
  464. data/rbi/stripe/resources/payment_method.rbi +2287 -0
  465. data/rbi/stripe/resources/payment_method_configuration.rbi +3657 -0
  466. data/rbi/stripe/resources/payment_method_domain.rbi +246 -0
  467. data/rbi/stripe/resources/payment_record.rbi +856 -0
  468. data/rbi/stripe/resources/payout.rbi +357 -0
  469. data/rbi/stripe/resources/person.rbi +461 -0
  470. data/rbi/stripe/resources/plan.rbi +463 -0
  471. data/rbi/stripe/resources/price.rbi +884 -0
  472. data/rbi/stripe/resources/product.rbi +735 -0
  473. data/rbi/stripe/resources/product_feature.rbi +30 -0
  474. data/rbi/stripe/resources/promotion_code.rbi +316 -0
  475. data/rbi/stripe/resources/quote.rbi +3779 -0
  476. data/rbi/stripe/resources/quote_line.rbi +416 -0
  477. data/rbi/stripe/resources/quote_preview_invoice.rbi +1030 -0
  478. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +575 -0
  479. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +121 -0
  480. data/rbi/stripe/resources/radar/value_list.rbi +207 -0
  481. data/rbi/stripe/resources/radar/value_list_item.rbi +157 -0
  482. data/rbi/stripe/resources/refund.rbi +615 -0
  483. data/rbi/stripe/resources/reporting/report_run.rbi +232 -0
  484. data/rbi/stripe/resources/reporting/report_type.rbi +75 -0
  485. data/rbi/stripe/resources/reserve_transaction.rbi +27 -0
  486. data/rbi/stripe/resources/reversal.rbi +60 -0
  487. data/rbi/stripe/resources/review.rbi +191 -0
  488. data/rbi/stripe/resources/setup_attempt.rbi +587 -0
  489. data/rbi/stripe/resources/setup_intent.rbi +4726 -0
  490. data/rbi/stripe/resources/shipping_rate.rbi +367 -0
  491. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +98 -0
  492. data/rbi/stripe/resources/source.rbi +1899 -0
  493. data/rbi/stripe/resources/source_mandate_notification.rbi +90 -0
  494. data/rbi/stripe/resources/source_transaction.rbi +156 -0
  495. data/rbi/stripe/resources/subscription.rbi +2739 -0
  496. data/rbi/stripe/resources/subscription_item.rbi +566 -0
  497. data/rbi/stripe/resources/subscription_schedule.rbi +3157 -0
  498. data/rbi/stripe/resources/tax/association.rbi +107 -0
  499. data/rbi/stripe/resources/tax/calculation.rbi +577 -0
  500. data/rbi/stripe/resources/tax/calculation_line_item.rbi +108 -0
  501. data/rbi/stripe/resources/tax/form.rbi +262 -0
  502. data/rbi/stripe/resources/tax/registration.rbi +2354 -0
  503. data/rbi/stripe/resources/tax/settings.rbi +174 -0
  504. data/rbi/stripe/resources/tax/transaction.rbi +428 -0
  505. data/rbi/stripe/resources/tax/transaction_line_item.rbi +66 -0
  506. data/rbi/stripe/resources/tax_code.rbi +60 -0
  507. data/rbi/stripe/resources/tax_deducted_at_source.rbi +27 -0
  508. data/rbi/stripe/resources/tax_id.rbi +206 -0
  509. data/rbi/stripe/resources/tax_rate.rbi +295 -0
  510. data/rbi/stripe/resources/terminal/configuration.rbi +1302 -0
  511. data/rbi/stripe/resources/terminal/connection_token.rbi +42 -0
  512. data/rbi/stripe/resources/terminal/location.rbi +271 -0
  513. data/rbi/stripe/resources/terminal/reader.rbi +1110 -0
  514. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +48 -0
  515. data/rbi/stripe/resources/test_helpers/test_clock.rbi +159 -0
  516. data/rbi/stripe/resources/token.rbi +1405 -0
  517. data/rbi/stripe/resources/topup.rbi +269 -0
  518. data/rbi/stripe/resources/transfer.rbi +245 -0
  519. data/rbi/stripe/resources/treasury/credit_reversal.rbi +151 -0
  520. data/rbi/stripe/resources/treasury/debit_reversal.rbi +165 -0
  521. data/rbi/stripe/resources/treasury/financial_account.rbi +924 -0
  522. data/rbi/stripe/resources/treasury/financial_account_features.rbi +309 -0
  523. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +361 -0
  524. data/rbi/stripe/resources/treasury/outbound_payment.rbi +702 -0
  525. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +529 -0
  526. data/rbi/stripe/resources/treasury/received_credit.rbi +408 -0
  527. data/rbi/stripe/resources/treasury/received_debit.rbi +367 -0
  528. data/rbi/stripe/resources/treasury/transaction.rbi +261 -0
  529. data/rbi/stripe/resources/treasury/transaction_entry.rbi +234 -0
  530. data/rbi/stripe/resources/usage_record.rbi +37 -0
  531. data/rbi/stripe/resources/usage_record_summary.rbi +45 -0
  532. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  533. data/rbi/stripe/resources/v2/billing/meter_event.rbi +43 -0
  534. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +48 -0
  535. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +36 -0
  536. data/rbi/stripe/resources/v2/event.rbi +55 -0
  537. data/rbi/stripe/resources/v2/event_destination.rbi +109 -0
  538. data/rbi/stripe/resources/webhook_endpoint.rbi +208 -0
  539. data/rbi/stripe/services/account_capability_service.rbi +55 -0
  540. data/rbi/stripe/services/account_external_account_service.rbi +358 -0
  541. data/rbi/stripe/services/account_link_service.rbi +67 -0
  542. data/rbi/stripe/services/account_login_link_service.rbi +23 -0
  543. data/rbi/stripe/services/account_notice_service.rbi +103 -0
  544. data/rbi/stripe/services/account_person_service.rbi +1077 -0
  545. data/rbi/stripe/services/account_service.rbi +4948 -0
  546. data/rbi/stripe/services/account_session_service.rbi +873 -0
  547. data/rbi/stripe/services/apple_pay_domain_service.rbi +86 -0
  548. data/rbi/stripe/services/application_fee_refund_service.rbi +101 -0
  549. data/rbi/stripe/services/application_fee_service.rbi +85 -0
  550. data/rbi/stripe/services/apps/secret_service.rbi +175 -0
  551. data/rbi/stripe/services/apps_service.rbi +9 -0
  552. data/rbi/stripe/services/balance_service.rbi +22 -0
  553. data/rbi/stripe/services/balance_transaction_service.rbi +103 -0
  554. data/rbi/stripe/services/billing/alert_service.rbi +172 -0
  555. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +61 -0
  556. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +66 -0
  557. data/rbi/stripe/services/billing/credit_grant_service.rbi +217 -0
  558. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +45 -0
  559. data/rbi/stripe/services/billing/meter_event_service.rbi +47 -0
  560. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +62 -0
  561. data/rbi/stripe/services/billing/meter_service.rbi +184 -0
  562. data/rbi/stripe/services/billing_portal/configuration_service.rbi +573 -0
  563. data/rbi/stripe/services/billing_portal/session_service.rbi +233 -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 +108 -0
  567. data/rbi/stripe/services/capital/financing_summary_service.rbi +23 -0
  568. data/rbi/stripe/services/capital/financing_transaction_service.rbi +77 -0
  569. data/rbi/stripe/services/capital_service.rbi +11 -0
  570. data/rbi/stripe/services/charge_service.rbi +2162 -0
  571. data/rbi/stripe/services/checkout/session_line_item_service.rbi +37 -0
  572. data/rbi/stripe/services/checkout/session_service.rbi +2975 -0
  573. data/rbi/stripe/services/checkout_service.rbi +9 -0
  574. data/rbi/stripe/services/climate/order_service.rbi +158 -0
  575. data/rbi/stripe/services/climate/product_service.rbi +51 -0
  576. data/rbi/stripe/services/climate/supplier_service.rbi +51 -0
  577. data/rbi/stripe/services/climate_service.rbi +11 -0
  578. data/rbi/stripe/services/confirmation_token_service.rbi +21 -0
  579. data/rbi/stripe/services/country_spec_service.rbi +49 -0
  580. data/rbi/stripe/services/coupon_service.rbi +220 -0
  581. data/rbi/stripe/services/credit_note_line_item_service.rbi +35 -0
  582. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +200 -0
  583. data/rbi/stripe/services/credit_note_service.rbi +496 -0
  584. data/rbi/stripe/services/customer_balance_transaction_service.rbi +105 -0
  585. data/rbi/stripe/services/customer_cash_balance_service.rbi +49 -0
  586. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +49 -0
  587. data/rbi/stripe/services/customer_funding_instructions_service.rbi +67 -0
  588. data/rbi/stripe/services/customer_payment_method_service.rbi +64 -0
  589. data/rbi/stripe/services/customer_payment_source_service.rbi +265 -0
  590. data/rbi/stripe/services/customer_service.rbi +763 -0
  591. data/rbi/stripe/services/customer_session_service.rbi +126 -0
  592. data/rbi/stripe/services/customer_tax_id_service.rbi +80 -0
  593. data/rbi/stripe/services/dispute_service.rbi +500 -0
  594. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +61 -0
  595. data/rbi/stripe/services/entitlements/feature_service.rbi +122 -0
  596. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  597. data/rbi/stripe/services/ephemeral_key_service.rbi +59 -0
  598. data/rbi/stripe/services/event_service.rbi +94 -0
  599. data/rbi/stripe/services/exchange_rate_service.rbi +49 -0
  600. data/rbi/stripe/services/file_link_service.rbi +141 -0
  601. data/rbi/stripe/services/file_service.rbi +132 -0
  602. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +37 -0
  603. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +47 -0
  604. data/rbi/stripe/services/financial_connections/account_service.rbi +148 -0
  605. data/rbi/stripe/services/financial_connections/institution_service.rbi +51 -0
  606. data/rbi/stripe/services/financial_connections/session_service.rbi +128 -0
  607. data/rbi/stripe/services/financial_connections/transaction_service.rbi +103 -0
  608. data/rbi/stripe/services/financial_connections_service.rbi +12 -0
  609. data/rbi/stripe/services/forwarding/request_service.rbi +152 -0
  610. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  611. data/rbi/stripe/services/gift_cards/card_service.rbi +162 -0
  612. data/rbi/stripe/services/gift_cards/transaction_service.rbi +198 -0
  613. data/rbi/stripe/services/gift_cards_service.rbi +10 -0
  614. data/rbi/stripe/services/identity/verification_report_service.rbi +98 -0
  615. data/rbi/stripe/services/identity/verification_session_service.rbi +360 -0
  616. data/rbi/stripe/services/identity_service.rbi +10 -0
  617. data/rbi/stripe/services/invoice_item_service.rbi +505 -0
  618. data/rbi/stripe/services/invoice_line_item_service.rbi +320 -0
  619. data/rbi/stripe/services/invoice_payment_service.rbi +49 -0
  620. data/rbi/stripe/services/invoice_rendering_template_service.rbi +91 -0
  621. data/rbi/stripe/services/invoice_service.rbi +7138 -0
  622. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +2397 -0
  623. data/rbi/stripe/services/issuing/authorization_service.rbi +160 -0
  624. data/rbi/stripe/services/issuing/card_service.rbi +568 -0
  625. data/rbi/stripe/services/issuing/cardholder_service.rbi +668 -0
  626. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +580 -0
  627. data/rbi/stripe/services/issuing/dispute_service.rbi +824 -0
  628. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +61 -0
  629. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +83 -0
  630. data/rbi/stripe/services/issuing/personalization_design_service.rbi +271 -0
  631. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +66 -0
  632. data/rbi/stripe/services/issuing/token_service.rbi +109 -0
  633. data/rbi/stripe/services/issuing/transaction_service.rbi +119 -0
  634. data/rbi/stripe/services/issuing_service.rbi +19 -0
  635. data/rbi/stripe/services/mandate_service.rbi +21 -0
  636. data/rbi/stripe/services/margin_service.rbi +119 -0
  637. data/rbi/stripe/services/order_line_item_service.rbi +35 -0
  638. data/rbi/stripe/services/order_service.rbi +2669 -0
  639. data/rbi/stripe/services/payment_attempt_record_service.rbi +39 -0
  640. data/rbi/stripe/services/payment_intent_service.rbi +13193 -0
  641. data/rbi/stripe/services/payment_link_line_item_service.rbi +35 -0
  642. data/rbi/stripe/services/payment_link_service.rbi +1447 -0
  643. data/rbi/stripe/services/payment_method_configuration_service.rbi +2465 -0
  644. data/rbi/stripe/services/payment_method_domain_service.rbi +123 -0
  645. data/rbi/stripe/services/payment_method_service.rbi +1032 -0
  646. data/rbi/stripe/services/payment_record_service.rbi +613 -0
  647. data/rbi/stripe/services/payout_service.rbi +228 -0
  648. data/rbi/stripe/services/plan_service.rbi +337 -0
  649. data/rbi/stripe/services/price_service.rbi +657 -0
  650. data/rbi/stripe/services/product_feature_service.rbi +76 -0
  651. data/rbi/stripe/services/product_service.rbi +596 -0
  652. data/rbi/stripe/services/promotion_code_service.rbi +244 -0
  653. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +35 -0
  654. data/rbi/stripe/services/quote_line_item_service.rbi +35 -0
  655. data/rbi/stripe/services/quote_line_service.rbi +35 -0
  656. data/rbi/stripe/services/quote_preview_invoice_service.rbi +35 -0
  657. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +35 -0
  658. data/rbi/stripe/services/quote_service.rbi +2830 -0
  659. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +95 -0
  660. data/rbi/stripe/services/radar/value_list_item_service.rbi +122 -0
  661. data/rbi/stripe/services/radar/value_list_service.rbi +160 -0
  662. data/rbi/stripe/services/radar_service.rbi +11 -0
  663. data/rbi/stripe/services/refund_service.rbi +208 -0
  664. data/rbi/stripe/services/reporting/report_run_service.rbi +152 -0
  665. data/rbi/stripe/services/reporting/report_type_service.rbi +37 -0
  666. data/rbi/stripe/services/reporting_service.rbi +10 -0
  667. data/rbi/stripe/services/review_service.rbi +93 -0
  668. data/rbi/stripe/services/setup_attempt_service.rbi +73 -0
  669. data/rbi/stripe/services/setup_intent_service.rbi +4204 -0
  670. data/rbi/stripe/services/shipping_rate_service.rbi +274 -0
  671. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +51 -0
  672. data/rbi/stripe/services/sigma_service.rbi +9 -0
  673. data/rbi/stripe/services/source_service.rbi +766 -0
  674. data/rbi/stripe/services/source_transaction_service.rbi +35 -0
  675. data/rbi/stripe/services/subscription_item_service.rbi +496 -0
  676. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +41 -0
  677. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +37 -0
  678. data/rbi/stripe/services/subscription_schedule_service.rbi +2613 -0
  679. data/rbi/stripe/services/subscription_service.rbi +2207 -0
  680. data/rbi/stripe/services/tax/association_service.rbi +27 -0
  681. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +37 -0
  682. data/rbi/stripe/services/tax/calculation_service.rbi +267 -0
  683. data/rbi/stripe/services/tax/form_service.rbi +96 -0
  684. data/rbi/stripe/services/tax/registration_service.rbi +1495 -0
  685. data/rbi/stripe/services/tax/settings_service.rbi +106 -0
  686. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +37 -0
  687. data/rbi/stripe/services/tax/transaction_service.rbi +164 -0
  688. data/rbi/stripe/services/tax_code_service.rbi +49 -0
  689. data/rbi/stripe/services/tax_id_service.rbi +128 -0
  690. data/rbi/stripe/services/tax_rate_service.rbi +215 -0
  691. data/rbi/stripe/services/tax_service.rbi +14 -0
  692. data/rbi/stripe/services/terminal/configuration_service.rbi +976 -0
  693. data/rbi/stripe/services/terminal/connection_token_service.rbi +27 -0
  694. data/rbi/stripe/services/terminal/location_service.rbi +211 -0
  695. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +23 -0
  696. data/rbi/stripe/services/terminal/reader_service.rbi +591 -0
  697. data/rbi/stripe/services/terminal_service.rbi +13 -0
  698. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +892 -0
  699. data/rbi/stripe/services/test_helpers/customer_service.rbi +37 -0
  700. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +974 -0
  701. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +81 -0
  702. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +73 -0
  703. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +825 -0
  704. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  705. data/rbi/stripe/services/test_helpers/refund_service.rbi +23 -0
  706. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +69 -0
  707. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  708. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +100 -0
  709. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +69 -0
  710. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +137 -0
  711. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +137 -0
  712. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +130 -0
  713. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +130 -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 +1357 -0
  717. data/rbi/stripe/services/topup_service.rbi +200 -0
  718. data/rbi/stripe/services/transfer_reversal_service.rbi +111 -0
  719. data/rbi/stripe/services/transfer_service.rbi +174 -0
  720. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +95 -0
  721. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +100 -0
  722. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +226 -0
  723. data/rbi/stripe/services/treasury/financial_account_service.rbi +577 -0
  724. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +133 -0
  725. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +350 -0
  726. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +189 -0
  727. data/rbi/stripe/services/treasury/received_credit_service.rbi +79 -0
  728. data/rbi/stripe/services/treasury/received_debit_service.rbi +66 -0
  729. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +125 -0
  730. data/rbi/stripe/services/treasury/transaction_service.rbi +133 -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 +43 -0
  734. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +46 -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 +60 -0
  737. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  738. data/rbi/stripe/services/v2/core/event_destination_service.rbi +228 -0
  739. data/rbi/stripe/services/v2/core/event_service.rbi +42 -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 +149 -0
  743. metadata +435 -4
@@ -0,0 +1,1188 @@
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
+
14
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
15
+ sig { returns(T.nilable(String)) }
16
+ attr_reader :country
17
+
18
+ # Address line 1 (e.g., street, PO Box, or company name).
19
+ sig { returns(T.nilable(String)) }
20
+ attr_reader :line1
21
+
22
+ # Address line 2 (e.g., apartment, suite, unit, or building).
23
+ sig { returns(T.nilable(String)) }
24
+ attr_reader :line2
25
+
26
+ # ZIP or postal code.
27
+ sig { returns(T.nilable(String)) }
28
+ attr_reader :postal_code
29
+
30
+ # State, county, province, or region.
31
+ sig { returns(T.nilable(String)) }
32
+ attr_reader :state
33
+ end
34
+ class InvoiceSettings < Stripe::StripeObject
35
+ class CustomField < Stripe::StripeObject
36
+ # The name of the custom field.
37
+ sig { returns(String) }
38
+ attr_reader :name
39
+
40
+ # The value of the custom field.
41
+ sig { returns(String) }
42
+ attr_reader :value
43
+ end
44
+ class RenderingOptions < Stripe::StripeObject
45
+ # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
46
+ sig { returns(T.nilable(String)) }
47
+ attr_reader :amount_tax_display
48
+
49
+ # 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.
50
+ sig { returns(T.nilable(String)) }
51
+ attr_reader :template
52
+ end
53
+ # Default custom fields to be displayed on invoices for this customer.
54
+ sig { returns(T.nilable(T::Array[CustomField])) }
55
+ attr_reader :custom_fields
56
+
57
+ # 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.
58
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
59
+ attr_reader :default_payment_method
60
+
61
+ # Default footer to be displayed on invoices for this customer.
62
+ sig { returns(T.nilable(String)) }
63
+ attr_reader :footer
64
+
65
+ # Default options for invoice PDF rendering for this customer.
66
+ sig { returns(T.nilable(RenderingOptions)) }
67
+ attr_reader :rendering_options
68
+ end
69
+ class Shipping < Stripe::StripeObject
70
+ class Address < Stripe::StripeObject
71
+ # City, district, suburb, town, or village.
72
+ sig { returns(T.nilable(String)) }
73
+ attr_reader :city
74
+
75
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
76
+ sig { returns(T.nilable(String)) }
77
+ attr_reader :country
78
+
79
+ # Address line 1 (e.g., street, PO Box, or company name).
80
+ sig { returns(T.nilable(String)) }
81
+ attr_reader :line1
82
+
83
+ # Address line 2 (e.g., apartment, suite, unit, or building).
84
+ sig { returns(T.nilable(String)) }
85
+ attr_reader :line2
86
+
87
+ # ZIP or postal code.
88
+ sig { returns(T.nilable(String)) }
89
+ attr_reader :postal_code
90
+
91
+ # State, county, province, or region.
92
+ sig { returns(T.nilable(String)) }
93
+ attr_reader :state
94
+ end
95
+ # Attribute for field address
96
+ sig { returns(Address) }
97
+ attr_reader :address
98
+
99
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
100
+ sig { returns(T.nilable(String)) }
101
+ attr_reader :carrier
102
+
103
+ # Recipient name.
104
+ sig { returns(String) }
105
+ attr_reader :name
106
+
107
+ # Recipient phone (including extension).
108
+ sig { returns(T.nilable(String)) }
109
+ attr_reader :phone
110
+
111
+ # 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.
112
+ sig { returns(T.nilable(String)) }
113
+ attr_reader :tracking_number
114
+ end
115
+ class Tax < Stripe::StripeObject
116
+ class Location < Stripe::StripeObject
117
+ # The customer's country as identified by Stripe Tax.
118
+ sig { returns(String) }
119
+ attr_reader :country
120
+
121
+ # The data source used to infer the customer's location.
122
+ sig { returns(String) }
123
+ attr_reader :source
124
+
125
+ # The customer's state, county, province, or region as identified by Stripe Tax.
126
+ sig { returns(T.nilable(String)) }
127
+ attr_reader :state
128
+ end
129
+ # Surfaces if automatic tax computation is possible given the current customer location information.
130
+ sig { returns(String) }
131
+ attr_reader :automatic_tax
132
+
133
+ # A recent IP address of the customer used for tax reporting and tax location inference.
134
+ sig { returns(T.nilable(String)) }
135
+ attr_reader :ip_address
136
+
137
+ # The customer's location as identified by Stripe Tax.
138
+ sig { returns(T.nilable(Location)) }
139
+ attr_reader :location
140
+ end
141
+ # The customer's address.
142
+ sig { returns(T.nilable(Address)) }
143
+ attr_reader :address
144
+
145
+ # 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.
146
+ sig { returns(Integer) }
147
+ attr_reader :balance
148
+
149
+ # 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.
150
+ sig { returns(T.nilable(Stripe::CashBalance)) }
151
+ attr_reader :cash_balance
152
+
153
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
154
+ sig { returns(Integer) }
155
+ attr_reader :created
156
+
157
+ # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.
158
+ sig { returns(T.nilable(String)) }
159
+ attr_reader :currency
160
+
161
+ # ID of the default payment source for the customer.
162
+ #
163
+ # 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.
164
+ sig {
165
+ returns(T.nilable(T.any(String, T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))))
166
+ }
167
+ attr_reader :default_source
168
+
169
+ # 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`.
170
+ #
171
+ # If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.
172
+ #
173
+ # 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`.
174
+ sig { returns(T.nilable(T::Boolean)) }
175
+ attr_reader :delinquent
176
+
177
+ # An arbitrary string attached to the object. Often useful for displaying to users.
178
+ sig { returns(T.nilable(String)) }
179
+ attr_reader :description
180
+
181
+ # Describes the current discount active on the customer, if there is one.
182
+ sig { returns(T.nilable(Stripe::Discount)) }
183
+ attr_reader :discount
184
+
185
+ # The customer's email address.
186
+ sig { returns(T.nilable(String)) }
187
+ attr_reader :email
188
+
189
+ # Unique identifier for the object.
190
+ sig { returns(String) }
191
+ attr_reader :id
192
+
193
+ # 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.
194
+ sig { returns(T::Hash[String, Integer]) }
195
+ attr_reader :invoice_credit_balance
196
+
197
+ # The prefix for the customer used to generate unique invoice numbers.
198
+ sig { returns(T.nilable(String)) }
199
+ attr_reader :invoice_prefix
200
+
201
+ # Attribute for field invoice_settings
202
+ sig { returns(InvoiceSettings) }
203
+ attr_reader :invoice_settings
204
+
205
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
206
+ sig { returns(T::Boolean) }
207
+ attr_reader :livemode
208
+
209
+ # 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.
210
+ sig { returns(T::Hash[String, String]) }
211
+ attr_reader :metadata
212
+
213
+ # The customer's full name or business name.
214
+ sig { returns(T.nilable(String)) }
215
+ attr_reader :name
216
+
217
+ # 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.
218
+ sig { returns(Integer) }
219
+ attr_reader :next_invoice_sequence
220
+
221
+ # String representing the object's type. Objects of the same type share the same value.
222
+ sig { returns(String) }
223
+ attr_reader :object
224
+
225
+ # The customer's phone number.
226
+ sig { returns(T.nilable(String)) }
227
+ attr_reader :phone
228
+
229
+ # The customer's preferred locales (languages), ordered by preference.
230
+ sig { returns(T.nilable(T::Array[String])) }
231
+ attr_reader :preferred_locales
232
+
233
+ # Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
234
+ sig { returns(T.nilable(Shipping)) }
235
+ attr_reader :shipping
236
+
237
+ # The customer's payment sources, if any.
238
+ sig { returns(Stripe::ListObject) }
239
+ attr_reader :sources
240
+
241
+ # The customer's current subscriptions, if any.
242
+ sig { returns(Stripe::ListObject) }
243
+ attr_reader :subscriptions
244
+
245
+ # Attribute for field tax
246
+ sig { returns(Tax) }
247
+ attr_reader :tax
248
+
249
+ # 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"**.
250
+ sig { returns(T.nilable(String)) }
251
+ attr_reader :tax_exempt
252
+
253
+ # The customer's tax IDs.
254
+ sig { returns(Stripe::ListObject) }
255
+ attr_reader :tax_ids
256
+
257
+ # ID of the test clock that this customer belongs to.
258
+ sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
259
+ attr_reader :test_clock
260
+
261
+ # Always true for a deleted object
262
+ sig { returns(T::Boolean) }
263
+ attr_reader :deleted
264
+
265
+ class DeleteParams < Stripe::RequestParams
266
+
267
+ end
268
+ class RetrieveParams < Stripe::RequestParams
269
+ # Specifies which fields in the response should be expanded.
270
+ sig { returns(T::Array[String]) }
271
+ attr_accessor :expand
272
+
273
+ sig { params(expand: T::Array[String]).void }
274
+ def initialize(expand: nil); end
275
+ end
276
+ class UpdateParams < Stripe::RequestParams
277
+ class Address < Stripe::RequestParams
278
+ # City, district, suburb, town, or village.
279
+ sig { returns(String) }
280
+ attr_accessor :city
281
+
282
+ # 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)).
283
+ sig { returns(String) }
284
+ attr_accessor :country
285
+
286
+ # Address line 1 (e.g., street, PO Box, or company name).
287
+ sig { returns(String) }
288
+ attr_accessor :line1
289
+
290
+ # Address line 2 (e.g., apartment, suite, unit, or building).
291
+ sig { returns(String) }
292
+ attr_accessor :line2
293
+
294
+ # ZIP or postal code.
295
+ sig { returns(String) }
296
+ attr_accessor :postal_code
297
+
298
+ # State, county, province, or region.
299
+ sig { returns(String) }
300
+ attr_accessor :state
301
+
302
+ sig {
303
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
304
+ }
305
+ def initialize(
306
+ city: nil,
307
+ country: nil,
308
+ line1: nil,
309
+ line2: nil,
310
+ postal_code: nil,
311
+ state: nil
312
+ ); end
313
+ end
314
+ class CashBalance < Stripe::RequestParams
315
+ class Settings < Stripe::RequestParams
316
+ # 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).
317
+ sig { returns(String) }
318
+ attr_accessor :reconciliation_mode
319
+
320
+ sig { params(reconciliation_mode: String).void }
321
+ def initialize(reconciliation_mode: nil); end
322
+ end
323
+ # Settings controlling the behavior of the customer's cash balance,
324
+ # such as reconciliation of funds received.
325
+ sig { returns(::Stripe::Customer::UpdateParams::CashBalance::Settings) }
326
+ attr_accessor :settings
327
+
328
+ sig { params(settings: ::Stripe::Customer::UpdateParams::CashBalance::Settings).void }
329
+ def initialize(settings: nil); end
330
+ end
331
+ class InvoiceSettings < Stripe::RequestParams
332
+ class CustomField < Stripe::RequestParams
333
+ # The name of the custom field. This may be up to 40 characters.
334
+ sig { returns(String) }
335
+ attr_accessor :name
336
+
337
+ # The value of the custom field. This may be up to 140 characters.
338
+ sig { returns(String) }
339
+ attr_accessor :value
340
+
341
+ sig { params(name: String, value: String).void }
342
+ def initialize(name: nil, value: nil); end
343
+ end
344
+ class RenderingOptions < Stripe::RequestParams
345
+ # 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.
346
+ sig { returns(T.nilable(String)) }
347
+ attr_accessor :amount_tax_display
348
+
349
+ # ID of the invoice rendering template to use for future invoices.
350
+ sig { returns(String) }
351
+ attr_accessor :template
352
+
353
+ sig { params(amount_tax_display: T.nilable(String), template: String).void }
354
+ def initialize(amount_tax_display: nil, template: nil); end
355
+ end
356
+ # 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.
357
+ sig {
358
+ returns(T.nilable(T::Array[::Stripe::Customer::UpdateParams::InvoiceSettings::CustomField]))
359
+ }
360
+ attr_accessor :custom_fields
361
+
362
+ # 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.
363
+ sig { returns(String) }
364
+ attr_accessor :default_payment_method
365
+
366
+ # Default footer to be displayed on invoices for this customer.
367
+ sig { returns(String) }
368
+ attr_accessor :footer
369
+
370
+ # Default options for invoice PDF rendering for this customer.
371
+ sig {
372
+ returns(T.nilable(::Stripe::Customer::UpdateParams::InvoiceSettings::RenderingOptions))
373
+ }
374
+ attr_accessor :rendering_options
375
+
376
+ sig {
377
+ 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
378
+ }
379
+ def initialize(
380
+ custom_fields: nil,
381
+ default_payment_method: nil,
382
+ footer: nil,
383
+ rendering_options: nil
384
+ ); end
385
+ end
386
+ class Shipping < Stripe::RequestParams
387
+ class Address < Stripe::RequestParams
388
+ # City, district, suburb, town, or village.
389
+ sig { returns(String) }
390
+ attr_accessor :city
391
+
392
+ # 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)).
393
+ sig { returns(String) }
394
+ attr_accessor :country
395
+
396
+ # Address line 1 (e.g., street, PO Box, or company name).
397
+ sig { returns(String) }
398
+ attr_accessor :line1
399
+
400
+ # Address line 2 (e.g., apartment, suite, unit, or building).
401
+ sig { returns(String) }
402
+ attr_accessor :line2
403
+
404
+ # ZIP or postal code.
405
+ sig { returns(String) }
406
+ attr_accessor :postal_code
407
+
408
+ # State, county, province, or region.
409
+ sig { returns(String) }
410
+ attr_accessor :state
411
+
412
+ sig {
413
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
414
+ }
415
+ def initialize(
416
+ city: nil,
417
+ country: nil,
418
+ line1: nil,
419
+ line2: nil,
420
+ postal_code: nil,
421
+ state: nil
422
+ ); end
423
+ end
424
+ # Customer shipping address.
425
+ sig { returns(::Stripe::Customer::UpdateParams::Shipping::Address) }
426
+ attr_accessor :address
427
+
428
+ # Customer name.
429
+ sig { returns(String) }
430
+ attr_accessor :name
431
+
432
+ # Customer phone (including extension).
433
+ sig { returns(String) }
434
+ attr_accessor :phone
435
+
436
+ sig {
437
+ params(address: ::Stripe::Customer::UpdateParams::Shipping::Address, name: String, phone: String).void
438
+ }
439
+ def initialize(address: nil, name: nil, phone: nil); end
440
+ end
441
+ class Tax < Stripe::RequestParams
442
+ # 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.
443
+ sig { returns(T.nilable(String)) }
444
+ attr_accessor :ip_address
445
+
446
+ # A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.
447
+ sig { returns(String) }
448
+ attr_accessor :validate_location
449
+
450
+ sig { params(ip_address: T.nilable(String), validate_location: String).void }
451
+ def initialize(ip_address: nil, validate_location: nil); end
452
+ end
453
+ # The customer's address.
454
+ sig { returns(T.nilable(::Stripe::Customer::UpdateParams::Address)) }
455
+ attr_accessor :address
456
+
457
+ # 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.
458
+ sig { returns(Integer) }
459
+ attr_accessor :balance
460
+
461
+ # Balance information and default balance settings for this customer.
462
+ sig { returns(::Stripe::Customer::UpdateParams::CashBalance) }
463
+ attr_accessor :cash_balance
464
+
465
+ # Attribute for param field coupon
466
+ sig { returns(String) }
467
+ attr_accessor :coupon
468
+
469
+ # 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.
470
+ #
471
+ # Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.
472
+ #
473
+ # 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.
474
+ sig { returns(String) }
475
+ attr_accessor :default_source
476
+
477
+ # An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
478
+ sig { returns(String) }
479
+ attr_accessor :description
480
+
481
+ # 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*.
482
+ sig { returns(String) }
483
+ attr_accessor :email
484
+
485
+ # Specifies which fields in the response should be expanded.
486
+ sig { returns(T::Array[String]) }
487
+ attr_accessor :expand
488
+
489
+ # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
490
+ sig { returns(String) }
491
+ attr_accessor :invoice_prefix
492
+
493
+ # Default invoice settings for this customer.
494
+ sig { returns(::Stripe::Customer::UpdateParams::InvoiceSettings) }
495
+ attr_accessor :invoice_settings
496
+
497
+ # 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`.
498
+ sig { returns(T.nilable(T::Hash[String, String])) }
499
+ attr_accessor :metadata
500
+
501
+ # The customer's full name or business name.
502
+ sig { returns(String) }
503
+ attr_accessor :name
504
+
505
+ # The sequence to be used on the customer's next invoice. Defaults to 1.
506
+ sig { returns(Integer) }
507
+ attr_accessor :next_invoice_sequence
508
+
509
+ # The customer's phone number.
510
+ sig { returns(String) }
511
+ attr_accessor :phone
512
+
513
+ # Customer's preferred languages, ordered by preference.
514
+ sig { returns(T::Array[String]) }
515
+ attr_accessor :preferred_locales
516
+
517
+ # 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.
518
+ sig { returns(String) }
519
+ attr_accessor :promotion_code
520
+
521
+ # The customer's shipping information. Appears on invoices emailed to this customer.
522
+ sig { returns(T.nilable(::Stripe::Customer::UpdateParams::Shipping)) }
523
+ attr_accessor :shipping
524
+
525
+ # Attribute for param field source
526
+ sig { returns(String) }
527
+ attr_accessor :source
528
+
529
+ # Tax details about the customer.
530
+ sig { returns(::Stripe::Customer::UpdateParams::Tax) }
531
+ attr_accessor :tax
532
+
533
+ # The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
534
+ sig { returns(T.nilable(String)) }
535
+ attr_accessor :tax_exempt
536
+
537
+ # Attribute for param field validate
538
+ sig { returns(T::Boolean) }
539
+ attr_accessor :validate
540
+
541
+ sig {
542
+ 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
543
+ }
544
+ def initialize(
545
+ address: nil,
546
+ balance: nil,
547
+ cash_balance: nil,
548
+ coupon: nil,
549
+ default_source: nil,
550
+ description: nil,
551
+ email: nil,
552
+ expand: nil,
553
+ invoice_prefix: nil,
554
+ invoice_settings: nil,
555
+ metadata: nil,
556
+ name: nil,
557
+ next_invoice_sequence: nil,
558
+ phone: nil,
559
+ preferred_locales: nil,
560
+ promotion_code: nil,
561
+ shipping: nil,
562
+ source: nil,
563
+ tax: nil,
564
+ tax_exempt: nil,
565
+ validate: nil
566
+ ); end
567
+ end
568
+ class DeleteDiscountParams < Stripe::RequestParams
569
+
570
+ end
571
+ class ListParams < Stripe::RequestParams
572
+ class Created < Stripe::RequestParams
573
+ # Minimum value to filter by (exclusive)
574
+ sig { returns(Integer) }
575
+ attr_accessor :gt
576
+
577
+ # Minimum value to filter by (inclusive)
578
+ sig { returns(Integer) }
579
+ attr_accessor :gte
580
+
581
+ # Maximum value to filter by (exclusive)
582
+ sig { returns(Integer) }
583
+ attr_accessor :lt
584
+
585
+ # Maximum value to filter by (inclusive)
586
+ sig { returns(Integer) }
587
+ attr_accessor :lte
588
+
589
+ sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
590
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
591
+ end
592
+ # Only return customers that were created during the given date interval.
593
+ sig { returns(T.any(::Stripe::Customer::ListParams::Created, Integer)) }
594
+ attr_accessor :created
595
+
596
+ # A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.
597
+ sig { returns(String) }
598
+ attr_accessor :email
599
+
600
+ # 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.
601
+ sig { returns(String) }
602
+ attr_accessor :ending_before
603
+
604
+ # Specifies which fields in the response should be expanded.
605
+ sig { returns(T::Array[String]) }
606
+ attr_accessor :expand
607
+
608
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
609
+ sig { returns(Integer) }
610
+ attr_accessor :limit
611
+
612
+ # 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.
613
+ sig { returns(String) }
614
+ attr_accessor :starting_after
615
+
616
+ # 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.
617
+ sig { returns(String) }
618
+ attr_accessor :test_clock
619
+
620
+ sig {
621
+ 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
622
+ }
623
+ def initialize(
624
+ created: nil,
625
+ email: nil,
626
+ ending_before: nil,
627
+ expand: nil,
628
+ limit: nil,
629
+ starting_after: nil,
630
+ test_clock: nil
631
+ ); end
632
+ end
633
+ class CreateParams < Stripe::RequestParams
634
+ class Address < Stripe::RequestParams
635
+ # City, district, suburb, town, or village.
636
+ sig { returns(String) }
637
+ attr_accessor :city
638
+
639
+ # 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)).
640
+ sig { returns(String) }
641
+ attr_accessor :country
642
+
643
+ # Address line 1 (e.g., street, PO Box, or company name).
644
+ sig { returns(String) }
645
+ attr_accessor :line1
646
+
647
+ # Address line 2 (e.g., apartment, suite, unit, or building).
648
+ sig { returns(String) }
649
+ attr_accessor :line2
650
+
651
+ # ZIP or postal code.
652
+ sig { returns(String) }
653
+ attr_accessor :postal_code
654
+
655
+ # State, county, province, or region.
656
+ sig { returns(String) }
657
+ attr_accessor :state
658
+
659
+ sig {
660
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
661
+ }
662
+ def initialize(
663
+ city: nil,
664
+ country: nil,
665
+ line1: nil,
666
+ line2: nil,
667
+ postal_code: nil,
668
+ state: nil
669
+ ); end
670
+ end
671
+ class CashBalance < Stripe::RequestParams
672
+ class Settings < Stripe::RequestParams
673
+ # 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).
674
+ sig { returns(String) }
675
+ attr_accessor :reconciliation_mode
676
+
677
+ sig { params(reconciliation_mode: String).void }
678
+ def initialize(reconciliation_mode: nil); end
679
+ end
680
+ # Settings controlling the behavior of the customer's cash balance,
681
+ # such as reconciliation of funds received.
682
+ sig { returns(::Stripe::Customer::CreateParams::CashBalance::Settings) }
683
+ attr_accessor :settings
684
+
685
+ sig { params(settings: ::Stripe::Customer::CreateParams::CashBalance::Settings).void }
686
+ def initialize(settings: nil); end
687
+ end
688
+ class InvoiceSettings < Stripe::RequestParams
689
+ class CustomField < Stripe::RequestParams
690
+ # The name of the custom field. This may be up to 40 characters.
691
+ sig { returns(String) }
692
+ attr_accessor :name
693
+
694
+ # The value of the custom field. This may be up to 140 characters.
695
+ sig { returns(String) }
696
+ attr_accessor :value
697
+
698
+ sig { params(name: String, value: String).void }
699
+ def initialize(name: nil, value: nil); end
700
+ end
701
+ class RenderingOptions < Stripe::RequestParams
702
+ # 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.
703
+ sig { returns(T.nilable(String)) }
704
+ attr_accessor :amount_tax_display
705
+
706
+ # ID of the invoice rendering template to use for future invoices.
707
+ sig { returns(String) }
708
+ attr_accessor :template
709
+
710
+ sig { params(amount_tax_display: T.nilable(String), template: String).void }
711
+ def initialize(amount_tax_display: nil, template: nil); end
712
+ end
713
+ # 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.
714
+ sig {
715
+ returns(T.nilable(T::Array[::Stripe::Customer::CreateParams::InvoiceSettings::CustomField]))
716
+ }
717
+ attr_accessor :custom_fields
718
+
719
+ # 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.
720
+ sig { returns(String) }
721
+ attr_accessor :default_payment_method
722
+
723
+ # Default footer to be displayed on invoices for this customer.
724
+ sig { returns(String) }
725
+ attr_accessor :footer
726
+
727
+ # Default options for invoice PDF rendering for this customer.
728
+ sig {
729
+ returns(T.nilable(::Stripe::Customer::CreateParams::InvoiceSettings::RenderingOptions))
730
+ }
731
+ attr_accessor :rendering_options
732
+
733
+ sig {
734
+ 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
735
+ }
736
+ def initialize(
737
+ custom_fields: nil,
738
+ default_payment_method: nil,
739
+ footer: nil,
740
+ rendering_options: nil
741
+ ); end
742
+ end
743
+ class Shipping < Stripe::RequestParams
744
+ class Address < Stripe::RequestParams
745
+ # City, district, suburb, town, or village.
746
+ sig { returns(String) }
747
+ attr_accessor :city
748
+
749
+ # 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)).
750
+ sig { returns(String) }
751
+ attr_accessor :country
752
+
753
+ # Address line 1 (e.g., street, PO Box, or company name).
754
+ sig { returns(String) }
755
+ attr_accessor :line1
756
+
757
+ # Address line 2 (e.g., apartment, suite, unit, or building).
758
+ sig { returns(String) }
759
+ attr_accessor :line2
760
+
761
+ # ZIP or postal code.
762
+ sig { returns(String) }
763
+ attr_accessor :postal_code
764
+
765
+ # State, county, province, or region.
766
+ sig { returns(String) }
767
+ attr_accessor :state
768
+
769
+ sig {
770
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
771
+ }
772
+ def initialize(
773
+ city: nil,
774
+ country: nil,
775
+ line1: nil,
776
+ line2: nil,
777
+ postal_code: nil,
778
+ state: nil
779
+ ); end
780
+ end
781
+ # Customer shipping address.
782
+ sig { returns(::Stripe::Customer::CreateParams::Shipping::Address) }
783
+ attr_accessor :address
784
+
785
+ # Customer name.
786
+ sig { returns(String) }
787
+ attr_accessor :name
788
+
789
+ # Customer phone (including extension).
790
+ sig { returns(String) }
791
+ attr_accessor :phone
792
+
793
+ sig {
794
+ params(address: ::Stripe::Customer::CreateParams::Shipping::Address, name: String, phone: String).void
795
+ }
796
+ def initialize(address: nil, name: nil, phone: nil); end
797
+ end
798
+ class Tax < Stripe::RequestParams
799
+ # 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.
800
+ sig { returns(T.nilable(String)) }
801
+ attr_accessor :ip_address
802
+
803
+ # A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.
804
+ sig { returns(String) }
805
+ attr_accessor :validate_location
806
+
807
+ sig { params(ip_address: T.nilable(String), validate_location: String).void }
808
+ def initialize(ip_address: nil, validate_location: nil); end
809
+ end
810
+ class TaxIdDatum < Stripe::RequestParams
811
+ # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `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`
812
+ sig { returns(String) }
813
+ attr_accessor :type
814
+
815
+ # Value of the tax ID.
816
+ sig { returns(String) }
817
+ attr_accessor :value
818
+
819
+ sig { params(type: String, value: String).void }
820
+ def initialize(type: nil, value: nil); end
821
+ end
822
+ # The customer's address.
823
+ sig { returns(T.nilable(::Stripe::Customer::CreateParams::Address)) }
824
+ attr_accessor :address
825
+
826
+ # 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.
827
+ sig { returns(Integer) }
828
+ attr_accessor :balance
829
+
830
+ # Balance information and default balance settings for this customer.
831
+ sig { returns(::Stripe::Customer::CreateParams::CashBalance) }
832
+ attr_accessor :cash_balance
833
+
834
+ # Attribute for param field coupon
835
+ sig { returns(String) }
836
+ attr_accessor :coupon
837
+
838
+ # An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
839
+ sig { returns(String) }
840
+ attr_accessor :description
841
+
842
+ # 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*.
843
+ sig { returns(String) }
844
+ attr_accessor :email
845
+
846
+ # Specifies which fields in the response should be expanded.
847
+ sig { returns(T::Array[String]) }
848
+ attr_accessor :expand
849
+
850
+ # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
851
+ sig { returns(String) }
852
+ attr_accessor :invoice_prefix
853
+
854
+ # Default invoice settings for this customer.
855
+ sig { returns(::Stripe::Customer::CreateParams::InvoiceSettings) }
856
+ attr_accessor :invoice_settings
857
+
858
+ # 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`.
859
+ sig { returns(T.nilable(T::Hash[String, String])) }
860
+ attr_accessor :metadata
861
+
862
+ # The customer's full name or business name.
863
+ sig { returns(String) }
864
+ attr_accessor :name
865
+
866
+ # The sequence to be used on the customer's next invoice. Defaults to 1.
867
+ sig { returns(Integer) }
868
+ attr_accessor :next_invoice_sequence
869
+
870
+ # Attribute for param field payment_method
871
+ sig { returns(String) }
872
+ attr_accessor :payment_method
873
+
874
+ # The customer's phone number.
875
+ sig { returns(String) }
876
+ attr_accessor :phone
877
+
878
+ # Customer's preferred languages, ordered by preference.
879
+ sig { returns(T::Array[String]) }
880
+ attr_accessor :preferred_locales
881
+
882
+ # 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.
883
+ sig { returns(String) }
884
+ attr_accessor :promotion_code
885
+
886
+ # The customer's shipping information. Appears on invoices emailed to this customer.
887
+ sig { returns(T.nilable(::Stripe::Customer::CreateParams::Shipping)) }
888
+ attr_accessor :shipping
889
+
890
+ # Attribute for param field source
891
+ sig { returns(String) }
892
+ attr_accessor :source
893
+
894
+ # Tax details about the customer.
895
+ sig { returns(::Stripe::Customer::CreateParams::Tax) }
896
+ attr_accessor :tax
897
+
898
+ # The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
899
+ sig { returns(T.nilable(String)) }
900
+ attr_accessor :tax_exempt
901
+
902
+ # The customer's tax IDs.
903
+ sig { returns(T::Array[::Stripe::Customer::CreateParams::TaxIdDatum]) }
904
+ attr_accessor :tax_id_data
905
+
906
+ # ID of the test clock to attach to the customer.
907
+ sig { returns(String) }
908
+ attr_accessor :test_clock
909
+
910
+ # Attribute for param field validate
911
+ sig { returns(T::Boolean) }
912
+ attr_accessor :validate
913
+
914
+ sig {
915
+ 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
916
+ }
917
+ def initialize(
918
+ address: nil,
919
+ balance: nil,
920
+ cash_balance: nil,
921
+ coupon: nil,
922
+ description: nil,
923
+ email: nil,
924
+ expand: nil,
925
+ invoice_prefix: nil,
926
+ invoice_settings: nil,
927
+ metadata: nil,
928
+ name: nil,
929
+ next_invoice_sequence: nil,
930
+ payment_method: nil,
931
+ phone: nil,
932
+ preferred_locales: nil,
933
+ promotion_code: nil,
934
+ shipping: nil,
935
+ source: nil,
936
+ tax: nil,
937
+ tax_exempt: nil,
938
+ tax_id_data: nil,
939
+ test_clock: nil,
940
+ validate: nil
941
+ ); end
942
+ end
943
+ class ListPaymentMethodsParams < Stripe::RequestParams
944
+ # 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`.
945
+ sig { returns(String) }
946
+ attr_accessor :allow_redisplay
947
+
948
+ # 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.
949
+ sig { returns(String) }
950
+ attr_accessor :ending_before
951
+
952
+ # Specifies which fields in the response should be expanded.
953
+ sig { returns(T::Array[String]) }
954
+ attr_accessor :expand
955
+
956
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
957
+ sig { returns(Integer) }
958
+ attr_accessor :limit
959
+
960
+ # 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.
961
+ sig { returns(String) }
962
+ attr_accessor :starting_after
963
+
964
+ # 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.
965
+ sig { returns(String) }
966
+ attr_accessor :type
967
+
968
+ sig {
969
+ params(allow_redisplay: String, ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, type: String).void
970
+ }
971
+ def initialize(
972
+ allow_redisplay: nil,
973
+ ending_before: nil,
974
+ expand: nil,
975
+ limit: nil,
976
+ starting_after: nil,
977
+ type: nil
978
+ ); end
979
+ end
980
+ class RetrievePaymentMethodParams < Stripe::RequestParams
981
+ # Specifies which fields in the response should be expanded.
982
+ sig { returns(T::Array[String]) }
983
+ attr_accessor :expand
984
+
985
+ sig { params(expand: T::Array[String]).void }
986
+ def initialize(expand: nil); end
987
+ end
988
+ class SearchParams < Stripe::RequestParams
989
+ # Specifies which fields in the response should be expanded.
990
+ sig { returns(T::Array[String]) }
991
+ attr_accessor :expand
992
+
993
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
994
+ sig { returns(Integer) }
995
+ attr_accessor :limit
996
+
997
+ # 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.
998
+ sig { returns(String) }
999
+ attr_accessor :page
1000
+
1001
+ # 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).
1002
+ sig { returns(String) }
1003
+ attr_accessor :query
1004
+
1005
+ sig { params(expand: T::Array[String], limit: Integer, page: String, query: String).void }
1006
+ def initialize(expand: nil, limit: nil, page: nil, query: nil); end
1007
+ end
1008
+ class CreateFundingInstructionsParams < Stripe::RequestParams
1009
+ class BankTransfer < Stripe::RequestParams
1010
+ class EuBankTransfer < Stripe::RequestParams
1011
+ # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
1012
+ sig { returns(String) }
1013
+ attr_accessor :country
1014
+
1015
+ sig { params(country: String).void }
1016
+ def initialize(country: nil); end
1017
+ end
1018
+ # Configuration for eu_bank_transfer funding type.
1019
+ sig {
1020
+ returns(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer::EuBankTransfer)
1021
+ }
1022
+ attr_accessor :eu_bank_transfer
1023
+
1024
+ # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
1025
+ #
1026
+ # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
1027
+ sig { returns(T::Array[String]) }
1028
+ attr_accessor :requested_address_types
1029
+
1030
+ # The type of the `bank_transfer`
1031
+ sig { returns(String) }
1032
+ attr_accessor :type
1033
+
1034
+ sig {
1035
+ params(eu_bank_transfer: ::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer::EuBankTransfer, requested_address_types: T::Array[String], type: String).void
1036
+ }
1037
+ def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
1038
+ end
1039
+ # Additional parameters for `bank_transfer` funding types
1040
+ sig { returns(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer) }
1041
+ attr_accessor :bank_transfer
1042
+
1043
+ # 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).
1044
+ sig { returns(String) }
1045
+ attr_accessor :currency
1046
+
1047
+ # Specifies which fields in the response should be expanded.
1048
+ sig { returns(T::Array[String]) }
1049
+ attr_accessor :expand
1050
+
1051
+ # The `funding_type` to get the instructions for.
1052
+ sig { returns(String) }
1053
+ attr_accessor :funding_type
1054
+
1055
+ sig {
1056
+ params(bank_transfer: ::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer, currency: String, expand: T::Array[String], funding_type: String).void
1057
+ }
1058
+ def initialize(bank_transfer: nil, currency: nil, expand: nil, funding_type: nil); end
1059
+ end
1060
+ class FundCashBalanceParams < Stripe::RequestParams
1061
+ # 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).
1062
+ sig { returns(Integer) }
1063
+ attr_accessor :amount
1064
+
1065
+ # 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).
1066
+ sig { returns(String) }
1067
+ attr_accessor :currency
1068
+
1069
+ # Specifies which fields in the response should be expanded.
1070
+ sig { returns(T::Array[String]) }
1071
+ attr_accessor :expand
1072
+
1073
+ # 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.
1074
+ sig { returns(String) }
1075
+ attr_accessor :reference
1076
+
1077
+ sig {
1078
+ params(amount: Integer, currency: String, expand: T::Array[String], reference: String).void
1079
+ }
1080
+ def initialize(amount: nil, currency: nil, expand: nil, reference: nil); end
1081
+ end
1082
+ # Creates a new customer object.
1083
+ sig {
1084
+ params(params: T.any(::Stripe::Customer::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
1085
+ }
1086
+ def self.create(params = {}, opts = {}); end
1087
+
1088
+ # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
1089
+ # funding instructions will be created. If funding instructions have already been created for a given customer, the same
1090
+ # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
1091
+ sig {
1092
+ params(params: T.any(::Stripe::Customer::CreateFundingInstructionsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FundingInstructions)
1093
+ }
1094
+ def create_funding_instructions(params = {}, opts = {}); end
1095
+
1096
+ # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
1097
+ # funding instructions will be created. If funding instructions have already been created for a given customer, the same
1098
+ # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
1099
+ sig {
1100
+ params(customer: String, params: T.any(::Stripe::Customer::CreateFundingInstructionsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FundingInstructions)
1101
+ }
1102
+ def self.create_funding_instructions(customer, params = {}, opts = {}); end
1103
+
1104
+ # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
1105
+ sig {
1106
+ params(id: String, params: T.any(::Stripe::Customer::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
1107
+ }
1108
+ def self.delete(id, params = {}, opts = {}); end
1109
+
1110
+ # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
1111
+ sig {
1112
+ params(params: T.any(::Stripe::Customer::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
1113
+ }
1114
+ def delete(params = {}, opts = {}); end
1115
+
1116
+ # Removes the currently applied discount on a customer.
1117
+ sig {
1118
+ params(params: T.any(::Stripe::Customer::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
1119
+ }
1120
+ def delete_discount(params = {}, opts = {}); end
1121
+
1122
+ # Removes the currently applied discount on a customer.
1123
+ sig {
1124
+ params(customer: String, params: T.any(::Stripe::Customer::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
1125
+ }
1126
+ def self.delete_discount(customer, params = {}, opts = {}); end
1127
+
1128
+ # Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
1129
+ sig {
1130
+ params(params: T.any(::Stripe::Customer::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1131
+ }
1132
+ def self.list(params = {}, opts = {}); end
1133
+
1134
+ # Returns a list of PaymentMethods for a given Customer
1135
+ sig {
1136
+ params(params: T.any(::Stripe::Customer::ListPaymentMethodsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1137
+ }
1138
+ def list_payment_methods(params = {}, opts = {}); end
1139
+
1140
+ # Returns a list of PaymentMethods for a given Customer
1141
+ sig {
1142
+ params(customer: String, params: T.any(::Stripe::Customer::ListPaymentMethodsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1143
+ }
1144
+ def self.list_payment_methods(customer, params = {}, opts = {}); end
1145
+
1146
+ # Retrieves a customer's cash balance.
1147
+ sig {
1148
+ params(customer: String, params: T.any(::Stripe::Customer::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.untyped)
1149
+ }
1150
+ def self.retrieve_cash_balance(customer, params = {}, opts = {}); end
1151
+
1152
+ # Retrieves a PaymentMethod object for a given Customer.
1153
+ sig {
1154
+ params(payment_method: String, params: T.any(::Stripe::Customer::RetrievePaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
1155
+ }
1156
+ def retrieve_payment_method(payment_method, params = {}, opts = {}); end
1157
+
1158
+ # Retrieves a PaymentMethod object for a given Customer.
1159
+ sig {
1160
+ params(customer: String, payment_method: String, params: T.any(::Stripe::Customer::RetrievePaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
1161
+ }
1162
+ def self.retrieve_payment_method(customer, payment_method, params = {}, opts = {}); end
1163
+
1164
+ sig {
1165
+ params(params: T.any(::Stripe::Customer::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
1166
+ }
1167
+ def self.search(params = {}, opts = {}); end
1168
+
1169
+ sig {
1170
+ params(params: T.any(::Stripe::Customer::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
1171
+ }
1172
+ def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
1173
+
1174
+ # 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.
1175
+ #
1176
+ # This request accepts mostly the same arguments as the customer creation call.
1177
+ sig {
1178
+ params(id: String, params: T.any(::Stripe::Customer::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
1179
+ }
1180
+ def self.update(id, params = {}, opts = {}); end
1181
+
1182
+ # Changes the settings on a customer's cash balance.
1183
+ sig {
1184
+ params(customer: String, params: T.any(::Stripe::Customer::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.untyped)
1185
+ }
1186
+ def self.update_cash_balance(customer, params = {}, opts = {}); end
1187
+ end
1188
+ end