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
@@ -9,19 +9,15 @@ module Stripe
9
9
  # Minimum value to filter by (exclusive)
10
10
  sig { returns(Integer) }
11
11
  attr_accessor :gt
12
-
13
12
  # Minimum value to filter by (inclusive)
14
13
  sig { returns(Integer) }
15
14
  attr_accessor :gte
16
-
17
15
  # Maximum value to filter by (exclusive)
18
16
  sig { returns(Integer) }
19
17
  attr_accessor :lt
20
-
21
18
  # Maximum value to filter by (inclusive)
22
19
  sig { returns(Integer) }
23
20
  attr_accessor :lte
24
-
25
21
  sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
26
22
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
27
23
  end
@@ -29,19 +25,15 @@ module Stripe
29
25
  # Minimum value to filter by (exclusive)
30
26
  sig { returns(Integer) }
31
27
  attr_accessor :gt
32
-
33
28
  # Minimum value to filter by (inclusive)
34
29
  sig { returns(Integer) }
35
30
  attr_accessor :gte
36
-
37
31
  # Maximum value to filter by (exclusive)
38
32
  sig { returns(Integer) }
39
33
  attr_accessor :lt
40
-
41
34
  # Maximum value to filter by (inclusive)
42
35
  sig { returns(Integer) }
43
36
  attr_accessor :lte
44
-
45
37
  sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
46
38
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
47
39
  end
@@ -49,19 +41,15 @@ module Stripe
49
41
  # Minimum value to filter by (exclusive)
50
42
  sig { returns(Integer) }
51
43
  attr_accessor :gt
52
-
53
44
  # Minimum value to filter by (inclusive)
54
45
  sig { returns(Integer) }
55
46
  attr_accessor :gte
56
-
57
47
  # Maximum value to filter by (exclusive)
58
48
  sig { returns(Integer) }
59
49
  attr_accessor :lt
60
-
61
50
  # Maximum value to filter by (inclusive)
62
51
  sig { returns(Integer) }
63
52
  attr_accessor :lte
64
-
65
53
  sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
66
54
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
67
55
  end
@@ -69,64 +57,50 @@ module Stripe
69
57
  # Minimum value to filter by (exclusive)
70
58
  sig { returns(Integer) }
71
59
  attr_accessor :gt
72
-
73
60
  # Minimum value to filter by (inclusive)
74
61
  sig { returns(Integer) }
75
62
  attr_accessor :gte
76
-
77
63
  # Maximum value to filter by (exclusive)
78
64
  sig { returns(Integer) }
79
65
  attr_accessor :lt
80
-
81
66
  # Maximum value to filter by (inclusive)
82
67
  sig { returns(Integer) }
83
68
  attr_accessor :lte
84
-
85
69
  sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
86
70
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
87
71
  end
88
72
  # Only return subscription schedules that were created canceled the given date interval.
89
73
  sig { returns(T.any(::Stripe::SubscriptionScheduleService::ListParams::CanceledAt, Integer)) }
90
74
  attr_accessor :canceled_at
91
-
92
75
  # Only return subscription schedules that completed during the given date interval.
93
76
  sig {
94
77
  returns(T.any(::Stripe::SubscriptionScheduleService::ListParams::CompletedAt, Integer))
95
78
  }
96
79
  attr_accessor :completed_at
97
-
98
80
  # Only return subscription schedules that were created during the given date interval.
99
81
  sig { returns(T.any(::Stripe::SubscriptionScheduleService::ListParams::Created, Integer)) }
100
82
  attr_accessor :created
101
-
102
83
  # Only return subscription schedules for the given customer.
103
84
  sig { returns(String) }
104
85
  attr_accessor :customer
105
-
106
86
  # 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.
107
87
  sig { returns(String) }
108
88
  attr_accessor :ending_before
109
-
110
89
  # Specifies which fields in the response should be expanded.
111
90
  sig { returns(T::Array[String]) }
112
91
  attr_accessor :expand
113
-
114
92
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
115
93
  sig { returns(Integer) }
116
94
  attr_accessor :limit
117
-
118
95
  # Only return subscription schedules that were released during the given date interval.
119
96
  sig { returns(T.any(::Stripe::SubscriptionScheduleService::ListParams::ReleasedAt, Integer)) }
120
97
  attr_accessor :released_at
121
-
122
98
  # Only return subscription schedules that have not started yet.
123
99
  sig { returns(T::Boolean) }
124
100
  attr_accessor :scheduled
125
-
126
101
  # 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.
127
102
  sig { returns(String) }
128
103
  attr_accessor :starting_after
129
-
130
104
  sig {
131
105
  params(canceled_at: T.any(::Stripe::SubscriptionScheduleService::ListParams::CanceledAt, Integer), completed_at: T.any(::Stripe::SubscriptionScheduleService::ListParams::CompletedAt, Integer), created: T.any(::Stripe::SubscriptionScheduleService::ListParams::Created, Integer), customer: String, ending_before: String, expand: T::Array[String], limit: Integer, released_at: T.any(::Stripe::SubscriptionScheduleService::ListParams::ReleasedAt, Integer), scheduled: T::Boolean, starting_after: String).void
132
106
  }
@@ -150,24 +124,20 @@ module Stripe
150
124
  # The connected account being referenced when `type` is `account`.
151
125
  sig { returns(String) }
152
126
  attr_accessor :account
153
-
154
127
  # Type of the account referenced in the request.
155
128
  sig { returns(String) }
156
129
  attr_accessor :type
157
-
158
130
  sig { params(account: String, type: String).void }
159
131
  def initialize(account: nil, type: nil); end
160
132
  end
161
133
  # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
162
134
  sig { returns(T::Boolean) }
163
135
  attr_accessor :enabled
164
-
165
136
  # 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.
166
137
  sig {
167
138
  returns(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax::Liability)
168
139
  }
169
140
  attr_accessor :liability
170
-
171
141
  sig {
172
142
  params(enabled: T::Boolean, liability: ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax::Liability).void
173
143
  }
@@ -177,11 +147,9 @@ module Stripe
177
147
  # Monetary threshold that triggers the subscription to advance to a new billing period
178
148
  sig { returns(Integer) }
179
149
  attr_accessor :amount_gte
180
-
181
150
  # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
182
151
  sig { returns(T::Boolean) }
183
152
  attr_accessor :reset_billing_cycle_anchor
184
-
185
153
  sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
186
154
  def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
187
155
  end
@@ -190,28 +158,23 @@ module Stripe
190
158
  # The connected account being referenced when `type` is `account`.
191
159
  sig { returns(String) }
192
160
  attr_accessor :account
193
-
194
161
  # Type of the account referenced in the request.
195
162
  sig { returns(String) }
196
163
  attr_accessor :type
197
-
198
164
  sig { params(account: String, type: String).void }
199
165
  def initialize(account: nil, type: nil); end
200
166
  end
201
167
  # The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
202
168
  sig { returns(T.nilable(T::Array[String])) }
203
169
  attr_accessor :account_tax_ids
204
-
205
170
  # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
206
171
  sig { returns(Integer) }
207
172
  attr_accessor :days_until_due
208
-
209
173
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
210
174
  sig {
211
175
  returns(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings::Issuer)
212
176
  }
213
177
  attr_accessor :issuer
214
-
215
178
  sig {
216
179
  params(account_tax_ids: T.nilable(T::Array[String]), days_until_due: Integer, issuer: ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings::Issuer).void
217
180
  }
@@ -221,62 +184,50 @@ module Stripe
221
184
  # 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.
222
185
  sig { returns(Float) }
223
186
  attr_accessor :amount_percent
224
-
225
187
  # ID of an existing, connected Stripe account.
226
188
  sig { returns(String) }
227
189
  attr_accessor :destination
228
-
229
190
  sig { params(amount_percent: Float, destination: String).void }
230
191
  def initialize(amount_percent: nil, destination: nil); end
231
192
  end
232
193
  # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
233
194
  sig { returns(Float) }
234
195
  attr_accessor :application_fee_percent
235
-
236
196
  # Default settings for automatic tax computation.
237
197
  sig {
238
198
  returns(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax)
239
199
  }
240
200
  attr_accessor :automatic_tax
241
-
242
201
  # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
243
202
  sig { returns(String) }
244
203
  attr_accessor :billing_cycle_anchor
245
-
246
204
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
247
205
  sig {
248
206
  returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::BillingThresholds))
249
207
  }
250
208
  attr_accessor :billing_thresholds
251
-
252
209
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
253
210
  sig { returns(String) }
254
211
  attr_accessor :collection_method
255
-
256
212
  # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
257
213
  sig { returns(String) }
258
214
  attr_accessor :default_payment_method
259
-
260
215
  # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
261
216
  sig { returns(T.nilable(String)) }
262
217
  attr_accessor :description
263
-
264
218
  # All invoices will be billed using the specified settings.
265
219
  sig {
266
220
  returns(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings)
267
221
  }
268
222
  attr_accessor :invoice_settings
269
-
270
223
  # The account on behalf of which to charge, for each of the associated subscription's invoices.
271
224
  sig { returns(T.nilable(String)) }
272
225
  attr_accessor :on_behalf_of
273
-
274
226
  # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
275
227
  sig {
276
228
  returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::TransferData))
277
229
  }
278
230
  attr_accessor :transfer_data
279
-
280
231
  sig {
281
232
  params(application_fee_percent: Float, automatic_tax: ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::BillingThresholds), collection_method: String, default_payment_method: String, description: T.nilable(String), invoice_settings: ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings, on_behalf_of: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::TransferData)).void
282
233
  }
@@ -301,11 +252,9 @@ module Stripe
301
252
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
302
253
  sig { returns(String) }
303
254
  attr_accessor :interval
304
-
305
255
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
306
256
  sig { returns(Integer) }
307
257
  attr_accessor :interval_count
308
-
309
258
  sig { params(interval: String, interval_count: Integer).void }
310
259
  def initialize(interval: nil, interval_count: nil); end
311
260
  end
@@ -314,15 +263,12 @@ module Stripe
314
263
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)
315
264
  }
316
265
  attr_accessor :duration
317
-
318
266
  # A precise Unix timestamp for the discount to end. Must be in the future.
