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
@@ -13,35 +13,27 @@ module Stripe
13
13
  # The ID of the customer whose quotes will be retrieved.
14
14
  sig { returns(String) }
15
15
  attr_accessor :customer
16
-
17
16
  # 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.
18
17
  sig { returns(String) }
19
18
  attr_accessor :ending_before
20
-
21
19
  # Specifies which fields in the response should be expanded.
22
20
  sig { returns(T::Array[String]) }
23
21
  attr_accessor :expand
24
-
25
22
  # The subscription which the quote updates.
26
23
  sig { returns(String) }
27
24
  attr_accessor :from_subscription
28
-
29
25
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
30
26
  sig { returns(Integer) }
31
27
  attr_accessor :limit
32
-
33
28
  # 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.
34
29
  sig { returns(String) }
35
30
  attr_accessor :starting_after
36
-
37
31
  # The status of the quote.
38
32
  sig { returns(String) }
39
33
  attr_accessor :status
40
-
41
34
  # Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.
42
35
  sig { returns(String) }
43
36
  attr_accessor :test_clock
44
-
45
37
  sig {
46
38
  params(customer: String, ending_before: String, expand: T::Array[String], from_subscription: String, limit: Integer, starting_after: String, status: String, test_clock: String).void
47
39
  }
@@ -62,22 +54,18 @@ module Stripe
62
54
  # The connected account being referenced when `type` is `account`.
63
55
  sig { returns(String) }
64
56
  attr_accessor :account
65
-
66
57
  # Type of the account referenced in the request.
67
58
  sig { returns(String) }
68
59
  attr_accessor :type
69
-
70
60
  sig { params(account: String, type: String).void }
71
61
  def initialize(account: nil, type: nil); end
72
62
  end
73
63
  # Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
74
64
  sig { returns(T::Boolean) }
75
65
  attr_accessor :enabled
76
-
77
66
  # 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.
78
67
  sig { returns(::Stripe::QuoteService::CreateParams::AutomaticTax::Liability) }
79
68
  attr_accessor :liability
80
-
81
69
  sig {
82
70
  params(enabled: T::Boolean, liability: ::Stripe::QuoteService::CreateParams::AutomaticTax::Liability).void
83
71
  }
@@ -89,26 +77,21 @@ module Stripe
89
77
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
90
78
  sig { returns(String) }
91
79
  attr_accessor :interval
92
-
93
80
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
94
81
  sig { returns(Integer) }
95
82
  attr_accessor :interval_count
96
-
97
83
  sig { params(interval: String, interval_count: Integer).void }
98
84
  def initialize(interval: nil, interval_count: nil); end
99
85
  end
100
86
  # Time span for the redeemed discount.
101
87
  sig { returns(::Stripe::QuoteService::CreateParams::Discount::DiscountEnd::Duration) }
102
88
  attr_accessor :duration
103
-
104
89
  # A precise Unix timestamp for the discount to end. Must be in the future.
105
90
  sig { returns(Integer) }
106
91
  attr_accessor :timestamp
107
-
108
92
  # The type of calculation made to determine when the discount ends.
109
93
  sig { returns(String) }
110
94
  attr_accessor :type
111
-
112
95
  sig {
113
96
  params(duration: ::Stripe::QuoteService::CreateParams::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
114
97
  }
@@ -117,19 +100,15 @@ module Stripe
117
100
  # ID of the coupon to create a new discount for.
118
101
  sig { returns(String) }
119
102
  attr_accessor :coupon
120
-
121
103
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
122
104
  sig { returns(String) }
123
105
  attr_accessor :discount
124
-
125
106
  # Details to determine how long the discount should be applied for.
126
107
  sig { returns(::Stripe::QuoteService::CreateParams::Discount::DiscountEnd) }
127
108
  attr_accessor :discount_end
128
-
129
109
  # ID of the promotion code to create a new discount for.
130
110
  sig { returns(String) }
131
111
  attr_accessor :promotion_code
132
-
133
112
  sig {
134
113
  params(coupon: String, discount: String, discount_end: ::Stripe::QuoteService::CreateParams::Discount::DiscountEnd, promotion_code: String).void
135
114
  }
@@ -139,11 +118,9 @@ module Stripe
139
118
  # Whether this quote is a revision of the previous quote.
140
119
  sig { returns(T::Boolean) }
141
120
  attr_accessor :is_revision
142
-
143
121
  # The `id` of the quote that will be cloned.
144
122
  sig { returns(String) }
145
123
  attr_accessor :quote
146
-
147
124
  sig { params(is_revision: T::Boolean, quote: String).void }
148
125
  def initialize(is_revision: nil, quote: nil); end
149
126
  end
@@ -152,22 +129,18 @@ module Stripe
152
129
  # The connected account being referenced when `type` is `account`.
153
130
  sig { returns(String) }
154
131
  attr_accessor :account
155
-
156
132
  # Type of the account referenced in the request.
157
133
  sig { returns(String) }
158
134
  attr_accessor :type
159
-
160
135
  sig { params(account: String, type: String).void }
161
136
  def initialize(account: nil, type: nil); end
162
137
  end
163
138
  # Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
164
139
  sig { returns(Integer) }
165
140
  attr_accessor :days_until_due
166
-
167
141
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
168
142
  sig { returns(::Stripe::QuoteService::CreateParams::InvoiceSettings::Issuer) }
169
143
  attr_accessor :issuer
170
-
171
144
  sig {
172
145
  params(days_until_due: Integer, issuer: ::Stripe::QuoteService::CreateParams::InvoiceSettings::Issuer).void
173
146
  }
@@ -180,32 +153,26 @@ module Stripe
180
153
  # The type of calculation made to determine when the discount ends.
181
154
  sig { returns(String) }
182
155
  attr_accessor :type
183
-
184
156
  sig { params(type: String).void }
185
157
  def initialize(type: nil); end
186
158
  end
187
159
  # The coupon code to redeem.
188
160
  sig { returns(String) }
189
161
  attr_accessor :coupon
190
-
191
162
  # An ID of an existing discount for a coupon that was already redeemed.
192
163
  sig { returns(String) }
193
164
  attr_accessor :discount
194
-
195
165
  # Details to determine how long the discount should be applied for.
196
166
  sig {
197
167
  returns(::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount::DiscountEnd)
198
168
  }
199
169
  attr_accessor :discount_end
200
-
201
170
  # 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.
202
171
  sig { returns(Integer) }
203
172
  attr_accessor :index
204
-
205
173
  # The promotion code to redeem.
206
174
  sig { returns(String) }
207
175
  attr_accessor :promotion_code
208
-
209
176
  sig {
210
177
  params(coupon: String, discount: String, discount_end: ::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount::DiscountEnd, index: Integer, promotion_code: String).void
211
178
  }
@@ -224,11 +191,9 @@ module Stripe
224
191
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
225
192
  sig { returns(String) }
226
193
  attr_accessor :interval
227
-
228
194
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
229
195
  sig { returns(Integer) }
230
196
  attr_accessor :interval_count
231
-
232
197
  sig { params(interval: String, interval_count: Integer).void }
233
198
  def initialize(interval: nil, interval_count: nil); end
234
199
  end
@@ -237,15 +202,12 @@ module Stripe
237
202
  returns(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration)
238
203
  }
239
204
  attr_accessor :duration
240
-
241
205
  # A precise Unix timestamp for the discount to end. Must be in the future.
242
206
  sig { returns(Integer) }
243
207
  attr_accessor :timestamp
244
-
245
208
  # The type of calculation made to determine when the discount ends.
246
209
  sig { returns(String) }
247
210
  attr_accessor :type
248
-
249
211
  sig {
250
212
  params(duration: ::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
251
213
  }
@@ -254,21 +216,17 @@ module Stripe
254
216
  # ID of the coupon to create a new discount for.
255
217
  sig { returns(String) }
256
218
  attr_accessor :coupon
257
-
258
219
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
259
220
  sig { returns(String) }
260
221
  attr_accessor :discount
261
-
262
222
  # Details to determine how long the discount should be applied for.
263
223
  sig {
264
224
  returns(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd)
265
225
  }
266
226
  attr_accessor :discount_end
267
-
268
227
  # ID of the promotion code to create a new discount for.
269
228
  sig { returns(String) }
270
229
  attr_accessor :promotion_code
271
-
272
230
  sig {
273
231
  params(coupon: String, discount: String, discount_end: ::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount::DiscountEnd, promotion_code: String).void
274
232
  }
@@ -283,11 +241,9 @@ module Stripe
283
241
  # 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.
284
242
  sig { returns(T::Array[String]) }
285
243
  attr_accessor :converts_to
286
-
287
244
  # Determines the type of trial for this item.
288
245
  sig { returns(String) }
289
246
  attr_accessor :type
290
-
291
247
  sig { params(converts_to: T::Array[String], type: String).void }
292
248
  def initialize(converts_to: nil, type: nil); end
293
249
  end
@@ -296,27 +252,21 @@ module Stripe
296
252
  returns(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount])
297
253
  }
298
254
  attr_accessor :discounts
299
-
300
255
  # 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`.
301
256
  sig { returns(T::Hash[String, String]) }
302
257
  attr_accessor :metadata
303
-
304
258
  # The ID of the price object.
305
259
  sig { returns(String) }
306
260
  attr_accessor :price
307
-
308
261
  # Quantity for this item.
309
262
  sig { returns(Integer) }
310
263
  attr_accessor :quantity
311
-
312
264
  # 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`.
313
265
  sig { returns(T::Array[String]) }
314
266
  attr_accessor :tax_rates
315
-
316
267
  # Options that configure the trial on the subscription item.
317
268
  sig { returns(::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Trial) }
318
269
  attr_accessor :trial
319
-
320
270
  sig {
321
271
  params(discounts: T::Array[::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Discount], metadata: T::Hash[String, String], price: String, quantity: Integer, tax_rates: T::Array[String], trial: ::Stripe::QuoteService::CreateParams::Line::Action::AddItem::Trial).void
322
272
  }
@@ -333,15 +283,12 @@ module Stripe
333
283
  # The coupon code to remove from the `discounts` array.
334
284
  sig { returns(String) }
335
285
  attr_accessor :coupon
336
-
337
286
  # The ID of a discount to remove from the `discounts` array.
338
287
  sig { returns(String) }
339
288
  attr_accessor :discount
340
-
341
289
  # The ID of a promotion code to remove from the `discounts` array.
342
290
  sig { returns(String) }
343
291
  attr_accessor :promotion_code
344
-
345
292
  sig { params(coupon: String, discount: String, promotion_code: String).void }
346
293
  def initialize(coupon: nil, discount: nil, promotion_code: nil); end
347
294
  end
@@ -349,7 +296,6 @@ module Stripe
349
296
  # ID of a price to remove.
350
297
  sig { returns(String) }
351
298
  attr_accessor :price
352
-
353
299
  sig { params(price: String).void }
354
300
  def initialize(price: nil); end
355
301
  end
@@ -357,15 +303,12 @@ module Stripe
357
303
  # The coupon code to replace the `discounts` array with.
358
304
  sig { returns(String) }
359
305
  attr_accessor :coupon
360
-
361
306
  # An ID of an existing discount to replace the `discounts` array with.
362
307
  sig { returns(String) }
363
308
  attr_accessor :discount
364
-
365
309
  # An ID of an existing promotion code to replace the `discounts` array with.
366
310
  sig { returns(String) }
367
311
  attr_accessor :promotion_code
368
-
369
312
  sig { params(coupon: String, discount: String, promotion_code: String).void }
370
313
  def initialize(coupon: nil, discount: nil, promotion_code: nil); end
371
314
  end
@@ -376,11 +319,9 @@ module Stripe
376
319
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
377
320
  sig { returns(String) }
378
321
  attr_accessor :interval
379
-
380
322
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
381
323
  sig { returns(Integer) }
382
324
  attr_accessor :interval_count
383
-
384
325
  sig { params(interval: String, interval_count: Integer).void }
385
326
  def initialize(interval: nil, interval_count: nil); end
386
327
  end
@@ -389,15 +330,12 @@ module Stripe
389
330
  returns(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration)
390
331
  }
391
332
  attr_accessor :duration
392
-
393
333
  # A precise Unix timestamp for the discount to end. Must be in the future.
394
334
  sig { returns(Integer) }
395
335
  attr_accessor :timestamp
396
-
397
336
  # The type of calculation made to determine when the discount ends.
