stripe 13.6.0.pre.beta.1 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (556) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +699 -1457
  3. data/OPENAPI_VERSION +1 -1
  4. data/README.md +29 -0
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_requestor.rb +2 -0
  7. data/lib/stripe/api_version.rb +1 -1
  8. data/lib/stripe/errors.rb +0 -7
  9. data/lib/stripe/object_types.rb +0 -26
  10. data/lib/stripe/resources/account.rb +83 -614
  11. data/lib/stripe/resources/account_session.rb +1 -247
  12. data/lib/stripe/resources/apple_pay_domain.rb +0 -9
  13. data/lib/stripe/resources/application_fee.rb +1 -10
  14. data/lib/stripe/resources/balance.rb +0 -9
  15. data/lib/stripe/resources/balance_transaction.rb +2 -11
  16. data/lib/stripe/resources/bank_account.rb +1 -1
  17. data/lib/stripe/resources/billing/alert.rb +0 -9
  18. data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -48
  19. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -9
  20. data/lib/stripe/resources/billing/credit_grant.rb +4 -13
  21. data/lib/stripe/resources/billing/meter.rb +1 -10
  22. data/lib/stripe/resources/billing_portal/configuration.rb +0 -9
  23. data/lib/stripe/resources/card.rb +2 -4
  24. data/lib/stripe/resources/charge.rb +35 -1457
  25. data/lib/stripe/resources/checkout/session.rb +100 -293
  26. data/lib/stripe/resources/climate/order.rb +0 -9
  27. data/lib/stripe/resources/climate/product.rb +0 -9
  28. data/lib/stripe/resources/climate/supplier.rb +0 -9
  29. data/lib/stripe/resources/confirmation_token.rb +74 -156
  30. data/lib/stripe/resources/country_spec.rb +0 -9
  31. data/lib/stripe/resources/coupon.rb +0 -9
  32. data/lib/stripe/resources/credit_note.rb +14 -35
  33. data/lib/stripe/resources/credit_note_line_item.rb +14 -12
  34. data/lib/stripe/resources/customer.rb +12 -28
  35. data/lib/stripe/resources/customer_balance_transaction.rb +3 -1
  36. data/lib/stripe/resources/dispute.rb +0 -9
  37. data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -9
  38. data/lib/stripe/resources/entitlements/feature.rb +0 -9
  39. data/lib/stripe/resources/event.rb +0 -40
  40. data/lib/stripe/resources/exchange_rate.rb +0 -9
  41. data/lib/stripe/resources/file.rb +0 -9
  42. data/lib/stripe/resources/file_link.rb +0 -9
  43. data/lib/stripe/resources/financial_connections/account.rb +0 -23
  44. data/lib/stripe/resources/financial_connections/session.rb +1 -65
  45. data/lib/stripe/resources/financial_connections/transaction.rb +0 -9
  46. data/lib/stripe/resources/forwarding/request.rb +0 -9
  47. data/lib/stripe/resources/identity/verification_report.rb +0 -9
  48. data/lib/stripe/resources/identity/verification_session.rb +0 -9
  49. data/lib/stripe/resources/invoice.rb +225 -5120
  50. data/lib/stripe/resources/invoice_item.rb +65 -110
  51. data/lib/stripe/resources/invoice_line_item.rb +106 -89
  52. data/lib/stripe/resources/invoice_payment.rb +53 -4
  53. data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
  54. data/lib/stripe/resources/issuing/authorization.rb +0 -9
  55. data/lib/stripe/resources/issuing/card.rb +0 -9
  56. data/lib/stripe/resources/issuing/cardholder.rb +1 -11
  57. data/lib/stripe/resources/issuing/dispute.rb +0 -9
  58. data/lib/stripe/resources/issuing/personalization_design.rb +0 -9
  59. data/lib/stripe/resources/issuing/physical_bundle.rb +0 -9
  60. data/lib/stripe/resources/issuing/token.rb +0 -9
  61. data/lib/stripe/resources/issuing/transaction.rb +0 -15
  62. data/lib/stripe/resources/line_item.rb +0 -28
  63. data/lib/stripe/resources/mandate.rb +6 -33
  64. data/lib/stripe/resources/payment_intent.rb +642 -4975
  65. data/lib/stripe/resources/payment_link.rb +84 -15
  66. data/lib/stripe/resources/payment_method.rb +74 -187
  67. data/lib/stripe/resources/payment_method_configuration.rb +87 -214
  68. data/lib/stripe/resources/payment_method_domain.rb +9 -18
  69. data/lib/stripe/resources/payout.rb +0 -9
  70. data/lib/stripe/resources/person.rb +9 -9
  71. data/lib/stripe/resources/plan.rb +0 -15
  72. data/lib/stripe/resources/price.rb +2 -47
  73. data/lib/stripe/resources/product.rb +0 -68
  74. data/lib/stripe/resources/promotion_code.rb +0 -9
  75. data/lib/stripe/resources/quote.rb +8 -2037
  76. data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -9
  77. data/lib/stripe/resources/radar/value_list.rb +0 -9
  78. data/lib/stripe/resources/radar/value_list_item.rb +0 -9
  79. data/lib/stripe/resources/refund.rb +13 -18
  80. data/lib/stripe/resources/reporting/report_run.rb +0 -9
  81. data/lib/stripe/resources/reporting/report_type.rb +0 -9
  82. data/lib/stripe/resources/review.rb +2 -11
  83. data/lib/stripe/resources/setup_attempt.rb +11 -16
  84. data/lib/stripe/resources/setup_intent.rb +158 -540
  85. data/lib/stripe/resources/shipping_rate.rb +0 -9
  86. data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -9
  87. data/lib/stripe/resources/source.rb +0 -41
  88. data/lib/stripe/resources/subscription.rb +14 -385
  89. data/lib/stripe/resources/subscription_item.rb +9 -134
  90. data/lib/stripe/resources/subscription_schedule.rb +14 -1135
  91. data/lib/stripe/resources/tax/calculation.rb +0 -9
  92. data/lib/stripe/resources/tax/registration.rb +1 -10
  93. data/lib/stripe/resources/tax/settings.rb +0 -9
  94. data/lib/stripe/resources/tax/transaction.rb +0 -9
  95. data/lib/stripe/resources/tax_code.rb +0 -9
  96. data/lib/stripe/resources/tax_id.rb +0 -9
  97. data/lib/stripe/resources/tax_rate.rb +0 -9
  98. data/lib/stripe/resources/terminal/configuration.rb +214 -14
  99. data/lib/stripe/resources/terminal/location.rb +0 -9
  100. data/lib/stripe/resources/terminal/reader.rb +0 -408
  101. data/lib/stripe/resources/test_helpers/test_clock.rb +0 -9
  102. data/lib/stripe/resources/token.rb +1 -10
  103. data/lib/stripe/resources/topup.rb +0 -9
  104. data/lib/stripe/resources/transfer.rb +0 -9
  105. data/lib/stripe/resources/treasury/credit_reversal.rb +0 -9
  106. data/lib/stripe/resources/treasury/debit_reversal.rb +0 -9
  107. data/lib/stripe/resources/treasury/financial_account.rb +4 -32
  108. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
  109. data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -9
  110. data/lib/stripe/resources/treasury/outbound_payment.rb +0 -9
  111. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -46
  112. data/lib/stripe/resources/treasury/received_credit.rb +1 -47
  113. data/lib/stripe/resources/treasury/received_debit.rb +1 -49
  114. data/lib/stripe/resources/treasury/transaction.rb +0 -9
  115. data/lib/stripe/resources/treasury/transaction_entry.rb +0 -9
  116. data/lib/stripe/resources/v2/event.rb +1 -0
  117. data/lib/stripe/resources/v2/event_destination.rb +1 -0
  118. data/lib/stripe/resources/webhook_endpoint.rb +0 -9
  119. data/lib/stripe/resources.rb +0 -25
  120. data/lib/stripe/services/account_external_account_service.rb +1 -1
  121. data/lib/stripe/services/account_service.rb +68 -509
  122. data/lib/stripe/services/account_session_service.rb +1 -217
  123. data/lib/stripe/services/balance_transaction_service.rb +1 -1
  124. data/lib/stripe/services/billing/credit_balance_summary_service.rb +2 -2
  125. data/lib/stripe/services/billing/credit_grant_service.rb +2 -2
  126. data/lib/stripe/services/billing/meter_service.rb +1 -1
  127. data/lib/stripe/services/charge_service.rb +1 -1335
  128. data/lib/stripe/services/checkout/session_service.rb +60 -168
  129. data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -4
  130. data/lib/stripe/services/credit_note_service.rb +0 -8
  131. data/lib/stripe/services/customer_service.rb +0 -16
  132. data/lib/stripe/services/financial_connections/account_service.rb +1 -3
  133. data/lib/stripe/services/financial_connections/session_service.rb +1 -30
  134. data/lib/stripe/services/financial_connections_service.rb +1 -2
  135. data/lib/stripe/services/invoice_item_service.rb +34 -88
  136. data/lib/stripe/services/invoice_line_item_service.rb +25 -41
  137. data/lib/stripe/services/invoice_payment_service.rb +33 -5
  138. data/lib/stripe/services/invoice_service.rb +210 -3147
  139. data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
  140. data/lib/stripe/services/issuing/transaction_service.rb +0 -4
  141. data/lib/stripe/services/issuing_service.rb +1 -5
  142. data/lib/stripe/services/payment_intent_service.rb +568 -4513
  143. data/lib/stripe/services/payment_link_service.rb +59 -6
  144. data/lib/stripe/services/payment_method_configuration_service.rb +62 -146
  145. data/lib/stripe/services/payment_method_domain_service.rb +6 -6
  146. data/lib/stripe/services/payment_method_service.rb +49 -119
  147. data/lib/stripe/services/plan_service.rb +0 -4
  148. data/lib/stripe/services/price_service.rb +2 -25
  149. data/lib/stripe/services/product_service.rb +0 -38
  150. data/lib/stripe/services/quote_service.rb +9 -1716
  151. data/lib/stripe/services/setup_intent_service.rb +158 -492
  152. data/lib/stripe/services/subscription_item_service.rb +5 -111
  153. data/lib/stripe/services/subscription_schedule_service.rb +14 -1005
  154. data/lib/stripe/services/subscription_service.rb +13 -323
  155. data/lib/stripe/services/tax/registration_service.rb +1 -1
  156. data/lib/stripe/services/tax_service.rb +1 -3
  157. data/lib/stripe/services/terminal/configuration_service.rb +170 -4
  158. data/lib/stripe/services/terminal/reader_service.rb +0 -177
  159. data/lib/stripe/services/terminal_service.rb +1 -2
  160. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +49 -87
  161. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -43
  162. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
  163. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
  164. data/lib/stripe/services/token_service.rb +1 -1
  165. data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
  166. data/lib/stripe/services/treasury/financial_account_service.rb +3 -17
  167. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
  168. data/lib/stripe/services/v1_services.rb +2 -8
  169. data/lib/stripe/services/v2/core/event_destination_service.rb +1 -4
  170. data/lib/stripe/services/v2/core/event_service.rb +1 -4
  171. data/lib/stripe/services.rb +0 -27
  172. data/lib/stripe/stripe_client.rb +1 -0
  173. data/lib/stripe/stripe_configuration.rb +1 -3
  174. data/lib/stripe/util.rb +1 -7
  175. data/lib/stripe/version.rb +1 -1
  176. data/lib/stripe.rb +0 -45
  177. data/rbi/stripe/resources/account.rbi +1131 -1479
  178. data/rbi/stripe/resources/account_link.rbi +9 -9
  179. data/rbi/stripe/resources/account_session.rbi +118 -367
  180. data/rbi/stripe/resources/apple_pay_domain.rbi +8 -15
  181. data/rbi/stripe/resources/application_fee.rbi +15 -20
  182. data/rbi/stripe/resources/apps/secret.rbi +20 -20
  183. data/rbi/stripe/resources/balance.rbi +0 -7
  184. data/rbi/stripe/resources/balance_transaction.rbi +19 -24
  185. data/rbi/stripe/resources/bank_account.rbi +1 -1
  186. data/rbi/stripe/resources/billing/alert.rbi +23 -28
  187. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -53
  188. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +6 -13
  189. data/rbi/stripe/resources/billing/credit_grant.rbi +30 -37
  190. data/rbi/stripe/resources/billing/meter.rbi +19 -26
  191. data/rbi/stripe/resources/billing/meter_event.rbi +4 -4
  192. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +5 -5
  193. data/rbi/stripe/resources/billing_portal/configuration.rbi +86 -81
  194. data/rbi/stripe/resources/billing_portal/session.rbi +31 -27
  195. data/rbi/stripe/resources/card.rbi +2 -5
  196. data/rbi/stripe/resources/charge.rbi +136 -1576
  197. data/rbi/stripe/resources/checkout/session.rbi +631 -748
  198. data/rbi/stripe/resources/climate/order.rbi +20 -25
  199. data/rbi/stripe/resources/climate/product.rbi +5 -12
  200. data/rbi/stripe/resources/climate/supplier.rbi +5 -12
  201. data/rbi/stripe/resources/confirmation_token.rbi +274 -268
  202. data/rbi/stripe/resources/country_spec.rbi +5 -12
  203. data/rbi/stripe/resources/coupon.rbi +34 -39
  204. data/rbi/stripe/resources/credit_note.rbi +134 -146
  205. data/rbi/stripe/resources/credit_note_line_item.rbi +20 -18
  206. data/rbi/stripe/resources/customer.rbi +172 -164
  207. data/rbi/stripe/resources/customer_balance_transaction.rbi +4 -1
  208. data/rbi/stripe/resources/customer_session.rbi +19 -15
  209. data/rbi/stripe/resources/dispute.rbi +92 -95
  210. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +5 -12
  211. data/rbi/stripe/resources/entitlements/feature.rbi +15 -22
  212. data/rbi/stripe/resources/ephemeral_key.rbi +2 -2
  213. data/rbi/stripe/resources/event.rbi +16 -60
  214. data/rbi/stripe/resources/exchange_rate.rbi +5 -12
  215. data/rbi/stripe/resources/file.rbi +20 -25
  216. data/rbi/stripe/resources/file_link.rbi +23 -28
  217. data/rbi/stripe/resources/financial_connections/account.rbi +25 -44
  218. data/rbi/stripe/resources/financial_connections/session.rbi +12 -75
  219. data/rbi/stripe/resources/financial_connections/transaction.rbi +16 -19
  220. data/rbi/stripe/resources/forwarding/request.rbi +21 -24
  221. data/rbi/stripe/resources/identity/verification_report.rbi +18 -21
  222. data/rbi/stripe/resources/identity/verification_session.rbi +60 -61
  223. data/rbi/stripe/resources/invoice.rbi +723 -5918
  224. data/rbi/stripe/resources/invoice_item.rbi +138 -177
  225. data/rbi/stripe/resources/invoice_line_item.rbi +199 -264
  226. data/rbi/stripe/resources/invoice_payment.rbi +51 -7
  227. data/rbi/stripe/resources/invoice_rendering_template.rbi +10 -20
  228. data/rbi/stripe/resources/issuing/authorization.rbi +216 -199
  229. data/rbi/stripe/resources/issuing/card.rbi +104 -101
  230. data/rbi/stripe/resources/issuing/cardholder.rbi +120 -108
  231. data/rbi/stripe/resources/issuing/dispute.rbi +164 -151
  232. data/rbi/stripe/resources/issuing/personalization_design.rbi +61 -56
  233. data/rbi/stripe/resources/issuing/physical_bundle.rbi +7 -14
  234. data/rbi/stripe/resources/issuing/token.rbi +16 -21
  235. data/rbi/stripe/resources/issuing/transaction.rbi +180 -176
  236. data/rbi/stripe/resources/line_item.rbi +0 -36
  237. data/rbi/stripe/resources/mandate.rbi +8 -40
  238. data/rbi/stripe/resources/payment_intent.rbi +2252 -6482
  239. data/rbi/stripe/resources/payment_link.rbi +346 -211
  240. data/rbi/stripe/resources/payment_method.rbi +226 -330
  241. data/rbi/stripe/resources/payment_method_configuration.rbi +602 -685
  242. data/rbi/stripe/resources/payment_method_domain.rbi +26 -31
  243. data/rbi/stripe/resources/payout.rbi +43 -42
  244. data/rbi/stripe/resources/person.rbi +9 -9
  245. data/rbi/stripe/resources/plan.rbi +51 -63
  246. data/rbi/stripe/resources/price.rbi +114 -151
  247. data/rbi/stripe/resources/product.rbi +90 -152
  248. data/rbi/stripe/resources/promotion_code.rbi +42 -47
  249. data/rbi/stripe/resources/quote.rbi +168 -2231
  250. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +17 -20
  251. data/rbi/stripe/resources/radar/value_list.rbi +24 -29
  252. data/rbi/stripe/resources/radar/value_list_item.rbi +18 -21
  253. data/rbi/stripe/resources/refund.rbi +52 -51
  254. data/rbi/stripe/resources/reporting/report_run.rbi +27 -30
  255. data/rbi/stripe/resources/reporting/report_type.rbi +2 -9
  256. data/rbi/stripe/resources/review.rbi +17 -22
  257. data/rbi/stripe/resources/setup_attempt.rbi +25 -32
  258. data/rbi/stripe/resources/setup_intent.rbi +900 -1102
  259. data/rbi/stripe/resources/shipping_rate.rbi +41 -46
  260. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +5 -12
  261. data/rbi/stripe/resources/source.rbi +132 -179
  262. data/rbi/stripe/resources/subscription.rbi +363 -707
  263. data/rbi/stripe/resources/subscription_item.rbi +69 -177
  264. data/rbi/stripe/resources/subscription_schedule.rbi +289 -1447
  265. data/rbi/stripe/resources/tax/calculation.rbi +43 -48
  266. data/rbi/stripe/resources/tax/registration.rbi +217 -170
  267. data/rbi/stripe/resources/tax/settings.rbi +14 -21
  268. data/rbi/stripe/resources/tax/transaction.rbi +20 -25
  269. data/rbi/stripe/resources/tax_code.rbi +5 -12
  270. data/rbi/stripe/resources/tax_id.rbi +15 -22
  271. data/rbi/stripe/resources/tax_rate.rbi +34 -39
  272. data/rbi/stripe/resources/terminal/configuration.rbi +457 -212
  273. data/rbi/stripe/resources/terminal/connection_token.rbi +3 -3
  274. data/rbi/stripe/resources/terminal/location.rbi +28 -35
  275. data/rbi/stripe/resources/terminal/reader.rbi +71 -441
  276. data/rbi/stripe/resources/test_helpers/test_clock.rbi +12 -17
  277. data/rbi/stripe/resources/token.rbi +288 -263
  278. data/rbi/stripe/resources/topup.rbi +35 -38
  279. data/rbi/stripe/resources/transfer.rbi +27 -32
  280. data/rbi/stripe/resources/treasury/credit_reversal.rbi +10 -17
  281. data/rbi/stripe/resources/treasury/debit_reversal.rbi +11 -18
  282. data/rbi/stripe/resources/treasury/financial_account.rbi +125 -130
  283. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -3
  284. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +22 -29
  285. data/rbi/stripe/resources/treasury/outbound_payment.rbi +82 -79
  286. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +44 -86
  287. data/rbi/stripe/resources/treasury/received_credit.rbi +18 -64
  288. data/rbi/stripe/resources/treasury/received_debit.rbi +17 -66
  289. data/rbi/stripe/resources/treasury/transaction.rbi +27 -28
  290. data/rbi/stripe/resources/treasury/transaction_entry.rbi +25 -26
  291. data/rbi/stripe/resources/v2/amount.rbi +1 -1
  292. data/rbi/stripe/resources/v2/event.rbi +1 -0
  293. data/rbi/stripe/resources/v2/event_destination.rbi +1 -0
  294. data/rbi/stripe/resources/webhook_endpoint.rbi +18 -25
  295. data/rbi/stripe/services/account_capability_service.rbi +7 -7
  296. data/rbi/stripe/services/account_external_account_service.rbi +52 -52
  297. data/rbi/stripe/services/account_link_service.rbi +9 -9
  298. data/rbi/stripe/services/account_login_link_service.rbi +2 -2
  299. data/rbi/stripe/services/account_person_service.rbi +221 -201
  300. data/rbi/stripe/services/account_service.rbi +1221 -1345
  301. data/rbi/stripe/services/account_session_service.rbi +115 -346
  302. data/rbi/stripe/services/apple_pay_domain_service.rbi +10 -10
  303. data/rbi/stripe/services/application_fee_refund_service.rbi +16 -14
  304. data/rbi/stripe/services/application_fee_service.rbi +18 -14
  305. data/rbi/stripe/services/apps/secret_service.rbi +20 -20
  306. data/rbi/stripe/services/balance_service.rbi +2 -2
  307. data/rbi/stripe/services/balance_transaction_service.rbi +22 -18
  308. data/rbi/stripe/services/billing/alert_service.rbi +23 -23
  309. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +10 -10
  310. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +8 -8
  311. data/rbi/stripe/services/billing/credit_grant_service.rbi +32 -30
  312. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +7 -5
  313. data/rbi/stripe/services/billing/meter_event_service.rbi +4 -4
  314. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +6 -6
  315. data/rbi/stripe/services/billing/meter_service.rbi +21 -21
  316. data/rbi/stripe/services/billing_portal/configuration_service.rbi +90 -76
  317. data/rbi/stripe/services/billing_portal/session_service.rbi +29 -27
  318. data/rbi/stripe/services/charge_service.rbi +96 -1464
  319. data/rbi/stripe/services/checkout/session_line_item_service.rbi +5 -5
  320. data/rbi/stripe/services/checkout/session_service.rbi +555 -591
  321. data/rbi/stripe/services/climate/order_service.rbi +22 -20
  322. data/rbi/stripe/services/climate/product_service.rbi +7 -7
  323. data/rbi/stripe/services/climate/supplier_service.rbi +7 -7
  324. data/rbi/stripe/services/confirmation_token_service.rbi +2 -2
  325. data/rbi/stripe/services/country_spec_service.rbi +7 -7
  326. data/rbi/stripe/services/coupon_service.rbi +40 -34
  327. data/rbi/stripe/services/credit_note_line_item_service.rbi +5 -5
  328. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +35 -35
  329. data/rbi/stripe/services/credit_note_service.rbi +81 -85
  330. data/rbi/stripe/services/customer_balance_transaction_service.rbi +15 -15
  331. data/rbi/stripe/services/customer_cash_balance_service.rbi +7 -7
  332. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +7 -7
  333. data/rbi/stripe/services/customer_funding_instructions_service.rbi +5 -5
  334. data/rbi/stripe/services/customer_payment_method_service.rbi +9 -9
  335. data/rbi/stripe/services/customer_payment_source_service.rbi +48 -44
  336. data/rbi/stripe/services/customer_service.rbi +143 -139
  337. data/rbi/stripe/services/customer_session_service.rbi +21 -15
  338. data/rbi/stripe/services/customer_tax_id_service.rbi +9 -9
  339. data/rbi/stripe/services/dispute_service.rbi +92 -90
  340. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +7 -7
  341. data/rbi/stripe/services/entitlements/feature_service.rbi +17 -17
  342. data/rbi/stripe/services/ephemeral_key_service.rbi +8 -8
  343. data/rbi/stripe/services/event_service.rbi +18 -16
  344. data/rbi/stripe/services/exchange_rate_service.rbi +7 -7
  345. data/rbi/stripe/services/file_link_service.rbi +25 -23
  346. data/rbi/stripe/services/file_service.rbi +22 -20
  347. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +5 -5
  348. data/rbi/stripe/services/financial_connections/account_service.rbi +22 -21
  349. data/rbi/stripe/services/financial_connections/session_service.rbi +16 -39
  350. data/rbi/stripe/services/financial_connections/transaction_service.rbi +16 -14
  351. data/rbi/stripe/services/financial_connections_service.rbi +0 -1
  352. data/rbi/stripe/services/forwarding/request_service.rbi +21 -19
  353. data/rbi/stripe/services/identity/verification_report_service.rbi +18 -16
  354. data/rbi/stripe/services/identity/verification_session_service.rbi +62 -56
  355. data/rbi/stripe/services/invoice_item_service.rbi +99 -155
  356. data/rbi/stripe/services/invoice_line_item_service.rbi +71 -82
  357. data/rbi/stripe/services/invoice_payment_service.rbi +39 -12
  358. data/rbi/stripe/services/invoice_rendering_template_service.rbi +13 -13
  359. data/rbi/stripe/services/invoice_service.rbi +679 -3799
  360. data/rbi/stripe/services/issuing/authorization_service.rbi +32 -26
  361. data/rbi/stripe/services/issuing/card_service.rbi +102 -86
  362. data/rbi/stripe/services/issuing/cardholder_service.rbi +122 -103
  363. data/rbi/stripe/services/issuing/dispute_service.rbi +152 -146
  364. data/rbi/stripe/services/issuing/personalization_design_service.rbi +52 -42
  365. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +9 -9
  366. data/rbi/stripe/services/issuing/token_service.rbi +20 -16
  367. data/rbi/stripe/services/issuing/transaction_service.rbi +25 -23
  368. data/rbi/stripe/services/issuing_service.rbi +0 -3
  369. data/rbi/stripe/services/mandate_service.rbi +2 -2
  370. data/rbi/stripe/services/payment_intent_service.rbi +2312 -6081
  371. data/rbi/stripe/services/payment_link_line_item_service.rbi +5 -5
  372. data/rbi/stripe/services/payment_link_service.rbi +303 -201
  373. data/rbi/stripe/services/payment_method_configuration_service.rbi +616 -620
  374. data/rbi/stripe/services/payment_method_domain_service.rbi +25 -23
  375. data/rbi/stripe/services/payment_method_service.rbi +192 -249
  376. data/rbi/stripe/services/payout_service.rbi +45 -37
  377. data/rbi/stripe/services/plan_service.rbi +53 -55
  378. data/rbi/stripe/services/price_service.rbi +124 -129
  379. data/rbi/stripe/services/product_feature_service.rbi +9 -9
  380. data/rbi/stripe/services/product_service.rbi +94 -122
  381. data/rbi/stripe/services/promotion_code_service.rbi +46 -42
  382. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +5 -5
  383. data/rbi/stripe/services/quote_line_item_service.rbi +5 -5
  384. data/rbi/stripe/services/quote_service.rbi +159 -1863
  385. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +17 -15
  386. data/rbi/stripe/services/radar/value_list_item_service.rbi +20 -16
  387. data/rbi/stripe/services/radar/value_list_service.rbi +28 -24
  388. data/rbi/stripe/services/refund_service.rbi +37 -33
  389. data/rbi/stripe/services/reporting/report_run_service.rbi +29 -25
  390. data/rbi/stripe/services/reporting/report_type_service.rbi +4 -4
  391. data/rbi/stripe/services/review_service.rbi +17 -15
  392. data/rbi/stripe/services/setup_attempt_service.rbi +13 -11
  393. data/rbi/stripe/services/setup_intent_service.rbi +1028 -1062
  394. data/rbi/stripe/services/shipping_rate_service.rbi +47 -41
  395. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +7 -7
  396. data/rbi/stripe/services/source_service.rbi +149 -133
  397. data/rbi/stripe/services/source_transaction_service.rbi +5 -5
  398. data/rbi/stripe/services/subscription_item_service.rbi +61 -159
  399. data/rbi/stripe/services/subscription_schedule_service.rbi +289 -1305
  400. data/rbi/stripe/services/subscription_service.rbi +366 -640
  401. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +5 -5
  402. data/rbi/stripe/services/tax/calculation_service.rbi +40 -38
  403. data/rbi/stripe/services/tax/registration_service.rbi +337 -165
  404. data/rbi/stripe/services/tax/settings_service.rbi +16 -16
  405. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +5 -5
  406. data/rbi/stripe/services/tax/transaction_service.rbi +19 -15
  407. data/rbi/stripe/services/tax_code_service.rbi +7 -7
  408. data/rbi/stripe/services/tax_id_service.rbi +17 -17
  409. data/rbi/stripe/services/tax_rate_service.rbi +36 -34
  410. data/rbi/stripe/services/tax_service.rbi +0 -2
  411. data/rbi/stripe/services/terminal/configuration_service.rbi +464 -204
  412. data/rbi/stripe/services/terminal/connection_token_service.rbi +3 -3
  413. data/rbi/stripe/services/terminal/location_service.rbi +30 -30
  414. data/rbi/stripe/services/terminal/reader_service.rbi +57 -226
  415. data/rbi/stripe/services/terminal_service.rbi +0 -1
  416. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +157 -198
  417. data/rbi/stripe/services/test_helpers/customer_service.rbi +3 -3
  418. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +180 -168
  419. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +10 -10
  420. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +11 -9
  421. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +151 -145
  422. data/rbi/stripe/services/test_helpers/refund_service.rbi +2 -2
  423. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +10 -39
  424. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +14 -12
  425. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +9 -9
  426. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +20 -18
  427. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +20 -18
  428. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +11 -38
  429. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +11 -38
  430. data/rbi/stripe/services/token_service.rbi +292 -258
  431. data/rbi/stripe/services/topup_service.rbi +37 -33
  432. data/rbi/stripe/services/transfer_reversal_service.rbi +18 -16
  433. data/rbi/stripe/services/transfer_service.rbi +29 -27
  434. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +12 -12
  435. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +13 -13
  436. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +23 -26
  437. data/rbi/stripe/services/treasury/financial_account_service.rbi +92 -96
  438. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +15 -15
  439. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +60 -56
  440. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +24 -49
  441. data/rbi/stripe/services/treasury/received_credit_service.rbi +11 -9
  442. data/rbi/stripe/services/treasury/received_debit_service.rbi +8 -8
  443. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +25 -21
  444. data/rbi/stripe/services/treasury/transaction_service.rbi +31 -23
  445. data/rbi/stripe/services/v1_services.rbi +1 -7
  446. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +3 -3
  447. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +3 -3
  448. data/rbi/stripe/services/v2/core/event_destination_service.rbi +21 -24
  449. data/rbi/stripe/services/v2/core/event_service.rbi +3 -6
  450. data/rbi/stripe/services/webhook_endpoint_service.rbi +20 -20
  451. metadata +4 -109
  452. data/lib/stripe/request_signing_authenticator.rb +0 -79
  453. data/lib/stripe/resources/account_notice.rb +0 -132
  454. data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
  455. data/lib/stripe/resources/capital/financing_offer.rb +0 -188
  456. data/lib/stripe/resources/capital/financing_summary.rb +0 -64
  457. data/lib/stripe/resources/capital/financing_transaction.rb +0 -123
  458. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  459. data/lib/stripe/resources/financial_connections/institution.rb +0 -99
  460. data/lib/stripe/resources/gift_cards/card.rb +0 -217
  461. data/lib/stripe/resources/gift_cards/transaction.rb +0 -281
  462. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -611
  463. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -84
  464. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -95
  465. data/lib/stripe/resources/issuing/settlement.rb +0 -49
  466. data/lib/stripe/resources/margin.rb +0 -124
  467. data/lib/stripe/resources/order.rb +0 -2868
  468. data/lib/stripe/resources/payment_attempt_record.rb +0 -184
  469. data/lib/stripe/resources/payment_record.rb +0 -715
  470. data/lib/stripe/resources/quote_line.rb +0 -274
  471. data/lib/stripe/resources/quote_preview_invoice.rb +0 -652
  472. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -362
  473. data/lib/stripe/resources/tax/association.rb +0 -89
  474. data/lib/stripe/resources/tax/form.rb +0 -220
  475. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -40
  476. data/lib/stripe/resources/usage_record.rb +0 -30
  477. data/lib/stripe/resources/usage_record_summary.rb +0 -33
  478. data/lib/stripe/services/account_notice_service.rb +0 -101
  479. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  480. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  481. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  482. data/lib/stripe/services/capital_service.rb +0 -15
  483. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -37
  484. data/lib/stripe/services/financial_connections/institution_service.rb +0 -57
  485. data/lib/stripe/services/gift_cards/card_service.rb +0 -170
  486. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
  487. data/lib/stripe/services/gift_cards_service.rb +0 -14
  488. data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -1881
  489. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  490. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  491. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  492. data/lib/stripe/services/margin_service.rb +0 -119
  493. data/lib/stripe/services/order_line_item_service.rb +0 -35
  494. data/lib/stripe/services/order_service.rb +0 -2268
  495. data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
  496. data/lib/stripe/services/payment_record_service.rb +0 -542
  497. data/lib/stripe/services/quote_line_service.rb +0 -35
  498. data/lib/stripe/services/quote_preview_invoice_service.rb +0 -35
  499. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
  500. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -41
  501. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -37
  502. data/lib/stripe/services/tax/association_service.rb +0 -31
  503. data/lib/stripe/services/tax/form_service.rb +0 -100
  504. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  505. data/rbi/stripe/resources/account_notice.rbi +0 -139
  506. data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -71
  507. data/rbi/stripe/resources/capital/financing_offer.rbi +0 -190
  508. data/rbi/stripe/resources/capital/financing_summary.rbi +0 -74
  509. data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -130
  510. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -27
  511. data/rbi/stripe/resources/financial_connections/institution.rbi +0 -99
  512. data/rbi/stripe/resources/gift_cards/card.rbi +0 -206
  513. data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -257
  514. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -622
  515. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -83
  516. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -90
  517. data/rbi/stripe/resources/issuing/settlement.rbi +0 -62
  518. data/rbi/stripe/resources/margin.rbi +0 -127
  519. data/rbi/stripe/resources/order.rbi +0 -3036
  520. data/rbi/stripe/resources/payment_attempt_record.rbi +0 -215
  521. data/rbi/stripe/resources/payment_record.rbi +0 -722
  522. data/rbi/stripe/resources/quote_line.rbi +0 -350
  523. data/rbi/stripe/resources/quote_preview_invoice.rbi +0 -850
  524. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -474
  525. data/rbi/stripe/resources/tax/association.rbi +0 -94
  526. data/rbi/stripe/resources/tax/form.rbi +0 -224
  527. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -41
  528. data/rbi/stripe/resources/usage_record.rbi +0 -32
  529. data/rbi/stripe/resources/usage_record_summary.rbi +0 -38
  530. data/rbi/stripe/services/account_notice_service.rbi +0 -90
  531. data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -95
  532. data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -22
  533. data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -68
  534. data/rbi/stripe/services/capital_service.rbi +0 -11
  535. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -33
  536. data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -46
  537. data/rbi/stripe/services/gift_cards/card_service.rbi +0 -142
  538. data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -174
  539. data/rbi/stripe/services/gift_cards_service.rbi +0 -10
  540. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +0 -2023
  541. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -498
  542. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -55
  543. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -73
  544. data/rbi/stripe/services/margin_service.rbi +0 -104
  545. data/rbi/stripe/services/order_line_item_service.rbi +0 -31
  546. data/rbi/stripe/services/order_service.rbi +0 -2320
  547. data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -36
  548. data/rbi/stripe/services/payment_record_service.rbi +0 -521
  549. data/rbi/stripe/services/quote_line_service.rbi +0 -31
  550. data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -31
  551. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -31
  552. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -37
  553. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -33
  554. data/rbi/stripe/services/tax/association_service.rbi +0 -25
  555. data/rbi/stripe/services/tax/form_service.rbi +0 -85
  556. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -22