319
267
  sig { returns(Integer) }
320
268
  attr_accessor :timestamp
321
-
322
269
  # The type of calculation made to determine when the discount ends.
323
270
  sig { returns(String) }
324
271
  attr_accessor :type
325
-
326
272
  sig {
327
273
  params(duration: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
328
274
  }
@@ -331,21 +277,17 @@ module Stripe
331
277
  # ID of the coupon to create a new discount for.
332
278
  sig { returns(String) }
333
279
  attr_accessor :coupon
334
-
335
280
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
336
281
  sig { returns(String) }
337
282
  attr_accessor :discount
338
-
339
283
  # Details to determine how long the discount should be applied for.
340
284
  sig {
341
285
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd)
342
286
  }
343
287
  attr_accessor :discount_end
344
-
345
288
  # ID of the promotion code to create a new discount for.
346
289
  sig { returns(String) }
347
290
  attr_accessor :promotion_code
348
-
349
291
  sig {
350
292
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
351
293
  }
@@ -355,23 +297,18 @@ module Stripe
355
297
  # 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).
356
298
  sig { returns(String) }
357
299
  attr_accessor :currency
358
-
359
300
  # The ID of the product that this price will belong to.
360
301
  sig { returns(String) }
361
302
  attr_accessor :product
362
-
363
303
  # 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.
364
304
  sig { returns(String) }
365
305
  attr_accessor :tax_behavior
366
-
367
306
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
368
307
  sig { returns(Integer) }
369
308
  attr_accessor :unit_amount
370
-
371
309
  # 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.
372
310
  sig { returns(String) }
373
311
  attr_accessor :unit_amount_decimal
374
-
375
312
  sig {
376
313
  params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
377
314
  }
@@ -388,25 +325,20 @@ module Stripe
388
325
  returns(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount])
389
326
  }
390
327
  attr_accessor :discounts
391
-
392
328
  # The ID of the price object. One of `price` or `price_data` is required.
393
329
  sig { returns(String) }
394
330
  attr_accessor :price
395
-
396
331
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
397
332
  sig {
398
333
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::PriceData)
399
334
  }
400
335
  attr_accessor :price_data
401
-
402
336
  # Quantity for this item. Defaults to 1.
403
337
  sig { returns(Integer) }
404
338
  attr_accessor :quantity
405
-
406
339
  # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
407
340
  sig { returns(T.nilable(T::Array[String])) }
408
341
  attr_accessor :tax_rates
409
-
410
342
  sig {
411
343
  params(discounts: T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
412
344
  }
@@ -423,24 +355,20 @@ module Stripe
423
355
  # The connected account being referenced when `type` is `account`.
424
356
  sig { returns(String) }
425
357
  attr_accessor :account
426
-
427
358
  # Type of the account referenced in the request.
428
359
  sig { returns(String) }
429
360
  attr_accessor :type
430
-
431
361
  sig { params(account: String, type: String).void }
432
362
  def initialize(account: nil, type: nil); end
433
363
  end
434
364
  # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
435
365
  sig { returns(T::Boolean) }
436
366
  attr_accessor :enabled
437
-
438
367
  # 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.
439
368
  sig {
440
369
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax::Liability)
441
370
  }
442
371
  attr_accessor :liability
443
-
444
372
  sig {
445
373
  params(enabled: T::Boolean, liability: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax::Liability).void
446
374
  }
@@ -450,11 +378,9 @@ module Stripe
450
378
  # Monetary threshold that triggers the subscription to advance to a new billing period
451
379
  sig { returns(Integer) }
452
380
  attr_accessor :amount_gte
453
-
454
381
  # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
455
382
  sig { returns(T::Boolean) }
456
383
  attr_accessor :reset_billing_cycle_anchor
457
-
458
384
  sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
459
385
  def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
460
386
  end
@@ -464,11 +390,9 @@ module Stripe
464
390
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
465
391
  sig { returns(String) }
466
392
  attr_accessor :interval
467
-
468
393
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
469
394
  sig { returns(Integer) }
470
395
  attr_accessor :interval_count
471
-
472
396
  sig { params(interval: String, interval_count: Integer).void }
473
397
  def initialize(interval: nil, interval_count: nil); end
474
398
  end
@@ -477,15 +401,12 @@ module Stripe
477
401
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd::Duration)
478
402
  }
479
403
  attr_accessor :duration
480
-
481
404
  # A precise Unix timestamp for the discount to end. Must be in the future.
482
405
  sig { returns(Integer) }
483
406
  attr_accessor :timestamp
484
-
485
407
  # The type of calculation made to determine when the discount ends.
486
408
  sig { returns(String) }
487
409
  attr_accessor :type
488
-
489
410
  sig {
490
411
  params(duration: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
491
412
  }
@@ -494,21 +415,17 @@ module Stripe
494
415
  # ID of the coupon to create a new discount for.
495
416
  sig { returns(String) }
496
417
  attr_accessor :coupon
497
-
498
418
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
499
419
  sig { returns(String) }
500
420
  attr_accessor :discount
501
-
502
421
  # Details to determine how long the discount should be applied for.
503
422
  sig {
504
423
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd)
505
424
  }
506
425
  attr_accessor :discount_end
507
-
508
426
  # ID of the promotion code to create a new discount for.
509
427
  sig { returns(String) }
510
428
  attr_accessor :promotion_code
511
-
512
429
  sig {
513
430
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount::DiscountEnd, promotion_code: String).void
514
431
  }
@@ -519,28 +436,23 @@ module Stripe
519
436
  # The connected account being referenced when `type` is `account`.
520
437
  sig { returns(String) }
521
438
  attr_accessor :account
522
-
523
439
  # Type of the account referenced in the request.
524
440
  sig { returns(String) }
525
441
  attr_accessor :type
526
-
527
442
  sig { params(account: String, type: String).void }
528
443
  def initialize(account: nil, type: nil); end
529
444
  end
530
445
  # The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
531
446
  sig { returns(T.nilable(T::Array[String])) }
532
447
  attr_accessor :account_tax_ids
533
-
534
448
  # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
535
449
  sig { returns(Integer) }
536
450
  attr_accessor :days_until_due
537
-
538
451
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
539
452
  sig {
540
453
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings::Issuer)
541
454
  }
542
455
  attr_accessor :issuer
543
-
544
456
  sig {
545
457
  params(account_tax_ids: T.nilable(T::Array[String]), days_until_due: Integer, issuer: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings::Issuer).void
546
458
  }
@@ -551,7 +463,6 @@ module Stripe
551
463
  # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
552
464
  sig { returns(Integer) }
553
465
  attr_accessor :usage_gte
554
-
555
466
  sig { params(usage_gte: Integer).void }
556
467
  def initialize(usage_gte: nil); end
557
468
  end
@@ -561,11 +472,9 @@ module Stripe
561
472
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
562
473
  sig { returns(String) }
563
474
  attr_accessor :interval
564
-
565
475
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
566
476
  sig { returns(Integer) }
567
477
  attr_accessor :interval_count
568
-
569
478
  sig { params(interval: String, interval_count: Integer).void }
570
479
  def initialize(interval: nil, interval_count: nil); end
571
480
  end
@@ -574,15 +483,12 @@ module Stripe
574
483
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd::Duration)
575
484
  }
576
485
  attr_accessor :duration
577
-
578
486
  # A precise Unix timestamp for the discount to end. Must be in the future.
579
487
  sig { returns(Integer) }
580
488
  attr_accessor :timestamp
581
-
582
489
  # The type of calculation made to determine when the discount ends.
583
490
  sig { returns(String) }
584
491
  attr_accessor :type
585
-
586
492
  sig {
587
493
  params(duration: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
588
494
  }
@@ -591,21 +497,17 @@ module Stripe
591
497
  # ID of the coupon to create a new discount for.
592
498
  sig { returns(String) }
593
499
  attr_accessor :coupon
594
-
595
500
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
596
501
  sig { returns(String) }
597
502
  attr_accessor :discount
598
-
599
503
  # Details to determine how long the discount should be applied for.
600
504
  sig {
601
505
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd)
602
506
  }
603
507
  attr_accessor :discount_end
604
-
605
508
  # ID of the promotion code to create a new discount for.
606
509
  sig { returns(String) }
607
510
  attr_accessor :promotion_code
608
-
609
511
  sig {
610
512
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount::DiscountEnd, promotion_code: String).void
611
513
  }
@@ -616,40 +518,32 @@ module Stripe
616
518
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
617
519
  sig { returns(String) }
618
520
  attr_accessor :interval
619
-
620
521
  # 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).
621
522
  sig { returns(Integer) }
622
523
  attr_accessor :interval_count
623
-
624
524
  sig { params(interval: String, interval_count: Integer).void }
625
525
  def initialize(interval: nil, interval_count: nil); end
626
526
  end
627
527
  # 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).
628
528
  sig { returns(String) }
629
529
  attr_accessor :currency
630
-
631
530
  # The ID of the product that this price will belong to.
632
531
  sig { returns(String) }
633
532
  attr_accessor :product
634
-
635
533
  # The recurring components of a price such as `interval` and `interval_count`.
636
534
  sig {
637
535
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData::Recurring)
638
536
  }
639
537
  attr_accessor :recurring
640
-
641
538
  # 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.
642
539
  sig { returns(String) }
643
540
  attr_accessor :tax_behavior
644
-
645
541
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
646
542
  sig { returns(Integer) }
647
543
  attr_accessor :unit_amount
648
-
649
544
  # 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.
650
545
  sig { returns(String) }
651
546
  attr_accessor :unit_amount_decimal
652
-
653
547
  sig {
654
548
  params(currency: String, product: String, recurring: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
655
549
  }
@@ -666,11 +560,9 @@ module Stripe
666
560
  # 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.
667
561
  sig { returns(T::Array[String]) }
668
562
  attr_accessor :converts_to
669
-
670
563
  # Determines the type of trial for this item.
671
564
  sig { returns(String) }
672
565
  attr_accessor :type
673
-
674
566
  sig { params(converts_to: T::Array[String], type: String).void }
675
567
  def initialize(converts_to: nil, type: nil); end
676
568
  end
@@ -679,43 +571,34 @@ module Stripe
679
571
  returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::BillingThresholds))
