stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (688) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -1
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/resources/account.rb +23 -745
  6. data/lib/stripe/resources/account_link.rb +0 -10
  7. data/lib/stripe/resources/account_notice.rb +0 -22
  8. data/lib/stripe/resources/account_session.rb +0 -125
  9. data/lib/stripe/resources/apple_pay_domain.rb +0 -10
  10. data/lib/stripe/resources/application.rb +0 -3
  11. data/lib/stripe/resources/application_fee.rb +0 -24
  12. data/lib/stripe/resources/application_fee_refund.rb +0 -7
  13. data/lib/stripe/resources/apps/secret.rb +0 -25
  14. data/lib/stripe/resources/balance.rb +0 -31
  15. data/lib/stripe/resources/balance_transaction.rb +0 -29
  16. data/lib/stripe/resources/bank_account.rb +0 -29
  17. data/lib/stripe/resources/billing/alert.rb +0 -22
  18. data/lib/stripe/resources/billing/alert_triggered.rb +0 -5
  19. data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -12
  20. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -24
  21. data/lib/stripe/resources/billing/credit_grant.rb +0 -32
  22. data/lib/stripe/resources/billing/meter.rb +0 -25
  23. data/lib/stripe/resources/billing/meter_error_report.rb +0 -11
  24. data/lib/stripe/resources/billing/meter_event.rb +0 -10
  25. data/lib/stripe/resources/billing/meter_event_adjustment.rb +0 -8
  26. data/lib/stripe/resources/billing/meter_event_summary.rb +0 -6
  27. data/lib/stripe/resources/billing_portal/configuration.rb +0 -77
  28. data/lib/stripe/resources/billing_portal/session.rb +0 -42
  29. data/lib/stripe/resources/capability.rb +2 -29
  30. data/lib/stripe/resources/capital/financing_offer.rb +0 -33
  31. data/lib/stripe/resources/capital/financing_summary.rb +0 -13
  32. data/lib/stripe/resources/capital/financing_transaction.rb +0 -24
  33. data/lib/stripe/resources/card.rb +2 -34
  34. data/lib/stripe/resources/cash_balance.rb +0 -5
  35. data/lib/stripe/resources/charge.rb +4 -665
  36. data/lib/stripe/resources/checkout/session.rb +4 -512
  37. data/lib/stripe/resources/climate/order.rb +0 -40
  38. data/lib/stripe/resources/climate/product.rb +0 -13
  39. data/lib/stripe/resources/climate/supplier.rb +0 -13
  40. data/lib/stripe/resources/confirmation_token.rb +2 -337
  41. data/lib/stripe/resources/connect_collection_transfer.rb +0 -5
  42. data/lib/stripe/resources/country_spec.rb +0 -13
  43. data/lib/stripe/resources/coupon.rb +0 -39
  44. data/lib/stripe/resources/credit_note.rb +0 -138
  45. data/lib/stripe/resources/credit_note_line_item.rb +0 -24
  46. data/lib/stripe/resources/customer.rb +1 -156
  47. data/lib/stripe/resources/customer_balance_transaction.rb +0 -12
  48. data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -27
  49. data/lib/stripe/resources/customer_session.rb +0 -24
  50. data/lib/stripe/resources/discount.rb +0 -12
  51. data/lib/stripe/resources/dispute.rb +4 -152
  52. data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -8
  53. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +0 -3
  54. data/lib/stripe/resources/entitlements/feature.rb +0 -17
  55. data/lib/stripe/resources/ephemeral_key.rb +0 -5
  56. data/lib/stripe/resources/event.rb +0 -27
  57. data/lib/stripe/resources/exchange_rate.rb +0 -5
  58. data/lib/stripe/resources/file.rb +0 -23
  59. data/lib/stripe/resources/file_link.rb +0 -22
  60. data/lib/stripe/resources/financial_connections/account.rb +0 -47
  61. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -3
  62. data/lib/stripe/resources/financial_connections/account_owner.rb +0 -7
  63. data/lib/stripe/resources/financial_connections/account_ownership.rb +0 -3
  64. data/lib/stripe/resources/financial_connections/institution.rb +0 -13
  65. data/lib/stripe/resources/financial_connections/session.rb +0 -28
  66. data/lib/stripe/resources/financial_connections/transaction.rb +0 -21
  67. data/lib/stripe/resources/forwarding/request.rb +0 -31
  68. data/lib/stripe/resources/funding_instructions.rb +0 -107
  69. data/lib/stripe/resources/gift_cards/card.rb +0 -28
  70. data/lib/stripe/resources/gift_cards/transaction.rb +0 -32
  71. data/lib/stripe/resources/identity/verification_report.rb +0 -69
  72. data/lib/stripe/resources/identity/verification_session.rb +0 -69
  73. data/lib/stripe/resources/invoice.rb +6 -1276
  74. data/lib/stripe/resources/invoice_item.rb +0 -91
  75. data/lib/stripe/resources/invoice_line_item.rb +0 -76
  76. data/lib/stripe/resources/invoice_payment.rb +0 -16
  77. data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
  78. data/lib/stripe/resources/issuing/authorization.rb +0 -199
  79. data/lib/stripe/resources/issuing/card.rb +0 -128
  80. data/lib/stripe/resources/issuing/cardholder.rb +0 -110
  81. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -82
  82. data/lib/stripe/resources/issuing/dispute.rb +0 -151
  83. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -14
  84. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -14
  85. data/lib/stripe/resources/issuing/personalization_design.rb +0 -48
  86. data/lib/stripe/resources/issuing/physical_bundle.rb +0 -13
  87. data/lib/stripe/resources/issuing/settlement.rb +0 -16
  88. data/lib/stripe/resources/issuing/token.rb +0 -46
  89. data/lib/stripe/resources/issuing/transaction.rb +0 -171
  90. data/lib/stripe/resources/line_item.rb +0 -23
  91. data/lib/stripe/resources/login_link.rb +0 -2
  92. data/lib/stripe/resources/mandate.rb +0 -45
  93. data/lib/stripe/resources/margin.rb +0 -19
  94. data/lib/stripe/resources/order.rb +3 -391
  95. data/lib/stripe/resources/payment_attempt_record.rb +0 -42
  96. data/lib/stripe/resources/payment_intent.rb +2 -1768
  97. data/lib/stripe/resources/payment_link.rb +15 -213
  98. data/lib/stripe/resources/payment_method.rb +2 -345
  99. data/lib/stripe/resources/payment_method_configuration.rb +0 -293
  100. data/lib/stripe/resources/payment_method_domain.rb +0 -23
  101. data/lib/stripe/resources/payment_record.rb +0 -109
  102. data/lib/stripe/resources/payout.rb +0 -49
  103. data/lib/stripe/resources/person.rb +2 -92
  104. data/lib/stripe/resources/plan.rb +0 -69
  105. data/lib/stripe/resources/price.rb +0 -133
  106. data/lib/stripe/resources/product.rb +0 -100
  107. data/lib/stripe/resources/product_feature.rb +0 -4
  108. data/lib/stripe/resources/promotion_code.rb +0 -40
  109. data/lib/stripe/resources/quote.rb +0 -458
  110. data/lib/stripe/resources/quote_line.rb +0 -66
  111. data/lib/stripe/resources/quote_preview_invoice.rb +3 -184
  112. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -101
  113. data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -16
  114. data/lib/stripe/resources/radar/value_list.rb +0 -26
  115. data/lib/stripe/resources/radar/value_list_item.rb +0 -18
  116. data/lib/stripe/resources/refund.rb +0 -92
  117. data/lib/stripe/resources/reporting/report_run.rb +0 -32
  118. data/lib/stripe/resources/reporting/report_type.rb +0 -8
  119. data/lib/stripe/resources/reserve_transaction.rb +0 -4
  120. data/lib/stripe/resources/reversal.rb +0 -9
  121. data/lib/stripe/resources/review.rb +0 -27
  122. data/lib/stripe/resources/setup_attempt.rb +2 -103
  123. data/lib/stripe/resources/setup_intent.rb +2 -539
  124. data/lib/stripe/resources/shipping_rate.rb +0 -44
  125. data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -13
  126. data/lib/stripe/resources/source.rb +6 -338
  127. data/lib/stripe/resources/source_mandate_notification.rb +0 -13
  128. data/lib/stripe/resources/source_transaction.rb +0 -29
  129. data/lib/stripe/resources/subscription.rb +0 -338
  130. data/lib/stripe/resources/subscription_item.rb +0 -69
  131. data/lib/stripe/resources/subscription_schedule.rb +0 -388
  132. data/lib/stripe/resources/tax/association.rb +0 -11
  133. data/lib/stripe/resources/tax/calculation.rb +2 -89
  134. data/lib/stripe/resources/tax/calculation_line_item.rb +0 -20
  135. data/lib/stripe/resources/tax/form.rb +2 -35
  136. data/lib/stripe/resources/tax/registration.rb +421 -213
  137. data/lib/stripe/resources/tax/settings.rb +0 -20
  138. data/lib/stripe/resources/tax/transaction.rb +1 -66
  139. data/lib/stripe/resources/tax/transaction_line_item.rb +0 -12
  140. data/lib/stripe/resources/tax_code.rb +0 -6
  141. data/lib/stripe/resources/tax_deducted_at_source.rb +0 -4
  142. data/lib/stripe/resources/tax_id.rb +2 -28
  143. data/lib/stripe/resources/tax_rate.rb +0 -45
  144. data/lib/stripe/resources/terminal/configuration.rb +0 -164
  145. data/lib/stripe/resources/terminal/connection_token.rb +0 -3
  146. data/lib/stripe/resources/terminal/location.rb +0 -33
  147. data/lib/stripe/resources/terminal/reader.rb +0 -129
  148. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -5
  149. data/lib/stripe/resources/test_helpers/test_clock.rb +0 -15
  150. data/lib/stripe/resources/token.rb +4 -192
  151. data/lib/stripe/resources/topup.rb +0 -36
  152. data/lib/stripe/resources/transfer.rb +0 -35
  153. data/lib/stripe/resources/treasury/credit_reversal.rb +0 -21
  154. data/lib/stripe/resources/treasury/debit_reversal.rb +0 -23
  155. data/lib/stripe/resources/treasury/financial_account.rb +77 -71
  156. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -46
  157. data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -50
  158. data/lib/stripe/resources/treasury/outbound_payment.rb +0 -92
  159. data/lib/stripe/resources/treasury/outbound_transfer.rb +25 -66
  160. data/lib/stripe/resources/treasury/received_credit.rb +6 -58
  161. data/lib/stripe/resources/treasury/received_debit.rb +0 -54
  162. data/lib/stripe/resources/treasury/transaction.rb +0 -39
  163. data/lib/stripe/resources/treasury/transaction_entry.rb +0 -36
  164. data/lib/stripe/resources/usage_record.rb +0 -5
  165. data/lib/stripe/resources/usage_record_summary.rb +0 -7
  166. data/lib/stripe/resources/v2/billing/meter_event.rb +0 -6
  167. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +0 -7
  168. data/lib/stripe/resources/v2/billing/meter_event_session.rb +0 -5
  169. data/lib/stripe/resources/v2/event.rb +0 -8
  170. data/lib/stripe/resources/v2/event_destination.rb +0 -19
  171. data/lib/stripe/resources/webhook_endpoint.rb +0 -26
  172. data/lib/stripe/services/account_capability_service.rb +0 -1
  173. data/lib/stripe/services/account_external_account_service.rb +0 -43
  174. data/lib/stripe/services/account_link_service.rb +0 -7
  175. data/lib/stripe/services/account_notice_service.rb +0 -9
  176. data/lib/stripe/services/account_person_service.rb +0 -139
  177. data/lib/stripe/services/account_service.rb +8 -519
  178. data/lib/stripe/services/account_session_service.rb +0 -76
  179. data/lib/stripe/services/apple_pay_domain_service.rb +0 -5
  180. data/lib/stripe/services/application_fee_refund_service.rb +0 -6
  181. data/lib/stripe/services/application_fee_service.rb +0 -8
  182. data/lib/stripe/services/apps/secret_service.rb +0 -16
  183. data/lib/stripe/services/balance_transaction_service.rb +0 -11
  184. data/lib/stripe/services/billing/alert_service.rb +0 -12
  185. data/lib/stripe/services/billing/credit_balance_summary_service.rb +0 -4
  186. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -5
  187. data/lib/stripe/services/billing/credit_grant_service.rb +0 -16
  188. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +0 -3
  189. data/lib/stripe/services/billing/meter_event_service.rb +0 -4
  190. data/lib/stripe/services/billing/meter_event_summary_service.rb +0 -7
  191. data/lib/stripe/services/billing/meter_service.rb +0 -12
  192. data/lib/stripe/services/billing_portal/configuration_service.rb +0 -48
  193. data/lib/stripe/services/billing_portal/session_service.rb +0 -19
  194. data/lib/stripe/services/capital/financing_offer_service.rb +0 -9
  195. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -7
  196. data/lib/stripe/services/charge_service.rb +0 -274
  197. data/lib/stripe/services/checkout/session_line_item_service.rb +0 -3
  198. data/lib/stripe/services/checkout/session_service.rb +2 -273
  199. data/lib/stripe/services/climate/order_service.rb +0 -11
  200. data/lib/stripe/services/climate/product_service.rb +0 -3
  201. data/lib/stripe/services/climate/supplier_service.rb +0 -3
  202. data/lib/stripe/services/country_spec_service.rb +0 -3
  203. data/lib/stripe/services/coupon_service.rb +0 -22
  204. data/lib/stripe/services/credit_note_line_item_service.rb +0 -3
  205. data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -28
  206. data/lib/stripe/services/credit_note_service.rb +0 -61
  207. data/lib/stripe/services/customer_balance_transaction_service.rb +0 -9
  208. data/lib/stripe/services/customer_cash_balance_service.rb +0 -1
  209. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +0 -3
  210. data/lib/stripe/services/customer_funding_instructions_service.rb +0 -5
  211. data/lib/stripe/services/customer_payment_method_service.rb +0 -5
  212. data/lib/stripe/services/customer_payment_source_service.rb +0 -29
  213. data/lib/stripe/services/customer_service.rb +1 -92
  214. data/lib/stripe/services/customer_session_service.rb +0 -10
  215. data/lib/stripe/services/customer_tax_id_service.rb +1 -6
  216. data/lib/stripe/services/dispute_service.rb +2 -67
  217. data/lib/stripe/services/entitlements/active_entitlement_service.rb +0 -4
  218. data/lib/stripe/services/entitlements/feature_service.rb +0 -11
  219. data/lib/stripe/services/ephemeral_key_service.rb +0 -4
  220. data/lib/stripe/services/event_service.rb +0 -10
  221. data/lib/stripe/services/exchange_rate_service.rb +0 -3
  222. data/lib/stripe/services/file_link_service.rb +0 -14
  223. data/lib/stripe/services/file_service.rb +0 -13
  224. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -3
  225. data/lib/stripe/services/financial_connections/account_owner_service.rb +0 -4
  226. data/lib/stripe/services/financial_connections/account_service.rb +0 -9
  227. data/lib/stripe/services/financial_connections/institution_service.rb +0 -3
  228. data/lib/stripe/services/financial_connections/session_service.rb +0 -11
  229. data/lib/stripe/services/financial_connections/transaction_service.rb +0 -9
  230. data/lib/stripe/services/forwarding/request_service.rb +0 -14
  231. data/lib/stripe/services/gift_cards/card_service.rb +0 -13
  232. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -16
  233. data/lib/stripe/services/identity/verification_report_service.rb +0 -10
  234. data/lib/stripe/services/identity/verification_session_service.rb +0 -30
  235. data/lib/stripe/services/invoice_item_service.rb +0 -66
  236. data/lib/stripe/services/invoice_line_item_service.rb +0 -40
  237. data/lib/stripe/services/invoice_payment_service.rb +0 -3
  238. data/lib/stripe/services/invoice_rendering_template_service.rb +0 -5
  239. data/lib/stripe/services/invoice_service.rb +2 -810
  240. data/lib/stripe/services/invoice_upcoming_lines_service.rb +1 -279
  241. data/lib/stripe/services/issuing/authorization_service.rb +0 -14
  242. data/lib/stripe/services/issuing/card_service.rb +0 -70
  243. data/lib/stripe/services/issuing/cardholder_service.rb +0 -73
  244. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -56
  245. data/lib/stripe/services/issuing/dispute_service.rb +0 -98
  246. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -4
  247. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -7
  248. data/lib/stripe/services/issuing/personalization_design_service.rb +0 -29
  249. data/lib/stripe/services/issuing/physical_bundle_service.rb +0 -5
  250. data/lib/stripe/services/issuing/token_service.rb +0 -10
  251. data/lib/stripe/services/issuing/transaction_service.rb +0 -12
  252. data/lib/stripe/services/margin_service.rb +0 -11
  253. data/lib/stripe/services/order_line_item_service.rb +0 -3
  254. data/lib/stripe/services/order_service.rb +2 -266
  255. data/lib/stripe/services/payment_attempt_record_service.rb +0 -1
  256. data/lib/stripe/services/payment_intent_service.rb +0 -1309
  257. data/lib/stripe/services/payment_link_line_item_service.rb +0 -3
  258. data/lib/stripe/services/payment_link_service.rb +15 -135
  259. data/lib/stripe/services/payment_method_configuration_service.rb +0 -102
  260. data/lib/stripe/services/payment_method_domain_service.rb +0 -8
  261. data/lib/stripe/services/payment_method_service.rb +0 -113
  262. data/lib/stripe/services/payment_record_service.rb +0 -68
  263. data/lib/stripe/services/payout_service.rb +0 -23
  264. data/lib/stripe/services/plan_service.rb +0 -43
  265. data/lib/stripe/services/price_service.rb +0 -87
  266. data/lib/stripe/services/product_feature_service.rb +0 -4
  267. data/lib/stripe/services/product_service.rb +0 -74
  268. data/lib/stripe/services/promotion_code_service.rb +0 -25
  269. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +0 -3
  270. data/lib/stripe/services/quote_line_item_service.rb +0 -3
  271. data/lib/stripe/services/quote_line_service.rb +0 -3
  272. data/lib/stripe/services/quote_preview_invoice_service.rb +0 -3
  273. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -3
  274. data/lib/stripe/services/quote_service.rb +0 -309
  275. data/lib/stripe/services/radar/early_fraud_warning_service.rb +0 -9
  276. data/lib/stripe/services/radar/value_list_item_service.rb +0 -11
  277. data/lib/stripe/services/radar/value_list_service.rb +0 -16
  278. data/lib/stripe/services/refund_service.rb +0 -21
  279. data/lib/stripe/services/reporting/report_run_service.rb +0 -16
  280. data/lib/stripe/services/review_service.rb +0 -7
  281. data/lib/stripe/services/setup_attempt_service.rb +0 -8
  282. data/lib/stripe/services/setup_intent_service.rb +0 -447
  283. data/lib/stripe/services/shipping_rate_service.rb +0 -27
  284. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +0 -3
  285. data/lib/stripe/services/source_service.rb +0 -92
  286. data/lib/stripe/services/source_transaction_service.rb +0 -3
  287. data/lib/stripe/services/subscription_item_service.rb +0 -56
  288. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -3
  289. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -3
  290. data/lib/stripe/services/subscription_schedule_service.rb +0 -290
  291. data/lib/stripe/services/subscription_service.rb +0 -245
  292. data/lib/stripe/services/tax/association_service.rb +0 -1
  293. data/lib/stripe/services/tax/calculation_line_item_service.rb +0 -3
  294. data/lib/stripe/services/tax/calculation_service.rb +1 -31
  295. data/lib/stripe/services/tax/form_service.rb +0 -7
  296. data/lib/stripe/services/tax/registration_service.rb +274 -108
  297. data/lib/stripe/services/tax/settings_service.rb +0 -8
  298. data/lib/stripe/services/tax/transaction_line_item_service.rb +0 -3
  299. data/lib/stripe/services/tax/transaction_service.rb +0 -17
  300. data/lib/stripe/services/tax_code_service.rb +0 -3
  301. data/lib/stripe/services/tax_id_service.rb +1 -12
  302. data/lib/stripe/services/tax_rate_service.rb +0 -27
  303. data/lib/stripe/services/terminal/configuration_service.rb +0 -108
  304. data/lib/stripe/services/terminal/connection_token_service.rb +0 -1
  305. data/lib/stripe/services/terminal/location_service.rb +0 -21
  306. data/lib/stripe/services/terminal/reader_service.rb +0 -53
  307. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -89
  308. data/lib/stripe/services/test_helpers/customer_service.rb +0 -3
  309. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +0 -99
  310. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +0 -2
  311. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +0 -91
  312. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -4
  313. data/lib/stripe/services/test_helpers/test_clock_service.rb +0 -6
  314. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +0 -1
  315. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +0 -6
  316. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +0 -6
  317. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +0 -11
  318. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +0 -11
  319. data/lib/stripe/services/token_service.rb +4 -184
  320. data/lib/stripe/services/topup_service.rb +0 -21
  321. data/lib/stripe/services/transfer_reversal_service.rb +0 -8
  322. data/lib/stripe/services/transfer_service.rb +0 -19
  323. data/lib/stripe/services/treasury/credit_reversal_service.rb +0 -8
  324. data/lib/stripe/services/treasury/debit_reversal_service.rb +0 -9
  325. data/lib/stripe/services/treasury/financial_account_features_service.rb +0 -10
  326. data/lib/stripe/services/treasury/financial_account_service.rb +64 -36
  327. data/lib/stripe/services/treasury/inbound_transfer_service.rb +0 -12
  328. data/lib/stripe/services/treasury/outbound_payment_service.rb +0 -38
  329. data/lib/stripe/services/treasury/outbound_transfer_service.rb +16 -15
  330. data/lib/stripe/services/treasury/received_credit_service.rb +0 -6
  331. data/lib/stripe/services/treasury/received_debit_service.rb +0 -5
  332. data/lib/stripe/services/treasury/transaction_entry_service.rb +0 -14
  333. data/lib/stripe/services/treasury/transaction_service.rb +0 -14
  334. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +0 -2
  335. data/lib/stripe/services/v2/billing/meter_event_service.rb +0 -3
  336. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +0 -3
  337. data/lib/stripe/services/v2/core/event_destination_service.rb +0 -18
  338. data/lib/stripe/services/v2/core/event_service.rb +0 -2
  339. data/lib/stripe/services/webhook_endpoint_service.rb +0 -14
  340. data/lib/stripe/stripe_client.rb +1 -1
  341. data/lib/stripe/stripe_object.rb +3 -3
  342. data/lib/stripe/util.rb +1 -1
  343. data/lib/stripe/version.rb +1 -1
  344. data/rbi/stripe/resources/account.rbi +29 -1001
  345. data/rbi/stripe/resources/account_link.rbi +0 -13
  346. data/rbi/stripe/resources/account_notice.rbi +0 -27
  347. data/rbi/stripe/resources/account_session.rbi +0 -166
  348. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -14
  349. data/rbi/stripe/resources/application.rbi +0 -3
  350. data/rbi/stripe/resources/application_fee.rbi +0 -28
  351. data/rbi/stripe/resources/application_fee_refund.rbi +0 -7
  352. data/rbi/stripe/resources/apps/secret.rbi +0 -34
  353. data/rbi/stripe/resources/balance.rbi +0 -33
  354. data/rbi/stripe/resources/balance_transaction.rbi +0 -33
  355. data/rbi/stripe/resources/bank_account.rbi +0 -29
  356. data/rbi/stripe/resources/billing/alert.rbi +0 -31
  357. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -5
  358. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -16
  359. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -27
  360. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -43
  361. data/rbi/stripe/resources/billing/meter.rbi +0 -35
  362. data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -11
  363. data/rbi/stripe/resources/billing/meter_event.rbi +0 -12
  364. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -11
  365. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -6
  366. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -106
  367. data/rbi/stripe/resources/billing_portal/session.rbi +0 -55
  368. data/rbi/stripe/resources/capability.rbi +2 -29
  369. data/rbi/stripe/resources/capital/financing_offer.rbi +0 -38
  370. data/rbi/stripe/resources/capital/financing_summary.rbi +0 -15
  371. data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -27
  372. data/rbi/stripe/resources/card.rbi +3 -34
  373. data/rbi/stripe/resources/cash_balance.rbi +0 -5
  374. data/rbi/stripe/resources/charge.rbi +6 -738
  375. data/rbi/stripe/resources/checkout/session.rbi +4 -636
  376. data/rbi/stripe/resources/climate/order.rbi +0 -48
  377. data/rbi/stripe/resources/climate/product.rbi +0 -16
  378. data/rbi/stripe/resources/climate/supplier.rbi +0 -16
  379. data/rbi/stripe/resources/confirmation_token.rbi +3 -364
  380. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -5
  381. data/rbi/stripe/resources/country_spec.rbi +0 -16
  382. data/rbi/stripe/resources/coupon.rbi +0 -48
  383. data/rbi/stripe/resources/credit_note.rbi +0 -159
  384. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -24
  385. data/rbi/stripe/resources/customer.rbi +1 -188
  386. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -12
  387. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -27
  388. data/rbi/stripe/resources/customer_session.rbi +0 -31
  389. data/rbi/stripe/resources/discount.rbi +0 -12
  390. data/rbi/stripe/resources/dispute.rbi +4 -166
  391. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -11
  392. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -3
  393. data/rbi/stripe/resources/entitlements/feature.rbi +0 -22
  394. data/rbi/stripe/resources/ephemeral_key.rbi +0 -7
  395. data/rbi/stripe/resources/event.rbi +0 -31
  396. data/rbi/stripe/resources/exchange_rate.rbi +0 -8
  397. data/rbi/stripe/resources/file.rbi +0 -29
  398. data/rbi/stripe/resources/file_link.rbi +0 -28
  399. data/rbi/stripe/resources/financial_connections/account.rbi +0 -56
  400. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -3
  401. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -7
  402. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -3
  403. data/rbi/stripe/resources/financial_connections/institution.rbi +0 -16
  404. data/rbi/stripe/resources/financial_connections/session.rbi +0 -35
  405. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -26
  406. data/rbi/stripe/resources/forwarding/request.rbi +0 -38
  407. data/rbi/stripe/resources/funding_instructions.rbi +0 -107
  408. data/rbi/stripe/resources/gift_cards/card.rbi +0 -36
  409. data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -41
  410. data/rbi/stripe/resources/identity/verification_report.rbi +0 -73
  411. data/rbi/stripe/resources/identity/verification_session.rbi +0 -83
  412. data/rbi/stripe/resources/invoice.rbi +7 -1663
  413. data/rbi/stripe/resources/invoice_item.rbi +0 -107
  414. data/rbi/stripe/resources/invoice_line_item.rbi +0 -86
  415. data/rbi/stripe/resources/invoice_payment.rbi +0 -16
  416. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -17
  417. data/rbi/stripe/resources/issuing/authorization.rbi +0 -245
  418. data/rbi/stripe/resources/issuing/card.rbi +0 -153
  419. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -138
  420. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -109
  421. data/rbi/stripe/resources/issuing/dispute.rbi +0 -177
  422. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -17
  423. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -18
  424. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -62
  425. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -16
  426. data/rbi/stripe/resources/issuing/settlement.rbi +0 -16
  427. data/rbi/stripe/resources/issuing/token.rbi +0 -51
  428. data/rbi/stripe/resources/issuing/transaction.rbi +0 -205
  429. data/rbi/stripe/resources/line_item.rbi +0 -23
  430. data/rbi/stripe/resources/login_link.rbi +0 -2
  431. data/rbi/stripe/resources/mandate.rbi +0 -47
  432. data/rbi/stripe/resources/margin.rbi +0 -24
  433. data/rbi/stripe/resources/order.rbi +3 -492
  434. data/rbi/stripe/resources/payment_attempt_record.rbi +0 -45
  435. data/rbi/stripe/resources/payment_intent.rbi +3 -2224
  436. data/rbi/stripe/resources/payment_link.rbi +14 -291
  437. data/rbi/stripe/resources/payment_method.rbi +3 -382
  438. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -486
  439. data/rbi/stripe/resources/payment_method_domain.rbi +0 -29
  440. data/rbi/stripe/resources/payment_record.rbi +0 -134
  441. data/rbi/stripe/resources/payout.rbi +0 -58
  442. data/rbi/stripe/resources/person.rbi +2 -92
  443. data/rbi/stripe/resources/plan.rbi +0 -78
  444. data/rbi/stripe/resources/price.rbi +0 -153
  445. data/rbi/stripe/resources/product.rbi +0 -120
  446. data/rbi/stripe/resources/product_feature.rbi +0 -4
  447. data/rbi/stripe/resources/promotion_code.rbi +0 -50
  448. data/rbi/stripe/resources/quote.rbi +0 -593
  449. data/rbi/stripe/resources/quote_line.rbi +0 -66
  450. data/rbi/stripe/resources/quote_preview_invoice.rbi +4 -184
  451. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -101
  452. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -20
  453. data/rbi/stripe/resources/radar/value_list.rbi +0 -32
  454. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -23
  455. data/rbi/stripe/resources/refund.rbi +0 -100
  456. data/rbi/stripe/resources/reporting/report_run.rbi +0 -38
  457. data/rbi/stripe/resources/reporting/report_type.rbi +0 -11
  458. data/rbi/stripe/resources/reserve_transaction.rbi +0 -4
  459. data/rbi/stripe/resources/reversal.rbi +0 -9
  460. data/rbi/stripe/resources/review.rbi +0 -32
  461. data/rbi/stripe/resources/setup_attempt.rbi +3 -106
  462. data/rbi/stripe/resources/setup_intent.rbi +3 -688
  463. data/rbi/stripe/resources/shipping_rate.rbi +0 -57
  464. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -16
  465. data/rbi/stripe/resources/source.rbi +9 -365
  466. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -13
  467. data/rbi/stripe/resources/source_transaction.rbi +0 -29
  468. data/rbi/stripe/resources/subscription.rbi +0 -431
  469. data/rbi/stripe/resources/subscription_item.rbi +0 -88
  470. data/rbi/stripe/resources/subscription_schedule.rbi +0 -504
  471. data/rbi/stripe/resources/tax/association.rbi +0 -13
  472. data/rbi/stripe/resources/tax/calculation.rbi +2 -100
  473. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -20
  474. data/rbi/stripe/resources/tax/form.rbi +2 -40
  475. data/rbi/stripe/resources/tax/registration.rbi +401 -317
  476. data/rbi/stripe/resources/tax/settings.rbi +0 -26
  477. data/rbi/stripe/resources/tax/transaction.rbi +1 -73
  478. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -12
  479. data/rbi/stripe/resources/tax_code.rbi +0 -9
  480. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -4
  481. data/rbi/stripe/resources/tax_id.rbi +2 -34
  482. data/rbi/stripe/resources/tax_rate.rbi +0 -51
  483. data/rbi/stripe/resources/terminal/configuration.rbi +0 -211
  484. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -5
  485. data/rbi/stripe/resources/terminal/location.rbi +0 -40
  486. data/rbi/stripe/resources/terminal/reader.rbi +0 -158
  487. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -7
  488. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -20
  489. data/rbi/stripe/resources/token.rbi +5 -235
  490. data/rbi/stripe/resources/topup.rbi +0 -44
  491. data/rbi/stripe/resources/transfer.rbi +0 -41
  492. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -25
  493. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -27
  494. data/rbi/stripe/resources/treasury/financial_account.rbi +70 -124
  495. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -46
  496. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -59
  497. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -113
  498. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +28 -84
  499. data/rbi/stripe/resources/treasury/received_credit.rbi +7 -67
  500. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -62
  501. data/rbi/stripe/resources/treasury/transaction.rbi +0 -45
  502. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -41
  503. data/rbi/stripe/resources/usage_record.rbi +0 -5
  504. data/rbi/stripe/resources/usage_record_summary.rbi +0 -7
  505. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -6
  506. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -7
  507. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -5
  508. data/rbi/stripe/resources/v2/event.rbi +0 -8
  509. data/rbi/stripe/resources/v2/event_destination.rbi +0 -19
  510. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -31
  511. data/rbi/stripe/services/account_capability_service.rbi +0 -4
  512. data/rbi/stripe/services/account_external_account_service.rbi +0 -52
  513. data/rbi/stripe/services/account_link_service.rbi +0 -9
  514. data/rbi/stripe/services/account_login_link_service.rbi +0 -1
  515. data/rbi/stripe/services/account_notice_service.rbi +0 -13
  516. data/rbi/stripe/services/account_person_service.rbi +0 -174
  517. data/rbi/stripe/services/account_service.rbi +10 -773
  518. data/rbi/stripe/services/account_session_service.rbi +0 -116
  519. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -8
  520. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -10
  521. data/rbi/stripe/services/application_fee_service.rbi +0 -11
  522. data/rbi/stripe/services/apps/secret_service.rbi +0 -24
  523. data/rbi/stripe/services/balance_service.rbi +0 -1
  524. data/rbi/stripe/services/balance_transaction_service.rbi +0 -14
  525. data/rbi/stripe/services/billing/alert_service.rbi +0 -20
  526. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -7
  527. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -7
  528. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -26
  529. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -5
  530. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -5
  531. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -8
  532. data/rbi/stripe/services/billing/meter_service.rbi +0 -21
  533. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -76
  534. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -31
  535. data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -13
  536. data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -1
  537. data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -9
  538. data/rbi/stripe/services/charge_service.rbi +0 -346
  539. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -4
  540. data/rbi/stripe/services/checkout/session_service.rbi +2 -395
  541. data/rbi/stripe/services/climate/order_service.rbi +0 -18
  542. data/rbi/stripe/services/climate/product_service.rbi +0 -5
  543. data/rbi/stripe/services/climate/supplier_service.rbi +0 -5
  544. data/rbi/stripe/services/confirmation_token_service.rbi +0 -1
  545. data/rbi/stripe/services/country_spec_service.rbi +0 -5
  546. data/rbi/stripe/services/coupon_service.rbi +0 -30
  547. data/rbi/stripe/services/credit_note_line_item_service.rbi +0 -4
  548. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -33
  549. data/rbi/stripe/services/credit_note_service.rbi +0 -76
  550. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -13
  551. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -4
  552. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -5
  553. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -8
  554. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -7
  555. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -37
  556. data/rbi/stripe/services/customer_service.rbi +1 -117
  557. data/rbi/stripe/services/customer_session_service.rbi +0 -16
  558. data/rbi/stripe/services/customer_tax_id_service.rbi +1 -9
  559. data/rbi/stripe/services/dispute_service.rbi +2 -80
  560. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -6
  561. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -15
  562. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -6
  563. data/rbi/stripe/services/event_service.rbi +0 -13
  564. data/rbi/stripe/services/exchange_rate_service.rbi +0 -5
  565. data/rbi/stripe/services/file_link_service.rbi +0 -19
  566. data/rbi/stripe/services/file_service.rbi +0 -18
  567. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -4
  568. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -5
  569. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -16
  570. data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -5
  571. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -17
  572. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -13
  573. data/rbi/stripe/services/forwarding/request_service.rbi +0 -20
  574. data/rbi/stripe/services/gift_cards/card_service.rbi +0 -20
  575. data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -24
  576. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -13
  577. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -43
  578. data/rbi/stripe/services/invoice_item_service.rbi +0 -81
  579. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -50
  580. data/rbi/stripe/services/invoice_payment_service.rbi +0 -5
  581. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -9
  582. data/rbi/stripe/services/invoice_service.rbi +2 -1100
  583. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +1 -375
  584. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -20
  585. data/rbi/stripe/services/issuing/card_service.rbi +0 -89
  586. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -100
  587. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -82
  588. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -123
  589. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -6
  590. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -10
  591. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -38
  592. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -7
  593. data/rbi/stripe/services/issuing/token_service.rbi +0 -14
  594. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -16
  595. data/rbi/stripe/services/mandate_service.rbi +0 -1
  596. data/rbi/stripe/services/margin_service.rbi +0 -15
  597. data/rbi/stripe/services/order_line_item_service.rbi +0 -4
  598. data/rbi/stripe/services/order_service.rbi +2 -365
  599. data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -3
  600. data/rbi/stripe/services/payment_intent_service.rbi +0 -1764
  601. data/rbi/stripe/services/payment_link_line_item_service.rbi +0 -4
  602. data/rbi/stripe/services/payment_link_service.rbi +14 -211
  603. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -294
  604. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -13
  605. data/rbi/stripe/services/payment_method_service.rbi +0 -149
  606. data/rbi/stripe/services/payment_record_service.rbi +0 -92
  607. data/rbi/stripe/services/payout_service.rbi +0 -31
  608. data/rbi/stripe/services/plan_service.rbi +0 -51
  609. data/rbi/stripe/services/price_service.rbi +0 -106
  610. data/rbi/stripe/services/product_feature_service.rbi +0 -7
  611. data/rbi/stripe/services/product_service.rbi +0 -93
  612. data/rbi/stripe/services/promotion_code_service.rbi +0 -34
  613. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -4
  614. data/rbi/stripe/services/quote_line_item_service.rbi +0 -4
  615. data/rbi/stripe/services/quote_line_service.rbi +0 -4
  616. data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -4
  617. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -4
  618. data/rbi/stripe/services/quote_service.rbi +0 -440
  619. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -12
  620. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -15
  621. data/rbi/stripe/services/radar/value_list_service.rbi +0 -21
  622. data/rbi/stripe/services/refund_service.rbi +0 -27
  623. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -21
  624. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -2
  625. data/rbi/stripe/services/review_service.rbi +0 -11
  626. data/rbi/stripe/services/setup_attempt_service.rbi +0 -10
  627. data/rbi/stripe/services/setup_intent_service.rbi +0 -595
  628. data/rbi/stripe/services/shipping_rate_service.rbi +0 -39
  629. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -5
  630. data/rbi/stripe/services/source_service.rbi +0 -119
  631. data/rbi/stripe/services/source_transaction_service.rbi +0 -4
  632. data/rbi/stripe/services/subscription_item_service.rbi +0 -74
  633. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -4
  634. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -4
  635. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -405
  636. data/rbi/stripe/services/subscription_service.rbi +0 -337
  637. data/rbi/stripe/services/tax/association_service.rbi +0 -2
  638. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -4
  639. data/rbi/stripe/services/tax/calculation_service.rbi +1 -40
  640. data/rbi/stripe/services/tax/form_service.rbi +0 -11
  641. data/rbi/stripe/services/tax/registration_service.rbi +233 -211
  642. data/rbi/stripe/services/tax/settings_service.rbi +0 -13
  643. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +0 -4
  644. data/rbi/stripe/services/tax/transaction_service.rbi +0 -22
  645. data/rbi/stripe/services/tax_code_service.rbi +0 -5
  646. data/rbi/stripe/services/tax_id_service.rbi +1 -17
  647. data/rbi/stripe/services/tax_rate_service.rbi +0 -32
  648. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -154
  649. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -2
  650. data/rbi/stripe/services/terminal/location_service.rbi +0 -27
  651. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -1
  652. data/rbi/stripe/services/terminal/reader_service.rbi +0 -78
  653. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -114
  654. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -4
  655. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -138
  656. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -5
  657. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -6
  658. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -120
  659. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -1
  660. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -7
  661. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -10
  662. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -5
  663. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -14
  664. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -14
  665. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -16
  666. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -16
  667. data/rbi/stripe/services/token_service.rbi +5 -226
  668. data/rbi/stripe/services/topup_service.rbi +0 -28
  669. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -12
  670. data/rbi/stripe/services/transfer_service.rbi +0 -24
  671. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -11
  672. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -12
  673. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -25
  674. data/rbi/stripe/services/treasury/financial_account_service.rbi +62 -73
  675. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -16
  676. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -50
  677. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +17 -24
  678. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -9
  679. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -7
  680. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -18
  681. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -19
  682. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -4
  683. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -4
  684. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -5
  685. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -25
  686. data/rbi/stripe/services/v2/core/event_service.rbi +0 -3
  687. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -18
  688. metadata +2 -2