@@ -7,68 +7,72 @@ module Stripe
7
7
  class ListParams < Stripe::RequestParams
8
8
  class Created < Stripe::RequestParams
9
9
  # Minimum value to filter by (exclusive)
10
- sig { returns(Integer) }
10
+ sig { returns(T.nilable(Integer)) }
11
11
  attr_accessor :gt
12
12
  # Minimum value to filter by (inclusive)
13
- sig { returns(Integer) }
13
+ sig { returns(T.nilable(Integer)) }
14
14
  attr_accessor :gte
15
15
  # Maximum value to filter by (exclusive)
16
- sig { returns(Integer) }
16
+ sig { returns(T.nilable(Integer)) }
17
17
  attr_accessor :lt
18
18
  # Maximum value to filter by (inclusive)
19
- sig { returns(Integer) }
19
+ sig { returns(T.nilable(Integer)) }
20
20
  attr_accessor :lte
21
- sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
21
+ sig {
22
+ params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
23
+ }
22
24
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
23
25
  end
24
26
  class Recurring < Stripe::RequestParams
25
27
  # Filter by billing frequency. Either `day`, `week`, `month` or `year`.
26
- sig { returns(String) }
28
+ sig { returns(T.nilable(String)) }
27
29
  attr_accessor :interval
28
30
  # Filter by the price's meter.