680
572
  }
681
573
  attr_accessor :billing_thresholds
682
-
683
574
  # The coupons to redeem into discounts for the subscription item.
684
575
  sig {
685
576
  returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount]))
686
577
  }
687
578
  attr_accessor :discounts
688
-
689
579
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
690
580
  sig { returns(T::Hash[String, String]) }
691
581
  attr_accessor :metadata
692
-
693
582
  # The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
694
583
  sig { returns(String) }
695
584
  attr_accessor :plan
696
-
697
585
  # The ID of the price object.
698
586
  sig { returns(String) }
699
587
  attr_accessor :price
700
-
701
588
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
702
589
  sig {
703
590
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData)
704
591
  }
705
592
  attr_accessor :price_data
706
-
707
593
  # Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
708
594
  sig { returns(Integer) }
709
595
  attr_accessor :quantity
710
-
711
596
  # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
712
597
  sig { returns(T.nilable(T::Array[String])) }
713
598
  attr_accessor :tax_rates
714
-
715
599
  # Options that configure the trial on the subscription item.
716
600
  sig { returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Trial) }
717
601
  attr_accessor :trial
718
-
719
602
  sig {
720
603
  params(billing_thresholds: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::BillingThresholds), discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount]), metadata: T::Hash[String, String], plan: String, price: String, price_data: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String]), trial: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Trial).void
721
604
  }
@@ -735,7 +618,6 @@ module Stripe
735
618
  # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
736
619
  sig { returns(String) }
737
620
  attr_accessor :behavior
738
-
739
621
  sig { params(behavior: String).void }
740
622
  def initialize(behavior: nil); end
741
623
  end
@@ -743,11 +625,9 @@ module Stripe
743
625
  # 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.
744
626
  sig { returns(Float) }
745
627
  attr_accessor :amount_percent
746
-
747
628
  # ID of an existing, connected Stripe account.
748
629
  sig { returns(String) }
749
630
  attr_accessor :destination
750
-
751
631
  sig { params(amount_percent: Float, destination: String).void }
752
632
  def initialize(amount_percent: nil, destination: nil); end
753
633
  end
@@ -756,7 +636,6 @@ module Stripe
756
636
  # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
757
637
  sig { returns(String) }
758
638
  attr_accessor :prorate_up_front
759
-
760
639
  sig { params(prorate_up_front: String).void }
761
640
  def initialize(prorate_up_front: nil); end
762
641
  end
@@ -765,7 +644,6 @@ module Stripe
765
644
  returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings::EndBehavior)
766
645
  }
767
646
  attr_accessor :end_behavior
768
-
769
647
  sig {
770
648
  params(end_behavior: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings::EndBehavior).void
771
649
  }
@@ -776,107 +654,82 @@ module Stripe
776
654
  returns(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem])
777
655
  }
778
656
  attr_accessor :add_invoice_items
779
-
780
657
  # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
781
658
  sig { returns(Float) }
782
659
  attr_accessor :application_fee_percent
783
-
784
660
  # Automatic tax settings for this phase.
785
661
  sig { returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax) }
786
662
  attr_accessor :automatic_tax
787
-
788
663
  # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
789
664
  sig { returns(String) }
790
665
  attr_accessor :billing_cycle_anchor
791
-
792
666
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
793
667
  sig {
794
668
  returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::BillingThresholds))
795
669
  }
796
670
  attr_accessor :billing_thresholds
797
-
798
671
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
799
672
  sig { returns(String) }
800
673
  attr_accessor :collection_method
801
-
802
674
  # The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
803
675
  sig { returns(String) }
804
676
  attr_accessor :coupon
805
-
806
677
  # 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).
807
678
  sig { returns(String) }
808
679
  attr_accessor :currency
809
-
810
680
  # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
811
681
  sig { returns(String) }
812
682
  attr_accessor :default_payment_method
813
-
814
683
  # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
815
684
  sig { returns(T.nilable(T::Array[String])) }
816
685
  attr_accessor :default_tax_rates
817
-
818
686
  # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
819
687
  sig { returns(T.nilable(String)) }
820
688
  attr_accessor :description
821
-
822
689
  # The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
823
690
  sig {
824
691
  returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount]))
825
692
  }
826
693
  attr_accessor :discounts
827
-
828
694
  # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
829
695
  sig { returns(Integer) }
830
696
  attr_accessor :end_date
831
-
832
697
  # All invoices will be billed using the specified settings.
833
698
  sig { returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings) }
834
699
  attr_accessor :invoice_settings
835
-
836
700
  # List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
837
701
  sig { returns(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item]) }
838
702
  attr_accessor :items
839
-
840
703
  # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
841
704
  sig { returns(Integer) }
842
705
  attr_accessor :iterations
843
-
844
706
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
845
707
  sig { returns(T::Hash[String, String]) }
846
708
  attr_accessor :metadata
847
-
848
709
  # The account on behalf of which to charge, for each of the associated subscription's invoices.
849
710
  sig { returns(String) }
850
711
  attr_accessor :on_behalf_of
851
-
852
712
  # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
853
713
  sig { returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::PauseCollection) }
854
714
  attr_accessor :pause_collection
855
-
856
715
  # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
857
716
  sig { returns(String) }
858
717
  attr_accessor :proration_behavior
859
-
860
718
  # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
861
719
  sig { returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TransferData) }
862
720
  attr_accessor :transfer_data
863
-
864
721
  # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
865
722
  sig { returns(T::Boolean) }
866
723
  attr_accessor :trial
867
-
868
724
  # Specify trial behavior when crossing phase boundaries
869
725
  sig { returns(String) }
870
726
  attr_accessor :trial_continuation
871
-
872
727
  # Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
873
728
  sig { returns(Integer) }
874
729
  attr_accessor :trial_end
875
-
876
730
  # Settings related to subscription trials.
877
731
  sig { returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings) }
878
732
  attr_accessor :trial_settings
879
-
880
733
  sig {
881
734
  params(add_invoice_items: T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem], application_fee_percent: Float, automatic_tax: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::BillingThresholds), collection_method: String, coupon: String, currency: String, default_payment_method: String, default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount]), end_date: Integer, invoice_settings: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings, items: T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item], iterations: Integer, metadata: T::Hash[String, String], on_behalf_of: String, pause_collection: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::PauseCollection, proration_behavior: String, transfer_data: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::TransferData, trial: T::Boolean, trial_continuation: String, trial_end: Integer, trial_settings: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::TrialSettings).void
882
735
  }
@@ -912,54 +765,42 @@ module Stripe
912
765
  # This is used to determine the number of billing cycles to prebill.
913
766
  sig { returns(Integer) }
914
767
  attr_accessor :iterations
915
-
916
768
  # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
917
769
  sig { returns(String) }
918
770
  attr_accessor :update_behavior
919
-
920
771
  sig { params(iterations: Integer, update_behavior: String).void }
921
772
  def initialize(iterations: nil, update_behavior: nil); end
922
773
  end
923
774
  # 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.
924
775
  sig { returns(String) }
925
776
  attr_accessor :billing_behavior
926
-
927
777
  # The identifier of the customer to create the subscription schedule for.
928
778
  sig { returns(String) }
929
779
  attr_accessor :customer
930
-
931
780
  # Object representing the subscription schedule's default settings.
932
781
  sig { returns(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings) }
933
782
  attr_accessor :default_settings
934
-
935
783
  # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
936
784
  sig { returns(String) }
937
785
  attr_accessor :end_behavior
938
-
939
786
  # Specifies which fields in the response should be expanded.
940
787
  sig { returns(T::Array[String]) }
941
788
  attr_accessor :expand
942
-
943
789
  # Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
944
790
  sig { returns(String) }
945
791
  attr_accessor :from_subscription
946
-
947
792
  # 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`.
948
793
  sig { returns(T.nilable(T::Hash[String, String])) }
949
794
  attr_accessor :metadata
950
-
951
795
  # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
952
796
  sig { returns(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase]) }
953
797
  attr_accessor :phases
954
-
955
798
  # If specified, the invoicing for the given billing cycle iterations will be processed now.
956
799
  sig { returns(::Stripe::SubscriptionScheduleService::CreateParams::Prebilling) }
957
800
  attr_accessor :prebilling
958
-
959
801
  # When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
960
802
  sig { returns(T.any(Integer, String)) }
961
803
  attr_accessor :start_date
962
-
963
804
  sig {
964
805
  params(billing_behavior: String, customer: String, default_settings: ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings, end_behavior: String, expand: T::Array[String], from_subscription: String, metadata: T.nilable(T::Hash[String, String]), phases: T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase], prebilling: ::Stripe::SubscriptionScheduleService::CreateParams::Prebilling, start_date: T.any(Integer, String)).void
965
806
  }
@@ -980,7 +821,6 @@ module Stripe
980
821
  # Specifies which fields in the response should be expanded.
981
822
  sig { returns(T::Array[String]) }
982
823
  attr_accessor :expand
983
-
984
824
  sig { params(expand: T::Array[String]).void }
985
825
  def initialize(expand: nil); end
986
826
  end
@@ -991,24 +831,20 @@ module Stripe
991
831
  # The connected account being referenced when `type` is `account`.
992
832
  sig { returns(String) }
993
833
  attr_accessor :account
994
-
995
834
  # Type of the account referenced in the request.
996
835
  sig { returns(String) }
997
836
  attr_accessor :type
998
-
999
837
  sig { params(account: String, type: String).void }
1000
838
  def initialize(account: nil, type: nil); end
1001
839
  end
1002
840
  # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
1003
841
  sig { returns(T::Boolean) }
1004
842
  attr_accessor :enabled
1005
-
1006
843
  # 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.
1007
844
  sig {
1008
845
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax::Liability)
1009
846
  }
1010
847
  attr_accessor :liability
1011
-
1012
848
  sig {
1013
849
  params(enabled: T::Boolean, liability: ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax::Liability).void
1014
850
  }
@@ -1018,11 +854,9 @@ module Stripe
1018
854
  # Monetary threshold that triggers the subscription to advance to a new billing period
1019
855
  sig { returns(Integer) }
1020
856
  attr_accessor :amount_gte
1021
-
1022
857
  # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
