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,30 +9,24 @@ module Stripe
9
9
  # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
10
10
  sig { returns(T.nilable(String)) }
11
11
  attr_accessor :comment
12
-
13
12
  # The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
14
13
  sig { returns(T.nilable(String)) }
15
14
  attr_accessor :feedback
16
-
17
15
  sig { params(comment: T.nilable(String), feedback: T.nilable(String)).void }
18
16
  def initialize(comment: nil, feedback: nil); end
19
17
  end
20
18
  # Details about why this subscription was cancelled
21
19
  sig { returns(::Stripe::SubscriptionService::CancelParams::CancellationDetails) }
22
20
  attr_accessor :cancellation_details
23
-
24
21
  # Specifies which fields in the response should be expanded.
25
22
  sig { returns(T::Array[String]) }
26
23
  attr_accessor :expand
27
-
28
24
  # Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.
29
25
  sig { returns(T::Boolean) }
30
26
  attr_accessor :invoice_now
31
-
32
27
  # Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.
33
28
  sig { returns(T::Boolean) }
34
29
  attr_accessor :prorate
35
-
36
30
  sig {
37
31
  params(cancellation_details: ::Stripe::SubscriptionService::CancelParams::CancellationDetails, expand: T::Array[String], invoice_now: T::Boolean, prorate: T::Boolean).void
38
32
  }
@@ -42,7 +36,6 @@ module Stripe
42
36
  # Specifies which fields in the response should be expanded.
43
37
  sig { returns(T::Array[String]) }
44
38
  attr_accessor :expand
45
-
46
39
  sig { params(expand: T::Array[String]).void }
47
40
  def initialize(expand: nil); end
48
41
  end
@@ -54,11 +47,9 @@ module Stripe
54
47
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
55
48
  sig { returns(String) }
56
49
  attr_accessor :interval
57
-
58
50
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
59
51
  sig { returns(Integer) }
60
52
  attr_accessor :interval_count
61
-
62
53
  sig { params(interval: String, interval_count: Integer).void }
63
54
  def initialize(interval: nil, interval_count: nil); end
64
55
  end
@@ -67,15 +58,12 @@ module Stripe
67
58
  returns(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration)
68
59
  }
69
60
  attr_accessor :duration
70
-
71
61
  # A precise Unix timestamp for the discount to end. Must be in the future.
72
62
  sig { returns(Integer) }
73
63
  attr_accessor :timestamp
74
-
75
64
  # The type of calculation made to determine when the discount ends.
76
65
  sig { returns(String) }
77
66
  attr_accessor :type
78
-
79
67
  sig {
80
68
  params(duration: ::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
81
69
  }
@@ -84,21 +72,17 @@ module Stripe
84
72
  # ID of the coupon to create a new discount for.
85
73
  sig { returns(String) }
86
74
  attr_accessor :coupon
87
-
88
75
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
89
76
  sig { returns(String) }
90
77
  attr_accessor :discount
91
-
92
78
  # Details to determine how long the discount should be applied for.
93
79
  sig {
94
80
  returns(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd)
95
81
  }
96
82
  attr_accessor :discount_end
97
-
98
83
  # ID of the promotion code to create a new discount for.
99
84
  sig { returns(String) }
100
85
  attr_accessor :promotion_code
101
-
102
86
  sig {
103
87
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
104
88
  }
@@ -108,23 +92,18 @@ module Stripe
108
92
  # 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).
109
93
  sig { returns(String) }
110
94
  attr_accessor :currency
111
-
112
95
  # The ID of the product that this price will belong to.
113
96
  sig { returns(String) }
114
97
  attr_accessor :product
115
-
116
98
  # 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.
117
99
  sig { returns(String) }
118
100
  attr_accessor :tax_behavior
119
-
120
101
  # 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.
121
102
  sig { returns(Integer) }
122
103
  attr_accessor :unit_amount
123
-
124
104
  # 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.
125
105
  sig { returns(String) }
126
106
  attr_accessor :unit_amount_decimal
127
-
128
107
  sig {
129
108
  params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
130
109
  }
@@ -141,23 +120,18 @@ module Stripe
141
120
  returns(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount])
142
121
  }
143
122
  attr_accessor :discounts
144
-
145
123
  # The ID of the price object. One of `price` or `price_data` is required.
146
124
  sig { returns(String) }
147
125
  attr_accessor :price
148
-
149
126
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
150
127
  sig { returns(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::PriceData) }
151
128
  attr_accessor :price_data
152
-
153
129
  # Quantity for this item. Defaults to 1.
154
130
  sig { returns(Integer) }
155
131
  attr_accessor :quantity
156
-
157
132
  # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
158
133
  sig { returns(T.nilable(T::Array[String])) }
159
134
  attr_accessor :tax_rates
160
-
161
135
  sig {
162
136
  params(discounts: T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
163
137
  }
@@ -174,22 +148,18 @@ module Stripe
174
148
  # The connected account being referenced when `type` is `account`.
175
149
  sig { returns(String) }
176
150
  attr_accessor :account
177
-
178
151
  # Type of the account referenced in the request.
179
152
  sig { returns(String) }
180
153
  attr_accessor :type
181
-
182
154
  sig { params(account: String, type: String).void }
183
155
  def initialize(account: nil, type: nil); end
184
156
  end
185
157
  # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
186
158
  sig { returns(T::Boolean) }
187
159
  attr_accessor :enabled
188
-
189
160
  # 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.
190
161
  sig { returns(::Stripe::SubscriptionService::UpdateParams::AutomaticTax::Liability) }
191
162
  attr_accessor :liability
192
-
193
163
  sig {
194
164
  params(enabled: T::Boolean, liability: ::Stripe::SubscriptionService::UpdateParams::AutomaticTax::Liability).void
195
165
  }
@@ -199,11 +169,9 @@ module Stripe
199
169
  # Monetary threshold that triggers the subscription to advance to a new billing period
200
170
  sig { returns(Integer) }
201
171
  attr_accessor :amount_gte
202
-
203
172
  # 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.
204
173
  sig { returns(T::Boolean) }
205
174
  attr_accessor :reset_billing_cycle_anchor
206
-
207
175
  sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
208
176
  def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
209
177
  end
@@ -211,11 +179,9 @@ module Stripe
211
179
  # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
212
180
  sig { returns(T.nilable(String)) }
213
181
  attr_accessor :comment
214
-
215
182
  # The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
216
183
  sig { returns(T.nilable(String)) }
217
184
  attr_accessor :feedback
218
-
219
185
  sig { params(comment: T.nilable(String), feedback: T.nilable(String)).void }
220
186
  def initialize(comment: nil, feedback: nil); end
221
187
  end
@@ -225,11 +191,9 @@ module Stripe
225
191
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
226
192
  sig { returns(String) }
227
193
  attr_accessor :interval
228
-
229
194
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
230
195
  sig { returns(Integer) }
231
196
  attr_accessor :interval_count
232
-
233
197
  sig { params(interval: String, interval_count: Integer).void }
234
198
  def initialize(interval: nil, interval_count: nil); end
235
199
  end
@@ -238,15 +202,12 @@ module Stripe
238
202
  returns(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd::Duration)
239
203
  }
240
204
  attr_accessor :duration
241
-
242
205
  # A precise Unix timestamp for the discount to end. Must be in the future.
243
206
  sig { returns(Integer) }
244
207
  attr_accessor :timestamp
245
-
246
208
  # The type of calculation made to determine when the discount ends.
247
209
  sig { returns(String) }
248
210
  attr_accessor :type
249
-
250
211
  sig {
251
212
  params(duration: ::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
252
213
  }
@@ -255,19 +216,15 @@ module Stripe
255
216
  # ID of the coupon to create a new discount for.
256
217
  sig { returns(String) }
257
218
  attr_accessor :coupon
258
-
259
219
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
260
220
  sig { returns(String) }
261
221
  attr_accessor :discount
262
-
263
222
  # Details to determine how long the discount should be applied for.
264
223
  sig { returns(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd) }
265
224
  attr_accessor :discount_end
266
-
267
225
  # ID of the promotion code to create a new discount for.
268
226
  sig { returns(String) }
269
227
  attr_accessor :promotion_code
270
-
271
228
  sig {
272
229
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd, promotion_code: String).void
273
230
  }
@@ -278,22 +235,18 @@ module Stripe
278
235
  # The connected account being referenced when `type` is `account`.
279
236
  sig { returns(String) }
280
237
  attr_accessor :account
281
-
282
238
  # Type of the account referenced in the request.
283
239
  sig { returns(String) }
284
240
  attr_accessor :type
285
-
286
241
  sig { params(account: String, type: String).void }
287
242
  def initialize(account: nil, type: nil); end
288
243
  end