@@ -10,22 +10,18 @@ module Stripe
10
10
  # The connected account being referenced when `type` is `account`.
11
11
  sig { returns(String) }
12
12
  attr_accessor :account
13
-
14
13
  # Type of the account referenced in the request.
15
14
  sig { returns(String) }
16
15
  attr_accessor :type
17
-
18
16
  sig { params(account: String, type: String).void }
19
17
  def initialize(account: nil, type: nil); end
20
18
  end
21
19
  # Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
22
20
  sig { returns(T::Boolean) }
23
21
  attr_accessor :enabled
24
-
25
22
  # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
26
23
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::AutomaticTax::Liability) }
27
24
  attr_accessor :liability
28
-
29
25
  sig {
30
26
  params(enabled: T::Boolean, liability: ::Stripe::InvoiceUpcomingLinesService::ListParams::AutomaticTax::Liability).void
31
27
  }
@@ -36,27 +32,21 @@ module Stripe
36
32
  # City, district, suburb, town, or village.
37
33
  sig { returns(String) }
38
34
  attr_accessor :city
39
-
40
35
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
41
36
  sig { returns(String) }
42
37
  attr_accessor :country
43
-
44
38
  # Address line 1 (e.g., street, PO Box, or company name).
45
39
  sig { returns(String) }
