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,25 +7,25 @@ module Stripe
7
7
  class ConfigurationService < StripeService
8
8
  class ListParams < Stripe::RequestParams
9
9
  # Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).
10
- sig { returns(T::Boolean) }
10
+ sig { returns(T.nilable(T::Boolean)) }
11
11
  attr_accessor :active
12
12
  # 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.
13
- sig { returns(String) }
13
+ sig { returns(T.nilable(String)) }
14
14
  attr_accessor :ending_before
15
15
  # Specifies which fields in the response should be expanded.
16
- sig { returns(T::Array[String]) }
16
+ sig { returns(T.nilable(T::Array[String])) }
17
17
  attr_accessor :expand
18
18
  # Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).
19
- sig { returns(T::Boolean) }
19
+ sig { returns(T.nilable(T::Boolean)) }
20
20
  attr_accessor :is_default
21
21
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
22
- sig { returns(Integer) }
22
+ sig { returns(T.nilable(Integer)) }
23
23
  attr_accessor :limit
24
24
  # 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.
25
- sig { returns(String) }
25
+ sig { returns(T.nilable(String)) }
26
26
  attr_accessor :starting_after
27
27
  sig {
28
- params(active: T::Boolean, ending_before: String, expand: T::Array[String], is_default: T::Boolean, limit: Integer, starting_after: String).void
28
+ params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), is_default: T.nilable(T::Boolean), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
29
29
  }
30
30
  def initialize(
31
31
  active: nil,
@@ -39,28 +39,30 @@ module Stripe
39
39
  class CreateParams < Stripe::RequestParams
40
40
  class BusinessProfile < Stripe::RequestParams
41
41
  # The messaging shown to customers in the portal.
42
- sig { returns(T.nilable(String)) }
42
+ sig { returns(T.nilable(T.nilable(String))) }
43
43
  attr_accessor :headline
44
44
  # A link to the business’s publicly available privacy policy.
45
- sig { returns(String) }
45
+ sig { returns(T.nilable(String)) }
46
46
  attr_accessor :privacy_policy_url
47
47
  # A link to the business’s publicly available terms of service.
48
- sig { returns(String) }
48
+ sig { returns(T.nilable(String)) }
49
49
  attr_accessor :terms_of_service_url
50
50
  sig {
51
- params(headline: T.nilable(String), privacy_policy_url: String, terms_of_service_url: String).void
51
+ params(headline: T.nilable(T.nilable(String)), privacy_policy_url: T.nilable(String), terms_of_service_url: T.nilable(String)).void
52
52
  }
53
53
  def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
54
54
  end
55
55
  class Features < Stripe::RequestParams
56
56
  class CustomerUpdate < Stripe::RequestParams
57
57
  # The types of customer updates that are supported. When empty, customers are not updateable.
58
- sig { returns(T.nilable(T::Array[String])) }
58
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
59
59
  attr_accessor :allowed_updates
60
60
  # Whether the feature is enabled.
61
61
  sig { returns(T::Boolean) }
62
62
  attr_accessor :enabled
63
- sig { params(allowed_updates: T.nilable(T::Array[String]), enabled: T::Boolean).void }
63
+ sig {
64
+ params(allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T::Boolean).void
65
+ }
64
66
  def initialize(allowed_updates: nil, enabled: nil); end
65
67
  end
66
68
  class InvoiceHistory < Stripe::RequestParams
@@ -83,27 +85,29 @@ module Stripe
83
85
  sig { returns(T::Boolean) }
84
86
  attr_accessor :enabled
85
87
  # Which cancellation reasons will be given as options to the customer.
86
- sig { returns(T.nilable(T::Array[String])) }
88
+ sig { returns(T.nilable(T.any(String, T::Array[String]))) }
87
89
  attr_accessor :options
88
- sig { params(enabled: T::Boolean, options: T.nilable(T::Array[String])).void }
90
+ sig {
91
+ params(enabled: T::Boolean, options: T.nilable(T.any(String, T::Array[String]))).void
92
+ }
89
93
  def initialize(enabled: nil, options: nil); end
90
94
  end
91
95
  # Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
92
96
  sig {
93
- returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel::CancellationReason)
97
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel::CancellationReason))
94
98
  }