398
337
  sig { returns(String) }
399
338
  attr_accessor :type
400
-
401
339
  sig {
402
340
  params(duration: ::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
403
341
  }
@@ -406,21 +344,17 @@ module Stripe
406
344
  # ID of the coupon to create a new discount for.
407
345
  sig { returns(String) }
408
346
  attr_accessor :coupon
409
-
410
347
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
411
348
  sig { returns(String) }
412
349
  attr_accessor :discount
413
-
414
350
  # Details to determine how long the discount should be applied for.
415
351
  sig {
416
352
  returns(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd)
417
353
  }
418
354
  attr_accessor :discount_end
419
-
420
355
  # ID of the promotion code to create a new discount for.
421
356
  sig { returns(String) }
422
357
  attr_accessor :promotion_code
423
-
424
358
  sig {
425
359
  params(coupon: String, discount: String, discount_end: ::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount::DiscountEnd, promotion_code: String).void
426
360
  }
@@ -435,11 +369,9 @@ module Stripe
435
369
  # 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.
436
370
  sig { returns(T::Array[String]) }
437
371
  attr_accessor :converts_to
438
-
439
372
  # Determines the type of trial for this item.
440
373
  sig { returns(String) }
441
374
  attr_accessor :type
442
-
443
375
  sig { params(converts_to: T::Array[String], type: String).void }
444
376
  def initialize(converts_to: nil, type: nil); end
445
377
  end
@@ -448,27 +380,21 @@ module Stripe
448
380
  returns(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount])
449
381
  }
450
382
  attr_accessor :discounts
451
-
452
383
  # 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`.
453
384
  sig { returns(T::Hash[String, String]) }
454
385
  attr_accessor :metadata
455
-
456
386
  # The ID of the price object.
457
387
  sig { returns(String) }
458
388
  attr_accessor :price
459
-
460
389
  # 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`.
461
390
  sig { returns(Integer) }
462
391
  attr_accessor :quantity
463
-
464
392
  # 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`.
465
393
  sig { returns(T::Array[String]) }
466
394
  attr_accessor :tax_rates
467
-
468
395
  # 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`.
469
396
  sig { returns(::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Trial) }
470
397
  attr_accessor :trial
471
-
472
398
  sig {
473
399
  params(discounts: T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Discount], metadata: T::Hash[String, String], price: String, quantity: Integer, tax_rates: T::Array[String], trial: ::Stripe::QuoteService::CreateParams::Line::Action::SetItem::Trial).void
474
400
  }
@@ -484,43 +410,33 @@ module Stripe
484
410
  # Details for the `add_discount` type.
485
411
  sig { returns(::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount) }
486
412
  attr_accessor :add_discount
487
-
488
413
  # Details for the `add_item` type.
489
414
  sig { returns(::Stripe::QuoteService::CreateParams::Line::Action::AddItem) }
490
415
  attr_accessor :add_item
491
-
492
416
  # Details for the `add_metadata` type: specify a hash of key-value pairs.
493
417
  sig { returns(T::Hash[String, String]) }
494
418
  attr_accessor :add_metadata
495
-
496
419
  # Details for the `remove_discount` type.
497
420
  sig { returns(::Stripe::QuoteService::CreateParams::Line::Action::RemoveDiscount) }
498
421
  attr_accessor :remove_discount
499
-
500
422
  # Details for the `remove_item` type.
501
423
  sig { returns(::Stripe::QuoteService::CreateParams::Line::Action::RemoveItem) }
502
424
  attr_accessor :remove_item
503
-
504
425
  # Details for the `remove_metadata` type: specify an array of metadata keys.
505
426
  sig { returns(T::Array[String]) }
506
427
  attr_accessor :remove_metadata
507
-
508
428
  # Details for the `set_discounts` type.
509
429
  sig { returns(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetDiscount]) }
510
430
  attr_accessor :set_discounts
511
-
512
431
  # Details for the `set_items` type.
513
432
  sig { returns(T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem]) }
514
433
  attr_accessor :set_items
515
-
516
434
  # Details for the `set_metadata` type: specify an array of key-value pairs.
517
435
  sig { returns(T.nilable(T::Hash[String, String])) }
518
436
  attr_accessor :set_metadata
519
-
520
437
  # The type of action the quote line performs.
521
438
  sig { returns(String) }
522
439
  attr_accessor :type
523
-
524
440
  sig {
525
441
  params(add_discount: ::Stripe::QuoteService::CreateParams::Line::Action::AddDiscount, add_item: ::Stripe::QuoteService::CreateParams::Line::Action::AddItem, add_metadata: T::Hash[String, String], remove_discount: ::Stripe::QuoteService::CreateParams::Line::Action::RemoveDiscount, remove_item: ::Stripe::QuoteService::CreateParams::Line::Action::RemoveItem, remove_metadata: T::Array[String], set_discounts: T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetDiscount], set_items: T::Array[::Stripe::QuoteService::CreateParams::Line::Action::SetItem], set_metadata: T.nilable(T::Hash[String, String]), type: String).void
526
442
  }
@@ -541,15 +457,12 @@ module Stripe
541
457
  # A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
542
458
  sig { returns(String) }
543
459
  attr_accessor :new_reference
544
-
545
460
  # The ID of the schedule the line applies to.
546
461
  sig { returns(String) }
547
462
  attr_accessor :subscription_schedule
548
-
549
463
  # Describes whether the quote line is affecting a new schedule or an existing schedule.
550
464
  sig { returns(String) }
551
465
  attr_accessor :type
552
-
553
466
  sig { params(new_reference: String, subscription_schedule: String, type: String).void }
554
467
  def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
555
468
  end
@@ -557,15 +470,12 @@ module Stripe
557
470
  # Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
558
471
  sig { returns(String) }
559
472
  attr_accessor :cancel_at
560
-
561
473
  # If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
562
474
  sig { returns(T::Boolean) }
563
475
  attr_accessor :invoice_now
564
-
565
476
  # If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
566
477
  sig { returns(T::Boolean) }
567
478
  attr_accessor :prorate
568
-
569
479
  sig { params(cancel_at: String, invoice_now: T::Boolean, prorate: T::Boolean).void }
570
480
  def initialize(cancel_at: nil, invoice_now: nil, prorate: nil); end
571
481
  end
@@ -574,7 +484,6 @@ module Stripe
574
484
  # The ID of a specific discount.
575
485
  sig { returns(String) }
576
486
  attr_accessor :discount
577
-
578
487
  sig { params(discount: String).void }
579
488
  def initialize(discount: nil); end
580
489
  end
@@ -582,30 +491,24 @@ module Stripe
582
491
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
583
492
  sig { returns(String) }
584
493
  attr_accessor :interval
585
-
586
494
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
587
495
  sig { returns(Integer) }
588
496
  attr_accessor :interval_count
589
-
590
497
  sig { params(interval: String, interval_count: Integer).void }
591
498
  def initialize(interval: nil, interval_count: nil); end
592
499
  end
593
500
  # Use the `end` time of a given discount.
594
501
  sig { returns(::Stripe::QuoteService::CreateParams::Line::EndsAt::DiscountEnd) }
595
502
  attr_accessor :discount_end
596
-
597
503
  # Time span for the quote line starting from the `starts_at` date.
598
504
  sig { returns(::Stripe::QuoteService::CreateParams::Line::EndsAt::Duration) }
599
505
  attr_accessor :duration
600
-
601
506
  # A precise Unix timestamp.
602
507
  sig { returns(Integer) }
603
508
  attr_accessor :timestamp
604
-
605
509
  # Select a way to pass in `ends_at`.
606
510
  sig { returns(String) }
607
511
  attr_accessor :type
608
-
609
512
  sig {
610
513
  params(discount_end: ::Stripe::QuoteService::CreateParams::Line::EndsAt::DiscountEnd, duration: ::Stripe::QuoteService::CreateParams::Line::EndsAt::Duration, timestamp: Integer, type: String).void
611
514
  }
@@ -616,18 +519,15 @@ module Stripe
616
519
  # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
617
520
  sig { returns(String) }
618
521
  attr_accessor :behavior
619
-
620
522
  sig { params(behavior: String).void }
621
523
  def initialize(behavior: nil); end
622
524
  end
623
525
  # Details of the pause_collection behavior to apply to the amendment.
624
526
  sig { returns(::Stripe::QuoteService::CreateParams::Line::SetPauseCollection::Set) }
625
527
  attr_accessor :set
626
-
627
528
  # Determines the type of the pause_collection amendment.
628
529
  sig { returns(String) }
629
530
  attr_accessor :type
630
-
631
531
  sig {
632
532
  params(set: ::Stripe::QuoteService::CreateParams::Line::SetPauseCollection::Set, type: String).void
633
533
  }
@@ -638,7 +538,6 @@ module Stripe
638
538
  # The ID of a specific discount.
639
539
  sig { returns(String) }
640
540
  attr_accessor :discount
641
-
642
541
  sig { params(discount: String).void }
643
542
  def initialize(discount: nil); end
644
543
  end
@@ -646,26 +545,21 @@ module Stripe
646
545
  # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
647
546
  sig { returns(Integer) }
648
547
  attr_accessor :index
649
-
650
548
  sig { params(index: Integer).void }
651
549
  def initialize(index: nil); end
652
550
  end
653
551
  # Use the `end` time of a given discount.
654
552
  sig { returns(::Stripe::QuoteService::CreateParams::Line::StartsAt::DiscountEnd) }
655
553
  attr_accessor :discount_end
656
-
657
554
  # The timestamp the given line ends at.
658
555
  sig { returns(::Stripe::QuoteService::CreateParams::Line::StartsAt::LineEndsAt) }
659
556
  attr_accessor :line_ends_at
660
-
661
557
  # A precise Unix timestamp.
662
558
  sig { returns(Integer) }
663
559
  attr_accessor :timestamp
664
-
665
560
  # Select a way to pass in `starts_at`.
666
561
  sig { returns(String) }
667
562
  attr_accessor :type
668
-
669
563
  sig {
670
564
  params(discount_end: ::Stripe::QuoteService::CreateParams::Line::StartsAt::DiscountEnd, line_ends_at: ::Stripe::QuoteService::CreateParams::Line::StartsAt::LineEndsAt, timestamp: Integer, type: String).void
671
565
  }
@@ -676,14 +570,12 @@ module Stripe
676
570
  # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
677
571
  sig { returns(String) }
678
572
  attr_accessor :prorate_up_front
679
-
680
573
  sig { params(prorate_up_front: String).void }
681
574
  def initialize(prorate_up_front: nil); end
682
575
  end
683
576
  # Defines how the subscription should behave when a trial ends.
684
577
  sig { returns(::Stripe::QuoteService::CreateParams::Line::TrialSettings::EndBehavior) }
685
578
  attr_accessor :end_behavior
686
-
687
579
  sig {
688
580
  params(end_behavior: ::Stripe::QuoteService::CreateParams::Line::TrialSettings::EndBehavior).void
689
581
  }
@@ -692,43 +584,33 @@ module Stripe
692
584
  # An array of operations the quote line performs.
693
585
  sig { returns(T::Array[::Stripe::QuoteService::CreateParams::Line::Action]) }
694
586
  attr_accessor :actions
695
-
696
587
  # Details to identify the subscription schedule the quote line applies to.
697
588
  sig { returns(::Stripe::QuoteService::CreateParams::Line::AppliesTo) }
698
589
  attr_accessor :applies_to
699
-
700
590
  # For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
701
591
  sig { returns(String) }
702
592
  attr_accessor :billing_cycle_anchor
703
-
704
593
  # A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
705
594
  sig { returns(::Stripe::QuoteService::CreateParams::Line::CancelSubscriptionSchedule) }
706
595
  attr_accessor :cancel_subscription_schedule
707
-
708
596
  # Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
709
597
  sig { returns(::Stripe::QuoteService::CreateParams::Line::EndsAt) }
710
598
  attr_accessor :ends_at
711
-
712
599
  # Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
713
600
  sig { returns(String) }
714
601
  attr_accessor :proration_behavior
715
-
716
602
  # Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
717
603
  sig { returns(::Stripe::QuoteService::CreateParams::Line::SetPauseCollection) }
718
604
  attr_accessor :set_pause_collection
719
-
720
605
  # Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
721
606
  sig { returns(String) }
722
607
  attr_accessor :set_schedule_end
723
-
724
608
  # Details to identify the earliest timestamp where the proposed change should take effect.