289
244
  # The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
290
245
  sig { returns(T.nilable(T::Array[String])) }
291
246
  attr_accessor :account_tax_ids
292
-
293
247
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
294
248
  sig { returns(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings::Issuer) }
295
249
  attr_accessor :issuer
296
-
297
250
  sig {
298
251
  params(account_tax_ids: T.nilable(T::Array[String]), issuer: ::Stripe::SubscriptionService::UpdateParams::InvoiceSettings::Issuer).void
299
252
  }
@@ -304,7 +257,6 @@ module Stripe
304
257
  # 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))
305
258
  sig { returns(Integer) }
306
259
  attr_accessor :usage_gte
307
-
308
260
  sig { params(usage_gte: Integer).void }
309
261
  def initialize(usage_gte: nil); end
310
262
  end
@@ -314,11 +266,9 @@ module Stripe
314
266
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
315
267
  sig { returns(String) }
316
268
  attr_accessor :interval
317
-
318
269
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
319
270
  sig { returns(Integer) }
320
271
  attr_accessor :interval_count
321
-
322
272
  sig { params(interval: String, interval_count: Integer).void }
323
273
  def initialize(interval: nil, interval_count: nil); end
324
274
  end
@@ -327,15 +277,12 @@ module Stripe
327
277
  returns(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd::Duration)
328
278
  }
329
279
  attr_accessor :duration
330
-
331
280
  # A precise Unix timestamp for the discount to end. Must be in the future.
332
281
  sig { returns(Integer) }
333
282
  attr_accessor :timestamp
334
-
335
283
  # The type of calculation made to determine when the discount ends.
336
284
  sig { returns(String) }
337
285
  attr_accessor :type
338
-
339
286
  sig {
340
287
  params(duration: ::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
341
288
  }
@@ -344,19 +291,15 @@ module Stripe
344
291
  # ID of the coupon to create a new discount for.
345
292
  sig { returns(String) }
346
293
  attr_accessor :coupon
347
-
348
294
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
349
295
  sig { returns(String) }
350
296
  attr_accessor :discount
351
-
352
297
  # Details to determine how long the discount should be applied for.
353
298
  sig { returns(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd) }
354
299
  attr_accessor :discount_end
355
-
356
300
  # ID of the promotion code to create a new discount for.
357
301
  sig { returns(String) }
358
302
  attr_accessor :promotion_code
359
-
360
303
  sig {
361
304
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd, promotion_code: String).void
362
305
  }
@@ -367,38 +310,30 @@ module Stripe
367
310
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
368
311
  sig { returns(String) }
369
312
  attr_accessor :interval
370
-
371
313
  # 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).
372
314
  sig { returns(Integer) }
373
315
  attr_accessor :interval_count
374
-
375
316
  sig { params(interval: String, interval_count: Integer).void }
376
317
  def initialize(interval: nil, interval_count: nil); end
377
318
  end
378
319
  # 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).
379
320
  sig { returns(String) }
380
321
  attr_accessor :currency
381
-
382
322
  # The ID of the product that this price will belong to.
383
323
  sig { returns(String) }
384
324
  attr_accessor :product
385
-
386
325
  # The recurring components of a price such as `interval` and `interval_count`.
387
326
  sig { returns(::Stripe::SubscriptionService::UpdateParams::Item::PriceData::Recurring) }
388
327
  attr_accessor :recurring
389
-
390
328
  # 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.
391
329
  sig { returns(String) }
392
330
  attr_accessor :tax_behavior
393
-
394
331
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
395
332
  sig { returns(Integer) }
396
333
  attr_accessor :unit_amount
397
-
398
334
  # 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.
399
335
  sig { returns(String) }
400
336
  attr_accessor :unit_amount_decimal
401
-
402
337
  sig {
403
338
  params(currency: String, product: String, recurring: ::Stripe::SubscriptionService::UpdateParams::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
404
339
  }
@@ -416,49 +351,38 @@ module Stripe
416
351
  returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::BillingThresholds))
417
352
  }
418
353
  attr_accessor :billing_thresholds
419
-
420
354
  # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
421
355
  sig { returns(T::Boolean) }
422
356
  attr_accessor :clear_usage
423
-
424
357
  # A flag that, if set to `true`, will delete the specified item.
425
358
  sig { returns(T::Boolean) }
426
359
  attr_accessor :deleted
427
-
428
360
  # The coupons to redeem into discounts for the subscription item.
429
361
  sig {
430
362
  returns(T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Item::Discount]))
431
363
  }
432
364
  attr_accessor :discounts
433
-
434
365
  # Subscription item to update.
435
366
  sig { returns(String) }
436
367
  attr_accessor :id
437
-
438
368
  # 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`.
439
369
  sig { returns(T.nilable(T::Hash[String, String])) }
440
370
  attr_accessor :metadata
441
-
442
371
  # Plan ID for this item, as a string.
443
372
  sig { returns(String) }
444
373
  attr_accessor :plan
445
-
446
374
  # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
447
375
  sig { returns(String) }
448
376
  attr_accessor :price
449
-
450
377
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
451
378
  sig { returns(::Stripe::SubscriptionService::UpdateParams::Item::PriceData) }
452
379
  attr_accessor :price_data
453
-
454
380
  # Quantity for this item.
455
381
  sig { returns(Integer) }
456
382
  attr_accessor :quantity
457
-
458
383
  # 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.
459
384
  sig { returns(T.nilable(T::Array[String])) }
460
385
  attr_accessor :tax_rates
461
-
462
386
  sig {
463
387
  params(billing_thresholds: T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::BillingThresholds), clear_usage: T::Boolean, deleted: T::Boolean, discounts: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Item::Discount]), id: String, metadata: T.nilable(T::Hash[String, String]), plan: String, price: String, price_data: ::Stripe::SubscriptionService::UpdateParams::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
464
388
  }
@@ -480,11 +404,9 @@ module Stripe
480
404
  # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
481
405
  sig { returns(String) }
482
406
  attr_accessor :behavior
483
-
484
407
  # The time after which the subscription will resume collecting payments.
485
408
  sig { returns(Integer) }
486
409
  attr_accessor :resumes_at
487
-
488
410
  sig { params(behavior: String, resumes_at: Integer).void }
489
411
  def initialize(behavior: nil, resumes_at: nil); end
490
412
  end
@@ -495,7 +417,6 @@ module Stripe
495
417
  # Transaction type of the mandate.
496
418
  sig { returns(String) }
497
419
  attr_accessor :transaction_type
498
-
499
420
  sig { params(transaction_type: String).void }
500
421
  def initialize(transaction_type: nil); end
501
422
  end
@@ -504,11 +425,9 @@ module Stripe
504
425
  returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)
505
426
  }
506
427
  attr_accessor :mandate_options
507
-
508
428
  # Verification method for the intent
509
429
  sig { returns(String) }
510
430
  attr_accessor :verification_method
511
-
512
431
  sig {
513
432
  params(mandate_options: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions, verification_method: String).void
514
433
  }
@@ -518,7 +437,6 @@ module Stripe
518
437
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
519
438
  sig { returns(String) }
520
439
  attr_accessor :preferred_language
521
-
522
440
  sig { params(preferred_language: String).void }
523
441
  def initialize(preferred_language: nil); end
524
442
  end
@@ -527,15 +445,12 @@ module Stripe
527
445
  # Amount to be charged for future payments.
528
446
  sig { returns(Integer) }
529
447
  attr_accessor :amount
530
-
531
448
  # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
532
449
  sig { returns(String) }
533
450
  attr_accessor :amount_type
534
-
535
451
  # A description of the mandate or subscription that is meant to be displayed to the customer.
536
452
  sig { returns(String) }
537
453
  attr_accessor :description
538
-
539
454
  sig { params(amount: Integer, amount_type: String, description: String).void }
540
455
  def initialize(amount: nil, amount_type: nil, description: nil); end
541
456
  end
@@ -544,15 +459,12 @@ module Stripe
544
459
  returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions)
545
460
  }
546
461
  attr_accessor :mandate_options
547
-
548
462
  # Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
549
463
  sig { returns(String) }
550
464
  attr_accessor :network
551
-
552
465
  # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
553
466
  sig { returns(String) }
554
467
  attr_accessor :request_three_d_secure
555
-
556
468
  sig {
557
469
  params(mandate_options: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions, network: String, request_three_d_secure: String).void
558
470
  }
@@ -564,7 +476,6 @@ module Stripe
564
476
  # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
565
477
  sig { returns(String) }
566
478
  attr_accessor :country
567
-
568
479
  sig { params(country: String).void }
569
480
  def initialize(country: nil); end
570
481
  end
@@ -573,11 +484,9 @@ module Stripe
573
484
  returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