95
99
  attr_accessor :cancellation_reason
96
100
  # Whether the feature is enabled.
97
101
  sig { returns(T::Boolean) }
98
102
  attr_accessor :enabled
99
103
  # Whether to cancel subscriptions immediately or at the end of the billing period.
100
- sig { returns(String) }
104
+ sig { returns(T.nilable(String)) }
101
105
  attr_accessor :mode
102
106
  # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
103
- sig { returns(String) }
107
+ sig { returns(T.nilable(String)) }
104
108
  attr_accessor :proration_behavior
105
109
  sig {
106
- params(cancellation_reason: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel::CancellationReason, enabled: T::Boolean, mode: String, proration_behavior: String).void
110
+ params(cancellation_reason: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel::CancellationReason), enabled: T::Boolean, mode: T.nilable(String), proration_behavior: T.nilable(String)).void
107
111
  }
108
112
  def initialize(
109
113
  cancellation_reason: nil,
@@ -133,35 +137,35 @@ module Stripe
133
137
  end
134
138
  # List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
135
139
  sig {
136
- returns(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])
140
+ returns(T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))
137
141
  }
138
142
  attr_accessor :conditions
139
143
  sig {
140
- params(conditions: T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]).void
144
+ params(conditions: T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])).void
141
145
  }
142
146
  def initialize(conditions: nil); end
143
147
  end
144
148
  # The types of subscription updates that are supported. When empty, subscriptions are not updateable.
145
- sig { returns(T.nilable(T::Array[String])) }
149
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
146
150
  attr_accessor :default_allowed_updates
147
151
  # Whether the feature is enabled.
148
152
  sig { returns(T::Boolean) }
149
153
  attr_accessor :enabled
150
154
  # The list of up to 10 products that support subscription updates.
151
155
  sig {
152
- returns(T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product]))
156
+ returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product]))))
153
157
  }
154
158
  attr_accessor :products
155
159
  # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
156
- sig { returns(String) }
160
+ sig { returns(T.nilable(String)) }
157
161
  attr_accessor :proration_behavior
158
162
  # Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
159
163
  sig {
160
- returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)
164
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
161
165
  }
162
166
  attr_accessor :schedule_at_period_end
163
167
  sig {
164
- params(default_allowed_updates: T.nilable(T::Array[String]), enabled: T::Boolean, products: T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product]), proration_behavior: String, schedule_at_period_end: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd).void
168
+ params(default_allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T::Boolean, products: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product]))), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).void
165
169
  }
166
170
  def initialize(
167
171
  default_allowed_updates: nil,
@@ -173,31 +177,31 @@ module Stripe
173
177
  end
174
178
  # Information about updating the customer details in the portal.
175
179
  sig {
176
- returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::CustomerUpdate)
180
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::CustomerUpdate))
177
181
  }
178
182
  attr_accessor :customer_update
179
183
  # Information about showing the billing history in the portal.
180
184
  sig {
181
- returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::InvoiceHistory)
185
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::InvoiceHistory))
182
186
  }
183
187
  attr_accessor :invoice_history
184
188
  # Information about updating payment methods in the portal.
185
189
  sig {
186
- returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::PaymentMethodUpdate)
190
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::PaymentMethodUpdate))
187
191
  }
188
192
  attr_accessor :payment_method_update
189
193
  # Information about canceling subscriptions in the portal.
190
194
  sig {
191
- returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel)
195
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel))
192
196
  }
193
197
  attr_accessor :subscription_cancel
194
198
  # Information about updating subscriptions in the portal.
195
199
  sig {
196
- returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate)
200
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate))
197
201
  }
