stripe 14.0.1 → 14.1.0.pre.beta.1

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 (568) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1512 -672
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/data/ca-certificates.crt +3340 -290
  6. data/lib/stripe/api_requestor.rb +28 -0
  7. data/lib/stripe/api_version.rb +1 -1
  8. data/lib/stripe/errors.rb +54 -0
  9. data/lib/stripe/event_types.rb +75 -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_identity_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  19. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  20. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  21. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  22. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  23. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  24. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  25. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  26. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  42. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  50. data/lib/stripe/object_types.rb +48 -0
  51. data/lib/stripe/request_signing_authenticator.rb +79 -0
  52. data/lib/stripe/resources/account.rb +653 -1
  53. data/lib/stripe/resources/account_notice.rb +123 -0
  54. data/lib/stripe/resources/account_session.rb +247 -1
  55. data/lib/stripe/resources/balance_settings.rb +101 -0
  56. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  57. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  58. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  59. data/lib/stripe/resources/billing/meter_error_report.rb +59 -0
  60. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  61. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  62. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  63. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  64. data/lib/stripe/resources/card.rb +2 -0
  65. data/lib/stripe/resources/cash_balance.rb +2 -0
  66. data/lib/stripe/resources/charge.rb +1454 -0
  67. data/lib/stripe/resources/checkout/session.rb +260 -4
  68. data/lib/stripe/resources/confirmation_token.rb +234 -0
  69. data/lib/stripe/resources/coupon.rb +1 -1
  70. data/lib/stripe/resources/credit_note.rb +10 -0
  71. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  72. data/lib/stripe/resources/customer.rb +2 -0
  73. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  74. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  75. data/lib/stripe/resources/customer_session.rb +6 -1
  76. data/lib/stripe/resources/discount.rb +2 -0
  77. data/lib/stripe/resources/event.rb +33 -0
  78. data/lib/stripe/resources/financial_connections/account.rb +20 -1
  79. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  80. data/lib/stripe/resources/financial_connections/institution.rb +90 -0
  81. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  82. data/lib/stripe/resources/gift_cards/card.rb +208 -0
  83. data/lib/stripe/resources/gift_cards/transaction.rb +272 -0
  84. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  85. data/lib/stripe/resources/invoice.rb +1176 -16
  86. data/lib/stripe/resources/invoice_item.rb +78 -2
  87. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  88. data/lib/stripe/resources/invoice_payment.rb +2 -53
  89. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  90. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  91. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  92. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  93. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  94. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  95. data/lib/stripe/resources/line_item.rb +37 -0
  96. data/lib/stripe/resources/mandate.rb +24 -0
  97. data/lib/stripe/resources/margin.rb +115 -0
  98. data/lib/stripe/resources/order.rb +2859 -0
  99. data/lib/stripe/resources/payment_attempt_record.rb +1078 -0
  100. data/lib/stripe/resources/payment_intent.rb +5233 -431
  101. data/lib/stripe/resources/payment_method.rb +196 -1
  102. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  103. data/lib/stripe/resources/payment_record.rb +1607 -0
  104. data/lib/stripe/resources/payout.rb +6 -0
  105. data/lib/stripe/resources/price.rb +30 -0
  106. data/lib/stripe/resources/product.rb +59 -0
  107. data/lib/stripe/resources/promotion_code.rb +10 -0
  108. data/lib/stripe/resources/quote.rb +2042 -6
  109. data/lib/stripe/resources/quote_line.rb +274 -0
  110. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  111. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +337 -0
  112. data/lib/stripe/resources/refund.rb +9 -0
  113. data/lib/stripe/resources/setup_attempt.rb +21 -0
  114. data/lib/stripe/resources/setup_intent.rb +596 -9
  115. data/lib/stripe/resources/source.rb +29 -0
  116. data/lib/stripe/resources/subscription.rb +292 -9
  117. data/lib/stripe/resources/subscription_item.rb +84 -3
  118. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  119. data/lib/stripe/resources/tax/association.rb +89 -0
  120. data/lib/stripe/resources/tax/form.rb +211 -0
  121. data/lib/stripe/resources/tax_id.rb +12 -2
  122. data/lib/stripe/resources/terminal/reader.rb +406 -0
  123. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  124. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  125. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  126. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  127. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  128. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  129. data/lib/stripe/resources/v2/core/account.rb +1715 -0
  130. data/lib/stripe/resources/v2/core/account_link.rb +54 -0
  131. data/lib/stripe/resources/v2/core/person.rb +272 -0
  132. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +72 -0
  133. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +37 -0
  134. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +18 -0
  135. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +20 -0
  136. data/lib/stripe/resources/v2/money_management/adjustment.rb +49 -0
  137. data/lib/stripe/resources/v2/money_management/financial_account.rb +56 -0
  138. data/lib/stripe/resources/v2/money_management/financial_address.rb +66 -0
  139. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +92 -0
  140. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +127 -0
  141. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +74 -0
  142. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +43 -0
  143. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +115 -0
  144. data/lib/stripe/resources/v2/money_management/payout_method.rb +73 -0
  145. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +47 -0
  146. data/lib/stripe/resources/v2/money_management/received_credit.rb +134 -0
  147. data/lib/stripe/resources/v2/money_management/received_debit.rb +106 -0
  148. data/lib/stripe/resources/v2/money_management/transaction.rb +76 -0
  149. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +66 -0
  150. data/lib/stripe/resources.rb +85 -0
  151. data/lib/stripe/services/account_notice_service.rb +101 -0
  152. data/lib/stripe/services/account_service.rb +562 -1
  153. data/lib/stripe/services/account_session_service.rb +217 -1
  154. data/lib/stripe/services/balance_settings_service.rb +96 -0
  155. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  156. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  157. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  158. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  159. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  160. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  161. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  162. data/lib/stripe/services/capital_service.rb +15 -0
  163. data/lib/stripe/services/charge_service.rb +1334 -0
  164. data/lib/stripe/services/checkout/session_service.rb +172 -2
  165. data/lib/stripe/services/credit_note_service.rb +4 -0
  166. data/lib/stripe/services/customer_session_service.rb +4 -1
  167. data/lib/stripe/services/external_account_service.rb +206 -0
  168. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  169. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  170. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  171. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  172. data/lib/stripe/services/financial_connections_service.rb +2 -1
  173. data/lib/stripe/services/gift_cards/card_service.rb +170 -0
  174. data/lib/stripe/services/gift_cards/transaction_service.rb +209 -0
  175. data/lib/stripe/services/gift_cards_service.rb +14 -0
  176. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  177. data/lib/stripe/services/invoice_item_service.rb +74 -2
  178. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  179. data/lib/stripe/services/invoice_payment_service.rb +5 -33
  180. data/lib/stripe/services/invoice_service.rb +1088 -17
  181. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  182. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  183. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  184. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  185. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  186. data/lib/stripe/services/issuing_service.rb +5 -1
  187. data/lib/stripe/services/margin_service.rb +119 -0
  188. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  189. data/lib/stripe/services/order_service.rb +2268 -0
  190. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  191. data/lib/stripe/services/payment_intent_service.rb +4625 -252
  192. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  193. data/lib/stripe/services/payment_method_service.rb +126 -1
  194. data/lib/stripe/services/payment_record_service.rb +542 -0
  195. data/lib/stripe/services/payout_service.rb +4 -0
  196. data/lib/stripe/services/price_service.rb +19 -0
  197. data/lib/stripe/services/product_service.rb +38 -0
  198. data/lib/stripe/services/promotion_code_service.rb +8 -0
  199. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  200. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  201. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_subscription_schedule_service.rb} +20 -16
  202. data/lib/stripe/services/quote_service.rb +1726 -7
  203. data/lib/stripe/services/setup_intent_service.rb +556 -9
  204. data/lib/stripe/services/subscription_item_service.rb +75 -3
  205. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  206. data/lib/stripe/services/subscription_service.rb +253 -9
  207. data/lib/stripe/services/tax/association_service.rb +31 -0
  208. data/lib/stripe/services/tax/form_service.rb +100 -0
  209. data/lib/stripe/services/tax_id_service.rb +8 -2
  210. data/lib/stripe/services/tax_service.rb +3 -1
  211. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  212. data/lib/stripe/services/terminal/reader_service.rb +180 -0
  213. data/lib/stripe/services/terminal_service.rb +2 -1
  214. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +148 -0
  215. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +43 -0
  216. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  217. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  218. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  219. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  220. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  221. data/lib/stripe/services/v1_services.rb +10 -2
  222. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  223. data/lib/stripe/services/v2/core/account_service.rb +4130 -0
  224. data/lib/stripe/services/v2/core/accounts/person_service.rb +1040 -0
  225. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +135 -0
  226. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +109 -0
  227. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  228. data/lib/stripe/services/v2/core_service.rb +4 -1
  229. data/lib/stripe/services/v2/money_management/adjustment_service.rb +75 -0
  230. data/lib/stripe/services/v2/money_management/financial_account_service.rb +44 -0
  231. data/lib/stripe/services/v2/money_management/financial_address_service.rb +81 -0
  232. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +126 -0
  233. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +80 -0
  234. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +202 -0
  235. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +237 -0
  236. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +174 -0
  237. data/lib/stripe/services/v2/money_management/payout_method_service.rb +95 -0
  238. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  239. data/lib/stripe/services/v2/money_management/received_credit_service.rb +71 -0
  240. data/lib/stripe/services/v2/money_management/received_debit_service.rb +44 -0
  241. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +70 -0
  242. data/lib/stripe/services/v2/money_management/transaction_service.rb +74 -0
  243. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  244. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  245. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +50 -0
  246. data/lib/stripe/services/v2_services.rb +4 -2
  247. data/lib/stripe/services.rb +49 -0
  248. data/lib/stripe/stripe_configuration.rb +3 -1
  249. data/lib/stripe/util.rb +7 -1
  250. data/lib/stripe/version.rb +1 -1
  251. data/lib/stripe.rb +55 -0
  252. data/rbi/stripe.rbi +189274 -0
  253. data/stripe.gemspec +4 -1
  254. metadata +143 -327
  255. data/rbi/stripe/resources/account.rbi +0 -4840
  256. data/rbi/stripe/resources/account_link.rbi +0 -74
  257. data/rbi/stripe/resources/account_session.rbi +0 -894
  258. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -90
  259. data/rbi/stripe/resources/application.rbi +0 -20
  260. data/rbi/stripe/resources/application_fee.rbi +0 -118
  261. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  262. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  263. data/rbi/stripe/resources/balance.rbi +0 -180
  264. data/rbi/stripe/resources/balance_transaction.rbi +0 -144
  265. data/rbi/stripe/resources/bank_account.rbi +0 -127
  266. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  267. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  268. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  269. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  270. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  271. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  272. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  273. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  274. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  275. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  276. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  277. data/rbi/stripe/resources/capability.rbi +0 -125
  278. data/rbi/stripe/resources/card.rbi +0 -125
  279. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  280. data/rbi/stripe/resources/charge.rbi +0 -2054
  281. data/rbi/stripe/resources/checkout/session.rbi +0 -3951
  282. data/rbi/stripe/resources/climate/order.rbi +0 -245
  283. data/rbi/stripe/resources/climate/product.rbi +0 -75
  284. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  285. data/rbi/stripe/resources/confirmation_token.rbi +0 -1793
  286. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  287. data/rbi/stripe/resources/country_spec.rbi +0 -85
  288. data/rbi/stripe/resources/coupon.rbi +0 -252
  289. data/rbi/stripe/resources/credit_note.rbi +0 -747
  290. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  291. data/rbi/stripe/resources/customer.rbi +0 -1009
  292. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  293. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  294. data/rbi/stripe/resources/customer_session.rbi +0 -200
  295. data/rbi/stripe/resources/discount.rbi +0 -53
  296. data/rbi/stripe/resources/dispute.rbi +0 -761
  297. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  298. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  299. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  300. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  301. data/rbi/stripe/resources/event.rbi +0 -146
  302. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  303. data/rbi/stripe/resources/file.rbi +0 -143
  304. data/rbi/stripe/resources/file_link.rbi +0 -141
  305. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  306. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  307. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  308. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  309. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  310. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  311. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  312. data/rbi/stripe/resources/identity/verification_report.rbi +0 -351
  313. data/rbi/stripe/resources/identity/verification_session.rbi +0 -517
  314. data/rbi/stripe/resources/invoice.rbi +0 -3733
  315. data/rbi/stripe/resources/invoice_item.rbi +0 -475
  316. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  317. data/rbi/stripe/resources/invoice_payment.rbi +0 -114
  318. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  319. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  320. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  321. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  322. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  323. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  324. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  325. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  326. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  327. data/rbi/stripe/resources/line_item.rbi +0 -72
  328. data/rbi/stripe/resources/login_link.rbi +0 -18
  329. data/rbi/stripe/resources/mandate.rbi +0 -187
  330. data/rbi/stripe/resources/payment_intent.rbi +0 -9731
  331. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  332. data/rbi/stripe/resources/payment_method.rbi +0 -1822
  333. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3154
  334. data/rbi/stripe/resources/payment_method_domain.rbi +0 -212
  335. data/rbi/stripe/resources/payout.rbi +0 -300
  336. data/rbi/stripe/resources/person.rbi +0 -371
  337. data/rbi/stripe/resources/plan.rbi +0 -373
  338. data/rbi/stripe/resources/price.rbi +0 -694
  339. data/rbi/stripe/resources/product.rbi +0 -557
  340. data/rbi/stripe/resources/product_feature.rbi +0 -26
  341. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  342. data/rbi/stripe/resources/quote.rbi +0 -1123
  343. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  344. data/rbi/stripe/resources/radar/value_list.rbi +0 -170
  345. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -131
  346. data/rbi/stripe/resources/refund.rbi +0 -516
  347. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  348. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  349. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  350. data/rbi/stripe/resources/reversal.rbi +0 -51
  351. data/rbi/stripe/resources/review.rbi +0 -154
  352. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  353. data/rbi/stripe/resources/setup_intent.rbi +0 -3860
  354. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  355. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  356. data/rbi/stripe/resources/source.rbi +0 -1496
  357. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  358. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  359. data/rbi/stripe/resources/subscription.rbi +0 -1964
  360. data/rbi/stripe/resources/subscription_item.rbi +0 -370
  361. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1495
  362. data/rbi/stripe/resources/tax/calculation.rbi +0 -474
  363. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -88
  364. data/rbi/stripe/resources/tax/registration.rbi +0 -2485
  365. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  366. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  367. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  368. data/rbi/stripe/resources/tax_code.rbi +0 -44
  369. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  370. data/rbi/stripe/resources/tax_id.rbi +0 -167
  371. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  372. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1388
  373. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  374. data/rbi/stripe/resources/terminal/location.rbi +0 -224
  375. data/rbi/stripe/resources/terminal/reader.rbi +0 -587
  376. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -134
  377. data/rbi/stripe/resources/token.rbi +0 -1217
  378. data/rbi/stripe/resources/topup.rbi +0 -222
  379. data/rbi/stripe/resources/transfer.rbi +0 -199
  380. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  381. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  382. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -865
  383. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  384. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  385. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  386. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  387. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  388. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  389. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  390. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  391. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  392. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  393. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  394. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  395. data/rbi/stripe/resources/v2/event.rbi +0 -48
  396. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  397. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -170
  398. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  399. data/rbi/stripe/services/account_external_account_service.rbi +0 -306
  400. data/rbi/stripe/services/account_link_service.rbi +0 -58
  401. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  402. data/rbi/stripe/services/account_person_service.rbi +0 -923
  403. data/rbi/stripe/services/account_service.rbi +0 -4143
  404. data/rbi/stripe/services/account_session_service.rbi +0 -572
  405. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -78
  406. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  407. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  408. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  409. data/rbi/stripe/services/apps_service.rbi +0 -9
  410. data/rbi/stripe/services/balance_service.rbi +0 -21
  411. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  412. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  413. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  414. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  415. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  416. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  417. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  418. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  419. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  420. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  421. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  422. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  423. data/rbi/stripe/services/billing_service.rbi +0 -15
  424. data/rbi/stripe/services/charge_service.rbi +0 -448
  425. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  426. data/rbi/stripe/services/checkout/session_service.rbi +0 -2585
  427. data/rbi/stripe/services/checkout_service.rbi +0 -9
  428. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  429. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  430. data/rbi/stripe/services/climate_service.rbi +0 -11
  431. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  432. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  433. data/rbi/stripe/services/coupon_service.rbi +0 -196
  434. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  435. data/rbi/stripe/services/credit_note_service.rbi +0 -416
  436. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  437. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  438. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  439. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  440. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  441. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  442. data/rbi/stripe/services/customer_service.rbi +0 -651
  443. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  444. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -72
  445. data/rbi/stripe/services/dispute_service.rbi +0 -424
  446. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  447. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  448. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  449. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  450. data/rbi/stripe/services/event_service.rbi +0 -83
  451. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  452. data/rbi/stripe/services/file_link_service.rbi +0 -124
  453. data/rbi/stripe/services/file_service.rbi +0 -116
  454. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  455. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  456. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  457. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  458. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  459. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  460. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  461. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  462. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -323
  463. data/rbi/stripe/services/identity_service.rbi +0 -10
  464. data/rbi/stripe/services/invoice_item_service.rbi +0 -368
  465. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  466. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  467. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  468. data/rbi/stripe/services/invoice_service.rbi +0 -2920
  469. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  470. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  471. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  472. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  473. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  474. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  475. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  476. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  477. data/rbi/stripe/services/issuing_service.rbi +0 -16
  478. data/rbi/stripe/services/mandate_service.rbi +0 -20
  479. data/rbi/stripe/services/payment_intent_service.rbi +0 -7759
  480. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  481. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2211
  482. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  483. data/rbi/stripe/services/payment_method_service.rbi +0 -840
  484. data/rbi/stripe/services/payout_service.rbi +0 -205
  485. data/rbi/stripe/services/plan_service.rbi +0 -284
  486. data/rbi/stripe/services/price_service.rbi +0 -546
  487. data/rbi/stripe/services/product_feature_service.rbi +0 -69
  488. data/rbi/stripe/services/product_service.rbi +0 -479
  489. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  490. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  491. data/rbi/stripe/services/quote_service.rbi +0 -686
  492. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  493. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -111
  494. data/rbi/stripe/services/radar/value_list_service.rbi +0 -143
  495. data/rbi/stripe/services/radar_service.rbi +0 -11
  496. data/rbi/stripe/services/refund_service.rbi +0 -185
  497. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  498. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  499. data/rbi/stripe/services/reporting_service.rbi +0 -10
  500. data/rbi/stripe/services/review_service.rbi +0 -84
  501. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  502. data/rbi/stripe/services/setup_intent_service.rbi +0 -3596
  503. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  504. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  505. data/rbi/stripe/services/sigma_service.rbi +0 -9
  506. data/rbi/stripe/services/source_service.rbi +0 -663
  507. data/rbi/stripe/services/subscription_item_service.rbi +0 -324
  508. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1192
  509. data/rbi/stripe/services/subscription_service.rbi +0 -1596
  510. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -33
  511. data/rbi/stripe/services/tax/calculation_service.rbi +0 -230
  512. data/rbi/stripe/services/tax/registration_service.rbi +0 -1689
  513. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  514. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  515. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  516. data/rbi/stripe/services/tax_id_service.rbi +0 -112
  517. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  518. data/rbi/stripe/services/tax_service.rbi +0 -12
  519. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1120
  520. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  521. data/rbi/stripe/services/terminal/location_service.rbi +0 -184
  522. data/rbi/stripe/services/terminal/reader_service.rbi +0 -344
  523. data/rbi/stripe/services/terminal_service.rbi +0 -12
  524. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  525. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  526. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  527. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  528. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  529. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  530. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  531. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  532. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -62
  533. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  534. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -92
  535. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  536. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  537. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  538. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  539. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  540. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  541. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  542. data/rbi/stripe/services/token_service.rbi +0 -1189
  543. data/rbi/stripe/services/topup_service.rbi +0 -176
  544. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  545. data/rbi/stripe/services/transfer_service.rbi +0 -152
  546. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  547. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  548. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  549. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -562
  550. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  551. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  552. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  553. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  554. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  555. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  556. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  557. data/rbi/stripe/services/treasury_service.rbi +0 -18
  558. data/rbi/stripe/services/v1_services.rbi +0 -77
  559. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  560. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  561. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -20
  562. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  563. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  564. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -200
  565. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  566. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  567. data/rbi/stripe/services/v2_services.rbi +0 -10
  568. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -131