46
40
  attr_accessor :line1
47
-
48
41
  # Address line 2 (e.g., apartment, suite, unit, or building).
49
42
  sig { returns(String) }
50
43
  attr_accessor :line2
51
-
52
44
  # ZIP or postal code.
53
45
  sig { returns(String) }
54
46
  attr_accessor :postal_code
55
-
56
47
  # State, county, province, or region.
57
48
  sig { returns(String) }
58
49
  attr_accessor :state
59
-
60
50
  sig {
61
51
  params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
62
52
  }
@@ -74,27 +64,21 @@ module Stripe
74
64
  # City, district, suburb, town, or village.
75
65
  sig { returns(String) }
76
66
  attr_accessor :city
77
-
78
67
  # A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
79
68
  sig { returns(String) }
80
69
  attr_accessor :country
81
-
82
70
  # Address line 1 (e.g., street, PO Box, or company name).
83
71
  sig { returns(String) }
84
72
  attr_accessor :line1
85
-
86
73
  # Address line 2 (e.g., apartment, suite, unit, or building).
87
74
  sig { returns(String) }
88
75
  attr_accessor :line2
89
-
90
76
  # ZIP or postal code.
91
77
  sig { returns(String) }
92
78
  attr_accessor :postal_code
93
-
94
79
  # State, county, province, or region.
95
80
  sig { returns(String) }
96
81
  attr_accessor :state
97
-
98
82
  sig {
99
83
  params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
100
84
  }