574
485
  }
575
486
  attr_accessor :eu_bank_transfer
576
-
577
487
  # The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
578
488
  sig { returns(String) }
579
489
  attr_accessor :type
580
-
581
490
  sig {
582
491
  params(eu_bank_transfer: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, type: String).void
583
492
  }
@@ -588,11 +497,9 @@ module Stripe
588
497
  returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)
589
498
  }
590
499
  attr_accessor :bank_transfer
591
-
592
500
  # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
593
501
  sig { returns(String) }
594
502
  attr_accessor :funding_type
595
-
596
503
  sig {
597
504
  params(bank_transfer: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String).void
598
505
  }
@@ -613,11 +520,9 @@ module Stripe
613
520
  # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
614
521
  sig { returns(T::Array[String]) }
615
522
  attr_accessor :account_subcategories
616
-
617
523
  # ID of the institution to use to filter for selectable accounts.
618
524
  sig { returns(String) }
619
525
  attr_accessor :institution
620
-
621
526
  sig { params(account_subcategories: T::Array[String], institution: String).void }
622
527
  def initialize(account_subcategories: nil, institution: nil); end
623
528
  end
@@ -626,15 +531,12 @@ module Stripe
626
531
  returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)
627
532
  }
628
533
  attr_accessor :filters
629
-
630
534
  # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
631
535
  sig { returns(T::Array[String]) }
632
536
  attr_accessor :permissions
633
-
634
537
  # List of data features that you would like to retrieve upon account creation.
635
538
  sig { returns(T::Array[String]) }
636
539
  attr_accessor :prefetch
637
-
638
540
  sig {
639
541
  params(filters: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters, permissions: T::Array[String], prefetch: T::Array[String]).void
640
542
  }
@@ -645,11 +547,9 @@ module Stripe
645
547
  returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)
646
548
  }
647
549
  attr_accessor :financial_connections
648
-
649
550
  # Verification method for the intent
650
551
  sig { returns(String) }
651
552
  attr_accessor :verification_method
652
-
653
553
  sig {
654
554
  params(financial_connections: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections, verification_method: String).void
655
555
  }
@@ -660,49 +560,41 @@ module Stripe
660
560
  returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))
661
561
  }
662
562
  attr_accessor :acss_debit
663
-
664
563
  # This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
665
564
  sig {
666
565
  returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact))
667
566
  }
668
567
  attr_accessor :bancontact
669
-
670
568
  # This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
671
569
  sig {
672
570
  returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card))
673
571
  }
674
572
  attr_accessor :card
675
-
676
573
  # This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
677
574
  sig {
678
575
  returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))
679
576
  }
680
577
  attr_accessor :customer_balance
681
-
682
578
  # This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
683
579
  sig {
684
580
  returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))
685
581
  }
686
582
  attr_accessor :id_bank_transfer
687
-
688
583
  # This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
689
584
  sig {
690
585
  returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini))
691
586
  }
692
587
  attr_accessor :konbini
693
-
694
588
  # This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
695
589
  sig {
696
590
  returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))
697
591
  }
698
592
  attr_accessor :sepa_debit
699
-
700
593
  # This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
701
594
  sig {
702
595
  returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))
703
596
  }
704
597
  attr_accessor :us_bank_account
705
-
706
598
  sig {
707
599
  params(acss_debit: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit), bancontact: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact), card: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card), customer_balance: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance), id_bank_transfer: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer), konbini: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini), sepa_debit: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)).void
708
600
  }
@@ -722,15 +614,12 @@ module Stripe
722
614
  returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions)
723
615
  }
724
616
  attr_accessor :payment_method_options
725
-
726
617
  # The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
727
618
  sig { returns(T.nilable(T::Array[String])) }
728
619
  attr_accessor :payment_method_types
729
-
730
620
  # Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
731
621
  sig { returns(String) }
732
622
  attr_accessor :save_default_payment_method
733
-
734
623
  sig {
735
624
  params(payment_method_options: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions, payment_method_types: T.nilable(T::Array[String]), save_default_payment_method: String).void
736
625
  }
@@ -744,11 +633,9 @@ module Stripe
744
633
  # Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
745
634
  sig { returns(String) }
746
635
  attr_accessor :interval
747
-
748
636
  # The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
749
637
  sig { returns(Integer) }
750
638
  attr_accessor :interval_count
751
-
752
639
  sig { params(interval: String, interval_count: Integer).void }
753
640
  def initialize(interval: nil, interval_count: nil); end
754
641
  end
@@ -756,11 +643,9 @@ module Stripe
756
643
  # This is used to determine the number of billing cycles to prebill.
757
644
  sig { returns(Integer) }
758
645
  attr_accessor :iterations
759
-
760
646
  # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
761
647
  sig { returns(String) }
762
648
  attr_accessor :update_behavior
763
-
764
649
  sig { params(iterations: Integer, update_behavior: String).void }
765
650
  def initialize(iterations: nil, update_behavior: nil); end
766
651
  end
@@ -768,11 +653,9 @@ module Stripe
768
653
  # 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.
769
654
  sig { returns(Float) }
770
655
  attr_accessor :amount_percent
771
-
772
656
  # ID of an existing, connected Stripe account.
773
657
  sig { returns(String) }
774
658
  attr_accessor :destination
775
-
776
659
  sig { params(amount_percent: Float, destination: String).void }
777
660
  def initialize(amount_percent: nil, destination: nil); end
778
661
  end
@@ -781,14 +664,12 @@ module Stripe
781
664
  # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
782
665
  sig { returns(String) }
783
666
  attr_accessor :missing_payment_method
784
-
785
667
  sig { params(missing_payment_method: String).void }
786
668
  def initialize(missing_payment_method: nil); end
787
669
  end
788
670
  # Defines how the subscription should behave when the user's free trial ends.
789
671
  sig { returns(::Stripe::SubscriptionService::UpdateParams::TrialSettings::EndBehavior) }
790
672
  attr_accessor :end_behavior
791
-
792
673
  sig {
793
674
  params(end_behavior: ::Stripe::SubscriptionService::UpdateParams::TrialSettings::EndBehavior).void
794
675
  }
@@ -797,95 +678,72 @@ module Stripe
797
678
  # A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
798
679
  sig { returns(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem]) }
799
680
  attr_accessor :add_invoice_items
800
-
801
681
  # 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).
802
682
  sig { returns(T.nilable(Float)) }
803
683
  attr_accessor :application_fee_percent
804
-
805
684
  # Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
806
685
  sig { returns(::Stripe::SubscriptionService::UpdateParams::AutomaticTax) }
807
686
  attr_accessor :automatic_tax
808
-
809
687
  # Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
810
688
  sig { returns(String) }
811
689
  attr_accessor :billing_cycle_anchor
812
-
813
690
  # 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.
814
691
  sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::BillingThresholds)) }
815
692
  attr_accessor :billing_thresholds
816
-
817
693
  # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
818
694
  sig { returns(T.nilable(Integer)) }
819
695
  attr_accessor :cancel_at
820
-
821
696
  # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
822
697
  sig { returns(T::Boolean) }
823
698
  attr_accessor :cancel_at_period_end
824
-
825
699
  # Details about why this subscription was cancelled
826
700
  sig { returns(::Stripe::SubscriptionService::UpdateParams::CancellationDetails) }
827
701
  attr_accessor :cancellation_details
828
-
829
702
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`.
830
703
  sig { returns(String) }
831
704
  attr_accessor :collection_method
832
-
833
705
  # The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
834
706
  sig { returns(String) }
835
707
  attr_accessor :coupon
836
-
837
708
  # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
838
709
  sig { returns(Integer) }
839
710
  attr_accessor :days_until_due
840
-
841
711
  # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
842
712
  sig { returns(String) }
843
713
  attr_accessor :default_payment_method
844
-
845
714
  # ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
846
715
  sig { returns(T.nilable(String)) }
847
716
  attr_accessor :default_source
848
-
849
717
  # The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
850
718
  sig { returns(T.nilable(T::Array[String])) }
851
719
  attr_accessor :default_tax_rates
852
-
853
720
  # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
854
721
  sig { returns(T.nilable(String)) }
855
722
  attr_accessor :description
856
-
857
723
  # The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
858
724
  sig { returns(T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Discount])) }
859
725
  attr_accessor :discounts
860
-
861
726
  # Specifies which fields in the response should be expanded.
862
727
  sig { returns(T::Array[String]) }
863
728
  attr_accessor :expand
864
-
865
729
  # All invoices will be billed using the specified settings.
866
730
  sig { returns(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings) }
867
731
  attr_accessor :invoice_settings
868
-
869
732
  # A list of up to 20 subscription items, each with an attached price.
870
733
  sig { returns(T::Array[::Stripe::SubscriptionService::UpdateParams::Item]) }
871
734
  attr_accessor :items
872
-
873
735
  # 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`.