725
609
  sig { returns(::Stripe::QuoteService::CreateParams::Line::StartsAt) }
726
610
  attr_accessor :starts_at
727
-
728
611
  # Settings related to subscription trials.
729
612
  sig { returns(::Stripe::QuoteService::CreateParams::Line::TrialSettings) }
730
613
  attr_accessor :trial_settings
731
-
732
614
  sig {
733
615
  params(actions: T::Array[::Stripe::QuoteService::CreateParams::Line::Action], applies_to: ::Stripe::QuoteService::CreateParams::Line::AppliesTo, billing_cycle_anchor: String, cancel_subscription_schedule: ::Stripe::QuoteService::CreateParams::Line::CancelSubscriptionSchedule, ends_at: ::Stripe::QuoteService::CreateParams::Line::EndsAt, proration_behavior: String, set_pause_collection: ::Stripe::QuoteService::CreateParams::Line::SetPauseCollection, set_schedule_end: String, starts_at: ::Stripe::QuoteService::CreateParams::Line::StartsAt, trial_settings: ::Stripe::QuoteService::CreateParams::Line::TrialSettings).void
734
616
  }
@@ -752,11 +634,9 @@ module Stripe
752
634
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
753
635
  sig { returns(String) }
754
636
  attr_accessor :interval
755
-
756
637
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
757
638
  sig { returns(Integer) }
758
639
  attr_accessor :interval_count
759
-
760
640
  sig { params(interval: String, interval_count: Integer).void }
761
641
  def initialize(interval: nil, interval_count: nil); end
762
642
  end
@@ -765,15 +645,12 @@ module Stripe
765
645
  returns(::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd::Duration)
766
646
  }
767
647
  attr_accessor :duration
768
-
769
648
  # A precise Unix timestamp for the discount to end. Must be in the future.
770
649
  sig { returns(Integer) }
771
650
  attr_accessor :timestamp
772
-
773
651
  # The type of calculation made to determine when the discount ends.
774
652
  sig { returns(String) }
775
653
  attr_accessor :type
776
-
777
654
  sig {
778
655
  params(duration: ::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
779
656
  }
@@ -782,19 +659,15 @@ module Stripe
782
659
  # ID of the coupon to create a new discount for.
783
660
  sig { returns(String) }
784
661
  attr_accessor :coupon
785
-
786
662
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
787
663
  sig { returns(String) }
788
664
  attr_accessor :discount
789
-
790
665
  # Details to determine how long the discount should be applied for.
791
666
  sig { returns(::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd) }
792
667
  attr_accessor :discount_end
793
-
794
668
  # ID of the promotion code to create a new discount for.
795
669
  sig { returns(String) }
796
670
  attr_accessor :promotion_code
797
-
798
671
  sig {
799
672
  params(coupon: String, discount: String, discount_end: ::Stripe::QuoteService::CreateParams::LineItem::Discount::DiscountEnd, promotion_code: String).void
800
673
  }
@@ -805,38 +678,30 @@ module Stripe
805
678
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
806
679
  sig { returns(String) }
807
680
  attr_accessor :interval
808
-
809
681
  # 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).
810
682
  sig { returns(Integer) }
811
683
  attr_accessor :interval_count
812
-
813
684
  sig { params(interval: String, interval_count: Integer).void }
814
685
  def initialize(interval: nil, interval_count: nil); end
815
686
  end
816
687
  # 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).
817
688
  sig { returns(String) }
818
689
  attr_accessor :currency
819
-
820
690
  # The ID of the product that this price will belong to.
821
691
  sig { returns(String) }
822
692
  attr_accessor :product
823
-
824
693
  # The recurring components of a price such as `interval` and `interval_count`.
825
694
  sig { returns(::Stripe::QuoteService::CreateParams::LineItem::PriceData::Recurring) }
826
695
  attr_accessor :recurring
827
-
828
696
  # 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.
829
697
  sig { returns(String) }
830
698
  attr_accessor :tax_behavior
831
-
832
699
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
833
700
  sig { returns(Integer) }
834
701
  attr_accessor :unit_amount
835
-
836
702
  # 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.
837
703
  sig { returns(String) }
838
704
  attr_accessor :unit_amount_decimal
839
-
840
705
  sig {
841
706
  params(currency: String, product: String, recurring: ::Stripe::QuoteService::CreateParams::LineItem::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
842
707
  }
@@ -854,23 +719,18 @@ module Stripe
854
719
  returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::LineItem::Discount]))
855
720
  }
856
721
  attr_accessor :discounts
857
-
858
722
  # The ID of the price object. One of `price` or `price_data` is required.
859
723
  sig { returns(String) }
860
724
  attr_accessor :price
861
-
862
725
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
863
726
  sig { returns(::Stripe::QuoteService::CreateParams::LineItem::PriceData) }
864
727
  attr_accessor :price_data
865
-
866
728
  # The quantity of the line item.
867
729
  sig { returns(Integer) }
868
730
  attr_accessor :quantity
869
-
870
731
  # The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
871
732
  sig { returns(T.nilable(T::Array[String])) }
872
733
  attr_accessor :tax_rates
873
-
874
734
  sig {
875
735
  params(discounts: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::LineItem::Discount]), price: String, price_data: ::Stripe::QuoteService::CreateParams::LineItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
876
736
  }
@@ -889,11 +749,9 @@ module Stripe
889
749
  # The ID of a quote line.
890
750
  sig { returns(String) }
891
751
  attr_accessor :id
892
-
893
752
  # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
894
753
  sig { returns(Integer) }
895
754
  attr_accessor :index
896
-
897
755
  sig { params(id: String, index: Integer).void }
898
756
  def initialize(id: nil, index: nil); end
899
757
  end
@@ -902,15 +760,12 @@ module Stripe
902
760
  returns(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt)
903
761
  }
904
762
  attr_accessor :line_starts_at
905
-
906
763
  # A precise Unix timestamp.
907
764
  sig { returns(Integer) }
908
765
  attr_accessor :timestamp
909
-
910
766
  # The type of method to specify the `bill_from` time.
911
767
  sig { returns(String) }
912
768
  attr_accessor :type
913
-
914
769
  sig {
915
770
  params(line_starts_at: ::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt, timestamp: Integer, type: String).void
916
771
  }
@@ -921,11 +776,9 @@ module Stripe
921
776
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
922
777
  sig { returns(String) }
923
778
  attr_accessor :interval
924
-
925
779
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
926
780
  sig { returns(Integer) }
927
781
  attr_accessor :interval_count
928
-
929
782
  sig { params(interval: String, interval_count: Integer).void }
930
783
  def initialize(interval: nil, interval_count: nil); end
931
784
  end
@@ -933,11 +786,9 @@ module Stripe
933
786
  # The ID of a quote line.
934
787
  sig { returns(String) }
935
788
  attr_accessor :id
936
-
937
789
  # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
938
790
  sig { returns(Integer) }
939
791
  attr_accessor :index
940
-
941
792
  sig { params(id: String, index: Integer).void }
942
793
  def initialize(id: nil, index: nil); end
943
794
  end
@@ -946,21 +797,17 @@ module Stripe
946
797
  returns(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration)
947
798
  }
948
799
  attr_accessor :duration
949
-
950
800
  # Details of a Quote line item from which to bill until.
951
801
  sig {
952
802
  returns(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt)
953
803
  }
954
804
  attr_accessor :line_ends_at
955
-
956
805
  # A precise Unix timestamp.
957
806
  sig { returns(Integer) }
958
807
  attr_accessor :timestamp
959
-
960
808
  # The type of method to specify the `bill_until` time.
961
809
  sig { returns(String) }
962
810
  attr_accessor :type
963
-
964
811
  sig {
965
812
  params(duration: ::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration, line_ends_at: ::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt, timestamp: Integer, type: String).void
966
813
  }
@@ -971,13 +818,11 @@ module Stripe
971
818
  returns(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom)
972
819
  }
973
820
  attr_accessor :bill_from
974
-
975
821
  # The end of the period to bill until when the Quote is accepted.
976
822
  sig {
977
823
  returns(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil)
978
824
  }
979
825
  attr_accessor :bill_until
980
-
981
826
  sig {
982
827
  params(bill_from: ::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillFrom, bill_until: ::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance::BillUntil).void
983
828
  }
@@ -987,48 +832,38 @@ module Stripe
987
832
  # This is used to determine the number of billing cycles to prebill.
988
833
  sig { returns(Integer) }
989
834
  attr_accessor :iterations
990
-
991
835
  sig { params(iterations: Integer).void }
992
836
  def initialize(iterations: nil); end
993
837
  end
994
838
  # Describes the period to bill for upon accepting the quote.
995
839
  sig { returns(::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance) }
996
840
  attr_accessor :bill_on_acceptance
997
-
998
841
  # 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.
999
842
  sig { returns(String) }
1000
843
  attr_accessor :billing_behavior
1001
-
1002
844
  # When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
1003
845
  sig { returns(T.nilable(String)) }
1004
846
  attr_accessor :billing_cycle_anchor
1005
-
1006
847
  # The subscription's 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.
1007
848
  sig { returns(String) }
1008
849
  attr_accessor :description
1009
-
1010
850
  # When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
1011
851
  sig { returns(T.nilable(T.any(String, Integer))) }
1012
852
  attr_accessor :effective_date
1013
-
1014
853
  # Behavior of the subscription schedule and underlying subscription when it ends.
1015
854
  sig { returns(String) }
1016
855
  attr_accessor :end_behavior
1017
-
1018
856
  # The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.
1019
857
  sig { returns(String) }
1020
858
  attr_accessor :from_subscription
1021
-
1022
859
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
1023
860
  sig { returns(T::Hash[String, String]) }
1024
861
  attr_accessor :metadata
1025
-
1026
862
  # If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
1027
863
  sig {
1028
864
  returns(T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::Prebilling))
1029
865
  }
1030
866
  attr_accessor :prebilling
1031
-
1032
867
  # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
1033
868
  #
1034
869
  # When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
@@ -1038,11 +873,9 @@ module Stripe
1038
873
  # Prorations can be disabled by passing `none`.
1039
874
  sig { returns(String) }
1040
875
  attr_accessor :proration_behavior
1041
-
1042
876
  # Integer representing the number of trial period days before the customer is charged for the first time.
1043
877
  sig { returns(T.nilable(Integer)) }
1044
878
  attr_accessor :trial_period_days
1045
-
1046
879
  sig {
1047
880
  params(bill_on_acceptance: ::Stripe::QuoteService::CreateParams::SubscriptionData::BillOnAcceptance, billing_behavior: String, billing_cycle_anchor: T.nilable(String), description: String, effective_date: T.nilable(T.any(String, Integer)), end_behavior: String, from_subscription: String, metadata: T::Hash[String, String], prebilling: T.nilable(::Stripe::QuoteService::CreateParams::SubscriptionData::Prebilling), proration_behavior: String, trial_period_days: T.nilable(Integer)).void
1048
881
  }
@@ -1065,15 +898,12 @@ module Stripe
1065
898
  # A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
1066
899
  sig { returns(String) }
1067
900
  attr_accessor :new_reference
1068
-
1069
901
  # The ID of the schedule the line applies to.
1070
902
  sig { returns(String) }
1071
903
  attr_accessor :subscription_schedule
1072
-
1073
904
  # Describes whether the quote line is affecting a new schedule or an existing schedule.
1074
905
  sig { returns(String) }
1075
906
  attr_accessor :type
1076
-
1077
907
  sig { params(new_reference: String, subscription_schedule: String, type: String).void }
1078
908
  def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
1079
909
  end
@@ -1083,11 +913,9 @@ module Stripe
1083
913
  # The ID of a quote line.
1084
914
  sig { returns(String) }
1085
915
  attr_accessor :id
1086
-
1087
916
  # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
1088
917
  sig { returns(Integer) }
1089
918
  attr_accessor :index
1090
-
1091
919
  sig { params(id: String, index: Integer).void }
1092
920
  def initialize(id: nil, index: nil); end
1093
921
  end
@@ -1096,15 +924,12 @@ module Stripe
1096
924
  returns(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt)
1097
925
  }
1098
926
  attr_accessor :line_starts_at
1099
-
1100
927
  # A precise Unix timestamp.
1101
928
  sig { returns(Integer) }
1102
929
  attr_accessor :timestamp
1103
-
1104
930
  # The type of method to specify the `bill_from` time.