29
- sig { returns(String) }
31
+ sig { returns(T.nilable(String)) }
30
32
  attr_accessor :meter
31
33
  # Filter by the usage type for this price. Can be either `metered` or `licensed`.
32
- sig { returns(String) }
34
+ sig { returns(T.nilable(String)) }
33
35
  attr_accessor :usage_type
34
- sig { params(interval: String, meter: String, usage_type: String).void }
36
+ sig {
37
+ params(interval: T.nilable(String), meter: T.nilable(String), usage_type: T.nilable(String)).void
38
+ }
35
39
  def initialize(interval: nil, meter: nil, usage_type: nil); end
36
40
  end
37
41
  # Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
38
- sig { returns(T::Boolean) }
42
+ sig { returns(T.nilable(T::Boolean)) }
39
43
  attr_accessor :active
40
44
  # A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
41
- sig { returns(T.any(::Stripe::PriceService::ListParams::Created, Integer)) }
45
+ sig { returns(T.nilable(T.any(::Stripe::PriceService::ListParams::Created, Integer))) }
42
46
  attr_accessor :created
43
47
  # Only return prices for the given currency.
44
- sig { returns(String) }
48
+ sig { returns(T.nilable(String)) }
45
49
  attr_accessor :currency
46
50
  # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
47
- sig { returns(String) }
51
+ sig { returns(T.nilable(String)) }
48
52
  attr_accessor :ending_before