@@ -112,15 +96,12 @@ module Stripe
112
96
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails::Shipping::Address)
113
97
  }
114
98
  attr_accessor :address
115
-
116
99
  # Customer name.
117
100
  sig { returns(String) }
118
101
  attr_accessor :name
119
-
120
102
  # Customer phone (including extension).
121
103
  sig { returns(String) }
122
104
  attr_accessor :phone
123
-
124
105
  sig {
125
106
  params(address: ::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails::Shipping::Address, name: String, phone: String).void
126
107
  }
@@ -130,19 +111,16 @@ module Stripe
130
111
  # A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
131
112
  sig { returns(T.nilable(String)) }
132
113
  attr_accessor :ip_address
133
-
134
114
  sig { params(ip_address: T.nilable(String)).void }
135
115
  def initialize(ip_address: nil); end
136
116
  end
137
117
  class TaxId < Stripe::RequestParams
138
- # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
118
+ # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
139
119
  sig { returns(String) }
140
120
  attr_accessor :type
141
-
142
121
  # Value of the tax ID.
143
122
  sig { returns(String) }
144
123
  attr_accessor :value
145
-
146
124
  sig { params(type: String, value: String).void }
147
125
  def initialize(type: nil, value: nil); end
148
126
  end
@@ -151,27 +129,22 @@ module Stripe
151
129
  returns(T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails::Address))
152
130
  }
153
131
  attr_accessor :address
154
-
155
132
  # The customer's shipping information. Appears on invoices emailed to this customer.
156
133
  sig {
157
134
  returns(T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails::Shipping))
158
135
  }
159
136
  attr_accessor :shipping
160
-
161
137
  # Tax details about the customer.
162
138
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails::Tax) }
163
139
  attr_accessor :tax
164
-
165
140
  # The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
166
141
  sig { returns(T.nilable(String)) }
167
142
  attr_accessor :tax_exempt
168
-
169
143
  # The customer's tax IDs.
170
144
  sig {
171
145
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails::TaxId])
172
146
  }
173
147
  attr_accessor :tax_ids
174
-
175
148
  sig {
176
149
  params(address: T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails::Address), shipping: T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails::Shipping), tax: ::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails::Tax, tax_exempt: T.nilable(String), tax_ids: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails::TaxId]).void
177
150
  }
@@ -183,11 +156,9 @@ module Stripe
183
156
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
184
157
  sig { returns(String) }
185
158
  attr_accessor :interval
186
-
187
159
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
188
160
  sig { returns(Integer) }
189
161
  attr_accessor :interval_count
190
-
191
162
  sig { params(interval: String, interval_count: Integer).void }
192
163
  def initialize(interval: nil, interval_count: nil); end
193
164
  end
@@ -196,15 +167,12 @@ module Stripe
196
167
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::Discount::DiscountEnd::Duration)
197
168
  }
198
169
  attr_accessor :duration
199
-
200
170
  # A precise Unix timestamp for the discount to end. Must be in the future.
201
171
  sig { returns(Integer) }
202
172
  attr_accessor :timestamp
203
-
204
173
  # The type of calculation made to determine when the discount ends.
205
174
  sig { returns(String) }
206
175
  attr_accessor :type
207
-
208
176
  sig {
209
177
  params(duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
210
178
  }
@@ -213,19 +181,15 @@ module Stripe
213
181
  # ID of the coupon to create a new discount for.
214
182
  sig { returns(String) }
215
183
  attr_accessor :coupon
216
-
217
184
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
218
185
  sig { returns(String) }
219
186
  attr_accessor :discount
220
-
221
187
  # Details to determine how long the discount should be applied for.
222
188
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::Discount::DiscountEnd) }
223
189
  attr_accessor :discount_end
224
-
225
190
  # ID of the promotion code to create a new discount for.
226
191
  sig { returns(String) }
227
192
  attr_accessor :promotion_code
228
-
229
193
  sig {
230
194
  params(coupon: String, discount: String, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::Discount::DiscountEnd, promotion_code: String).void
231
195
  }
@@ -238,11 +202,9 @@ module Stripe
238
202
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
239
203
  sig { returns(String) }
240
204
  attr_accessor :interval
241
-
242
205
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
243
206
  sig { returns(Integer) }
244
207
  attr_accessor :interval_count
245
-
246
208
  sig { params(interval: String, interval_count: Integer).void }
247
209
  def initialize(interval: nil, interval_count: nil); end
248
210
  end
@@ -251,15 +213,12 @@ module Stripe
251
213
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem::Discount::DiscountEnd::Duration)
252
214
  }
253
215
  attr_accessor :duration
254
-
255
216
  # A precise Unix timestamp for the discount to end. Must be in the future.
256
217
  sig { returns(Integer) }
257
218
  attr_accessor :timestamp
258
-
259
219
  # The type of calculation made to determine when the discount ends.
260
220
  sig { returns(String) }
261
221
  attr_accessor :type
262
-
263
222
  sig {
264
223
  params(duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
265
224
  }
@@ -268,21 +227,17 @@ module Stripe
268
227
  # ID of the coupon to create a new discount for.
269
228
  sig { returns(String) }
270
229
  attr_accessor :coupon
271
-
272
230
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
273
231
  sig { returns(String) }
274
232
  attr_accessor :discount
275
-
276
233
  # Details to determine how long the discount should be applied for.
277
234
  sig {
278
235
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem::Discount::DiscountEnd)
279
236
  }
280
237
  attr_accessor :discount_end
281
-
282
238
  # ID of the promotion code to create a new discount for.
283
239
  sig { returns(String) }
284
240
  attr_accessor :promotion_code
285
-
286
241
  sig {
287
242
  params(coupon: String, discount: String, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem::Discount::DiscountEnd, promotion_code: String).void
288
243
  }
@@ -292,11 +247,9 @@ module Stripe
292
247
  # The end of the period, which must be greater than or equal to the start. This value is inclusive.
293
248
  sig { returns(Integer) }
294
249
  attr_accessor :end
295
-
296
250
  # The start of the period. This value is inclusive.
297
251
  sig { returns(Integer) }
298
252
  attr_accessor :start
299
-
300
253
  sig { params(end_: Integer, start: Integer).void }
301
254
  def initialize(end_: nil, start: nil); end
302
255
  end
@@ -304,23 +257,18 @@ module Stripe
304
257
  # 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).
305
258
  sig { returns(String) }
306
259
  attr_accessor :currency
307
-
308
260
  # The ID of the product that this price will belong to.
309
261
  sig { returns(String) }
310
262
  attr_accessor :product
311
-
312
263
  # 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.
313
264
  sig { returns(String) }
314
265
  attr_accessor :tax_behavior
315
-
316
266
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
317
267
  sig { returns(Integer) }
318
268
  attr_accessor :unit_amount
319
-
320
269
  # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
321
270
  sig { returns(String) }
322
271
  attr_accessor :unit_amount_decimal
323
-
324
272
  sig {
325
273
  params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
326
274
  }
@@ -335,69 +283,53 @@ module Stripe
335
283
  # The integer amount in cents (or local equivalent) of previewed invoice item.
336
284
  sig { returns(Integer) }
337
285
  attr_accessor :amount
338
-
339
286
  # 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). Only applicable to new invoice items.
340
287
  sig { returns(String) }
341
288
  attr_accessor :currency
342
-
343
289
  # An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
344
290
  sig { returns(String) }
345
291
  attr_accessor :description
346
-
347
292
  # Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.
348
293
  sig { returns(T::Boolean) }
349
294
  attr_accessor :discountable
350
-
351
295
  # The coupons to redeem into discounts for the invoice item in the preview.
352
296
  sig {
353
297
  returns(T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem::Discount]))
354
298
  }
355
299
  attr_accessor :discounts
356
-
357
300
  # The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.
358
301
  sig { returns(String) }
359
302
  attr_accessor :invoiceitem
360
-
361
303
  # 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`.
362
304
  sig { returns(T.nilable(T::Hash[String, String])) }
363
305
  attr_accessor :metadata
364
-
365
306
  # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
366
307
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem::Period) }
367
308
  attr_accessor :period
368
-
369
309
  # The ID of the price object. One of `price` or `price_data` is required.
370
310
  sig { returns(String) }
371
311
  attr_accessor :price
372
-
373
312
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
374
313
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem::PriceData) }
375
314
  attr_accessor :price_data
376
-
377
315
  # Non-negative integer. The quantity of units for the invoice item.
378
316
  sig { returns(Integer) }
379
317
  attr_accessor :quantity
380
-
381
318
  # 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.
382
319
  sig { returns(String) }
383
320
  attr_accessor :tax_behavior
384
-
385
321
  # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
386
322
  sig { returns(T.nilable(String)) }
387
323
  attr_accessor :tax_code
388
-
389
324
  # The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
390
325
  sig { returns(T.nilable(T::Array[String])) }
391
326
  attr_accessor :tax_rates
392
-
393
327
  # The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
394
328
  sig { returns(Integer) }
395
329
  attr_accessor :unit_amount
396
-
397
330
  # 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.
398
331
  sig { returns(String) }
399
332
  attr_accessor :unit_amount_decimal
400
-
401
333
  sig {
402
334
  params(amount: Integer, currency: String, description: String, discountable: T::Boolean, discounts: T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem::Discount]), invoiceitem: String, metadata: T.nilable(T::Hash[String, String]), period: ::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem::Period, price: String, price_data: ::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem::PriceData, quantity: Integer, tax_behavior: String, tax_code: T.nilable(String), tax_rates: T.nilable(T::Array[String]), unit_amount: Integer, unit_amount_decimal: String).void
403
335
  }
@@ -424,11 +356,9 @@ module Stripe
424
356
  # The connected account being referenced when `type` is `account`.
425
357
  sig { returns(String) }
426
358
  attr_accessor :account
427
-
428
359
  # Type of the account referenced in the request.
429
360
  sig { returns(String) }
430
361
  attr_accessor :type
431
-
432
362
  sig { params(account: String, type: String).void }
433
363
  def initialize(account: nil, type: nil); end
434
364
  end
@@ -439,7 +369,6 @@ module Stripe
439
369
  # The ID of a specific discount.
440
370
  sig { returns(String) }
441
371
  attr_accessor :discount
442
-
443
372
  sig { params(discount: String).void }
444
373
  def initialize(discount: nil); end
445
374
  end
@@ -447,11 +376,9 @@ module Stripe
447
376
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
448
377
  sig { returns(String) }
449
378
  attr_accessor :interval
450
-
451
379
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
452
380
  sig { returns(Integer) }
453
381
  attr_accessor :interval_count
454
-
455
382
  sig { params(interval: String, interval_count: Integer).void }
456
383
  def initialize(interval: nil, interval_count: nil); end
457
384
  end
@@ -460,21 +387,17 @@ module Stripe
460
387
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentEnd::DiscountEnd)
461
388
  }
462
389
  attr_accessor :discount_end
463
-
464
390
  # Time span for the amendment starting from the `amendment_start`.
465
391
  sig {
466
392
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentEnd::Duration)
467
393
  }
468
394
  attr_accessor :duration
469
-
470
395
  # A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
471
396
  sig { returns(Integer) }
472
397
  attr_accessor :timestamp
473
-
474
398
  # Select one of three ways to pass the `amendment_end`.
475
399
  sig { returns(String) }
476
400
  attr_accessor :type
477
-
478
401
  sig {
479
402
  params(discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentEnd::DiscountEnd, duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentEnd::Duration, timestamp: Integer, type: String).void
480
403
  }
@@ -485,7 +408,6 @@ module Stripe
485
408
  # The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
486
409
  sig { returns(Integer) }
487
410
  attr_accessor :index
488
-
489
411
  sig { params(index: Integer).void }
490
412
  def initialize(index: nil); end
491
413
  end
@@ -493,7 +415,6 @@ module Stripe
493
415
  # The ID of a specific discount.
494
416
  sig { returns(String) }
495
417
  attr_accessor :discount
496
-
497
418
  sig { params(discount: String).void }
498
419
  def initialize(discount: nil); end
499
420
  end
@@ -502,21 +423,17 @@ module Stripe
502
423
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentStart::AmendmentEnd)
503
424
  }
504
425
  attr_accessor :amendment_end
505
-
506
426
  # Use the `end` time of a given discount.
507
427
  sig {
508
428
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentStart::DiscountEnd)
509
429
  }
510
430
  attr_accessor :discount_end
511
-
512
431
  # A precise Unix timestamp for the amendment to start.
513
432
  sig { returns(Integer) }
514
433
  attr_accessor :timestamp
515
-
516
434
  # Select one of three ways to pass the `amendment_start`.
517
435
  sig { returns(String) }
518
436
  attr_accessor :type
519
-
520
437
  sig {
521
438
  params(amendment_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentStart::AmendmentEnd, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentStart::DiscountEnd, timestamp: Integer, type: String).void
522
439
  }
@@ -528,32 +445,26 @@ module Stripe
528
445
  # The type of calculation made to determine when the discount ends.
529
446
  sig { returns(String) }
530
447
  attr_accessor :type
531
-
532
448
  sig { params(type: String).void }
533
449
  def initialize(type: nil); end
534
450
  end
535
451
  # The coupon code to redeem.
536
452
  sig { returns(String) }
537
453
  attr_accessor :coupon
538
-
539
454
  # An ID of an existing discount for a coupon that was already redeemed.
540
455
  sig { returns(String) }
541
456
  attr_accessor :discount
542
-
543
457
  # Details to determine how long the discount should be applied for.
544
458
  sig {
545
459
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::DiscountAction::Add::DiscountEnd)
546
460
  }
547
461
  attr_accessor :discount_end
548
-
549
462
  # The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
550
463
  sig { returns(Integer) }
551
464
  attr_accessor :index
552
-
553
465
  # The promotion code to redeem.
554
466
  sig { returns(String) }
555
467
  attr_accessor :promotion_code
556
-
557
468
  sig {
558
469
  params(coupon: String, discount: String, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::DiscountAction::Add::DiscountEnd, index: Integer, promotion_code: String).void
559
470
  }
@@ -569,15 +480,12 @@ module Stripe
569
480
  # The coupon code to remove from the `discounts` array.
570
481
  sig { returns(String) }
571
482
  attr_accessor :coupon
572
-
573
483
  # The ID of a discount to remove from the `discounts` array.
574
484
  sig { returns(String) }
575
485
  attr_accessor :discount
576
-
577
486
  # The ID of a promotion code to remove from the `discounts` array.
