stripe 15.4.0 → 15.5.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 (597) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +1639 -662
  4. data/OPENAPI_VERSION +1 -1
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_requestor.rb +32 -0
  7. data/lib/stripe/api_version.rb +1 -2
  8. data/lib/stripe/errors.rb +60 -0
  9. data/lib/stripe/event_types.rb +102 -0
  10. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  17. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +23 -0
  19. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  21. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  22. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  23. data/lib/stripe/events/v2_core_account_link_returned_event.rb +13 -0
  24. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  25. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  26. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  27. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_payout_method_updated_event.rb +21 -0
  52. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  53. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  58. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  59. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  60. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  61. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  62. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +22 -0
  65. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  66. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  67. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  68. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  69. data/lib/stripe/object_types.rb +53 -0
  70. data/lib/stripe/resources/account.rb +653 -1
  71. data/lib/stripe/resources/account_notice.rb +123 -0
  72. data/lib/stripe/resources/account_session.rb +256 -1
  73. data/lib/stripe/resources/balance_settings.rb +105 -0
  74. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  75. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  76. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  77. data/lib/stripe/resources/billing/meter_usage.rb +23 -0
  78. data/lib/stripe/resources/billing/meter_usage_row.rb +28 -0
  79. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  80. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  81. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  82. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  83. data/lib/stripe/resources/card.rb +2 -0
  84. data/lib/stripe/resources/cash_balance.rb +2 -0
  85. data/lib/stripe/resources/charge.rb +1538 -0
  86. data/lib/stripe/resources/checkout/session.rb +399 -3
  87. data/lib/stripe/resources/confirmation_token.rb +170 -0
  88. data/lib/stripe/resources/coupon.rb +30 -1
  89. data/lib/stripe/resources/credit_note.rb +6 -0
  90. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  91. data/lib/stripe/resources/customer.rb +2 -0
  92. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  93. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  94. data/lib/stripe/resources/customer_session.rb +6 -1
  95. data/lib/stripe/resources/discount.rb +2 -0
  96. data/lib/stripe/resources/dispute.rb +11 -0
  97. data/lib/stripe/resources/event.rb +31 -0
  98. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  99. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  100. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  101. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  102. data/lib/stripe/resources/fx_quote.rb +186 -0
  103. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  104. data/lib/stripe/resources/invoice.rb +1140 -16
  105. data/lib/stripe/resources/invoice_item.rb +78 -2
  106. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  107. data/lib/stripe/resources/invoice_payment.rb +6 -1
  108. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  109. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  110. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  111. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  112. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  113. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  114. data/lib/stripe/resources/line_item.rb +37 -0
  115. data/lib/stripe/resources/mandate.rb +24 -0
  116. data/lib/stripe/resources/margin.rb +115 -0
  117. data/lib/stripe/resources/order.rb +2958 -0
  118. data/lib/stripe/resources/payment_attempt_record.rb +1101 -0
  119. data/lib/stripe/resources/payment_intent.rb +9469 -3712
  120. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  121. data/lib/stripe/resources/payment_method.rb +192 -1
  122. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  123. data/lib/stripe/resources/payment_record.rb +1630 -0
  124. data/lib/stripe/resources/payout.rb +6 -0
  125. data/lib/stripe/resources/price.rb +30 -0
  126. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  127. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  128. data/lib/stripe/resources/promotion_code.rb +10 -0
  129. data/lib/stripe/resources/quote.rb +2038 -7
  130. data/lib/stripe/resources/quote_line.rb +274 -0
  131. data/lib/stripe/resources/quote_preview_invoice.rb +680 -0
  132. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +371 -0
  133. data/lib/stripe/resources/refund.rb +9 -0
  134. data/lib/stripe/resources/setup_attempt.rb +21 -0
  135. data/lib/stripe/resources/setup_intent.rb +578 -9
  136. data/lib/stripe/resources/source.rb +29 -0
  137. data/lib/stripe/resources/subscription.rb +365 -9
  138. data/lib/stripe/resources/subscription_item.rb +84 -3
  139. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  140. data/lib/stripe/resources/tax/association.rb +66 -0
  141. data/lib/stripe/resources/tax/form.rb +211 -0
  142. data/lib/stripe/resources/tax_id.rb +12 -2
  143. data/lib/stripe/resources/terminal/onboarding_link.rb +84 -0
  144. data/lib/stripe/resources/terminal/reader.rb +8 -0
  145. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  146. data/lib/stripe/resources/transfer.rb +6 -0
  147. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  148. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  149. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  150. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  151. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  152. data/lib/stripe/resources/v2/core/account.rb +1930 -0
  153. data/lib/stripe/resources/v2/core/account_link.rb +72 -0
  154. data/lib/stripe/resources/v2/core/person.rb +276 -0
  155. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  156. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  157. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  158. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  159. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  160. data/lib/stripe/resources/v2/money_management/financial_account.rb +77 -0
  161. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  162. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  163. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  164. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  165. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  166. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  167. data/lib/stripe/resources/v2/money_management/payout_method.rb +77 -0
  168. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  169. data/lib/stripe/resources/v2/money_management/received_credit.rb +122 -0
  170. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  171. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  172. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  173. data/lib/stripe/resources/v2/payments/off_session_payment.rb +89 -0
  174. data/lib/stripe/resources.rb +109 -0
  175. data/lib/stripe/services/account_notice_service.rb +101 -0
  176. data/lib/stripe/services/account_service.rb +562 -1
  177. data/lib/stripe/services/account_session_service.rb +226 -1
  178. data/lib/stripe/services/balance_settings_service.rb +96 -0
  179. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  180. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  181. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  182. data/lib/stripe/services/billing/meter_usage_service.rb +76 -0
  183. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  184. data/lib/stripe/services/billing_service.rb +2 -1
  185. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  186. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  187. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  188. data/lib/stripe/services/capital_service.rb +15 -0
  189. data/lib/stripe/services/charge_service.rb +1418 -0
  190. data/lib/stripe/services/checkout/session_service.rb +316 -3
  191. data/lib/stripe/services/coupon_service.rb +17 -1
  192. data/lib/stripe/services/credit_note_service.rb +4 -0
  193. data/lib/stripe/services/customer_session_service.rb +4 -1
  194. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  195. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  196. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  197. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  198. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  199. data/lib/stripe/services/financial_connections_service.rb +2 -1
  200. data/lib/stripe/services/fx_quote_service.rb +123 -0
  201. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  202. data/lib/stripe/services/invoice_item_service.rb +74 -2
  203. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  204. data/lib/stripe/services/invoice_payment_service.rb +4 -1
  205. data/lib/stripe/services/invoice_service.rb +1074 -16
  206. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  207. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  208. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  209. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  210. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  211. data/lib/stripe/services/issuing_service.rb +5 -1
  212. data/lib/stripe/services/margin_service.rb +119 -0
  213. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  214. data/lib/stripe/services/order_service.rb +2388 -0
  215. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  216. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  217. data/lib/stripe/services/payment_intent_service.rb +5724 -435
  218. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  219. data/lib/stripe/services/payment_method_service.rb +120 -1
  220. data/lib/stripe/services/payment_record_service.rb +542 -0
  221. data/lib/stripe/services/payout_service.rb +4 -0
  222. data/lib/stripe/services/price_service.rb +19 -0
  223. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  224. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  225. data/lib/stripe/services/privacy_service.rb +13 -0
  226. data/lib/stripe/services/promotion_code_service.rb +8 -0
  227. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  228. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  229. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  230. data/lib/stripe/services/quote_service.rb +1723 -8
  231. data/lib/stripe/services/setup_intent_service.rb +538 -9
  232. data/lib/stripe/services/subscription_item_service.rb +75 -3
  233. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  234. data/lib/stripe/services/subscription_service.rb +309 -9
  235. data/lib/stripe/services/tax/association_service.rb +31 -0
  236. data/lib/stripe/services/tax/form_service.rb +100 -0
  237. data/lib/stripe/services/tax_id_service.rb +8 -2
  238. data/lib/stripe/services/tax_service.rb +3 -1
  239. data/lib/stripe/services/terminal/onboarding_link_service.rb +56 -0
  240. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  241. data/lib/stripe/services/terminal_service.rb +3 -1
  242. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  243. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  244. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  245. data/lib/stripe/services/transfer_service.rb +4 -0
  246. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  247. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  248. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  249. data/lib/stripe/services/v1_services.rb +11 -1
  250. data/lib/stripe/services/v2/core/account_link_service.rb +114 -0
  251. data/lib/stripe/services/v2/core/account_service.rb +4522 -0
  252. data/lib/stripe/services/v2/core/accounts/person_service.rb +1045 -0
  253. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +130 -0
  254. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  255. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  256. data/lib/stripe/services/v2/core_service.rb +4 -1
  257. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  258. data/lib/stripe/services/v2/money_management/financial_account_service.rb +116 -0
  259. data/lib/stripe/services/v2/money_management/financial_address_service.rb +82 -0
  260. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  261. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  262. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +199 -0
  263. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  264. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  265. data/lib/stripe/services/v2/money_management/payout_method_service.rb +90 -0
  266. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  267. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  268. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  269. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  270. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  271. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  272. data/lib/stripe/services/v2/payment_service.rb +15 -0
  273. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +152 -0
  274. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  275. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +53 -0
  276. data/lib/stripe/services/v2_services.rb +4 -1
  277. data/lib/stripe/services.rb +55 -0
  278. data/lib/stripe/stripe_configuration.rb +3 -1
  279. data/lib/stripe/stripe_object.rb +1 -1
  280. data/lib/stripe/util.rb +7 -1
  281. data/lib/stripe/version.rb +1 -1
  282. data/lib/stripe.rb +53 -0
  283. data/rbi/stripe.rbi +199145 -0
  284. data/stripe.gemspec +4 -1
  285. metadata +169 -324
  286. data/rbi/stripe/resources/account.rbi +0 -4995
  287. data/rbi/stripe/resources/account_link.rbi +0 -76
  288. data/rbi/stripe/resources/account_session.rbi +0 -1074
  289. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  290. data/rbi/stripe/resources/application.rbi +0 -20
  291. data/rbi/stripe/resources/application_fee.rbi +0 -118
  292. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  293. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  294. data/rbi/stripe/resources/balance.rbi +0 -235
  295. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  296. data/rbi/stripe/resources/bank_account.rbi +0 -127
  297. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  298. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  299. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  300. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  301. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  302. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  303. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  304. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  305. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  306. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -703
  307. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  308. data/rbi/stripe/resources/capability.rbi +0 -125
  309. data/rbi/stripe/resources/card.rbi +0 -125
  310. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  311. data/rbi/stripe/resources/charge.rbi +0 -2089
  312. data/rbi/stripe/resources/checkout/session.rbi +0 -4095
  313. data/rbi/stripe/resources/climate/order.rbi +0 -245
  314. data/rbi/stripe/resources/climate/product.rbi +0 -75
  315. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  316. data/rbi/stripe/resources/confirmation_token.rbi +0 -1818
  317. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  318. data/rbi/stripe/resources/country_spec.rbi +0 -85
  319. data/rbi/stripe/resources/coupon.rbi +0 -250
  320. data/rbi/stripe/resources/credit_note.rbi +0 -752
  321. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  322. data/rbi/stripe/resources/customer.rbi +0 -1005
  323. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  324. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  325. data/rbi/stripe/resources/customer_session.rbi +0 -200
  326. data/rbi/stripe/resources/discount.rbi +0 -53
  327. data/rbi/stripe/resources/dispute.rbi +0 -761
  328. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  329. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  330. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  331. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  332. data/rbi/stripe/resources/event.rbi +0 -137
  333. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  334. data/rbi/stripe/resources/file.rbi +0 -143
  335. data/rbi/stripe/resources/file_link.rbi +0 -141
  336. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  337. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  338. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  339. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  340. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  341. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  342. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  343. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  344. data/rbi/stripe/resources/identity/verification_session.rbi +0 -564
  345. data/rbi/stripe/resources/invoice.rbi +0 -3858
  346. data/rbi/stripe/resources/invoice_item.rbi +0 -470
  347. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  348. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  349. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  350. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  351. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  352. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  353. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  354. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  355. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  356. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  357. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  358. data/rbi/stripe/resources/line_item.rbi +0 -72
  359. data/rbi/stripe/resources/login_link.rbi +0 -19
  360. data/rbi/stripe/resources/mandate.rbi +0 -191
  361. data/rbi/stripe/resources/payment_intent.rbi +0 -9997
  362. data/rbi/stripe/resources/payment_link.rbi +0 -1893
  363. data/rbi/stripe/resources/payment_method.rbi +0 -1770
  364. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  365. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  366. data/rbi/stripe/resources/payout.rbi +0 -300
  367. data/rbi/stripe/resources/person.rbi +0 -401
  368. data/rbi/stripe/resources/plan.rbi +0 -371
  369. data/rbi/stripe/resources/price.rbi +0 -694
  370. data/rbi/stripe/resources/product.rbi +0 -555
  371. data/rbi/stripe/resources/product_feature.rbi +0 -26
  372. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  373. data/rbi/stripe/resources/quote.rbi +0 -1145
  374. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  375. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  376. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  377. data/rbi/stripe/resources/refund.rbi +0 -523
  378. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  379. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  380. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  381. data/rbi/stripe/resources/reversal.rbi +0 -51
  382. data/rbi/stripe/resources/review.rbi +0 -154
  383. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  384. data/rbi/stripe/resources/setup_intent.rbi +0 -3978
  385. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  386. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  387. data/rbi/stripe/resources/source.rbi +0 -1496
  388. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  389. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  390. data/rbi/stripe/resources/subscription.rbi +0 -2080
  391. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  392. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1673
  393. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  394. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  395. data/rbi/stripe/resources/tax/registration.rbi +0 -3216
  396. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  397. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  398. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  399. data/rbi/stripe/resources/tax_code.rbi +0 -44
  400. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  401. data/rbi/stripe/resources/tax_id.rbi +0 -165
  402. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  403. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1595
  404. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  405. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  406. data/rbi/stripe/resources/terminal/reader.rbi +0 -994
  407. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  408. data/rbi/stripe/resources/token.rbi +0 -1283
  409. data/rbi/stripe/resources/topup.rbi +0 -222
  410. data/rbi/stripe/resources/transfer.rbi +0 -199
  411. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  412. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  413. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -869
  414. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  415. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  416. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  417. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  418. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  419. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  420. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  421. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  422. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  423. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  424. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  425. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  426. data/rbi/stripe/resources/v2/event.rbi +0 -48
  427. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  428. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  429. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  430. data/rbi/stripe/services/account_link_service.rbi +0 -60
  431. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  432. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  433. data/rbi/stripe/services/account_service.rbi +0 -4281
  434. data/rbi/stripe/services/account_session_service.rbi +0 -685
  435. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  436. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  437. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  438. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  439. data/rbi/stripe/services/apps_service.rbi +0 -9
  440. data/rbi/stripe/services/balance_service.rbi +0 -21
  441. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  442. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  443. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  444. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  445. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  446. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  447. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  448. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  449. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  450. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -555
  451. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  452. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  453. data/rbi/stripe/services/billing_service.rbi +0 -15
  454. data/rbi/stripe/services/charge_service.rbi +0 -448
  455. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  456. data/rbi/stripe/services/checkout/session_service.rbi +0 -2690
  457. data/rbi/stripe/services/checkout_service.rbi +0 -9
  458. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  459. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  460. data/rbi/stripe/services/climate_service.rbi +0 -11
  461. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  462. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  463. data/rbi/stripe/services/coupon_service.rbi +0 -194
  464. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  465. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  466. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  467. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  468. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  469. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  470. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  471. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  472. data/rbi/stripe/services/customer_service.rbi +0 -647
  473. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  474. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  475. data/rbi/stripe/services/dispute_service.rbi +0 -424
  476. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  477. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  478. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  479. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  480. data/rbi/stripe/services/event_service.rbi +0 -83
  481. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  482. data/rbi/stripe/services/file_link_service.rbi +0 -124
  483. data/rbi/stripe/services/file_service.rbi +0 -116
  484. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  485. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  486. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  487. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  488. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  489. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  490. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  491. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  492. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -339
  493. data/rbi/stripe/services/identity_service.rbi +0 -10
  494. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  495. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  496. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  497. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  498. data/rbi/stripe/services/invoice_service.rbi +0 -3027
  499. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  500. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  501. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  502. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  503. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  504. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  505. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  506. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  507. data/rbi/stripe/services/issuing_service.rbi +0 -16
  508. data/rbi/stripe/services/mandate_service.rbi +0 -20
  509. data/rbi/stripe/services/payment_intent_service.rbi +0 -7994
  510. data/rbi/stripe/services/payment_link_service.rbi +0 -1441
  511. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  512. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  513. data/rbi/stripe/services/payment_method_service.rbi +0 -781
  514. data/rbi/stripe/services/payout_service.rbi +0 -205
  515. data/rbi/stripe/services/plan_service.rbi +0 -282
  516. data/rbi/stripe/services/price_service.rbi +0 -546
  517. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  518. data/rbi/stripe/services/product_service.rbi +0 -477
  519. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  520. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  521. data/rbi/stripe/services/quote_service.rbi +0 -699
  522. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  523. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  524. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  525. data/rbi/stripe/services/radar_service.rbi +0 -11
  526. data/rbi/stripe/services/refund_service.rbi +0 -185
  527. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  528. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  529. data/rbi/stripe/services/reporting_service.rbi +0 -10
  530. data/rbi/stripe/services/review_service.rbi +0 -84
  531. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  532. data/rbi/stripe/services/setup_intent_service.rbi +0 -3709
  533. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  534. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  535. data/rbi/stripe/services/sigma_service.rbi +0 -9
  536. data/rbi/stripe/services/source_service.rbi +0 -663
  537. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  538. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1333
  539. data/rbi/stripe/services/subscription_service.rbi +0 -1684
  540. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  541. data/rbi/stripe/services/tax/registration_service.rbi +0 -2278
  542. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  543. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  544. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  545. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  546. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  547. data/rbi/stripe/services/tax_service.rbi +0 -12
  548. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1286
  549. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  550. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  551. data/rbi/stripe/services/terminal/reader_service.rbi +0 -540
  552. data/rbi/stripe/services/terminal_service.rbi +0 -12
  553. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  554. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  555. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  556. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  557. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  558. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  559. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  560. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  561. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  562. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  563. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  564. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  565. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  566. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  567. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  568. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  569. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  570. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  571. data/rbi/stripe/services/token_service.rbi +0 -1257
  572. data/rbi/stripe/services/topup_service.rbi +0 -176
  573. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  574. data/rbi/stripe/services/transfer_service.rbi +0 -152
  575. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  576. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  577. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  578. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  579. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  580. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  581. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  582. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  583. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  584. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  585. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  586. data/rbi/stripe/services/treasury_service.rbi +0 -18
  587. data/rbi/stripe/services/v1_services.rbi +0 -77
  588. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  589. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  590. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  591. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  592. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  593. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  594. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  595. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  596. data/rbi/stripe/services/v2_services.rbi +0 -10
  597. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,555 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # Products describe the specific goods or services you offer to your customers.