49
53
  # Specifies which fields in the response should be expanded.
50
- sig { returns(T::Array[String]) }
54
+ sig { returns(T.nilable(T::Array[String])) }
51
55
  attr_accessor :expand
52
56
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
53
- sig { returns(Integer) }
57
+ sig { returns(T.nilable(Integer)) }
54
58
  attr_accessor :limit
55
59
  # Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
56
- sig { returns(T::Array[String]) }
60
+ sig { returns(T.nilable(T::Array[String])) }
57
61
  attr_accessor :lookup_keys
58
62
  # Only return prices for the given product.
59
- sig { returns(String) }
63
+ sig { returns(T.nilable(String)) }
60
64
  attr_accessor :product
61
65
  # Only return prices with these recurring fields.
62
- sig { returns(::Stripe::PriceService::ListParams::Recurring) }
66
+ sig { returns(T.nilable(::Stripe::PriceService::ListParams::Recurring)) }
63
67
  attr_accessor :recurring
64
68
  # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
65
- sig { returns(String) }
69
+ sig { returns(T.nilable(String)) }
66
70
  attr_accessor :starting_after
67
71
  # Only return prices of type `recurring` or `one_time`.
68
- sig { returns(String) }
72
+ sig { returns(T.nilable(String)) }
69
73
  attr_accessor :type