578
487
  sig { returns(String) }
579
488
  attr_accessor :promotion_code
580
-
581
489
  sig { params(coupon: String, discount: String, promotion_code: String).void }
582
490
  def initialize(coupon: nil, discount: nil, promotion_code: nil); end
583
491
  end
@@ -585,15 +493,12 @@ module Stripe
585
493
  # The coupon code to replace the `discounts` array with.
586
494
  sig { returns(String) }
587
495
  attr_accessor :coupon
588
-
589
496
  # An ID of an existing discount to replace the `discounts` array with.
590
497
  sig { returns(String) }
591
498
  attr_accessor :discount
592
-
593
499
  # An ID of an existing promotion code to replace the `discounts` array with.
594
500
  sig { returns(String) }
595
501
  attr_accessor :promotion_code
596
-
597
502
  sig { params(coupon: String, discount: String, promotion_code: String).void }
598
503
  def initialize(coupon: nil, discount: nil, promotion_code: nil); end
599
504
  end
@@ -602,23 +507,19 @@ module Stripe
602
507
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::DiscountAction::Add)
603
508
  }
604
509
  attr_accessor :add
605
-
606
510
  # Details of the discount to remove.
607
511
  sig {
608
512
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::DiscountAction::Remove)
609
513
  }
610
514
  attr_accessor :remove
611
-
612
515
  # Details of the discount to replace the existing discounts with.
613
516
  sig {
614
517
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::DiscountAction::Set)
615
518
  }
616
519
  attr_accessor :set
617
-
618
520
  # Determines the type of discount action.
619
521
  sig { returns(String) }
620
522
  attr_accessor :type
621
-
622
523
  sig {
623
524
  params(add: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::DiscountAction::Add, remove: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::DiscountAction::Remove, set: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::DiscountAction::Set, type: String).void
624
525
  }
@@ -632,11 +533,9 @@ module Stripe
632
533
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
633
534
  sig { returns(String) }
634
535
  attr_accessor :interval
635
-
636
536
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
637
537
  sig { returns(Integer) }
638
538
  attr_accessor :interval_count
639
-
640
539
  sig { params(interval: String, interval_count: Integer).void }
641
540
  def initialize(interval: nil, interval_count: nil); end
642
541
  end
@@ -645,15 +544,12 @@ module Stripe
645
544
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration)
646
545
  }
647
546
  attr_accessor :duration
648
-
649
547
  # A precise Unix timestamp for the discount to end. Must be in the future.
650
548
  sig { returns(Integer) }
651
549
  attr_accessor :timestamp
652
-
653
550
  # The type of calculation made to determine when the discount ends.
654
551
  sig { returns(String) }
655
552
  attr_accessor :type
656
-
657
553
  sig {
658
554
  params(duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
659
555
  }
@@ -662,21 +558,17 @@ module Stripe
662
558
  # ID of the coupon to create a new discount for.
663
559
  sig { returns(String) }
664
560
  attr_accessor :coupon
665
-
666
561
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
667
562
  sig { returns(String) }
668
563
  attr_accessor :discount
669
-
670
564
  # Details to determine how long the discount should be applied for.
671
565
  sig {
672
566
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd)
673
567
  }
674
568
  attr_accessor :discount_end
675
-
676
569
  # ID of the promotion code to create a new discount for.
677
570
  sig { returns(String) }
678
571
  attr_accessor :promotion_code
679
-
680
572
  sig {
681
573
  params(coupon: String, discount: String, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Add::Discount::DiscountEnd, promotion_code: String).void
682
574
  }
@@ -691,11 +583,9 @@ module Stripe
691
583
  # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
692
584
  sig { returns(T::Array[String]) }
693
585
  attr_accessor :converts_to
694
-
695
586
  # Determines the type of trial for this item.
696
587
  sig { returns(String) }
697
588
  attr_accessor :type
698
-
699
589
  sig { params(converts_to: T::Array[String], type: String).void }
700
590
  def initialize(converts_to: nil, type: nil); end
701
591
  end
@@ -704,29 +594,23 @@ module Stripe
704
594
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Add::Discount])
705
595
  }
706
596
  attr_accessor :discounts
707
-
708
597
  # 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`.
709
598
  sig { returns(T::Hash[String, String]) }
710
599
  attr_accessor :metadata
711
-
712
600
  # The ID of the price object.
713
601
  sig { returns(String) }
714
602
  attr_accessor :price
715
-
716
603
  # Quantity for this item.
717
604
  sig { returns(Integer) }
718
605
  attr_accessor :quantity
719
-
720
606
  # The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
721
607
  sig { returns(T::Array[String]) }
722
608
  attr_accessor :tax_rates
723
-
724
609
  # Options that configure the trial on the subscription item.
725
610
  sig {
726
611
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Add::Trial)
727
612
  }
728
613
  attr_accessor :trial
729
-
730
614
  sig {
731
615
  params(discounts: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Add::Discount], metadata: T::Hash[String, String], price: String, quantity: Integer, tax_rates: T::Array[String], trial: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Add::Trial).void
732
616
  }
@@ -743,7 +627,6 @@ module Stripe
743
627
  # ID of a price to remove.
744
628
  sig { returns(String) }
745
629
  attr_accessor :price
746
-
747
630
  sig { params(price: String).void }
748
631
  def initialize(price: nil); end
749
632
  end
@@ -754,11 +637,9 @@ module Stripe
754
637
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
755
638
  sig { returns(String) }
756
639
  attr_accessor :interval
757
-
758
640
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
759
641
  sig { returns(Integer) }
760
642
  attr_accessor :interval_count
761
-
762
643
  sig { params(interval: String, interval_count: Integer).void }
763
644
  def initialize(interval: nil, interval_count: nil); end
764
645
  end
@@ -767,15 +648,12 @@ module Stripe
767
648
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration)
768
649
  }
769
650
  attr_accessor :duration
770
-
771
651
  # A precise Unix timestamp for the discount to end. Must be in the future.
772
652
  sig { returns(Integer) }
773
653
  attr_accessor :timestamp
774
-
775
654
  # The type of calculation made to determine when the discount ends.
776
655
  sig { returns(String) }
777
656
  attr_accessor :type
778
-
779
657
  sig {
780
658
  params(duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
781
659
  }
@@ -784,21 +662,17 @@ module Stripe
784
662
  # ID of the coupon to create a new discount for.
785
663
  sig { returns(String) }
786
664
  attr_accessor :coupon
787
-
788
665
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
789
666
  sig { returns(String) }
790
667
  attr_accessor :discount
791
-
792
668
  # Details to determine how long the discount should be applied for.
793
669
  sig {
794
670
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd)
795
671
  }
796
672
  attr_accessor :discount_end
797
-
798
673
  # ID of the promotion code to create a new discount for.
799
674
  sig { returns(String) }
800
675
  attr_accessor :promotion_code
801
-
802
676
  sig {
803
677
  params(coupon: String, discount: String, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Set::Discount::DiscountEnd, promotion_code: String).void
804
678
  }
@@ -813,11 +687,9 @@ module Stripe
813
687
  # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
814
688
  sig { returns(T::Array[String]) }
815
689
  attr_accessor :converts_to
816
-
817
690
  # Determines the type of trial for this item.
818
691
  sig { returns(String) }
819
692
  attr_accessor :type
820
-
821
693
  sig { params(converts_to: T::Array[String], type: String).void }
822
694
  def initialize(converts_to: nil, type: nil); end
823
695
  end
@@ -826,29 +698,23 @@ module Stripe
826
698
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Set::Discount])
827
699
  }
828
700
  attr_accessor :discounts
829
-
830
701
  # If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
831
702
  sig { returns(T::Hash[String, String]) }
832
703
  attr_accessor :metadata
833
-
834
704
  # The ID of the price object.
835
705
  sig { returns(String) }
836
706
  attr_accessor :price
837
-
838
707
  # If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
839
708
  sig { returns(Integer) }
840
709
  attr_accessor :quantity
841
-
842
710
  # If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
843
711
  sig { returns(T::Array[String]) }
844
712
  attr_accessor :tax_rates
845
-
846
713
  # If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
847
714
  sig {
848
715
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Set::Trial)
849
716
  }
850
717
  attr_accessor :trial
851
-
852
718
  sig {
853
719
  params(discounts: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Set::Discount], metadata: T::Hash[String, String], price: String, quantity: Integer, tax_rates: T::Array[String], trial: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Set::Trial).void
854
720
  }
@@ -866,23 +732,19 @@ module Stripe
866
732
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Add)
867
733
  }
868
734
  attr_accessor :add
869
-
870
735
  # Details of the subscription item to remove.
871
736
  sig {
872
737
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Remove)
873
738
  }
874
739
  attr_accessor :remove
875
-
876
740
  # Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
877
741
  sig {
878
742
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Set)
879
743
  }
880
744
  attr_accessor :set
881
-
882
745
  # Determines the type of item action.
883
746
  sig { returns(String) }
884
747
  attr_accessor :type
885
-
886
748
  sig {
887
749
  params(add: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Add, remove: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Remove, set: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction::Set, type: String).void
888
750
  }
@@ -892,19 +754,15 @@ module Stripe
892
754
  # Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
893
755
  sig { returns(T::Hash[String, String]) }
894
756
  attr_accessor :add
895
-
896
757
  # Keys to remove from schedule phase metadata.
897
758
  sig { returns(T::Array[String]) }
898
759
  attr_accessor :remove
899
-
900
760
  # Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
901
761
  sig { returns(T.nilable(T::Hash[String, String])) }
902
762
  attr_accessor :set
903
-
904
763
  # Select one of three ways to update phase-level `metadata` on subscription schedules.
905
764
  sig { returns(String) }
906
765
  attr_accessor :type
907
-
908
766
  sig {
909
767
  params(add: T::Hash[String, String], remove: T::Array[String], set: T.nilable(T::Hash[String, String]), type: String).void
910
768
  }
@@ -915,7 +773,6 @@ module Stripe
915
773
  # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
916
774
  sig { returns(String) }
917
775
  attr_accessor :behavior
918
-
919
776
  sig { params(behavior: String).void }
920
777
  def initialize(behavior: nil); end
921
778
  end
@@ -924,11 +781,9 @@ module Stripe
924
781
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::SetPauseCollection::Set)
925
782
  }
926
783
  attr_accessor :set
927
-
928
784
  # Determines the type of the pause_collection amendment.
929
785
  sig { returns(String) }
930
786
  attr_accessor :type
931
-
932
787
  sig {
933
788
  params(set: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::SetPauseCollection::Set, type: String).void
934
789
  }
@@ -939,7 +794,6 @@ module Stripe
939
794
  # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
940
795
  sig { returns(String) }
941
796
  attr_accessor :prorate_up_front
942
-
943
797
  sig { params(prorate_up_front: String).void }
944
798
  def initialize(prorate_up_front: nil); end
945
799
  end
@@ -948,7 +802,6 @@ module Stripe
948
802
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::TrialSettings::EndBehavior)
949
803
  }
950
804
  attr_accessor :end_behavior
951
-
952
805
  sig {
953
806
  params(end_behavior: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::TrialSettings::EndBehavior).void
954
807
  }
@@ -959,55 +812,45 @@ module Stripe
959
812
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentEnd)
960
813
  }
961
814
  attr_accessor :amendment_end
962
-
963
815
  # Details to identify the earliest timestamp where the proposed change should take effect.
964
816
  sig {
965
817
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentStart)
966
818
  }
967
819
  attr_accessor :amendment_start
968
-
969
820
  # For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
970
821
  sig { returns(String) }
971
822
  attr_accessor :billing_cycle_anchor
972
-
973
823
  # Changes to the coupons being redeemed or discounts being applied during the amendment time span.
974
824
  sig {
975
825
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::DiscountAction])
976
826
  }
977
827
  attr_accessor :discount_actions
978
-
979
828
  # Changes to the subscription items during the amendment time span.
980
829
  sig {
981
830
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction])
982
831
  }
983
832
  attr_accessor :item_actions
984
-
985
833
  # Instructions for how to modify phase metadata
986
834
  sig {
987
835
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::MetadataAction])
988
836
  }
989
837
  attr_accessor :metadata_actions
990
-
991
838
  # Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
992
839
  sig { returns(String) }
993
840
  attr_accessor :proration_behavior
994
-
995
841
  # Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
996
842
  sig {
997
843
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::SetPauseCollection)
998
844
  }
999
845
  attr_accessor :set_pause_collection
1000
-
1001
846
  # Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
1002
847
  sig { returns(String) }
1003
848
  attr_accessor :set_schedule_end
1004
-
1005
849
  # Settings related to subscription trials.
1006
850
  sig {
1007
851
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::TrialSettings)
1008
852
  }
1009
853
  attr_accessor :trial_settings
1010
-
1011
854
  sig {
1012
855
  params(amendment_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentEnd, amendment_start: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::AmendmentStart, billing_cycle_anchor: String, discount_actions: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::DiscountAction], item_actions: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::ItemAction], metadata_actions: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::MetadataAction], proration_behavior: String, set_pause_collection: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::SetPauseCollection, set_schedule_end: String, trial_settings: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment::TrialSettings).void
1013
856
  }
@@ -1032,11 +875,9 @@ module Stripe
1032
875
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1033
876
  sig { returns(String) }
1034
877
  attr_accessor :interval
1035
-
1036
878
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1037
879
  sig { returns(Integer) }
1038
880
  attr_accessor :interval_count
1039
-
1040
881
  sig { params(interval: String, interval_count: Integer).void }
1041
882
  def initialize(interval: nil, interval_count: nil); end
1042
883
  end
@@ -1045,15 +886,12 @@ module Stripe
1045
886
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)
1046
887
  }
1047
888
  attr_accessor :duration
1048
-
1049
889
  # A precise Unix timestamp for the discount to end. Must be in the future.
1050
890
  sig { returns(Integer) }
1051
891
  attr_accessor :timestamp
1052
-
1053
892
  # The type of calculation made to determine when the discount ends.
1054
893
  sig { returns(String) }
1055
894
  attr_accessor :type
1056
-
1057
895
  sig {
1058
896
  params(duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1059
897
  }
@@ -1062,21 +900,17 @@ module Stripe
1062
900
  # ID of the coupon to create a new discount for.
1063
901
  sig { returns(String) }
1064
902
  attr_accessor :coupon
1065
-
1066
903
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1067
904
  sig { returns(String) }
1068
905
  attr_accessor :discount
1069
-
1070
906
  # Details to determine how long the discount should be applied for.
1071
907
  sig {
1072
908
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd)
1073
909
  }
