stripe 13.5.0 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (641) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +33 -3
  3. data/Gemfile +4 -0
  4. data/OPENAPI_VERSION +1 -1
  5. data/README.md +29 -0
  6. data/VERSION +1 -1
  7. data/lib/stripe/api_operations/request.rb +1 -0
  8. data/lib/stripe/api_requestor.rb +3 -0
  9. data/lib/stripe/api_version.rb +1 -1
  10. data/lib/stripe/errors.rb +0 -7
  11. data/lib/stripe/object_types.rb +8 -2
  12. data/lib/stripe/request_params.rb +24 -0
  13. data/lib/stripe/resources/account.rb +4634 -0
  14. data/lib/stripe/resources/account_link.rb +54 -0
  15. data/lib/stripe/resources/account_session.rb +739 -0
  16. data/lib/stripe/resources/apple_pay_domain.rb +54 -0
  17. data/lib/stripe/resources/application.rb +20 -0
  18. data/lib/stripe/resources/application_fee.rb +87 -0
  19. data/lib/stripe/resources/application_fee_refund.rb +17 -0
  20. data/lib/stripe/resources/apps/secret.rb +141 -0
  21. data/lib/stripe/resources/balance.rb +122 -0
  22. data/lib/stripe/resources/balance_transaction.rb +103 -0
  23. data/lib/stripe/resources/bank_account.rb +84 -2
  24. data/lib/stripe/resources/billing/alert.rb +135 -0
  25. data/lib/stripe/resources/billing/alert_triggered.rb +26 -0
  26. data/lib/stripe/resources/billing/credit_balance_summary.rb +40 -0
  27. data/lib/stripe/resources/billing/credit_balance_transaction.rb +107 -0
  28. data/lib/stripe/resources/billing/credit_grant.rb +217 -0
  29. data/lib/stripe/resources/billing/meter.rb +169 -0
  30. data/lib/stripe/resources/billing/meter_event.rb +35 -0
  31. data/lib/stripe/resources/billing/meter_event_adjustment.rb +43 -0
  32. data/lib/stripe/resources/billing/meter_event_summary.rb +15 -0
  33. data/lib/stripe/resources/billing_portal/configuration.rb +553 -0
  34. data/lib/stripe/resources/billing_portal/session.rb +271 -0
  35. data/lib/stripe/resources/capability.rb +84 -0
  36. data/lib/stripe/resources/card.rb +77 -0
  37. data/lib/stripe/resources/cash_balance.rb +17 -0
  38. data/lib/stripe/resources/charge.rb +1612 -0
  39. data/lib/stripe/resources/checkout/session.rb +3530 -6
  40. data/lib/stripe/resources/climate/order.rb +167 -0
  41. data/lib/stripe/resources/climate/product.rb +47 -0
  42. data/lib/stripe/resources/climate/supplier.rb +45 -0
  43. data/lib/stripe/resources/confirmation_token.rb +1448 -0
  44. data/lib/stripe/resources/connect_collection_transfer.rb +24 -0
  45. data/lib/stripe/resources/country_spec.rb +54 -0
  46. data/lib/stripe/resources/coupon.rb +189 -0
  47. data/lib/stripe/resources/credit_note.rb +639 -0
  48. data/lib/stripe/resources/credit_note_line_item.rb +67 -0
  49. data/lib/stripe/resources/customer.rb +824 -0
  50. data/lib/stripe/resources/customer_balance_transaction.rb +29 -0
  51. data/lib/stripe/resources/customer_cash_balance_transaction.rb +109 -0
  52. data/lib/stripe/resources/customer_session.rb +159 -0
  53. data/lib/stripe/resources/discount.rb +29 -0
  54. data/lib/stripe/resources/dispute.rb +610 -0
  55. data/lib/stripe/resources/entitlements/active_entitlement.rb +37 -0
  56. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +23 -0
  57. data/lib/stripe/resources/entitlements/feature.rb +81 -0
  58. data/lib/stripe/resources/ephemeral_key.rb +21 -0
  59. data/lib/stripe/resources/event.rb +90 -0
  60. data/lib/stripe/resources/exchange_rate.rb +24 -0
  61. data/lib/stripe/resources/file.rb +102 -0
  62. data/lib/stripe/resources/file_link.rb +103 -0
  63. data/lib/stripe/resources/financial_connections/account.rb +237 -0
  64. data/lib/stripe/resources/financial_connections/account_owner.rb +17 -0
  65. data/lib/stripe/resources/financial_connections/account_ownership.rb +9 -0
  66. data/lib/stripe/resources/financial_connections/session.rb +95 -0
  67. data/lib/stripe/resources/financial_connections/transaction.rb +92 -0
  68. data/lib/stripe/resources/forwarding/request.rb +156 -0
  69. data/lib/stripe/resources/funding_instructions.rb +308 -0
  70. data/lib/stripe/resources/identity/verification_report.rb +257 -0
  71. data/lib/stripe/resources/identity/verification_session.rb +352 -0
  72. data/lib/stripe/resources/invoice.rb +3204 -21
  73. data/lib/stripe/resources/invoice_item.rb +400 -0
  74. data/lib/stripe/resources/invoice_line_item.rb +350 -0
  75. data/lib/stripe/resources/invoice_payment.rb +105 -0
  76. data/lib/stripe/resources/invoice_rendering_template.rb +55 -0
  77. data/lib/stripe/resources/issuing/authorization.rb +1104 -0
  78. data/lib/stripe/resources/issuing/card.rb +657 -0
  79. data/lib/stripe/resources/issuing/cardholder.rb +648 -0
  80. data/lib/stripe/resources/issuing/dispute.rb +781 -0
  81. data/lib/stripe/resources/issuing/personalization_design.rb +276 -0
  82. data/lib/stripe/resources/issuing/physical_bundle.rb +54 -0
  83. data/lib/stripe/resources/issuing/token.rb +166 -0
  84. data/lib/stripe/resources/issuing/transaction.rb +912 -0
  85. data/lib/stripe/resources/line_item.rb +47 -0
  86. data/lib/stripe/resources/login_link.rb +7 -0
  87. data/lib/stripe/resources/mandate.rb +142 -0
  88. data/lib/stripe/resources/payment_intent.rb +8650 -0
  89. data/lib/stripe/resources/payment_link.rb +1632 -0
  90. data/lib/stripe/resources/payment_method.rb +1542 -0
  91. data/lib/stripe/resources/payment_method_configuration.rb +2776 -0
  92. data/lib/stripe/resources/payment_method_domain.rb +150 -6
  93. data/lib/stripe/resources/payout.rb +209 -0
  94. data/lib/stripe/resources/person.rb +264 -1
  95. data/lib/stripe/resources/plan.rb +302 -0
  96. data/lib/stripe/resources/price.rb +605 -1
  97. data/lib/stripe/resources/product.rb +472 -0
  98. data/lib/stripe/resources/product_feature.rb +12 -0
  99. data/lib/stripe/resources/promotion_code.rb +212 -0
  100. data/lib/stripe/resources/quote.rb +917 -0
  101. data/lib/stripe/resources/radar/early_fraud_warning.rb +68 -0
  102. data/lib/stripe/resources/radar/value_list.rb +116 -0
  103. data/lib/stripe/resources/radar/value_list_item.rb +86 -0
  104. data/lib/stripe/resources/refund.rb +392 -0
  105. data/lib/stripe/resources/reporting/report_run.rb +141 -0
  106. data/lib/stripe/resources/reporting/report_type.rb +27 -0
  107. data/lib/stripe/resources/reserve_transaction.rb +22 -0
  108. data/lib/stripe/resources/reversal.rb +21 -0
  109. data/lib/stripe/resources/review.rb +99 -0
  110. data/lib/stripe/resources/setup_attempt.rb +368 -0
  111. data/lib/stripe/resources/setup_intent.rb +3473 -0
  112. data/lib/stripe/resources/shipping_rate.rb +250 -0
  113. data/lib/stripe/resources/sigma/scheduled_query_run.rb +45 -0
  114. data/lib/stripe/resources/source.rb +1198 -0
  115. data/lib/stripe/resources/source_mandate_notification.rb +66 -0
  116. data/lib/stripe/resources/source_transaction.rb +85 -0
  117. data/lib/stripe/resources/subscription.rb +1686 -0
  118. data/lib/stripe/resources/subscription_item.rb +313 -5
  119. data/lib/stripe/resources/subscription_schedule.rb +1281 -0
  120. data/lib/stripe/resources/tax/calculation.rb +378 -0
  121. data/lib/stripe/resources/tax/calculation_line_item.rb +56 -0
  122. data/lib/stripe/resources/tax/registration.rb +2373 -0
  123. data/lib/stripe/resources/tax/settings.rb +117 -0
  124. data/lib/stripe/resources/tax/transaction.rb +258 -0
  125. data/lib/stripe/resources/tax/transaction_line_item.rb +31 -0
  126. data/lib/stripe/resources/tax_code.rb +26 -0
  127. data/lib/stripe/resources/tax_deducted_at_source.rb +22 -0
  128. data/lib/stripe/resources/tax_id.rb +112 -0
  129. data/lib/stripe/resources/tax_rate.rb +191 -0
  130. data/lib/stripe/resources/terminal/configuration.rb +1260 -0
  131. data/lib/stripe/resources/terminal/connection_token.rb +18 -0
  132. data/lib/stripe/resources/terminal/location.rb +166 -0
  133. data/lib/stripe/resources/terminal/reader.rb +427 -0
  134. data/lib/stripe/resources/test_helpers/test_clock.rb +77 -0
  135. data/lib/stripe/resources/token.rb +1159 -0
  136. data/lib/stripe/resources/topup.rb +165 -0
  137. data/lib/stripe/resources/transfer.rb +144 -0
  138. data/lib/stripe/resources/treasury/credit_reversal.rb +83 -0
  139. data/lib/stripe/resources/treasury/debit_reversal.rb +94 -0
  140. data/lib/stripe/resources/treasury/financial_account.rb +725 -1
  141. data/lib/stripe/resources/treasury/financial_account_features.rb +189 -0
  142. data/lib/stripe/resources/treasury/inbound_transfer.rb +226 -0
  143. data/lib/stripe/resources/treasury/outbound_payment.rb +486 -0
  144. data/lib/stripe/resources/treasury/outbound_transfer.rb +341 -0
  145. data/lib/stripe/resources/treasury/received_credit.rb +237 -0
  146. data/lib/stripe/resources/treasury/received_debit.rb +196 -0
  147. data/lib/stripe/resources/treasury/transaction.rb +167 -0
  148. data/lib/stripe/resources/treasury/transaction_entry.rb +148 -0
  149. data/lib/stripe/resources/v2/amount.rb +9 -0
  150. data/lib/stripe/resources/v2/billing/meter_event.rb +18 -0
  151. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +21 -0
  152. data/lib/stripe/resources/v2/billing/meter_event_session.rb +14 -0
  153. data/lib/stripe/resources/v2/event.rb +28 -0
  154. data/lib/stripe/resources/v2/event_destination.rb +60 -0
  155. data/lib/stripe/resources/webhook_endpoint.rb +113 -0
  156. data/lib/stripe/resources.rb +8 -2
  157. data/lib/stripe/services/account_capability_service.rb +32 -0
  158. data/lib/stripe/services/account_external_account_service.rb +250 -0
  159. data/lib/stripe/services/account_link_service.rb +46 -0
  160. data/lib/stripe/services/account_login_link_service.rb +9 -0
  161. data/lib/stripe/services/account_person_service.rb +875 -0
  162. data/lib/stripe/services/account_service.rb +4000 -0
  163. data/lib/stripe/services/account_session_service.rb +484 -0
  164. data/lib/stripe/services/apple_pay_domain_service.rb +51 -0
  165. data/lib/stripe/services/application_fee_refund_service.rb +54 -0
  166. data/lib/stripe/services/application_fee_service.rb +57 -0
  167. data/lib/stripe/services/apps/secret_service.rb +116 -0
  168. data/lib/stripe/services/balance_service.rb +9 -0
  169. data/lib/stripe/services/balance_transaction_service.rb +69 -0
  170. data/lib/stripe/services/billing/alert_service.rb +113 -0
  171. data/lib/stripe/services/billing/credit_balance_summary_service.rb +48 -0
  172. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +40 -0
  173. data/lib/stripe/services/billing/credit_grant_service.rb +166 -0
  174. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +26 -0
  175. data/lib/stripe/services/billing/meter_event_service.rb +21 -0
  176. data/lib/stripe/services/billing/meter_event_summary_service.rb +39 -0
  177. data/lib/stripe/services/billing/meter_service.rb +130 -0
  178. data/lib/stripe/services/billing_portal/configuration_service.rb +444 -0
  179. data/lib/stripe/services/billing_portal/session_service.rb +173 -0
  180. data/lib/stripe/services/charge_service.rb +402 -0
  181. data/lib/stripe/services/checkout/session_line_item_service.rb +18 -0
  182. data/lib/stripe/services/checkout/session_service.rb +2399 -5
  183. data/lib/stripe/services/climate/order_service.rb +102 -0
  184. data/lib/stripe/services/climate/product_service.rb +27 -0
  185. data/lib/stripe/services/climate/supplier_service.rb +27 -0
  186. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  187. data/lib/stripe/services/country_spec_service.rb +27 -0
  188. data/lib/stripe/services/coupon_service.rb +152 -0
  189. data/lib/stripe/services/credit_note_line_item_service.rb +18 -0
  190. data/lib/stripe/services/credit_note_preview_lines_service.rb +152 -0
  191. data/lib/stripe/services/credit_note_service.rb +365 -0
  192. data/lib/stripe/services/customer_balance_transaction_service.rb +63 -0
  193. data/lib/stripe/services/customer_cash_balance_service.rb +29 -0
  194. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +27 -0
  195. data/lib/stripe/services/customer_funding_instructions_service.rb +42 -0
  196. data/lib/stripe/services/customer_payment_method_service.rb +40 -0
  197. data/lib/stripe/services/customer_payment_source_service.rb +179 -0
  198. data/lib/stripe/services/customer_service.rb +577 -0
  199. data/lib/stripe/services/customer_session_service.rb +96 -0
  200. data/lib/stripe/services/customer_tax_id_service.rb +45 -0
  201. data/lib/stripe/services/dispute_service.rb +374 -0
  202. data/lib/stripe/services/entitlements/active_entitlement_service.rb +36 -0
  203. data/lib/stripe/services/entitlements/feature_service.rb +76 -0
  204. data/lib/stripe/services/ephemeral_key_service.rb +36 -0
  205. data/lib/stripe/services/event_service.rb +65 -0
  206. data/lib/stripe/services/exchange_rate_service.rb +27 -0
  207. data/lib/stripe/services/file_link_service.rb +94 -0
  208. data/lib/stripe/services/file_service.rb +89 -0
  209. data/lib/stripe/services/financial_connections/account_owner_service.rb +27 -0
  210. data/lib/stripe/services/financial_connections/account_service.rb +96 -0
  211. data/lib/stripe/services/financial_connections/session_service.rb +68 -0
  212. data/lib/stripe/services/financial_connections/transaction_service.rb +70 -0
  213. data/lib/stripe/services/forwarding/request_service.rb +106 -0
  214. data/lib/stripe/services/identity/verification_report_service.rb +65 -0
  215. data/lib/stripe/services/identity/verification_session_service.rb +231 -0
  216. data/lib/stripe/services/invoice_item_service.rb +334 -0
  217. data/lib/stripe/services/invoice_line_item_service.rb +221 -0
  218. data/lib/stripe/services/invoice_payment_service.rb +83 -0
  219. data/lib/stripe/services/invoice_rendering_template_service.rb +51 -0
  220. data/lib/stripe/services/invoice_service.rb +2648 -19
  221. data/lib/stripe/services/issuing/authorization_service.rb +104 -0
  222. data/lib/stripe/services/issuing/card_service.rb +455 -0
  223. data/lib/stripe/services/issuing/cardholder_service.rb +525 -0
  224. data/lib/stripe/services/issuing/dispute_service.rb +633 -0
  225. data/lib/stripe/services/issuing/personalization_design_service.rb +193 -0
  226. data/lib/stripe/services/issuing/physical_bundle_service.rb +40 -0
  227. data/lib/stripe/services/issuing/token_service.rb +73 -0
  228. data/lib/stripe/services/issuing/transaction_service.rb +77 -0
  229. data/lib/stripe/services/mandate_service.rb +9 -0
  230. data/lib/stripe/services/payment_intent_service.rb +7054 -0
  231. data/lib/stripe/services/payment_link_line_item_service.rb +18 -0
  232. data/lib/stripe/services/payment_link_service.rb +1276 -0
  233. data/lib/stripe/services/payment_method_configuration_service.rb +2004 -0
  234. data/lib/stripe/services/payment_method_domain_service.rb +79 -3
  235. data/lib/stripe/services/payment_method_service.rb +808 -0
  236. data/lib/stripe/services/payout_service.rb +159 -0
  237. data/lib/stripe/services/plan_service.rb +249 -0
  238. data/lib/stripe/services/price_service.rb +494 -1
  239. data/lib/stripe/services/product_feature_service.rb +42 -0
  240. data/lib/stripe/services/product_service.rb +425 -0
  241. data/lib/stripe/services/promotion_code_service.rb +178 -0
  242. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +18 -0
  243. data/lib/stripe/services/quote_line_item_service.rb +18 -0
  244. data/lib/stripe/services/quote_service.rb +611 -0
  245. data/lib/stripe/services/radar/early_fraud_warning_service.rb +61 -0
  246. data/lib/stripe/services/radar/value_list_item_service.rb +79 -0
  247. data/lib/stripe/services/radar/value_list_service.rb +103 -0
  248. data/lib/stripe/services/refund_service.rb +137 -0
  249. data/lib/stripe/services/reporting/report_run_service.rb +106 -0
  250. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  251. data/lib/stripe/services/review_service.rb +56 -0
  252. data/lib/stripe/services/setup_attempt_service.rb +51 -0
  253. data/lib/stripe/services/setup_intent_service.rb +3163 -0
  254. data/lib/stripe/services/shipping_rate_service.rb +200 -0
  255. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +27 -0
  256. data/lib/stripe/services/source_service.rb +601 -0
  257. data/lib/stripe/services/source_transaction_service.rb +18 -0
  258. data/lib/stripe/services/subscription_item_service.rb +282 -5
  259. data/lib/stripe/services/subscription_schedule_service.rb +1062 -0
  260. data/lib/stripe/services/subscription_service.rb +1412 -0
  261. data/lib/stripe/services/tax/calculation_line_item_service.rb +18 -0
  262. data/lib/stripe/services/tax/calculation_service.rb +205 -0
  263. data/lib/stripe/services/tax/registration_service.rb +1564 -0
  264. data/lib/stripe/services/tax/settings_service.rb +74 -0
  265. data/lib/stripe/services/tax/transaction_line_item_service.rb +18 -0
  266. data/lib/stripe/services/tax/transaction_service.rb +111 -0
  267. data/lib/stripe/services/tax_code_service.rb +27 -0
  268. data/lib/stripe/services/tax_id_service.rb +79 -0
  269. data/lib/stripe/services/tax_rate_service.rb +155 -0
  270. data/lib/stripe/services/terminal/configuration_service.rb +997 -0
  271. data/lib/stripe/services/terminal/connection_token_service.rb +12 -0
  272. data/lib/stripe/services/terminal/location_service.rb +144 -0
  273. data/lib/stripe/services/terminal/reader_service.rb +266 -0
  274. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +642 -0
  275. data/lib/stripe/services/test_helpers/customer_service.rb +18 -0
  276. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +745 -0
  277. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  278. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +41 -0
  279. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +632 -0
  280. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  281. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +44 -0
  282. data/lib/stripe/services/test_helpers/test_clock_service.rb +57 -0
  283. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +38 -0
  284. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +87 -0
  285. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +87 -0
  286. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +60 -0
  287. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +60 -0
  288. data/lib/stripe/services/token_service.rb +1140 -0
  289. data/lib/stripe/services/topup_service.rb +142 -0
  290. data/lib/stripe/services/transfer_reversal_service.rb +66 -0
  291. data/lib/stripe/services/transfer_service.rb +119 -0
  292. data/lib/stripe/services/treasury/credit_reversal_service.rb +59 -0
  293. data/lib/stripe/services/treasury/debit_reversal_service.rb +63 -0
  294. data/lib/stripe/services/treasury/financial_account_features_service.rb +166 -0
  295. data/lib/stripe/services/treasury/financial_account_service.rb +485 -1
  296. data/lib/stripe/services/treasury/inbound_transfer_service.rb +88 -0
  297. data/lib/stripe/services/treasury/outbound_payment_service.rb +258 -0
  298. data/lib/stripe/services/treasury/outbound_transfer_service.rb +124 -0
  299. data/lib/stripe/services/treasury/received_credit_service.rb +52 -0
  300. data/lib/stripe/services/treasury/received_debit_service.rb +40 -0
  301. data/lib/stripe/services/treasury/transaction_entry_service.rb +87 -0
  302. data/lib/stripe/services/treasury/transaction_service.rb +95 -0
  303. data/lib/stripe/services/v1_services.rb +2 -1
  304. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +23 -0
  305. data/lib/stripe/services/v2/billing/meter_event_service.rb +25 -0
  306. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  307. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +33 -0
  308. data/lib/stripe/services/v2/core/event_destination_service.rb +143 -0
  309. data/lib/stripe/services/v2/core/event_service.rb +15 -0
  310. data/lib/stripe/services/webhook_endpoint_service.rb +96 -0
  311. data/lib/stripe/services.rb +1 -3
  312. data/lib/stripe/stripe_client.rb +2 -1
  313. data/lib/stripe/stripe_object.rb +5 -0
  314. data/lib/stripe/version.rb +1 -1
  315. data/lib/stripe.rb +1 -0
  316. data/rbi/stripe/resources/account.rbi +4840 -0
  317. data/rbi/stripe/resources/account_link.rbi +74 -0
  318. data/rbi/stripe/resources/account_session.rbi +894 -0
  319. data/rbi/stripe/resources/apple_pay_domain.rbi +90 -0
  320. data/rbi/stripe/resources/application.rbi +20 -0
  321. data/rbi/stripe/resources/application_fee.rbi +118 -0
  322. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  323. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  324. data/rbi/stripe/resources/balance.rbi +180 -0
  325. data/rbi/stripe/resources/balance_transaction.rbi +144 -0
  326. data/rbi/stripe/resources/bank_account.rbi +127 -0
  327. data/rbi/stripe/resources/billing/alert.rbi +201 -0
  328. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  329. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
  330. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
  331. data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
  332. data/rbi/stripe/resources/billing/meter.rbi +226 -0
  333. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  334. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  335. data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
  336. data/rbi/stripe/resources/billing_portal/configuration.rbi +645 -0
  337. data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
  338. data/rbi/stripe/resources/capability.rbi +125 -0
  339. data/rbi/stripe/resources/card.rbi +125 -0
  340. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  341. data/rbi/stripe/resources/charge.rbi +2054 -0
  342. data/rbi/stripe/resources/checkout/session.rbi +3951 -0
  343. data/rbi/stripe/resources/climate/order.rbi +245 -0
  344. data/rbi/stripe/resources/climate/product.rbi +75 -0
  345. data/rbi/stripe/resources/climate/supplier.rbi +72 -0
  346. data/rbi/stripe/resources/confirmation_token.rbi +1793 -0
  347. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  348. data/rbi/stripe/resources/country_spec.rbi +85 -0
  349. data/rbi/stripe/resources/coupon.rbi +252 -0
  350. data/rbi/stripe/resources/credit_note.rbi +747 -0
  351. data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
  352. data/rbi/stripe/resources/customer.rbi +1009 -0
  353. data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
  354. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  355. data/rbi/stripe/resources/customer_session.rbi +200 -0
  356. data/rbi/stripe/resources/discount.rbi +53 -0
  357. data/rbi/stripe/resources/dispute.rbi +761 -0
  358. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
  359. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  360. data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
  361. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  362. data/rbi/stripe/resources/event.rbi +146 -0
  363. data/rbi/stripe/resources/exchange_rate.rbi +66 -0
  364. data/rbi/stripe/resources/file.rbi +143 -0
  365. data/rbi/stripe/resources/file_link.rbi +141 -0
  366. data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
  367. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  368. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  369. data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
  370. data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
  371. data/rbi/stripe/resources/forwarding/request.rbi +216 -0
  372. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  373. data/rbi/stripe/resources/identity/verification_report.rbi +351 -0
  374. data/rbi/stripe/resources/identity/verification_session.rbi +517 -0
  375. data/rbi/stripe/resources/invoice.rbi +3733 -0
  376. data/rbi/stripe/resources/invoice_item.rbi +475 -0
  377. data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
  378. data/rbi/stripe/resources/invoice_payment.rbi +114 -0
  379. data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
  380. data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
  381. data/rbi/stripe/resources/issuing/card.rbi +741 -0
  382. data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
  383. data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
  384. data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
  385. data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
  386. data/rbi/stripe/resources/issuing/token.rbi +226 -0
  387. data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
  388. data/rbi/stripe/resources/line_item.rbi +72 -0
  389. data/rbi/stripe/resources/login_link.rbi +18 -0
  390. data/rbi/stripe/resources/mandate.rbi +187 -0
  391. data/rbi/stripe/resources/payment_intent.rbi +9731 -0
  392. data/rbi/stripe/resources/payment_link.rbi +1801 -0
  393. data/rbi/stripe/resources/payment_method.rbi +1822 -0
  394. data/rbi/stripe/resources/payment_method_configuration.rbi +3154 -0
  395. data/rbi/stripe/resources/payment_method_domain.rbi +212 -0
  396. data/rbi/stripe/resources/payout.rbi +300 -0
  397. data/rbi/stripe/resources/person.rbi +371 -0
  398. data/rbi/stripe/resources/plan.rbi +373 -0
  399. data/rbi/stripe/resources/price.rbi +694 -0
  400. data/rbi/stripe/resources/product.rbi +557 -0
  401. data/rbi/stripe/resources/product_feature.rbi +26 -0
  402. data/rbi/stripe/resources/promotion_code.rbi +261 -0
  403. data/rbi/stripe/resources/quote.rbi +1123 -0
  404. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
  405. data/rbi/stripe/resources/radar/value_list.rbi +170 -0
  406. data/rbi/stripe/resources/radar/value_list_item.rbi +131 -0
  407. data/rbi/stripe/resources/refund.rbi +516 -0
  408. data/rbi/stripe/resources/reporting/report_run.rbi +191 -0
  409. data/rbi/stripe/resources/reporting/report_type.rbi +57 -0
  410. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  411. data/rbi/stripe/resources/reversal.rbi +51 -0
  412. data/rbi/stripe/resources/review.rbi +154 -0
  413. data/rbi/stripe/resources/setup_attempt.rbi +477 -0
  414. data/rbi/stripe/resources/setup_intent.rbi +3860 -0
  415. data/rbi/stripe/resources/shipping_rate.rbi +305 -0
  416. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +75 -0
  417. data/rbi/stripe/resources/source.rbi +1496 -0
  418. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  419. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  420. data/rbi/stripe/resources/subscription.rbi +1964 -0
  421. data/rbi/stripe/resources/subscription_item.rbi +370 -0
  422. data/rbi/stripe/resources/subscription_schedule.rbi +1495 -0
  423. data/rbi/stripe/resources/tax/calculation.rbi +474 -0
  424. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  425. data/rbi/stripe/resources/tax/registration.rbi +2485 -0
  426. data/rbi/stripe/resources/tax/settings.rbi +141 -0
  427. data/rbi/stripe/resources/tax/transaction.rbi +351 -0
  428. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  429. data/rbi/stripe/resources/tax_code.rbi +44 -0
  430. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  431. data/rbi/stripe/resources/tax_id.rbi +167 -0
  432. data/rbi/stripe/resources/tax_rate.rbi +239 -0
  433. data/rbi/stripe/resources/terminal/configuration.rbi +1388 -0
  434. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  435. data/rbi/stripe/resources/terminal/location.rbi +224 -0
  436. data/rbi/stripe/resources/terminal/reader.rbi +587 -0
  437. data/rbi/stripe/resources/test_helpers/test_clock.rbi +134 -0
  438. data/rbi/stripe/resources/token.rbi +1217 -0
  439. data/rbi/stripe/resources/topup.rbi +222 -0
  440. data/rbi/stripe/resources/transfer.rbi +199 -0
  441. data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
  442. data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
  443. data/rbi/stripe/resources/treasury/financial_account.rbi +865 -0
  444. data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
  445. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
  446. data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
  447. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
  448. data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
  449. data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
  450. data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
  451. data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
  452. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  453. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  454. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  455. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  456. data/rbi/stripe/resources/v2/event.rbi +48 -0
  457. data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
  458. data/rbi/stripe/resources/webhook_endpoint.rbi +170 -0
  459. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  460. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  461. data/rbi/stripe/services/account_link_service.rbi +58 -0
  462. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  463. data/rbi/stripe/services/account_person_service.rbi +923 -0
  464. data/rbi/stripe/services/account_service.rbi +4143 -0
  465. data/rbi/stripe/services/account_session_service.rbi +572 -0
  466. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  467. data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
  468. data/rbi/stripe/services/application_fee_service.rbi +78 -0
  469. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  470. data/rbi/stripe/services/apps_service.rbi +9 -0
  471. data/rbi/stripe/services/balance_service.rbi +21 -0
  472. data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
  473. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  474. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
  475. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  476. data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
  477. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
  478. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  479. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  480. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  481. data/rbi/stripe/services/billing_portal/configuration_service.rbi +511 -0
  482. data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
  483. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  484. data/rbi/stripe/services/billing_service.rbi +15 -0
  485. data/rbi/stripe/services/charge_service.rbi +448 -0
  486. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  487. data/rbi/stripe/services/checkout/session_service.rbi +2585 -0
  488. data/rbi/stripe/services/checkout_service.rbi +9 -0
  489. data/rbi/stripe/services/climate/order_service.rbi +142 -0
  490. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  491. data/rbi/stripe/services/climate/supplier_service.rbi +46 -0
  492. data/rbi/stripe/services/climate_service.rbi +11 -0
  493. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  494. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  495. data/rbi/stripe/services/coupon_service.rbi +196 -0
  496. data/rbi/stripe/services/credit_note_line_item_service.rbi +31 -0
  497. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  498. data/rbi/stripe/services/credit_note_service.rbi +416 -0
  499. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  500. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  501. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  502. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  503. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  504. data/rbi/stripe/services/customer_payment_source_service.rbi +232 -0
  505. data/rbi/stripe/services/customer_service.rbi +651 -0
  506. data/rbi/stripe/services/customer_session_service.rbi +116 -0
  507. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  508. data/rbi/stripe/services/dispute_service.rbi +424 -0
  509. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  510. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  511. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  512. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  513. data/rbi/stripe/services/event_service.rbi +83 -0
  514. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  515. data/rbi/stripe/services/file_link_service.rbi +124 -0
  516. data/rbi/stripe/services/file_service.rbi +116 -0
  517. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  518. data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
  519. data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
  520. data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
  521. data/rbi/stripe/services/financial_connections_service.rbi +11 -0
  522. data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
  523. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  524. data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
  525. data/rbi/stripe/services/identity/verification_session_service.rbi +323 -0
  526. data/rbi/stripe/services/identity_service.rbi +10 -0
  527. data/rbi/stripe/services/invoice_item_service.rbi +368 -0
  528. data/rbi/stripe/services/invoice_line_item_service.rbi +259 -0
  529. data/rbi/stripe/services/invoice_payment_service.rbi +71 -0
  530. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  531. data/rbi/stripe/services/invoice_service.rbi +2920 -0
  532. data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
  533. data/rbi/stripe/services/issuing/card_service.rbi +495 -0
  534. data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
  535. data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
  536. data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
  537. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  538. data/rbi/stripe/services/issuing/token_service.rbi +99 -0
  539. data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
  540. data/rbi/stripe/services/issuing_service.rbi +16 -0
  541. data/rbi/stripe/services/mandate_service.rbi +20 -0
  542. data/rbi/stripe/services/payment_intent_service.rbi +7759 -0
  543. data/rbi/stripe/services/payment_link_line_item_service.rbi +31 -0
  544. data/rbi/stripe/services/payment_link_service.rbi +1352 -0
  545. data/rbi/stripe/services/payment_method_configuration_service.rbi +2211 -0
  546. data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
  547. data/rbi/stripe/services/payment_method_service.rbi +840 -0
  548. data/rbi/stripe/services/payout_service.rbi +205 -0
  549. data/rbi/stripe/services/plan_service.rbi +284 -0
  550. data/rbi/stripe/services/price_service.rbi +546 -0
  551. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  552. data/rbi/stripe/services/product_service.rbi +479 -0
  553. data/rbi/stripe/services/promotion_code_service.rbi +214 -0
  554. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  555. data/rbi/stripe/services/quote_line_item_service.rbi +31 -0
  556. data/rbi/stripe/services/quote_service.rbi +686 -0
  557. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
  558. data/rbi/stripe/services/radar/value_list_item_service.rbi +111 -0
  559. data/rbi/stripe/services/radar/value_list_service.rbi +143 -0
  560. data/rbi/stripe/services/radar_service.rbi +11 -0
  561. data/rbi/stripe/services/refund_service.rbi +185 -0
  562. data/rbi/stripe/services/reporting/report_run_service.rbi +135 -0
  563. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  564. data/rbi/stripe/services/reporting_service.rbi +10 -0
  565. data/rbi/stripe/services/review_service.rbi +84 -0
  566. data/rbi/stripe/services/setup_attempt_service.rbi +65 -0
  567. data/rbi/stripe/services/setup_intent_service.rbi +3596 -0
  568. data/rbi/stripe/services/shipping_rate_service.rbi +241 -0
  569. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  570. data/rbi/stripe/services/sigma_service.rbi +9 -0
  571. data/rbi/stripe/services/source_service.rbi +663 -0
  572. data/rbi/stripe/services/source_transaction_service.rbi +31 -0
  573. data/rbi/stripe/services/subscription_item_service.rbi +324 -0
  574. data/rbi/stripe/services/subscription_schedule_service.rbi +1192 -0
  575. data/rbi/stripe/services/subscription_service.rbi +1596 -0
  576. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  577. data/rbi/stripe/services/tax/calculation_service.rbi +230 -0
  578. data/rbi/stripe/services/tax/registration_service.rbi +1689 -0
  579. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  580. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +33 -0
  581. data/rbi/stripe/services/tax/transaction_service.rbi +146 -0
  582. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  583. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  584. data/rbi/stripe/services/tax_rate_service.rbi +185 -0
  585. data/rbi/stripe/services/tax_service.rbi +12 -0
  586. data/rbi/stripe/services/terminal/configuration_service.rbi +1120 -0
  587. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  588. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  589. data/rbi/stripe/services/terminal/reader_service.rbi +344 -0
  590. data/rbi/stripe/services/terminal_service.rbi +12 -0
  591. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +746 -0
  592. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  593. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +848 -0
  594. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  595. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +69 -0
  596. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +711 -0
  597. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  598. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  599. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  600. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  601. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +92 -0
  602. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  603. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
  604. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
  605. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
  606. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
  607. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  608. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  609. data/rbi/stripe/services/token_service.rbi +1189 -0
  610. data/rbi/stripe/services/topup_service.rbi +176 -0
  611. data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
  612. data/rbi/stripe/services/transfer_service.rbi +152 -0
  613. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  614. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  615. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
  616. data/rbi/stripe/services/treasury/financial_account_service.rbi +562 -0
  617. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  618. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
  619. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
  620. data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
  621. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  622. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
  623. data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
  624. data/rbi/stripe/services/treasury_service.rbi +18 -0
  625. data/rbi/stripe/services/v1_services.rbi +77 -0
  626. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  627. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  628. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  629. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  630. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  631. data/rbi/stripe/services/v2/core/event_destination_service.rbi +200 -0
  632. data/rbi/stripe/services/v2/core/event_service.rbi +36 -0
  633. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  634. data/rbi/stripe/services/v2_services.rbi +10 -0
  635. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  636. metadata +333 -7
  637. data/lib/stripe/resources/usage_record.rb +0 -17
  638. data/lib/stripe/resources/usage_record_summary.rb +0 -12
  639. data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -17
  640. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -23
  641. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -19