70
74
  sig {
71
- params(active: T::Boolean, created: T.any(::Stripe::PriceService::ListParams::Created, Integer), currency: String, ending_before: String, expand: T::Array[String], limit: Integer, lookup_keys: T::Array[String], product: String, recurring: ::Stripe::PriceService::ListParams::Recurring, starting_after: String, type: String).void
75
+ params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::PriceService::ListParams::Created, Integer)), currency: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_keys: T.nilable(T::Array[String]), product: T.nilable(String), recurring: T.nilable(::Stripe::PriceService::ListParams::Recurring), starting_after: T.nilable(String), type: T.nilable(String)).void
72
76
  }
73
77
  def initialize(
74
78
  active: nil,
@@ -91,37 +95,37 @@ module Stripe
91
95
  sig { returns(T::Boolean) }
92
96
  attr_accessor :enabled
93
97
  # The maximum unit amount the customer can specify for this item.
94
- sig { returns(Integer) }
98
+ sig { returns(T.nilable(Integer)) }
95
99
  attr_accessor :maximum
96
100
  # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
97
- sig { returns(Integer) }
101
+ sig { returns(T.nilable(Integer)) }
98
102
  attr_accessor :minimum
99
103
  # The starting unit amount which can be updated by the customer.
100
- sig { returns(Integer) }
104
+ sig { returns(T.nilable(Integer)) }
101
105
  attr_accessor :preset
102
106
  sig {
103
- params(enabled: T::Boolean, maximum: Integer, minimum: Integer, preset: Integer).void
107
+ params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
104
108
  }
105
109
  def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
106
110
  end
107
111
  class Tier < Stripe::RequestParams
108
112
  # The flat billing amount for an entire tier, regardless of the number of units in the tier.
109
- sig { returns(Integer) }
113
+ sig { returns(T.nilable(Integer)) }
110
114
  attr_accessor :flat_amount
111
115
  # Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
112
- sig { returns(String) }
116
+ sig { returns(T.nilable(String)) }
113
117
  attr_accessor :flat_amount_decimal
114
118
  # The per unit billing amount for each individual unit for which this tier applies.
115
- sig { returns(Integer) }
119
+ sig { returns(T.nilable(Integer)) }
116
120
  attr_accessor :unit_amount
117
121
  # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
118
- sig { returns(String) }
122
+ sig { returns(T.nilable(String)) }
119
123
  attr_accessor :unit_amount_decimal
120
124
  # Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
121
125
  sig { returns(T.any(String, Integer)) }
122
126
  attr_accessor :up_to
123
127
  sig {
124
- params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
128
+ params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
125
129
  }
126
130
  def initialize(
127
131
  flat_amount: nil,
@@ -132,22 +136,26 @@ module Stripe
132
136
  ); end
133
137
  end
134
138
  # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
135
- sig { returns(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount) }
139
+ sig {
140
+ returns(T.nilable(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount))
141
+ }
136
142
  attr_accessor :custom_unit_amount
137
143
  # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
138
- sig { returns(String) }
144
+ sig { returns(T.nilable(String)) }
139
145
  attr_accessor :tax_behavior
140
146
  # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
141
- sig { returns(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier]) }
147
+ sig {
148
+ returns(T.nilable(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier]))
149
+ }
142
150
  attr_accessor :tiers