@@ -1,373 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
7
- #
8
- # Plans define the base price, currency, and billing cycle for recurring purchases of products.
9
- # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
10
- #
11
- # For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
12
- #
13
- # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).
14
- class Plan < APIResource
15
- class Tier < Stripe::StripeObject
16
- # Price for the entire tier.
17
- sig { returns(T.nilable(Integer)) }
18
- attr_reader :flat_amount
19
- # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
20
- sig { returns(T.nilable(String)) }
21
- attr_reader :flat_amount_decimal
22
- # Per unit price for units relevant to the tier.
23
- sig { returns(T.nilable(Integer)) }
24
- attr_reader :unit_amount
25
- # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
26
- sig { returns(T.nilable(String)) }
27
- attr_reader :unit_amount_decimal
28
- # Up to and including to this quantity will be contained in the tier.
29
- sig { returns(T.nilable(Integer)) }
30
- attr_reader :up_to
31
- end
32
- class TransformUsage < Stripe::StripeObject
33
- # Divide usage by this number.
34
- sig { returns(Integer) }
35
- attr_reader :divide_by
36
- # After division, either round the result `up` or `down`.
37
- sig { returns(String) }
38
- attr_reader :round
39
- end
40
- # Whether the plan can be used for new purchases.
41
- sig { returns(T::Boolean) }
42
- attr_reader :active
43
- # 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`.
44
- sig { returns(T.nilable(Integer)) }
45
- attr_reader :amount
46
- # 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`.
47
- sig { returns(T.nilable(String)) }
48
- attr_reader :amount_decimal
49
- # Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans 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.
50
- sig { returns(String) }
51
- attr_reader :billing_scheme
52
- # Time at which the object was created. Measured in seconds since the Unix epoch.
53
- sig { returns(Integer) }
54
- attr_reader :created
55
- # 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).
56
- sig { returns(String) }
57
- attr_reader :currency
58
- # Unique identifier for the object.
59
- sig { returns(String) }
60
- attr_reader :id
61
- # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
62
- sig { returns(String) }
63
- attr_reader :interval
64
- # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
65
- sig { returns(Integer) }
66
- attr_reader :interval_count
67
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
68
- sig { returns(T::Boolean) }
69
- attr_reader :livemode
70
- # 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.
71
- sig { returns(T.nilable(T::Hash[String, String])) }
72
- attr_reader :metadata
73
- # The meter tracking the usage of a metered price
74
- sig { returns(T.nilable(String)) }
75
- attr_reader :meter
76
- # A brief description of the plan, hidden from customers.
77
- sig { returns(T.nilable(String)) }
78
- attr_reader :nickname
79
- # String representing the object's type. Objects of the same type share the same value.
80
- sig { returns(String) }
81
- attr_reader :object
82
- # The product whose pricing this plan determines.
83
- sig { returns(T.nilable(T.any(String, Stripe::Product))) }
84
- attr_reader :product
85
- # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
86
- sig { returns(T::Array[Tier]) }
87
- attr_reader :tiers
88
- # 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.
89
- sig { returns(T.nilable(String)) }
90
- attr_reader :tiers_mode
91
- # Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
92
- sig { returns(T.nilable(TransformUsage)) }
93
- attr_reader :transform_usage
94
- # Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
95
- sig { returns(T.nilable(Integer)) }
96
- attr_reader :trial_period_days
97
- # 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`.
98
- sig { returns(String) }
99
- attr_reader :usage_type
100
- # Always true for a deleted object
101
- sig { returns(T::Boolean) }
102
- attr_reader :deleted
103
- class DeleteParams < Stripe::RequestParams
104
-
105
- end
106
- class UpdateParams < Stripe::RequestParams
107
- # Whether the plan is currently available for new subscriptions.
108
- sig { returns(T.nilable(T::Boolean)) }
109
- attr_accessor :active
110
- # Specifies which fields in the response should be expanded.
111
- sig { returns(T.nilable(T::Array[String])) }
112
- attr_accessor :expand
113
- # 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`.
114
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
115
- attr_accessor :metadata
116
- # A brief description of the plan, hidden from customers.
117
- sig { returns(T.nilable(String)) }
118
- attr_accessor :nickname
119
- # The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.
120
- sig { returns(T.nilable(String)) }
121
- attr_accessor :product
122
- # Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
123
- sig { returns(T.nilable(Integer)) }
124
- attr_accessor :trial_period_days
125
- sig {
126
- params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), nickname: T.nilable(String), product: T.nilable(String), trial_period_days: T.nilable(Integer)).void
127
- }
128
- def initialize(
129
- active: nil,
130
- expand: nil,
131
- metadata: nil,
132
- nickname: nil,
133
- product: nil,
134
- trial_period_days: nil
135
- ); end
136
- end
137
- class ListParams < Stripe::RequestParams
138
- class Created < Stripe::RequestParams
139
- # Minimum value to filter by (exclusive)
140
- sig { returns(T.nilable(Integer)) }
141
- attr_accessor :gt
142
- # Minimum value to filter by (inclusive)
143
- sig { returns(T.nilable(Integer)) }
144
- attr_accessor :gte
145
- # Maximum value to filter by (exclusive)
146
- sig { returns(T.nilable(Integer)) }
147
- attr_accessor :lt
148
- # Maximum value to filter by (inclusive)
149
- sig { returns(T.nilable(Integer)) }
150
- attr_accessor :lte
151
- sig {
152
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
153
- }
154
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
155
- end
156
- # Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).
157
- sig { returns(T.nilable(T::Boolean)) }
158
- attr_accessor :active
159
- # 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.
160
- sig { returns(T.nilable(T.any(::Stripe::Plan::ListParams::Created, Integer))) }
161
- attr_accessor :created
162
- # 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.
163
- sig { returns(T.nilable(String)) }
164
- attr_accessor :ending_before
165
- # Specifies which fields in the response should be expanded.
166
- sig { returns(T.nilable(T::Array[String])) }
167
- attr_accessor :expand
168
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
169
- sig { returns(T.nilable(Integer)) }
170
- attr_accessor :limit
171
- # Only return plans for the given product.
172
- sig { returns(T.nilable(String)) }
173
- attr_accessor :product
174
- # 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.
175
- sig { returns(T.nilable(String)) }
176
- attr_accessor :starting_after
177
- sig {
178
- params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::Plan::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), product: T.nilable(String), starting_after: T.nilable(String)).void
179
- }
180
- def initialize(
181
- active: nil,
182
- created: nil,
183
- ending_before: nil,
184
- expand: nil,
185
- limit: nil,
186
- product: nil,
187
- starting_after: nil
188
- ); end
189
- end
190
- class CreateParams < Stripe::RequestParams
191
- class Product < Stripe::RequestParams
192
- # Whether the product is currently available for purchase. Defaults to `true`.
193
- sig { returns(T.nilable(T::Boolean)) }
194
- attr_accessor :active
195
- # The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
196
- sig { returns(T.nilable(String)) }
197
- attr_accessor :id
198
- # 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`.
199
- sig { returns(T.nilable(T::Hash[String, String])) }
200
- attr_accessor :metadata
201
- # The product's name, meant to be displayable to the customer.
202
- sig { returns(String) }
203
- attr_accessor :name
204
- # 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.
205
- #
206
- # 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.
207
- sig { returns(T.nilable(String)) }
208
- attr_accessor :statement_descriptor
209
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
210
- sig { returns(T.nilable(String)) }
211
- attr_accessor :tax_code
212
- # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
213
- sig { returns(T.nilable(String)) }
214
- attr_accessor :unit_label
215
- sig {
216
- 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
217
- }
218
- def initialize(
219
- active: nil,
220
- id: nil,
221
- metadata: nil,
222
- name: nil,
223
- statement_descriptor: nil,
224
- tax_code: nil,
225
- unit_label: nil
226
- ); end
227
- end
228
- class Tier < Stripe::RequestParams
229
- # The flat billing amount for an entire tier, regardless of the number of units in the tier.
230
- sig { returns(T.nilable(Integer)) }
231
- attr_accessor :flat_amount
232
- # 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.
233
- sig { returns(T.nilable(String)) }
234
- attr_accessor :flat_amount_decimal
235
- # The per unit billing amount for each individual unit for which this tier applies.
236
- sig { returns(T.nilable(Integer)) }
237
- attr_accessor :unit_amount
238
- # 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.
239
- sig { returns(T.nilable(String)) }
240
- attr_accessor :unit_amount_decimal
241
- # 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.
242
- sig { returns(T.any(String, Integer)) }
243
- attr_accessor :up_to
244
- sig {
245
- 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
246
- }
247
- def initialize(
248
- flat_amount: nil,
249
- flat_amount_decimal: nil,
250
- unit_amount: nil,
251
- unit_amount_decimal: nil,
252
- up_to: nil
253
- ); end
254
- end
255
- class TransformUsage < Stripe::RequestParams
256
- # Divide usage by this number.
257
- sig { returns(Integer) }
258
- attr_accessor :divide_by
259
- # After division, either round the result `up` or `down`.
260
- sig { returns(String) }
261
- attr_accessor :round
262
- sig { params(divide_by: Integer, round: String).void }
263
- def initialize(divide_by: nil, round: nil); end
264
- end
265
- # Whether the plan is currently available for new subscriptions. Defaults to `true`.
266
- sig { returns(T.nilable(T::Boolean)) }
267
- attr_accessor :active
268
- # A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.
269
- sig { returns(T.nilable(Integer)) }
270
- attr_accessor :amount
271
- # Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.
272
- sig { returns(T.nilable(String)) }
273
- attr_accessor :amount_decimal
274
- # Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans 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.
275
- sig { returns(T.nilable(String)) }
276
- attr_accessor :billing_scheme
277
- # 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).
278
- sig { returns(String) }
279
- attr_accessor :currency
280
- # Specifies which fields in the response should be expanded.
281
- sig { returns(T.nilable(T::Array[String])) }
282
- attr_accessor :expand
283
- # An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.
284
- sig { returns(T.nilable(String)) }
285
- attr_accessor :id
286
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
287
- sig { returns(String) }
288
- attr_accessor :interval
289
- # 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).
290
- sig { returns(T.nilable(Integer)) }
291
- attr_accessor :interval_count
292
- # 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`.
293
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
294
- attr_accessor :metadata
295
- # The meter tracking the usage of a metered price
296
- sig { returns(T.nilable(String)) }
297
- attr_accessor :meter
298
- # A brief description of the plan, hidden from customers.
299
- sig { returns(T.nilable(String)) }
300
- attr_accessor :nickname
301
- # Attribute for param field product
302
- sig { returns(T.nilable(T.any(::Stripe::Plan::CreateParams::Product, String))) }
303
- attr_accessor :product
304
- # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
305
- sig { returns(T.nilable(T::Array[::Stripe::Plan::CreateParams::Tier])) }
306
- attr_accessor :tiers
307
- # 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.
308
- sig { returns(T.nilable(String)) }
309
- attr_accessor :tiers_mode
310
- # Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
311
- sig { returns(T.nilable(::Stripe::Plan::CreateParams::TransformUsage)) }
312
- attr_accessor :transform_usage
313
- # Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
314
- sig { returns(T.nilable(Integer)) }
315
- attr_accessor :trial_period_days
316
- # 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`.
317
- sig { returns(T.nilable(String)) }
318
- attr_accessor :usage_type
319
- sig {
320
- params(active: T.nilable(T::Boolean), amount: T.nilable(Integer), amount_decimal: T.nilable(String), billing_scheme: T.nilable(String), currency: String, expand: T.nilable(T::Array[String]), id: T.nilable(String), interval: String, interval_count: T.nilable(Integer), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), meter: T.nilable(String), nickname: T.nilable(String), product: T.nilable(T.any(::Stripe::Plan::CreateParams::Product, String)), tiers: T.nilable(T::Array[::Stripe::Plan::CreateParams::Tier]), tiers_mode: T.nilable(String), transform_usage: T.nilable(::Stripe::Plan::CreateParams::TransformUsage), trial_period_days: T.nilable(Integer), usage_type: T.nilable(String)).void
321
- }
322
- def initialize(
323
- active: nil,
324
- amount: nil,
325
- amount_decimal: nil,
326
- billing_scheme: nil,
327
- currency: nil,
328
- expand: nil,
329
- id: nil,
330
- interval: nil,
331
- interval_count: nil,
332
- metadata: nil,
333
- meter: nil,
334
- nickname: nil,
335
- product: nil,
336
- tiers: nil,
337
- tiers_mode: nil,
338
- transform_usage: nil,
339
- trial_period_days: nil,
340
- usage_type: nil
341
- ); end
342
- end
343
- # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
344
- sig {
345
- params(params: T.any(::Stripe::Plan::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
346
- }
347
- def self.create(params = {}, opts = {}); end
348
-
349
- # Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
350
- sig {
351
- params(plan: String, params: T.any(::Stripe::Plan::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
352
- }
353
- def self.delete(plan, params = {}, opts = {}); end
354
-
355
- # Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
356
- sig {
357
- params(params: T.any(::Stripe::Plan::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
358
- }
359
- def delete(params = {}, opts = {}); end
360
-
361
- # Returns a list of your plans.
362
- sig {
363
- params(params: T.any(::Stripe::Plan::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
364
- }
365
- def self.list(params = {}, opts = {}); end
366
-
367
- # Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan's ID, amount, currency, or billing cycle.
368
- sig {
369
- params(plan: String, params: T.any(::Stripe::Plan::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan)
370
- }
371
- def self.update(plan, params = {}, opts = {}); end
372
- end
373
- end