1023
858
  sig { returns(T::Boolean) }
1024
859
  attr_accessor :reset_billing_cycle_anchor
1025
-
1026
860
  sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
1027
861
  def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
1028
862
  end
@@ -1031,28 +865,23 @@ module Stripe
1031
865
  # The connected account being referenced when `type` is `account`.
1032
866
  sig { returns(String) }
1033
867
  attr_accessor :account
1034
-
1035
868
  # Type of the account referenced in the request.
1036
869
  sig { returns(String) }
1037
870
  attr_accessor :type
1038
-
1039
871
  sig { params(account: String, type: String).void }
1040
872
  def initialize(account: nil, type: nil); end
1041
873
  end
1042
874
  # The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
1043
875
  sig { returns(T.nilable(T::Array[String])) }
1044
876
  attr_accessor :account_tax_ids
1045
-
1046
877
  # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
1047
878
  sig { returns(Integer) }
1048
879
  attr_accessor :days_until_due
1049
-
1050
880
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1051
881
  sig {
1052
882
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings::Issuer)
1053
883
  }
1054
884
  attr_accessor :issuer
1055
-
1056
885
  sig {
1057
886
  params(account_tax_ids: T.nilable(T::Array[String]), days_until_due: Integer, issuer: ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings::Issuer).void
1058
887
  }
@@ -1062,62 +891,50 @@ module Stripe
1062
891
  # 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.
1063
892
  sig { returns(Float) }
1064
893
  attr_accessor :amount_percent
1065
-
1066
894
  # ID of an existing, connected Stripe account.
1067
895
  sig { returns(String) }
1068
896
  attr_accessor :destination
1069
-
1070
897
  sig { params(amount_percent: Float, destination: String).void }
1071
898
  def initialize(amount_percent: nil, destination: nil); end
1072
899
  end
1073
900
  # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
1074
901
  sig { returns(Float) }
1075
902
  attr_accessor :application_fee_percent
1076
-
1077
903
  # Default settings for automatic tax computation.
1078
904
  sig {
1079
905
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax)
1080
906
  }
1081
907
  attr_accessor :automatic_tax
1082
-
1083
908
  # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
1084
909
  sig { returns(String) }
1085
910
  attr_accessor :billing_cycle_anchor
1086
-
1087
911
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
1088
912
  sig {
1089
913
  returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::BillingThresholds))
1090
914
  }
1091
915
  attr_accessor :billing_thresholds
1092
-
1093
916
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
1094
917
  sig { returns(String) }
1095
918
  attr_accessor :collection_method
1096
-
1097
919
  # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
1098
920
  sig { returns(String) }
1099
921
  attr_accessor :default_payment_method
1100
-
1101
922
  # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1102
923
  sig { returns(T.nilable(String)) }
1103
924
  attr_accessor :description
1104
-
1105
925
  # All invoices will be billed using the specified settings.
1106
926
  sig {
1107
927
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings)
1108
928
  }
1109
929
  attr_accessor :invoice_settings
1110
-
1111
930
  # The account on behalf of which to charge, for each of the associated subscription's invoices.
1112
931
  sig { returns(T.nilable(String)) }
1113
932
  attr_accessor :on_behalf_of
1114
-
1115
933
  # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
1116
934
  sig {
1117
935
  returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::TransferData))
1118
936
  }
1119
937
  attr_accessor :transfer_data
1120
-
1121
938
  sig {
1122
939
  params(application_fee_percent: Float, automatic_tax: ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::BillingThresholds), collection_method: String, default_payment_method: String, description: T.nilable(String), invoice_settings: ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings, on_behalf_of: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::TransferData)).void
1123
940
  }
@@ -1142,11 +959,9 @@ module Stripe
1142
959
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1143
960
  sig { returns(String) }
1144
961
  attr_accessor :interval
1145
-
1146
962
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1147
963
  sig { returns(Integer) }
1148
964
  attr_accessor :interval_count
1149
-
1150
965
  sig { params(interval: String, interval_count: Integer).void }
1151
966
  def initialize(interval: nil, interval_count: nil); end
1152
967
  end
@@ -1155,15 +970,12 @@ module Stripe
1155
970
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)
1156
971
  }
1157
972
  attr_accessor :duration
1158
-
1159
973
  # A precise Unix timestamp for the discount to end. Must be in the future.
1160
974
  sig { returns(Integer) }
1161
975
  attr_accessor :timestamp
1162
-
1163
976
  # The type of calculation made to determine when the discount ends.
1164
977
  sig { returns(String) }
1165
978
  attr_accessor :type
1166
-
1167
979
  sig {
1168
980
  params(duration: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1169
981
  }
@@ -1172,21 +984,17 @@ module Stripe
1172
984
  # ID of the coupon to create a new discount for.
1173
985
  sig { returns(String) }
1174
986
  attr_accessor :coupon
1175
-
1176
987
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1177
988
  sig { returns(String) }
1178
989
  attr_accessor :discount
1179
-
1180
990
  # Details to determine how long the discount should be applied for.
1181
991
  sig {
1182
992
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd)
1183
993
  }
1184
994
  attr_accessor :discount_end
1185
-
1186
995
  # ID of the promotion code to create a new discount for.
1187
996
  sig { returns(String) }
1188
997
  attr_accessor :promotion_code
1189
-
1190
998
  sig {
1191
999
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
1192
1000
  }
@@ -1196,23 +1004,18 @@ module Stripe
1196
1004
  # 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).
1197
1005
  sig { returns(String) }
1198
1006
  attr_accessor :currency
1199
-
1200
1007
  # The ID of the product that this price will belong to.
1201
1008
  sig { returns(String) }
1202
1009
  attr_accessor :product
1203
-
1204
1010
  # 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.
1205
1011
  sig { returns(String) }
1206
1012
  attr_accessor :tax_behavior
1207
-
1208
1013
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
1209
1014
  sig { returns(Integer) }
1210
1015
  attr_accessor :unit_amount
1211
-
1212
1016
  # 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.
1213
1017
  sig { returns(String) }
1214
1018
  attr_accessor :unit_amount_decimal
1215
-
1216
1019
  sig {
1217
1020
  params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1218
1021
  }
@@ -1229,25 +1032,20 @@ module Stripe
1229
1032
  returns(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount])
1230
1033
  }
1231
1034
  attr_accessor :discounts
1232
-
1233
1035
  # The ID of the price object. One of `price` or `price_data` is required.
1234
1036
  sig { returns(String) }
1235
1037
  attr_accessor :price
1236
-
1237
1038
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
1238
1039
  sig {
1239
1040
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::PriceData)
1240
1041
  }
1241
1042
  attr_accessor :price_data
1242
-
1243
1043
  # Quantity for this item. Defaults to 1.
1244
1044
  sig { returns(Integer) }
1245
1045
  attr_accessor :quantity
1246
-
1247
1046
  # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
1248
1047
  sig { returns(T.nilable(T::Array[String])) }
1249
1048
  attr_accessor :tax_rates
1250
-
1251
1049
  sig {
1252
1050
  params(discounts: T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
1253
1051
  }
@@ -1264,24 +1062,20 @@ module Stripe
1264
1062
  # The connected account being referenced when `type` is `account`.
1265
1063
  sig { returns(String) }
1266
1064
  attr_accessor :account
1267
-
1268
1065
  # Type of the account referenced in the request.
1269
1066
  sig { returns(String) }
1270
1067
  attr_accessor :type
1271
-
1272
1068
  sig { params(account: String, type: String).void }
1273
1069
  def initialize(account: nil, type: nil); end
1274
1070
  end
1275
1071
  # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
1276
1072
  sig { returns(T::Boolean) }
1277
1073
  attr_accessor :enabled
1278
-
1279
1074
  # 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.
1280
1075
  sig {
1281
1076
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax::Liability)
1282
1077
  }
1283
1078
  attr_accessor :liability
1284
-
1285
1079
  sig {
1286
1080
  params(enabled: T::Boolean, liability: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax::Liability).void
1287
1081
  }
@@ -1291,11 +1085,9 @@ module Stripe
1291
1085
  # Monetary threshold that triggers the subscription to advance to a new billing period
1292
1086
  sig { returns(Integer) }
1293
1087
  attr_accessor :amount_gte
1294
-
1295
1088
  # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
1296
1089
  sig { returns(T::Boolean) }
1297
1090
  attr_accessor :reset_billing_cycle_anchor
1298
-
1299
1091
  sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
1300
1092
  def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
1301
1093
  end
@@ -1305,11 +1097,9 @@ module Stripe
1305
1097
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1306
1098
  sig { returns(String) }
1307
1099
  attr_accessor :interval
1308
-
1309
1100
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1310
1101
  sig { returns(Integer) }
1311
1102
  attr_accessor :interval_count
1312
-
1313
1103
  sig { params(interval: String, interval_count: Integer).void }
1314
1104
  def initialize(interval: nil, interval_count: nil); end
1315
1105
  end
@@ -1318,15 +1108,12 @@ module Stripe
1318
1108
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd::Duration)
1319
1109
  }
1320
1110
  attr_accessor :duration
1321
-
1322
1111
  # A precise Unix timestamp for the discount to end. Must be in the future.
1323
1112
  sig { returns(Integer) }
1324
1113
  attr_accessor :timestamp
1325
-
1326
1114
  # The type of calculation made to determine when the discount ends.
1327
1115
  sig { returns(String) }
1328
1116
  attr_accessor :type
1329
-
1330
1117
  sig {
1331
1118
  params(duration: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1332
1119
  }
@@ -1335,21 +1122,17 @@ module Stripe
1335
1122
  # ID of the coupon to create a new discount for.
1336
1123
  sig { returns(String) }
1337
1124
  attr_accessor :coupon
1338
-
1339
1125
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1340
1126
  sig { returns(String) }
1341
1127
  attr_accessor :discount
1342
-
1343
1128
  # Details to determine how long the discount should be applied for.
1344
1129
  sig {
1345
1130
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd)
1346
1131
  }
1347
1132
  attr_accessor :discount_end
1348
-
1349
1133
  # ID of the promotion code to create a new discount for.
1350
1134
  sig { returns(String) }
1351
1135
  attr_accessor :promotion_code