1074
910
  attr_accessor :discount_end
1075
-
1076
911
  # ID of the promotion code to create a new discount for.
1077
912
  sig { returns(String) }
1078
913
  attr_accessor :promotion_code
1079
-
1080
914
  sig {
1081
915
  params(coupon: String, discount: String, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
1082
916
  }
@@ -1091,23 +925,18 @@ module Stripe
1091
925
  # 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).
1092
926
  sig { returns(String) }
1093
927
  attr_accessor :currency
1094
-
1095
928
  # The ID of the product that this price will belong to.
1096
929
  sig { returns(String) }
1097
930
  attr_accessor :product
1098
-
1099
931
  # 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.
1100
932
  sig { returns(String) }
1101
933
  attr_accessor :tax_behavior
1102
-
1103
934
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
1104
935
  sig { returns(Integer) }
1105
936
  attr_accessor :unit_amount
1106
-
1107
937
  # 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.
1108
938
  sig { returns(String) }
1109
939
  attr_accessor :unit_amount_decimal
1110
-
1111
940
  sig {
1112
941
  params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1113
942
  }
@@ -1124,25 +953,20 @@ module Stripe
1124
953
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AddInvoiceItem::Discount])
1125
954
  }
1126
955
  attr_accessor :discounts
1127
-
1128
956
  # The ID of the price object. One of `price` or `price_data` is required.
1129
957
  sig { returns(String) }
1130
958
  attr_accessor :price
1131
-
1132
959
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
1133
960
  sig {
1134
961
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AddInvoiceItem::PriceData)
1135
962
  }
1136
963
  attr_accessor :price_data
1137
-
1138
964
  # Quantity for this item. Defaults to 1.
1139
965
  sig { returns(Integer) }
1140
966
  attr_accessor :quantity
1141
-
1142
967
  # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
1143
968
  sig { returns(T.nilable(T::Array[String])) }
1144
969
  attr_accessor :tax_rates
1145
-
1146
970
  sig {
1147
971
  params(discounts: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
1148
972
  }
@@ -1159,24 +983,20 @@ module Stripe
1159
983
  # The connected account being referenced when `type` is `account`.
1160
984
  sig { returns(String) }
1161
985
  attr_accessor :account
1162
-
1163
986
  # Type of the account referenced in the request.
1164
987
  sig { returns(String) }
1165
988
  attr_accessor :type
1166
-
1167
989
  sig { params(account: String, type: String).void }
1168
990
  def initialize(account: nil, type: nil); end
1169
991
  end
1170
992
  # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
1171
993
  sig { returns(T::Boolean) }
1172
994
  attr_accessor :enabled
1173
-
1174
995
  # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
1175
996
  sig {
1176
997
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AutomaticTax::Liability)
1177
998
  }
1178
999
  attr_accessor :liability
1179
-
1180
1000
  sig {
1181
1001
  params(enabled: T::Boolean, liability: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AutomaticTax::Liability).void
1182
1002
  }
@@ -1186,11 +1006,9 @@ module Stripe
1186
1006
  # Monetary threshold that triggers the subscription to advance to a new billing period
1187
1007
  sig { returns(Integer) }
1188
1008
  attr_accessor :amount_gte
1189
-
1190
1009
  # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
1191
1010
  sig { returns(T::Boolean) }
1192
1011
  attr_accessor :reset_billing_cycle_anchor
1193
-
1194
1012
  sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
1195
1013
  def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
1196
1014
  end
@@ -1200,11 +1018,9 @@ module Stripe
1200
1018
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1201
1019
  sig { returns(String) }
1202
1020
  attr_accessor :interval
1203
-
1204
1021
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1205
1022
  sig { returns(Integer) }
1206
1023
  attr_accessor :interval_count
1207
-
1208
1024
  sig { params(interval: String, interval_count: Integer).void }
1209
1025
  def initialize(interval: nil, interval_count: nil); end
1210
1026
  end
@@ -1213,15 +1029,12 @@ module Stripe
1213
1029
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Discount::DiscountEnd::Duration)
1214
1030
  }
1215
1031
  attr_accessor :duration
1216
-
1217
1032
  # A precise Unix timestamp for the discount to end. Must be in the future.
1218
1033
  sig { returns(Integer) }
1219
1034
  attr_accessor :timestamp
1220
-
1221
1035
  # The type of calculation made to determine when the discount ends.
1222
1036
  sig { returns(String) }
1223
1037
  attr_accessor :type
1224
-
1225
1038
  sig {
1226
1039
  params(duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1227
1040
  }
@@ -1230,21 +1043,17 @@ module Stripe
1230
1043
  # ID of the coupon to create a new discount for.
1231
1044
  sig { returns(String) }
1232
1045
  attr_accessor :coupon
1233
-
1234
1046
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1235
1047
  sig { returns(String) }
1236
1048
  attr_accessor :discount
1237
-
1238
1049
  # Details to determine how long the discount should be applied for.
1239
1050
  sig {
1240
1051
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Discount::DiscountEnd)
1241
1052
  }
1242
1053
  attr_accessor :discount_end
1243
-
1244
1054
  # ID of the promotion code to create a new discount for.
1245
1055
  sig { returns(String) }
1246
1056
  attr_accessor :promotion_code
1247
-
1248
1057
  sig {
1249
1058
  params(coupon: String, discount: String, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Discount::DiscountEnd, promotion_code: String).void
1250
1059
  }
@@ -1255,28 +1064,23 @@ module Stripe
1255
1064
  # The connected account being referenced when `type` is `account`.
1256
1065
  sig { returns(String) }
1257
1066
  attr_accessor :account
1258
-
1259
1067
  # Type of the account referenced in the request.
1260
1068
  sig { returns(String) }
1261
1069
  attr_accessor :type
1262
-
1263
1070
  sig { params(account: String, type: String).void }
1264
1071
  def initialize(account: nil, type: nil); end
1265
1072
  end
1266
1073
  # The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
1267
1074
  sig { returns(T.nilable(T::Array[String])) }
1268
1075
  attr_accessor :account_tax_ids
1269
-
1270
1076
  # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
1271
1077
  sig { returns(Integer) }
1272
1078
  attr_accessor :days_until_due
1273
-
1274
1079
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1275
1080
  sig {
1276
1081
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::InvoiceSettings::Issuer)
1277
1082
  }
1278
1083
  attr_accessor :issuer
1279
-
1280
1084
  sig {
1281
1085
  params(account_tax_ids: T.nilable(T::Array[String]), days_until_due: Integer, issuer: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::InvoiceSettings::Issuer).void
1282
1086
  }
@@ -1287,7 +1091,6 @@ module Stripe
1287
1091
  # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
1288
1092
  sig { returns(Integer) }
1289
1093
  attr_accessor :usage_gte
1290
-
1291
1094
  sig { params(usage_gte: Integer).void }
1292
1095
  def initialize(usage_gte: nil); end
1293
1096
  end
@@ -1297,11 +1100,9 @@ module Stripe
1297
1100
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1298
1101
  sig { returns(String) }
1299
1102
  attr_accessor :interval
1300
-
1301
1103
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1302
1104
  sig { returns(Integer) }
1303
1105
  attr_accessor :interval_count
1304
-
1305
1106
  sig { params(interval: String, interval_count: Integer).void }
1306
1107
  def initialize(interval: nil, interval_count: nil); end
1307
1108
  end
@@ -1310,15 +1111,12 @@ module Stripe
1310
1111
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd::Duration)
1311
1112
  }
1312
1113
  attr_accessor :duration
1313
-
1314
1114
  # A precise Unix timestamp for the discount to end. Must be in the future.
1315
1115
  sig { returns(Integer) }
1316
1116
  attr_accessor :timestamp
1317
-
1318
1117
  # The type of calculation made to determine when the discount ends.
1319
1118
  sig { returns(String) }
1320
1119
  attr_accessor :type
1321
-
1322
1120
  sig {
1323
1121
  params(duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1324
1122
  }
@@ -1327,21 +1125,17 @@ module Stripe
1327
1125
  # ID of the coupon to create a new discount for.
1328
1126
  sig { returns(String) }
1329
1127
  attr_accessor :coupon
1330
-
1331
1128
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1332
1129
  sig { returns(String) }
1333
1130
  attr_accessor :discount
1334
-
1335
1131
  # Details to determine how long the discount should be applied for.
1336
1132
  sig {
1337
1133
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd)
1338
1134
  }
1339
1135
  attr_accessor :discount_end
1340
-
1341
1136
  # ID of the promotion code to create a new discount for.
1342
1137
  sig { returns(String) }
1343
1138
  attr_accessor :promotion_code
1344
-
1345
1139
  sig {
1346
1140
  params(coupon: String, discount: String, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::Discount::DiscountEnd, promotion_code: String).void
1347
1141
  }
@@ -1357,40 +1151,32 @@ module Stripe
1357
1151
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1358
1152
  sig { returns(String) }
1359
1153
  attr_accessor :interval
1360
-
1361
1154
  # 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).
1362
1155
  sig { returns(Integer) }
1363
1156
  attr_accessor :interval_count
1364
-
1365
1157
  sig { params(interval: String, interval_count: Integer).void }
1366
1158
  def initialize(interval: nil, interval_count: nil); end
1367
1159
  end
1368
1160
  # 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).
1369
1161
  sig { returns(String) }
1370
1162
  attr_accessor :currency
1371
-
1372
1163
  # The ID of the product that this price will belong to.
1373
1164
  sig { returns(String) }
1374
1165
  attr_accessor :product
1375
-
1376
1166
  # The recurring components of a price such as `interval` and `interval_count`.
1377
1167
  sig {
1378
1168
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::PriceData::Recurring)
1379
1169
  }
1380
1170
  attr_accessor :recurring
1381
-
1382
1171
  # 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.
1383
1172
  sig { returns(String) }
1384
1173
  attr_accessor :tax_behavior
1385
-
1386
1174
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
1387
1175
  sig { returns(Integer) }
1388
1176
  attr_accessor :unit_amount
1389
-
1390
1177
  # 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.
1391
1178
  sig { returns(String) }
1392
1179
  attr_accessor :unit_amount_decimal
1393
-
1394
1180
  sig {
1395
1181
  params(currency: String, product: String, recurring: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1396
1182
  }
@@ -1407,11 +1193,9 @@ module Stripe
1407
1193
  # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
1408
1194
  sig { returns(T::Array[String]) }
1409
1195
  attr_accessor :converts_to
1410
-
1411
1196
  # Determines the type of trial for this item.
1412
1197
  sig { returns(String) }
1413
1198
  attr_accessor :type
1414
-
1415
1199
  sig { params(converts_to: T::Array[String], type: String).void }
1416
1200
  def initialize(converts_to: nil, type: nil); end
1417
1201
  end
@@ -1420,45 +1204,36 @@ module Stripe
1420
1204
  returns(T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::BillingThresholds))
1421
1205
  }
1422
1206
  attr_accessor :billing_thresholds
1423
-
1424
1207
  # The coupons to redeem into discounts for the subscription item.
1425
1208
  sig {
1426
1209
  returns(T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::Discount]))
1427
1210
  }
1428
1211
  attr_accessor :discounts
1429
-
1430
1212
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
1431
1213
  sig { returns(T::Hash[String, String]) }
1432
1214
  attr_accessor :metadata
1433
-
1434
1215
  # The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
1435
1216
  sig { returns(String) }
1436
1217
  attr_accessor :plan
1437
-
1438
1218
  # The ID of the price object.
1439
1219
  sig { returns(String) }
1440
1220
  attr_accessor :price
1441
-
1442
1221
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
1443
1222
  sig {
1444
1223
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::PriceData)
1445
1224
  }
1446
1225
  attr_accessor :price_data
1447
-
1448
1226
  # Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
1449
1227
  sig { returns(Integer) }
1450
1228
  attr_accessor :quantity
1451
-
1452
1229
  # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
1453
1230
  sig { returns(T.nilable(T::Array[String])) }
1454
1231
  attr_accessor :tax_rates
1455
-
1456
1232
  # Options that configure the trial on the subscription item.
1457
1233
  sig {
1458
1234
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::Trial)
1459
1235
  }
1460
1236
  attr_accessor :trial
1461
-
1462
1237
  sig {
1463
1238
  params(billing_thresholds: T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::BillingThresholds), discounts: T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::Discount]), metadata: T::Hash[String, String], plan: String, price: String, price_data: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String]), trial: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item::Trial).void
1464
1239
  }
@@ -1478,7 +1253,6 @@ module Stripe
1478
1253
  # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
1479
1254
  sig { returns(String) }
1480
1255
  attr_accessor :behavior
1481
-
1482
1256
  sig { params(behavior: String).void }
1483
1257
  def initialize(behavior: nil); end
1484
1258
  end
@@ -1486,11 +1260,9 @@ module Stripe
1486
1260
  # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
1487
1261
  sig { returns(Float) }
1488
1262
  attr_accessor :amount_percent
1489
-
1490
1263
  # ID of an existing, connected Stripe account.
1491
1264
  sig { returns(String) }
1492
1265
  attr_accessor :destination
1493
-
1494
1266
  sig { params(amount_percent: Float, destination: String).void }
1495
1267
  def initialize(amount_percent: nil, destination: nil); end
1496
1268
  end
@@ -1499,7 +1271,6 @@ module Stripe
1499
1271
  # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
1500
1272
  sig { returns(String) }
1501
1273
  attr_accessor :prorate_up_front
1502
-
1503
1274
  sig { params(prorate_up_front: String).void }
1504
1275
  def initialize(prorate_up_front: nil); end
1505
1276
  end
@@ -1508,7 +1279,6 @@ module Stripe
1508
1279
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::TrialSettings::EndBehavior)
1509
1280
  }
1510
1281
  attr_accessor :end_behavior
1511
-
1512
1282
  sig {
1513
1283
  params(end_behavior: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::TrialSettings::EndBehavior).void
1514
1284
  }
@@ -1519,123 +1289,97 @@ module Stripe
1519
1289
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AddInvoiceItem])
1520
1290
  }
1521
1291
  attr_accessor :add_invoice_items
1522
-
1523
1292
  # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
1524
1293
  sig { returns(Float) }
1525
1294
  attr_accessor :application_fee_percent