1105
931
  sig { returns(String) }
1106
932
  attr_accessor :type
1107
-
1108
933
  sig {
1109
934
  params(line_starts_at: ::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt, timestamp: Integer, type: String).void
1110
935
  }
@@ -1115,11 +940,9 @@ module Stripe
1115
940
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1116
941
  sig { returns(String) }
1117
942
  attr_accessor :interval
1118
-
1119
943
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1120
944
  sig { returns(Integer) }
1121
945
  attr_accessor :interval_count
1122
-
1123
946
  sig { params(interval: String, interval_count: Integer).void }
1124
947
  def initialize(interval: nil, interval_count: nil); end
1125
948
  end
@@ -1127,11 +950,9 @@ module Stripe
1127
950
  # The ID of a quote line.
1128
951
  sig { returns(String) }
1129
952
  attr_accessor :id
1130
-
1131
953
  # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
1132
954
  sig { returns(Integer) }
1133
955
  attr_accessor :index
1134
-
1135
956
  sig { params(id: String, index: Integer).void }
1136
957
  def initialize(id: nil, index: nil); end
1137
958
  end
@@ -1140,21 +961,17 @@ module Stripe
1140
961
  returns(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration)
1141
962
  }
1142
963
  attr_accessor :duration
1143
-
1144
964
  # Details of a Quote line item from which to bill until.
1145
965
  sig {
1146
966
  returns(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt)
1147
967
  }
1148
968
  attr_accessor :line_ends_at
1149
-
1150
969
  # A precise Unix timestamp.
1151
970
  sig { returns(Integer) }
1152
971
  attr_accessor :timestamp
1153
-
1154
972
  # The type of method to specify the `bill_until` time.
1155
973
  sig { returns(String) }
1156
974
  attr_accessor :type
1157
-
1158
975
  sig {
1159
976
  params(duration: ::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration, line_ends_at: ::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt, timestamp: Integer, type: String).void
1160
977
  }
@@ -1165,13 +982,11 @@ module Stripe
1165
982
  returns(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom)
1166
983
  }
1167
984
  attr_accessor :bill_from
1168
-
1169
985
  # The end of the period to bill until when the Quote is accepted.
1170
986
  sig {
1171
987
  returns(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil)
1172
988
  }
1173
989
  attr_accessor :bill_until
1174
-
1175
990
  sig {
1176
991
  params(bill_from: ::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom, bill_until: ::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil).void
1177
992
  }
@@ -1180,29 +995,23 @@ module Stripe
1180
995
  # Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
1181
996
  sig { returns(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::AppliesTo) }
1182
997
  attr_accessor :applies_to
1183
-
1184
998
  # Describes the period to bill for upon accepting the quote.
1185
999
  sig {
1186
1000
  returns(::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance)
1187
1001
  }
1188
1002
  attr_accessor :bill_on_acceptance
1189
-
1190
1003
  # 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.
1191
1004
  sig { returns(String) }
1192
1005
  attr_accessor :billing_behavior
1193
-
1194
1006
  # The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.
1195
1007
  sig { returns(String) }
1196
1008
  attr_accessor :customer
1197
-
1198
1009
  # The subscription's 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.
1199
1010
  sig { returns(String) }
1200
1011
  attr_accessor :description
1201
-
1202
1012
  # Behavior of the subscription schedule and underlying subscription when it ends.
1203
1013
  sig { returns(String) }
1204
1014
  attr_accessor :end_behavior
1205
-
1206
1015
  # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
1207
1016
  #
1208
1017
  # When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
@@ -1212,7 +1021,6 @@ module Stripe
1212
1021
  # Prorations can be disabled by passing `none`.
1213
1022
  sig { returns(String) }
1214
1023
  attr_accessor :proration_behavior
1215
-
1216
1024
  sig {
1217
1025
  params(applies_to: ::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::AppliesTo, bill_on_acceptance: ::Stripe::QuoteService::CreateParams::SubscriptionDataOverride::BillOnAcceptance, billing_behavior: String, customer: String, description: String, end_behavior: String, proration_behavior: String).void
1218
1026
  }
@@ -1230,110 +1038,84 @@ module Stripe
1230
1038
  # The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
1231
1039
  sig { returns(Integer) }
1232
1040
  attr_accessor :amount
1233
-
1234
1041
  # 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. There must be at least 1 line item with a recurring price to use this field.
1235
1042
  sig { returns(Float) }
1236
1043
  attr_accessor :amount_percent
1237
-
1238
1044
  # ID of an existing, connected Stripe account.
1239
1045
  sig { returns(String) }
1240
1046
  attr_accessor :destination
1241
-
1242
1047
  sig { params(amount: Integer, amount_percent: Float, destination: String).void }
1243
1048
  def initialize(amount: nil, amount_percent: nil, destination: nil); end
1244
1049
  end
1245
1050
  # Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
1246
1051
  sig { returns(T::Boolean) }
1247
1052
  attr_accessor :allow_backdated_lines
1248
-
1249
1053
  # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
1250
1054
  sig { returns(T.nilable(Integer)) }
1251
1055
  attr_accessor :application_fee_amount
1252
-
1253
1056
  # 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. There must be at least 1 line item with a recurring price to use this field.
1254
1057
  sig { returns(T.nilable(Float)) }
1255
1058
  attr_accessor :application_fee_percent
1256
-
1257
1059
  # Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
1258
1060
  sig { returns(::Stripe::QuoteService::CreateParams::AutomaticTax) }
1259
1061
  attr_accessor :automatic_tax
1260
-
1261
1062
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or 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`.
1262
1063
  sig { returns(String) }
1263
1064
  attr_accessor :collection_method
1264
-
1265
1065
  # The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
1266
1066
  sig { returns(String) }
1267
1067
  attr_accessor :customer
1268
-
1269
1068
  # The tax rates that will apply to any line item that does not have `tax_rates` set.
1270
1069
  sig { returns(T.nilable(T::Array[String])) }
1271
1070
  attr_accessor :default_tax_rates
1272
-
1273
1071
  # A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
1274
1072
  sig { returns(T.nilable(String)) }
1275
1073
  attr_accessor :description
1276
-
1277
1074
  # The discounts applied to the quote.
1278
1075
  sig { returns(T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Discount])) }
1279
1076
  attr_accessor :discounts
1280
-
1281
1077
  # Specifies which fields in the response should be expanded.
1282
1078
  sig { returns(T::Array[String]) }
1283
1079
  attr_accessor :expand
1284
-
1285
1080
  # A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
1286
1081
  sig { returns(Integer) }
1287
1082
  attr_accessor :expires_at
1288
-
1289
1083
  # A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
1290
1084
  sig { returns(T.nilable(String)) }
1291
1085
  attr_accessor :footer
1292
-
1293
1086
  # Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`.
1294
1087
  sig { returns(::Stripe::QuoteService::CreateParams::FromQuote) }
1295
1088
  attr_accessor :from_quote
1296
-
1297
1089
  # A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
1298
1090
  sig { returns(T.nilable(String)) }
1299
1091
  attr_accessor :header
1300
-
1301
1092
  # All invoices will be billed using the specified settings.
1302
1093
  sig { returns(::Stripe::QuoteService::CreateParams::InvoiceSettings) }
1303
1094
  attr_accessor :invoice_settings
1304
-
1305
1095
  # A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
1306
1096
  sig { returns(T::Array[::Stripe::QuoteService::CreateParams::LineItem]) }
1307
1097
  attr_accessor :line_items
1308
-
1309
1098
  # A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
1310
1099
  sig { returns(T::Array[::Stripe::QuoteService::CreateParams::Line]) }
1311
1100
  attr_accessor :lines
1312
-
1313
1101
  # 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`.
1314
1102
  sig { returns(T::Hash[String, String]) }
1315
1103
  attr_accessor :metadata
1316
-
1317
1104
  # The account on behalf of which to charge.
1318
1105
  sig { returns(T.nilable(String)) }
1319
1106
  attr_accessor :on_behalf_of
1320
-
1321
1107
  # When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
1322
1108
  sig { returns(::Stripe::QuoteService::CreateParams::SubscriptionData) }
1323
1109
  attr_accessor :subscription_data
1324
-
1325
1110
  # List representing overrides for `subscription_data` configurations for specific subscription schedules.
1326
1111
  sig { returns(T::Array[::Stripe::QuoteService::CreateParams::SubscriptionDataOverride]) }
1327
1112
  attr_accessor :subscription_data_overrides
1328
-
1329
1113
  # ID of the test clock to attach to the quote.
1330
1114
  sig { returns(String) }
1331
1115
  attr_accessor :test_clock
1332
-
1333
1116
  # The data with which to automatically create a Transfer for each of the invoices.
1334
1117
  sig { returns(T.nilable(::Stripe::QuoteService::CreateParams::TransferData)) }
1335
1118
  attr_accessor :transfer_data
1336
-
1337
1119
  sig {
1338
1120
  params(allow_backdated_lines: T::Boolean, application_fee_amount: T.nilable(Integer), application_fee_percent: T.nilable(Float), automatic_tax: ::Stripe::QuoteService::CreateParams::AutomaticTax, collection_method: String, customer: String, default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T::Array[::Stripe::QuoteService::CreateParams::Discount]), expand: T::Array[String], expires_at: Integer, footer: T.nilable(String), from_quote: ::Stripe::QuoteService::CreateParams::FromQuote, header: T.nilable(String), invoice_settings: ::Stripe::QuoteService::CreateParams::InvoiceSettings, line_items: T::Array[::Stripe::QuoteService::CreateParams::LineItem], lines: T::Array[::Stripe::QuoteService::CreateParams::Line], metadata: T::Hash[String, String], on_behalf_of: T.nilable(String), subscription_data: ::Stripe::QuoteService::CreateParams::SubscriptionData, subscription_data_overrides: T::Array[::Stripe::QuoteService::CreateParams::SubscriptionDataOverride], test_clock: String, transfer_data: T.nilable(::Stripe::QuoteService::CreateParams::TransferData)).void
1339
1121
  }
@@ -1367,7 +1149,6 @@ module Stripe
1367
1149
  # Specifies which fields in the response should be expanded.
1368
1150
  sig { returns(T::Array[String]) }
1369
1151
  attr_accessor :expand
1370
-
1371
1152
  sig { params(expand: T::Array[String]).void }
1372
1153
  def initialize(expand: nil); end
1373
1154
  end
@@ -1377,22 +1158,18 @@ module Stripe
1377
1158
  # The connected account being referenced when `type` is `account`.
1378
1159
  sig { returns(String) }
1379
1160
  attr_accessor :account
1380
-
1381
1161
  # Type of the account referenced in the request.
1382
1162
  sig { returns(String) }
1383
1163
  attr_accessor :type
1384
-
1385
1164
  sig { params(account: String, type: String).void }
1386
1165
  def initialize(account: nil, type: nil); end
1387
1166
  end
1388
1167
  # Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
1389
1168
  sig { returns(T::Boolean) }
1390
1169
  attr_accessor :enabled
1391
-
1392
1170
  # 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.
1393
1171
  sig { returns(::Stripe::QuoteService::UpdateParams::AutomaticTax::Liability) }
1394
1172
  attr_accessor :liability
1395
-
1396
1173
  sig {
1397
1174
  params(enabled: T::Boolean, liability: ::Stripe::QuoteService::UpdateParams::AutomaticTax::Liability).void
1398
1175
  }
@@ -1404,26 +1181,21 @@ module Stripe
1404
1181
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1405
1182
  sig { returns(String) }
1406
1183
  attr_accessor :interval
1407
-
1408
1184
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1409
1185
  sig { returns(Integer) }
1410
1186
  attr_accessor :interval_count
1411
-
1412
1187
  sig { params(interval: String, interval_count: Integer).void }
1413
1188
  def initialize(interval: nil, interval_count: nil); end
1414
1189
  end
1415
1190
  # Time span for the redeemed discount.
1416
1191
  sig { returns(::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd::Duration) }
1417
1192
  attr_accessor :duration
1418
-
1419
1193
  # A precise Unix timestamp for the discount to end. Must be in the future.
1420
1194
  sig { returns(Integer) }
1421
1195
  attr_accessor :timestamp
1422
-
1423
1196
  # The type of calculation made to determine when the discount ends.
1424
1197
  sig { returns(String) }
1425
1198
  attr_accessor :type