874
736
  sig { returns(T.nilable(T::Hash[String, String])) }
875
737
  attr_accessor :metadata
876
-
877
738
  # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
878
739
  sig { returns(T::Boolean) }
879
740
  attr_accessor :off_session
880
-
881
741
  # The account on behalf of which to charge, for each of the subscription's invoices.
882
742
  sig { returns(T.nilable(String)) }
883
743
  attr_accessor :on_behalf_of
884
-
885
744
  # 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).
886
745
  sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PauseCollection)) }
887
746
  attr_accessor :pause_collection
888
-
889
747
  # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
890
748
  #
891
749
  # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
@@ -895,49 +753,38 @@ module Stripe
895
753
  # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
896
754
  sig { returns(String) }
897
755
  attr_accessor :payment_behavior
898
-
899
756
  # Payment settings to pass to invoices created by the subscription.
900
757
  sig { returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings) }
901
758
  attr_accessor :payment_settings
902
-
903
759
  # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
904
760
  sig {
905
761
  returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PendingInvoiceItemInterval))
906
762
  }
907
763
  attr_accessor :pending_invoice_item_interval
908
-
909
764
  # If specified, the invoicing for the given billing cycle iterations will be processed now.
910
765
  sig { returns(::Stripe::SubscriptionService::UpdateParams::Prebilling) }
911
766
  attr_accessor :prebilling
912
-
913
767
  # The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
914
768
  sig { returns(String) }
915
769
  attr_accessor :promotion_code
916
-
917
770
  # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
918
771
  sig { returns(String) }
919
772
  attr_accessor :proration_behavior
920
-
921
773
  # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
922
774
  sig { returns(Integer) }
923
775
  attr_accessor :proration_date
924
-
925
776
  # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
926
777
  sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::TransferData)) }
927
778
  attr_accessor :transfer_data
928
-
929
779
  # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
930
780
  sig { returns(T.any(String, Integer)) }
931
781
  attr_accessor :trial_end
932
-
933
782
  # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
934
783
  sig { returns(T::Boolean) }
935
784
  attr_accessor :trial_from_plan
936
-
937
785
  # Settings related to subscription trials.
938
786
  sig { returns(::Stripe::SubscriptionService::UpdateParams::TrialSettings) }
939
787
  attr_accessor :trial_settings
940
-
941
788
  sig {
942
789
  params(add_invoice_items: T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem], application_fee_percent: T.nilable(Float), automatic_tax: ::Stripe::SubscriptionService::UpdateParams::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::SubscriptionService::UpdateParams::BillingThresholds), cancel_at: T.nilable(Integer), cancel_at_period_end: T::Boolean, cancellation_details: ::Stripe::SubscriptionService::UpdateParams::CancellationDetails, collection_method: String, coupon: String, days_until_due: Integer, default_payment_method: String, default_source: T.nilable(String), default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Discount]), expand: T::Array[String], invoice_settings: ::Stripe::SubscriptionService::UpdateParams::InvoiceSettings, items: T::Array[::Stripe::SubscriptionService::UpdateParams::Item], metadata: T.nilable(T::Hash[String, String]), off_session: T::Boolean, on_behalf_of: T.nilable(String), pause_collection: T.nilable(::Stripe::SubscriptionService::UpdateParams::PauseCollection), payment_behavior: String, payment_settings: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings, pending_invoice_item_interval: T.nilable(::Stripe::SubscriptionService::UpdateParams::PendingInvoiceItemInterval), prebilling: ::Stripe::SubscriptionService::UpdateParams::Prebilling, promotion_code: String, proration_behavior: String, proration_date: Integer, transfer_data: T.nilable(::Stripe::SubscriptionService::UpdateParams::TransferData), trial_end: T.any(String, Integer), trial_from_plan: T::Boolean, trial_settings: ::Stripe::SubscriptionService::UpdateParams::TrialSettings).void
943
790
  }
@@ -986,7 +833,6 @@ module Stripe
986
833
  # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
987
834
  sig { returns(T::Boolean) }
988
835
  attr_accessor :enabled
989
-
990
836
  sig { params(enabled: T::Boolean).void }
991
837
  def initialize(enabled: nil); end
992
838
  end
@@ -994,19 +840,15 @@ module Stripe
994
840
  # Minimum value to filter by (exclusive)
995
841
  sig { returns(Integer) }
996
842
  attr_accessor :gt
997
-
998
843
  # Minimum value to filter by (inclusive)
999
844
  sig { returns(Integer) }
1000
845
  attr_accessor :gte
1001
-
1002
846
  # Maximum value to filter by (exclusive)
1003
847
  sig { returns(Integer) }
1004
848
  attr_accessor :lt
1005
-
1006
849
  # Maximum value to filter by (inclusive)
1007
850
  sig { returns(Integer) }
1008
851
  attr_accessor :lte
1009
-
1010
852
  sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
1011
853
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
1012
854
  end
@@ -1014,19 +856,15 @@ module Stripe
1014
856
  # Minimum value to filter by (exclusive)
1015
857
  sig { returns(Integer) }
1016
858
  attr_accessor :gt
1017
-
1018
859
  # Minimum value to filter by (inclusive)
1019
860
  sig { returns(Integer) }
1020
861
  attr_accessor :gte
1021
-
1022
862
  # Maximum value to filter by (exclusive)
1023
863
  sig { returns(Integer) }
1024
864
  attr_accessor :lt
1025
-
1026
865
  # Maximum value to filter by (inclusive)
1027
866
  sig { returns(Integer) }
1028
867
  attr_accessor :lte
1029
-
1030
868
  sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
1031
869
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
1032
870
  end
@@ -1034,78 +872,60 @@ module Stripe
1034
872
  # Minimum value to filter by (exclusive)
1035
873
  sig { returns(Integer) }
1036
874
  attr_accessor :gt
1037
-
1038
875
  # Minimum value to filter by (inclusive)
1039
876
  sig { returns(Integer) }
1040
877
  attr_accessor :gte
1041
-
1042
878
  # Maximum value to filter by (exclusive)
1043
879
  sig { returns(Integer) }
1044
880
  attr_accessor :lt
1045
-
1046
881
  # Maximum value to filter by (inclusive)
1047
882
  sig { returns(Integer) }
1048
883
  attr_accessor :lte
1049
-
1050
884
  sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
1051
885
  def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
1052
886
  end
1053
887
  # Filter subscriptions by their automatic tax settings.
1054
888
  sig { returns(::Stripe::SubscriptionService::ListParams::AutomaticTax) }
1055
889
  attr_accessor :automatic_tax
1056
-
1057
890
  # The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
1058
891
  sig { returns(String) }
1059
892
  attr_accessor :collection_method
1060
-
1061
893
  # Only return subscriptions that were created during the given date interval.
1062
894
  sig { returns(T.any(::Stripe::SubscriptionService::ListParams::Created, Integer)) }
1063
895
  attr_accessor :created
1064
-
1065
896
  # Only return subscriptions whose current_period_end falls within the given date interval.
1066
897
  sig { returns(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodEnd, Integer)) }
1067
898
  attr_accessor :current_period_end
1068
-
1069
899
  # Only return subscriptions whose current_period_start falls within the given date interval.
1070
900
  sig { returns(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodStart, Integer)) }
1071
901
  attr_accessor :current_period_start
1072
-
1073
902
  # The ID of the customer whose subscriptions will be retrieved.
1074
903
  sig { returns(String) }
1075
904
  attr_accessor :customer
1076
-
1077
905
  # 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.
1078
906
  sig { returns(String) }
1079
907
  attr_accessor :ending_before
1080
-
1081
908
  # Specifies which fields in the response should be expanded.
1082
909
  sig { returns(T::Array[String]) }
1083
910
  attr_accessor :expand
1084
-
1085
911
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1086
912
  sig { returns(Integer) }
1087
913
  attr_accessor :limit
1088
-
1089
914
  # The ID of the plan whose subscriptions will be retrieved.
1090
915
  sig { returns(String) }
1091
916
  attr_accessor :plan
1092
-
1093
917
  # Filter for subscriptions that contain this recurring price ID.
1094
918
  sig { returns(String) }
1095
919
  attr_accessor :price
1096
-
1097
920
  # 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.
1098
921
  sig { returns(String) }
1099
922
  attr_accessor :starting_after
1100
-
1101
923
  # The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
1102
924
  sig { returns(String) }
1103
925
  attr_accessor :status
1104
-
1105
926
  # Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.
1106
927
  sig { returns(String) }
1107
928
  attr_accessor :test_clock