1352
-
1353
1136
  sig {
1354
1137
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount::DiscountEnd, promotion_code: String).void
1355
1138
  }
@@ -1360,28 +1143,23 @@ module Stripe
1360
1143
  # The connected account being referenced when `type` is `account`.
1361
1144
  sig { returns(String) }
1362
1145
  attr_accessor :account
1363
-
1364
1146
  # Type of the account referenced in the request.
1365
1147
  sig { returns(String) }
1366
1148
  attr_accessor :type
1367
-
1368
1149
  sig { params(account: String, type: String).void }
1369
1150
  def initialize(account: nil, type: nil); end
1370
1151
  end
1371
1152
  # The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
1372
1153
  sig { returns(T.nilable(T::Array[String])) }
1373
1154
  attr_accessor :account_tax_ids
1374
-
1375
1155
  # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
1376
1156
  sig { returns(Integer) }
1377
1157
  attr_accessor :days_until_due
1378
-
1379
1158
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1380
1159
  sig {
1381
1160
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings::Issuer)
1382
1161
  }
1383
1162
  attr_accessor :issuer
1384
-
1385
1163
  sig {
1386
1164
  params(account_tax_ids: T.nilable(T::Array[String]), days_until_due: Integer, issuer: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings::Issuer).void
1387
1165
  }
@@ -1392,7 +1170,6 @@ module Stripe
1392
1170
  # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
1393
1171
  sig { returns(Integer) }
1394
1172
  attr_accessor :usage_gte
1395
-
1396
1173
  sig { params(usage_gte: Integer).void }
1397
1174
  def initialize(usage_gte: nil); end
1398
1175
  end
@@ -1402,11 +1179,9 @@ module Stripe
1402
1179
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1403
1180
  sig { returns(String) }
1404
1181
  attr_accessor :interval
1405
-
1406
1182
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1407
1183
  sig { returns(Integer) }
1408
1184
  attr_accessor :interval_count
1409
-
1410
1185
  sig { params(interval: String, interval_count: Integer).void }
1411
1186
  def initialize(interval: nil, interval_count: nil); end
1412
1187
  end
@@ -1415,15 +1190,12 @@ module Stripe
1415
1190
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration)
1416
1191
  }
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::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1429
1201
  }
@@ -1432,21 +1204,17 @@ 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 {
1442
1212
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd)
1443
1213
  }
1444
1214
  attr_accessor :discount_end
1445
-
1446
1215
  # ID of the promotion code to create a new discount for.
1447
1216
  sig { returns(String) }
1448
1217
  attr_accessor :promotion_code
1449
-
1450
1218
  sig {
1451
1219
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount::DiscountEnd, promotion_code: String).void
1452
1220
  }
@@ -1457,40 +1225,32 @@ module Stripe
1457
1225
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1458
1226
  sig { returns(String) }
1459
1227
  attr_accessor :interval
1460
-
1461
1228
  # 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).
1462
1229
  sig { returns(Integer) }
1463
1230
  attr_accessor :interval_count
1464
-
1465
1231
  sig { params(interval: String, interval_count: Integer).void }
1466
1232
  def initialize(interval: nil, interval_count: nil); end
1467
1233
  end
1468
1234
  # 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).
1469
1235
  sig { returns(String) }
1470
1236
  attr_accessor :currency
1471
-
1472
1237
  # The ID of the product that this price will belong to.
1473
1238
  sig { returns(String) }
1474
1239
  attr_accessor :product
1475
-
1476
1240
  # The recurring components of a price such as `interval` and `interval_count`.
1477
1241
  sig {
1478
1242
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData::Recurring)
1479
1243
  }
1480
1244
  attr_accessor :recurring
1481
-
1482
1245
  # 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.
1483
1246
  sig { returns(String) }
1484
1247
  attr_accessor :tax_behavior
1485
-
1486
1248
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
1487
1249
  sig { returns(Integer) }
1488
1250
  attr_accessor :unit_amount
1489
-
1490
1251
  # 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.
1491
1252
  sig { returns(String) }
1492
1253
  attr_accessor :unit_amount_decimal
1493
-
1494
1254
  sig {
1495
1255
  params(currency: String, product: String, recurring: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1496
1256
  }
@@ -1507,11 +1267,9 @@ module Stripe
1507
1267
  # 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.
1508
1268
  sig { returns(T::Array[String]) }
1509
1269
  attr_accessor :converts_to
1510
-
1511
1270
  # Determines the type of trial for this item.
1512
1271
  sig { returns(String) }
1513
1272
  attr_accessor :type
1514
-
1515
1273
  sig { params(converts_to: T::Array[String], type: String).void }
1516
1274
  def initialize(converts_to: nil, type: nil); end
1517
1275
  end
@@ -1520,43 +1278,34 @@ module Stripe
1520
1278
  returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::BillingThresholds))
1521
1279
  }
1522
1280
  attr_accessor :billing_thresholds
1523
-
1524
1281
  # The coupons to redeem into discounts for the subscription item.
1525
1282
  sig {
1526
1283
  returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount]))
1527
1284
  }
1528
1285
  attr_accessor :discounts
1529
-
1530
1286
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
1531
1287
  sig { returns(T::Hash[String, String]) }
1532
1288
  attr_accessor :metadata
1533
-
1534
1289
  # The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
1535
1290
  sig { returns(String) }
1536
1291
  attr_accessor :plan
1537
-
1538
1292
  # The ID of the price object.
1539
1293
  sig { returns(String) }
1540
1294
  attr_accessor :price
1541
-
1542
1295
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
1543
1296
  sig {
1544
1297
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData)
1545
1298
  }
1546
1299
  attr_accessor :price_data
1547
-
1548
1300
  # Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
1549
1301
  sig { returns(Integer) }
1550
1302
  attr_accessor :quantity
1551
-
1552
1303
  # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
1553
1304
  sig { returns(T.nilable(T::Array[String])) }
1554
1305
  attr_accessor :tax_rates
1555
-
1556
1306
  # Options that configure the trial on the subscription item.
1557
1307
  sig { returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Trial) }
1558
1308
  attr_accessor :trial
1559
-
1560
1309
  sig {
1561
1310
  params(billing_thresholds: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::BillingThresholds), discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount]), metadata: T::Hash[String, String], plan: String, price: String, price_data: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String]), trial: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Trial).void
1562
1311
  }
@@ -1576,7 +1325,6 @@ module Stripe
1576
1325
  # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
1577
1326
  sig { returns(String) }
1578
1327
  attr_accessor :behavior
1579
-
1580
1328
  sig { params(behavior: String).void }
1581
1329
  def initialize(behavior: nil); end
1582
1330
  end
@@ -1584,11 +1332,9 @@ module Stripe
1584
1332
  # 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.
1585
1333
  sig { returns(Float) }
1586
1334
  attr_accessor :amount_percent
1587
-
1588
1335
  # ID of an existing, connected Stripe account.
1589
1336
  sig { returns(String) }
1590
1337
  attr_accessor :destination
1591
-
1592
1338
  sig { params(amount_percent: Float, destination: String).void }
1593
1339
  def initialize(amount_percent: nil, destination: nil); end
1594
1340
  end
@@ -1597,7 +1343,6 @@ module Stripe
1597
1343
  # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
1598
1344
  sig { returns(String) }
1599
1345
  attr_accessor :prorate_up_front
1600
-
1601
1346
  sig { params(prorate_up_front: String).void }
1602
1347
  def initialize(prorate_up_front: nil); end
1603
1348
  end
@@ -1606,7 +1351,6 @@ module Stripe
1606
1351
  returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings::EndBehavior)
1607
1352
  }
1608
1353
  attr_accessor :end_behavior
1609
-
1610
1354
  sig {
1611
1355
  params(end_behavior: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings::EndBehavior).void
1612
1356
  }
@@ -1617,111 +1361,85 @@ module Stripe
1617
1361
  returns(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem])
1618
1362
  }
1619
1363
  attr_accessor :add_invoice_items
1620
-
1621
1364
  # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
1622
1365
  sig { returns(Float) }
1623
1366
  attr_accessor :application_fee_percent
1624
-
1625
1367
  # Automatic tax settings for this phase.
1626
1368
  sig { returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax) }
1627
1369
  attr_accessor :automatic_tax
1628
-
1629
1370
  # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
1630
1371
  sig { returns(String) }
1631
1372
  attr_accessor :billing_cycle_anchor
1632
-
1633
1373
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
1634
1374
  sig {
1635
1375
  returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::BillingThresholds))
1636
1376
  }
1637
1377
  attr_accessor :billing_thresholds
1638
-
1639
1378
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
1640
1379
  sig { returns(String) }
1641
1380
  attr_accessor :collection_method
1642
-
1643
1381
  # The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
1644
1382
  sig { returns(String) }
1645
1383
  attr_accessor :coupon
1646
-
1647
1384
  # 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).
1648
1385
  sig { returns(String) }
1649
1386
  attr_accessor :currency
1650
-
1651
1387
  # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
1652
1388
  sig { returns(String) }
1653
1389
  attr_accessor :default_payment_method
1654
-
1655
1390
  # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
1656
1391
  sig { returns(T.nilable(T::Array[String])) }
1657
1392
  attr_accessor :default_tax_rates
1658
-
1659
1393
  # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1660
1394
  sig { returns(T.nilable(String)) }
1661
1395
  attr_accessor :description
1662
-
1663
1396
  # The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
1664
1397
  sig {
1665
1398
  returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount]))
1666
1399
  }
1667
1400
  attr_accessor :discounts
1668
-
1669
1401
  # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
1670
1402
  sig { returns(T.any(Integer, String)) }
1671
1403
  attr_accessor :end_date
1672
-
1673
1404
  # All invoices will be billed using the specified settings.
1674
1405
  sig { returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings) }
1675
1406
  attr_accessor :invoice_settings
1676
-
1677
1407
  # List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
1678
1408
  sig { returns(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item]) }
1679
1409
  attr_accessor :items
1680
-
1681
1410
  # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
1682
1411
  sig { returns(Integer) }
1683
1412
  attr_accessor :iterations
1684
-
1685
1413
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
1686
1414
  sig { returns(T::Hash[String, String]) }