143
151
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
144
- sig { returns(Integer) }
152
+ sig { returns(T.nilable(Integer)) }
145
153
  attr_accessor :unit_amount
146
154
  # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
147
- sig { returns(String) }
155
+ sig { returns(T.nilable(String)) }
148
156
  attr_accessor :unit_amount_decimal
149
157
  sig {
150
- params(custom_unit_amount: ::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount, tax_behavior: String, tiers: T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier], unit_amount: Integer, unit_amount_decimal: String).void
158
+ params(custom_unit_amount: T.nilable(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
151
159
  }
152
160
  def initialize(
153
161
  custom_unit_amount: nil,
@@ -162,28 +170,28 @@ module Stripe
162
170
  sig { returns(T::Boolean) }
163
171
  attr_accessor :enabled
164
172
  # The maximum unit amount the customer can specify for this item.
165
- sig { returns(Integer) }
173
+ sig { returns(T.nilable(Integer)) }
166
174
  attr_accessor :maximum
167
175
  # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
168
- sig { returns(Integer) }
176
+ sig { returns(T.nilable(Integer)) }
169
177
  attr_accessor :minimum
170
178
  # The starting unit amount which can be updated by the customer.
171
- sig { returns(Integer) }
179
+ sig { returns(T.nilable(Integer)) }
172
180
  attr_accessor :preset
173
181
  sig {
174
- params(enabled: T::Boolean, maximum: Integer, minimum: Integer, preset: Integer).void
182
+ params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
175
183
  }
176
184
  def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
177
185
  end
178
186
  class ProductData < Stripe::RequestParams
179
187
  # Whether the product is currently available for purchase. Defaults to `true`.
180
- sig { returns(T::Boolean) }
188
+ sig { returns(T.nilable(T::Boolean)) }
181
189
  attr_accessor :active
182
190
  # The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
183
- sig { returns(String) }
191
+ sig { returns(T.nilable(String)) }
184
192
  attr_accessor :id
185
193
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
186
- sig { returns(T::Hash[String, String]) }
194
+ sig { returns(T.nilable(T::Hash[String, String])) }
187
195
  attr_accessor :metadata
188
196
  # The product's name, meant to be displayable to the customer.
189
197
  sig { returns(String) }
@@ -191,16 +199,16 @@ module Stripe
191
199
  # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
192
200
  #
193
201
  # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
194
- sig { returns(String) }
202
+ sig { returns(T.nilable(String)) }
195
203
  attr_accessor :statement_descriptor
196
204
  # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
197
- sig { returns(String) }
205
+ sig { returns(T.nilable(String)) }
198
206
  attr_accessor :tax_code
199
207
  # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
200
- sig { returns(String) }
208
+ sig { returns(T.nilable(String)) }
201
209
  attr_accessor :unit_label
202
210
  sig {
203
- params(active: T::Boolean, id: String, metadata: T::Hash[String, String], name: String, statement_descriptor: String, tax_code: String, unit_label: String).void
211
+ params(active: T.nilable(T::Boolean), id: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: String, statement_descriptor: T.nilable(String), tax_code: T.nilable(String), unit_label: T.nilable(String)).void
204
212
  }
205
213
  def initialize(
206
214
  active: nil,
@@ -213,29 +221,25 @@ module Stripe
213
221
  ); end
214
222
  end
215
223
  class Recurring < Stripe::RequestParams
216
- # Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.
217
- sig { returns(String) }
218
- attr_accessor :aggregate_usage
219
224
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
220
225
  sig { returns(String) }
221
226
  attr_accessor :interval
222
227
  # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
223
- sig { returns(Integer) }
228
+ sig { returns(T.nilable(Integer)) }
224
229
  attr_accessor :interval_count
225
230
  # The meter tracking the usage of a metered price
226
- sig { returns(String) }
231
+ sig { returns(T.nilable(String)) }
227
232
  attr_accessor :meter
228
233
  # Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
229
- sig { returns(Integer) }
234
+ sig { returns(T.nilable(Integer)) }
230
235
  attr_accessor :trial_period_days
231
236
  # Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
232
- sig { returns(String) }
237
+ sig { returns(T.nilable(String)) }
233
238
  attr_accessor :usage_type
234
239
  sig {
235
- params(aggregate_usage: String, interval: String, interval_count: Integer, meter: String, trial_period_days: Integer, usage_type: String).void
240
+ params(interval: String, interval_count: T.nilable(Integer), meter: T.nilable(String), trial_period_days: T.nilable(Integer), usage_type: T.nilable(String)).void
236
241
  }
237
242
  def initialize(
238
- aggregate_usage: nil,
239
243
  interval: nil,
240
244
  interval_count: nil,
241
245
  meter: nil,
@@ -245,22 +249,22 @@ module Stripe
245
249
  end
246
250
  class Tier < Stripe::RequestParams
247
251
  # The flat billing amount for an entire tier, regardless of the number of units in the tier.
248
- sig { returns(Integer) }
252
+ sig { returns(T.nilable(Integer)) }
249
253
  attr_accessor :flat_amount
250
254
  # Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
251
- sig { returns(String) }
255
+ sig { returns(T.nilable(String)) }
252
256
  attr_accessor :flat_amount_decimal
253
257
  # The per unit billing amount for each individual unit for which this tier applies.
254
- sig { returns(Integer) }
258
+ sig { returns(T.nilable(Integer)) }
255
259
  attr_accessor :unit_amount
256
260
  # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
257
- sig { returns(String) }
261
+ sig { returns(T.nilable(String)) }
258
262
  attr_accessor :unit_amount_decimal
259
263
  # Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
260
264
  sig { returns(T.any(String, Integer)) }
261
265
  attr_accessor :up_to
262
266
  sig {
263
- params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
267
+ params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
264
268
  }
265
269
  def initialize(
266
270
  flat_amount: nil,
@@ -281,64 +285,66 @@ module Stripe
281
285
  def initialize(divide_by: nil, round: nil); end
282
286
  end
283
287
  # Whether the price can be used for new purchases. Defaults to `true`.
284
- sig { returns(T::Boolean) }
288
+ sig { returns(T.nilable(T::Boolean)) }
285
289
  attr_accessor :active
286
290
  # Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
287
- sig { returns(String) }
291
+ sig { returns(T.nilable(String)) }
288
292
  attr_accessor :billing_scheme
289
293
  # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
290
294
  sig { returns(String) }
291
295
  attr_accessor :currency
292
296
  # Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
293
- sig { returns(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions]) }
297
+ sig {
298
+ returns(T.nilable(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions]))
299
+ }
294
300
  attr_accessor :currency_options
295
301
  # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
296
- sig { returns(::Stripe::PriceService::CreateParams::CustomUnitAmount) }
302
+ sig { returns(T.nilable(::Stripe::PriceService::CreateParams::CustomUnitAmount)) }
297
303
  attr_accessor :custom_unit_amount
298
304
  # Specifies which fields in the response should be expanded.
299
- sig { returns(T::Array[String]) }
305
+ sig { returns(T.nilable(T::Array[String])) }
300
306
  attr_accessor :expand
301
307
  # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
302
- sig { returns(String) }
308
+ sig { returns(T.nilable(String)) }
303
309
  attr_accessor :lookup_key
304
310
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
305
- sig { returns(T::Hash[String, String]) }
311
+ sig { returns(T.nilable(T::Hash[String, String])) }
306
312
  attr_accessor :metadata
307
313
  # A brief description of the price, hidden from customers.
308
- sig { returns(String) }
314
+ sig { returns(T.nilable(String)) }
309
315
  attr_accessor :nickname
310
- # The ID of the product that this price will belong to.
311
- sig { returns(String) }
316
+ # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
317
+ sig { returns(T.nilable(String)) }
312
318
  attr_accessor :product
313
319
  # These fields can be used to create a new product that this price will belong to.
314
- sig { returns(::Stripe::PriceService::CreateParams::ProductData) }
320
+ sig { returns(T.nilable(::Stripe::PriceService::CreateParams::ProductData)) }
315
321
  attr_accessor :product_data
316
322
  # The recurring components of a price such as `interval` and `usage_type`.
317
- sig { returns(::Stripe::PriceService::CreateParams::Recurring) }
323
+ sig { returns(T.nilable(::Stripe::PriceService::CreateParams::Recurring)) }
318
324
  attr_accessor :recurring
319
325
  # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
320
- sig { returns(String) }
326
+ sig { returns(T.nilable(String)) }
321
327
  attr_accessor :tax_behavior
322
328
  # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
323
- sig { returns(T::Array[::Stripe::PriceService::CreateParams::Tier]) }
329
+ sig { returns(T.nilable(T::Array[::Stripe::PriceService::CreateParams::Tier])) }
324
330
  attr_accessor :tiers
325
331
  # Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.
326
- sig { returns(String) }
332
+ sig { returns(T.nilable(String)) }
327
333
  attr_accessor :tiers_mode
328
334
  # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
329
- sig { returns(T::Boolean) }
335
+ sig { returns(T.nilable(T::Boolean)) }
330
336
  attr_accessor :transfer_lookup_key
331
337
  # Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
332
- sig { returns(::Stripe::PriceService::CreateParams::TransformQuantity) }
338
+ sig { returns(T.nilable(::Stripe::PriceService::CreateParams::TransformQuantity)) }
333
339
  attr_accessor :transform_quantity
334
340
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.
335
- sig { returns(Integer) }
341
+ sig { returns(T.nilable(Integer)) }
336
342
  attr_accessor :unit_amount
337
343
  # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
338
- sig { returns(String) }
344
+ sig { returns(T.nilable(String)) }
339
345
  attr_accessor :unit_amount_decimal
340
346
  sig {
341
- params(active: T::Boolean, billing_scheme: String, currency: String, currency_options: T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions], custom_unit_amount: ::Stripe::PriceService::CreateParams::CustomUnitAmount, expand: T::Array[String], lookup_key: String, metadata: T::Hash[String, String], nickname: String, product: String, product_data: ::Stripe::PriceService::CreateParams::ProductData, recurring: ::Stripe::PriceService::CreateParams::Recurring, tax_behavior: String, tiers: T::Array[::Stripe::PriceService::CreateParams::Tier], tiers_mode: String, transfer_lookup_key: T::Boolean, transform_quantity: ::Stripe::PriceService::CreateParams::TransformQuantity, unit_amount: Integer, unit_amount_decimal: String).void
347
+ params(active: T.nilable(T::Boolean), billing_scheme: T.nilable(String), currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions]), custom_unit_amount: T.nilable(::Stripe::PriceService::CreateParams::CustomUnitAmount), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), nickname: T.nilable(String), product: T.nilable(String), product_data: T.nilable(::Stripe::PriceService::CreateParams::ProductData), recurring: T.nilable(::Stripe::PriceService::CreateParams::Recurring), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::CreateParams::Tier]), tiers_mode: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean), transform_quantity: T.nilable(::Stripe::PriceService::CreateParams::TransformQuantity), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
342
348
  }