1108
-
1109
929
  sig {
1110
930
  params(automatic_tax: ::Stripe::SubscriptionService::ListParams::AutomaticTax, collection_method: String, created: T.any(::Stripe::SubscriptionService::ListParams::Created, Integer), current_period_end: T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodEnd, Integer), current_period_start: T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodStart, Integer), customer: String, ending_before: String, expand: T::Array[String], limit: Integer, plan: String, price: String, starting_after: String, status: String, test_clock: String).void
1111
931
  }
@@ -1134,11 +954,9 @@ module Stripe
1134
954
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1135
955
  sig { returns(String) }
1136
956
  attr_accessor :interval
1137
-
1138
957
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1139
958
  sig { returns(Integer) }
1140
959
  attr_accessor :interval_count
1141
-
1142
960
  sig { params(interval: String, interval_count: Integer).void }
1143
961
  def initialize(interval: nil, interval_count: nil); end
1144
962
  end
@@ -1147,15 +965,12 @@ module Stripe
1147
965
  returns(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration)
1148
966
  }
1149
967
  attr_accessor :duration
1150
-
1151
968
  # A precise Unix timestamp for the discount to end. Must be in the future.
1152
969
  sig { returns(Integer) }
1153
970
  attr_accessor :timestamp
1154
-
1155
971
  # The type of calculation made to determine when the discount ends.
1156
972
  sig { returns(String) }
1157
973
  attr_accessor :type
1158
-
1159
974
  sig {
1160
975
  params(duration: ::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1161
976
  }
@@ -1164,21 +979,17 @@ module Stripe
1164
979
  # ID of the coupon to create a new discount for.
1165
980
  sig { returns(String) }
1166
981
  attr_accessor :coupon
1167
-
1168
982
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1169
983
  sig { returns(String) }
1170
984
  attr_accessor :discount
1171
-
1172
985
  # Details to determine how long the discount should be applied for.
1173
986
  sig {
1174
987
  returns(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd)
1175
988
  }
1176
989
  attr_accessor :discount_end
1177
-
1178
990
  # ID of the promotion code to create a new discount for.
1179
991
  sig { returns(String) }
1180
992
  attr_accessor :promotion_code
1181
-
1182
993
  sig {
1183
994
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
1184
995
  }
@@ -1188,23 +999,18 @@ module Stripe
1188
999
  # 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).
1189
1000
  sig { returns(String) }
1190
1001
  attr_accessor :currency
1191
-
1192
1002
  # The ID of the product that this price will belong to.
1193
1003
  sig { returns(String) }
1194
1004
  attr_accessor :product
1195
-
1196
1005
  # 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.
1197
1006
  sig { returns(String) }
1198
1007
  attr_accessor :tax_behavior
1199
-
1200
1008
  # 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.
1201
1009
  sig { returns(Integer) }
1202
1010
  attr_accessor :unit_amount
1203
-
1204
1011
  # 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.
1205
1012
  sig { returns(String) }
1206
1013
  attr_accessor :unit_amount_decimal
1207
-
1208
1014
  sig {
1209
1015
  params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1210
1016
  }
@@ -1221,23 +1027,18 @@ module Stripe
1221
1027
  returns(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount])
1222
1028
  }
1223
1029
  attr_accessor :discounts
1224
-
1225
1030
  # The ID of the price object. One of `price` or `price_data` is required.
1226
1031
  sig { returns(String) }
1227
1032
  attr_accessor :price
1228
-
1229
1033
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
1230
1034
  sig { returns(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::PriceData) }
1231
1035
  attr_accessor :price_data
1232
-
1233
1036
  # Quantity for this item. Defaults to 1.
1234
1037
  sig { returns(Integer) }
1235
1038
  attr_accessor :quantity
1236
-
1237
1039
  # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
1238
1040
  sig { returns(T.nilable(T::Array[String])) }
1239
1041
  attr_accessor :tax_rates
1240
-
1241
1042
  sig {
1242
1043
  params(discounts: T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
1243
1044
  }
@@ -1254,22 +1055,18 @@ module Stripe
1254
1055
  # The connected account being referenced when `type` is `account`.
1255
1056
  sig { returns(String) }
1256
1057
  attr_accessor :account
1257
-
1258
1058
  # Type of the account referenced in the request.
1259
1059
  sig { returns(String) }
1260
1060
  attr_accessor :type
1261
-
1262
1061
  sig { params(account: String, type: String).void }
1263
1062
  def initialize(account: nil, type: nil); end
1264
1063
  end
1265
1064
  # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
1266
1065
  sig { returns(T::Boolean) }
1267
1066
  attr_accessor :enabled
1268
-
1269
1067
  # 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.
1270
1068
  sig { returns(::Stripe::SubscriptionService::CreateParams::AutomaticTax::Liability) }
1271
1069
  attr_accessor :liability
1272
-
1273
1070
  sig {
1274
1071
  params(enabled: T::Boolean, liability: ::Stripe::SubscriptionService::CreateParams::AutomaticTax::Liability).void
1275
1072
  }
@@ -1279,23 +1076,18 @@ module Stripe
1279
1076
  # The day of the month the billing_cycle_anchor should be. Ranges from 1 to 31.
1280
1077
  sig { returns(Integer) }
1281
1078
  attr_accessor :day_of_month
1282
-
1283
1079
  # The hour of the day the billing_cycle_anchor should be. Ranges from 0 to 23.
1284
1080
  sig { returns(Integer) }
1285
1081
  attr_accessor :hour
1286
-
1287
1082
  # The minute of the hour the billing_cycle_anchor should be. Ranges from 0 to 59.
1288
1083
  sig { returns(Integer) }
1289
1084
  attr_accessor :minute
1290
-
1291
1085
  # The month to start full cycle billing periods. Ranges from 1 to 12.
1292
1086
  sig { returns(Integer) }
1293
1087
  attr_accessor :month
1294
-
1295
1088
  # The second of the minute the billing_cycle_anchor should be. Ranges from 0 to 59.
1296
1089
  sig { returns(Integer) }
1297
1090
  attr_accessor :second
1298
-
1299
1091
  sig {
1300
1092
  params(day_of_month: Integer, hour: Integer, minute: Integer, month: Integer, second: Integer).void
1301
1093
  }
@@ -1305,11 +1097,9 @@ module Stripe
1305
1097
  # Monetary threshold that triggers the subscription to advance to a new billing period
1306
1098
  sig { returns(Integer) }
1307
1099
  attr_accessor :amount_gte
1308
-
1309
1100
  # 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.
1310
1101
  sig { returns(T::Boolean) }
1311
1102
  attr_accessor :reset_billing_cycle_anchor
1312
-
1313
1103
  sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
1314
1104
  def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
1315
1105
  end
@@ -1319,11 +1109,9 @@ module Stripe
1319
1109
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1320
1110
  sig { returns(String) }
1321
1111
  attr_accessor :interval
1322
-
1323
1112
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1324
1113
  sig { returns(Integer) }
1325
1114
  attr_accessor :interval_count
1326
-
1327
1115
  sig { params(interval: String, interval_count: Integer).void }
1328
1116
  def initialize(interval: nil, interval_count: nil); end
1329
1117
  end
@@ -1332,15 +1120,12 @@ module Stripe
1332
1120
  returns(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd::Duration)
1333
1121
  }
1334
1122
  attr_accessor :duration
1335
-
1336
1123
  # A precise Unix timestamp for the discount to end. Must be in the future.
1337
1124
  sig { returns(Integer) }
1338
1125
  attr_accessor :timestamp
1339
-
1340
1126
  # The type of calculation made to determine when the discount ends.
1341
1127
  sig { returns(String) }
1342
1128
  attr_accessor :type
1343
-
1344
1129
  sig {
1345
1130
  params(duration: ::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1346
1131
  }
@@ -1349,19 +1134,15 @@ module Stripe
1349
1134
  # ID of the coupon to create a new discount for.
1350
1135
  sig { returns(String) }
1351
1136
  attr_accessor :coupon
1352
-
1353
1137
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1354
1138
  sig { returns(String) }
1355
1139
  attr_accessor :discount
1356
-
1357
1140
  # Details to determine how long the discount should be applied for.
1358
1141
  sig { returns(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd) }
1359
1142
  attr_accessor :discount_end
1360
-
1361
1143
  # ID of the promotion code to create a new discount for.
1362
1144
  sig { returns(String) }
1363
1145
  attr_accessor :promotion_code
1364
-
1365
1146
  sig {
1366
1147
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd, promotion_code: String).void
1367
1148
  }
@@ -1372,22 +1153,18 @@ module Stripe
1372
1153
  # The connected account being referenced when `type` is `account`.
1373
1154
  sig { returns(String) }