1426
-
1427
1199
  sig {
1428
1200
  params(duration: ::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1429
1201
  }
@@ -1432,19 +1204,15 @@ module Stripe
1432
1204
  # ID of the coupon to create a new discount for.
1433
1205
  sig { returns(String) }
1434
1206
  attr_accessor :coupon
1435
-
1436
1207
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1437
1208
  sig { returns(String) }
1438
1209
  attr_accessor :discount
1439
-
1440
1210
  # Details to determine how long the discount should be applied for.
1441
1211
  sig { returns(::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd) }
1442
1212
  attr_accessor :discount_end
1443
-
1444
1213
  # ID of the promotion code to create a new discount for.
1445
1214
  sig { returns(String) }
1446
1215
  attr_accessor :promotion_code
1447
-
1448
1216
  sig {
1449
1217
  params(coupon: String, discount: String, discount_end: ::Stripe::QuoteService::UpdateParams::Discount::DiscountEnd, promotion_code: String).void
1450
1218
  }
@@ -1455,22 +1223,18 @@ module Stripe
1455
1223
  # The connected account being referenced when `type` is `account`.
1456
1224
  sig { returns(String) }
1457
1225
  attr_accessor :account
1458
-
1459
1226
  # Type of the account referenced in the request.
1460
1227
  sig { returns(String) }
1461
1228
  attr_accessor :type
1462
-
1463
1229
  sig { params(account: String, type: String).void }
1464
1230
  def initialize(account: nil, type: nil); end
1465
1231
  end
1466
1232
  # Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
1467
1233
  sig { returns(Integer) }
1468
1234
  attr_accessor :days_until_due
1469
-
1470
1235
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1471
1236
  sig { returns(::Stripe::QuoteService::UpdateParams::InvoiceSettings::Issuer) }
1472
1237
  attr_accessor :issuer
1473
-
1474
1238
  sig {
1475
1239
  params(days_until_due: Integer, issuer: ::Stripe::QuoteService::UpdateParams::InvoiceSettings::Issuer).void
1476
1240
  }
@@ -1483,32 +1247,26 @@ module Stripe
1483
1247
  # The type of calculation made to determine when the discount ends.
1484
1248
  sig { returns(String) }
1485
1249
  attr_accessor :type
1486
-
1487
1250
  sig { params(type: String).void }
1488
1251
  def initialize(type: nil); end
1489
1252
  end
1490
1253
  # The coupon code to redeem.
1491
1254
  sig { returns(String) }
1492
1255
  attr_accessor :coupon
1493
-
1494
1256
  # An ID of an existing discount for a coupon that was already redeemed.
1495
1257
  sig { returns(String) }
1496
1258
  attr_accessor :discount
1497
-
1498
1259
  # Details to determine how long the discount should be applied for.
1499
1260
  sig {
1500
1261
  returns(::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount::DiscountEnd)
1501
1262
  }
1502
1263
  attr_accessor :discount_end
1503
-
1504
1264
  # 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.
1505
1265
  sig { returns(Integer) }
1506
1266
  attr_accessor :index
1507
-
1508
1267
  # The promotion code to redeem.
1509
1268
  sig { returns(String) }
1510
1269
  attr_accessor :promotion_code
1511
-
1512
1270
  sig {
1513
1271
  params(coupon: String, discount: String, discount_end: ::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount::DiscountEnd, index: Integer, promotion_code: String).void
1514
1272
  }
@@ -1527,11 +1285,9 @@ module Stripe
1527
1285
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1528
1286
  sig { returns(String) }
1529
1287
  attr_accessor :interval
1530
-
1531
1288
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1532
1289
  sig { returns(Integer) }
1533
1290
  attr_accessor :interval_count
1534
-
1535
1291
  sig { params(interval: String, interval_count: Integer).void }
1536
1292
  def initialize(interval: nil, interval_count: nil); end
1537
1293
  end
@@ -1540,15 +1296,12 @@ module Stripe
1540
1296
  returns(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration)
1541
1297
  }
1542
1298
  attr_accessor :duration
1543
-
1544
1299
  # A precise Unix timestamp for the discount to end. Must be in the future.
1545
1300
  sig { returns(Integer) }
1546
1301
  attr_accessor :timestamp
1547
-
1548
1302
  # The type of calculation made to determine when the discount ends.
1549
1303
  sig { returns(String) }
1550
1304
  attr_accessor :type
1551
-
1552
1305
  sig {
1553
1306
  params(duration: ::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1554
1307
  }
@@ -1557,21 +1310,17 @@ module Stripe
1557
1310
  # ID of the coupon to create a new discount for.
1558
1311
  sig { returns(String) }
1559
1312
  attr_accessor :coupon
1560
-
1561
1313
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1562
1314
  sig { returns(String) }
1563
1315
  attr_accessor :discount
1564
-
1565
1316
  # Details to determine how long the discount should be applied for.
1566
1317
  sig {
1567
1318
  returns(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd)
1568
1319
  }
1569
1320
  attr_accessor :discount_end
1570
-
1571
1321
  # ID of the promotion code to create a new discount for.
1572
1322
  sig { returns(String) }
1573
1323
  attr_accessor :promotion_code
1574
-
1575
1324
  sig {
1576
1325
  params(coupon: String, discount: String, discount_end: ::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount::DiscountEnd, promotion_code: String).void
1577
1326
  }
@@ -1586,11 +1335,9 @@ module Stripe
1586
1335
  # 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.
1587
1336
  sig { returns(T::Array[String]) }
1588
1337
  attr_accessor :converts_to
1589
-
1590
1338
  # Determines the type of trial for this item.
1591
1339
  sig { returns(String) }
1592
1340
  attr_accessor :type
1593
-
1594
1341
  sig { params(converts_to: T::Array[String], type: String).void }
1595
1342
  def initialize(converts_to: nil, type: nil); end
1596
1343
  end
@@ -1599,27 +1346,21 @@ module Stripe
1599
1346
  returns(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount])
1600
1347
  }
1601
1348
  attr_accessor :discounts
1602
-
1603
1349
  # 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`.
1604
1350
  sig { returns(T::Hash[String, String]) }
1605
1351
  attr_accessor :metadata
1606
-
1607
1352
  # The ID of the price object.
1608
1353
  sig { returns(String) }
1609
1354
  attr_accessor :price
1610
-
1611
1355
  # Quantity for this item.
1612
1356
  sig { returns(Integer) }
1613
1357
  attr_accessor :quantity
1614
-
1615
1358
  # 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`.
1616
1359
  sig { returns(T::Array[String]) }
1617
1360
  attr_accessor :tax_rates
1618
-
1619
1361
  # Options that configure the trial on the subscription item.
1620
1362
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Trial) }
1621
1363
  attr_accessor :trial
1622
-
1623
1364
  sig {
1624
1365
  params(discounts: T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Discount], metadata: T::Hash[String, String], price: String, quantity: Integer, tax_rates: T::Array[String], trial: ::Stripe::QuoteService::UpdateParams::Line::Action::AddItem::Trial).void
1625
1366
  }
@@ -1636,15 +1377,12 @@ module Stripe
1636
1377
  # The coupon code to remove from the `discounts` array.
1637
1378
  sig { returns(String) }
1638
1379
  attr_accessor :coupon
1639
-
1640
1380
  # The ID of a discount to remove from the `discounts` array.
1641
1381
  sig { returns(String) }
1642
1382
  attr_accessor :discount
1643
-
1644
1383
  # The ID of a promotion code to remove from the `discounts` array.
1645
1384
  sig { returns(String) }
1646
1385
  attr_accessor :promotion_code
1647
-
1648
1386
  sig { params(coupon: String, discount: String, promotion_code: String).void }
1649
1387
  def initialize(coupon: nil, discount: nil, promotion_code: nil); end
1650
1388
  end
@@ -1652,7 +1390,6 @@ module Stripe
1652
1390
  # ID of a price to remove.
1653
1391
  sig { returns(String) }
1654
1392
  attr_accessor :price
1655
-
1656
1393
  sig { params(price: String).void }
1657
1394
  def initialize(price: nil); end
1658
1395
  end
@@ -1660,15 +1397,12 @@ module Stripe
1660
1397
  # The coupon code to replace the `discounts` array with.
1661
1398
  sig { returns(String) }
1662
1399
  attr_accessor :coupon
1663
-
1664
1400
  # An ID of an existing discount to replace the `discounts` array with.
1665
1401
  sig { returns(String) }
1666
1402
  attr_accessor :discount
1667
-
1668
1403
  # An ID of an existing promotion code to replace the `discounts` array with.
1669
1404
  sig { returns(String) }
1670
1405
  attr_accessor :promotion_code
1671
-
1672
1406
  sig { params(coupon: String, discount: String, promotion_code: String).void }
1673
1407
  def initialize(coupon: nil, discount: nil, promotion_code: nil); end
1674
1408
  end
@@ -1679,11 +1413,9 @@ module Stripe
1679
1413
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1680
1414
  sig { returns(String) }
1681
1415
  attr_accessor :interval
1682
-
1683
1416
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1684
1417
  sig { returns(Integer) }
1685
1418
  attr_accessor :interval_count
1686
-
1687
1419
  sig { params(interval: String, interval_count: Integer).void }
1688
1420
  def initialize(interval: nil, interval_count: nil); end
1689
1421
  end
@@ -1692,15 +1424,12 @@ module Stripe
1692
1424
  returns(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration)
1693
1425
  }
1694
1426
  attr_accessor :duration
1695
-
1696
1427
  # A precise Unix timestamp for the discount to end. Must be in the future.
1697
1428
  sig { returns(Integer) }
1698
1429
  attr_accessor :timestamp
1699
-
1700
1430
  # The type of calculation made to determine when the discount ends.
1701
1431
  sig { returns(String) }
1702
1432
  attr_accessor :type
1703
-
1704
1433
  sig {
1705
1434
  params(duration: ::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1706
1435
  }
@@ -1709,21 +1438,17 @@ module Stripe
1709
1438
  # ID of the coupon to create a new discount for.
1710
1439
  sig { returns(String) }
1711
1440
  attr_accessor :coupon
1712
-
1713
1441
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1714
1442
  sig { returns(String) }
1715
1443
  attr_accessor :discount
1716
-
1717
1444
  # Details to determine how long the discount should be applied for.
1718
1445
  sig {
1719
1446
  returns(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd)
1720
1447
  }
1721
1448
  attr_accessor :discount_end
1722
-
1723
1449
  # ID of the promotion code to create a new discount for.
1724
1450
  sig { returns(String) }
1725
1451
  attr_accessor :promotion_code
1726
-
1727
1452
  sig {
1728
1453
  params(coupon: String, discount: String, discount_end: ::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount::DiscountEnd, promotion_code: String).void
1729
1454
  }
@@ -1738,11 +1463,9 @@ module Stripe
1738
1463
  # 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.
1739
1464
  sig { returns(T::Array[String]) }
1740
1465
  attr_accessor :converts_to
1741
-
1742
1466
  # Determines the type of trial for this item.
1743
1467
  sig { returns(String) }
1744
1468
  attr_accessor :type
1745
-
1746
1469
  sig { params(converts_to: T::Array[String], type: String).void }
1747
1470
  def initialize(converts_to: nil, type: nil); end
1748
1471
  end
@@ -1751,27 +1474,21 @@ module Stripe
1751
1474
  returns(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount])
1752
1475
  }
1753
1476
  attr_accessor :discounts
1754
-
1755
1477
  # 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`.
1756
1478
  sig { returns(T::Hash[String, String]) }
1757
1479
  attr_accessor :metadata
1758
-
1759
1480
  # The ID of the price object.
1760
1481
  sig { returns(String) }
1761
1482
  attr_accessor :price
1762
-
1763
1483
  # 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`.
1764
1484
  sig { returns(Integer) }
1765
1485
  attr_accessor :quantity
1766
-
1767
1486
  # 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`.
1768
1487
  sig { returns(T::Array[String]) }
1769
1488
  attr_accessor :tax_rates
1770
-
1771
1489
  # 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`.
1772
1490
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Trial) }
1773
1491
  attr_accessor :trial
1774
-
1775
1492
  sig {
1776
1493
  params(discounts: T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Discount], metadata: T::Hash[String, String], price: String, quantity: Integer, tax_rates: T::Array[String], trial: ::Stripe::QuoteService::UpdateParams::Line::Action::SetItem::Trial).void
1777
1494
  }
@@ -1787,43 +1504,33 @@ module Stripe
1787
1504
  # Details for the `add_discount` type.