1687
1415
  attr_accessor :metadata
1688
-
1689
1416
  # The account on behalf of which to charge, for each of the associated subscription's invoices.
1690
1417
  sig { returns(String) }
1691
1418
  attr_accessor :on_behalf_of
1692
-
1693
1419
  # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
1694
1420
  sig { returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::PauseCollection) }
1695
1421
  attr_accessor :pause_collection
1696
-
1697
1422
  # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
1698
1423
  sig { returns(String) }
1699
1424
  attr_accessor :proration_behavior
1700
-
1701
1425
  # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
1702
1426
  sig { returns(T.any(Integer, String)) }
1703
1427
  attr_accessor :start_date
1704
-
1705
1428
  # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
1706
1429
  sig { returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TransferData) }
1707
1430
  attr_accessor :transfer_data
1708
-
1709
1431
  # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
1710
1432
  sig { returns(T::Boolean) }
1711
1433
  attr_accessor :trial
1712
-
1713
1434
  # Specify trial behavior when crossing phase boundaries
1714
1435
  sig { returns(String) }
1715
1436
  attr_accessor :trial_continuation
1716
-
1717
1437
  # Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
1718
1438
  sig { returns(T.any(Integer, String)) }
1719
1439
  attr_accessor :trial_end
1720
-
1721
1440
  # Settings related to subscription trials.
1722
1441
  sig { returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings) }
1723
1442
  attr_accessor :trial_settings
1724
-
1725
1443
  sig {
1726
1444
  params(add_invoice_items: T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem], application_fee_percent: Float, automatic_tax: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::BillingThresholds), collection_method: String, coupon: String, currency: String, default_payment_method: String, default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount]), end_date: T.any(Integer, String), invoice_settings: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings, items: T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item], iterations: Integer, metadata: T::Hash[String, String], on_behalf_of: String, pause_collection: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::PauseCollection, proration_behavior: String, start_date: T.any(Integer, String), transfer_data: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TransferData, trial: T::Boolean, trial_continuation: String, trial_end: T.any(Integer, String), trial_settings: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TrialSettings).void
1727
1445
  }
@@ -1758,46 +1476,36 @@ module Stripe
1758
1476
  # This is used to determine the number of billing cycles to prebill.
1759
1477
  sig { returns(Integer) }
1760
1478
  attr_accessor :iterations
1761
-
1762
1479
  # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
1763
1480
  sig { returns(String) }
1764
1481
  attr_accessor :update_behavior
1765
-
1766
1482
  sig { params(iterations: Integer, update_behavior: String).void }
1767
1483
  def initialize(iterations: nil, update_behavior: nil); end
1768
1484
  end
1769
1485
  # 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.
1770
1486
  sig { returns(String) }
1771
1487
  attr_accessor :billing_behavior
1772
-
1773
1488
  # Object representing the subscription schedule's default settings.
1774
1489
  sig { returns(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings) }
1775
1490
  attr_accessor :default_settings
1776
-
1777
1491
  # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
1778
1492
  sig { returns(String) }
1779
1493
  attr_accessor :end_behavior
1780
-
1781
1494
  # Specifies which fields in the response should be expanded.
1782
1495
  sig { returns(T::Array[String]) }
1783
1496
  attr_accessor :expand
1784
-
1785
1497
  # 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`.
1786
1498
  sig { returns(T.nilable(T::Hash[String, String])) }
1787
1499
  attr_accessor :metadata
1788
-
1789
1500
  # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
1790
1501
  sig { returns(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase]) }
1791
1502
  attr_accessor :phases
1792
-
1793
1503
  # If specified, the invoicing for the given billing cycle iterations will be processed now.
1794
1504
  sig { returns(::Stripe::SubscriptionScheduleService::UpdateParams::Prebilling) }
1795
1505
  attr_accessor :prebilling
1796
-
1797
1506
  # If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.
1798
1507
  sig { returns(String) }
1799
1508
  attr_accessor :proration_behavior
1800
-
1801
1509
  sig {
1802
1510
  params(billing_behavior: String, default_settings: ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings, end_behavior: String, expand: T::Array[String], metadata: T.nilable(T::Hash[String, String]), phases: T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase], prebilling: ::Stripe::SubscriptionScheduleService::UpdateParams::Prebilling, proration_behavior: String).void
1803
1511
  }
@@ -1819,7 +1527,6 @@ module Stripe
1819
1527
  # The ID of a specific discount.
1820
1528
  sig { returns(String) }
1821
1529
  attr_accessor :discount
1822
-
1823
1530
  sig { params(discount: String).void }
1824
1531
  def initialize(discount: nil); end
1825
1532
  end
@@ -1827,11 +1534,9 @@ module Stripe
1827
1534
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1828
1535
  sig { returns(String) }
1829
1536
  attr_accessor :interval
1830
-
1831
1537
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1832
1538
  sig { returns(Integer) }
1833
1539
  attr_accessor :interval_count
1834
-
1835
1540
  sig { params(interval: String, interval_count: Integer).void }
1836
1541
  def initialize(interval: nil, interval_count: nil); end
1837
1542
  end
@@ -1840,21 +1545,17 @@ module Stripe
1840
1545
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::DiscountEnd)
1841
1546
  }
1842
1547
  attr_accessor :discount_end
1843
-
1844
1548
  # Time span for the amendment starting from the `amendment_start`.
1845
1549
  sig {
1846
1550
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::Duration)
1847
1551
  }
1848
1552
  attr_accessor :duration
1849
-
1850
1553
  # A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
1851
1554
  sig { returns(Integer) }
1852
1555
  attr_accessor :timestamp
1853
-
1854
1556
  # Select one of three ways to pass the `amendment_end`.
1855
1557
  sig { returns(String) }
1856
1558
  attr_accessor :type
1857
-
1858
1559
  sig {
1859
1560
  params(discount_end: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::DiscountEnd, duration: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd::Duration, timestamp: Integer, type: String).void
1860
1561
  }
@@ -1865,7 +1566,6 @@ module Stripe
1865
1566
  # The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
1866
1567
  sig { returns(Integer) }
1867
1568
  attr_accessor :index
1868
-
1869
1569
  sig { params(index: Integer).void }
1870
1570
  def initialize(index: nil); end
1871
1571
  end
@@ -1873,7 +1573,6 @@ module Stripe
1873
1573
  # The ID of a specific discount.
1874
1574
  sig { returns(String) }
1875
1575
  attr_accessor :discount
1876
-
1877
1576
  sig { params(discount: String).void }
1878
1577
  def initialize(discount: nil); end
1879
1578
  end
@@ -1882,21 +1581,17 @@ module Stripe
1882
1581
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::AmendmentEnd)
1883
1582
  }
1884
1583
  attr_accessor :amendment_end
1885
-
1886
1584
  # Use the `end` time of a given discount.
1887
1585
  sig {
1888
1586
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::DiscountEnd)
1889
1587
  }
1890
1588
  attr_accessor :discount_end
1891
-
1892
1589
  # A precise Unix timestamp for the amendment to start.
1893
1590
  sig { returns(Integer) }
1894
1591
  attr_accessor :timestamp
1895
-
1896
1592
  # Select one of three ways to pass the `amendment_start`.
1897
1593
  sig { returns(String) }
1898
1594
  attr_accessor :type
1899
-
1900
1595
  sig {
1901
1596
  params(amendment_end: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::AmendmentEnd, discount_end: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart::DiscountEnd, timestamp: Integer, type: String).void
1902
1597
  }
@@ -1908,32 +1603,26 @@ module Stripe
1908
1603
  # The type of calculation made to determine when the discount ends.
1909
1604
  sig { returns(String) }
1910
1605
  attr_accessor :type
1911
-
1912
1606
  sig { params(type: String).void }
1913
1607
  def initialize(type: nil); end
1914
1608
  end
1915
1609
  # The coupon code to redeem.
1916
1610
  sig { returns(String) }
1917
1611
  attr_accessor :coupon
1918
-
1919
1612
  # An ID of an existing discount for a coupon that was already redeemed.
1920
1613
  sig { returns(String) }
1921
1614
  attr_accessor :discount
1922
-
1923
1615
  # Details to determine how long the discount should be applied for.
1924
1616
  sig {
1925
1617
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add::DiscountEnd)
1926
1618
  }
1927
1619
  attr_accessor :discount_end
1928
-
1929
1620
  # 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.
1930
1621
  sig { returns(Integer) }
1931
1622
  attr_accessor :index
1932
-
1933
1623
  # The promotion code to redeem.
1934
1624
  sig { returns(String) }
1935
1625
  attr_accessor :promotion_code
1936
-
1937
1626
  sig {
1938
1627
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add::DiscountEnd, index: Integer, promotion_code: String).void
1939
1628
  }
@@ -1949,15 +1638,12 @@ module Stripe
1949
1638
  # The coupon code to remove from the `discounts` array.
1950
1639
  sig { returns(String) }
1951
1640
  attr_accessor :coupon
1952
-
1953
1641
  # The ID of a discount to remove from the `discounts` array.
1954
1642
  sig { returns(String) }
1955
1643
  attr_accessor :discount
1956
-
1957
1644
  # The ID of a promotion code to remove from the `discounts` array.
1958
1645
  sig { returns(String) }
1959
1646
  attr_accessor :promotion_code
1960
-
1961
1647
  sig { params(coupon: String, discount: String, promotion_code: String).void }
1962
1648
  def initialize(coupon: nil, discount: nil, promotion_code: nil); end
1963
1649
  end
@@ -1965,15 +1651,12 @@ module Stripe
1965
1651
  # The coupon code to replace the `discounts` array with.
1966
1652
  sig { returns(String) }
1967
1653
  attr_accessor :coupon
1968
-
1969
1654
  # An ID of an existing discount to replace the `discounts` array with.
1970
1655
  sig { returns(String) }
1971
1656
  attr_accessor :discount
1972
-
1973
1657
  # An ID of an existing promotion code to replace the `discounts` array with.
1974
1658
  sig { returns(String) }
1975
1659
  attr_accessor :promotion_code
1976
-
1977
1660
  sig { params(coupon: String, discount: String, promotion_code: String).void }
1978
1661
  def initialize(coupon: nil, discount: nil, promotion_code: nil); end