@@ -0,0 +1,546 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ class PriceService < StripeService
7
+ class ListParams < Stripe::RequestParams
8
+ class Created < Stripe::RequestParams
9
+ # Minimum value to filter by (exclusive)
10
+ sig { returns(T.nilable(Integer)) }
11
+ attr_accessor :gt
12
+ # Minimum value to filter by (inclusive)
13
+ sig { returns(T.nilable(Integer)) }
14
+ attr_accessor :gte
15
+ # Maximum value to filter by (exclusive)
16
+ sig { returns(T.nilable(Integer)) }
17
+ attr_accessor :lt
18
+ # Maximum value to filter by (inclusive)
19
+ sig { returns(T.nilable(Integer)) }
20
+ attr_accessor :lte
21
+ sig {
22
+ params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
23
+ }
24
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
25
+ end
26
+ class Recurring < Stripe::RequestParams
27
+ # Filter by billing frequency. Either `day`, `week`, `month` or `year`.
28
+ sig { returns(T.nilable(String)) }
29
+ attr_accessor :interval
30
+ # Filter by the price's meter.
31
+ sig { returns(T.nilable(String)) }
32
+ attr_accessor :meter
33
+ # Filter by the usage type for this price. Can be either `metered` or `licensed`.
34
+ sig { returns(T.nilable(String)) }
35
+ attr_accessor :usage_type
36
+ sig {
37
+ params(interval: T.nilable(String), meter: T.nilable(String), usage_type: T.nilable(String)).void
38
+ }
39
+ def initialize(interval: nil, meter: nil, usage_type: nil); end
40
+ end
41
+ # Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
42
+ sig { returns(T.nilable(T::Boolean)) }
43
+ attr_accessor :active
44
+ # 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.
45
+ sig { returns(T.nilable(T.any(::Stripe::PriceService::ListParams::Created, Integer))) }
46
+ attr_accessor :created
47
+ # Only return prices for the given currency.
48
+ sig { returns(T.nilable(String)) }
49
+ attr_accessor :currency
50
+ # 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.
51
+ sig { returns(T.nilable(String)) }
52
+ attr_accessor :ending_before
53
+ # Specifies which fields in the response should be expanded.
54
+ sig { returns(T.nilable(T::Array[String])) }
55
+ attr_accessor :expand
56
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
57
+ sig { returns(T.nilable(Integer)) }
58
+ attr_accessor :limit
59
+ # Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
60
+ sig { returns(T.nilable(T::Array[String])) }
61
+ attr_accessor :lookup_keys
62
+ # Only return prices for the given product.
63
+ sig { returns(T.nilable(String)) }
64
+ attr_accessor :product
65
+ # Only return prices with these recurring fields.
66
+ sig { returns(T.nilable(::Stripe::PriceService::ListParams::Recurring)) }
67
+ attr_accessor :recurring
68
+ # 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.
69
+ sig { returns(T.nilable(String)) }
70
+ attr_accessor :starting_after
71
+ # Only return prices of type `recurring` or `one_time`.
72
+ sig { returns(T.nilable(String)) }
73
+ attr_accessor :type
74
+ sig {
75
+ params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::PriceService::ListParams::Created, Integer)), currency: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_keys: T.nilable(T::Array[String]), product: T.nilable(String), recurring: T.nilable(::Stripe::PriceService::ListParams::Recurring), starting_after: T.nilable(String), type: T.nilable(String)).void
76
+ }
77
+ def initialize(
78
+ active: nil,
79
+ created: nil,
80
+ currency: nil,
81
+ ending_before: nil,
82
+ expand: nil,
83
+ limit: nil,
84
+ lookup_keys: nil,
85
+ product: nil,
86
+ recurring: nil,
87
+ starting_after: nil,
88
+ type: nil
89
+ ); end
90
+ end
91
+ class CreateParams < Stripe::RequestParams
92
+ class CurrencyOptions < Stripe::RequestParams
93
+ class CustomUnitAmount < Stripe::RequestParams
94
+ # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
95
+ sig { returns(T::Boolean) }
96
+ attr_accessor :enabled
97
+ # The maximum unit amount the customer can specify for this item.
98
+ sig { returns(T.nilable(Integer)) }
99
+ attr_accessor :maximum
100
+ # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
101
+ sig { returns(T.nilable(Integer)) }
102
+ attr_accessor :minimum
103
+ # The starting unit amount which can be updated by the customer.
104
+ sig { returns(T.nilable(Integer)) }
105
+ attr_accessor :preset
106
+ sig {
107
+ params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
108
+ }
109
+ def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
110
+ end
111
+ class Tier < Stripe::RequestParams
112
+ # The flat billing amount for an entire tier, regardless of the number of units in the tier.
113
+ sig { returns(T.nilable(Integer)) }
114
+ attr_accessor :flat_amount
115
+ # 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.
116
+ sig { returns(T.nilable(String)) }
117
+ attr_accessor :flat_amount_decimal
118
+ # The per unit billing amount for each individual unit for which this tier applies.
119
+ sig { returns(T.nilable(Integer)) }
120
+ attr_accessor :unit_amount
121
+ # 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.
122
+ sig { returns(T.nilable(String)) }
123
+ attr_accessor :unit_amount_decimal
124
+ # 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.
125
+ sig { returns(T.any(String, Integer)) }
126
+ attr_accessor :up_to
127
+ sig {
128
+ params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
129
+ }
130
+ def initialize(
131
+ flat_amount: nil,
132
+ flat_amount_decimal: nil,
133
+ unit_amount: nil,
134
+ unit_amount_decimal: nil,
135
+ up_to: nil
136
+ ); end
137
+ end
138
+ # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
139
+ sig {
140
+ returns(T.nilable(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount))
141
+ }
142
+ attr_accessor :custom_unit_amount
143
+ # 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.
144
+ sig { returns(T.nilable(String)) }
145
+ attr_accessor :tax_behavior
146
+ # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
147
+ sig {
148
+ returns(T.nilable(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier]))
149
+ }
150
+ attr_accessor :tiers
151
+ # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
152
+ sig { returns(T.nilable(Integer)) }
153
+ attr_accessor :unit_amount
154
+ # 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.
155
+ sig { returns(T.nilable(String)) }
156
+ attr_accessor :unit_amount_decimal
157
+ sig {
158
+ params(custom_unit_amount: T.nilable(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
159
+ }
160
+ def initialize(
161
+ custom_unit_amount: nil,
162
+ tax_behavior: nil,
163
+ tiers: nil,
164
+ unit_amount: nil,
165
+ unit_amount_decimal: nil
166
+ ); end
167
+ end
168
+ class CustomUnitAmount < Stripe::RequestParams
169
+ # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
170
+ sig { returns(T::Boolean) }
171
+ attr_accessor :enabled
172
+ # The maximum unit amount the customer can specify for this item.
173
+ sig { returns(T.nilable(Integer)) }
174
+ attr_accessor :maximum
175
+ # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
176
+ sig { returns(T.nilable(Integer)) }
177
+ attr_accessor :minimum
178
+ # The starting unit amount which can be updated by the customer.
179
+ sig { returns(T.nilable(Integer)) }
180
+ attr_accessor :preset
181
+ sig {
182
+ params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
183
+ }
184
+ def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
185
+ end
186
+ class ProductData < Stripe::RequestParams
187
+ # Whether the product is currently available for purchase. Defaults to `true`.
188
+ sig { returns(T.nilable(T::Boolean)) }
189
+ attr_accessor :active
190
+ # The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
191
+ sig { returns(T.nilable(String)) }
192
+ attr_accessor :id
193
+ # 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`.
194
+ sig { returns(T.nilable(T::Hash[String, String])) }
195
+ attr_accessor :metadata
196
+ # The product's name, meant to be displayable to the customer.
197
+ sig { returns(String) }
198
+ attr_accessor :name
199
+ # 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.
200
+ #
201
+ # 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.
202
+ sig { returns(T.nilable(String)) }
203
+ attr_accessor :statement_descriptor
204
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
205
+ sig { returns(T.nilable(String)) }
206
+ attr_accessor :tax_code
207
+ # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
208
+ sig { returns(T.nilable(String)) }
209
+ attr_accessor :unit_label
210
+ sig {
211
+ params(active: T.nilable(T::Boolean), id: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: String, statement_descriptor: T.nilable(String), tax_code: T.nilable(String), unit_label: T.nilable(String)).void
212
+ }
213
+ def initialize(
214
+ active: nil,
215
+ id: nil,
216
+ metadata: nil,
217
+ name: nil,
218
+ statement_descriptor: nil,
219
+ tax_code: nil,
220
+ unit_label: nil
221
+ ); end
222
+ end
223
+ class Recurring < Stripe::RequestParams
224
+ # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
225
+ sig { returns(String) }
226
+ attr_accessor :interval
227
+ # 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).
228
+ sig { returns(T.nilable(Integer)) }
229
+ attr_accessor :interval_count
230
+ # The meter tracking the usage of a metered price
231
+ sig { returns(T.nilable(String)) }
232
+ attr_accessor :meter
233
+ # 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).
234
+ sig { returns(T.nilable(Integer)) }
235
+ attr_accessor :trial_period_days
236
+ # 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`.
237
+ sig { returns(T.nilable(String)) }
238
+ attr_accessor :usage_type
239
+ sig {
240
+ params(interval: String, interval_count: T.nilable(Integer), meter: T.nilable(String), trial_period_days: T.nilable(Integer), usage_type: T.nilable(String)).void
241
+ }
242
+ def initialize(
243
+ interval: nil,
244
+ interval_count: nil,
245
+ meter: nil,
246
+ trial_period_days: nil,
247
+ usage_type: nil
248
+ ); end
249
+ end
250
+ class Tier < Stripe::RequestParams
251
+ # The flat billing amount for an entire tier, regardless of the number of units in the tier.
252
+ sig { returns(T.nilable(Integer)) }
253
+ attr_accessor :flat_amount
254
+ # 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.
255
+ sig { returns(T.nilable(String)) }
256
+ attr_accessor :flat_amount_decimal
257
+ # The per unit billing amount for each individual unit for which this tier applies.
258
+ sig { returns(T.nilable(Integer)) }
259
+ attr_accessor :unit_amount
260
+ # 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.
261
+ sig { returns(T.nilable(String)) }
262
+ attr_accessor :unit_amount_decimal
263
+ # 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.
264
+ sig { returns(T.any(String, Integer)) }
265
+ attr_accessor :up_to
266
+ sig {
267
+ params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
268
+ }
269
+ def initialize(
270
+ flat_amount: nil,
271
+ flat_amount_decimal: nil,
272
+ unit_amount: nil,
273
+ unit_amount_decimal: nil,
274
+ up_to: nil
275
+ ); end
276
+ end
277
+ class TransformQuantity < Stripe::RequestParams
278
+ # Divide usage by this number.
279
+ sig { returns(Integer) }
280
+ attr_accessor :divide_by
281
+ # After division, either round the result `up` or `down`.
282
+ sig { returns(String) }
283
+ attr_accessor :round
284
+ sig { params(divide_by: Integer, round: String).void }
285
+ def initialize(divide_by: nil, round: nil); end
286
+ end
287
+ # Whether the price can be used for new purchases. Defaults to `true`.
288
+ sig { returns(T.nilable(T::Boolean)) }
289
+ attr_accessor :active
290
+ # 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.
291
+ sig { returns(T.nilable(String)) }
292
+ attr_accessor :billing_scheme
293
+ # 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).
294
+ sig { returns(String) }
295
+ attr_accessor :currency
296
+ # 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).
297
+ sig {
298
+ returns(T.nilable(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions]))
299
+ }
300
+ attr_accessor :currency_options
301
+ # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
302
+ sig { returns(T.nilable(::Stripe::PriceService::CreateParams::CustomUnitAmount)) }
303
+ attr_accessor :custom_unit_amount
304
+ # Specifies which fields in the response should be expanded.
305
+ sig { returns(T.nilable(T::Array[String])) }
306
+ attr_accessor :expand
307
+ # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
308
+ sig { returns(T.nilable(String)) }
309
+ attr_accessor :lookup_key
310
+ # 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`.
311
+ sig { returns(T.nilable(T::Hash[String, String])) }
312
+ attr_accessor :metadata
313
+ # A brief description of the price, hidden from customers.
314
+ sig { returns(T.nilable(String)) }
315
+ attr_accessor :nickname
316
+ # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
317
+ sig { returns(T.nilable(String)) }
318
+ attr_accessor :product
319
+ # These fields can be used to create a new product that this price will belong to.
320
+ sig { returns(T.nilable(::Stripe::PriceService::CreateParams::ProductData)) }
321
+ attr_accessor :product_data
322
+ # The recurring components of a price such as `interval` and `usage_type`.
323
+ sig { returns(T.nilable(::Stripe::PriceService::CreateParams::Recurring)) }
324
+ attr_accessor :recurring
325
+ # 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.
326
+ sig { returns(T.nilable(String)) }
327
+ attr_accessor :tax_behavior
328
+ # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
329
+ sig { returns(T.nilable(T::Array[::Stripe::PriceService::CreateParams::Tier])) }
330
+ attr_accessor :tiers
331
+ # 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.
332
+ sig { returns(T.nilable(String)) }
333
+ attr_accessor :tiers_mode
334
+ # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
335
+ sig { returns(T.nilable(T::Boolean)) }
336
+ attr_accessor :transfer_lookup_key
337
+ # Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
338
+ sig { returns(T.nilable(::Stripe::PriceService::CreateParams::TransformQuantity)) }
339
+ attr_accessor :transform_quantity
340
+ # 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`.
341
+ sig { returns(T.nilable(Integer)) }
342
+ attr_accessor :unit_amount
343
+ # 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.
344
+ sig { returns(T.nilable(String)) }
345
+ attr_accessor :unit_amount_decimal
346
+ sig {
347
+ params(active: T.nilable(T::Boolean), billing_scheme: T.nilable(String), currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions]), custom_unit_amount: T.nilable(::Stripe::PriceService::CreateParams::CustomUnitAmount), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), nickname: T.nilable(String), product: T.nilable(String), product_data: T.nilable(::Stripe::PriceService::CreateParams::ProductData), recurring: T.nilable(::Stripe::PriceService::CreateParams::Recurring), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::CreateParams::Tier]), tiers_mode: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean), transform_quantity: T.nilable(::Stripe::PriceService::CreateParams::TransformQuantity), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
348
+ }
349
+ def initialize(
350
+ active: nil,
351
+ billing_scheme: nil,
352
+ currency: nil,
353
+ currency_options: nil,
354
+ custom_unit_amount: nil,
355
+ expand: nil,
356
+ lookup_key: nil,
357
+ metadata: nil,
358
+ nickname: nil,
359
+ product: nil,
360
+ product_data: nil,
361
+ recurring: nil,
362
+ tax_behavior: nil,
363
+ tiers: nil,
364
+ tiers_mode: nil,
365
+ transfer_lookup_key: nil,
366
+ transform_quantity: nil,
367
+ unit_amount: nil,
368
+ unit_amount_decimal: nil
369
+ ); end
370
+ end
371
+ class RetrieveParams < Stripe::RequestParams
372
+ # Specifies which fields in the response should be expanded.
373
+ sig { returns(T.nilable(T::Array[String])) }
374
+ attr_accessor :expand
375
+ sig { params(expand: T.nilable(T::Array[String])).void }
376
+ def initialize(expand: nil); end
377
+ end
378
+ class UpdateParams < Stripe::RequestParams
379
+ class CurrencyOptions < Stripe::RequestParams
380
+ class CustomUnitAmount < Stripe::RequestParams
381
+ # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
382
+ sig { returns(T::Boolean) }
383
+ attr_accessor :enabled
384
+ # The maximum unit amount the customer can specify for this item.
385
+ sig { returns(T.nilable(Integer)) }
386
+ attr_accessor :maximum
387
+ # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
388
+ sig { returns(T.nilable(Integer)) }
389
+ attr_accessor :minimum
390
+ # The starting unit amount which can be updated by the customer.
391
+ sig { returns(T.nilable(Integer)) }
392
+ attr_accessor :preset
393
+ sig {
394
+ params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
395
+ }
396
+ def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
397
+ end
398
+ class Tier < Stripe::RequestParams
399
+ # The flat billing amount for an entire tier, regardless of the number of units in the tier.
400
+ sig { returns(T.nilable(Integer)) }
401
+ attr_accessor :flat_amount
402
+ # 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.
403
+ sig { returns(T.nilable(String)) }
404
+ attr_accessor :flat_amount_decimal
405
+ # The per unit billing amount for each individual unit for which this tier applies.
406
+ sig { returns(T.nilable(Integer)) }
407
+ attr_accessor :unit_amount
408
+ # 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.
409
+ sig { returns(T.nilable(String)) }
410
+ attr_accessor :unit_amount_decimal
411
+ # 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.
412
+ sig { returns(T.any(String, Integer)) }
413
+ attr_accessor :up_to
414
+ sig {
415
+ params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
416
+ }
417
+ def initialize(
418
+ flat_amount: nil,
419
+ flat_amount_decimal: nil,
420
+ unit_amount: nil,
421
+ unit_amount_decimal: nil,
422
+ up_to: nil
423
+ ); end
424
+ end
425
+ # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
426
+ sig {
427
+ returns(T.nilable(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount))
428
+ }
429
+ attr_accessor :custom_unit_amount
430
+ # 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.
431
+ sig { returns(T.nilable(String)) }
432
+ attr_accessor :tax_behavior
433
+ # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
434
+ sig {
435
+ returns(T.nilable(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier]))
436
+ }
437
+ attr_accessor :tiers
438
+ # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
439
+ sig { returns(T.nilable(Integer)) }
440
+ attr_accessor :unit_amount
441
+ # 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.
442
+ sig { returns(T.nilable(String)) }
443
+ attr_accessor :unit_amount_decimal
444
+ sig {
445
+ params(custom_unit_amount: T.nilable(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
446
+ }
447
+ def initialize(
448
+ custom_unit_amount: nil,
449
+ tax_behavior: nil,
450
+ tiers: nil,
451
+ unit_amount: nil,
452
+ unit_amount_decimal: nil
453
+ ); end
454
+ end
455
+ # Whether the price can be used for new purchases. Defaults to `true`.
456
+ sig { returns(T.nilable(T::Boolean)) }
457
+ attr_accessor :active
458
+ # 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).
459
+ sig {
460
+ returns(T.nilable(T.nilable(T.any(String, T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]))))
461
+ }
462
+ attr_accessor :currency_options
463
+ # Specifies which fields in the response should be expanded.
464
+ sig { returns(T.nilable(T::Array[String])) }
465
+ attr_accessor :expand
466
+ # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
467
+ sig { returns(T.nilable(String)) }
468
+ attr_accessor :lookup_key
469
+ # 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`.
470
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
471
+ attr_accessor :metadata
472
+ # A brief description of the price, hidden from customers.
473
+ sig { returns(T.nilable(String)) }
474
+ attr_accessor :nickname
475
+ # 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.
476
+ sig { returns(T.nilable(String)) }
477
+ attr_accessor :tax_behavior
478
+ # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
479
+ sig { returns(T.nilable(T::Boolean)) }
480
+ attr_accessor :transfer_lookup_key
481
+ sig {
482
+ params(active: T.nilable(T::Boolean), currency_options: T.nilable(T.nilable(T.any(String, T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]))), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), nickname: T.nilable(String), tax_behavior: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean)).void
483
+ }
484
+ def initialize(
485
+ active: nil,
486
+ currency_options: nil,
487
+ expand: nil,
488
+ lookup_key: nil,
489
+ metadata: nil,
490
+ nickname: nil,
491
+ tax_behavior: nil,
492
+ transfer_lookup_key: nil
493
+ ); end
494
+ end
495
+ class SearchParams < Stripe::RequestParams
496
+ # Specifies which fields in the response should be expanded.
497
+ sig { returns(T.nilable(T::Array[String])) }
498
+ attr_accessor :expand
499
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
500
+ sig { returns(T.nilable(Integer)) }
501
+ attr_accessor :limit
502
+ # 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.
503
+ sig { returns(T.nilable(String)) }
504
+ attr_accessor :page
505
+ # 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).
506
+ sig { returns(String) }
507
+ attr_accessor :query
508
+ sig {
509
+ params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
510
+ }
511
+ def initialize(expand: nil, limit: nil, page: nil, query: nil); end
512
+ end
513
+ # Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
514
+ sig {
515
+ params(params: T.any(::Stripe::PriceService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
516
+ }
517
+ def create(params = {}, opts = {}); end
518
+
519
+ # 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.
520
+ sig {
521
+ params(params: T.any(::Stripe::PriceService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
522
+ }
523
+ def list(params = {}, opts = {}); end
524
+
525
+ # Retrieves the price with the given ID.
526
+ sig {
527
+ params(price: String, params: T.any(::Stripe::PriceService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
528
+ }
529
+ def retrieve(price, params = {}, opts = {}); end
530
+
531
+ # Search for prices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
532
+ # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
533
+ # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
534
+ # to an hour behind during outages. Search functionality is not available to merchants in India.
535
+ sig {
536
+ params(params: T.any(::Stripe::PriceService::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
537
+ }
538
+ def search(params = {}, opts = {}); end
539
+
540
+ # Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
541
+ sig {
542
+ params(price: String, params: T.any(::Stripe::PriceService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
543
+ }
544
+ def update(price, params = {}, opts = {}); end
545
+ end
546
+ end
@@ -0,0 +1,69 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ class ProductFeatureService < StripeService
7
+ class DeleteParams < Stripe::RequestParams
8
+
9
+ end
10
+ class RetrieveParams < Stripe::RequestParams
11
+ # Specifies which fields in the response should be expanded.
12
+ sig { returns(T.nilable(T::Array[String])) }
13
+ attr_accessor :expand
14
+ sig { params(expand: T.nilable(T::Array[String])).void }
15
+ def initialize(expand: nil); end
16
+ end
17
+ class ListParams < Stripe::RequestParams
18
+ # 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.
19
+ sig { returns(T.nilable(String)) }
20
+ attr_accessor :ending_before
21
+ # Specifies which fields in the response should be expanded.
22
+ sig { returns(T.nilable(T::Array[String])) }
23
+ attr_accessor :expand
24
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
25
+ sig { returns(T.nilable(Integer)) }
26
+ attr_accessor :limit
27
+ # 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.
28
+ sig { returns(T.nilable(String)) }
29
+ attr_accessor :starting_after
30
+ sig {
31
+ params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
32
+ }
33
+ def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
34
+ end
35
+ class CreateParams < Stripe::RequestParams
36
+ # The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product.
37
+ sig { returns(String) }
38
+ attr_accessor :entitlement_feature
39
+ # Specifies which fields in the response should be expanded.
40
+ sig { returns(T.nilable(T::Array[String])) }
41
+ attr_accessor :expand
42
+ sig { params(entitlement_feature: String, expand: T.nilable(T::Array[String])).void }
43
+ def initialize(entitlement_feature: nil, expand: nil); end
44
+ end
45
+ # Creates a product_feature, which represents a feature attachment to a product
46
+ sig {
47
+ params(product: String, params: T.any(::Stripe::ProductFeatureService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ProductFeature)
48
+ }
49
+ def create(product, params = {}, opts = {}); end
50
+
51
+ # Deletes the feature attachment to a product
52
+ sig {
53
+ params(product: String, id: String, params: T.any(::Stripe::ProductFeatureService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ProductFeature)
54
+ }
55
+ def delete(product, id, params = {}, opts = {}); end
56
+
57
+ # Retrieve a list of features for a product
58
+ sig {
59
+ params(product: String, params: T.any(::Stripe::ProductFeatureService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
60
+ }
61
+ def list(product, params = {}, opts = {}); end
62
+
63
+ # Retrieves a product_feature, which represents a feature attachment to a product
64
+ sig {
65
+ params(product: String, id: String, params: T.any(::Stripe::ProductFeatureService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ProductFeature)
66
+ }
67
+ def retrieve(product, id, params = {}, opts = {}); end
68
+ end
69
+ end