1788
1505
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount) }
1789
1506
  attr_accessor :add_discount
1790
-
1791
1507
  # Details for the `add_item` type.
1792
1508
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::Action::AddItem) }
1793
1509
  attr_accessor :add_item
1794
-
1795
1510
  # Details for the `add_metadata` type: specify a hash of key-value pairs.
1796
1511
  sig { returns(T::Hash[String, String]) }
1797
1512
  attr_accessor :add_metadata
1798
-
1799
1513
  # Details for the `remove_discount` type.
1800
1514
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::Action::RemoveDiscount) }
1801
1515
  attr_accessor :remove_discount
1802
-
1803
1516
  # Details for the `remove_item` type.
1804
1517
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::Action::RemoveItem) }
1805
1518
  attr_accessor :remove_item
1806
-
1807
1519
  # Details for the `remove_metadata` type: specify an array of metadata keys.
1808
1520
  sig { returns(T::Array[String]) }
1809
1521
  attr_accessor :remove_metadata
1810
-
1811
1522
  # Details for the `set_discounts` type.
1812
1523
  sig { returns(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetDiscount]) }
1813
1524
  attr_accessor :set_discounts
1814
-
1815
1525
  # Details for the `set_items` type.
1816
1526
  sig { returns(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem]) }
1817
1527
  attr_accessor :set_items
1818
-
1819
1528
  # Details for the `set_metadata` type: specify an array of key-value pairs.
1820
1529
  sig { returns(T.nilable(T::Hash[String, String])) }
1821
1530
  attr_accessor :set_metadata
1822
-
1823
1531
  # The type of action the quote line performs.
1824
1532
  sig { returns(String) }
1825
1533
  attr_accessor :type
1826
-
1827
1534
  sig {
1828
1535
  params(add_discount: ::Stripe::QuoteService::UpdateParams::Line::Action::AddDiscount, add_item: ::Stripe::QuoteService::UpdateParams::Line::Action::AddItem, add_metadata: T::Hash[String, String], remove_discount: ::Stripe::QuoteService::UpdateParams::Line::Action::RemoveDiscount, remove_item: ::Stripe::QuoteService::UpdateParams::Line::Action::RemoveItem, remove_metadata: T::Array[String], set_discounts: T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetDiscount], set_items: T::Array[::Stripe::QuoteService::UpdateParams::Line::Action::SetItem], set_metadata: T.nilable(T::Hash[String, String]), type: String).void
1829
1536
  }
@@ -1844,15 +1551,12 @@ module Stripe
1844
1551
  # A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
1845
1552
  sig { returns(String) }
1846
1553
  attr_accessor :new_reference
1847
-
1848
1554
  # The ID of the schedule the line applies to.
1849
1555
  sig { returns(String) }
1850
1556
  attr_accessor :subscription_schedule
1851
-
1852
1557
  # Describes whether the quote line is affecting a new schedule or an existing schedule.
1853
1558
  sig { returns(String) }
1854
1559
  attr_accessor :type
1855
-
1856
1560
  sig { params(new_reference: String, subscription_schedule: String, type: String).void }
1857
1561
  def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
1858
1562
  end
@@ -1860,15 +1564,12 @@ module Stripe
1860
1564
  # Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
1861
1565
  sig { returns(String) }
1862
1566
  attr_accessor :cancel_at
1863
-
1864
1567
  # If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
1865
1568
  sig { returns(T::Boolean) }
1866
1569
  attr_accessor :invoice_now
1867
-
1868
1570
  # If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
1869
1571
  sig { returns(T::Boolean) }
1870
1572
  attr_accessor :prorate
1871
-
1872
1573
  sig { params(cancel_at: String, invoice_now: T::Boolean, prorate: T::Boolean).void }
1873
1574
  def initialize(cancel_at: nil, invoice_now: nil, prorate: nil); end
1874
1575
  end
@@ -1877,7 +1578,6 @@ module Stripe
1877
1578
  # The ID of a specific discount.
1878
1579
  sig { returns(String) }
1879
1580
  attr_accessor :discount
1880
-
1881
1581
  sig { params(discount: String).void }
1882
1582
  def initialize(discount: nil); end
1883
1583
  end
@@ -1885,30 +1585,24 @@ module Stripe
1885
1585
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1886
1586
  sig { returns(String) }
1887
1587
  attr_accessor :interval
1888
-
1889
1588
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1890
1589
  sig { returns(Integer) }
1891
1590
  attr_accessor :interval_count
1892
-
1893
1591
  sig { params(interval: String, interval_count: Integer).void }
1894
1592
  def initialize(interval: nil, interval_count: nil); end
1895
1593
  end
1896
1594
  # Use the `end` time of a given discount.
1897
1595
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::EndsAt::DiscountEnd) }
1898
1596
  attr_accessor :discount_end
1899
-
1900
1597
  # Time span for the quote line starting from the `starts_at` date.
1901
1598
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::EndsAt::Duration) }
1902
1599
  attr_accessor :duration
1903
-
1904
1600
  # A precise Unix timestamp.
1905
1601
  sig { returns(Integer) }
1906
1602
  attr_accessor :timestamp
1907
-
1908
1603
  # Select a way to pass in `ends_at`.
1909
1604
  sig { returns(String) }
1910
1605
  attr_accessor :type
1911
-
1912
1606
  sig {
1913
1607
  params(discount_end: ::Stripe::QuoteService::UpdateParams::Line::EndsAt::DiscountEnd, duration: ::Stripe::QuoteService::UpdateParams::Line::EndsAt::Duration, timestamp: Integer, type: String).void
1914
1608
  }
@@ -1919,18 +1613,15 @@ module Stripe
1919
1613
  # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
1920
1614
  sig { returns(String) }
1921
1615
  attr_accessor :behavior
1922
-
1923
1616
  sig { params(behavior: String).void }
1924
1617
  def initialize(behavior: nil); end
1925
1618
  end
1926
1619
  # Details of the pause_collection behavior to apply to the amendment.
1927
1620
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection::Set) }
1928
1621
  attr_accessor :set
1929
-
1930
1622
  # Determines the type of the pause_collection amendment.
1931
1623
  sig { returns(String) }
1932
1624
  attr_accessor :type
1933
-
1934
1625
  sig {
1935
1626
  params(set: ::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection::Set, type: String).void
1936
1627
  }
@@ -1941,7 +1632,6 @@ module Stripe
1941
1632
  # The ID of a specific discount.
1942
1633
  sig { returns(String) }
1943
1634
  attr_accessor :discount
1944
-
1945
1635
  sig { params(discount: String).void }
1946
1636
  def initialize(discount: nil); end
1947
1637
  end
@@ -1949,30 +1639,24 @@ module Stripe
1949
1639
  # The ID of a quote line.
1950
1640
  sig { returns(String) }
1951
1641
  attr_accessor :id
1952
-
1953
1642
  # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
1954
1643
  sig { returns(Integer) }
1955
1644
  attr_accessor :index
1956
-
1957
1645
  sig { params(id: String, index: Integer).void }
1958
1646
  def initialize(id: nil, index: nil); end
1959
1647
  end
1960
1648
  # Use the `end` time of a given discount.
1961
1649
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::StartsAt::DiscountEnd) }
1962
1650
  attr_accessor :discount_end
1963
-
1964
1651
  # The timestamp the given line ends at.
1965
1652
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::StartsAt::LineEndsAt) }
1966
1653
  attr_accessor :line_ends_at
1967
-
1968
1654
  # A precise Unix timestamp.
1969
1655
  sig { returns(Integer) }
1970
1656
  attr_accessor :timestamp
1971
-
1972
1657
  # Select a way to pass in `starts_at`.
1973
1658
  sig { returns(String) }
1974
1659
  attr_accessor :type
1975
-
1976
1660
  sig {
1977
1661
  params(discount_end: ::Stripe::QuoteService::UpdateParams::Line::StartsAt::DiscountEnd, line_ends_at: ::Stripe::QuoteService::UpdateParams::Line::StartsAt::LineEndsAt, timestamp: Integer, type: String).void
1978
1662
  }
@@ -1983,14 +1667,12 @@ module Stripe
1983
1667
  # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
1984
1668
  sig { returns(String) }
1985
1669
  attr_accessor :prorate_up_front
1986
-
1987
1670
  sig { params(prorate_up_front: String).void }
1988
1671
  def initialize(prorate_up_front: nil); end
1989
1672
  end
1990
1673
  # Defines how the subscription should behave when a trial ends.
1991
1674
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::TrialSettings::EndBehavior) }
1992
1675
  attr_accessor :end_behavior
1993
-
1994
1676
  sig {
1995
1677
  params(end_behavior: ::Stripe::QuoteService::UpdateParams::Line::TrialSettings::EndBehavior).void
1996
1678
  }
@@ -1999,47 +1681,36 @@ module Stripe
1999
1681
  # An array of operations the quote line performs.
2000
1682
  sig { returns(T::Array[::Stripe::QuoteService::UpdateParams::Line::Action]) }
2001
1683
  attr_accessor :actions
2002
-
2003
1684
  # Details to identify the subscription schedule the quote line applies to.
2004
1685
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::AppliesTo) }
2005
1686
  attr_accessor :applies_to
2006
-
2007
1687
  # For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
2008
1688
  sig { returns(String) }
2009
1689
  attr_accessor :billing_cycle_anchor
2010
-
2011
1690
  # A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
2012
1691
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::CancelSubscriptionSchedule) }
2013
1692
  attr_accessor :cancel_subscription_schedule
2014
-
2015
1693
  # Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
2016
1694
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::EndsAt) }
2017
1695
  attr_accessor :ends_at
2018
-
2019
1696
  # The ID of an existing line on the quote.
2020
1697
  sig { returns(String) }
2021
1698
  attr_accessor :id
2022
-
2023
1699
  # Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
2024
1700
  sig { returns(String) }
2025
1701
  attr_accessor :proration_behavior
2026
-
2027
1702
  # Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
2028
1703
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection) }
2029
1704
  attr_accessor :set_pause_collection
2030
-
2031
1705
  # Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
2032
1706
  sig { returns(String) }
2033
1707
  attr_accessor :set_schedule_end
2034
-
2035
1708
  # Details to identify the earliest timestamp where the proposed change should take effect.
2036
1709
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::StartsAt) }
2037
1710
  attr_accessor :starts_at
2038
-
2039
1711
  # Settings related to subscription trials.
2040
1712
  sig { returns(::Stripe::QuoteService::UpdateParams::Line::TrialSettings) }
2041
1713
  attr_accessor :trial_settings
2042
-
2043
1714
  sig {
2044
1715
  params(actions: T::Array[::Stripe::QuoteService::UpdateParams::Line::Action], applies_to: ::Stripe::QuoteService::UpdateParams::Line::AppliesTo, billing_cycle_anchor: String, cancel_subscription_schedule: ::Stripe::QuoteService::UpdateParams::Line::CancelSubscriptionSchedule, ends_at: ::Stripe::QuoteService::UpdateParams::Line::EndsAt, id: String, proration_behavior: String, set_pause_collection: ::Stripe::QuoteService::UpdateParams::Line::SetPauseCollection, set_schedule_end: String, starts_at: ::Stripe::QuoteService::UpdateParams::Line::StartsAt, trial_settings: ::Stripe::QuoteService::UpdateParams::Line::TrialSettings).void
2045
1716
  }
@@ -2064,11 +1735,9 @@ module Stripe
2064
1735
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2065
1736
  sig { returns(String) }
2066
1737
  attr_accessor :interval
2067
-
2068
1738
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2069
1739
  sig { returns(Integer) }
2070
1740
  attr_accessor :interval_count
2071
-
2072
1741
  sig { params(interval: String, interval_count: Integer).void }
2073
1742
  def initialize(interval: nil, interval_count: nil); end
2074
1743
  end
@@ -2077,15 +1746,12 @@ module Stripe
2077
1746
  returns(::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd::Duration)
2078
1747
  }
2079
1748
  attr_accessor :duration
2080
-
2081
1749
  # A precise Unix timestamp for the discount to end. Must be in the future.
2082
1750
  sig { returns(Integer) }
2083
1751
  attr_accessor :timestamp
2084
-
2085
1752
  # The type of calculation made to determine when the discount ends.
2086
1753
  sig { returns(String) }
2087
1754
  attr_accessor :type