1526
-
1527
1295
  # Automatic tax settings for this phase.
1528
1296
  sig {
1529
1297
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AutomaticTax)
1530
1298
  }
1531
1299
  attr_accessor :automatic_tax
1532
-
1533
1300
  # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
1534
1301
  sig { returns(String) }
1535
1302
  attr_accessor :billing_cycle_anchor
1536
-
1537
1303
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
1538
1304
  sig {
1539
1305
  returns(T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::BillingThresholds))
1540
1306
  }
1541
1307
  attr_accessor :billing_thresholds
1542
-
1543
1308
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
1544
1309
  sig { returns(String) }
1545
1310
  attr_accessor :collection_method
1546
-
1547
1311
  # The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
1548
1312
  sig { returns(String) }
1549
1313
  attr_accessor :coupon
1550
-
1551
1314
  # 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).
1552
1315
  sig { returns(String) }
1553
1316
  attr_accessor :currency
1554
-
1555
1317
  # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
1556
1318
  sig { returns(String) }
1557
1319
  attr_accessor :default_payment_method
1558
-
1559
1320
  # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
1560
1321
  sig { returns(T.nilable(T::Array[String])) }
1561
1322
  attr_accessor :default_tax_rates
1562
-
1563
1323
  # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1564
1324
  sig { returns(T.nilable(String)) }
1565
1325
  attr_accessor :description
1566
-
1567
1326
  # The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
1568
1327
  sig {
1569
1328
  returns(T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Discount]))
1570
1329
  }
1571
1330
  attr_accessor :discounts
1572
-
1573
1331
  # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
1574
1332
  sig { returns(T.any(Integer, String)) }
1575
1333
  attr_accessor :end_date
1576
-
1577
1334
  # All invoices will be billed using the specified settings.
1578
1335
  sig {
1579
1336
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::InvoiceSettings)
1580
1337
  }
1581
1338
  attr_accessor :invoice_settings
1582
-
1583
1339
  # List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
1584
1340
  sig {
1585
1341
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item])
1586
1342
  }
1587
1343
  attr_accessor :items
1588
-
1589
1344
  # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
1590
1345
  sig { returns(Integer) }
1591
1346
  attr_accessor :iterations
1592
-
1593
1347
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
1594
1348
  sig { returns(T::Hash[String, String]) }
1595
1349
  attr_accessor :metadata
1596
-
1597
1350
  # The account on behalf of which to charge, for each of the associated subscription's invoices.
1598
1351
  sig { returns(String) }
1599
1352
  attr_accessor :on_behalf_of
1600
-
1601
1353
  # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
1602
1354
  sig {
1603
1355
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::PauseCollection)
1604
1356
  }
1605
1357
  attr_accessor :pause_collection
1606
-
1607
1358
  # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
1608
1359
  sig { returns(String) }
1609
1360
  attr_accessor :proration_behavior
1610
-
1611
1361
  # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
1612
1362
  sig { returns(T.any(Integer, String)) }
1613
1363
  attr_accessor :start_date
1614
-
1615
1364
  # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
1616
1365
  sig {
1617
1366
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::TransferData)
1618
1367
  }
1619
1368
  attr_accessor :transfer_data
1620
-
1621
1369
  # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
1622
1370
  sig { returns(T::Boolean) }
1623
1371
  attr_accessor :trial
1624
-
1625
1372
  # Specify trial behavior when crossing phase boundaries
1626
1373
  sig { returns(String) }
1627
1374
  attr_accessor :trial_continuation
1628
-
1629
1375
  # Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
1630
1376
  sig { returns(T.any(Integer, String)) }
1631
1377
  attr_accessor :trial_end
1632
-
1633
1378
  # Settings related to subscription trials.
1634
1379
  sig {
1635
1380
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::TrialSettings)
1636
1381
  }
1637
1382
  attr_accessor :trial_settings
1638
-
1639
1383
  sig {
1640
1384
  params(add_invoice_items: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AddInvoiceItem], application_fee_percent: Float, automatic_tax: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::BillingThresholds), collection_method: String, coupon: String, currency: String, default_payment_method: String, default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Discount]), end_date: T.any(Integer, String), invoice_settings: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::InvoiceSettings, items: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::Item], iterations: Integer, metadata: T::Hash[String, String], on_behalf_of: String, pause_collection: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::PauseCollection, proration_behavior: String, start_date: T.any(Integer, String), transfer_data: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::TransferData, trial: T::Boolean, trial_continuation: String, trial_end: T.any(Integer, String), trial_settings: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase::TrialSettings).void
1641
1385
  }
@@ -1674,7 +1418,6 @@ module Stripe
1674
1418
  # The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
1675
1419
  sig { returns(Integer) }
1676
1420
  attr_accessor :index
1677
-
1678
1421
  sig { params(index: Integer).void }
1679
1422
  def initialize(index: nil); end
1680
1423
  end
@@ -1682,11 +1425,9 @@ module Stripe
1682
1425
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1683
1426
  sig { returns(String) }
1684
1427
  attr_accessor :interval
1685
-
1686
1428
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1687
1429
  sig { returns(Integer) }
1688
1430
  attr_accessor :interval_count
1689
-
1690
1431
  sig { params(interval: String, interval_count: Integer).void }
1691
1432
  def initialize(interval: nil, interval_count: nil); end
1692
1433
  end
@@ -1695,21 +1436,17 @@ module Stripe
1695
1436
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Prebilling::BillUntil::AmendmentEnd)
1696
1437
  }
1697
1438
  attr_accessor :amendment_end
1698
-
1699
1439
  # Time span for prebilling, starting from `bill_from`.
1700
1440
  sig {
1701
1441
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Prebilling::BillUntil::Duration)
1702
1442
  }
1703
1443
  attr_accessor :duration
1704
-
1705
1444
  # End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
1706
1445
  sig { returns(Integer) }
1707
1446
  attr_accessor :timestamp
1708
-
1709
1447
  # Select one of several ways to pass the `bill_until` value.
1710
1448
  sig { returns(String) }
1711
1449
  attr_accessor :type
1712
-
1713
1450
  sig {
1714
1451
  params(amendment_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Prebilling::BillUntil::AmendmentEnd, duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Prebilling::BillUntil::Duration, timestamp: Integer, type: String).void
1715
1452
  }
@@ -1720,11 +1457,9 @@ module Stripe
1720
1457
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Prebilling::BillUntil)
1721
1458
  }
1722
1459
  attr_accessor :bill_until
1723
-
1724
1460
  # This is used to determine the number of billing cycles to prebill.
1725
1461
  sig { returns(Integer) }
1726
1462
  attr_accessor :iterations
1727
-
1728
1463
  sig {
1729
1464
  params(bill_until: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Prebilling::BillUntil, iterations: Integer).void
1730
1465
  }
@@ -1735,31 +1470,25 @@ module Stripe
1735
1470
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment])
1736
1471
  }
1737
1472
  attr_accessor :amendments
1738
-
1739
1473
  # Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
1740
1474
  sig { returns(String) }
1741
1475
  attr_accessor :billing_behavior
1742
-
1743
1476
  # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
1744
1477
  sig { returns(String) }
1745
1478
  attr_accessor :end_behavior
1746
-
1747
1479
  # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
1748
1480
  sig {
1749
1481
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase])
1750
1482
  }
1751
1483
  attr_accessor :phases
1752
-
1753
1484
  # Provide any time periods to bill in advance.
1754
1485
  sig {
1755
1486
  returns(T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Prebilling]))
1756
1487
  }
1757
1488
  attr_accessor :prebilling
1758
-
1759
1489
  # In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
1760
1490
  sig { returns(String) }
1761
1491
  attr_accessor :proration_behavior
1762
-
1763
1492
  sig {
1764
1493
  params(amendments: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Amendment], billing_behavior: String, end_behavior: String, phases: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Phase], prebilling: T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails::Prebilling]), proration_behavior: String).void
1765
1494
  }
@@ -1778,7 +1507,6 @@ module Stripe
1778
1507
  # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
1779
1508
  sig { returns(Integer) }
1780
1509
  attr_accessor :usage_gte
1781
-
1782
1510
  sig { params(usage_gte: Integer).void }
1783
1511
  def initialize(usage_gte: nil); end
1784
1512
  end
@@ -1788,11 +1516,9 @@ module Stripe
1788
1516
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1789
1517
  sig { returns(String) }
1790
1518
  attr_accessor :interval
1791
-
1792
1519
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1793
1520
  sig { returns(Integer) }
1794
1521
  attr_accessor :interval_count
1795
-
1796
1522
  sig { params(interval: String, interval_count: Integer).void }
1797
1523
  def initialize(interval: nil, interval_count: nil); end
1798
1524
  end
@@ -1801,15 +1527,12 @@ module Stripe
1801
1527
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::Discount::DiscountEnd::Duration)
1802
1528
  }
1803
1529
  attr_accessor :duration
1804
-
1805
1530
  # A precise Unix timestamp for the discount to end. Must be in the future.
1806
1531
  sig { returns(Integer) }
1807
1532
  attr_accessor :timestamp
1808
-
1809
1533
  # The type of calculation made to determine when the discount ends.
1810
1534
  sig { returns(String) }
1811
1535
  attr_accessor :type
1812
-
1813
1536
  sig {
1814
1537
  params(duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1815
1538
  }
@@ -1818,21 +1541,17 @@ module Stripe
1818
1541
  # ID of the coupon to create a new discount for.
1819
1542
  sig { returns(String) }
1820
1543
  attr_accessor :coupon
1821
-
1822
1544
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1823
1545
  sig { returns(String) }
1824
1546
  attr_accessor :discount
1825
-
1826
1547
  # Details to determine how long the discount should be applied for.
1827
1548
  sig {
1828
1549
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::Discount::DiscountEnd)
1829
1550
  }
1830
1551
  attr_accessor :discount_end
1831
-
1832
1552
  # ID of the promotion code to create a new discount for.
1833
1553
  sig { returns(String) }
1834
1554
  attr_accessor :promotion_code
1835
-
1836
1555
  sig {
1837
1556
  params(coupon: String, discount: String, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::Discount::DiscountEnd, promotion_code: String).void
1838
1557
  }
@@ -1843,40 +1562,32 @@ module Stripe
1843
1562
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1844
1563
  sig { returns(String) }
1845
1564
  attr_accessor :interval
1846
-
1847
1565
  # 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).
1848
1566
  sig { returns(Integer) }
1849
1567
  attr_accessor :interval_count
1850
-
1851
1568
  sig { params(interval: String, interval_count: Integer).void }
1852
1569
  def initialize(interval: nil, interval_count: nil); end
1853
1570
  end
1854
1571
  # 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).
1855
1572
  sig { returns(String) }
1856
1573
  attr_accessor :currency
1857
-
1858
1574
  # The ID of the product that this price will belong to.
1859
1575
  sig { returns(String) }
1860
1576
  attr_accessor :product
1861
-
1862
1577
  # The recurring components of a price such as `interval` and `interval_count`.
1863
1578
  sig {
1864
1579
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::PriceData::Recurring)
1865
1580
  }
1866
1581
  attr_accessor :recurring
1867
-
1868
1582
  # 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.
1869
1583
  sig { returns(String) }
1870
1584
  attr_accessor :tax_behavior
1871
-
1872
1585
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
1873
1586
  sig { returns(Integer) }
1874
1587
  attr_accessor :unit_amount
1875
-
1876
1588
  # 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.
1877
1589
  sig { returns(String) }
1878
1590
  attr_accessor :unit_amount_decimal
1879
-
1880
1591
  sig {
1881
1592
  params(currency: String, product: String, recurring: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1882
1593
  }
@@ -1894,51 +1605,40 @@ module Stripe
1894
1605
  returns(T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::BillingThresholds))
1895
1606
  }
1896
1607
  attr_accessor :billing_thresholds
1897
-
1898
1608
  # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
1899
1609
  sig { returns(T::Boolean) }
1900
1610
  attr_accessor :clear_usage
1901
-
1902
1611
  # A flag that, if set to `true`, will delete the specified item.
1903
1612
  sig { returns(T::Boolean) }
1904
1613
  attr_accessor :deleted
1905
-
1906
1614
  # The coupons to redeem into discounts for the subscription item.
1907
1615
  sig {
1908
1616
  returns(T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::Discount]))
1909
1617
  }
1910
1618
  attr_accessor :discounts
1911
-
1912
1619
  # Subscription item to update.
1913
1620
  sig { returns(String) }
1914
1621
  attr_accessor :id
1915
-
1916
1622
  # 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`.
1917
1623
  sig { returns(T.nilable(T::Hash[String, String])) }
1918
1624
  attr_accessor :metadata
1919
-
1920
1625
  # Plan ID for this item, as a string.
1921
1626
  sig { returns(String) }
1922
1627
  attr_accessor :plan
1923
-
1924
1628
  # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
1925
1629
  sig { returns(String) }
1926
1630
  attr_accessor :price
1927
-
1928
1631
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
1929
1632
  sig {
1930
1633
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::PriceData)
1931
1634
  }
1932
1635
  attr_accessor :price_data
1933
-
1934
1636
  # Quantity for this item.
1935
1637
  sig { returns(Integer) }
1936
1638
  attr_accessor :quantity
1937
-
1938
1639
  # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
1939
1640
  sig { returns(T.nilable(T::Array[String])) }
1940
1641
  attr_accessor :tax_rates
1941
-
1942
1642
  sig {
1943
1643
  params(billing_thresholds: T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::BillingThresholds), clear_usage: T::Boolean, deleted: T::Boolean, discounts: T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::Discount]), id: String, metadata: T.nilable(T::Hash[String, String]), plan: String, price: String, price_data: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
1944
1644
  }
@@ -1960,62 +1660,49 @@ module Stripe
1960
1660
  # This is used to determine the number of billing cycles to prebill.
1961
1661
  sig { returns(Integer) }
1962
1662
  attr_accessor :iterations
1963
-
1964
1663
  sig { params(iterations: Integer).void }
1965
1664
  def initialize(iterations: nil); end
1966
1665
  end
1967
1666
  # For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
1968
1667
  sig { returns(T.any(String, Integer)) }
1969
1668
  attr_accessor :billing_cycle_anchor
1970
-
1971
1669
  # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
1972
1670
  sig { returns(T.nilable(Integer)) }
1973
1671
  attr_accessor :cancel_at
1974
-
1975
1672
  # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
1976
1673
  sig { returns(T::Boolean) }