1374
1155
  attr_accessor :account
1375
-
1376
1156
  # Type of the account referenced in the request.
1377
1157
  sig { returns(String) }
1378
1158
  attr_accessor :type
1379
-
1380
1159
  sig { params(account: String, type: String).void }
1381
1160
  def initialize(account: nil, type: nil); end
1382
1161
  end
1383
1162
  # The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
1384
1163
  sig { returns(T.nilable(T::Array[String])) }
1385
1164
  attr_accessor :account_tax_ids
1386
-
1387
1165
  # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1388
1166
  sig { returns(::Stripe::SubscriptionService::CreateParams::InvoiceSettings::Issuer) }
1389
1167
  attr_accessor :issuer
1390
-
1391
1168
  sig {
1392
1169
  params(account_tax_ids: T.nilable(T::Array[String]), issuer: ::Stripe::SubscriptionService::CreateParams::InvoiceSettings::Issuer).void
1393
1170
  }
@@ -1398,7 +1175,6 @@ module Stripe
1398
1175
  # 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))
1399
1176
  sig { returns(Integer) }
1400
1177
  attr_accessor :usage_gte
1401
-
1402
1178
  sig { params(usage_gte: Integer).void }
1403
1179
  def initialize(usage_gte: nil); end
1404
1180
  end
@@ -1408,11 +1184,9 @@ module Stripe
1408
1184
  # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1409
1185
  sig { returns(String) }
1410
1186
  attr_accessor :interval
1411
-
1412
1187
  # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1413
1188
  sig { returns(Integer) }
1414
1189
  attr_accessor :interval_count
1415
-
1416
1190
  sig { params(interval: String, interval_count: Integer).void }
1417
1191
  def initialize(interval: nil, interval_count: nil); end
1418
1192
  end
@@ -1421,15 +1195,12 @@ module Stripe
1421
1195
  returns(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd::Duration)
1422
1196
  }
1423
1197
  attr_accessor :duration
1424
-
1425
1198
  # A precise Unix timestamp for the discount to end. Must be in the future.
1426
1199
  sig { returns(Integer) }
1427
1200
  attr_accessor :timestamp
1428
-
1429
1201
  # The type of calculation made to determine when the discount ends.
1430
1202
  sig { returns(String) }
1431
1203
  attr_accessor :type
1432
-
1433
1204
  sig {
1434
1205
  params(duration: ::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1435
1206
  }
@@ -1438,19 +1209,15 @@ module Stripe
1438
1209
  # ID of the coupon to create a new discount for.
1439
1210
  sig { returns(String) }
1440
1211
  attr_accessor :coupon
1441
-
1442
1212
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1443
1213
  sig { returns(String) }
1444
1214
  attr_accessor :discount
1445
-
1446
1215
  # Details to determine how long the discount should be applied for.
1447
1216
  sig { returns(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd) }
1448
1217
  attr_accessor :discount_end
1449
-
1450
1218
  # ID of the promotion code to create a new discount for.
1451
1219
  sig { returns(String) }
1452
1220
  attr_accessor :promotion_code
1453
-
1454
1221
  sig {
1455
1222
  params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd, promotion_code: String).void
1456
1223
  }
@@ -1461,38 +1228,30 @@ module Stripe
1461
1228
  # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1462
1229
  sig { returns(String) }
1463
1230
  attr_accessor :interval
1464
-
1465
1231
  # 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).
1466
1232
  sig { returns(Integer) }
1467
1233
  attr_accessor :interval_count
1468
-
1469
1234
  sig { params(interval: String, interval_count: Integer).void }
1470
1235
  def initialize(interval: nil, interval_count: nil); end
1471
1236
  end
1472
1237
  # 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).
1473
1238
  sig { returns(String) }
1474
1239
  attr_accessor :currency
1475
-
1476
1240
  # The ID of the product that this price will belong to.
1477
1241
  sig { returns(String) }
1478
1242
  attr_accessor :product
1479
-
1480
1243
  # The recurring components of a price such as `interval` and `interval_count`.
1481
1244
  sig { returns(::Stripe::SubscriptionService::CreateParams::Item::PriceData::Recurring) }
1482
1245
  attr_accessor :recurring
1483
-
1484
1246
  # 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.
1485
1247
  sig { returns(String) }
1486
1248
  attr_accessor :tax_behavior
1487
-
1488
1249
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
1489
1250
  sig { returns(Integer) }
1490
1251
  attr_accessor :unit_amount
1491
-
1492
1252
  # 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.
1493
1253
  sig { returns(String) }
1494
1254
  attr_accessor :unit_amount_decimal
1495
-
1496
1255
  sig {
1497
1256
  params(currency: String, product: String, recurring: ::Stripe::SubscriptionService::CreateParams::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1498
1257
  }
@@ -1509,11 +1268,9 @@ module Stripe
1509
1268
  # 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.
1510
1269
  sig { returns(T::Array[String]) }
1511
1270
  attr_accessor :converts_to
1512
-
1513
1271
  # Determines the type of trial for this item.
1514
1272
  sig { returns(String) }
1515
1273
  attr_accessor :type
1516
-
1517
1274
  sig { params(converts_to: T::Array[String], type: String).void }
1518
1275
  def initialize(converts_to: nil, type: nil); end
1519
1276
  end
@@ -1522,41 +1279,32 @@ module Stripe
1522
1279
  returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Item::BillingThresholds))
1523
1280
  }
1524
1281
  attr_accessor :billing_thresholds
1525
-
1526
1282
  # The coupons to redeem into discounts for the subscription item.
1527
1283
  sig {
1528
1284
  returns(T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount]))
1529
1285
  }
1530
1286
  attr_accessor :discounts
1531
-
1532
1287
  # 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`.
1533
1288
  sig { returns(T::Hash[String, String]) }
1534
1289
  attr_accessor :metadata
1535
-
1536
1290
  # Plan ID for this item, as a string.
1537
1291
  sig { returns(String) }
1538
1292
  attr_accessor :plan
1539
-
1540
1293
  # The ID of the price object.
1541
1294
  sig { returns(String) }
1542
1295
  attr_accessor :price
1543
-
1544
1296
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
1545
1297
  sig { returns(::Stripe::SubscriptionService::CreateParams::Item::PriceData) }
1546
1298
  attr_accessor :price_data
1547
-
1548
1299
  # Quantity for this item.
1549
1300
  sig { returns(Integer) }
1550
1301
  attr_accessor :quantity
1551
-
1552
1302
  # 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
1303
  sig { returns(T.nilable(T::Array[String])) }
1554
1304
  attr_accessor :tax_rates
1555
-
1556
1305
  # Define options to configure the trial on the subscription item.
1557
1306
  sig { returns(::Stripe::SubscriptionService::CreateParams::Item::Trial) }
1558
1307
  attr_accessor :trial
1559
-
1560
1308
  sig {
1561
1309
  params(billing_thresholds: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::BillingThresholds), discounts: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount]), metadata: T::Hash[String, String], plan: String, price: String, price_data: ::Stripe::SubscriptionService::CreateParams::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String]), trial: ::Stripe::SubscriptionService::CreateParams::Item::Trial).void
1562
1310
  }
@@ -1579,7 +1327,6 @@ module Stripe
1579
1327
  # Transaction type of the mandate.
1580
1328
  sig { returns(String) }
1581
1329
  attr_accessor :transaction_type
1582
-
1583
1330
  sig { params(transaction_type: String).void }
1584
1331
  def initialize(transaction_type: nil); end
1585
1332
  end
@@ -1588,11 +1335,9 @@ module Stripe
1588
1335
  returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)
1589
1336
  }
1590
1337
  attr_accessor :mandate_options
1591
-
1592
1338
  # Verification method for the intent
1593
1339
  sig { returns(String) }
1594
1340
  attr_accessor :verification_method
1595
-
1596
1341
  sig {
1597
1342
  params(mandate_options: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions, verification_method: String).void
1598
1343
  }
@@ -1602,7 +1347,6 @@ module Stripe
1602
1347
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
1603
1348
  sig { returns(String) }
1604
1349
  attr_accessor :preferred_language
1605
-
1606
1350
  sig { params(preferred_language: String).void }
1607
1351
  def initialize(preferred_language: nil); end
1608
1352
  end
@@ -1611,15 +1355,12 @@ module Stripe
1611
1355
  # Amount to be charged for future payments.
1612
1356
  sig { returns(Integer) }
1613
1357
  attr_accessor :amount
1614
-
1615
1358
  # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
1616
1359
  sig { returns(String) }
1617
1360
  attr_accessor :amount_type
1618
-
1619
1361
  # A description of the mandate or subscription that is meant to be displayed to the customer.
1620
1362
  sig { returns(String) }
