stripe 13.3.0 → 13.4.0.pre.beta.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (743) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1416 -645
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_operations/request.rb +1 -0
  6. data/lib/stripe/api_requestor.rb +1 -0
  7. data/lib/stripe/object_types.rb +32 -0
  8. data/lib/stripe/request_params.rb +24 -0
  9. data/lib/stripe/request_signing_authenticator.rb +79 -0
  10. data/lib/stripe/resources/account.rb +5071 -0
  11. data/lib/stripe/resources/account_link.rb +54 -0
  12. data/lib/stripe/resources/account_notice.rb +132 -0
  13. data/lib/stripe/resources/account_session.rb +877 -0
  14. data/lib/stripe/resources/apple_pay_domain.rb +63 -0
  15. data/lib/stripe/resources/application.rb +20 -0
  16. data/lib/stripe/resources/application_fee.rb +96 -0
  17. data/lib/stripe/resources/application_fee_refund.rb +17 -0
  18. data/lib/stripe/resources/apps/secret.rb +141 -0
  19. data/lib/stripe/resources/balance.rb +131 -0
  20. data/lib/stripe/resources/balance_transaction.rb +112 -0
  21. data/lib/stripe/resources/bank_account.rb +84 -2
  22. data/lib/stripe/resources/billing/alert.rb +144 -0
  23. data/lib/stripe/resources/billing/alert_triggered.rb +26 -0
  24. data/lib/stripe/resources/billing/credit_balance_summary.rb +77 -0
  25. data/lib/stripe/resources/billing/credit_balance_transaction.rb +116 -0
  26. data/lib/stripe/resources/billing/credit_grant.rb +203 -0
  27. data/lib/stripe/resources/billing/meter.rb +178 -0
  28. data/lib/stripe/resources/billing/meter_error_report.rb +59 -0
  29. data/lib/stripe/resources/billing/meter_event.rb +35 -0
  30. data/lib/stripe/resources/billing/meter_event_adjustment.rb +43 -0
  31. data/lib/stripe/resources/billing/meter_event_summary.rb +15 -0
  32. data/lib/stripe/resources/billing_portal/configuration.rb +562 -0
  33. data/lib/stripe/resources/billing_portal/session.rb +271 -0
  34. data/lib/stripe/resources/capability.rb +84 -0
  35. data/lib/stripe/resources/capital/financing_offer.rb +188 -0
  36. data/lib/stripe/resources/capital/financing_summary.rb +64 -0
  37. data/lib/stripe/resources/capital/financing_transaction.rb +123 -0
  38. data/lib/stripe/resources/card.rb +79 -0
  39. data/lib/stripe/resources/cash_balance.rb +17 -0
  40. data/lib/stripe/resources/charge.rb +3026 -0
  41. data/lib/stripe/resources/checkout/session.rb +3654 -0
  42. data/lib/stripe/resources/climate/order.rb +176 -0
  43. data/lib/stripe/resources/climate/product.rb +56 -0
  44. data/lib/stripe/resources/climate/supplier.rb +54 -0
  45. data/lib/stripe/resources/confirmation_token.rb +1520 -0
  46. data/lib/stripe/resources/connect_collection_transfer.rb +24 -0
  47. data/lib/stripe/resources/country_spec.rb +63 -0
  48. data/lib/stripe/resources/coupon.rb +198 -0
  49. data/lib/stripe/resources/credit_note.rb +660 -0
  50. data/lib/stripe/resources/credit_note_line_item.rb +65 -0
  51. data/lib/stripe/resources/customer.rb +840 -0
  52. data/lib/stripe/resources/customer_balance_transaction.rb +27 -0
  53. data/lib/stripe/resources/customer_cash_balance_transaction.rb +109 -0
  54. data/lib/stripe/resources/customer_session.rb +159 -0
  55. data/lib/stripe/resources/discount.rb +29 -0
  56. data/lib/stripe/resources/dispute.rb +619 -0
  57. data/lib/stripe/resources/entitlements/active_entitlement.rb +46 -0
  58. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +23 -0
  59. data/lib/stripe/resources/entitlements/feature.rb +90 -0
  60. data/lib/stripe/resources/ephemeral_key.rb +21 -0
  61. data/lib/stripe/resources/event.rb +130 -0
  62. data/lib/stripe/resources/exchange_rate.rb +33 -0
  63. data/lib/stripe/resources/file.rb +111 -0
  64. data/lib/stripe/resources/file_link.rb +112 -0
  65. data/lib/stripe/resources/financial_connections/account.rb +260 -0
  66. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  67. data/lib/stripe/resources/financial_connections/account_owner.rb +17 -0
  68. data/lib/stripe/resources/financial_connections/account_ownership.rb +9 -0
  69. data/lib/stripe/resources/financial_connections/institution.rb +99 -0
  70. data/lib/stripe/resources/financial_connections/session.rb +159 -0
  71. data/lib/stripe/resources/financial_connections/transaction.rb +101 -0
  72. data/lib/stripe/resources/forwarding/request.rb +165 -0
  73. data/lib/stripe/resources/funding_instructions.rb +308 -0
  74. data/lib/stripe/resources/gift_cards/card.rb +217 -0
  75. data/lib/stripe/resources/gift_cards/transaction.rb +281 -0
  76. data/lib/stripe/resources/identity/verification_report.rb +266 -0
  77. data/lib/stripe/resources/identity/verification_session.rb +361 -0
  78. data/lib/stripe/resources/invoice.rb +8078 -0
  79. data/lib/stripe/resources/invoice_item.rb +445 -0
  80. data/lib/stripe/resources/invoice_line_item.rb +333 -0
  81. data/lib/stripe/resources/invoice_payment.rb +56 -0
  82. data/lib/stripe/resources/invoice_rendering_template.rb +67 -0
  83. data/lib/stripe/resources/issuing/authorization.rb +1117 -2
  84. data/lib/stripe/resources/issuing/card.rb +666 -0
  85. data/lib/stripe/resources/issuing/cardholder.rb +658 -0
  86. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +611 -0
  87. data/lib/stripe/resources/issuing/dispute.rb +790 -0
  88. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +84 -0
  89. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +95 -0
  90. data/lib/stripe/resources/issuing/personalization_design.rb +285 -0
  91. data/lib/stripe/resources/issuing/physical_bundle.rb +63 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +49 -0
  93. data/lib/stripe/resources/issuing/token.rb +175 -0
  94. data/lib/stripe/resources/issuing/transaction.rb +927 -0
  95. data/lib/stripe/resources/line_item.rb +75 -0
  96. data/lib/stripe/resources/login_link.rb +7 -0
  97. data/lib/stripe/resources/mandate.rb +169 -0
  98. data/lib/stripe/resources/margin.rb +124 -0
  99. data/lib/stripe/resources/order.rb +2850 -0
  100. data/lib/stripe/resources/payment_attempt_record.rb +184 -0
  101. data/lib/stripe/resources/payment_intent.rb +12864 -0
  102. data/lib/stripe/resources/payment_link.rb +1563 -0
  103. data/lib/stripe/resources/payment_method.rb +1638 -0
  104. data/lib/stripe/resources/payment_method_configuration.rb +2844 -0
  105. data/lib/stripe/resources/payment_method_domain.rb +153 -0
  106. data/lib/stripe/resources/payment_record.rb +715 -0
  107. data/lib/stripe/resources/payout.rb +218 -0
  108. data/lib/stripe/resources/person.rb +263 -0
  109. data/lib/stripe/resources/plan.rb +317 -0
  110. data/lib/stripe/resources/price.rb +649 -0
  111. data/lib/stripe/resources/product.rb +536 -0
  112. data/lib/stripe/resources/product_feature.rb +12 -0
  113. data/lib/stripe/resources/promotion_code.rb +221 -0
  114. data/lib/stripe/resources/quote.rb +2946 -0
  115. data/lib/stripe/resources/quote_line.rb +274 -0
  116. data/lib/stripe/resources/quote_preview_invoice.rb +652 -0
  117. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +362 -0
  118. data/lib/stripe/resources/radar/early_fraud_warning.rb +77 -0
  119. data/lib/stripe/resources/radar/value_list.rb +125 -0
  120. data/lib/stripe/resources/radar/value_list_item.rb +95 -0
  121. data/lib/stripe/resources/refund.rb +397 -0
  122. data/lib/stripe/resources/reporting/report_run.rb +150 -0
  123. data/lib/stripe/resources/reporting/report_type.rb +36 -0
  124. data/lib/stripe/resources/reserve_transaction.rb +22 -0
  125. data/lib/stripe/resources/reversal.rb +21 -0
  126. data/lib/stripe/resources/review.rb +108 -0
  127. data/lib/stripe/resources/setup_attempt.rb +373 -0
  128. data/lib/stripe/resources/setup_intent.rb +3834 -0
  129. data/lib/stripe/resources/shipping_rate.rb +259 -0
  130. data/lib/stripe/resources/sigma/scheduled_query_run.rb +54 -0
  131. data/lib/stripe/resources/source.rb +1239 -0
  132. data/lib/stripe/resources/source_mandate_notification.rb +66 -0
  133. data/lib/stripe/resources/source_transaction.rb +85 -0
  134. data/lib/stripe/resources/subscription.rb +2057 -0
  135. data/lib/stripe/resources/subscription_item.rb +433 -0
  136. data/lib/stripe/resources/subscription_schedule.rb +2402 -0
  137. data/lib/stripe/resources/tax/association.rb +89 -0
  138. data/lib/stripe/resources/tax/calculation.rb +387 -0
  139. data/lib/stripe/resources/tax/calculation_line_item.rb +56 -0
  140. data/lib/stripe/resources/tax/form.rb +220 -0
  141. data/lib/stripe/resources/tax/registration.rb +2382 -0
  142. data/lib/stripe/resources/tax/settings.rb +126 -0
  143. data/lib/stripe/resources/tax/transaction.rb +267 -0
  144. data/lib/stripe/resources/tax/transaction_line_item.rb +31 -0
  145. data/lib/stripe/resources/tax_code.rb +35 -0
  146. data/lib/stripe/resources/tax_deducted_at_source.rb +22 -0
  147. data/lib/stripe/resources/tax_id.rb +121 -0
  148. data/lib/stripe/resources/tax_rate.rb +200 -0
  149. data/lib/stripe/resources/terminal/configuration.rb +1011 -0
  150. data/lib/stripe/resources/terminal/connection_token.rb +18 -0
  151. data/lib/stripe/resources/terminal/location.rb +175 -0
  152. data/lib/stripe/resources/terminal/reader.rb +782 -0
  153. data/lib/stripe/resources/terminal/reader_collected_data.rb +40 -0
  154. data/lib/stripe/resources/test_helpers/test_clock.rb +86 -0
  155. data/lib/stripe/resources/token.rb +1149 -0
  156. data/lib/stripe/resources/topup.rb +174 -0
  157. data/lib/stripe/resources/transfer.rb +153 -0
  158. data/lib/stripe/resources/treasury/credit_reversal.rb +92 -0
  159. data/lib/stripe/resources/treasury/debit_reversal.rb +103 -0
  160. data/lib/stripe/resources/treasury/financial_account.rb +772 -0
  161. data/lib/stripe/resources/treasury/financial_account_features.rb +191 -0
  162. data/lib/stripe/resources/treasury/inbound_transfer.rb +235 -0
  163. data/lib/stripe/resources/treasury/outbound_payment.rb +495 -0
  164. data/lib/stripe/resources/treasury/outbound_transfer.rb +387 -0
  165. data/lib/stripe/resources/treasury/received_credit.rb +283 -0
  166. data/lib/stripe/resources/treasury/received_debit.rb +244 -0
  167. data/lib/stripe/resources/treasury/transaction.rb +176 -0
  168. data/lib/stripe/resources/treasury/transaction_entry.rb +157 -0
  169. data/lib/stripe/resources/usage_record.rb +13 -0
  170. data/lib/stripe/resources/usage_record_summary.rb +21 -0
  171. data/lib/stripe/resources/v2/amount.rb +9 -0
  172. data/lib/stripe/resources/v2/billing/meter_event.rb +18 -0
  173. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +21 -0
  174. data/lib/stripe/resources/v2/billing/meter_event_session.rb +14 -0
  175. data/lib/stripe/resources/v2/event.rb +27 -0
  176. data/lib/stripe/resources/v2/event_destination.rb +59 -0
  177. data/lib/stripe/resources/webhook_endpoint.rb +122 -0
  178. data/lib/stripe/resources.rb +31 -0
  179. data/lib/stripe/services/account_capability_service.rb +32 -0
  180. data/lib/stripe/services/account_external_account_service.rb +250 -0
  181. data/lib/stripe/services/account_link_service.rb +46 -0
  182. data/lib/stripe/services/account_login_link_service.rb +9 -0
  183. data/lib/stripe/services/account_notice_service.rb +101 -0
  184. data/lib/stripe/services/account_person_service.rb +875 -0
  185. data/lib/stripe/services/account_service.rb +4351 -0
  186. data/lib/stripe/services/account_session_service.rb +664 -0
  187. data/lib/stripe/services/apple_pay_domain_service.rb +51 -0
  188. data/lib/stripe/services/application_fee_refund_service.rb +54 -0
  189. data/lib/stripe/services/application_fee_service.rb +57 -0
  190. data/lib/stripe/services/apps/secret_service.rb +116 -0
  191. data/lib/stripe/services/balance_service.rb +9 -0
  192. data/lib/stripe/services/balance_transaction_service.rb +69 -0
  193. data/lib/stripe/services/billing/alert_service.rb +113 -0
  194. data/lib/stripe/services/billing/credit_balance_summary_service.rb +37 -0
  195. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +40 -0
  196. data/lib/stripe/services/billing/credit_grant_service.rb +151 -0
  197. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +26 -0
  198. data/lib/stripe/services/billing/meter_event_service.rb +21 -0
  199. data/lib/stripe/services/billing/meter_event_summary_service.rb +39 -0
  200. data/lib/stripe/services/billing/meter_service.rb +130 -0
  201. data/lib/stripe/services/billing_portal/configuration_service.rb +444 -0
  202. data/lib/stripe/services/billing_portal/session_service.rb +173 -0
  203. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  204. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  205. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  206. data/lib/stripe/services/capital_service.rb +15 -0
  207. data/lib/stripe/services/charge_service.rb +1736 -0
  208. data/lib/stripe/services/checkout/session_line_item_service.rb +18 -0
  209. data/lib/stripe/services/checkout/session_service.rb +2465 -0
  210. data/lib/stripe/services/climate/order_service.rb +102 -0
  211. data/lib/stripe/services/climate/product_service.rb +27 -0
  212. data/lib/stripe/services/climate/supplier_service.rb +27 -0
  213. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  214. data/lib/stripe/services/country_spec_service.rb +27 -0
  215. data/lib/stripe/services/coupon_service.rb +152 -0
  216. data/lib/stripe/services/credit_note_line_item_service.rb +18 -0
  217. data/lib/stripe/services/credit_note_preview_lines_service.rb +156 -0
  218. data/lib/stripe/services/credit_note_service.rb +373 -0
  219. data/lib/stripe/services/customer_balance_transaction_service.rb +63 -0
  220. data/lib/stripe/services/customer_cash_balance_service.rb +29 -0
  221. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +27 -0
  222. data/lib/stripe/services/customer_funding_instructions_service.rb +42 -0
  223. data/lib/stripe/services/customer_payment_method_service.rb +40 -0
  224. data/lib/stripe/services/customer_payment_source_service.rb +179 -0
  225. data/lib/stripe/services/customer_service.rb +593 -0
  226. data/lib/stripe/services/customer_session_service.rb +96 -0
  227. data/lib/stripe/services/customer_tax_id_service.rb +45 -0
  228. data/lib/stripe/services/dispute_service.rb +374 -0
  229. data/lib/stripe/services/entitlements/active_entitlement_service.rb +36 -0
  230. data/lib/stripe/services/entitlements/feature_service.rb +76 -0
  231. data/lib/stripe/services/ephemeral_key_service.rb +36 -0
  232. data/lib/stripe/services/event_service.rb +65 -0
  233. data/lib/stripe/services/exchange_rate_service.rb +27 -0
  234. data/lib/stripe/services/file_link_service.rb +94 -0
  235. data/lib/stripe/services/file_service.rb +89 -0
  236. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +37 -0
  237. data/lib/stripe/services/financial_connections/account_owner_service.rb +27 -0
  238. data/lib/stripe/services/financial_connections/account_service.rb +99 -1
  239. data/lib/stripe/services/financial_connections/institution_service.rb +57 -0
  240. data/lib/stripe/services/financial_connections/session_service.rb +97 -0
  241. data/lib/stripe/services/financial_connections/transaction_service.rb +70 -0
  242. data/lib/stripe/services/financial_connections_service.rb +2 -1
  243. data/lib/stripe/services/forwarding/request_service.rb +106 -0
  244. data/lib/stripe/services/gift_cards/card_service.rb +170 -0
  245. data/lib/stripe/services/gift_cards/transaction_service.rb +209 -0
  246. data/lib/stripe/services/gift_cards_service.rb +14 -0
  247. data/lib/stripe/services/identity/verification_report_service.rb +65 -0
  248. data/lib/stripe/services/identity/verification_session_service.rb +231 -0
  249. data/lib/stripe/services/invoice_item_service.rb +388 -0
  250. data/lib/stripe/services/invoice_line_item_service.rb +237 -0
  251. data/lib/stripe/services/invoice_payment_service.rb +55 -0
  252. data/lib/stripe/services/invoice_rendering_template_service.rb +51 -0
  253. data/lib/stripe/services/invoice_service.rb +5567 -1
  254. data/lib/stripe/services/invoice_upcoming_lines_service.rb +1864 -0
  255. data/lib/stripe/services/issuing/authorization_service.rb +104 -0
  256. data/lib/stripe/services/issuing/card_service.rb +455 -0
  257. data/lib/stripe/services/issuing/cardholder_service.rb +526 -0
  258. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  259. data/lib/stripe/services/issuing/dispute_service.rb +633 -0
  260. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  261. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  262. data/lib/stripe/services/issuing/personalization_design_service.rb +193 -0
  263. data/lib/stripe/services/issuing/physical_bundle_service.rb +40 -0
  264. data/lib/stripe/services/issuing/token_service.rb +73 -0
  265. data/lib/stripe/services/issuing/transaction_service.rb +81 -0
  266. data/lib/stripe/services/issuing_service.rb +5 -1
  267. data/lib/stripe/services/mandate_service.rb +9 -0
  268. data/lib/stripe/services/margin_service.rb +119 -0
  269. data/lib/stripe/services/order_line_item_service.rb +35 -0
  270. data/lib/stripe/services/order_service.rb +2254 -0
  271. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  272. data/lib/stripe/services/payment_intent_service.rb +10894 -0
  273. data/lib/stripe/services/payment_link_line_item_service.rb +18 -0
  274. data/lib/stripe/services/payment_link_service.rb +1223 -0
  275. data/lib/stripe/services/payment_method_configuration_service.rb +2046 -0
  276. data/lib/stripe/services/payment_method_domain_service.rb +76 -0
  277. data/lib/stripe/services/payment_method_service.rb +864 -0
  278. data/lib/stripe/services/payment_record_service.rb +542 -0
  279. data/lib/stripe/services/payout_service.rb +159 -0
  280. data/lib/stripe/services/plan_service.rb +253 -0
  281. data/lib/stripe/services/price_service.rb +516 -0
  282. data/lib/stripe/services/product_feature_service.rb +42 -0
  283. data/lib/stripe/services/product_service.rb +459 -0
  284. data/lib/stripe/services/promotion_code_service.rb +178 -0
  285. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +18 -0
  286. data/lib/stripe/services/quote_line_item_service.rb +18 -0
  287. data/lib/stripe/services/quote_line_service.rb +35 -0
  288. data/lib/stripe/services/quote_preview_invoice_service.rb +35 -0
  289. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  290. data/lib/stripe/services/quote_service.rb +2319 -1
  291. data/lib/stripe/services/radar/early_fraud_warning_service.rb +61 -0
  292. data/lib/stripe/services/radar/value_list_item_service.rb +79 -0
  293. data/lib/stripe/services/radar/value_list_service.rb +103 -0
  294. data/lib/stripe/services/refund_service.rb +137 -0
  295. data/lib/stripe/services/reporting/report_run_service.rb +106 -0
  296. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  297. data/lib/stripe/services/review_service.rb +56 -0
  298. data/lib/stripe/services/setup_attempt_service.rb +51 -0
  299. data/lib/stripe/services/setup_intent_service.rb +3476 -0
  300. data/lib/stripe/services/shipping_rate_service.rb +200 -0
  301. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +27 -0
  302. data/lib/stripe/services/source_service.rb +601 -0
  303. data/lib/stripe/services/source_transaction_service.rb +18 -0
  304. data/lib/stripe/services/subscription_item_service.rb +383 -0
  305. data/lib/stripe/services/subscription_item_usage_record_service.rb +18 -0
  306. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +18 -0
  307. data/lib/stripe/services/subscription_schedule_service.rb +2053 -0
  308. data/lib/stripe/services/subscription_service.rb +1722 -0
  309. data/lib/stripe/services/tax/association_service.rb +31 -0
  310. data/lib/stripe/services/tax/calculation_line_item_service.rb +18 -0
  311. data/lib/stripe/services/tax/calculation_service.rb +205 -0
  312. data/lib/stripe/services/tax/form_service.rb +100 -0
  313. data/lib/stripe/services/tax/registration_service.rb +1564 -0
  314. data/lib/stripe/services/tax/settings_service.rb +74 -0
  315. data/lib/stripe/services/tax/transaction_line_item_service.rb +18 -0
  316. data/lib/stripe/services/tax/transaction_service.rb +111 -0
  317. data/lib/stripe/services/tax_code_service.rb +27 -0
  318. data/lib/stripe/services/tax_id_service.rb +79 -0
  319. data/lib/stripe/services/tax_rate_service.rb +155 -0
  320. data/lib/stripe/services/tax_service.rb +3 -1
  321. data/lib/stripe/services/terminal/configuration_service.rb +793 -0
  322. data/lib/stripe/services/terminal/connection_token_service.rb +12 -0
  323. data/lib/stripe/services/terminal/location_service.rb +144 -0
  324. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  325. data/lib/stripe/services/terminal/reader_service.rb +443 -0
  326. data/lib/stripe/services/terminal_service.rb +2 -1
  327. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +673 -0
  328. data/lib/stripe/services/test_helpers/customer_service.rb +18 -0
  329. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +745 -0
  330. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  331. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +41 -0
  332. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +632 -0
  333. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  334. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +44 -0
  335. data/lib/stripe/services/test_helpers/test_clock_service.rb +57 -0
  336. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +38 -0
  337. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +87 -0
  338. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +87 -0
  339. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +84 -0
  340. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +84 -0
  341. data/lib/stripe/services/token_service.rb +1121 -0
  342. data/lib/stripe/services/topup_service.rb +142 -0
  343. data/lib/stripe/services/transfer_reversal_service.rb +66 -0
  344. data/lib/stripe/services/transfer_service.rb +119 -0
  345. data/lib/stripe/services/treasury/credit_reversal_service.rb +59 -0
  346. data/lib/stripe/services/treasury/debit_reversal_service.rb +63 -0
  347. data/lib/stripe/services/treasury/financial_account_features_service.rb +169 -0
  348. data/lib/stripe/services/treasury/financial_account_service.rb +509 -0
  349. data/lib/stripe/services/treasury/inbound_transfer_service.rb +88 -0
  350. data/lib/stripe/services/treasury/outbound_payment_service.rb +258 -0
  351. data/lib/stripe/services/treasury/outbound_transfer_service.rb +148 -0
  352. data/lib/stripe/services/treasury/received_credit_service.rb +52 -0
  353. data/lib/stripe/services/treasury/received_debit_service.rb +40 -0
  354. data/lib/stripe/services/treasury/transaction_entry_service.rb +87 -0
  355. data/lib/stripe/services/treasury/transaction_service.rb +95 -0
  356. data/lib/stripe/services/v1_services.rb +8 -1
  357. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +23 -0
  358. data/lib/stripe/services/v2/billing/meter_event_service.rb +25 -0
  359. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  360. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +33 -0
  361. data/lib/stripe/services/v2/core/event_destination_service.rb +146 -0
  362. data/lib/stripe/services/v2/core/event_service.rb +18 -0
  363. data/lib/stripe/services/webhook_endpoint_service.rb +96 -0
  364. data/lib/stripe/services.rb +25 -0
  365. data/lib/stripe/stripe_client.rb +1 -1
  366. data/lib/stripe/stripe_configuration.rb +3 -1
  367. data/lib/stripe/stripe_object.rb +5 -0
  368. data/lib/stripe/util.rb +7 -1
  369. data/lib/stripe/version.rb +1 -1
  370. data/lib/stripe.rb +46 -0
  371. data/rbi/stripe/resources/account.rbi +5100 -0
  372. data/rbi/stripe/resources/account_link.rbi +74 -0
  373. data/rbi/stripe/resources/account_notice.rbi +139 -0
  374. data/rbi/stripe/resources/account_session.rbi +1007 -0
  375. data/rbi/stripe/resources/apple_pay_domain.rbi +97 -0
  376. data/rbi/stripe/resources/application.rbi +20 -0
  377. data/rbi/stripe/resources/application_fee.rbi +123 -0
  378. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  379. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  380. data/rbi/stripe/resources/balance.rbi +187 -0
  381. data/rbi/stripe/resources/balance_transaction.rbi +149 -0
  382. data/rbi/stripe/resources/bank_account.rbi +127 -0
  383. data/rbi/stripe/resources/billing/alert.rbi +206 -0
  384. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  385. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +102 -0
  386. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +154 -0
  387. data/rbi/stripe/resources/billing/credit_grant.rbi +269 -0
  388. data/rbi/stripe/resources/billing/meter.rbi +233 -0
  389. data/rbi/stripe/resources/billing/meter_error_report.rbi +71 -0
  390. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  391. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  392. data/rbi/stripe/resources/billing/meter_event_summary.rbi +33 -0
  393. data/rbi/stripe/resources/billing_portal/configuration.rbi +640 -0
  394. data/rbi/stripe/resources/billing_portal/session.rbi +341 -0
  395. data/rbi/stripe/resources/capability.rbi +125 -0
  396. data/rbi/stripe/resources/capital/financing_offer.rbi +190 -0
  397. data/rbi/stripe/resources/capital/financing_summary.rbi +74 -0
  398. data/rbi/stripe/resources/capital/financing_transaction.rbi +130 -0
  399. data/rbi/stripe/resources/card.rbi +128 -0
  400. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  401. data/rbi/stripe/resources/charge.rbi +3484 -0
  402. data/rbi/stripe/resources/checkout/session.rbi +3995 -0
  403. data/rbi/stripe/resources/climate/order.rbi +250 -0
  404. data/rbi/stripe/resources/climate/product.rbi +82 -0
  405. data/rbi/stripe/resources/climate/supplier.rbi +79 -0
  406. data/rbi/stripe/resources/confirmation_token.rbi +1776 -0
  407. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  408. data/rbi/stripe/resources/country_spec.rbi +92 -0
  409. data/rbi/stripe/resources/coupon.rbi +257 -0
  410. data/rbi/stripe/resources/credit_note.rbi +759 -0
  411. data/rbi/stripe/resources/credit_note_line_item.rbi +99 -0
  412. data/rbi/stripe/resources/customer.rbi +1001 -0
  413. data/rbi/stripe/resources/customer_balance_transaction.rbi +53 -0
  414. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  415. data/rbi/stripe/resources/customer_session.rbi +196 -0
  416. data/rbi/stripe/resources/discount.rbi +53 -0
  417. data/rbi/stripe/resources/dispute.rbi +764 -0
  418. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +65 -0
  419. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  420. data/rbi/stripe/resources/entitlements/feature.rbi +124 -0
  421. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  422. data/rbi/stripe/resources/event.rbi +190 -0
  423. data/rbi/stripe/resources/exchange_rate.rbi +73 -0
  424. data/rbi/stripe/resources/file.rbi +148 -0
  425. data/rbi/stripe/resources/file_link.rbi +146 -0
  426. data/rbi/stripe/resources/financial_connections/account.rbi +358 -0
  427. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +27 -0
  428. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  429. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  430. data/rbi/stripe/resources/financial_connections/institution.rbi +99 -0
  431. data/rbi/stripe/resources/financial_connections/session.rbi +186 -0
  432. data/rbi/stripe/resources/financial_connections/transaction.rbi +127 -0
  433. data/rbi/stripe/resources/forwarding/request.rbi +219 -0
  434. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  435. data/rbi/stripe/resources/gift_cards/card.rbi +206 -0
  436. data/rbi/stripe/resources/gift_cards/transaction.rbi +257 -0
  437. data/rbi/stripe/resources/identity/verification_report.rbi +354 -0
  438. data/rbi/stripe/resources/identity/verification_session.rbi +518 -0
  439. data/rbi/stripe/resources/invoice.rbi +8928 -0
  440. data/rbi/stripe/resources/invoice_item.rbi +514 -0
  441. data/rbi/stripe/resources/invoice_line_item.rbi +400 -0
  442. data/rbi/stripe/resources/invoice_payment.rbi +70 -0
  443. data/rbi/stripe/resources/invoice_rendering_template.rbi +114 -0
  444. data/rbi/stripe/resources/issuing/authorization.rbi +1266 -0
  445. data/rbi/stripe/resources/issuing/card.rbi +738 -0
  446. data/rbi/stripe/resources/issuing/cardholder.rbi +732 -0
  447. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +622 -0
  448. data/rbi/stripe/resources/issuing/dispute.rbi +900 -0
  449. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +83 -0
  450. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +90 -0
  451. data/rbi/stripe/resources/issuing/personalization_design.rbi +333 -0
  452. data/rbi/stripe/resources/issuing/physical_bundle.rbi +86 -0
  453. data/rbi/stripe/resources/issuing/settlement.rbi +62 -0
  454. data/rbi/stripe/resources/issuing/token.rbi +231 -0
  455. data/rbi/stripe/resources/issuing/transaction.rbi +1057 -0
  456. data/rbi/stripe/resources/line_item.rbi +108 -0
  457. data/rbi/stripe/resources/login_link.rbi +18 -0
  458. data/rbi/stripe/resources/mandate.rbi +219 -0
  459. data/rbi/stripe/resources/margin.rbi +127 -0
  460. data/rbi/stripe/resources/order.rbi +3016 -0
  461. data/rbi/stripe/resources/payment_attempt_record.rbi +215 -0
  462. data/rbi/stripe/resources/payment_intent.rbi +13843 -0
  463. data/rbi/stripe/resources/payment_link.rbi +1666 -0
  464. data/rbi/stripe/resources/payment_method.rbi +1908 -0
  465. data/rbi/stripe/resources/payment_method_configuration.rbi +3171 -0
  466. data/rbi/stripe/resources/payment_method_domain.rbi +217 -0
  467. data/rbi/stripe/resources/payment_record.rbi +722 -0
  468. data/rbi/stripe/resources/payout.rbi +299 -0
  469. data/rbi/stripe/resources/person.rbi +371 -0
  470. data/rbi/stripe/resources/plan.rbi +385 -0
  471. data/rbi/stripe/resources/price.rbi +731 -0
  472. data/rbi/stripe/resources/product.rbi +615 -0
  473. data/rbi/stripe/resources/product_feature.rbi +26 -0
  474. data/rbi/stripe/resources/promotion_code.rbi +266 -0
  475. data/rbi/stripe/resources/quote.rbi +3186 -0
  476. data/rbi/stripe/resources/quote_line.rbi +350 -0
  477. data/rbi/stripe/resources/quote_preview_invoice.rbi +850 -0
  478. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +474 -0
  479. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +101 -0
  480. data/rbi/stripe/resources/radar/value_list.rbi +175 -0
  481. data/rbi/stripe/resources/radar/value_list_item.rbi +134 -0
  482. data/rbi/stripe/resources/refund.rbi +515 -0
  483. data/rbi/stripe/resources/reporting/report_run.rbi +194 -0
  484. data/rbi/stripe/resources/reporting/report_type.rbi +64 -0
  485. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  486. data/rbi/stripe/resources/reversal.rbi +51 -0
  487. data/rbi/stripe/resources/review.rbi +159 -0
  488. data/rbi/stripe/resources/setup_attempt.rbi +484 -0
  489. data/rbi/stripe/resources/setup_intent.rbi +4041 -0
  490. data/rbi/stripe/resources/shipping_rate.rbi +310 -0
  491. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +82 -0
  492. data/rbi/stripe/resources/source.rbi +1543 -0
  493. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  494. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  495. data/rbi/stripe/resources/subscription.rbi +2308 -0
  496. data/rbi/stripe/resources/subscription_item.rbi +478 -0
  497. data/rbi/stripe/resources/subscription_schedule.rbi +2653 -0
  498. data/rbi/stripe/resources/tax/association.rbi +94 -0
  499. data/rbi/stripe/resources/tax/calculation.rbi +479 -0
  500. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  501. data/rbi/stripe/resources/tax/form.rbi +224 -0
  502. data/rbi/stripe/resources/tax/registration.rbi +2438 -0
  503. data/rbi/stripe/resources/tax/settings.rbi +148 -0
  504. data/rbi/stripe/resources/tax/transaction.rbi +356 -0
  505. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  506. data/rbi/stripe/resources/tax_code.rbi +51 -0
  507. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  508. data/rbi/stripe/resources/tax_id.rbi +174 -0
  509. data/rbi/stripe/resources/tax_rate.rbi +244 -0
  510. data/rbi/stripe/resources/terminal/configuration.rbi +1091 -0
  511. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  512. data/rbi/stripe/resources/terminal/location.rbi +231 -0
  513. data/rbi/stripe/resources/terminal/reader.rbi +952 -0
  514. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +41 -0
  515. data/rbi/stripe/resources/test_helpers/test_clock.rbi +139 -0
  516. data/rbi/stripe/resources/token.rbi +1175 -0
  517. data/rbi/stripe/resources/topup.rbi +225 -0
  518. data/rbi/stripe/resources/transfer.rbi +204 -0
  519. data/rbi/stripe/resources/treasury/credit_reversal.rbi +126 -0
  520. data/rbi/stripe/resources/treasury/debit_reversal.rbi +138 -0
  521. data/rbi/stripe/resources/treasury/financial_account.rbi +870 -0
  522. data/rbi/stripe/resources/treasury/financial_account_features.rbi +263 -0
  523. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +302 -0
  524. data/rbi/stripe/resources/treasury/outbound_payment.rbi +589 -0
  525. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +473 -0
  526. data/rbi/stripe/resources/treasury/received_credit.rbi +348 -0
  527. data/rbi/stripe/resources/treasury/received_debit.rbi +305 -0
  528. data/rbi/stripe/resources/treasury/transaction.rbi +216 -0
  529. data/rbi/stripe/resources/treasury/transaction_entry.rbi +193 -0
  530. data/rbi/stripe/resources/usage_record.rbi +32 -0
  531. data/rbi/stripe/resources/usage_record_summary.rbi +38 -0
  532. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  533. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  534. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  535. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  536. data/rbi/stripe/resources/v2/event.rbi +47 -0
  537. data/rbi/stripe/resources/v2/event_destination.rbi +90 -0
  538. data/rbi/stripe/resources/webhook_endpoint.rbi +177 -0
  539. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  540. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  541. data/rbi/stripe/services/account_link_service.rbi +58 -0
  542. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  543. data/rbi/stripe/services/account_notice_service.rbi +90 -0
  544. data/rbi/stripe/services/account_person_service.rbi +903 -0
  545. data/rbi/stripe/services/account_service.rbi +4185 -0
  546. data/rbi/stripe/services/account_session_service.rbi +757 -0
  547. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  548. data/rbi/stripe/services/application_fee_refund_service.rbi +91 -0
  549. data/rbi/stripe/services/application_fee_service.rbi +74 -0
  550. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  551. data/rbi/stripe/services/apps_service.rbi +9 -0
  552. data/rbi/stripe/services/balance_service.rbi +21 -0
  553. data/rbi/stripe/services/balance_transaction_service.rbi +89 -0
  554. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  555. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +54 -0
  556. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  557. data/rbi/stripe/services/billing/credit_grant_service.rbi +191 -0
  558. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +40 -0
  559. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  560. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  561. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  562. data/rbi/stripe/services/billing_portal/configuration_service.rbi +497 -0
  563. data/rbi/stripe/services/billing_portal/session_service.rbi +202 -0
  564. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  565. data/rbi/stripe/services/billing_service.rbi +15 -0
  566. data/rbi/stripe/services/capital/financing_offer_service.rbi +95 -0
  567. data/rbi/stripe/services/capital/financing_summary_service.rbi +22 -0
  568. data/rbi/stripe/services/capital/financing_transaction_service.rbi +68 -0
  569. data/rbi/stripe/services/capital_service.rbi +11 -0
  570. data/rbi/stripe/services/charge_service.rbi +1816 -0
  571. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  572. data/rbi/stripe/services/checkout/session_service.rbi +2582 -0
  573. data/rbi/stripe/services/checkout_service.rbi +9 -0
  574. data/rbi/stripe/services/climate/order_service.rbi +140 -0
  575. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  576. data/rbi/stripe/services/climate/supplier_service.rbi +46 -0
  577. data/rbi/stripe/services/climate_service.rbi +11 -0
  578. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  579. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  580. data/rbi/stripe/services/coupon_service.rbi +190 -0
  581. data/rbi/stripe/services/credit_note_line_item_service.rbi +31 -0
  582. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  583. data/rbi/stripe/services/credit_note_service.rbi +420 -0
  584. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  585. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  586. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  587. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  588. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  589. data/rbi/stripe/services/customer_payment_source_service.rbi +228 -0
  590. data/rbi/stripe/services/customer_service.rbi +647 -0
  591. data/rbi/stripe/services/customer_session_service.rbi +110 -0
  592. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  593. data/rbi/stripe/services/dispute_service.rbi +422 -0
  594. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  595. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  596. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  597. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  598. data/rbi/stripe/services/event_service.rbi +81 -0
  599. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  600. data/rbi/stripe/services/file_link_service.rbi +122 -0
  601. data/rbi/stripe/services/file_service.rbi +114 -0
  602. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +33 -0
  603. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  604. data/rbi/stripe/services/financial_connections/account_service.rbi +132 -0
  605. data/rbi/stripe/services/financial_connections/institution_service.rbi +46 -0
  606. data/rbi/stripe/services/financial_connections/session_service.rbi +111 -0
  607. data/rbi/stripe/services/financial_connections/transaction_service.rbi +90 -0
  608. data/rbi/stripe/services/financial_connections_service.rbi +12 -0
  609. data/rbi/stripe/services/forwarding/request_service.rbi +132 -0
  610. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  611. data/rbi/stripe/services/gift_cards/card_service.rbi +142 -0
  612. data/rbi/stripe/services/gift_cards/transaction_service.rbi +174 -0
  613. data/rbi/stripe/services/gift_cards_service.rbi +10 -0
  614. data/rbi/stripe/services/identity/verification_report_service.rbi +85 -0
  615. data/rbi/stripe/services/identity/verification_session_service.rbi +317 -0
  616. data/rbi/stripe/services/identity_service.rbi +10 -0
  617. data/rbi/stripe/services/invoice_item_service.rbi +424 -0
  618. data/rbi/stripe/services/invoice_line_item_service.rbi +270 -0
  619. data/rbi/stripe/services/invoice_payment_service.rbi +44 -0
  620. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  621. data/rbi/stripe/services/invoice_service.rbi +6040 -0
  622. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +2023 -0
  623. data/rbi/stripe/services/issuing/authorization_service.rbi +140 -0
  624. data/rbi/stripe/services/issuing/card_service.rbi +479 -0
  625. data/rbi/stripe/services/issuing/cardholder_service.rbi +568 -0
  626. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +498 -0
  627. data/rbi/stripe/services/issuing/dispute_service.rbi +701 -0
  628. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +55 -0
  629. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +73 -0
  630. data/rbi/stripe/services/issuing/personalization_design_service.rbi +233 -0
  631. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  632. data/rbi/stripe/services/issuing/token_service.rbi +95 -0
  633. data/rbi/stripe/services/issuing/transaction_service.rbi +103 -0
  634. data/rbi/stripe/services/issuing_service.rbi +19 -0
  635. data/rbi/stripe/services/mandate_service.rbi +20 -0
  636. data/rbi/stripe/services/margin_service.rbi +104 -0
  637. data/rbi/stripe/services/order_line_item_service.rbi +31 -0
  638. data/rbi/stripe/services/order_service.rbi +2306 -0
  639. data/rbi/stripe/services/payment_attempt_record_service.rbi +36 -0
  640. data/rbi/stripe/services/payment_intent_service.rbi +11429 -0
  641. data/rbi/stripe/services/payment_link_line_item_service.rbi +31 -0
  642. data/rbi/stripe/services/payment_link_service.rbi +1250 -0
  643. data/rbi/stripe/services/payment_method_configuration_service.rbi +2171 -0
  644. data/rbi/stripe/services/payment_method_domain_service.rbi +110 -0
  645. data/rbi/stripe/services/payment_method_service.rbi +883 -0
  646. data/rbi/stripe/services/payment_record_service.rbi +521 -0
  647. data/rbi/stripe/services/payout_service.rbi +197 -0
  648. data/rbi/stripe/services/plan_service.rbi +286 -0
  649. data/rbi/stripe/services/price_service.rbi +551 -0
  650. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  651. data/rbi/stripe/services/product_service.rbi +503 -0
  652. data/rbi/stripe/services/promotion_code_service.rbi +210 -0
  653. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  654. data/rbi/stripe/services/quote_line_item_service.rbi +31 -0
  655. data/rbi/stripe/services/quote_line_service.rbi +31 -0
  656. data/rbi/stripe/services/quote_preview_invoice_service.rbi +31 -0
  657. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +31 -0
  658. data/rbi/stripe/services/quote_service.rbi +2390 -0
  659. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +83 -0
  660. data/rbi/stripe/services/radar/value_list_item_service.rbi +107 -0
  661. data/rbi/stripe/services/radar/value_list_service.rbi +139 -0
  662. data/rbi/stripe/services/radar_service.rbi +11 -0
  663. data/rbi/stripe/services/refund_service.rbi +181 -0
  664. data/rbi/stripe/services/reporting/report_run_service.rbi +131 -0
  665. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  666. data/rbi/stripe/services/reporting_service.rbi +10 -0
  667. data/rbi/stripe/services/review_service.rbi +82 -0
  668. data/rbi/stripe/services/setup_attempt_service.rbi +63 -0
  669. data/rbi/stripe/services/setup_intent_service.rbi +3609 -0
  670. data/rbi/stripe/services/shipping_rate_service.rbi +235 -0
  671. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  672. data/rbi/stripe/services/sigma_service.rbi +9 -0
  673. data/rbi/stripe/services/source_service.rbi +647 -0
  674. data/rbi/stripe/services/source_transaction_service.rbi +31 -0
  675. data/rbi/stripe/services/subscription_item_service.rbi +422 -0
  676. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +37 -0
  677. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +33 -0
  678. data/rbi/stripe/services/subscription_schedule_service.rbi +2208 -0
  679. data/rbi/stripe/services/subscription_service.rbi +1870 -0
  680. data/rbi/stripe/services/tax/association_service.rbi +25 -0
  681. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  682. data/rbi/stripe/services/tax/calculation_service.rbi +228 -0
  683. data/rbi/stripe/services/tax/form_service.rbi +85 -0
  684. data/rbi/stripe/services/tax/registration_service.rbi +1517 -0
  685. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  686. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +33 -0
  687. data/rbi/stripe/services/tax/transaction_service.rbi +142 -0
  688. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  689. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  690. data/rbi/stripe/services/tax_rate_service.rbi +183 -0
  691. data/rbi/stripe/services/tax_service.rbi +14 -0
  692. data/rbi/stripe/services/terminal/configuration_service.rbi +822 -0
  693. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  694. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  695. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +22 -0
  696. data/rbi/stripe/services/terminal/reader_service.rbi +513 -0
  697. data/rbi/stripe/services/terminal_service.rbi +13 -0
  698. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +778 -0
  699. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  700. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +836 -0
  701. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  702. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +67 -0
  703. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +705 -0
  704. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  705. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  706. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  707. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  708. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +90 -0
  709. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  710. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +123 -0
  711. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +123 -0
  712. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +114 -0
  713. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +114 -0
  714. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  715. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  716. data/rbi/stripe/services/token_service.rbi +1136 -0
  717. data/rbi/stripe/services/topup_service.rbi +172 -0
  718. data/rbi/stripe/services/transfer_reversal_service.rbi +99 -0
  719. data/rbi/stripe/services/transfer_service.rbi +150 -0
  720. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  721. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  722. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +201 -0
  723. data/rbi/stripe/services/treasury/financial_account_service.rbi +566 -0
  724. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  725. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +300 -0
  726. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +182 -0
  727. data/rbi/stripe/services/treasury/received_credit_service.rbi +70 -0
  728. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  729. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +107 -0
  730. data/rbi/stripe/services/treasury/transaction_service.rbi +114 -0
  731. data/rbi/stripe/services/treasury_service.rbi +18 -0
  732. data/rbi/stripe/services/v1_services.rbi +83 -0
  733. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  734. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  735. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  736. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  737. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  738. data/rbi/stripe/services/v2/core/event_destination_service.rbi +203 -0
  739. data/rbi/stripe/services/v2/core/event_service.rbi +39 -0
  740. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  741. data/rbi/stripe/services/v2_services.rbi +10 -0
  742. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  743. metadata +435 -4