343
349
  def initialize(
344
350
  active: nil,
@@ -364,9 +370,9 @@ module Stripe
364
370
  end
365
371
  class RetrieveParams < Stripe::RequestParams
366
372
  # Specifies which fields in the response should be expanded.
367
- sig { returns(T::Array[String]) }
373
+ sig { returns(T.nilable(T::Array[String])) }
368
374
  attr_accessor :expand
369
- sig { params(expand: T::Array[String]).void }
375
+ sig { params(expand: T.nilable(T::Array[String])).void }
370
376
  def initialize(expand: nil); end
371
377
  end
372
378
  class UpdateParams < Stripe::RequestParams
@@ -376,37 +382,37 @@ module Stripe
376
382
  sig { returns(T::Boolean) }
377
383
  attr_accessor :enabled
378
384
  # The maximum unit amount the customer can specify for this item.
379
- sig { returns(Integer) }
385
+ sig { returns(T.nilable(Integer)) }
380
386
  attr_accessor :maximum
381
387
  # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
382
- sig { returns(Integer) }
388
+ sig { returns(T.nilable(Integer)) }
383
389
  attr_accessor :minimum
384
390
  # The starting unit amount which can be updated by the customer.
385
- sig { returns(Integer) }
391
+ sig { returns(T.nilable(Integer)) }
386
392
  attr_accessor :preset
387
393
  sig {
388
- params(enabled: T::Boolean, maximum: Integer, minimum: Integer, preset: Integer).void
394
+ params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
389
395
  }
390
396
  def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
391
397
  end
392
398
  class Tier < Stripe::RequestParams
393
399
  # The flat billing amount for an entire tier, regardless of the number of units in the tier.
394
- sig { returns(Integer) }
400
+ sig { returns(T.nilable(Integer)) }
395
401
  attr_accessor :flat_amount
396
402
  # Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
397
- sig { returns(String) }
403
+ sig { returns(T.nilable(String)) }
398
404
  attr_accessor :flat_amount_decimal
399
405
  # The per unit billing amount for each individual unit for which this tier applies.
400
- sig { returns(Integer) }
406
+ sig { returns(T.nilable(Integer)) }
401
407
  attr_accessor :unit_amount
402
408
  # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
403
- sig { returns(String) }
409
+ sig { returns(T.nilable(String)) }
404
410
  attr_accessor :unit_amount_decimal
405
411
  # Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
406
412
  sig { returns(T.any(String, Integer)) }
407
413
  attr_accessor :up_to
408
414
  sig {
409
- params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
415
+ params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
410
416
  }
411
417
  def initialize(
412
418
  flat_amount: nil,
@@ -417,22 +423,26 @@ module Stripe
417
423
  ); end
418
424
  end
419
425
  # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
420
- sig { returns(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount) }
426
+ sig {
427
+ returns(T.nilable(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount))
428
+ }
421
429
  attr_accessor :custom_unit_amount
422
430
  # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
423
- sig { returns(String) }
431
+ sig { returns(T.nilable(String)) }
424
432
  attr_accessor :tax_behavior
425
433
  # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
426
- sig { returns(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier]) }
434
+ sig {
435
+ returns(T.nilable(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier]))
436
+ }
427
437
  attr_accessor :tiers