1979
1662
  end
@@ -1982,23 +1665,19 @@ module Stripe
1982
1665
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add)
1983
1666
  }
1984
1667
  attr_accessor :add
1985
-
1986
1668
  # Details of the discount to remove.
1987
1669
  sig {
1988
1670
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Remove)
1989
1671
  }
1990
1672
  attr_accessor :remove
1991
-
1992
1673
  # Details of the discount to replace the existing discounts with.
1993
1674
  sig {
1994
1675
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Set)
1995
1676
  }
1996
1677
  attr_accessor :set
1997
-
1998
1678
  # Determines the type of discount action.
1999
1679
  sig { returns(String) }
2000
1680
  attr_accessor :type
2001
-
2002
1681
  sig {
2003
1682
  params(add: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Add, remove: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Remove, set: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction::Set, type: String).void
2004
1683
  }
@@ -2012,11 +1691,9 @@ module Stripe
2012
1691
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2013
1692
  sig { returns(String) }
2014
1693
  attr_accessor :interval
2015
-
2016
1694
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2017
1695
  sig { returns(Integer) }
2018
1696
  attr_accessor :interval_count
2019
-
2020
1697
  sig { params(interval: String, interval_count: Integer).void }
2021
1698
  def initialize(interval: nil, interval_count: nil); end
2022
1699
  end
@@ -2025,15 +1702,12 @@ module Stripe
2025
1702
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration)
2026
1703
  }
2027
1704
  attr_accessor :duration
2028
-
2029
1705
  # A precise Unix timestamp for the discount to end. Must be in the future.
2030
1706
  sig { returns(Integer) }
2031
1707
  attr_accessor :timestamp
2032
-
2033
1708
  # The type of calculation made to determine when the discount ends.
2034
1709
  sig { returns(String) }
2035
1710
  attr_accessor :type
2036
-
2037
1711
  sig {
2038
1712
  params(duration: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
2039
1713
  }
@@ -2042,21 +1716,17 @@ module Stripe
2042
1716
  # ID of the coupon to create a new discount for.
2043
1717
  sig { returns(String) }
2044
1718
  attr_accessor :coupon
2045
-
2046
1719
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
2047
1720
  sig { returns(String) }
2048
1721
  attr_accessor :discount
2049
-
2050
1722
  # Details to determine how long the discount should be applied for.
2051
1723
  sig {
2052
1724
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd)
2053
1725
  }
2054
1726
  attr_accessor :discount_end
2055
-
2056
1727
  # ID of the promotion code to create a new discount for.
2057
1728
  sig { returns(String) }
2058
1729
  attr_accessor :promotion_code
2059
-
2060
1730
  sig {
2061
1731
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd, promotion_code: String).void
2062
1732
  }
@@ -2071,11 +1741,9 @@ module Stripe
2071
1741
  # 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.
2072
1742
  sig { returns(T::Array[String]) }
2073
1743
  attr_accessor :converts_to
2074
-
2075
1744
  # Determines the type of trial for this item.
2076
1745
  sig { returns(String) }
2077
1746
  attr_accessor :type
2078
-
2079
1747
  sig { params(converts_to: T::Array[String], type: String).void }
2080
1748
  def initialize(converts_to: nil, type: nil); end
2081
1749
  end
@@ -2084,29 +1752,23 @@ module Stripe
2084
1752
  returns(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount])
2085
1753
  }
2086
1754
  attr_accessor :discounts
2087
-
2088
1755
  # 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`.
2089
1756
  sig { returns(T::Hash[String, String]) }
2090
1757
  attr_accessor :metadata
2091
-
2092
1758
  # The ID of the price object.
2093
1759
  sig { returns(String) }
2094
1760
  attr_accessor :price
2095
-
2096
1761
  # Quantity for this item.
2097
1762
  sig { returns(Integer) }
2098
1763
  attr_accessor :quantity
2099
-
2100
1764
  # 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`.
2101
1765
  sig { returns(T::Array[String]) }
2102
1766
  attr_accessor :tax_rates
2103
-
2104
1767
  # Options that configure the trial on the subscription item.
2105
1768
  sig {
2106
1769
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Trial)
2107
1770
  }
2108
1771
  attr_accessor :trial
2109
-
2110
1772
  sig {
2111
1773
  params(discounts: T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Discount], metadata: T::Hash[String, String], price: String, quantity: Integer, tax_rates: T::Array[String], trial: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add::Trial).void
2112
1774
  }
@@ -2123,7 +1785,6 @@ module Stripe
2123
1785
  # ID of a price to remove.
2124
1786
  sig { returns(String) }
2125
1787
  attr_accessor :price
2126
-
2127
1788
  sig { params(price: String).void }
2128
1789
  def initialize(price: nil); end
2129
1790
  end
@@ -2134,11 +1795,9 @@ module Stripe
2134
1795
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2135
1796
  sig { returns(String) }
2136
1797
  attr_accessor :interval
2137
-
2138
1798
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2139
1799
  sig { returns(Integer) }
2140
1800
  attr_accessor :interval_count
2141
-
2142
1801
  sig { params(interval: String, interval_count: Integer).void }
2143
1802
  def initialize(interval: nil, interval_count: nil); end
2144
1803
  end
@@ -2147,15 +1806,12 @@ module Stripe
2147
1806
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration)
2148
1807
  }
2149
1808
  attr_accessor :duration
2150
-
2151
1809
  # A precise Unix timestamp for the discount to end. Must be in the future.
2152
1810
  sig { returns(Integer) }
2153
1811
  attr_accessor :timestamp
2154
-
2155
1812
  # The type of calculation made to determine when the discount ends.
2156
1813
  sig { returns(String) }
2157
1814
  attr_accessor :type
2158
-
2159
1815
  sig {
2160
1816
  params(duration: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
2161
1817
  }
@@ -2164,21 +1820,17 @@ module Stripe
2164
1820
  # ID of the coupon to create a new discount for.
2165
1821
  sig { returns(String) }
2166
1822
  attr_accessor :coupon
2167
-
2168
1823
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
2169
1824
  sig { returns(String) }
2170
1825
  attr_accessor :discount
2171
-
2172
1826
  # Details to determine how long the discount should be applied for.
2173
1827
  sig {
2174
1828
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd)
2175
1829
  }
2176
1830
  attr_accessor :discount_end
2177
-
2178
1831
  # ID of the promotion code to create a new discount for.
2179
1832
  sig { returns(String) }
2180
1833
  attr_accessor :promotion_code
2181
-
2182
1834
  sig {
2183
1835
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd, promotion_code: String).void
2184
1836
  }
@@ -2193,11 +1845,9 @@ module Stripe
2193
1845
  # 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.
2194
1846
  sig { returns(T::Array[String]) }
2195
1847
  attr_accessor :converts_to
2196
-
2197
1848
  # Determines the type of trial for this item.
2198
1849
  sig { returns(String) }
2199
1850
  attr_accessor :type
2200
-
2201
1851
  sig { params(converts_to: T::Array[String], type: String).void }
2202
1852
  def initialize(converts_to: nil, type: nil); end
2203
1853
  end
@@ -2206,29 +1856,23 @@ module Stripe
2206
1856
  returns(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount])
2207
1857
  }
2208
1858
  attr_accessor :discounts
2209
-
2210
1859
  # 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`.
2211
1860
  sig { returns(T::Hash[String, String]) }
2212
1861
  attr_accessor :metadata
2213
-
2214
1862
  # The ID of the price object.
2215
1863
  sig { returns(String) }
2216
1864
  attr_accessor :price
2217
-
2218
1865
  # 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`.
2219
1866
  sig { returns(Integer) }
2220
1867
  attr_accessor :quantity
2221
-
2222
1868
  # 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`.
2223
1869
  sig { returns(T::Array[String]) }
2224
1870
  attr_accessor :tax_rates
2225
-
2226
1871
  # 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`.
2227
1872
  sig {
2228
1873
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Trial)
2229
1874
  }
2230
1875
  attr_accessor :trial
2231
-
2232
1876
  sig {
2233
1877
  params(discounts: T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Discount], metadata: T::Hash[String, String], price: String, quantity: Integer, tax_rates: T::Array[String], trial: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set::Trial).void
2234
1878
  }
@@ -2246,23 +1890,19 @@ module Stripe
2246
1890
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add)
2247
1891
  }
2248
1892
  attr_accessor :add
2249
-
2250
1893
  # Details of the subscription item to remove.
2251
1894
  sig {
2252
1895
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Remove)
2253
1896
  }
2254
1897
  attr_accessor :remove
2255
-
2256
1898
  # Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
2257
1899
  sig {
2258
1900
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set)
2259
1901
  }
2260
1902
  attr_accessor :set
2261
-
2262
1903
  # Determines the type of item action.
2263
1904
  sig { returns(String) }
2264
1905
  attr_accessor :type
2265
-
2266
1906
  sig {
2267
1907
  params(add: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Add, remove: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Remove, set: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction::Set, type: String).void
2268
1908
  }
@@ -2272,19 +1912,15 @@ module Stripe
2272
1912
  # Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
2273
1913
  sig { returns(T::Hash[String, String]) }
2274
1914
  attr_accessor :add
2275
-
2276
1915
  # Keys to remove from schedule phase metadata.
2277
1916
  sig { returns(T::Array[String]) }
2278
1917
  attr_accessor :remove
2279
-
2280
1918
  # Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
2281
1919
  sig { returns(T.nilable(T::Hash[String, String])) }
2282
1920
  attr_accessor :set
2283
-
2284
1921
  # Select one of three ways to update phase-level `metadata` on subscription schedules.
2285
1922
  sig { returns(String) }
2286
1923
  attr_accessor :type
2287
-
2288
1924
  sig {
2289
1925
  params(add: T::Hash[String, String], remove: T::Array[String], set: T.nilable(T::Hash[String, String]), type: String).void
2290
1926
  }
@@ -2295,7 +1931,6 @@ module Stripe
2295
1931
  # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
2296
1932
  sig { returns(String) }
2297
1933
  attr_accessor :behavior
2298
-
2299
1934
  sig { params(behavior: String).void }
2300
1935
  def initialize(behavior: nil); end
2301
1936
  end