@@ -0,0 +1,731 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ # Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
7
+ # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
8
+ #
9
+ # For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
10
+ #
11
+ # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
12
+ class Price < APIResource
13
+ class CurrencyOptions < Stripe::StripeObject
14
+ class CustomUnitAmount < Stripe::StripeObject
15
+ # The maximum unit amount the customer can specify for this item.
16
+ sig { returns(T.nilable(Integer)) }
17
+ attr_reader :maximum
18
+ # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
19
+ sig { returns(T.nilable(Integer)) }
20
+ attr_reader :minimum
21
+ # The starting unit amount which can be updated by the customer.
22
+ sig { returns(T.nilable(Integer)) }
23
+ attr_reader :preset
24
+ end
25
+ class Tier < Stripe::StripeObject
26
+ # Price for the entire tier.
27
+ sig { returns(T.nilable(Integer)) }
28
+ attr_reader :flat_amount
29
+ # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
30
+ sig { returns(T.nilable(String)) }
31
+ attr_reader :flat_amount_decimal
32
+ # Per unit price for units relevant to the tier.
33
+ sig { returns(T.nilable(Integer)) }
34
+ attr_reader :unit_amount
35
+ # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
36
+ sig { returns(T.nilable(String)) }
37
+ attr_reader :unit_amount_decimal
38
+ # Up to and including to this quantity will be contained in the tier.
39
+ sig { returns(T.nilable(Integer)) }
40
+ attr_reader :up_to
41
+ end
42
+ # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
43
+ sig { returns(T.nilable(CustomUnitAmount)) }
44
+ attr_reader :custom_unit_amount
45
+ # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
46
+ sig { returns(T.nilable(String)) }
47
+ attr_reader :tax_behavior
48
+ # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
49
+ sig { returns(T::Array[Tier]) }
50
+ attr_reader :tiers
51
+ # The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
52
+ sig { returns(T.nilable(Integer)) }
53
+ attr_reader :unit_amount
54
+ # The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
55
+ sig { returns(T.nilable(String)) }
56
+ attr_reader :unit_amount_decimal
57
+ end
58
+ class CustomUnitAmount < Stripe::StripeObject
59
+ # The maximum unit amount the customer can specify for this item.
60
+ sig { returns(T.nilable(Integer)) }
61
+ attr_reader :maximum
62
+ # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
63
+ sig { returns(T.nilable(Integer)) }
64
+ attr_reader :minimum
65
+ # The starting unit amount which can be updated by the customer.
66
+ sig { returns(T.nilable(Integer)) }
67
+ attr_reader :preset
68
+ end
69
+ class MigrateTo < Stripe::StripeObject
70
+ # The behavior controlling at what point in the subscription lifecycle to migrate the price
71
+ sig { returns(String) }
72
+ attr_reader :behavior
73
+ # The unix timestamp after at which subscriptions will start to migrate to the new price.
74
+ sig { returns(Integer) }
75
+ attr_reader :effective_after
76
+ # The id of the price being migrated to
77
+ sig { returns(String) }
78
+ attr_reader :price
79
+ end
80
+ class Recurring < Stripe::StripeObject
81
+ # Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.
82
+ sig { returns(T.nilable(String)) }
83
+ attr_reader :aggregate_usage
84
+ # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
85
+ sig { returns(String) }
86
+ attr_reader :interval
87
+ # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
88
+ sig { returns(Integer) }
89
+ attr_reader :interval_count
90
+ # The meter tracking the usage of a metered price
91
+ sig { returns(T.nilable(String)) }
92
+ attr_reader :meter
93
+ # Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
94
+ sig { returns(T.nilable(Integer)) }
95
+ attr_reader :trial_period_days
96
+ # Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
97
+ sig { returns(String) }
98
+ attr_reader :usage_type
99
+ end
100
+ class Tier < Stripe::StripeObject
101
+ # Price for the entire tier.
102
+ sig { returns(T.nilable(Integer)) }
103
+ attr_reader :flat_amount
104
+ # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
105
+ sig { returns(T.nilable(String)) }
106
+ attr_reader :flat_amount_decimal
107
+ # Per unit price for units relevant to the tier.
108
+ sig { returns(T.nilable(Integer)) }
109
+ attr_reader :unit_amount
110
+ # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
111
+ sig { returns(T.nilable(String)) }
112
+ attr_reader :unit_amount_decimal
113
+ # Up to and including to this quantity will be contained in the tier.
114
+ sig { returns(T.nilable(Integer)) }
115
+ attr_reader :up_to
116
+ end
117
+ class TransformQuantity < Stripe::StripeObject
118
+ # Divide usage by this number.
119
+ sig { returns(Integer) }
120
+ attr_reader :divide_by
121
+ # After division, either round the result `up` or `down`.
122
+ sig { returns(String) }
123
+ attr_reader :round
124
+ end
125
+ # Whether the price can be used for new purchases.
126
+ sig { returns(T::Boolean) }
127
+ attr_reader :active
128
+ # Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
129
+ sig { returns(String) }
130
+ attr_reader :billing_scheme
131
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
132
+ sig { returns(Integer) }
133
+ attr_reader :created
134
+ # 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).
135
+ sig { returns(String) }
136
+ attr_reader :currency
137
+ # Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
138
+ sig { returns(T::Hash[String, CurrencyOptions]) }
139
+ attr_reader :currency_options
140
+ # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
141
+ sig { returns(T.nilable(CustomUnitAmount)) }
142
+ attr_reader :custom_unit_amount
143
+ # Unique identifier for the object.
144
+ sig { returns(String) }
145
+ attr_reader :id
146
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
147
+ sig { returns(T::Boolean) }
148
+ attr_reader :livemode
149
+ # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
150
+ sig { returns(T.nilable(String)) }
151
+ attr_reader :lookup_key
152
+ # 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.
153
+ sig { returns(T::Hash[String, String]) }
154
+ attr_reader :metadata
155
+ # Subscriptions using this price will be migrated to use the new referenced price.
156
+ sig { returns(T.nilable(MigrateTo)) }
157
+ attr_reader :migrate_to
158
+ # A brief description of the price, hidden from customers.
159
+ sig { returns(T.nilable(String)) }
160
+ attr_reader :nickname
161
+ # String representing the object's type. Objects of the same type share the same value.
162
+ sig { returns(String) }
163
+ attr_reader :object
164
+ # The ID of the product this price is associated with.
165
+ sig { returns(T.any(String, Stripe::Product)) }
166
+ attr_reader :product
167
+ # The recurring components of a price such as `interval` and `usage_type`.
168
+ sig { returns(T.nilable(Recurring)) }
169
+ attr_reader :recurring
170
+ # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
171
+ sig { returns(T.nilable(String)) }
172
+ attr_reader :tax_behavior
173
+ # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
174
+ sig { returns(T::Array[Tier]) }
175
+ attr_reader :tiers
176
+ # Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.
177
+ sig { returns(T.nilable(String)) }
178
+ attr_reader :tiers_mode
179
+ # Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
180
+ sig { returns(T.nilable(TransformQuantity)) }
181
+ attr_reader :transform_quantity
182
+ # One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
183
+ sig { returns(String) }
184
+ attr_reader :type
185
+ # The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
186
+ sig { returns(T.nilable(Integer)) }
187
+ attr_reader :unit_amount
188
+ # The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
189
+ sig { returns(T.nilable(String)) }
190
+ attr_reader :unit_amount_decimal
191
+ # Always true for a deleted object
192
+ sig { returns(T::Boolean) }
193
+ attr_reader :deleted
194
+ class ListParams < Stripe::RequestParams
195
+ class Created < Stripe::RequestParams
196
+ # Minimum value to filter by (exclusive)
197
+ sig { returns(Integer) }
198
+ attr_accessor :gt
199
+ # Minimum value to filter by (inclusive)
200
+ sig { returns(Integer) }
201
+ attr_accessor :gte
202
+ # Maximum value to filter by (exclusive)
203
+ sig { returns(Integer) }
204
+ attr_accessor :lt
205
+ # Maximum value to filter by (inclusive)
206
+ sig { returns(Integer) }
207
+ attr_accessor :lte
208
+ sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
209
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
210
+ end
211
+ class Recurring < Stripe::RequestParams
212
+ # Filter by billing frequency. Either `day`, `week`, `month` or `year`.
213
+ sig { returns(String) }
214
+ attr_accessor :interval
215
+ # Filter by the price's meter.
216
+ sig { returns(String) }
217
+ attr_accessor :meter
218
+ # Filter by the usage type for this price. Can be either `metered` or `licensed`.
219
+ sig { returns(String) }
220
+ attr_accessor :usage_type
221
+ sig { params(interval: String, meter: String, usage_type: String).void }
222
+ def initialize(interval: nil, meter: nil, usage_type: nil); end
223
+ end
224
+ # Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
225
+ sig { returns(T::Boolean) }
226
+ attr_accessor :active
227
+ # A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
228
+ sig { returns(T.any(::Stripe::Price::ListParams::Created, Integer)) }
229
+ attr_accessor :created
230
+ # Only return prices for the given currency.
231
+ sig { returns(String) }
232
+ attr_accessor :currency
233
+ # 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.
234
+ sig { returns(String) }
235
+ attr_accessor :ending_before
236
+ # Specifies which fields in the response should be expanded.
237
+ sig { returns(T::Array[String]) }
238
+ attr_accessor :expand
239
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
240
+ sig { returns(Integer) }
241
+ attr_accessor :limit
242
+ # Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
243
+ sig { returns(T::Array[String]) }
244
+ attr_accessor :lookup_keys
245
+ # Only return prices for the given product.
246
+ sig { returns(String) }
247
+ attr_accessor :product
248
+ # Only return prices with these recurring fields.
249
+ sig { returns(::Stripe::Price::ListParams::Recurring) }
250
+ attr_accessor :recurring
251
+ # 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.
252
+ sig { returns(String) }
253
+ attr_accessor :starting_after
254
+ # Only return prices of type `recurring` or `one_time`.
255
+ sig { returns(String) }
256
+ attr_accessor :type
257
+ sig {
258
+ params(active: T::Boolean, created: T.any(::Stripe::Price::ListParams::Created, Integer), currency: String, ending_before: String, expand: T::Array[String], limit: Integer, lookup_keys: T::Array[String], product: String, recurring: ::Stripe::Price::ListParams::Recurring, starting_after: String, type: String).void
259
+ }
260
+ def initialize(
261
+ active: nil,
262
+ created: nil,
263
+ currency: nil,
264
+ ending_before: nil,
265
+ expand: nil,
266
+ limit: nil,
267
+ lookup_keys: nil,
268
+ product: nil,
269
+ recurring: nil,
270
+ starting_after: nil,
271
+ type: nil
272
+ ); end
273
+ end
274
+ class CreateParams < Stripe::RequestParams
275
+ class CurrencyOptions < Stripe::RequestParams
276
+ class CustomUnitAmount < Stripe::RequestParams
277
+ # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
278
+ sig { returns(T::Boolean) }
279
+ attr_accessor :enabled
280
+ # The maximum unit amount the customer can specify for this item.
281
+ sig { returns(Integer) }
282
+ attr_accessor :maximum
283
+ # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
284
+ sig { returns(Integer) }
285
+ attr_accessor :minimum
286
+ # The starting unit amount which can be updated by the customer.
287
+ sig { returns(Integer) }
288
+ attr_accessor :preset
289
+ sig {
290
+ params(enabled: T::Boolean, maximum: Integer, minimum: Integer, preset: Integer).void
291
+ }
292
+ def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
293
+ end
294
+ class Tier < Stripe::RequestParams
295
+ # The flat billing amount for an entire tier, regardless of the number of units in the tier.
296
+ sig { returns(Integer) }
297
+ attr_accessor :flat_amount
298
+ # Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
299
+ sig { returns(String) }
300
+ attr_accessor :flat_amount_decimal
301
+ # The per unit billing amount for each individual unit for which this tier applies.
302
+ sig { returns(Integer) }
303
+ attr_accessor :unit_amount
304
+ # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
305
+ sig { returns(String) }
306
+ attr_accessor :unit_amount_decimal
307
+ # Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
308
+ sig { returns(T.any(String, Integer)) }
309
+ attr_accessor :up_to
310
+ sig {
311
+ params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
312
+ }
313
+ def initialize(
314
+ flat_amount: nil,
315
+ flat_amount_decimal: nil,
316
+ unit_amount: nil,
317
+ unit_amount_decimal: nil,
318
+ up_to: nil
319
+ ); end
320
+ end
321
+ # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
322
+ sig { returns(::Stripe::Price::CreateParams::CurrencyOptions::CustomUnitAmount) }
323
+ attr_accessor :custom_unit_amount
324
+ # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
325
+ sig { returns(String) }
326
+ attr_accessor :tax_behavior
327
+ # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
328
+ sig { returns(T::Array[::Stripe::Price::CreateParams::CurrencyOptions::Tier]) }
329
+ attr_accessor :tiers
330
+ # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
331
+ sig { returns(Integer) }
332
+ attr_accessor :unit_amount
333
+ # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
334
+ sig { returns(String) }
335
+ attr_accessor :unit_amount_decimal
336
+ sig {
337
+ params(custom_unit_amount: ::Stripe::Price::CreateParams::CurrencyOptions::CustomUnitAmount, tax_behavior: String, tiers: T::Array[::Stripe::Price::CreateParams::CurrencyOptions::Tier], unit_amount: Integer, unit_amount_decimal: String).void
338
+ }
339
+ def initialize(
340
+ custom_unit_amount: nil,
341
+ tax_behavior: nil,
342
+ tiers: nil,
343
+ unit_amount: nil,
344
+ unit_amount_decimal: nil
345
+ ); end
346
+ end
347
+ class CustomUnitAmount < Stripe::RequestParams
348
+ # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
349
+ sig { returns(T::Boolean) }
350
+ attr_accessor :enabled
351
+ # The maximum unit amount the customer can specify for this item.
352
+ sig { returns(Integer) }
353
+ attr_accessor :maximum
354
+ # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
355
+ sig { returns(Integer) }
356
+ attr_accessor :minimum
357
+ # The starting unit amount which can be updated by the customer.
358
+ sig { returns(Integer) }
359
+ attr_accessor :preset
360
+ sig {
361
+ params(enabled: T::Boolean, maximum: Integer, minimum: Integer, preset: Integer).void
362
+ }
363
+ def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
364
+ end
365
+ class ProductData < Stripe::RequestParams
366
+ # Whether the product is currently available for purchase. Defaults to `true`.
367
+ sig { returns(T::Boolean) }
368
+ attr_accessor :active
369
+ # The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
370
+ sig { returns(String) }
371
+ attr_accessor :id
372
+ # 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`.
373
+ sig { returns(T::Hash[String, String]) }
374
+ attr_accessor :metadata
375
+ # The product's name, meant to be displayable to the customer.
376
+ sig { returns(String) }
377
+ attr_accessor :name
378
+ # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
379
+ #
380
+ # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
381
+ sig { returns(String) }
382
+ attr_accessor :statement_descriptor
383
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
384
+ sig { returns(String) }
385
+ attr_accessor :tax_code
386
+ # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
387
+ sig { returns(String) }
388
+ attr_accessor :unit_label
389
+ sig {
390
+ params(active: T::Boolean, id: String, metadata: T::Hash[String, String], name: String, statement_descriptor: String, tax_code: String, unit_label: String).void
391
+ }
392
+ def initialize(
393
+ active: nil,
394
+ id: nil,
395
+ metadata: nil,
396
+ name: nil,
397
+ statement_descriptor: nil,
398
+ tax_code: nil,
399
+ unit_label: nil
400
+ ); end
401
+ end
402
+ class Recurring < Stripe::RequestParams
403
+ # Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.
404
+ sig { returns(String) }
405
+ attr_accessor :aggregate_usage
406
+ # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
407
+ sig { returns(String) }
408
+ attr_accessor :interval
409
+ # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
410
+ sig { returns(Integer) }
411
+ attr_accessor :interval_count
412
+ # The meter tracking the usage of a metered price
413
+ sig { returns(String) }
414
+ attr_accessor :meter
415
+ # Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
416
+ sig { returns(Integer) }
417
+ attr_accessor :trial_period_days
418
+ # Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
419
+ sig { returns(String) }
420
+ attr_accessor :usage_type
421
+ sig {
422
+ params(aggregate_usage: String, interval: String, interval_count: Integer, meter: String, trial_period_days: Integer, usage_type: String).void
423
+ }
424
+ def initialize(
425
+ aggregate_usage: nil,
426
+ interval: nil,
427
+ interval_count: nil,
428
+ meter: nil,
429
+ trial_period_days: nil,
430
+ usage_type: nil
431
+ ); end
432
+ end
433
+ class Tier < Stripe::RequestParams
434
+ # The flat billing amount for an entire tier, regardless of the number of units in the tier.
435
+ sig { returns(Integer) }
436
+ attr_accessor :flat_amount
437
+ # Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
438
+ sig { returns(String) }
439
+ attr_accessor :flat_amount_decimal
440
+ # The per unit billing amount for each individual unit for which this tier applies.
441
+ sig { returns(Integer) }
442
+ attr_accessor :unit_amount
443
+ # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
444
+ sig { returns(String) }
445
+ attr_accessor :unit_amount_decimal
446
+ # Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
447
+ sig { returns(T.any(String, Integer)) }
448
+ attr_accessor :up_to
449
+ sig {
450
+ params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
451
+ }
452
+ def initialize(
453
+ flat_amount: nil,
454
+ flat_amount_decimal: nil,
455
+ unit_amount: nil,
456
+ unit_amount_decimal: nil,
457
+ up_to: nil
458
+ ); end
459
+ end
460
+ class TransformQuantity < Stripe::RequestParams
461
+ # Divide usage by this number.
462
+ sig { returns(Integer) }
463
+ attr_accessor :divide_by
464
+ # After division, either round the result `up` or `down`.
465
+ sig { returns(String) }
466
+ attr_accessor :round
467
+ sig { params(divide_by: Integer, round: String).void }
468
+ def initialize(divide_by: nil, round: nil); end
469
+ end
470
+ # Whether the price can be used for new purchases. Defaults to `true`.
471
+ sig { returns(T::Boolean) }
472
+ attr_accessor :active
473
+ # Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
474
+ sig { returns(String) }
475
+ attr_accessor :billing_scheme
476
+ # 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).
477
+ sig { returns(String) }
478
+ attr_accessor :currency
479
+ # Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
480
+ sig { returns(T::Hash[String, ::Stripe::Price::CreateParams::CurrencyOptions]) }
481
+ attr_accessor :currency_options
482
+ # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
483
+ sig { returns(::Stripe::Price::CreateParams::CustomUnitAmount) }
484
+ attr_accessor :custom_unit_amount
485
+ # Specifies which fields in the response should be expanded.
486
+ sig { returns(T::Array[String]) }
487
+ attr_accessor :expand
488
+ # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
489
+ sig { returns(String) }
490
+ attr_accessor :lookup_key
491
+ # 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`.
492
+ sig { returns(T::Hash[String, String]) }
493
+ attr_accessor :metadata
494
+ # A brief description of the price, hidden from customers.
495
+ sig { returns(String) }
496
+ attr_accessor :nickname
497
+ # The ID of the product that this price will belong to.
498
+ sig { returns(String) }
499
+ attr_accessor :product
500
+ # These fields can be used to create a new product that this price will belong to.
501
+ sig { returns(::Stripe::Price::CreateParams::ProductData) }
502
+ attr_accessor :product_data
503
+ # The recurring components of a price such as `interval` and `usage_type`.
504
+ sig { returns(::Stripe::Price::CreateParams::Recurring) }
505
+ attr_accessor :recurring
506
+ # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
507
+ sig { returns(String) }
508
+ attr_accessor :tax_behavior
509
+ # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
510
+ sig { returns(T::Array[::Stripe::Price::CreateParams::Tier]) }
511
+ attr_accessor :tiers
512
+ # Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.
513
+ sig { returns(String) }
514
+ attr_accessor :tiers_mode
515
+ # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
516
+ sig { returns(T::Boolean) }
517
+ attr_accessor :transfer_lookup_key
518
+ # Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
519
+ sig { returns(::Stripe::Price::CreateParams::TransformQuantity) }
520
+ attr_accessor :transform_quantity
521
+ # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.
522
+ sig { returns(Integer) }
523
+ attr_accessor :unit_amount
524
+ # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
525
+ sig { returns(String) }
526
+ attr_accessor :unit_amount_decimal
527
+ sig {
528
+ params(active: T::Boolean, billing_scheme: String, currency: String, currency_options: T::Hash[String, ::Stripe::Price::CreateParams::CurrencyOptions], custom_unit_amount: ::Stripe::Price::CreateParams::CustomUnitAmount, expand: T::Array[String], lookup_key: String, metadata: T::Hash[String, String], nickname: String, product: String, product_data: ::Stripe::Price::CreateParams::ProductData, recurring: ::Stripe::Price::CreateParams::Recurring, tax_behavior: String, tiers: T::Array[::Stripe::Price::CreateParams::Tier], tiers_mode: String, transfer_lookup_key: T::Boolean, transform_quantity: ::Stripe::Price::CreateParams::TransformQuantity, unit_amount: Integer, unit_amount_decimal: String).void
529
+ }
530
+ def initialize(
531
+ active: nil,
532
+ billing_scheme: nil,
533
+ currency: nil,
534
+ currency_options: nil,
535
+ custom_unit_amount: nil,
536
+ expand: nil,
537
+ lookup_key: nil,
538
+ metadata: nil,
539
+ nickname: nil,
540
+ product: nil,
541
+ product_data: nil,
542
+ recurring: nil,
543
+ tax_behavior: nil,
544
+ tiers: nil,
545
+ tiers_mode: nil,
546
+ transfer_lookup_key: nil,
547
+ transform_quantity: nil,
548
+ unit_amount: nil,
549
+ unit_amount_decimal: nil
550
+ ); end
551
+ end
552
+ class RetrieveParams < Stripe::RequestParams
553
+ # Specifies which fields in the response should be expanded.
554
+ sig { returns(T::Array[String]) }
555
+ attr_accessor :expand
556
+ sig { params(expand: T::Array[String]).void }
557
+ def initialize(expand: nil); end
558
+ end
559
+ class UpdateParams < Stripe::RequestParams
560
+ class CurrencyOptions < Stripe::RequestParams
561
+ class CustomUnitAmount < Stripe::RequestParams
562
+ # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
563
+ sig { returns(T::Boolean) }
564
+ attr_accessor :enabled
565
+ # The maximum unit amount the customer can specify for this item.
566
+ sig { returns(Integer) }
567
+ attr_accessor :maximum
568
+ # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
569
+ sig { returns(Integer) }
570
+ attr_accessor :minimum
571
+ # The starting unit amount which can be updated by the customer.
572
+ sig { returns(Integer) }
573
+ attr_accessor :preset
574
+ sig {
575
+ params(enabled: T::Boolean, maximum: Integer, minimum: Integer, preset: Integer).void
576
+ }
577
+ def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
578
+ end
579
+ class Tier < Stripe::RequestParams
580
+ # The flat billing amount for an entire tier, regardless of the number of units in the tier.
581
+ sig { returns(Integer) }
582
+ attr_accessor :flat_amount
583
+ # Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
584
+ sig { returns(String) }
585
+ attr_accessor :flat_amount_decimal
586
+ # The per unit billing amount for each individual unit for which this tier applies.
587
+ sig { returns(Integer) }
588
+ attr_accessor :unit_amount
589
+ # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
590
+ sig { returns(String) }
591
+ attr_accessor :unit_amount_decimal
592
+ # Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
593
+ sig { returns(T.any(String, Integer)) }
594
+ attr_accessor :up_to
595
+ sig {
596
+ params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
597
+ }
598
+ def initialize(
599
+ flat_amount: nil,
600
+ flat_amount_decimal: nil,
601
+ unit_amount: nil,
602
+ unit_amount_decimal: nil,
603
+ up_to: nil
604
+ ); end
605
+ end
606
+ # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
607
+ sig { returns(::Stripe::Price::UpdateParams::CurrencyOptions::CustomUnitAmount) }
608
+ attr_accessor :custom_unit_amount
609
+ # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
610
+ sig { returns(String) }
611
+ attr_accessor :tax_behavior
612
+ # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
613
+ sig { returns(T::Array[::Stripe::Price::UpdateParams::CurrencyOptions::Tier]) }
614
+ attr_accessor :tiers
615
+ # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
616
+ sig { returns(Integer) }
617
+ attr_accessor :unit_amount
618
+ # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
619
+ sig { returns(String) }
620
+ attr_accessor :unit_amount_decimal
621
+ sig {
622
+ params(custom_unit_amount: ::Stripe::Price::UpdateParams::CurrencyOptions::CustomUnitAmount, tax_behavior: String, tiers: T::Array[::Stripe::Price::UpdateParams::CurrencyOptions::Tier], unit_amount: Integer, unit_amount_decimal: String).void
623
+ }
624
+ def initialize(
625
+ custom_unit_amount: nil,
626
+ tax_behavior: nil,
627
+ tiers: nil,
628
+ unit_amount: nil,
629
+ unit_amount_decimal: nil
630
+ ); end
631
+ end
632
+ class MigrateTo < Stripe::RequestParams
633
+ # The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
634
+ sig { returns(String) }
635
+ attr_accessor :behavior
636
+ # The time after which subscriptions should start using the new price.
637
+ sig { returns(Integer) }
638
+ attr_accessor :effective_after
639
+ # The ID of the price object.
640
+ sig { returns(String) }
641
+ attr_accessor :price
642
+ sig { params(behavior: String, effective_after: Integer, price: String).void }
643
+ def initialize(behavior: nil, effective_after: nil, price: nil); end
644
+ end
645
+ # Whether the price can be used for new purchases. Defaults to `true`.
646
+ sig { returns(T::Boolean) }
647
+ attr_accessor :active
648
+ # Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
649
+ sig { returns(T.nilable(T::Hash[String, ::Stripe::Price::UpdateParams::CurrencyOptions])) }
650
+ attr_accessor :currency_options
651
+ # Specifies which fields in the response should be expanded.
652
+ sig { returns(T::Array[String]) }
653
+ attr_accessor :expand
654
+ # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
655
+ sig { returns(String) }
656
+ attr_accessor :lookup_key
657
+ # 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`.
658
+ sig { returns(T.nilable(T::Hash[String, String])) }
659
+ attr_accessor :metadata
660
+ # If specified, subscriptions using this price will be updated to use the new referenced price.
661
+ sig { returns(T.nilable(::Stripe::Price::UpdateParams::MigrateTo)) }
662
+ attr_accessor :migrate_to
663
+ # A brief description of the price, hidden from customers.
664
+ sig { returns(String) }
665
+ attr_accessor :nickname
666
+ # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
667
+ sig { returns(String) }
668
+ attr_accessor :tax_behavior
669
+ # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
670
+ sig { returns(T::Boolean) }
671
+ attr_accessor :transfer_lookup_key
672
+ sig {
673
+ params(active: T::Boolean, currency_options: T.nilable(T::Hash[String, ::Stripe::Price::UpdateParams::CurrencyOptions]), expand: T::Array[String], lookup_key: String, metadata: T.nilable(T::Hash[String, String]), migrate_to: T.nilable(::Stripe::Price::UpdateParams::MigrateTo), nickname: String, tax_behavior: String, transfer_lookup_key: T::Boolean).void
674
+ }
675
+ def initialize(
676
+ active: nil,
677
+ currency_options: nil,
678
+ expand: nil,
679
+ lookup_key: nil,
680
+ metadata: nil,
681
+ migrate_to: nil,
682
+ nickname: nil,
683
+ tax_behavior: nil,
684
+ transfer_lookup_key: nil
685
+ ); end
686
+ end
687
+ class SearchParams < Stripe::RequestParams
688
+ # Specifies which fields in the response should be expanded.
689
+ sig { returns(T::Array[String]) }
690
+ attr_accessor :expand
691
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
692
+ sig { returns(Integer) }
693
+ attr_accessor :limit
694
+ # 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.
695
+ sig { returns(String) }
696
+ attr_accessor :page
697
+ # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices).
698
+ sig { returns(String) }
699
+ attr_accessor :query
700
+ sig { params(expand: T::Array[String], limit: Integer, page: String, query: String).void }
701
+ def initialize(expand: nil, limit: nil, page: nil, query: nil); end
702
+ end
703
+ # Creates a new price for an existing product. The price can be recurring or one-time.
704
+ sig {
705
+ params(params: T.any(::Stripe::Price::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
706
+ }
707
+ def self.create(params = {}, opts = {}); end
708
+
709
+ # Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
710
+ sig {
711
+ params(params: T.any(::Stripe::Price::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
712
+ }
713
+ def self.list(params = {}, opts = {}); end
714
+
715
+ sig {
716
+ params(params: T.any(::Stripe::Price::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
717
+ }
718
+ def self.search(params = {}, opts = {}); end
719
+
720
+ sig {
721
+ params(params: T.any(::Stripe::Price::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
722
+ }
723
+ def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
724
+
725
+ # Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
726
+ sig {
727
+ params(id: String, params: T.any(::Stripe::Price::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
728
+ }
729
+ def self.update(id, params = {}, opts = {}); end
730
+ end
731
+ end