428
438
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
429
- sig { returns(Integer) }
439
+ sig { returns(T.nilable(Integer)) }
430
440
  attr_accessor :unit_amount
431
441
  # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
432
- sig { returns(String) }
442
+ sig { returns(T.nilable(String)) }
433
443
  attr_accessor :unit_amount_decimal
434
444
  sig {
435
- params(custom_unit_amount: ::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount, tax_behavior: String, tiers: T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier], unit_amount: Integer, unit_amount_decimal: String).void
445
+ params(custom_unit_amount: T.nilable(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
436
446
  }
437
447
  def initialize(
438
448
  custom_unit_amount: nil,
@@ -442,50 +452,34 @@ module Stripe
442
452
  unit_amount_decimal: nil
443
453
  ); end
444
454
  end
445
- class MigrateTo < Stripe::RequestParams
446
- # The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
447
- sig { returns(String) }
448
- attr_accessor :behavior
449
- # The time after which subscriptions should start using the new price.
450
- sig { returns(Integer) }
451
- attr_accessor :effective_after
452
- # The ID of the price object.
453
- sig { returns(String) }
454
- attr_accessor :price
455
- sig { params(behavior: String, effective_after: Integer, price: String).void }
456
- def initialize(behavior: nil, effective_after: nil, price: nil); end
457
- end
458
455
  # Whether the price can be used for new purchases. Defaults to `true`.
459
- sig { returns(T::Boolean) }
456
+ sig { returns(T.nilable(T::Boolean)) }
460
457
  attr_accessor :active
461
458
  # Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
462
459
  sig {
463
- returns(T.nilable(T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]))
460
+ returns(T.nilable(T.nilable(T.any(String, T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]))))
464
461
  }
465
462
  attr_accessor :currency_options
466
463
  # Specifies which fields in the response should be expanded.
467
- sig { returns(T::Array[String]) }
464
+ sig { returns(T.nilable(T::Array[String])) }
468
465
  attr_accessor :expand
469
466
  # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
470
- sig { returns(String) }
467
+ sig { returns(T.nilable(String)) }
471
468
  attr_accessor :lookup_key
472
469
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
473
- sig { returns(T.nilable(T::Hash[String, String])) }
470
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
474
471
  attr_accessor :metadata
475
- # If specified, subscriptions using this price will be updated to use the new referenced price.
476
- sig { returns(T.nilable(::Stripe::PriceService::UpdateParams::MigrateTo)) }
477
- attr_accessor :migrate_to
478
472
  # A brief description of the price, hidden from customers.
479
- sig { returns(String) }
473
+ sig { returns(T.nilable(String)) }
480
474
  attr_accessor :nickname
481
475
  # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
482
- sig { returns(String) }
476
+ sig { returns(T.nilable(String)) }
483
477
  attr_accessor :tax_behavior
484
478
  # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
485
- sig { returns(T::Boolean) }
479
+ sig { returns(T.nilable(T::Boolean)) }
486
480
  attr_accessor :transfer_lookup_key
487
481
  sig {
488
- params(active: T::Boolean, currency_options: T.nilable(T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]), expand: T::Array[String], lookup_key: String, metadata: T.nilable(T::Hash[String, String]), migrate_to: T.nilable(::Stripe::PriceService::UpdateParams::MigrateTo), nickname: String, tax_behavior: String, transfer_lookup_key: T::Boolean).void
482
+ params(active: T.nilable(T::Boolean), currency_options: T.nilable(T.nilable(T.any(String, T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]))), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), nickname: T.nilable(String), tax_behavior: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean)).void
489
483
  }
490
484
  def initialize(
491
485
  active: nil,
@@ -493,7 +487,6 @@ module Stripe
493
487
  expand: nil,
494
488
  lookup_key: nil,
495
489
  metadata: nil,
496
- migrate_to: nil,
497
490
  nickname: nil,
498
491
  tax_behavior: nil,
499
492
  transfer_lookup_key: nil
@@ -501,21 +494,23 @@ module Stripe
501
494
  end
502
495
  class SearchParams < Stripe::RequestParams
503
496
  # Specifies which fields in the response should be expanded.
504
- sig { returns(T::Array[String]) }
497
+ sig { returns(T.nilable(T::Array[String])) }
505
498
  attr_accessor :expand
506
499
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
507
- sig { returns(Integer) }
500
+ sig { returns(T.nilable(Integer)) }
508
501
  attr_accessor :limit
509
502
  # A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
510
- sig { returns(String) }
503
+ sig { returns(T.nilable(String)) }
511
504
  attr_accessor :page
512
505
  # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices).
513
506
  sig { returns(String) }
514
507
  attr_accessor :query
515
- sig { params(expand: T::Array[String], limit: Integer, page: String, query: String).void }
508
+ sig {
509
+ params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
510
+ }
516
511
  def initialize(expand: nil, limit: nil, page: nil, query: nil); end
517
512
  end
518
- # Creates a new price for an existing product. The price can be recurring or one-time.
513
+ # Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
519
514
  sig {
520
515
  params(params: T.any(::Stripe::PriceService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
521
516
  }
@@ -9,26 +9,26 @@ module Stripe
9
9
  end
10
10
  class RetrieveParams < Stripe::RequestParams
11
11
  # Specifies which fields in the response should be expanded.
12
- sig { returns(T::Array[String]) }
12
+ sig { returns(T.nilable(T::Array[String])) }
13
13
  attr_accessor :expand
14
- sig { params(expand: T::Array[String]).void }
14
+ sig { params(expand: T.nilable(T::Array[String])).void }
15
15
  def initialize(expand: nil); end
16
16
  end
17
17
  class ListParams < Stripe::RequestParams
18
18
  # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
19
- sig { returns(String) }
19
+ sig { returns(T.nilable(String)) }
20
20
  attr_accessor :ending_before
21
21
  # Specifies which fields in the response should be expanded.
22
- sig { returns(T::Array[String]) }
22
+ sig { returns(T.nilable(T::Array[String])) }
23
23
  attr_accessor :expand
24
24
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
25
- sig { returns(Integer) }
25
+ sig { returns(T.nilable(Integer)) }
26
26
  attr_accessor :limit
27
27
  # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
28
- sig { returns(String) }
28
+ sig { returns(T.nilable(String)) }
29
29
  attr_accessor :starting_after
30
30
  sig {
31
- params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
31
+ params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
32
32
  }
33
33
  def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
34
34
  end
@@ -37,9 +37,9 @@ module Stripe
37
37
  sig { returns(String) }
38
38
  attr_accessor :entitlement_feature
39
39
  # Specifies which fields in the response should be expanded.
40
- sig { returns(T::Array[String]) }
40
+ sig { returns(T.nilable(T::Array[String])) }
41
41
  attr_accessor :expand
42
- sig { params(entitlement_feature: String, expand: T::Array[String]).void }
42
+ sig { params(entitlement_feature: String, expand: T.nilable(T::Array[String])).void }
43
43
  def initialize(entitlement_feature: nil, expand: nil); end
44
44
  end
45
45
  # Creates a product_feature, which represents a feature attachment to a product