1621
1363
  attr_accessor :description
1622
-
1623
1364
  sig { params(amount: Integer, amount_type: String, description: String).void }
1624
1365
  def initialize(amount: nil, amount_type: nil, description: nil); end
1625
1366
  end
@@ -1628,15 +1369,12 @@ module Stripe
1628
1369
  returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions)
1629
1370
  }
1630
1371
  attr_accessor :mandate_options
1631
-
1632
1372
  # Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
1633
1373
  sig { returns(String) }
1634
1374
  attr_accessor :network
1635
-
1636
1375
  # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
1637
1376
  sig { returns(String) }
1638
1377
  attr_accessor :request_three_d_secure
1639
-
1640
1378
  sig {
1641
1379
  params(mandate_options: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions, network: String, request_three_d_secure: String).void
1642
1380
  }
@@ -1648,7 +1386,6 @@ module Stripe
1648
1386
  # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
1649
1387
  sig { returns(String) }
1650
1388
  attr_accessor :country
1651
-
1652
1389
  sig { params(country: String).void }
1653
1390
  def initialize(country: nil); end
1654
1391
  end
@@ -1657,11 +1394,9 @@ module Stripe
1657
1394
  returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
1658
1395
  }
1659
1396
  attr_accessor :eu_bank_transfer
1660
-
1661
1397
  # The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
1662
1398
  sig { returns(String) }
1663
1399
  attr_accessor :type
1664
-
1665
1400
  sig {
1666
1401
  params(eu_bank_transfer: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, type: String).void
1667
1402
  }
@@ -1672,11 +1407,9 @@ module Stripe
1672
1407
  returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)
1673
1408
  }
1674
1409
  attr_accessor :bank_transfer
1675
-
1676
1410
  # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
1677
1411
  sig { returns(String) }
1678
1412
  attr_accessor :funding_type
1679
-
1680
1413
  sig {
1681
1414
  params(bank_transfer: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String).void
1682
1415
  }
@@ -1697,11 +1430,9 @@ module Stripe
1697
1430
  # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1698
1431
  sig { returns(T::Array[String]) }
1699
1432
  attr_accessor :account_subcategories
1700
-
1701
1433
  # ID of the institution to use to filter for selectable accounts.
1702
1434
  sig { returns(String) }
1703
1435
  attr_accessor :institution
1704
-
1705
1436
  sig { params(account_subcategories: T::Array[String], institution: String).void }
1706
1437
  def initialize(account_subcategories: nil, institution: nil); end
1707
1438
  end
@@ -1710,15 +1441,12 @@ module Stripe
1710
1441
  returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)
1711
1442
  }
1712
1443
  attr_accessor :filters
1713
-
1714
1444
  # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
1715
1445
  sig { returns(T::Array[String]) }
1716
1446
  attr_accessor :permissions
1717
-
1718
1447
  # List of data features that you would like to retrieve upon account creation.
1719
1448
  sig { returns(T::Array[String]) }
1720
1449
  attr_accessor :prefetch
1721
-
1722
1450
  sig {
1723
1451
  params(filters: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters, permissions: T::Array[String], prefetch: T::Array[String]).void
1724
1452
  }
@@ -1729,11 +1457,9 @@ module Stripe
1729
1457
  returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)
1730
1458
  }
1731
1459
  attr_accessor :financial_connections
1732
-
1733
1460
  # Verification method for the intent
1734
1461
  sig { returns(String) }
1735
1462
  attr_accessor :verification_method
1736
-
1737
1463
  sig {
1738
1464
  params(financial_connections: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections, verification_method: String).void
1739
1465
  }
@@ -1744,49 +1470,41 @@ module Stripe
1744
1470
  returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))
1745
1471
  }
1746
1472
  attr_accessor :acss_debit
1747
-
1748
1473
  # This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
1749
1474
  sig {
1750
1475
  returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact))
1751
1476
  }
1752
1477
  attr_accessor :bancontact
1753
-
1754
1478
  # This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
1755
1479
  sig {
1756
1480
  returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card))
1757
1481
  }
1758
1482
  attr_accessor :card
1759
-
1760
1483
  # This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
1761
1484
  sig {
1762
1485
  returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))
1763
1486
  }
1764
1487
  attr_accessor :customer_balance
1765
-
1766
1488
  # This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
1767
1489
  sig {
1768
1490
  returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))
1769
1491
  }
1770
1492
  attr_accessor :id_bank_transfer
1771
-
1772
1493
  # This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
1773
1494
  sig {
1774
1495
  returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini))
1775
1496
  }
1776
1497
  attr_accessor :konbini
1777
-
1778
1498
  # This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
1779
1499
  sig {
1780
1500
  returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))
1781
1501
  }
1782
1502
  attr_accessor :sepa_debit
1783
-
1784
1503
  # This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
1785
1504
  sig {
1786
1505
  returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))
1787
1506
  }
1788
1507
  attr_accessor :us_bank_account
1789
-
1790
1508
  sig {
1791
1509
  params(acss_debit: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit), bancontact: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact), card: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card), customer_balance: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance), id_bank_transfer: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer), konbini: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini), sepa_debit: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)).void
1792
1510
  }
@@ -1806,15 +1524,12 @@ module Stripe
1806
1524
  returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions)
1807
1525
  }
1808
1526
  attr_accessor :payment_method_options
1809
-
1810
1527
  # The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
1811
1528
  sig { returns(T.nilable(T::Array[String])) }
1812
1529
  attr_accessor :payment_method_types
1813
-
1814
1530
  # Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
1815
1531
  sig { returns(String) }
1816
1532
  attr_accessor :save_default_payment_method
1817
-
1818
1533
  sig {
1819
1534
  params(payment_method_options: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions, payment_method_types: T.nilable(T::Array[String]), save_default_payment_method: String).void
1820
1535
  }
@@ -1828,11 +1543,9 @@ module Stripe
1828
1543
  # Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
1829
1544
  sig { returns(String) }
1830
1545
  attr_accessor :interval
1831
-
1832
1546
  # The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
1833
1547
  sig { returns(Integer) }
1834
1548
  attr_accessor :interval_count
1835
-
1836
1549
  sig { params(interval: String, interval_count: Integer).void }
1837
1550
  def initialize(interval: nil, interval_count: nil); end
1838
1551
  end
@@ -1840,11 +1553,9 @@ module Stripe
1840
1553
  # This is used to determine the number of billing cycles to prebill.
1841
1554
  sig { returns(Integer) }
1842
1555
  attr_accessor :iterations
1843
-
1844
1556
  # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
1845
1557
  sig { returns(String) }
1846
1558
  attr_accessor :update_behavior
1847
-
1848
1559
  sig { params(iterations: Integer, update_behavior: String).void }
1849
1560
  def initialize(iterations: nil, update_behavior: nil); end
1850
1561
  end
@@ -1852,11 +1563,9 @@ module Stripe
1852
1563
  # 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.
1853
1564
  sig { returns(Float) }
1854
1565
  attr_accessor :amount_percent
1855
-
1856
1566
  # ID of an existing, connected Stripe account.
1857
1567
  sig { returns(String) }
1858
1568
  attr_accessor :destination
1859
-
1860
1569
  sig { params(amount_percent: Float, destination: String).void }
1861
1570
  def initialize(amount_percent: nil, destination: nil); end
1862
1571
  end
@@ -1865,14 +1574,12 @@ module Stripe
1865
1574
  # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
1866
1575
  sig { returns(String) }
1867
1576
  attr_accessor :missing_payment_method
1868
-
1869
1577
  sig { params(missing_payment_method: String).void }
1870
1578
  def initialize(missing_payment_method: nil); end
1871
1579
  end
1872
1580
  # Defines how the subscription should behave when the user's free trial ends.
1873
1581
  sig { returns(::Stripe::SubscriptionService::CreateParams::TrialSettings::EndBehavior) }
1874
1582
  attr_accessor :end_behavior
1875
-
1876
1583
  sig {
1877
1584
  params(end_behavior: ::Stripe::SubscriptionService::CreateParams::TrialSettings::EndBehavior).void
1878
1585
  }
@@ -1881,103 +1588,78 @@ module Stripe
1881
1588
  # A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
1882
1589
  sig { returns(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem]) }
1883
1590
  attr_accessor :add_invoice_items
1884
-
1885
1591
  # 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).
1886
1592
  sig { returns(T.nilable(Float)) }
1887
1593
  attr_accessor :application_fee_percent
1888
-
1889
1594
  # Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
1890
1595
  sig { returns(::Stripe::SubscriptionService::CreateParams::AutomaticTax) }
1891
1596
  attr_accessor :automatic_tax
1892
-
1893
1597
  # For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