198
202
  attr_accessor :subscription_update
199
203
  sig {
200
- params(customer_update: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::CustomerUpdate, invoice_history: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::InvoiceHistory, payment_method_update: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::PaymentMethodUpdate, subscription_cancel: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel, subscription_update: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate).void
204
+ params(customer_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate)).void
201
205
  }
202
206
  def initialize(
203
207
  customer_update: nil,
@@ -216,26 +220,28 @@ module Stripe
216
220
  end
217
221
  # The business information shown to customers in the portal.
218
222
  sig {
219
- returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::BusinessProfile)
223
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::BusinessProfile))
220
224
  }
221
225
  attr_accessor :business_profile
222
226
  # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
223
- sig { returns(T.nilable(String)) }
227
+ sig { returns(T.nilable(T.nilable(String))) }
224
228
  attr_accessor :default_return_url
225
229
  # Specifies which fields in the response should be expanded.
226
- sig { returns(T::Array[String]) }
230
+ sig { returns(T.nilable(T::Array[String])) }
227
231
  attr_accessor :expand
228
232
  # Information about the features available in the portal.
229
233
  sig { returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features) }
230
234
  attr_accessor :features
231
235
  # The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
232
- sig { returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::LoginPage) }
236
+ sig {
237
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::LoginPage))
238
+ }
233
239
  attr_accessor :login_page
234
240
  # 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`.
235
- sig { returns(T::Hash[String, String]) }
241
+ sig { returns(T.nilable(T::Hash[String, String])) }
236
242
  attr_accessor :metadata
237
243
  sig {
238
- params(business_profile: ::Stripe::BillingPortal::ConfigurationService::CreateParams::BusinessProfile, default_return_url: T.nilable(String), expand: T::Array[String], features: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features, login_page: ::Stripe::BillingPortal::ConfigurationService::CreateParams::LoginPage, metadata: T::Hash[String, String]).void
244
+ params(business_profile: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::BusinessProfile), default_return_url: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), features: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features, login_page: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::LoginPage), metadata: T.nilable(T::Hash[String, String])).void
239
245
  }
240
246
  def initialize(
241
247
  business_profile: nil,
@@ -248,36 +254,38 @@ module Stripe
248
254
  end
249
255
  class RetrieveParams < Stripe::RequestParams
250
256
  # Specifies which fields in the response should be expanded.
251
- sig { returns(T::Array[String]) }
257
+ sig { returns(T.nilable(T::Array[String])) }
252
258
  attr_accessor :expand
253
- sig { params(expand: T::Array[String]).void }
259
+ sig { params(expand: T.nilable(T::Array[String])).void }
254
260
  def initialize(expand: nil); end
255
261
  end
256
262
  class UpdateParams < Stripe::RequestParams
257
263
  class BusinessProfile < Stripe::RequestParams
258
264
  # The messaging shown to customers in the portal.
259
- sig { returns(T.nilable(String)) }
265
+ sig { returns(T.nilable(T.nilable(String))) }
260
266
  attr_accessor :headline
261
267
  # A link to the business’s publicly available privacy policy.
262
- sig { returns(T.nilable(String)) }
268
+ sig { returns(T.nilable(T.nilable(String))) }
263
269
  attr_accessor :privacy_policy_url
264
270
  # A link to the business’s publicly available terms of service.
265
- sig { returns(T.nilable(String)) }
271
+ sig { returns(T.nilable(T.nilable(String))) }
266
272
  attr_accessor :terms_of_service_url
267
273
  sig {
268
- params(headline: T.nilable(String), privacy_policy_url: T.nilable(String), terms_of_service_url: T.nilable(String)).void
274
+ params(headline: T.nilable(T.nilable(String)), privacy_policy_url: T.nilable(T.nilable(String)), terms_of_service_url: T.nilable(T.nilable(String))).void
269
275
  }
270
276
  def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
271
277
  end
272
278
  class Features < Stripe::RequestParams
273
279
  class CustomerUpdate < Stripe::RequestParams
274
280
  # The types of customer updates that are supported. When empty, customers are not updateable.
275
- sig { returns(T.nilable(T::Array[String])) }
281
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
276
282
  attr_accessor :allowed_updates
277
283
  # Whether the feature is enabled.
278
- sig { returns(T::Boolean) }
284
+ sig { returns(T.nilable(T::Boolean)) }
279
285
  attr_accessor :enabled
280
- sig { params(allowed_updates: T.nilable(T::Array[String]), enabled: T::Boolean).void }
286
+ sig {
287
+ params(allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T.nilable(T::Boolean)).void
288
+ }
281
289
  def initialize(allowed_updates: nil, enabled: nil); end
282
290
  end
283
291
  class InvoiceHistory < Stripe::RequestParams
@@ -300,27 +308,29 @@ module Stripe
300
308
  sig { returns(T::Boolean) }
301
309
  attr_accessor :enabled
302
310
  # Which cancellation reasons will be given as options to the customer.
303
- sig { returns(T.nilable(T::Array[String])) }
311
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
304
312
  attr_accessor :options
305
- sig { params(enabled: T::Boolean, options: T.nilable(T::Array[String])).void }
313
+ sig {
314
+ params(enabled: T::Boolean, options: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
315
+ }
306
316
  def initialize(enabled: nil, options: nil); end
307
317
  end
308
318
  # Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
309
319
  sig {
310
- returns(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel::CancellationReason)
320
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel::CancellationReason))
311
321
  }