@@ -2304,11 +1939,9 @@ module Stripe
2304
1939
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection::Set)
2305
1940
  }
2306
1941
  attr_accessor :set
2307
-
2308
1942
  # Determines the type of the pause_collection amendment.
2309
1943
  sig { returns(String) }
2310
1944
  attr_accessor :type
2311
-
2312
1945
  sig {
2313
1946
  params(set: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection::Set, type: String).void
2314
1947
  }
@@ -2319,7 +1952,6 @@ module Stripe
2319
1952
  # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
2320
1953
  sig { returns(String) }
2321
1954
  attr_accessor :prorate_up_front
2322
-
2323
1955
  sig { params(prorate_up_front: String).void }
2324
1956
  def initialize(prorate_up_front: nil); end
2325
1957
  end
@@ -2328,7 +1960,6 @@ module Stripe
2328
1960
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings::EndBehavior)
2329
1961
  }
2330
1962
  attr_accessor :end_behavior
2331
-
2332
1963
  sig {
2333
1964
  params(end_behavior: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings::EndBehavior).void
2334
1965
  }
@@ -2337,55 +1968,45 @@ module Stripe
2337
1968
  # Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
2338
1969
  sig { returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd) }
2339
1970
  attr_accessor :amendment_end
2340
-
2341
1971
  # Details to identify the earliest timestamp where the proposed change should take effect.
2342
1972
  sig {
2343
1973
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart)
2344
1974
  }
2345
1975
  attr_accessor :amendment_start
2346
-
2347
1976
  # For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
2348
1977
  sig { returns(String) }
2349
1978
  attr_accessor :billing_cycle_anchor
2350
-
2351
1979
  # Changes to the coupons being redeemed or discounts being applied during the amendment time span.
2352
1980
  sig {
2353
1981
  returns(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction])
2354
1982
  }
2355
1983
  attr_accessor :discount_actions
2356
-
2357
1984
  # Changes to the subscription items during the amendment time span.
2358
1985
  sig {
2359
1986
  returns(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction])
2360
1987
  }
2361
1988
  attr_accessor :item_actions
2362
-
2363
1989
  # Instructions for how to modify phase metadata
2364
1990
  sig {
2365
1991
  returns(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::MetadataAction])
2366
1992
  }
2367
1993
  attr_accessor :metadata_actions
2368
-
2369
1994
  # Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
2370
1995
  sig { returns(String) }
2371
1996
  attr_accessor :proration_behavior
2372
-
2373
1997
  # Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
2374
1998
  sig {
2375
1999
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection)
2376
2000
  }
2377
2001
  attr_accessor :set_pause_collection
2378
-
2379
2002
  # Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
2380
2003
  sig { returns(String) }
2381
2004
  attr_accessor :set_schedule_end
2382
-
2383
2005
  # Settings related to subscription trials.
2384
2006
  sig {
2385
2007
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings)
2386
2008
  }
2387
2009
  attr_accessor :trial_settings
2388
-
2389
2010
  sig {
2390
2011
  params(amendment_end: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentEnd, amendment_start: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::AmendmentStart, billing_cycle_anchor: String, discount_actions: T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::DiscountAction], item_actions: T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::ItemAction], metadata_actions: T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment::MetadataAction], proration_behavior: String, set_pause_collection: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::SetPauseCollection, set_schedule_end: String, trial_settings: ::Stripe::SubscriptionScheduleService::AmendParams::Amendment::TrialSettings).void
2391
2012
  }
@@ -2408,7 +2029,6 @@ module Stripe
2408
2029
  # The position of the amendment in the `amendments` array with which prebilling should begin. Indexes start from 0 and must be less than the total number of supplied amendments.
2409
2030
  sig { returns(Integer) }
2410
2031
  attr_accessor :index
2411
-
2412
2032
  sig { params(index: Integer).void }
2413
2033
  def initialize(index: nil); end
2414
2034
  end
@@ -2417,15 +2037,12 @@ module Stripe
2417
2037
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom::AmendmentStart)
2418
2038
  }
2419
2039
  attr_accessor :amendment_start
2420
-
2421
2040
  # Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
2422
2041
  sig { returns(Integer) }
2423
2042
  attr_accessor :timestamp
2424
-
2425
2043
  # Select one of several ways to pass the `bill_from` value.
2426
2044
  sig { returns(String) }
2427
2045
  attr_accessor :type
2428
-
2429
2046
  sig {
2430
2047
  params(amendment_start: ::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom::AmendmentStart, timestamp: Integer, type: String).void
2431
2048
  }
@@ -2436,7 +2053,6 @@ module Stripe
2436
2053
  # The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
2437
2054
  sig { returns(Integer) }
2438
2055
  attr_accessor :index
2439
-
2440
2056
  sig { params(index: Integer).void }
2441
2057
  def initialize(index: nil); end
2442
2058
  end
@@ -2444,11 +2060,9 @@ module Stripe
2444
2060
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2445
2061
  sig { returns(String) }
2446
2062
  attr_accessor :interval
2447
-
2448
2063
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2449
2064
  sig { returns(Integer) }
2450
2065
  attr_accessor :interval_count
2451
-
2452
2066
  sig { params(interval: String, interval_count: Integer).void }
2453
2067
  def initialize(interval: nil, interval_count: nil); end
2454
2068
  end
@@ -2457,21 +2071,17 @@ module Stripe
2457
2071
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::AmendmentEnd)
2458
2072
  }
2459
2073
  attr_accessor :amendment_end
2460
-
2461
2074
  # Time span for prebilling, starting from `bill_from`.
2462
2075
  sig {
2463
2076
  returns(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::Duration)
2464
2077
  }
2465
2078
  attr_accessor :duration
2466
-
2467
2079
  # End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
2468
2080
  sig { returns(Integer) }
2469
2081
  attr_accessor :timestamp
2470
-
2471
2082
  # Select one of several ways to pass the `bill_until` value.
2472
2083
  sig { returns(String) }
2473
2084
  attr_accessor :type
2474
-
2475
2085
  sig {
2476
2086
  params(amendment_end: ::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::AmendmentEnd, duration: ::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil::Duration, timestamp: Integer, type: String).void
2477
2087
  }
@@ -2480,19 +2090,15 @@ module Stripe
2480
2090
  # The beginning of the prebilled time period. The default value is `now`.
2481
2091
  sig { returns(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom) }
2482
2092
  attr_accessor :bill_from
2483
-
2484
2093
  # The end of the prebilled time period.
2485
2094
  sig { returns(::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil) }
2486
2095
  attr_accessor :bill_until
2487
-
2488
2096
  # When the prebilling invoice should be created. The default value is `now`.
2489
2097
  sig { returns(String) }
2490
2098
  attr_accessor :invoice_at
2491
-
2492
2099
  # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
2493
2100
  sig { returns(String) }
2494
2101
  attr_accessor :update_behavior
2495
-
2496
2102
  sig {
2497
2103
  params(bill_from: ::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillFrom, bill_until: ::Stripe::SubscriptionScheduleService::AmendParams::Prebilling::BillUntil, invoice_at: String, update_behavior: String).void
2498
2104
  }
@@ -2502,33 +2108,27 @@ module Stripe
2502
2108
  # Behavior of the subscription schedule and underlying subscription when it ends.
2503
2109
  sig { returns(String) }
2504
2110
  attr_accessor :end_behavior
2505
-
2506
2111
  sig { params(end_behavior: String).void }
2507
2112
  def initialize(end_behavior: nil); end
2508
2113
  end
2509
2114
  # Changes to apply to the phases of the subscription schedule, in the order provided.
2510
2115
  sig { returns(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment]) }
2511
2116
  attr_accessor :amendments
2512
-
2513
2117
  # Specifies which fields in the response should be expanded.
2514
2118
  sig { returns(T::Array[String]) }
2515
2119
  attr_accessor :expand
2516
-
2517
2120
  # Provide any time periods to bill in advance.
2518
2121
  sig {
2519
2122
  returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Prebilling]))
2520
2123
  }
2521
2124
  attr_accessor :prebilling
2522
-
2523
2125
  # In cases where the amendment changes the currently active phase,
2524
2126
  # specifies if and how to prorate at the time of the request.
2525
2127
  sig { returns(String) }
2526
2128
  attr_accessor :proration_behavior
2527
-
2528
2129
  # Changes to apply to the subscription schedule.
2529
2130
  sig { returns(::Stripe::SubscriptionScheduleService::AmendParams::ScheduleSettings) }
2530
2131
  attr_accessor :schedule_settings
2531
-
2532
2132
  sig {
2533
2133
  params(amendments: T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Amendment], expand: T::Array[String], prebilling: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::AmendParams::Prebilling]), proration_behavior: String, schedule_settings: ::Stripe::SubscriptionScheduleService::AmendParams::ScheduleSettings).void
2534
2134
  }
@@ -2544,15 +2144,12 @@ module Stripe
2544
2144
  # Specifies which fields in the response should be expanded.
2545
2145
  sig { returns(T::Array[String]) }
2546
2146
  attr_accessor :expand
2547
-
2548
2147
  # 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. Defaults to `true`.
2549
2148
  sig { returns(T::Boolean) }
2550
2149
  attr_accessor :invoice_now
2551
-
2552
2150
  # If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.
2553
2151
  sig { returns(T::Boolean) }
2554
2152
  attr_accessor :prorate
2555
-
2556
2153
  sig { params(expand: T::Array[String], invoice_now: T::Boolean, prorate: T::Boolean).void }
2557
2154
  def initialize(expand: nil, invoice_now: nil, prorate: nil); end
2558
2155
  end
@@ -2560,11 +2157,9 @@ module Stripe
2560
2157
  # Specifies which fields in the response should be expanded.
2561
2158
  sig { returns(T::Array[String]) }
2562
2159
  attr_accessor :expand
2563
-
2564
2160
  # Keep any cancellation on the subscription that the schedule has set
2565
2161
  sig { returns(T::Boolean) }
2566
2162
  attr_accessor :preserve_cancel_date
2567
-
2568
2163
  sig { params(expand: T::Array[String], preserve_cancel_date: T::Boolean).void }
2569
2164
  def initialize(expand: nil, preserve_cancel_date: nil); end
2570
2165
  end