stripe 15.2.1 → 15.3.0.pre.beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (588) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1602 -674
  3. data/VERSION +1 -1
  4. data/lib/stripe/api_requestor.rb +28 -0
  5. data/lib/stripe/api_version.rb +1 -1
  6. data/lib/stripe/errors.rb +54 -0
  7. data/lib/stripe/event_types.rb +98 -0
  8. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  9. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  10. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  11. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  19. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  20. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  21. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  22. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  23. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  24. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  25. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  26. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  30. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  48. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  52. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  53. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  58. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
  59. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  60. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
  61. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  62. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  65. data/lib/stripe/object_types.rb +50 -0
  66. data/lib/stripe/resources/account.rb +653 -1
  67. data/lib/stripe/resources/account_notice.rb +123 -0
  68. data/lib/stripe/resources/account_session.rb +256 -1
  69. data/lib/stripe/resources/balance_settings.rb +105 -0
  70. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  71. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  72. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  73. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  74. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  75. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  76. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  77. data/lib/stripe/resources/card.rb +2 -0
  78. data/lib/stripe/resources/cash_balance.rb +2 -0
  79. data/lib/stripe/resources/charge.rb +1538 -0
  80. data/lib/stripe/resources/checkout/session.rb +330 -2
  81. data/lib/stripe/resources/confirmation_token.rb +170 -0
  82. data/lib/stripe/resources/coupon.rb +30 -1
  83. data/lib/stripe/resources/credit_note.rb +6 -0
  84. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  85. data/lib/stripe/resources/customer.rb +2 -0
  86. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  87. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  88. data/lib/stripe/resources/customer_session.rb +6 -1
  89. data/lib/stripe/resources/discount.rb +2 -0
  90. data/lib/stripe/resources/event.rb +31 -0
  91. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  92. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  93. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  94. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  95. data/lib/stripe/resources/fx_quote.rb +184 -0
  96. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  97. data/lib/stripe/resources/invoice.rb +1070 -16
  98. data/lib/stripe/resources/invoice_item.rb +78 -2
  99. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  100. data/lib/stripe/resources/invoice_payment.rb +2 -53
  101. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  102. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  103. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  104. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  105. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  106. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  107. data/lib/stripe/resources/line_item.rb +37 -0
  108. data/lib/stripe/resources/mandate.rb +24 -0
  109. data/lib/stripe/resources/margin.rb +115 -0
  110. data/lib/stripe/resources/order.rb +2806 -0
  111. data/lib/stripe/resources/payment_attempt_record.rb +1086 -0
  112. data/lib/stripe/resources/payment_intent.rb +7694 -2738
  113. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  114. data/lib/stripe/resources/payment_method.rb +192 -1
  115. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  116. data/lib/stripe/resources/payment_record.rb +1615 -0
  117. data/lib/stripe/resources/payout.rb +6 -0
  118. data/lib/stripe/resources/price.rb +30 -0
  119. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  120. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  121. data/lib/stripe/resources/promotion_code.rb +10 -0
  122. data/lib/stripe/resources/quote.rb +2046 -6
  123. data/lib/stripe/resources/quote_line.rb +274 -0
  124. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  125. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +364 -0
  126. data/lib/stripe/resources/refund.rb +9 -0
  127. data/lib/stripe/resources/setup_attempt.rb +21 -0
  128. data/lib/stripe/resources/setup_intent.rb +578 -9
  129. data/lib/stripe/resources/source.rb +29 -0
  130. data/lib/stripe/resources/subscription.rb +333 -9
  131. data/lib/stripe/resources/subscription_item.rb +84 -3
  132. data/lib/stripe/resources/subscription_schedule.rb +1013 -10
  133. data/lib/stripe/resources/tax/association.rb +66 -0
  134. data/lib/stripe/resources/tax/form.rb +211 -0
  135. data/lib/stripe/resources/tax_id.rb +12 -2
  136. data/lib/stripe/resources/terminal/reader.rb +156 -0
  137. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  138. data/lib/stripe/resources/transfer.rb +6 -0
  139. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  140. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  141. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  142. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  143. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  144. data/lib/stripe/resources/v2/core/account.rb +1746 -0
  145. data/lib/stripe/resources/v2/core/account_link.rb +56 -0
  146. data/lib/stripe/resources/v2/core/person.rb +276 -0
  147. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  148. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  149. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  150. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  151. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  152. data/lib/stripe/resources/v2/money_management/financial_account.rb +58 -0
  153. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  154. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  155. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  156. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  157. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  158. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  159. data/lib/stripe/resources/v2/money_management/payout_method.rb +75 -0
  160. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  161. data/lib/stripe/resources/v2/money_management/received_credit.rb +116 -0
  162. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  163. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  164. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  165. data/lib/stripe/resources/v2/payments/off_session_payment.rb +72 -0
  166. data/lib/stripe/resources.rb +104 -0
  167. data/lib/stripe/services/account_notice_service.rb +101 -0
  168. data/lib/stripe/services/account_service.rb +562 -1
  169. data/lib/stripe/services/account_session_service.rb +226 -1
  170. data/lib/stripe/services/balance_settings_service.rb +96 -0
  171. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  172. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  173. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  174. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  175. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  176. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  177. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  178. data/lib/stripe/services/capital_service.rb +15 -0
  179. data/lib/stripe/services/charge_service.rb +1418 -0
  180. data/lib/stripe/services/checkout/session_service.rb +247 -2
  181. data/lib/stripe/services/coupon_service.rb +17 -1
  182. data/lib/stripe/services/credit_note_service.rb +4 -0
  183. data/lib/stripe/services/customer_session_service.rb +4 -1
  184. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  185. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  186. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  187. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  188. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  189. data/lib/stripe/services/financial_connections_service.rb +2 -1
  190. data/lib/stripe/services/fx_quote_service.rb +123 -0
  191. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  192. data/lib/stripe/services/invoice_item_service.rb +74 -2
  193. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  194. data/lib/stripe/services/invoice_service.rb +1021 -16
  195. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  196. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  197. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  198. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  199. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  200. data/lib/stripe/services/issuing_service.rb +5 -1
  201. data/lib/stripe/services/margin_service.rb +119 -0
  202. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  203. data/lib/stripe/services/order_service.rb +2236 -0
  204. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  205. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  206. data/lib/stripe/services/payment_intent_service.rb +4733 -245
  207. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  208. data/lib/stripe/services/payment_method_service.rb +120 -1
  209. data/lib/stripe/services/payment_record_service.rb +542 -0
  210. data/lib/stripe/services/payout_service.rb +4 -0
  211. data/lib/stripe/services/price_service.rb +19 -0
  212. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  213. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  214. data/lib/stripe/services/privacy_service.rb +13 -0
  215. data/lib/stripe/services/promotion_code_service.rb +8 -0
  216. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  217. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  218. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  219. data/lib/stripe/services/quote_service.rb +1730 -7
  220. data/lib/stripe/services/setup_intent_service.rb +538 -9
  221. data/lib/stripe/services/subscription_item_service.rb +75 -3
  222. data/lib/stripe/services/subscription_schedule_service.rb +915 -10
  223. data/lib/stripe/services/subscription_service.rb +276 -9
  224. data/lib/stripe/services/tax/association_service.rb +31 -0
  225. data/lib/stripe/services/tax/form_service.rb +100 -0
  226. data/lib/stripe/services/tax_id_service.rb +8 -2
  227. data/lib/stripe/services/tax_service.rb +3 -1
  228. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  229. data/lib/stripe/services/terminal/reader_service.rb +90 -0
  230. data/lib/stripe/services/terminal_service.rb +2 -1
  231. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  232. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  233. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  234. data/lib/stripe/services/transfer_service.rb +4 -0
  235. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  236. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  237. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  238. data/lib/stripe/services/v1_services.rb +11 -2
  239. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  240. data/lib/stripe/services/v2/core/account_service.rb +4138 -0
  241. data/lib/stripe/services/v2/core/accounts/person_service.rb +1046 -0
  242. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +131 -0
  243. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  244. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  245. data/lib/stripe/services/v2/core_service.rb +4 -1
  246. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  247. data/lib/stripe/services/v2/money_management/financial_account_service.rb +43 -0
  248. data/lib/stripe/services/v2/money_management/financial_address_service.rb +81 -0
  249. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  250. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  251. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +200 -0
  252. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  253. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  254. data/lib/stripe/services/v2/money_management/payout_method_service.rb +91 -0
  255. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  256. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  257. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  258. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  259. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  260. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  261. data/lib/stripe/services/v2/payment_service.rb +15 -0
  262. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +138 -0
  263. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  264. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +49 -0
  265. data/lib/stripe/services/v2_services.rb +5 -2
  266. data/lib/stripe/services.rb +53 -1
  267. data/lib/stripe/stripe_configuration.rb +3 -1
  268. data/lib/stripe/stripe_object.rb +1 -1
  269. data/lib/stripe/util.rb +7 -1
  270. data/lib/stripe/version.rb +1 -1
  271. data/lib/stripe/webhook.rb +1 -1
  272. data/lib/stripe.rb +53 -0
  273. data/rbi/stripe.rbi +191636 -0
  274. data/stripe.gemspec +4 -1
  275. metadata +162 -325
  276. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  277. data/rbi/stripe/resources/account.rbi +0 -4926
  278. data/rbi/stripe/resources/account_link.rbi +0 -74
  279. data/rbi/stripe/resources/account_session.rbi +0 -1013
  280. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  281. data/rbi/stripe/resources/application.rbi +0 -20
  282. data/rbi/stripe/resources/application_fee.rbi +0 -118
  283. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  284. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  285. data/rbi/stripe/resources/balance.rbi +0 -235
  286. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  287. data/rbi/stripe/resources/bank_account.rbi +0 -127
  288. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  289. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  290. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  291. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  292. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  293. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  294. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  295. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  296. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  297. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  298. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  299. data/rbi/stripe/resources/capability.rbi +0 -125
  300. data/rbi/stripe/resources/card.rbi +0 -125
  301. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  302. data/rbi/stripe/resources/charge.rbi +0 -2069
  303. data/rbi/stripe/resources/checkout/session.rbi +0 -4004
  304. data/rbi/stripe/resources/climate/order.rbi +0 -245
  305. data/rbi/stripe/resources/climate/product.rbi +0 -75
  306. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  307. data/rbi/stripe/resources/confirmation_token.rbi +0 -1807
  308. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  309. data/rbi/stripe/resources/country_spec.rbi +0 -85
  310. data/rbi/stripe/resources/coupon.rbi +0 -250
  311. data/rbi/stripe/resources/credit_note.rbi +0 -752
  312. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  313. data/rbi/stripe/resources/customer.rbi +0 -1005
  314. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  315. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  316. data/rbi/stripe/resources/customer_session.rbi +0 -200
  317. data/rbi/stripe/resources/discount.rbi +0 -53
  318. data/rbi/stripe/resources/dispute.rbi +0 -761
  319. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  320. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  321. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  322. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  323. data/rbi/stripe/resources/event.rbi +0 -149
  324. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  325. data/rbi/stripe/resources/file.rbi +0 -143
  326. data/rbi/stripe/resources/file_link.rbi +0 -141
  327. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  328. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  329. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  330. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  331. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  332. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  333. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  334. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  335. data/rbi/stripe/resources/identity/verification_session.rbi +0 -526
  336. data/rbi/stripe/resources/invoice.rbi +0 -3812
  337. data/rbi/stripe/resources/invoice_item.rbi +0 -473
  338. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  339. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  340. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  341. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  342. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  343. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  344. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  345. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  346. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  347. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  348. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  349. data/rbi/stripe/resources/line_item.rbi +0 -72
  350. data/rbi/stripe/resources/login_link.rbi +0 -19
  351. data/rbi/stripe/resources/mandate.rbi +0 -187
  352. data/rbi/stripe/resources/payment_intent.rbi +0 -9647
  353. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  354. data/rbi/stripe/resources/payment_method.rbi +0 -1761
  355. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  356. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  357. data/rbi/stripe/resources/payout.rbi +0 -300
  358. data/rbi/stripe/resources/person.rbi +0 -401
  359. data/rbi/stripe/resources/plan.rbi +0 -371
  360. data/rbi/stripe/resources/price.rbi +0 -694
  361. data/rbi/stripe/resources/product.rbi +0 -555
  362. data/rbi/stripe/resources/product_feature.rbi +0 -26
  363. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  364. data/rbi/stripe/resources/quote.rbi +0 -1126
  365. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  366. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  367. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  368. data/rbi/stripe/resources/refund.rbi +0 -523
  369. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  370. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  371. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  372. data/rbi/stripe/resources/reversal.rbi +0 -51
  373. data/rbi/stripe/resources/review.rbi +0 -154
  374. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  375. data/rbi/stripe/resources/setup_intent.rbi +0 -3655
  376. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  377. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  378. data/rbi/stripe/resources/source.rbi +0 -1496
  379. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  380. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  381. data/rbi/stripe/resources/subscription.rbi +0 -2027
  382. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  383. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1623
  384. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  385. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  386. data/rbi/stripe/resources/tax/registration.rbi +0 -2713
  387. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  388. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  389. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  390. data/rbi/stripe/resources/tax_code.rbi +0 -44
  391. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  392. data/rbi/stripe/resources/tax_id.rbi +0 -165
  393. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  394. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1386
  395. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  396. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  397. data/rbi/stripe/resources/terminal/reader.rbi +0 -847
  398. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  399. data/rbi/stripe/resources/token.rbi +0 -1283
  400. data/rbi/stripe/resources/topup.rbi +0 -222
  401. data/rbi/stripe/resources/transfer.rbi +0 -199
  402. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  403. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  404. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -865
  405. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  406. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  407. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  408. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  409. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  410. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  411. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  412. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  413. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  414. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  415. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  416. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  417. data/rbi/stripe/resources/v2/event.rbi +0 -48
  418. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  419. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  420. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  421. data/rbi/stripe/services/account_link_service.rbi +0 -58
  422. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  423. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  424. data/rbi/stripe/services/account_service.rbi +0 -4213
  425. data/rbi/stripe/services/account_session_service.rbi +0 -646
  426. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  427. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  428. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  429. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  430. data/rbi/stripe/services/apps_service.rbi +0 -9
  431. data/rbi/stripe/services/balance_service.rbi +0 -21
  432. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  433. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  434. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  435. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  436. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  437. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  438. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  439. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  440. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  441. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  442. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  443. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  444. data/rbi/stripe/services/billing_service.rbi +0 -15
  445. data/rbi/stripe/services/charge_service.rbi +0 -448
  446. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  447. data/rbi/stripe/services/checkout/session_service.rbi +0 -2614
  448. data/rbi/stripe/services/checkout_service.rbi +0 -9
  449. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  450. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  451. data/rbi/stripe/services/climate_service.rbi +0 -11
  452. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  453. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  454. data/rbi/stripe/services/coupon_service.rbi +0 -194
  455. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  456. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  457. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  458. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  459. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  460. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  461. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  462. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  463. data/rbi/stripe/services/customer_service.rbi +0 -647
  464. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  465. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  466. data/rbi/stripe/services/dispute_service.rbi +0 -424
  467. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  468. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  469. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  470. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  471. data/rbi/stripe/services/event_service.rbi +0 -83
  472. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  473. data/rbi/stripe/services/file_link_service.rbi +0 -124
  474. data/rbi/stripe/services/file_service.rbi +0 -116
  475. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  476. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  477. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  478. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  479. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  480. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  481. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  482. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  483. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -323
  484. data/rbi/stripe/services/identity_service.rbi +0 -10
  485. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  486. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  487. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  488. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  489. data/rbi/stripe/services/invoice_service.rbi +0 -2981
  490. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  491. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  492. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  493. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  494. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  495. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  496. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  497. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  498. data/rbi/stripe/services/issuing_service.rbi +0 -16
  499. data/rbi/stripe/services/mandate_service.rbi +0 -20
  500. data/rbi/stripe/services/payment_intent_service.rbi +0 -7659
  501. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  502. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  503. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  504. data/rbi/stripe/services/payment_method_service.rbi +0 -776
  505. data/rbi/stripe/services/payout_service.rbi +0 -205
  506. data/rbi/stripe/services/plan_service.rbi +0 -282
  507. data/rbi/stripe/services/price_service.rbi +0 -546
  508. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  509. data/rbi/stripe/services/product_service.rbi +0 -477
  510. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  511. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  512. data/rbi/stripe/services/quote_service.rbi +0 -686
  513. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  514. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  515. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  516. data/rbi/stripe/services/radar_service.rbi +0 -11
  517. data/rbi/stripe/services/refund_service.rbi +0 -185
  518. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  519. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  520. data/rbi/stripe/services/reporting_service.rbi +0 -10
  521. data/rbi/stripe/services/review_service.rbi +0 -84
  522. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  523. data/rbi/stripe/services/setup_intent_service.rbi +0 -3391
  524. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  525. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  526. data/rbi/stripe/services/sigma_service.rbi +0 -9
  527. data/rbi/stripe/services/source_service.rbi +0 -663
  528. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  529. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1290
  530. data/rbi/stripe/services/subscription_service.rbi +0 -1648
  531. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  532. data/rbi/stripe/services/tax/registration_service.rbi +0 -1845
  533. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  534. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  535. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  536. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  537. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  538. data/rbi/stripe/services/tax_service.rbi +0 -12
  539. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1118
  540. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  541. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  542. data/rbi/stripe/services/terminal/reader_service.rbi +0 -455
  543. data/rbi/stripe/services/terminal_service.rbi +0 -12
  544. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -739
  545. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  546. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  547. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  548. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  549. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  550. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  551. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  552. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  553. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  554. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  555. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  556. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  557. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  558. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  559. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  560. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  561. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  562. data/rbi/stripe/services/token_service.rbi +0 -1257
  563. data/rbi/stripe/services/topup_service.rbi +0 -176
  564. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  565. data/rbi/stripe/services/transfer_service.rbi +0 -152
  566. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  567. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  568. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  569. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -562
  570. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  571. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  572. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  573. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  574. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  575. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  576. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  577. data/rbi/stripe/services/treasury_service.rbi +0 -18
  578. data/rbi/stripe/services/v1_services.rbi +0 -77
  579. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  580. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  581. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  582. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  583. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  584. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  585. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  586. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  587. data/rbi/stripe/services/v2_services.rbi +0 -10
  588. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,694 +0,0 @@
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 Recurring < Stripe::StripeObject
70
- # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
71
- sig { returns(String) }
72
- attr_reader :interval
73
- # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
74
- sig { returns(Integer) }
75
- attr_reader :interval_count
76
- # The meter tracking the usage of a metered price
77
- sig { returns(T.nilable(String)) }
78
- attr_reader :meter
79
- # 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).
80
- sig { returns(T.nilable(Integer)) }
81
- attr_reader :trial_period_days
82
- # 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`.
83
- sig { returns(String) }
84
- attr_reader :usage_type
85
- end
86
- class Tier < Stripe::StripeObject
87
- # Price for the entire tier.
88
- sig { returns(T.nilable(Integer)) }
89
- attr_reader :flat_amount
90
- # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
91
- sig { returns(T.nilable(String)) }
92
- attr_reader :flat_amount_decimal
93
- # Per unit price for units relevant to the tier.
94
- sig { returns(T.nilable(Integer)) }
95
- attr_reader :unit_amount
96
- # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
97
- sig { returns(T.nilable(String)) }
98
- attr_reader :unit_amount_decimal
99
- # Up to and including to this quantity will be contained in the tier.
100
- sig { returns(T.nilable(Integer)) }
101
- attr_reader :up_to
102
- end
103
- class TransformQuantity < Stripe::StripeObject
104
- # Divide usage by this number.
105
- sig { returns(Integer) }
106
- attr_reader :divide_by
107
- # After division, either round the result `up` or `down`.
108
- sig { returns(String) }
109
- attr_reader :round
110
- end
111
- # Whether the price can be used for new purchases.
112
- sig { returns(T::Boolean) }
113
- attr_reader :active
114
- # 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.
115
- sig { returns(String) }
116
- attr_reader :billing_scheme
117
- # Time at which the object was created. Measured in seconds since the Unix epoch.
118
- sig { returns(Integer) }
119
- attr_reader :created
120
- # 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).
121
- sig { returns(String) }
122
- attr_reader :currency
123
- # 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).
124
- sig { returns(T::Hash[String, CurrencyOptions]) }
125
- attr_reader :currency_options
126
- # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
127
- sig { returns(T.nilable(CustomUnitAmount)) }
128
- attr_reader :custom_unit_amount
129
- # Unique identifier for the object.
130
- sig { returns(String) }
131
- attr_reader :id
132
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
133
- sig { returns(T::Boolean) }
134
- attr_reader :livemode
135
- # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
136
- sig { returns(T.nilable(String)) }
137
- attr_reader :lookup_key
138
- # 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.
139
- sig { returns(T::Hash[String, String]) }
140
- attr_reader :metadata
141
- # A brief description of the price, hidden from customers.
142
- sig { returns(T.nilable(String)) }
143
- attr_reader :nickname
144
- # String representing the object's type. Objects of the same type share the same value.
145
- sig { returns(String) }
146
- attr_reader :object
147
- # The ID of the product this price is associated with.
148
- sig { returns(T.any(String, Stripe::Product)) }
149
- attr_reader :product
150
- # The recurring components of a price such as `interval` and `usage_type`.
151
- sig { returns(T.nilable(Recurring)) }
152
- attr_reader :recurring
153
- # 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.
154
- sig { returns(T.nilable(String)) }
155
- attr_reader :tax_behavior
156
- # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
157
- sig { returns(T::Array[Tier]) }
158
- attr_reader :tiers
159
- # 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.
160
- sig { returns(T.nilable(String)) }
161
- attr_reader :tiers_mode
162
- # Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
163
- sig { returns(T.nilable(TransformQuantity)) }
164
- attr_reader :transform_quantity
165
- # One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
166
- sig { returns(String) }
167
- attr_reader :type
168
- # 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`.
169
- sig { returns(T.nilable(Integer)) }
170
- attr_reader :unit_amount
171
- # 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`.
172
- sig { returns(T.nilable(String)) }
173
- attr_reader :unit_amount_decimal
174
- # Always true for a deleted object
175
- sig { returns(T::Boolean) }
176
- attr_reader :deleted
177
- class ListParams < Stripe::RequestParams
178
- class Created < Stripe::RequestParams
179
- # Minimum value to filter by (exclusive)
180
- sig { returns(T.nilable(Integer)) }
181
- attr_accessor :gt
182
- # Minimum value to filter by (inclusive)
183
- sig { returns(T.nilable(Integer)) }
184
- attr_accessor :gte
185
- # Maximum value to filter by (exclusive)
186
- sig { returns(T.nilable(Integer)) }
187
- attr_accessor :lt
188
- # Maximum value to filter by (inclusive)
189
- sig { returns(T.nilable(Integer)) }
190
- attr_accessor :lte
191
- sig {
192
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
193
- }
194
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
195
- end
196
- class Recurring < Stripe::RequestParams
197
- # Filter by billing frequency. Either `day`, `week`, `month` or `year`.
198
- sig { returns(T.nilable(String)) }
199
- attr_accessor :interval
200
- # Filter by the price's meter.
201
- sig { returns(T.nilable(String)) }
202
- attr_accessor :meter
203
- # Filter by the usage type for this price. Can be either `metered` or `licensed`.
204
- sig { returns(T.nilable(String)) }
205
- attr_accessor :usage_type
206
- sig {
207
- params(interval: T.nilable(String), meter: T.nilable(String), usage_type: T.nilable(String)).void
208
- }
209
- def initialize(interval: nil, meter: nil, usage_type: nil); end
210
- end
211
- # Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
212
- sig { returns(T.nilable(T::Boolean)) }
213
- attr_accessor :active
214
- # 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.
215
- sig { returns(T.nilable(T.any(::Stripe::Price::ListParams::Created, Integer))) }
216
- attr_accessor :created
217
- # Only return prices for the given currency.
218
- sig { returns(T.nilable(String)) }
219
- attr_accessor :currency
220
- # 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.
221
- sig { returns(T.nilable(String)) }
222
- attr_accessor :ending_before
223
- # Specifies which fields in the response should be expanded.
224
- sig { returns(T.nilable(T::Array[String])) }
225
- attr_accessor :expand
226
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
227
- sig { returns(T.nilable(Integer)) }
228
- attr_accessor :limit
229
- # Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
230
- sig { returns(T.nilable(T::Array[String])) }
231
- attr_accessor :lookup_keys
232
- # Only return prices for the given product.
233
- sig { returns(T.nilable(String)) }
234
- attr_accessor :product
235
- # Only return prices with these recurring fields.
236
- sig { returns(T.nilable(::Stripe::Price::ListParams::Recurring)) }
237
- attr_accessor :recurring
238
- # 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.
239
- sig { returns(T.nilable(String)) }
240
- attr_accessor :starting_after
241
- # Only return prices of type `recurring` or `one_time`.
242
- sig { returns(T.nilable(String)) }
243
- attr_accessor :type
244
- sig {
245
- params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::Price::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::Price::ListParams::Recurring), starting_after: T.nilable(String), type: T.nilable(String)).void
246
- }
247
- def initialize(
248
- active: nil,
249
- created: nil,
250
- currency: nil,
251
- ending_before: nil,
252
- expand: nil,
253
- limit: nil,
254
- lookup_keys: nil,
255
- product: nil,
256
- recurring: nil,
257
- starting_after: nil,
258
- type: nil
259
- ); end
260
- end
261
- class CreateParams < Stripe::RequestParams
262
- class CurrencyOptions < Stripe::RequestParams
263
- class CustomUnitAmount < Stripe::RequestParams
264
- # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
265
- sig { returns(T::Boolean) }
266
- attr_accessor :enabled
267
- # The maximum unit amount the customer can specify for this item.
268
- sig { returns(T.nilable(Integer)) }
269
- attr_accessor :maximum
270
- # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
271
- sig { returns(T.nilable(Integer)) }
272
- attr_accessor :minimum
273
- # The starting unit amount which can be updated by the customer.
274
- sig { returns(T.nilable(Integer)) }
275
- attr_accessor :preset
276
- sig {
277
- params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
278
- }
279
- def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
280
- end
281
- class Tier < Stripe::RequestParams
282
- # The flat billing amount for an entire tier, regardless of the number of units in the tier.
283
- sig { returns(T.nilable(Integer)) }
284
- attr_accessor :flat_amount
285
- # 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.
286
- sig { returns(T.nilable(String)) }
287
- attr_accessor :flat_amount_decimal
288
- # The per unit billing amount for each individual unit for which this tier applies.
289
- sig { returns(T.nilable(Integer)) }
290
- attr_accessor :unit_amount
291
- # 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.
292
- sig { returns(T.nilable(String)) }
293
- attr_accessor :unit_amount_decimal
294
- # 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.
295
- sig { returns(T.any(String, Integer)) }
296
- attr_accessor :up_to
297
- sig {
298
- 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
299
- }
300
- def initialize(
301
- flat_amount: nil,
302
- flat_amount_decimal: nil,
303
- unit_amount: nil,
304
- unit_amount_decimal: nil,
305
- up_to: nil
306
- ); end
307
- end
308
- # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
309
- sig { returns(T.nilable(::Stripe::Price::CreateParams::CurrencyOptions::CustomUnitAmount)) }
310
- attr_accessor :custom_unit_amount
311
- # 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.
312
- sig { returns(T.nilable(String)) }
313
- attr_accessor :tax_behavior
314
- # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
315
- sig { returns(T.nilable(T::Array[::Stripe::Price::CreateParams::CurrencyOptions::Tier])) }
316
- attr_accessor :tiers
317
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
318
- sig { returns(T.nilable(Integer)) }
319
- attr_accessor :unit_amount
320
- # 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.
321
- sig { returns(T.nilable(String)) }
322
- attr_accessor :unit_amount_decimal
323
- sig {
324
- params(custom_unit_amount: T.nilable(::Stripe::Price::CreateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::Price::CreateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
325
- }
326
- def initialize(
327
- custom_unit_amount: nil,
328
- tax_behavior: nil,
329
- tiers: nil,
330
- unit_amount: nil,
331
- unit_amount_decimal: nil
332
- ); end
333
- end
334
- class CustomUnitAmount < Stripe::RequestParams
335
- # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
336
- sig { returns(T::Boolean) }
337
- attr_accessor :enabled
338
- # The maximum unit amount the customer can specify for this item.
339
- sig { returns(T.nilable(Integer)) }
340
- attr_accessor :maximum
341
- # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
342
- sig { returns(T.nilable(Integer)) }
343
- attr_accessor :minimum
344
- # The starting unit amount which can be updated by the customer.
345
- sig { returns(T.nilable(Integer)) }
346
- attr_accessor :preset
347
- sig {
348
- params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
349
- }
350
- def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
351
- end
352
- class ProductData < Stripe::RequestParams
353
- # Whether the product is currently available for purchase. Defaults to `true`.
354
- sig { returns(T.nilable(T::Boolean)) }
355
- attr_accessor :active
356
- # The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
357
- sig { returns(T.nilable(String)) }
358
- attr_accessor :id
359
- # 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`.
360
- sig { returns(T.nilable(T::Hash[String, String])) }
361
- attr_accessor :metadata
362
- # The product's name, meant to be displayable to the customer.
363
- sig { returns(String) }
364
- attr_accessor :name
365
- # 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.
366
- #
367
- # 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.
368
- sig { returns(T.nilable(String)) }
369
- attr_accessor :statement_descriptor
370
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
371
- sig { returns(T.nilable(String)) }
372
- attr_accessor :tax_code
373
- # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
374
- sig { returns(T.nilable(String)) }
375
- attr_accessor :unit_label
376
- sig {
377
- 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
378
- }
379
- def initialize(
380
- active: nil,
381
- id: nil,
382
- metadata: nil,
383
- name: nil,
384
- statement_descriptor: nil,
385
- tax_code: nil,
386
- unit_label: nil
387
- ); end
388
- end
389
- class Recurring < Stripe::RequestParams
390
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
391
- sig { returns(String) }
392
- attr_accessor :interval
393
- # 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).
394
- sig { returns(T.nilable(Integer)) }
395
- attr_accessor :interval_count
396
- # The meter tracking the usage of a metered price
397
- sig { returns(T.nilable(String)) }
398
- attr_accessor :meter
399
- # 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).
400
- sig { returns(T.nilable(Integer)) }
401
- attr_accessor :trial_period_days
402
- # 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`.
403
- sig { returns(T.nilable(String)) }
404
- attr_accessor :usage_type
405
- sig {
406
- params(interval: String, interval_count: T.nilable(Integer), meter: T.nilable(String), trial_period_days: T.nilable(Integer), usage_type: T.nilable(String)).void
407
- }
408
- def initialize(
409
- interval: nil,
410
- interval_count: nil,
411
- meter: nil,
412
- trial_period_days: nil,
413
- usage_type: nil
414
- ); end
415
- end
416
- class Tier < Stripe::RequestParams
417
- # The flat billing amount for an entire tier, regardless of the number of units in the tier.
418
- sig { returns(T.nilable(Integer)) }
419
- attr_accessor :flat_amount
420
- # 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.
421
- sig { returns(T.nilable(String)) }
422
- attr_accessor :flat_amount_decimal
423
- # The per unit billing amount for each individual unit for which this tier applies.
424
- sig { returns(T.nilable(Integer)) }
425
- attr_accessor :unit_amount
426
- # 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.
427
- sig { returns(T.nilable(String)) }
428
- attr_accessor :unit_amount_decimal
429
- # 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.
430
- sig { returns(T.any(String, Integer)) }
431
- attr_accessor :up_to
432
- sig {
433
- 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
434
- }
435
- def initialize(
436
- flat_amount: nil,
437
- flat_amount_decimal: nil,
438
- unit_amount: nil,
439
- unit_amount_decimal: nil,
440
- up_to: nil
441
- ); end
442
- end
443
- class TransformQuantity < Stripe::RequestParams
444
- # Divide usage by this number.
445
- sig { returns(Integer) }
446
- attr_accessor :divide_by
447
- # After division, either round the result `up` or `down`.
448
- sig { returns(String) }
449
- attr_accessor :round
450
- sig { params(divide_by: Integer, round: String).void }
451
- def initialize(divide_by: nil, round: nil); end
452
- end
453
- # Whether the price can be used for new purchases. Defaults to `true`.
454
- sig { returns(T.nilable(T::Boolean)) }
455
- attr_accessor :active
456
- # 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.
457
- sig { returns(T.nilable(String)) }
458
- attr_accessor :billing_scheme
459
- # 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).
460
- sig { returns(String) }
461
- attr_accessor :currency
462
- # 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).
463
- sig { returns(T.nilable(T::Hash[String, ::Stripe::Price::CreateParams::CurrencyOptions])) }
464
- attr_accessor :currency_options
465
- # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
466
- sig { returns(T.nilable(::Stripe::Price::CreateParams::CustomUnitAmount)) }
467
- attr_accessor :custom_unit_amount
468
- # Specifies which fields in the response should be expanded.
469
- sig { returns(T.nilable(T::Array[String])) }
470
- attr_accessor :expand
471
- # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
472
- sig { returns(T.nilable(String)) }
473
- attr_accessor :lookup_key
474
- # 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`.
475
- sig { returns(T.nilable(T::Hash[String, String])) }
476
- attr_accessor :metadata
477
- # A brief description of the price, hidden from customers.
478
- sig { returns(T.nilable(String)) }
479
- attr_accessor :nickname
480
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
481
- sig { returns(T.nilable(String)) }
482
- attr_accessor :product
483
- # These fields can be used to create a new product that this price will belong to.
484
- sig { returns(T.nilable(::Stripe::Price::CreateParams::ProductData)) }
485
- attr_accessor :product_data
486
- # The recurring components of a price such as `interval` and `usage_type`.
487
- sig { returns(T.nilable(::Stripe::Price::CreateParams::Recurring)) }
488
- attr_accessor :recurring
489
- # 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.
490
- sig { returns(T.nilable(String)) }
491
- attr_accessor :tax_behavior
492
- # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
493
- sig { returns(T.nilable(T::Array[::Stripe::Price::CreateParams::Tier])) }
494
- attr_accessor :tiers
495
- # 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.
496
- sig { returns(T.nilable(String)) }
497
- attr_accessor :tiers_mode
498
- # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
499
- sig { returns(T.nilable(T::Boolean)) }
500
- attr_accessor :transfer_lookup_key
501
- # Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
502
- sig { returns(T.nilable(::Stripe::Price::CreateParams::TransformQuantity)) }
503
- attr_accessor :transform_quantity
504
- # 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`.
505
- sig { returns(T.nilable(Integer)) }
506
- attr_accessor :unit_amount
507
- # 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.
508
- sig { returns(T.nilable(String)) }
509
- attr_accessor :unit_amount_decimal
510
- sig {
511
- params(active: T.nilable(T::Boolean), billing_scheme: T.nilable(String), currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Price::CreateParams::CurrencyOptions]), custom_unit_amount: T.nilable(::Stripe::Price::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::Price::CreateParams::ProductData), recurring: T.nilable(::Stripe::Price::CreateParams::Recurring), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::Price::CreateParams::Tier]), tiers_mode: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean), transform_quantity: T.nilable(::Stripe::Price::CreateParams::TransformQuantity), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
512
- }
513
- def initialize(
514
- active: nil,
515
- billing_scheme: nil,
516
- currency: nil,
517
- currency_options: nil,
518
- custom_unit_amount: nil,
519
- expand: nil,
520
- lookup_key: nil,
521
- metadata: nil,
522
- nickname: nil,
523
- product: nil,
524
- product_data: nil,
525
- recurring: nil,
526
- tax_behavior: nil,
527
- tiers: nil,
528
- tiers_mode: nil,
529
- transfer_lookup_key: nil,
530
- transform_quantity: nil,
531
- unit_amount: nil,
532
- unit_amount_decimal: nil
533
- ); end
534
- end
535
- class UpdateParams < Stripe::RequestParams
536
- class CurrencyOptions < Stripe::RequestParams
537
- class CustomUnitAmount < Stripe::RequestParams
538
- # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
539
- sig { returns(T::Boolean) }
540
- attr_accessor :enabled
541
- # The maximum unit amount the customer can specify for this item.
542
- sig { returns(T.nilable(Integer)) }
543
- attr_accessor :maximum
544
- # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
545
- sig { returns(T.nilable(Integer)) }
546
- attr_accessor :minimum
547
- # The starting unit amount which can be updated by the customer.
548
- sig { returns(T.nilable(Integer)) }
549
- attr_accessor :preset
550
- sig {
551
- params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
552
- }
553
- def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
554
- end
555
- class Tier < Stripe::RequestParams
556
- # The flat billing amount for an entire tier, regardless of the number of units in the tier.
557
- sig { returns(T.nilable(Integer)) }
558
- attr_accessor :flat_amount
559
- # 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.
560
- sig { returns(T.nilable(String)) }
561
- attr_accessor :flat_amount_decimal
562
- # The per unit billing amount for each individual unit for which this tier applies.
563
- sig { returns(T.nilable(Integer)) }
564
- attr_accessor :unit_amount
565
- # 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.
566
- sig { returns(T.nilable(String)) }
567
- attr_accessor :unit_amount_decimal
568
- # 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.
569
- sig { returns(T.any(String, Integer)) }
570
- attr_accessor :up_to
571
- sig {
572
- 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
573
- }
574
- def initialize(
575
- flat_amount: nil,
576
- flat_amount_decimal: nil,
577
- unit_amount: nil,
578
- unit_amount_decimal: nil,
579
- up_to: nil
580
- ); end
581
- end
582
- # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
583
- sig { returns(T.nilable(::Stripe::Price::UpdateParams::CurrencyOptions::CustomUnitAmount)) }
584
- attr_accessor :custom_unit_amount
585
- # 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.
586
- sig { returns(T.nilable(String)) }
587
- attr_accessor :tax_behavior
588
- # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
589
- sig { returns(T.nilable(T::Array[::Stripe::Price::UpdateParams::CurrencyOptions::Tier])) }
590
- attr_accessor :tiers
591
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
592
- sig { returns(T.nilable(Integer)) }
593
- attr_accessor :unit_amount
594
- # 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.
595
- sig { returns(T.nilable(String)) }
596
- attr_accessor :unit_amount_decimal
597
- sig {
598
- params(custom_unit_amount: T.nilable(::Stripe::Price::UpdateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::Price::UpdateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
599
- }
600
- def initialize(
601
- custom_unit_amount: nil,
602
- tax_behavior: nil,
603
- tiers: nil,
604
- unit_amount: nil,
605
- unit_amount_decimal: nil
606
- ); end
607
- end
608
- # Whether the price can be used for new purchases. Defaults to `true`.
609
- sig { returns(T.nilable(T::Boolean)) }
610
- attr_accessor :active
611
- # 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).
612
- sig {
613
- returns(T.nilable(T.nilable(T.any(String, T::Hash[String, ::Stripe::Price::UpdateParams::CurrencyOptions]))))
614
- }
615
- attr_accessor :currency_options
616
- # Specifies which fields in the response should be expanded.
617
- sig { returns(T.nilable(T::Array[String])) }
618
- attr_accessor :expand
619
- # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
620
- sig { returns(T.nilable(String)) }
621
- attr_accessor :lookup_key
622
- # 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`.
623
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
624
- attr_accessor :metadata
625
- # A brief description of the price, hidden from customers.
626
- sig { returns(T.nilable(String)) }
627
- attr_accessor :nickname
628
- # 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.
629
- sig { returns(T.nilable(String)) }
630
- attr_accessor :tax_behavior
631
- # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
632
- sig { returns(T.nilable(T::Boolean)) }
633
- attr_accessor :transfer_lookup_key
634
- sig {
635
- params(active: T.nilable(T::Boolean), currency_options: T.nilable(T.nilable(T.any(String, T::Hash[String, ::Stripe::Price::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
636
- }
637
- def initialize(
638
- active: nil,
639
- currency_options: nil,
640
- expand: nil,
641
- lookup_key: nil,
642
- metadata: nil,
643
- nickname: nil,
644
- tax_behavior: nil,
645
- transfer_lookup_key: nil
646
- ); end
647
- end
648
- class SearchParams < Stripe::RequestParams
649
- # Specifies which fields in the response should be expanded.
650
- sig { returns(T.nilable(T::Array[String])) }
651
- attr_accessor :expand
652
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
653
- sig { returns(T.nilable(Integer)) }
654
- attr_accessor :limit
655
- # 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.
656
- sig { returns(T.nilable(String)) }
657
- attr_accessor :page
658
- # 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).
659
- sig { returns(String) }
660
- attr_accessor :query
661
- sig {
662
- params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
663
- }
664
- def initialize(expand: nil, limit: nil, page: nil, query: nil); end
665
- end
666
- # 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.
667
- sig {
668
- params(params: T.any(::Stripe::Price::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
669
- }
670
- def self.create(params = {}, opts = {}); end
671
-
672
- # Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
673
- sig {
674
- params(params: T.any(::Stripe::Price::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
675
- }
676
- def self.list(params = {}, opts = {}); end
677
-
678
- sig {
679
- params(params: T.any(::Stripe::Price::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
680
- }
681
- def self.search(params = {}, opts = {}); end
682
-
683
- sig {
684
- params(params: T.any(::Stripe::Price::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
685
- }
686
- def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
687
-
688
- # Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
689
- sig {
690
- params(price: String, params: T.any(::Stripe::Price::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
691
- }
692
- def self.update(price, params = {}, opts = {}); end
693
- end
694
- end