1894
1598
  sig { returns(Integer) }
1895
1599
  attr_accessor :backdate_start_date
1896
-
1897
1600
  # A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
1898
1601
  sig { returns(Integer) }
1899
1602
  attr_accessor :billing_cycle_anchor
1900
-
1901
1603
  # Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.
1902
1604
  sig { returns(::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig) }
1903
1605
  attr_accessor :billing_cycle_anchor_config
1904
-
1905
1606
  # 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.
1906
1607
  sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::BillingThresholds)) }
1907
1608
  attr_accessor :billing_thresholds
1908
-
1909
1609
  # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
1910
1610
  sig { returns(Integer) }
1911
1611
  attr_accessor :cancel_at
1912
-
1913
1612
  # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
1914
1613
  sig { returns(T::Boolean) }
1915
1614
  attr_accessor :cancel_at_period_end
1916
-
1917
1615
  # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`.
1918
1616
  sig { returns(String) }
1919
1617
  attr_accessor :collection_method
1920
-
1921
1618
  # The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
1922
1619
  sig { returns(String) }
1923
1620
  attr_accessor :coupon
1924
-
1925
1621
  # 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).
1926
1622
  sig { returns(String) }
1927
1623
  attr_accessor :currency
1928
-
1929
1624
  # The identifier of the customer to subscribe.
1930
1625
  sig { returns(String) }
1931
1626
  attr_accessor :customer
1932
-
1933
1627
  # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
1934
1628
  sig { returns(Integer) }
1935
1629
  attr_accessor :days_until_due
1936
-
1937
1630
  # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
1938
1631
  sig { returns(String) }
1939
1632
  attr_accessor :default_payment_method
1940
-
1941
1633
  # ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
1942
1634
  sig { returns(String) }
1943
1635
  attr_accessor :default_source
1944
-
1945
1636
  # The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
1946
1637
  sig { returns(T.nilable(T::Array[String])) }
1947
1638
  attr_accessor :default_tax_rates
1948
-
1949
1639
  # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1950
1640
  sig { returns(String) }
1951
1641
  attr_accessor :description
1952
-
1953
1642
  # The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
1954
1643
  sig { returns(T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Discount])) }
1955
1644
  attr_accessor :discounts
1956
-
1957
1645
  # Specifies which fields in the response should be expanded.
1958
1646
  sig { returns(T::Array[String]) }
1959
1647
  attr_accessor :expand
1960
-
1961
1648
  # All invoices will be billed using the specified settings.
1962
1649
  sig { returns(::Stripe::SubscriptionService::CreateParams::InvoiceSettings) }
1963
1650
  attr_accessor :invoice_settings
1964
-
1965
1651
  # A list of up to 20 subscription items, each with an attached price.
1966
1652
  sig { returns(T::Array[::Stripe::SubscriptionService::CreateParams::Item]) }
1967
1653
  attr_accessor :items
1968
-
1969
1654
  # 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`.
1970
1655
  sig { returns(T.nilable(T::Hash[String, String])) }
1971
1656
  attr_accessor :metadata
1972
-
1973
1657
  # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
1974
1658
  sig { returns(T::Boolean) }
1975
1659
  attr_accessor :off_session
1976
-
1977
1660
  # The account on behalf of which to charge, for each of the subscription's invoices.
1978
1661
  sig { returns(T.nilable(String)) }
1979
1662
  attr_accessor :on_behalf_of
1980
-
1981
1663
  # Only applies to subscriptions with `collection_method=charge_automatically`.
1982
1664
  #
1983
1665
  # Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
@@ -1991,49 +1673,38 @@ module Stripe
1991
1673
  # Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.
1992
1674
  sig { returns(String) }
1993
1675
  attr_accessor :payment_behavior
1994
-
1995
1676
  # Payment settings to pass to invoices created by the subscription.
1996
1677
  sig { returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings) }
1997
1678
  attr_accessor :payment_settings
1998
-
1999
1679
  # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
2000
1680
  sig {
2001
1681
  returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PendingInvoiceItemInterval))
2002
1682
  }
2003
1683
  attr_accessor :pending_invoice_item_interval
2004
-
2005
1684
  # If specified, the invoicing for the given billing cycle iterations will be processed now.
2006
1685
  sig { returns(::Stripe::SubscriptionService::CreateParams::Prebilling) }
2007
1686
  attr_accessor :prebilling
2008
-
2009
1687
  # The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
2010
1688
  sig { returns(String) }
2011
1689
  attr_accessor :promotion_code
2012
-
2013
1690
  # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
2014
1691
  sig { returns(String) }
2015
1692
  attr_accessor :proration_behavior
2016
-
2017
1693
  # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
2018
1694
  sig { returns(::Stripe::SubscriptionService::CreateParams::TransferData) }
2019
1695
  attr_accessor :transfer_data
2020
-
2021
1696
  # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
2022
1697
  sig { returns(T.any(String, Integer)) }
2023
1698
  attr_accessor :trial_end
2024
-
2025
1699
  # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
2026
1700
  sig { returns(T::Boolean) }
2027
1701
  attr_accessor :trial_from_plan
2028
-
2029
1702
  # Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
2030
1703
  sig { returns(Integer) }
2031
1704
  attr_accessor :trial_period_days
2032
-
2033
1705
  # Settings related to subscription trials.
2034
1706
  sig { returns(::Stripe::SubscriptionService::CreateParams::TrialSettings) }
2035
1707
  attr_accessor :trial_settings
2036
-
2037
1708
  sig {
2038
1709
  params(add_invoice_items: T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem], application_fee_percent: T.nilable(Float), automatic_tax: ::Stripe::SubscriptionService::CreateParams::AutomaticTax, backdate_start_date: Integer, billing_cycle_anchor: Integer, billing_cycle_anchor_config: ::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig, billing_thresholds: T.nilable(::Stripe::SubscriptionService::CreateParams::BillingThresholds), cancel_at: Integer, cancel_at_period_end: T::Boolean, collection_method: String, coupon: String, currency: String, customer: String, days_until_due: Integer, default_payment_method: String, default_source: String, default_tax_rates: T.nilable(T::Array[String]), description: String, discounts: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Discount]), expand: T::Array[String], invoice_settings: ::Stripe::SubscriptionService::CreateParams::InvoiceSettings, items: T::Array[::Stripe::SubscriptionService::CreateParams::Item], metadata: T.nilable(T::Hash[String, String]), off_session: T::Boolean, on_behalf_of: T.nilable(String), payment_behavior: String, payment_settings: ::Stripe::SubscriptionService::CreateParams::PaymentSettings, pending_invoice_item_interval: T.nilable(::Stripe::SubscriptionService::CreateParams::PendingInvoiceItemInterval), prebilling: ::Stripe::SubscriptionService::CreateParams::Prebilling, promotion_code: String, proration_behavior: String, transfer_data: ::Stripe::SubscriptionService::CreateParams::TransferData, trial_end: T.any(String, Integer), trial_from_plan: T::Boolean, trial_period_days: Integer, trial_settings: ::Stripe::SubscriptionService::CreateParams::TrialSettings).void
2039
1710
  }
@@ -2080,19 +1751,15 @@ module Stripe
2080
1751
  # Specifies which fields in the response should be expanded.
2081
1752
  sig { returns(T::Array[String]) }
2082
1753
  attr_accessor :expand
2083
-
2084
1754
  # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
2085
1755
  sig { returns(Integer) }
2086
1756
  attr_accessor :limit
2087
-
2088
1757
  # A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
2089
1758
  sig { returns(String) }
2090
1759
  attr_accessor :page
2091
-
2092
1760
  # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).
2093
1761
  sig { returns(String) }
2094
1762
  attr_accessor :query
2095
-
2096
1763
  sig { params(expand: T::Array[String], limit: Integer, page: String, query: String).void }
2097
1764
  def initialize(expand: nil, limit: nil, page: nil, query: nil); end
2098
1765
  end
@@ -2100,19 +1767,15 @@ module Stripe
2100
1767
  # The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
2101
1768
  sig { returns(String) }
2102
1769
  attr_accessor :billing_cycle_anchor
2103
-
2104
1770
  # Specifies which fields in the response should be expanded.
2105
1771
  sig { returns(T::Array[String]) }
2106
1772
  attr_accessor :expand
2107
-
2108
1773
  # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
2109
1774
  sig { returns(String) }
2110
1775
  attr_accessor :proration_behavior
2111
-
2112
1776
  # If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
2113
1777
  sig { returns(Integer) }
2114
1778
  attr_accessor :proration_date
2115
-
2116
1779
  sig {
2117
1780
  params(billing_cycle_anchor: String, expand: T::Array[String], proration_behavior: String, proration_date: Integer).void
2118
1781
  }