312
322
  attr_accessor :cancellation_reason
313
323
  # Whether the feature is enabled.
314
- sig { returns(T::Boolean) }
324
+ sig { returns(T.nilable(T::Boolean)) }
315
325
  attr_accessor :enabled
316
326
  # Whether to cancel subscriptions immediately or at the end of the billing period.
317
- sig { returns(String) }
327
+ sig { returns(T.nilable(String)) }
318
328
  attr_accessor :mode
319
329
  # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
320
- sig { returns(String) }
330
+ sig { returns(T.nilable(String)) }
321
331
  attr_accessor :proration_behavior
322
332
  sig {
323
- params(cancellation_reason: ::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel::CancellationReason, enabled: T::Boolean, mode: String, proration_behavior: String).void
333
+ params(cancellation_reason: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel::CancellationReason), enabled: T.nilable(T::Boolean), mode: T.nilable(String), proration_behavior: T.nilable(String)).void
324
334
  }
325
335
  def initialize(
326
336
  cancellation_reason: nil,
@@ -350,35 +360,35 @@ module Stripe
350
360
  end
351
361
  # List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
352
362
  sig {
353
- returns(T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))
363
+ returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))))
354
364
  }
355
365
  attr_accessor :conditions
356
366
  sig {
357
- params(conditions: T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])).void
367
+ params(conditions: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])))).void
358
368
  }
359
369
  def initialize(conditions: nil); end
360
370
  end
361
371
  # The types of subscription updates that are supported. When empty, subscriptions are not updateable.
362
- sig { returns(T.nilable(T::Array[String])) }
372
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
363
373
  attr_accessor :default_allowed_updates
364
374
  # Whether the feature is enabled.
365
- sig { returns(T::Boolean) }
375
+ sig { returns(T.nilable(T::Boolean)) }
366
376
  attr_accessor :enabled
367
377
  # The list of up to 10 products that support subscription updates.
368
378
  sig {
369
- returns(T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product]))
379
+ returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product]))))
370
380
  }
371
381
  attr_accessor :products
372
382
  # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
373
- sig { returns(String) }
383
+ sig { returns(T.nilable(String)) }
374
384
  attr_accessor :proration_behavior
375
385
  # Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
376
386
  sig {
377
- returns(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)
387
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
378
388
  }