2088
-
2089
1755
  sig {
2090
1756
  params(duration: ::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
2091
1757
  }
@@ -2094,19 +1760,15 @@ module Stripe
2094
1760
  # ID of the coupon to create a new discount for.
2095
1761
  sig { returns(String) }
2096
1762
  attr_accessor :coupon
2097
-
2098
1763
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
2099
1764
  sig { returns(String) }
2100
1765
  attr_accessor :discount
2101
-
2102
1766
  # Details to determine how long the discount should be applied for.
2103
1767
  sig { returns(::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd) }
2104
1768
  attr_accessor :discount_end
2105
-
2106
1769
  # ID of the promotion code to create a new discount for.
2107
1770
  sig { returns(String) }
2108
1771
  attr_accessor :promotion_code
2109
-
2110
1772
  sig {
2111
1773
  params(coupon: String, discount: String, discount_end: ::Stripe::QuoteService::UpdateParams::LineItem::Discount::DiscountEnd, promotion_code: String).void
2112
1774
  }
@@ -2117,38 +1779,30 @@ module Stripe
2117
1779
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
2118
1780
  sig { returns(String) }
2119
1781
  attr_accessor :interval
2120
-
2121
1782
  # 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).
2122
1783
  sig { returns(Integer) }
2123
1784
  attr_accessor :interval_count
2124
-
2125
1785
  sig { params(interval: String, interval_count: Integer).void }
2126
1786
  def initialize(interval: nil, interval_count: nil); end
2127
1787
  end
2128
1788
  # 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).
2129
1789
  sig { returns(String) }
2130
1790
  attr_accessor :currency
2131
-
2132
1791
  # The ID of the product that this price will belong to.
2133
1792
  sig { returns(String) }
2134
1793
  attr_accessor :product
2135
-
2136
1794
  # The recurring components of a price such as `interval` and `interval_count`.
2137
1795
  sig { returns(::Stripe::QuoteService::UpdateParams::LineItem::PriceData::Recurring) }
2138
1796
  attr_accessor :recurring
2139
-
2140
1797
  # 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.
2141
1798
  sig { returns(String) }
2142
1799
  attr_accessor :tax_behavior
2143
-
2144
1800
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
2145
1801
  sig { returns(Integer) }
2146
1802
  attr_accessor :unit_amount
2147
-
2148
1803
  # 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.
2149
1804
  sig { returns(String) }
2150
1805
  attr_accessor :unit_amount_decimal
2151
-
2152
1806
  sig {
2153
1807
  params(currency: String, product: String, recurring: ::Stripe::QuoteService::UpdateParams::LineItem::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
2154
1808
  }
@@ -2166,27 +1820,21 @@ module Stripe
2166
1820
  returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::LineItem::Discount]))
2167
1821
  }
2168
1822
  attr_accessor :discounts
2169
-
2170
1823
  # The ID of an existing line item on the quote.
2171
1824
  sig { returns(String) }
2172
1825
  attr_accessor :id
2173
-
2174
1826
  # The ID of the price object. One of `price` or `price_data` is required.
2175
1827
  sig { returns(String) }
2176
1828
  attr_accessor :price
2177
-
2178
1829
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
2179
1830
  sig { returns(::Stripe::QuoteService::UpdateParams::LineItem::PriceData) }
2180
1831
  attr_accessor :price_data
2181
-
2182
1832
  # The quantity of the line item.
2183
1833
  sig { returns(Integer) }
2184
1834
  attr_accessor :quantity
2185
-
2186
1835
  # The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
2187
1836
  sig { returns(T.nilable(T::Array[String])) }
2188
1837
  attr_accessor :tax_rates
2189
-
2190
1838
  sig {
2191
1839
  params(discounts: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::LineItem::Discount]), id: String, price: String, price_data: ::Stripe::QuoteService::UpdateParams::LineItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
2192
1840
  }
@@ -2206,11 +1854,9 @@ module Stripe
2206
1854
  # The ID of a quote line.
2207
1855
  sig { returns(String) }
2208
1856
  attr_accessor :id
2209
-
2210
1857
  # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2211
1858
  sig { returns(Integer) }
2212
1859
  attr_accessor :index
2213
-
2214
1860
  sig { params(id: String, index: Integer).void }
2215
1861
  def initialize(id: nil, index: nil); end
2216
1862
  end
@@ -2219,15 +1865,12 @@ module Stripe
2219
1865
  returns(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt)
2220
1866
  }
2221
1867
  attr_accessor :line_starts_at
2222
-
2223
1868
  # A precise Unix timestamp.
2224
1869
  sig { returns(Integer) }
2225
1870
  attr_accessor :timestamp
2226
-
2227
1871
  # The type of method to specify the `bill_from` time.
2228
1872
  sig { returns(String) }
2229
1873
  attr_accessor :type
2230
-
2231
1874
  sig {
2232
1875
  params(line_starts_at: ::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom::LineStartsAt, timestamp: Integer, type: String).void
2233
1876
  }
@@ -2238,11 +1881,9 @@ module Stripe
2238
1881
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2239
1882
  sig { returns(String) }
2240
1883
  attr_accessor :interval
2241
-
2242
1884
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2243
1885
  sig { returns(Integer) }
2244
1886
  attr_accessor :interval_count
2245
-
2246
1887
  sig { params(interval: String, interval_count: Integer).void }
2247
1888
  def initialize(interval: nil, interval_count: nil); end
2248
1889
  end
@@ -2250,11 +1891,9 @@ module Stripe
2250
1891
  # The ID of a quote line.
2251
1892
  sig { returns(String) }
2252
1893
  attr_accessor :id
2253
-
2254
1894
  # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2255
1895
  sig { returns(Integer) }
2256
1896
  attr_accessor :index
2257
-
2258
1897
  sig { params(id: String, index: Integer).void }
2259
1898
  def initialize(id: nil, index: nil); end
2260
1899
  end
@@ -2263,21 +1902,17 @@ module Stripe
2263
1902
  returns(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration)
2264
1903
  }
2265
1904
  attr_accessor :duration
2266
-
2267
1905
  # Details of a Quote line item from which to bill until.
2268
1906
  sig {
2269
1907
  returns(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt)
2270
1908
  }
2271
1909
  attr_accessor :line_ends_at
2272
-
2273
1910
  # A precise Unix timestamp.
2274
1911
  sig { returns(Integer) }
2275
1912
  attr_accessor :timestamp
2276
-
2277
1913
  # The type of method to specify the `bill_until` time.
2278
1914
  sig { returns(String) }
2279
1915
  attr_accessor :type
2280
-
2281
1916
  sig {
2282
1917
  params(duration: ::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::Duration, line_ends_at: ::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil::LineEndsAt, timestamp: Integer, type: String).void
2283
1918
  }
@@ -2288,13 +1923,11 @@ module Stripe
2288
1923
  returns(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom)
2289
1924
  }
2290
1925
  attr_accessor :bill_from
2291
-
2292
1926
  # The end of the period to bill until when the Quote is accepted.
2293
1927
  sig {
2294
1928
  returns(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil)
2295
1929
  }
2296
1930
  attr_accessor :bill_until
2297
-
2298
1931
  sig {
2299
1932
  params(bill_from: ::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillFrom, bill_until: ::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance::BillUntil).void
2300
1933
  }
@@ -2304,7 +1937,6 @@ module Stripe
2304
1937
  # This is used to determine the number of billing cycles to prebill.
2305
1938
  sig { returns(Integer) }
2306
1939
  attr_accessor :iterations
2307
-
2308
1940
  sig { params(iterations: Integer).void }
2309
1941
  def initialize(iterations: nil); end
2310
1942
  end
@@ -2313,37 +1945,29 @@ module Stripe
2313
1945
  returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance))
2314
1946
  }
2315
1947
  attr_accessor :bill_on_acceptance
2316
-
2317
1948
  # 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.
2318
1949
  sig { returns(String) }
2319
1950
  attr_accessor :billing_behavior
2320
-
2321
1951
  # When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
2322
1952
  sig { returns(T.nilable(String)) }
2323
1953
  attr_accessor :billing_cycle_anchor
2324
-
2325
1954
  # The subscription's 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.
2326
1955
  sig { returns(T.nilable(String)) }
2327
1956
  attr_accessor :description
2328
-
2329
1957
  # When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
2330
1958
  sig { returns(T.nilable(T.any(String, Integer))) }
2331
1959
  attr_accessor :effective_date
2332
-
2333
1960
  # Behavior of the subscription schedule and underlying subscription when it ends.
2334
1961
  sig { returns(String) }
2335
1962
  attr_accessor :end_behavior
2336
-
2337
1963
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
2338
1964
  sig { returns(T::Hash[String, String]) }
2339
1965
  attr_accessor :metadata
2340
-
2341
1966
  # If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
2342
1967
  sig {
2343
1968
  returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::Prebilling))
2344
1969
  }
2345
1970
  attr_accessor :prebilling
2346
-
2347
1971
  # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
2348
1972
  #
2349
1973
  # When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
@@ -2353,11 +1977,9 @@ module Stripe
2353
1977
  # Prorations can be disabled by passing `none`.
2354
1978
  sig { returns(String) }
2355
1979
  attr_accessor :proration_behavior
2356
-
2357
1980
  # Integer representing the number of trial period days before the customer is charged for the first time.
2358
1981
  sig { returns(T.nilable(Integer)) }
2359
1982
  attr_accessor :trial_period_days
2360
-
2361
1983
  sig {
2362
1984
  params(bill_on_acceptance: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::BillOnAcceptance), billing_behavior: String, billing_cycle_anchor: T.nilable(String), description: T.nilable(String), effective_date: T.nilable(T.any(String, Integer)), end_behavior: String, metadata: T::Hash[String, String], prebilling: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionData::Prebilling), proration_behavior: String, trial_period_days: T.nilable(Integer)).void
2363
1985
  }
@@ -2379,15 +2001,12 @@ module Stripe
2379
2001
  # A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
2380
2002
  sig { returns(String) }
2381
2003
  attr_accessor :new_reference
2382
-
2383
2004
  # The ID of the schedule the line applies to.
2384
2005
  sig { returns(String) }
2385
2006
  attr_accessor :subscription_schedule
2386
-
2387
2007
  # Describes whether the quote line is affecting a new schedule or an existing schedule.
2388
2008
  sig { returns(String) }
2389
2009
  attr_accessor :type
2390
-
2391
2010
  sig { params(new_reference: String, subscription_schedule: String, type: String).void }
2392
2011
  def initialize(new_reference: nil, subscription_schedule: nil, type: nil); end
2393
2012
  end
@@ -2397,11 +2016,9 @@ module Stripe
2397
2016
  # The ID of a quote line.
2398
2017
  sig { returns(String) }
2399
2018
  attr_accessor :id
2400
-
2401
2019
  # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2402
2020
  sig { returns(Integer) }
2403
2021
  attr_accessor :index
2404
-
2405
2022
  sig { params(id: String, index: Integer).void }
2406
2023
  def initialize(id: nil, index: nil); end
2407
2024
  end
@@ -2410,15 +2027,12 @@ module Stripe
2410
2027
  returns(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt)
2411
2028
  }
2412
2029
  attr_accessor :line_starts_at
2413
-
2414
2030
  # A precise Unix timestamp.
2415
2031
  sig { returns(Integer) }
2416
2032
  attr_accessor :timestamp
2417
-
2418
2033
  # The type of method to specify the `bill_from` time.
2419
2034
  sig { returns(String) }
2420
2035
  attr_accessor :type
2421
-
2422
2036
  sig {
2423
2037
  params(line_starts_at: ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom::LineStartsAt, timestamp: Integer, type: String).void
2424
2038
  }
@@ -2429,11 +2043,9 @@ module Stripe
2429
2043
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2430
2044
  sig { returns(String) }
2431
2045
  attr_accessor :interval
2432
-
2433
2046
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2434
2047
  sig { returns(Integer) }
2435
2048
  attr_accessor :interval_count
2436
-
2437
2049
  sig { params(interval: String, interval_count: Integer).void }
2438
2050
  def initialize(interval: nil, interval_count: nil); end
2439
2051
  end
@@ -2441,11 +2053,9 @@ module Stripe
2441
2053
  # The ID of a quote line.
2442
2054
  sig { returns(String) }
2443
2055
  attr_accessor :id
2444
-
2445
2056
  # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2446
2057
  sig { returns(Integer) }
2447
2058
  attr_accessor :index