1977
1674
  attr_accessor :cancel_at_period_end
1978
-
1979
1675
  # This simulates the subscription being canceled or expired immediately.
1980
1676
  sig { returns(T::Boolean) }
1981
1677
  attr_accessor :cancel_now
1982
-
1983
1678
  # If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.
1984
1679
  sig { returns(T.nilable(T::Array[String])) }
1985
1680
  attr_accessor :default_tax_rates
1986
-
1987
1681
  # A list of up to 20 subscription items, each with an attached price.
1988
1682
  sig {
1989
1683
  returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item])
1990
1684
  }
1991
1685
  attr_accessor :items
1992
-
1993
1686
  # The pre-billing to apply to the subscription as a preview.
1994
1687
  sig {
1995
1688
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Prebilling)
1996
1689
  }
1997
1690
  attr_accessor :prebilling
1998
-
1999
1691
  # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
2000
1692
  sig { returns(String) }
2001
1693
  attr_accessor :proration_behavior
2002
-
2003
1694
  # If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
2004
1695
  sig { returns(Integer) }
2005
1696
  attr_accessor :proration_date
2006
-
2007
1697
  # For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.
2008
1698
  sig { returns(String) }
2009
1699
  attr_accessor :resume_at
2010
-
2011
1700
  # Date a subscription is intended to start (can be future or past).
2012
1701
  sig { returns(Integer) }
2013
1702
  attr_accessor :start_date
2014
-
2015
1703
  # If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.
2016
1704
  sig { returns(T.any(String, Integer)) }
2017
1705
  attr_accessor :trial_end
2018
-
2019
1706
  sig {
2020
1707
  params(billing_cycle_anchor: T.any(String, Integer), cancel_at: T.nilable(Integer), cancel_at_period_end: T::Boolean, cancel_now: T::Boolean, default_tax_rates: T.nilable(T::Array[String]), items: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Item], prebilling: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails::Prebilling, proration_behavior: String, proration_date: Integer, resume_at: String, start_date: Integer, trial_end: T.any(String, Integer)).void
2021
1708
  }
@@ -2039,7 +1726,6 @@ module Stripe
2039
1726
  # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
2040
1727
  sig { returns(Integer) }
2041
1728
  attr_accessor :usage_gte
2042
-
2043
1729
  sig { params(usage_gte: Integer).void }
2044
1730
  def initialize(usage_gte: nil); end
2045
1731
  end
@@ -2049,11 +1735,9 @@ module Stripe
2049
1735
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2050
1736
  sig { returns(String) }
2051
1737
  attr_accessor :interval
2052
-
2053
1738
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2054
1739
  sig { returns(Integer) }
2055
1740
  attr_accessor :interval_count
2056
-
2057
1741
  sig { params(interval: String, interval_count: Integer).void }
2058
1742
  def initialize(interval: nil, interval_count: nil); end
2059
1743
  end
@@ -2062,15 +1746,12 @@ module Stripe
2062
1746
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::Discount::DiscountEnd::Duration)
2063
1747
  }
2064
1748
  attr_accessor :duration
2065
-
2066
1749
  # A precise Unix timestamp for the discount to end. Must be in the future.
2067
1750
  sig { returns(Integer) }
2068
1751
  attr_accessor :timestamp
2069
-
2070
1752
  # The type of calculation made to determine when the discount ends.
2071
1753
  sig { returns(String) }
2072
1754
  attr_accessor :type
2073
-
2074
1755
  sig {
2075
1756
  params(duration: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
2076
1757
  }
@@ -2079,21 +1760,17 @@ module Stripe
2079
1760
  # ID of the coupon to create a new discount for.
2080
1761
  sig { returns(String) }
2081
1762
  attr_accessor :coupon
2082
-
2083
1763
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
2084
1764
  sig { returns(String) }
2085
1765
  attr_accessor :discount
2086
-
2087
1766
  # Details to determine how long the discount should be applied for.
2088
1767
  sig {
2089
1768
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::Discount::DiscountEnd)
2090
1769
  }
2091
1770
  attr_accessor :discount_end
2092
-
2093
1771
  # ID of the promotion code to create a new discount for.
2094
1772
  sig { returns(String) }
2095
1773
  attr_accessor :promotion_code
2096
-
2097
1774
  sig {
2098
1775
  params(coupon: String, discount: String, discount_end: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::Discount::DiscountEnd, promotion_code: String).void
2099
1776
  }
@@ -2104,40 +1781,32 @@ module Stripe
2104
1781
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
2105
1782
  sig { returns(String) }
2106
1783
  attr_accessor :interval
2107
-
2108
1784
  # 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).
2109
1785
  sig { returns(Integer) }
2110
1786
  attr_accessor :interval_count
2111
-
2112
1787
  sig { params(interval: String, interval_count: Integer).void }
2113
1788
  def initialize(interval: nil, interval_count: nil); end
2114
1789
  end
2115
1790
  # 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).
2116
1791
  sig { returns(String) }
2117
1792
  attr_accessor :currency
2118
-
2119
1793
  # The ID of the product that this price will belong to.
2120
1794
  sig { returns(String) }
2121
1795
  attr_accessor :product
2122
-
2123
1796
  # The recurring components of a price such as `interval` and `interval_count`.
2124
1797
  sig {
2125
1798
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::PriceData::Recurring)
2126
1799
  }
2127
1800
  attr_accessor :recurring
2128
-
2129
1801
  # 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.
2130
1802
  sig { returns(String) }
2131
1803
  attr_accessor :tax_behavior
2132
-
2133
1804
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
2134
1805
  sig { returns(Integer) }
2135
1806
  attr_accessor :unit_amount
2136
-
2137
1807
  # 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.
2138
1808
  sig { returns(String) }
2139
1809
  attr_accessor :unit_amount_decimal
2140
-
2141
1810
  sig {
2142
1811
  params(currency: String, product: String, recurring: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
2143
1812
  }
@@ -2155,51 +1824,40 @@ module Stripe
2155
1824
  returns(T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::BillingThresholds))
2156
1825
  }
2157
1826
  attr_accessor :billing_thresholds
2158
-
2159
1827
  # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
2160
1828
  sig { returns(T::Boolean) }
2161
1829
  attr_accessor :clear_usage
2162
-
2163
1830
  # A flag that, if set to `true`, will delete the specified item.
2164
1831
  sig { returns(T::Boolean) }
2165
1832
  attr_accessor :deleted
2166
-
2167
1833
  # The coupons to redeem into discounts for the subscription item.
2168
1834
  sig {
2169
1835
  returns(T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::Discount]))
2170
1836
  }
2171
1837
  attr_accessor :discounts
2172
-
2173
1838
  # Subscription item to update.
2174
1839
  sig { returns(String) }
2175
1840
  attr_accessor :id
2176
-
2177
1841
  # 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`.
2178
1842
  sig { returns(T.nilable(T::Hash[String, String])) }
2179
1843
  attr_accessor :metadata
2180
-
2181
1844
  # Plan ID for this item, as a string.
2182
1845
  sig { returns(String) }
2183
1846
  attr_accessor :plan
2184
-
2185
1847
  # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
2186
1848
  sig { returns(String) }
2187
1849
  attr_accessor :price
2188
-
2189
1850
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
2190
1851
  sig {
2191
1852
  returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::PriceData)
2192
1853
  }
2193
1854
  attr_accessor :price_data
2194
-
2195
1855
  # Quantity for this item.
2196
1856
  sig { returns(Integer) }
2197
1857
  attr_accessor :quantity
2198
-
2199
1858
  # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
2200
1859
  sig { returns(T.nilable(T::Array[String])) }
2201
1860
  attr_accessor :tax_rates
2202
-
2203
1861
  sig {
2204
1862
  params(billing_thresholds: T.nilable(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::BillingThresholds), clear_usage: T::Boolean, deleted: T::Boolean, discounts: T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::Discount]), id: String, metadata: T.nilable(T::Hash[String, String]), plan: String, price: String, price_data: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
2205
1863
  }
@@ -2221,136 +1879,104 @@ module Stripe
2221
1879
  # This is used to determine the number of billing cycles to prebill.
2222
1880
  sig { returns(Integer) }
2223
1881
  attr_accessor :iterations
2224
-
2225
1882
  sig { params(iterations: Integer).void }
2226
1883
  def initialize(iterations: nil); end
2227
1884
  end
2228
1885
  # Settings for automatic tax lookup for this invoice preview.
2229
1886
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::AutomaticTax) }
2230
1887
  attr_accessor :automatic_tax
2231
-
2232
1888
  # The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
2233
1889
  sig { returns(String) }
2234
1890
  attr_accessor :coupon
2235
-
2236
1891
  # The currency to preview this invoice in. Defaults to that of `customer` if not specified.
2237
1892
  sig { returns(String) }
2238
1893
  attr_accessor :currency
2239
-
2240
1894
  # The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
2241
1895
  sig { returns(String) }
2242
1896
  attr_accessor :customer
2243
-
2244
1897
  # Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
2245
1898
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails) }
2246
1899
  attr_accessor :customer_details
2247
-
2248
1900
  # The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
2249
1901
  sig {
2250
1902
  returns(T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::Discount]))
2251
1903
  }
2252
1904
  attr_accessor :discounts
2253
-
2254
1905
  # 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.
2255
1906
  sig { returns(String) }
2256
1907
  attr_accessor :ending_before
2257
-
2258
1908
  # Specifies which fields in the response should be expanded.
2259
1909
  sig { returns(T::Array[String]) }
2260
1910
  attr_accessor :expand
2261
-
2262
1911
  # List of invoice items to add or update in the upcoming invoice preview (up to 250).
2263
1912
  sig { returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem]) }
2264
1913
  attr_accessor :invoice_items
2265
-
2266
1914
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
2267
1915
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::Issuer) }
2268
1916
  attr_accessor :issuer
2269
-
2270
1917
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
2271
1918
  sig { returns(Integer) }
2272
1919
  attr_accessor :limit
2273
-
2274
1920
  # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
2275
1921
  sig { returns(T.nilable(String)) }
2276
1922
  attr_accessor :on_behalf_of
2277
-
2278
1923
  # Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
2279
1924
  sig { returns(String) }
2280
1925
  attr_accessor :preview_mode
2281
-
2282
1926
  # The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
2283
1927
  sig { returns(String) }
2284
1928
  attr_accessor :schedule
2285
-
2286
1929
  # The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
2287
1930
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails) }
2288
1931
  attr_accessor :schedule_details
2289
-
2290
1932
  # 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.
2291
1933
  sig { returns(String) }
2292
1934
  attr_accessor :starting_after
2293
-
2294
1935
  # The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
2295
1936
  sig { returns(String) }
2296
1937
  attr_accessor :subscription
2297
-
2298
1938
  # For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.
2299
1939
  sig { returns(T.any(String, Integer)) }
2300
1940
  attr_accessor :subscription_billing_cycle_anchor
2301
-
2302
1941
  # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.
2303
1942
  sig { returns(T.nilable(Integer)) }
2304
1943
  attr_accessor :subscription_cancel_at
2305
-
2306
1944
  # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.
2307
1945
  sig { returns(T::Boolean) }
2308
1946
  attr_accessor :subscription_cancel_at_period_end
2309
-
2310
1947
  # This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.
2311
1948
  sig { returns(T::Boolean) }
2312
1949
  attr_accessor :subscription_cancel_now
2313
-
2314
1950
  # If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.
2315
1951
  sig { returns(T.nilable(T::Array[String])) }
2316
1952
  attr_accessor :subscription_default_tax_rates
2317
-
2318
1953
  # The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.
2319
1954
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails) }
2320
1955
  attr_accessor :subscription_details
2321
-
2322
1956
  # A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.
2323
1957
  sig { returns(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem]) }
2324
1958
  attr_accessor :subscription_items
2325
-
2326
1959
  # The pre-billing to apply to the subscription as a preview. This field has been deprecated and will be removed in a future API version. Use `subscription_details.prebilling` instead.
2327
1960
  sig { returns(::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionPrebilling) }
2328
1961
  attr_accessor :subscription_prebilling
2329
-
2330
1962
  # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.
2331
1963
  sig { returns(String) }
2332
1964
  attr_accessor :subscription_proration_behavior
2333
-
2334
1965
  # If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.
2335
1966
  sig { returns(Integer) }
2336
1967
  attr_accessor :subscription_proration_date
2337
-
2338
1968
  # For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.
2339
1969
  sig { returns(String) }
2340
1970
  attr_accessor :subscription_resume_at
2341
-
2342
1971
  # Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.
2343
1972
  sig { returns(Integer) }
2344
1973
  attr_accessor :subscription_start_date
2345
-
2346
1974
  # If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.
2347
1975
  sig { returns(T.any(String, Integer)) }
2348
1976
  attr_accessor :subscription_trial_end
2349
-
2350
1977
  # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
2351
1978
  sig { returns(T::Boolean) }
2352
1979
  attr_accessor :subscription_trial_from_plan
2353
-
2354
1980
  sig {
2355
1981
  params(automatic_tax: ::Stripe::InvoiceUpcomingLinesService::ListParams::AutomaticTax, coupon: String, currency: String, customer: String, customer_details: ::Stripe::InvoiceUpcomingLinesService::ListParams::CustomerDetails, discounts: T.nilable(T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::Discount]), ending_before: String, expand: T::Array[String], invoice_items: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::InvoiceItem], issuer: ::Stripe::InvoiceUpcomingLinesService::ListParams::Issuer, limit: Integer, on_behalf_of: T.nilable(String), preview_mode: String, schedule: String, schedule_details: ::Stripe::InvoiceUpcomingLinesService::ListParams::ScheduleDetails, starting_after: String, subscription: String, subscription_billing_cycle_anchor: T.any(String, Integer), subscription_cancel_at: T.nilable(Integer), subscription_cancel_at_period_end: T::Boolean, subscription_cancel_now: T::Boolean, subscription_default_tax_rates: T.nilable(T::Array[String]), subscription_details: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionDetails, subscription_items: T::Array[::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionItem], subscription_prebilling: ::Stripe::InvoiceUpcomingLinesService::ListParams::SubscriptionPrebilling, subscription_proration_behavior: String, subscription_proration_date: Integer, subscription_resume_at: String, subscription_start_date: Integer, subscription_trial_end: T.any(String, Integer), subscription_trial_from_plan: T::Boolean).void
2356
1982
  }