379
389
  attr_accessor :schedule_at_period_end
380
390
  sig {
381
- params(default_allowed_updates: T.nilable(T::Array[String]), enabled: T::Boolean, products: T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product]), proration_behavior: String, schedule_at_period_end: ::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd).void
391
+ params(default_allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T.nilable(T::Boolean), products: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product]))), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).void
382
392
  }
383
393
  def initialize(
384
394
  default_allowed_updates: nil,
@@ -390,31 +400,31 @@ module Stripe
390
400
  end
391
401
  # Information about updating the customer details in the portal.
392
402
  sig {
393
- returns(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::CustomerUpdate)
403
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::CustomerUpdate))
394
404
  }
395
405
  attr_accessor :customer_update
396
406
  # Information about showing the billing history in the portal.
397
407
  sig {
398
- returns(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::InvoiceHistory)
408
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::InvoiceHistory))
399
409
  }
400
410
  attr_accessor :invoice_history
401
411
  # Information about updating payment methods in the portal.
402
412
  sig {
403
- returns(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::PaymentMethodUpdate)
413
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::PaymentMethodUpdate))
404
414
  }
405
415
  attr_accessor :payment_method_update
406
416
  # Information about canceling subscriptions in the portal.
407
417
  sig {
408
- returns(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel)
418
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel))
409
419
  }
410
420
  attr_accessor :subscription_cancel
411
421
  # Information about updating subscriptions in the portal.
412
422
  sig {
413
- returns(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate)
423
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate))
414
424
  }
415
425
  attr_accessor :subscription_update
416
426
  sig {
417
- params(customer_update: ::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::CustomerUpdate, invoice_history: ::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::InvoiceHistory, payment_method_update: ::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::PaymentMethodUpdate, subscription_cancel: ::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel, subscription_update: ::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate).void
427
+ params(customer_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate)).void
418
428
  }
419
429
  def initialize(
420
430
  customer_update: nil,
@@ -434,30 +444,34 @@ module Stripe
434
444
  def initialize(enabled: nil); end
435
445
  end
436
446
  # Whether the configuration is active and can be used to create portal sessions.
437
- sig { returns(T::Boolean) }
447
+ sig { returns(T.nilable(T::Boolean)) }
438
448
  attr_accessor :active
439
449
  # The business information shown to customers in the portal.
440
450
  sig {
441
- returns(::Stripe::BillingPortal::ConfigurationService::UpdateParams::BusinessProfile)
451
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::BusinessProfile))
442
452
  }
443
453
  attr_accessor :business_profile
444
454
  # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
445
- sig { returns(T.nilable(String)) }
455
+ sig { returns(T.nilable(T.nilable(String))) }
446
456
  attr_accessor :default_return_url
447
457
  # Specifies which fields in the response should be expanded.
448
- sig { returns(T::Array[String]) }
458
+ sig { returns(T.nilable(T::Array[String])) }
449
459
  attr_accessor :expand
450
460
  # Information about the features available in the portal.
451
- sig { returns(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features) }
461
+ sig {
462
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features))
463
+ }
452
464
  attr_accessor :features
453
465
  # The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
454
- sig { returns(::Stripe::BillingPortal::ConfigurationService::UpdateParams::LoginPage) }
466
+ sig {
467
+ returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::LoginPage))
468
+ }
455
469
  attr_accessor :login_page
456
470
  # 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`.
457
- sig { returns(T.nilable(T::Hash[String, String])) }
471
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
458
472
  attr_accessor :metadata
459
473
  sig {
460
- params(active: T::Boolean, business_profile: ::Stripe::BillingPortal::ConfigurationService::UpdateParams::BusinessProfile, default_return_url: T.nilable(String), expand: T::Array[String], features: ::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features, login_page: ::Stripe::BillingPortal::ConfigurationService::UpdateParams::LoginPage, metadata: T.nilable(T::Hash[String, String])).void
474
+ params(active: T.nilable(T::Boolean), business_profile: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::BusinessProfile), default_return_url: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), features: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features), login_page: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::LoginPage), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
461
475
  }