2448
-
2449
2059
  sig { params(id: String, index: Integer).void }
2450
2060
  def initialize(id: nil, index: nil); end
2451
2061
  end
@@ -2454,21 +2064,17 @@ module Stripe
2454
2064
  returns(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration)
2455
2065
  }
2456
2066
  attr_accessor :duration
2457
-
2458
2067
  # Details of a Quote line item from which to bill until.
2459
2068
  sig {
2460
2069
  returns(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt)
2461
2070
  }
2462
2071
  attr_accessor :line_ends_at
2463
-
2464
2072
  # A precise Unix timestamp.
2465
2073
  sig { returns(Integer) }
2466
2074
  attr_accessor :timestamp
2467
-
2468
2075
  # The type of method to specify the `bill_until` time.
2469
2076
  sig { returns(String) }
2470
2077
  attr_accessor :type
2471
-
2472
2078
  sig {
2473
2079
  params(duration: ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::Duration, line_ends_at: ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil::LineEndsAt, timestamp: Integer, type: String).void
2474
2080
  }
@@ -2479,13 +2085,11 @@ module Stripe
2479
2085
  returns(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom)
2480
2086
  }
2481
2087
  attr_accessor :bill_from
2482
-
2483
2088
  # The end of the period to bill until when the Quote is accepted.
2484
2089
  sig {
2485
2090
  returns(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil)
2486
2091
  }
2487
2092
  attr_accessor :bill_until
2488
-
2489
2093
  sig {
2490
2094
  params(bill_from: ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillFrom, bill_until: ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance::BillUntil).void
2491
2095
  }
@@ -2494,29 +2098,23 @@ module Stripe
2494
2098
  # Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
2495
2099
  sig { returns(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::AppliesTo) }
2496
2100
  attr_accessor :applies_to
2497
-
2498
2101
  # Describes the period to bill for upon accepting the quote.
2499
2102
  sig {
2500
2103
  returns(T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance))
2501
2104
  }
2502
2105
  attr_accessor :bill_on_acceptance
2503
-
2504
2106
  # 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.
2505
2107
  sig { returns(String) }
2506
2108
  attr_accessor :billing_behavior
2507
-
2508
2109
  # The customer the Subscription Data override applies to.
2509
2110
  sig { returns(String) }
2510
2111
  attr_accessor :customer
2511
-
2512
2112
  # The subscription's 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.
2513
2113
  sig { returns(T.nilable(String)) }
2514
2114
  attr_accessor :description
2515
-
2516
2115
  # Behavior of the subscription schedule and underlying subscription when it ends.
2517
2116
  sig { returns(String) }
2518
2117
  attr_accessor :end_behavior
2519
-
2520
2118
  # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
2521
2119
  #
2522
2120
  # When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
@@ -2526,7 +2124,6 @@ module Stripe
2526
2124
  # Prorations can be disabled by passing `none`.
2527
2125
  sig { returns(String) }
2528
2126
  attr_accessor :proration_behavior
2529
-
2530
2127
  sig {
2531
2128
  params(applies_to: ::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::AppliesTo, bill_on_acceptance: T.nilable(::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride::BillOnAcceptance), billing_behavior: String, customer: String, description: T.nilable(String), end_behavior: String, proration_behavior: String).void
2532
2129
  }
@@ -2544,104 +2141,80 @@ module Stripe
2544
2141
  # The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
2545
2142
  sig { returns(Integer) }
2546
2143
  attr_accessor :amount
2547
-
2548
2144
  # 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. There must be at least 1 line item with a recurring price to use this field.
2549
2145
  sig { returns(Float) }
2550
2146
  attr_accessor :amount_percent
2551
-
2552
2147
  # ID of an existing, connected Stripe account.
2553
2148
  sig { returns(String) }
2554
2149
  attr_accessor :destination
2555
-
2556
2150
  sig { params(amount: Integer, amount_percent: Float, destination: String).void }
2557
2151
  def initialize(amount: nil, amount_percent: nil, destination: nil); end
2558
2152
  end
2559
2153
  # Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
2560
2154
  sig { returns(T::Boolean) }
2561
2155
  attr_accessor :allow_backdated_lines
2562
-
2563
2156
  # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
2564
2157
  sig { returns(T.nilable(Integer)) }
2565
2158
  attr_accessor :application_fee_amount
2566
-
2567
2159
  # 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. There must be at least 1 line item with a recurring price to use this field.
2568
2160
  sig { returns(T.nilable(Float)) }
2569
2161
  attr_accessor :application_fee_percent
2570
-
2571
2162
  # Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
2572
2163
  sig { returns(::Stripe::QuoteService::UpdateParams::AutomaticTax) }
2573
2164
  attr_accessor :automatic_tax
2574
-
2575
2165
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or 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`.
2576
2166
  sig { returns(String) }
2577
2167
  attr_accessor :collection_method
2578
-
2579
2168
  # The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
2580
2169
  sig { returns(String) }
2581
2170
  attr_accessor :customer
2582
-
2583
2171
  # The tax rates that will apply to any line item that does not have `tax_rates` set.
2584
2172
  sig { returns(T.nilable(T::Array[String])) }
2585
2173
  attr_accessor :default_tax_rates
2586
-
2587
2174
  # A description that will be displayed on the quote PDF.
2588
2175
  sig { returns(T.nilable(String)) }
2589
2176
  attr_accessor :description
2590
-
2591
2177
  # The discounts applied to the quote.
2592
2178
  sig { returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Discount])) }
2593
2179
  attr_accessor :discounts
2594
-
2595
2180
  # Specifies which fields in the response should be expanded.
2596
2181
  sig { returns(T::Array[String]) }
2597
2182
  attr_accessor :expand
2598
-
2599
2183
  # A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
2600
2184
  sig { returns(Integer) }
2601
2185
  attr_accessor :expires_at
2602
-
2603
2186
  # A footer that will be displayed on the quote PDF.
2604
2187
  sig { returns(T.nilable(String)) }
2605
2188
  attr_accessor :footer
2606
-
2607
2189
  # A header that will be displayed on the quote PDF.
2608
2190
  sig { returns(T.nilable(String)) }
2609
2191
  attr_accessor :header
2610
-
2611
2192
  # All invoices will be billed using the specified settings.
2612
2193
  sig { returns(::Stripe::QuoteService::UpdateParams::InvoiceSettings) }
2613
2194
  attr_accessor :invoice_settings
2614
-
2615
2195
  # A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
2616
2196
  sig { returns(T::Array[::Stripe::QuoteService::UpdateParams::LineItem]) }
2617
2197
  attr_accessor :line_items
2618
-
2619
2198
  # A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
2620
2199
  sig { returns(T::Array[::Stripe::QuoteService::UpdateParams::Line]) }
2621
2200
  attr_accessor :lines
2622
-
2623
2201
  # 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`.
2624
2202
  sig { returns(T::Hash[String, String]) }
2625
2203
  attr_accessor :metadata
2626
-
2627
2204
  # The account on behalf of which to charge.
2628
2205
  sig { returns(T.nilable(String)) }
2629
2206
  attr_accessor :on_behalf_of
2630
-
2631
2207
  # When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
2632
2208
  sig { returns(::Stripe::QuoteService::UpdateParams::SubscriptionData) }
2633
2209
  attr_accessor :subscription_data
2634
-
2635
2210
  # List representing overrides for `subscription_data` configurations for specific subscription schedules.
2636
2211
  sig {
2637
2212
  returns(T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride]))
2638
2213
  }
2639
2214
  attr_accessor :subscription_data_overrides
2640
-
2641
2215
  # The data with which to automatically create a Transfer for each of the invoices.
2642
2216
  sig { returns(T.nilable(::Stripe::QuoteService::UpdateParams::TransferData)) }
2643
2217
  attr_accessor :transfer_data
2644
-
2645
2218
  sig {
2646
2219
  params(allow_backdated_lines: T::Boolean, application_fee_amount: T.nilable(Integer), application_fee_percent: T.nilable(Float), automatic_tax: ::Stripe::QuoteService::UpdateParams::AutomaticTax, collection_method: String, customer: String, default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::Discount]), expand: T::Array[String], expires_at: Integer, footer: T.nilable(String), header: T.nilable(String), invoice_settings: ::Stripe::QuoteService::UpdateParams::InvoiceSettings, line_items: T::Array[::Stripe::QuoteService::UpdateParams::LineItem], lines: T::Array[::Stripe::QuoteService::UpdateParams::Line], metadata: T::Hash[String, String], on_behalf_of: T.nilable(String), subscription_data: ::Stripe::QuoteService::UpdateParams::SubscriptionData, subscription_data_overrides: T.nilable(T::Array[::Stripe::QuoteService::UpdateParams::SubscriptionDataOverride]), transfer_data: T.nilable(::Stripe::QuoteService::UpdateParams::TransferData)).void
2647
2220
  }
@@ -2673,7 +2246,6 @@ module Stripe
2673
2246
  # Specifies which fields in the response should be expanded.
2674
2247
  sig { returns(T::Array[String]) }
2675
2248
  attr_accessor :expand
2676
-
2677
2249
  sig { params(expand: T::Array[String]).void }
2678
2250
  def initialize(expand: nil); end
2679
2251
  end
@@ -2681,7 +2253,6 @@ module Stripe
2681
2253
  # Specifies which fields in the response should be expanded.
2682
2254
  sig { returns(T::Array[String]) }
2683
2255
  attr_accessor :expand
2684
-
2685
2256
  sig { params(expand: T::Array[String]).void }
2686
2257
  def initialize(expand: nil); end
2687
2258
  end
@@ -2689,11 +2260,9 @@ module Stripe
2689
2260
  # Specifies which fields in the response should be expanded.
2690
2261
  sig { returns(T::Array[String]) }
2691
2262
  attr_accessor :expand
2692
-
2693
2263
  # A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
2694
2264
  sig { returns(Integer) }
2695
2265
  attr_accessor :expires_at
2696
-
2697
2266
  sig { params(expand: T::Array[String], expires_at: Integer).void }
2698
2267
  def initialize(expand: nil, expires_at: nil); end
2699
2268
  end
@@ -2701,7 +2270,6 @@ module Stripe
2701
2270
  # Specifies which fields in the response should be expanded.
2702
2271
  sig { returns(T::Array[String]) }
2703
2272
  attr_accessor :expand
2704
-
2705
2273
  sig { params(expand: T::Array[String]).void }
2706
2274
  def initialize(expand: nil); end
2707
2275
  end
@@ -2709,11 +2277,9 @@ module Stripe
2709
2277
  # Specifies which fields in the response should be expanded.
2710
2278
  sig { returns(T::Array[String]) }
2711
2279
  attr_accessor :expand
2712
-
2713
2280
  # Reason the Quote is being marked stale.
2714
2281
  sig { returns(String) }
2715
2282
  attr_accessor :reason
2716
-
2717
2283
  sig { params(expand: T::Array[String], reason: String).void }
2718
2284
  def initialize(expand: nil, reason: nil); end
2719
2285
  end
@@ -2721,7 +2287,6 @@ module Stripe
2721
2287
  # Specifies which fields in the response should be expanded.
2722
2288
  sig { returns(T::Array[String]) }
2723
2289
  attr_accessor :expand
2724
-
2725
2290
  sig { params(expand: T::Array[String]).void }
2726
2291
  def initialize(expand: nil); end
2727
2292
  end
@@ -2729,7 +2294,6 @@ module Stripe
2729
2294
  # Specifies which fields in the response should be expanded.
2730
2295
  sig { returns(T::Array[String]) }
2731
2296
  attr_accessor :expand
2732
-
2733
2297
  sig { params(expand: T::Array[String]).void }
2734
2298
  def initialize(expand: nil); end
2735
2299
  end
@@ -2737,19 +2301,15 @@ module Stripe
2737
2301
  # 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.
2738
2302
  sig { returns(String) }
2739
2303
  attr_accessor :ending_before
2740
-
2741
2304
  # Specifies which fields in the response should be expanded.
2742
2305
  sig { returns(T::Array[String]) }
2743
2306
  attr_accessor :expand
2744
-
2745
2307
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
2746
2308
  sig { returns(Integer) }
2747
2309
  attr_accessor :limit
2748
-
2749
2310
  # 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.
2750
2311
  sig { returns(String) }
2751
2312
  attr_accessor :starting_after
2752
-
2753
2313
  sig {
2754
2314
  params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
2755
2315
  }