7
- # For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.
8
- # They can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.
9
- #
10
- # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),
11
- # [share a Payment Link](https://stripe.com/docs/payment-links),
12
- # [accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),
13
- # and more about [Products and Prices](https://stripe.com/docs/products-prices/overview)
14
- class Product < APIResource
15
- class MarketingFeature < Stripe::StripeObject
16
- # The marketing feature name. Up to 80 characters long.
17
- sig { returns(String) }
18
- attr_reader :name
19
- end
20
- class PackageDimensions < Stripe::StripeObject
21
- # Height, in inches.
22
- sig { returns(Float) }
23
- attr_reader :height
24
- # Length, in inches.
25
- sig { returns(Float) }
26
- attr_reader :length
27
- # Weight, in ounces.
28
- sig { returns(Float) }
29
- attr_reader :weight
30
- # Width, in inches.
31
- sig { returns(Float) }
32
- attr_reader :width
33
- end
34
- # Whether the product is currently available for purchase.
35
- sig { returns(T::Boolean) }
36
- attr_reader :active
37
- # Time at which the object was created. Measured in seconds since the Unix epoch.
38
- sig { returns(Integer) }
39
- attr_reader :created
40
- # The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
41
- sig { returns(T.nilable(T.any(String, Stripe::Price))) }
42
- attr_reader :default_price
43
- # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
44
- sig { returns(T.nilable(String)) }
45
- attr_reader :description
46
- # Unique identifier for the object.
47
- sig { returns(String) }
48
- attr_reader :id
49
- # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
50
- sig { returns(T::Array[String]) }
51
- attr_reader :images
52
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
53
- sig { returns(T::Boolean) }
54
- attr_reader :livemode
55
- # A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
56
- sig { returns(T::Array[MarketingFeature]) }
57
- attr_reader :marketing_features
58
- # 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.
59
- sig { returns(T::Hash[String, String]) }
60
- attr_reader :metadata
61
- # The product's name, meant to be displayable to the customer.
62
- sig { returns(String) }
63
- attr_reader :name
64
- # String representing the object's type. Objects of the same type share the same value.
65
- sig { returns(String) }
66
- attr_reader :object
67
- # The dimensions of this product for shipping purposes.
68
- sig { returns(T.nilable(PackageDimensions)) }
69
- attr_reader :package_dimensions
70
- # Whether this product is shipped (i.e., physical goods).
71
- sig { returns(T.nilable(T::Boolean)) }
72
- attr_reader :shippable
73
- # Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
74
- sig { returns(T.nilable(String)) }
75
- attr_reader :statement_descriptor
76
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
77
- sig { returns(T.nilable(T.any(String, Stripe::TaxCode))) }
78
- attr_reader :tax_code
79
- # The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.
80
- sig { returns(String) }
81
- attr_reader :type
82
- # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
83
- sig { returns(T.nilable(String)) }
84
- attr_reader :unit_label
85
- # Time at which the object was last updated. Measured in seconds since the Unix epoch.
86
- sig { returns(Integer) }
87
- attr_reader :updated
88
- # A URL of a publicly-accessible webpage for this product.
89
- sig { returns(T.nilable(String)) }
90
- attr_reader :url
91
- # Always true for a deleted object
92
- sig { returns(T::Boolean) }
93
- attr_reader :deleted
94
- class DeleteParams < Stripe::RequestParams; end
95
- class UpdateParams < Stripe::RequestParams
96
- class MarketingFeature < Stripe::RequestParams
97
- # The marketing feature name. Up to 80 characters long.
98
- sig { returns(String) }
99
- attr_accessor :name
100
- sig { params(name: String).void }
101
- def initialize(name: nil); end
102
- end
103
- class PackageDimensions < Stripe::RequestParams
104
- # Height, in inches. Maximum precision is 2 decimal places.
105
- sig { returns(Float) }
106
- attr_accessor :height
107
- # Length, in inches. Maximum precision is 2 decimal places.
108
- sig { returns(Float) }
109
- attr_accessor :length
110
- # Weight, in ounces. Maximum precision is 2 decimal places.
111
- sig { returns(Float) }
112
- attr_accessor :weight
113
- # Width, in inches. Maximum precision is 2 decimal places.
114
- sig { returns(Float) }
115
- attr_accessor :width
116
- sig { params(height: Float, length: Float, weight: Float, width: Float).void }
117
- def initialize(height: nil, length: nil, weight: nil, width: nil); end
118
- end
119
- # Whether the product is available for purchase.
120
- sig { returns(T.nilable(T::Boolean)) }
121
- attr_accessor :active
122
- # The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
123
- sig { returns(T.nilable(String)) }
124
- attr_accessor :default_price
125
- # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
126
- sig { returns(T.nilable(T.nilable(String))) }
127
- attr_accessor :description
128
- # Specifies which fields in the response should be expanded.
129
- sig { returns(T.nilable(T::Array[String])) }
130
- attr_accessor :expand
131
- # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
132
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
133
- attr_accessor :images
134
- # A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
135
- sig {
136
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Product::UpdateParams::MarketingFeature]))))
137
- }
138
- attr_accessor :marketing_features
139
- # 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`.
140
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
141
- attr_accessor :metadata
142
- # The product's name, meant to be displayable to the customer.
143
- sig { returns(T.nilable(String)) }
144
- attr_accessor :name
145
- # The dimensions of this product for shipping purposes.
146
- sig {
147
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Product::UpdateParams::PackageDimensions))))
148
- }
149
- attr_accessor :package_dimensions
150
- # Whether this product is shipped (i.e., physical goods).
151
- sig { returns(T.nilable(T::Boolean)) }
152
- attr_accessor :shippable
153
- # 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.
154
- #
155
- # 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.
156
- # It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments.
157
- sig { returns(T.nilable(String)) }
158
- attr_accessor :statement_descriptor
159
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
160
- sig { returns(T.nilable(T.nilable(String))) }
161
- attr_accessor :tax_code
162
- # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`.
163
- sig { returns(T.nilable(T.nilable(String))) }
164
- attr_accessor :unit_label
165
- # A URL of a publicly-accessible webpage for this product.
166
- sig { returns(T.nilable(T.nilable(String))) }
167
- attr_accessor :url
168
- sig {
169
- params(active: T.nilable(T::Boolean), default_price: T.nilable(String), description: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), images: T.nilable(T.nilable(T.any(String, T::Array[String]))), marketing_features: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Product::UpdateParams::MarketingFeature]))), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), name: T.nilable(String), package_dimensions: T.nilable(T.nilable(T.any(String, ::Stripe::Product::UpdateParams::PackageDimensions))), shippable: T.nilable(T::Boolean), statement_descriptor: T.nilable(String), tax_code: T.nilable(T.nilable(String)), unit_label: T.nilable(T.nilable(String)), url: T.nilable(T.nilable(String))).void
170
- }
171
- def initialize(
172
- active: nil,
173
- default_price: nil,
174
- description: nil,
175
- expand: nil,
176
- images: nil,
177
- marketing_features: nil,
178
- metadata: nil,
179
- name: nil,
180
- package_dimensions: nil,
181
- shippable: nil,
182
- statement_descriptor: nil,
183
- tax_code: nil,
184
- unit_label: nil,
185
- url: nil
186
- ); end
187
- end
188
- class ListParams < Stripe::RequestParams
189
- class Created < Stripe::RequestParams
190
- # Minimum value to filter by (exclusive)
191
- sig { returns(T.nilable(Integer)) }
192
- attr_accessor :gt
193
- # Minimum value to filter by (inclusive)
194
- sig { returns(T.nilable(Integer)) }
195
- attr_accessor :gte
196
- # Maximum value to filter by (exclusive)
197
- sig { returns(T.nilable(Integer)) }
198
- attr_accessor :lt
199
- # Maximum value to filter by (inclusive)
200
- sig { returns(T.nilable(Integer)) }
201
- attr_accessor :lte
202
- sig {
203
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
204
- }
205
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
206
- end
207
- # Only return products that are active or inactive (e.g., pass `false` to list all inactive products).
208
- sig { returns(T.nilable(T::Boolean)) }
209
- attr_accessor :active
210
- # Only return products that were created during the given date interval.
211
- sig { returns(T.nilable(T.any(::Stripe::Product::ListParams::Created, Integer))) }
212
- attr_accessor :created
213
- # 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.
214
- sig { returns(T.nilable(String)) }
215
- attr_accessor :ending_before
216
- # Specifies which fields in the response should be expanded.
217
- sig { returns(T.nilable(T::Array[String])) }
218
- attr_accessor :expand
219
- # Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).
220
- sig { returns(T.nilable(T::Array[String])) }
221
- attr_accessor :ids
222
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
223
- sig { returns(T.nilable(Integer)) }
224
- attr_accessor :limit
225
- # Only return products that can be shipped (i.e., physical, not digital products).
226
- sig { returns(T.nilable(T::Boolean)) }
227
- attr_accessor :shippable
228
- # 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.
229
- sig { returns(T.nilable(String)) }
230
- attr_accessor :starting_after
231
- # Only return products of this type.
232
- sig { returns(T.nilable(String)) }
233
- attr_accessor :type
234
- # Only return products with the given url.
235
- sig { returns(T.nilable(String)) }
236
- attr_accessor :url
237
- sig {
238
- params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::Product::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), ids: T.nilable(T::Array[String]), limit: T.nilable(Integer), shippable: T.nilable(T::Boolean), starting_after: T.nilable(String), type: T.nilable(String), url: T.nilable(String)).void
239
- }
240
- def initialize(
241
- active: nil,
242
- created: nil,
243
- ending_before: nil,
244
- expand: nil,
245
- ids: nil,
246
- limit: nil,
247
- shippable: nil,
248
- starting_after: nil,
249
- type: nil,
250
- url: nil
251
- ); end
252
- end
253
- class CreateParams < Stripe::RequestParams
254
- class DefaultPriceData < Stripe::RequestParams
255
- class CurrencyOptions < Stripe::RequestParams
256
- class CustomUnitAmount < Stripe::RequestParams
257
- # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
258
- sig { returns(T::Boolean) }
259
- attr_accessor :enabled
260
- # The maximum unit amount the customer can specify for this item.
261
- sig { returns(T.nilable(Integer)) }
262
- attr_accessor :maximum
263
- # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
264
- sig { returns(T.nilable(Integer)) }
265
- attr_accessor :minimum
266
- # The starting unit amount which can be updated by the customer.
267
- sig { returns(T.nilable(Integer)) }
268
- attr_accessor :preset
269
- sig {
270
- params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
271
- }
272
- def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
273
- end
274
- class Tier < Stripe::RequestParams
275
- # The flat billing amount for an entire tier, regardless of the number of units in the tier.
276
- sig { returns(T.nilable(Integer)) }
277
- attr_accessor :flat_amount
278
- # 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.
279
- sig { returns(T.nilable(String)) }
280
- attr_accessor :flat_amount_decimal
281
- # The per unit billing amount for each individual unit for which this tier applies.
282
- sig { returns(T.nilable(Integer)) }
283
- attr_accessor :unit_amount
284
- # 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.
285
- sig { returns(T.nilable(String)) }
286
- attr_accessor :unit_amount_decimal
287
- # 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.
288
- sig { returns(T.any(String, Integer)) }
289
- attr_accessor :up_to
290
- sig {
291
- 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
292
- }
293
- def initialize(
294
- flat_amount: nil,
295
- flat_amount_decimal: nil,
296
- unit_amount: nil,
297
- unit_amount_decimal: nil,
298
- up_to: nil
299
- ); end
300
- end
301
- # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
302
- sig {
303
- returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount))
304
- }
305
- attr_accessor :custom_unit_amount
306
- # 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.
307
- sig { returns(T.nilable(String)) }
308
- attr_accessor :tax_behavior
309
- # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
310
- sig {
311
- returns(T.nilable(T::Array[::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::Tier]))
312
- }
313
- attr_accessor :tiers
314
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
315
- sig { returns(T.nilable(Integer)) }
316
- attr_accessor :unit_amount
317
- # 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.
318
- sig { returns(T.nilable(String)) }
319
- attr_accessor :unit_amount_decimal
320
- sig {
321
- params(custom_unit_amount: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
322
- }
323
- def initialize(
324
- custom_unit_amount: nil,
325
- tax_behavior: nil,
326
- tiers: nil,
327
- unit_amount: nil,
328
- unit_amount_decimal: nil
329
- ); end
330
- end
331
- class CustomUnitAmount < Stripe::RequestParams
332
- # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
333
- sig { returns(T::Boolean) }
334
- attr_accessor :enabled
335
- # The maximum unit amount the customer can specify for this item.
336
- sig { returns(T.nilable(Integer)) }
337
- attr_accessor :maximum
338
- # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
339
- sig { returns(T.nilable(Integer)) }
340
- attr_accessor :minimum
341
- # The starting unit amount which can be updated by the customer.
342
- sig { returns(T.nilable(Integer)) }
343
- attr_accessor :preset
344
- sig {
345
- params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
346
- }
347
- def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
348
- end
349
- class Recurring < Stripe::RequestParams
350
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
351
- sig { returns(String) }
352
- attr_accessor :interval
353
- # 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).
354
- sig { returns(T.nilable(Integer)) }
355
- attr_accessor :interval_count
356
- sig { params(interval: String, interval_count: T.nilable(Integer)).void }
357
- def initialize(interval: nil, interval_count: nil); end
358
- end
359
- # 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).
360
- sig { returns(String) }
361
- attr_accessor :currency
362
- # 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).
363
- sig {
364
- returns(T.nilable(T::Hash[String, ::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions]))
365
- }
366
- attr_accessor :currency_options
367
- # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
368
- sig {
369
- returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CustomUnitAmount))
370
- }
371
- attr_accessor :custom_unit_amount
372
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
373
- sig { returns(T.nilable(T::Hash[String, String])) }
374
- attr_accessor :metadata
375
- # The recurring components of a price such as `interval` and `interval_count`.
376
- sig { returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::Recurring)) }
377
- attr_accessor :recurring
378
- # 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.
379
- sig { returns(T.nilable(String)) }
380
- attr_accessor :tax_behavior
381
- # 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.
382
- sig { returns(T.nilable(Integer)) }
383
- attr_accessor :unit_amount
384
- # 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.
385
- sig { returns(T.nilable(String)) }
386
- attr_accessor :unit_amount_decimal
387
- sig {
388
- params(currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions]), custom_unit_amount: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::CustomUnitAmount), metadata: T.nilable(T::Hash[String, String]), recurring: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
389
- }
390
- def initialize(
391
- currency: nil,
392
- currency_options: nil,
393
- custom_unit_amount: nil,
394
- metadata: nil,
395
- recurring: nil,
396
- tax_behavior: nil,
397
- unit_amount: nil,
398
- unit_amount_decimal: nil
399
- ); end
400
- end
401
- class MarketingFeature < Stripe::RequestParams
402
- # The marketing feature name. Up to 80 characters long.
403
- sig { returns(String) }
404
- attr_accessor :name
405
- sig { params(name: String).void }
406
- def initialize(name: nil); end
407
- end
408
- class PackageDimensions < Stripe::RequestParams
409
- # Height, in inches. Maximum precision is 2 decimal places.
410
- sig { returns(Float) }
411
- attr_accessor :height
412
- # Length, in inches. Maximum precision is 2 decimal places.
413
- sig { returns(Float) }
414
- attr_accessor :length
415
- # Weight, in ounces. Maximum precision is 2 decimal places.
416
- sig { returns(Float) }
417
- attr_accessor :weight
418
- # Width, in inches. Maximum precision is 2 decimal places.
419
- sig { returns(Float) }
420
- attr_accessor :width
421
- sig { params(height: Float, length: Float, weight: Float, width: Float).void }
422
- def initialize(height: nil, length: nil, weight: nil, width: nil); end
423
- end
424
- # Whether the product is currently available for purchase. Defaults to `true`.
425
- sig { returns(T.nilable(T::Boolean)) }
426
- attr_accessor :active
427
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.
428
- sig { returns(T.nilable(::Stripe::Product::CreateParams::DefaultPriceData)) }
429
- attr_accessor :default_price_data
430
- # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
431
- sig { returns(T.nilable(String)) }
432
- attr_accessor :description
433
- # Specifies which fields in the response should be expanded.
434
- sig { returns(T.nilable(T::Array[String])) }
435
- attr_accessor :expand
436
- # An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.
437
- sig { returns(T.nilable(String)) }
438
- attr_accessor :id
439
- # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
440
- sig { returns(T.nilable(T::Array[String])) }
441
- attr_accessor :images
442
- # A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
443
- sig { returns(T.nilable(T::Array[::Stripe::Product::CreateParams::MarketingFeature])) }
444
- attr_accessor :marketing_features
445
- # 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`.
446
- sig { returns(T.nilable(T::Hash[String, String])) }
447
- attr_accessor :metadata
448
- # The product's name, meant to be displayable to the customer.
449
- sig { returns(String) }
450
- attr_accessor :name
451
- # The dimensions of this product for shipping purposes.
452
- sig { returns(T.nilable(::Stripe::Product::CreateParams::PackageDimensions)) }
453
- attr_accessor :package_dimensions
454
- # Whether this product is shipped (i.e., physical goods).
455
- sig { returns(T.nilable(T::Boolean)) }
456
- attr_accessor :shippable
457
- # 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.
458
- #
459
- # 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.
460
- # It must contain at least one letter. Only used for subscription payments.
461
- sig { returns(T.nilable(String)) }
462
- attr_accessor :statement_descriptor
463
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
464
- sig { returns(T.nilable(String)) }
465
- attr_accessor :tax_code
466
- # The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.
467
- sig { returns(T.nilable(String)) }
468
- attr_accessor :type
469
- # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
470
- sig { returns(T.nilable(String)) }
471
- attr_accessor :unit_label
472
- # A URL of a publicly-accessible webpage for this product.
473
- sig { returns(T.nilable(String)) }
474
- attr_accessor :url
475
- sig {
476
- params(active: T.nilable(T::Boolean), default_price_data: T.nilable(::Stripe::Product::CreateParams::DefaultPriceData), description: T.nilable(String), expand: T.nilable(T::Array[String]), id: T.nilable(String), images: T.nilable(T::Array[String]), marketing_features: T.nilable(T::Array[::Stripe::Product::CreateParams::MarketingFeature]), metadata: T.nilable(T::Hash[String, String]), name: String, package_dimensions: T.nilable(::Stripe::Product::CreateParams::PackageDimensions), shippable: T.nilable(T::Boolean), statement_descriptor: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String), unit_label: T.nilable(String), url: T.nilable(String)).void
477
- }
478
- def initialize(
479
- active: nil,
480
- default_price_data: nil,
481
- description: nil,
482
- expand: nil,
483
- id: nil,
484
- images: nil,
485
- marketing_features: nil,
486
- metadata: nil,
487
- name: nil,
488
- package_dimensions: nil,
489
- shippable: nil,
490
- statement_descriptor: nil,
491
- tax_code: nil,
492
- type: nil,
493
- unit_label: nil,
494
- url: nil
495
- ); end
496
- end
497
- class SearchParams < Stripe::RequestParams
498
- # Specifies which fields in the response should be expanded.
499
- sig { returns(T.nilable(T::Array[String])) }
500
- attr_accessor :expand
501
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
502
- sig { returns(T.nilable(Integer)) }
503
- attr_accessor :limit
504
- # 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.
505
- sig { returns(T.nilable(String)) }
506
- attr_accessor :page
507
- # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products).
508
- sig { returns(String) }
509
- attr_accessor :query
510
- sig {
511
- params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
512
- }
513
- def initialize(expand: nil, limit: nil, page: nil, query: nil); end
514
- end
515
- # Creates a new product object.
516
- sig {
517
- params(params: T.any(::Stripe::Product::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
518
- }
519
- def self.create(params = {}, opts = {}); end
520
-
521
- # Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
522
- sig {
523
- params(id: String, params: T.any(::Stripe::Product::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
524
- }
525
- def self.delete(id, params = {}, opts = {}); end
526
-
527
- # Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
528
- sig {
529
- params(params: T.any(::Stripe::Product::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
530
- }
531
- def delete(params = {}, opts = {}); end
532
-
533
- # Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
534
- sig {
535
- params(params: T.any(::Stripe::Product::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
536
- }
537
- def self.list(params = {}, opts = {}); end
538
-
539
- sig {
540
- params(params: T.any(::Stripe::Product::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
541
- }
542
- def self.search(params = {}, opts = {}); end
543
-
544
- sig {
545
- params(params: T.any(::Stripe::Product::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
546
- }
547
- def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
548
-
549
- # Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
550
- sig {
551
- params(id: String, params: T.any(::Stripe::Product::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
552
- }
553
- def self.update(id, params = {}, opts = {}); end
554
- end
555
- end
@@ -1,26 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # A product_feature represents an attachment between a feature and a product.
7
- # When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.
8
- class ProductFeature < APIResource
9
- # A feature represents a monetizable ability or functionality in your system.
10
- # Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
11
- sig { returns(Stripe::Entitlements::Feature) }
12
- attr_reader :entitlement_feature
13
- # Unique identifier for the object.
14
- sig { returns(String) }
15
- attr_reader :id
16
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
17
- sig { returns(T::Boolean) }
18
- attr_reader :livemode
19
- # String representing the object's type. Objects of the same type share the same value.
20
- sig { returns(String) }
21
- attr_reader :object
22
- # Always true for a deleted object
23
- sig { returns(T::Boolean) }
24
- attr_reader :deleted
25
- end
26
- end