462
476
  def initialize(
463
477
  active: nil,
@@ -10,9 +10,9 @@ module Stripe
10
10
  class AfterCompletion < Stripe::RequestParams
11
11
  class HostedConfirmation < Stripe::RequestParams
12
12
  # A custom message to display to the customer after the flow is completed.
13
- sig { returns(String) }
13
+ sig { returns(T.nilable(String)) }
14
14
  attr_accessor :custom_message
15
- sig { params(custom_message: String).void }
15
+ sig { params(custom_message: T.nilable(String)).void }
16
16
  def initialize(custom_message: nil); end
17
17
  end
18
18
  class Redirect < Stripe::RequestParams
@@ -24,19 +24,19 @@ module Stripe
24
24
  end
25
25
  # Configuration when `after_completion.type=hosted_confirmation`.
26
26
  sig {
27
- returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::HostedConfirmation)
27
+ returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::HostedConfirmation))
28
28
  }
29
29
  attr_accessor :hosted_confirmation
30
30
  # Configuration when `after_completion.type=redirect`.
31
31
  sig {
32
- returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::Redirect)
32
+ returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::Redirect))
33
33
  }
34
34
  attr_accessor :redirect
35
35
  # The specified behavior after the flow is completed.
36
36
  sig { returns(String) }
37
37
  attr_accessor :type
38
38
  sig {
39
- params(hosted_confirmation: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::HostedConfirmation, redirect: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::Redirect, type: String).void
39
+ params(hosted_confirmation: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion::Redirect), type: String).void
40
40
  }
41
41
  def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
42
42
  end
@@ -64,14 +64,14 @@ module Stripe
64
64
  end
65
65
  # Specify a retention strategy to be used in the cancellation flow.
66
66
  sig {
67
- returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention)
67
+ returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention))
68
68
  }
69
69
  attr_accessor :retention
70
70
  # The ID of the subscription to be canceled.
71
71
  sig { returns(String) }
72
72
  attr_accessor :subscription
73
73
  sig {
74
- params(retention: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention, subscription: String).void
74
+ params(retention: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel::Retention), subscription: String).void
75
75
  }
76
76
  def initialize(retention: nil, subscription: nil); end
77
77
  end
@@ -85,12 +85,12 @@ module Stripe
85
85
  class SubscriptionUpdateConfirm < Stripe::RequestParams
86
86
  class Discount < Stripe::RequestParams
87
87
  # The ID of the coupon to apply to this subscription update.
88
- sig { returns(String) }
88
+ sig { returns(T.nilable(String)) }
89
89
  attr_accessor :coupon
90
90
  # The ID of a promotion code to apply to this subscription update.
91
- sig { returns(String) }
91
+ sig { returns(T.nilable(String)) }
92
92
  attr_accessor :promotion_code
93
- sig { params(coupon: String, promotion_code: String).void }
93
+ sig { params(coupon: T.nilable(String), promotion_code: T.nilable(String)).void }
94
94
  def initialize(coupon: nil, promotion_code: nil); end
95
95
  end
96
96
  class Item < Stripe::RequestParams
@@ -98,17 +98,19 @@ module Stripe
98
98
  sig { returns(String) }
99
99
  attr_accessor :id
100
100
  # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
101
- sig { returns(String) }
101
+ sig { returns(T.nilable(String)) }
102
102
  attr_accessor :price
103
103
  # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
104
- sig { returns(Integer) }
104
+ sig { returns(T.nilable(Integer)) }
105
105
  attr_accessor :quantity
106
- sig { params(id: String, price: String, quantity: Integer).void }
106
+ sig {
107
+ params(id: String, price: T.nilable(String), quantity: T.nilable(Integer)).void
108
+ }
107
109
  def initialize(id: nil, price: nil, quantity: nil); end
108
110
  end
109
111
  # The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
110
112
  sig {
111
- returns(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount])
113
+ returns(T.nilable(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
112
114
  }
113
115
  attr_accessor :discounts
114
116
  # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
@@ -120,35 +122,35 @@ module Stripe
120
122
  sig { returns(String) }
121
123
  attr_accessor :subscription
122
124
  sig {
123
- params(discounts: T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount], items: T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Item], subscription: String).void
125
+ params(discounts: T.nilable(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]), items: T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Item], subscription: String).void
124
126
  }
125
127
  def initialize(discounts: nil, items: nil, subscription: nil); end
126
128
  end
127
129
  # Behavior after the flow is completed.
128
130
  sig {
129
- returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion)
131
+ returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion))
130
132
  }
131
133
  attr_accessor :after_completion
132
134
  # Configuration when `flow_data.type=subscription_cancel`.
133
135
  sig {
134
- returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel)
136
+ returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel))
135
137
  }
136
138
  attr_accessor :subscription_cancel
137
139
  # Configuration when `flow_data.type=subscription_update`.
138
140
  sig {
139
- returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdate)
141
+ returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdate))
140
142
  }
141
143
  attr_accessor :subscription_update
142
144
  # Configuration when `flow_data.type=subscription_update_confirm`.
143
145
  sig {
144
- returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm)
146
+ returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm))
145
147
  }
146
148
  attr_accessor :subscription_update_confirm
147
149
  # Type of flow that the customer will go through.
148
150
  sig { returns(String) }
149
151
  attr_accessor :type
150
152
  sig {
151
- params(after_completion: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion, subscription_cancel: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel, subscription_update: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdate, subscription_update_confirm: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm, type: String).void
153
+ params(after_completion: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::AfterCompletion), subscription_cancel: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdate), subscription_update_confirm: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm), type: String).void
152
154
  }
153
155
  def initialize(
154
156
  after_completion: nil,
@@ -159,28 +161,28 @@ module Stripe
159
161
  ); end
160
162
  end
161
163
  # The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
162
- sig { returns(String) }
164
+ sig { returns(T.nilable(String)) }
163
165
  attr_accessor :configuration
164
166
  # The ID of an existing customer.
165
167
  sig { returns(String) }
166
168
  attr_accessor :customer
167
169
  # Specifies which fields in the response should be expanded.
168
- sig { returns(T::Array[String]) }
170
+ sig { returns(T.nilable(T::Array[String])) }
169
171
  attr_accessor :expand
170
172
  # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
171
- sig { returns(::Stripe::BillingPortal::SessionService::CreateParams::FlowData) }
173
+ sig { returns(T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData)) }
172
174
  attr_accessor :flow_data
173
175
  # The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
174
- sig { returns(String) }
176
+ sig { returns(T.nilable(String)) }
175
177
  attr_accessor :locale
176
178
  # The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
177
- sig { returns(String) }
179
+ sig { returns(T.nilable(String)) }
178
180
  attr_accessor :on_behalf_of
179
181
  # The default URL to redirect customers to when they click on the portal's link to return to your website.
180
- sig { returns(String) }
182
+ sig { returns(T.nilable(String)) }
181
183
  attr_accessor :return_url
182
184
  sig {
183
- params(configuration: String, customer: String, expand: T::Array[String], flow_data: ::Stripe::BillingPortal::SessionService::CreateParams::FlowData, locale: String, on_behalf_of: String, return_url: String).void
185
+ params(configuration: T.nilable(String), customer: String, expand: T.nilable(T::Array[String]), flow_data: T.nilable(::Stripe::BillingPortal::SessionService::CreateParams::FlowData), locale: T.nilable(String), on_behalf_of: T.nilable(String), return_url: T.nilable(String)).void
184
186
  }
185
187
  def initialize(
186
188
  configuration: nil,