stripe 15.3.0 → 15.4.0.pre.beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (589) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +1594 -667
  4. data/README.md +1 -1
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_requestor.rb +28 -0
  7. data/lib/stripe/api_version.rb +1 -2
  8. data/lib/stripe/errors.rb +54 -0
  9. data/lib/stripe/event_types.rb +98 -0
  10. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  17. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  19. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  21. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  22. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  23. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  24. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  25. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  26. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  32. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  50. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  52. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  53. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  58. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  59. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  60. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
  61. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  62. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  65. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  66. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  67. data/lib/stripe/object_types.rb +50 -0
  68. data/lib/stripe/resources/account.rb +653 -1
  69. data/lib/stripe/resources/account_notice.rb +123 -0
  70. data/lib/stripe/resources/account_session.rb +256 -1
  71. data/lib/stripe/resources/balance_settings.rb +105 -0
  72. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  73. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  74. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  75. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  76. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  77. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  78. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  79. data/lib/stripe/resources/card.rb +2 -0
  80. data/lib/stripe/resources/cash_balance.rb +2 -0
  81. data/lib/stripe/resources/charge.rb +1538 -0
  82. data/lib/stripe/resources/checkout/session.rb +326 -2
  83. data/lib/stripe/resources/confirmation_token.rb +170 -0
  84. data/lib/stripe/resources/coupon.rb +30 -1
  85. data/lib/stripe/resources/credit_note.rb +6 -0
  86. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  87. data/lib/stripe/resources/customer.rb +2 -0
  88. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  89. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  90. data/lib/stripe/resources/customer_session.rb +6 -1
  91. data/lib/stripe/resources/discount.rb +2 -0
  92. data/lib/stripe/resources/dispute.rb +2 -0
  93. data/lib/stripe/resources/event.rb +31 -0
  94. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  95. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  96. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  97. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  98. data/lib/stripe/resources/fx_quote.rb +184 -0
  99. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  100. data/lib/stripe/resources/invoice.rb +1063 -16
  101. data/lib/stripe/resources/invoice_item.rb +78 -2
  102. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  103. data/lib/stripe/resources/invoice_payment.rb +2 -53
  104. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  105. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  106. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  107. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  108. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  109. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  110. data/lib/stripe/resources/line_item.rb +37 -0
  111. data/lib/stripe/resources/mandate.rb +24 -0
  112. data/lib/stripe/resources/margin.rb +115 -0
  113. data/lib/stripe/resources/order.rb +2958 -0
  114. data/lib/stripe/resources/payment_attempt_record.rb +1099 -0
  115. data/lib/stripe/resources/payment_intent.rb +8540 -3584
  116. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  117. data/lib/stripe/resources/payment_method.rb +192 -1
  118. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  119. data/lib/stripe/resources/payment_record.rb +1628 -0
  120. data/lib/stripe/resources/payout.rb +6 -0
  121. data/lib/stripe/resources/price.rb +30 -0
  122. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  123. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  124. data/lib/stripe/resources/promotion_code.rb +10 -0
  125. data/lib/stripe/resources/quote.rb +2038 -7
  126. data/lib/stripe/resources/quote_line.rb +274 -0
  127. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  128. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +371 -0
  129. data/lib/stripe/resources/refund.rb +9 -0
  130. data/lib/stripe/resources/setup_attempt.rb +21 -0
  131. data/lib/stripe/resources/setup_intent.rb +578 -9
  132. data/lib/stripe/resources/source.rb +29 -0
  133. data/lib/stripe/resources/subscription.rb +288 -9
  134. data/lib/stripe/resources/subscription_item.rb +84 -3
  135. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  136. data/lib/stripe/resources/tax/association.rb +66 -0
  137. data/lib/stripe/resources/tax/form.rb +211 -0
  138. data/lib/stripe/resources/tax_id.rb +12 -2
  139. data/lib/stripe/resources/terminal/reader.rb +8 -0
  140. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  141. data/lib/stripe/resources/transfer.rb +6 -0
  142. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  143. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  144. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  145. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  146. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  147. data/lib/stripe/resources/v2/core/account.rb +1755 -0
  148. data/lib/stripe/resources/v2/core/account_link.rb +56 -0
  149. data/lib/stripe/resources/v2/core/person.rb +276 -0
  150. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  151. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  152. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  153. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  154. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  155. data/lib/stripe/resources/v2/money_management/financial_account.rb +58 -0
  156. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  157. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  158. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  159. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  160. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  161. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  162. data/lib/stripe/resources/v2/money_management/payout_method.rb +75 -0
  163. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  164. data/lib/stripe/resources/v2/money_management/received_credit.rb +122 -0
  165. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  166. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  167. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  168. data/lib/stripe/resources/v2/payments/off_session_payment.rb +72 -0
  169. data/lib/stripe/resources.rb +104 -0
  170. data/lib/stripe/services/account_notice_service.rb +101 -0
  171. data/lib/stripe/services/account_service.rb +562 -1
  172. data/lib/stripe/services/account_session_service.rb +226 -1
  173. data/lib/stripe/services/balance_settings_service.rb +96 -0
  174. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  175. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  176. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  177. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  178. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  179. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  180. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  181. data/lib/stripe/services/capital_service.rb +15 -0
  182. data/lib/stripe/services/charge_service.rb +1418 -0
  183. data/lib/stripe/services/checkout/session_service.rb +243 -2
  184. data/lib/stripe/services/coupon_service.rb +17 -1
  185. data/lib/stripe/services/credit_note_service.rb +4 -0
  186. data/lib/stripe/services/customer_session_service.rb +4 -1
  187. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  188. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  189. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  190. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  191. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  192. data/lib/stripe/services/financial_connections_service.rb +2 -1
  193. data/lib/stripe/services/fx_quote_service.rb +123 -0
  194. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  195. data/lib/stripe/services/invoice_item_service.rb +74 -2
  196. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  197. data/lib/stripe/services/invoice_service.rb +1014 -16
  198. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  199. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  200. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  201. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  202. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  203. data/lib/stripe/services/issuing_service.rb +5 -1
  204. data/lib/stripe/services/margin_service.rb +119 -0
  205. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  206. data/lib/stripe/services/order_service.rb +2388 -0
  207. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  208. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  209. data/lib/stripe/services/payment_intent_service.rb +4879 -391
  210. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  211. data/lib/stripe/services/payment_method_service.rb +120 -1
  212. data/lib/stripe/services/payment_record_service.rb +542 -0
  213. data/lib/stripe/services/payout_service.rb +4 -0
  214. data/lib/stripe/services/price_service.rb +19 -0
  215. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  216. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  217. data/lib/stripe/services/privacy_service.rb +13 -0
  218. data/lib/stripe/services/promotion_code_service.rb +8 -0
  219. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  220. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  221. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  222. data/lib/stripe/services/quote_service.rb +1723 -8
  223. data/lib/stripe/services/setup_intent_service.rb +538 -9
  224. data/lib/stripe/services/subscription_item_service.rb +75 -3
  225. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  226. data/lib/stripe/services/subscription_service.rb +249 -9
  227. data/lib/stripe/services/tax/association_service.rb +31 -0
  228. data/lib/stripe/services/tax/form_service.rb +100 -0
  229. data/lib/stripe/services/tax_id_service.rb +8 -2
  230. data/lib/stripe/services/tax_service.rb +3 -1
  231. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  232. data/lib/stripe/services/terminal_service.rb +2 -1
  233. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  234. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  235. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  236. data/lib/stripe/services/transfer_service.rb +4 -0
  237. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  238. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  239. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  240. data/lib/stripe/services/v1_services.rb +11 -2
  241. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  242. data/lib/stripe/services/v2/core/account_service.rb +4170 -0
  243. data/lib/stripe/services/v2/core/accounts/person_service.rb +1045 -0
  244. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +130 -0
  245. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  246. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  247. data/lib/stripe/services/v2/core_service.rb +4 -1
  248. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  249. data/lib/stripe/services/v2/money_management/financial_account_service.rb +43 -0
  250. data/lib/stripe/services/v2/money_management/financial_address_service.rb +82 -0
  251. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  252. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  253. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +199 -0
  254. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  255. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  256. data/lib/stripe/services/v2/money_management/payout_method_service.rb +90 -0
  257. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  258. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  259. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  260. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  261. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  262. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  263. data/lib/stripe/services/v2/payment_service.rb +15 -0
  264. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +137 -0
  265. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  266. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +49 -0
  267. data/lib/stripe/services/v2_services.rb +4 -1
  268. data/lib/stripe/services.rb +53 -1
  269. data/lib/stripe/stripe_configuration.rb +3 -1
  270. data/lib/stripe/stripe_object.rb +1 -1
  271. data/lib/stripe/util.rb +7 -1
  272. data/lib/stripe/version.rb +1 -1
  273. data/lib/stripe.rb +53 -0
  274. data/rbi/stripe.rbi +193855 -0
  275. data/stripe.gemspec +4 -1
  276. metadata +161 -324
  277. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  278. data/rbi/stripe/resources/account.rbi +0 -4995
  279. data/rbi/stripe/resources/account_link.rbi +0 -74
  280. data/rbi/stripe/resources/account_session.rbi +0 -1013
  281. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  282. data/rbi/stripe/resources/application.rbi +0 -20
  283. data/rbi/stripe/resources/application_fee.rbi +0 -118
  284. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  285. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  286. data/rbi/stripe/resources/balance.rbi +0 -235
  287. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  288. data/rbi/stripe/resources/bank_account.rbi +0 -127
  289. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  290. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  291. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  292. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  293. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  294. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  295. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  296. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  297. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  298. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  299. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  300. data/rbi/stripe/resources/capability.rbi +0 -125
  301. data/rbi/stripe/resources/card.rbi +0 -125
  302. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  303. data/rbi/stripe/resources/charge.rbi +0 -2086
  304. data/rbi/stripe/resources/checkout/session.rbi +0 -4060
  305. data/rbi/stripe/resources/climate/order.rbi +0 -245
  306. data/rbi/stripe/resources/climate/product.rbi +0 -75
  307. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  308. data/rbi/stripe/resources/confirmation_token.rbi +0 -1818
  309. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  310. data/rbi/stripe/resources/country_spec.rbi +0 -85
  311. data/rbi/stripe/resources/coupon.rbi +0 -250
  312. data/rbi/stripe/resources/credit_note.rbi +0 -752
  313. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  314. data/rbi/stripe/resources/customer.rbi +0 -1005
  315. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  316. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  317. data/rbi/stripe/resources/customer_session.rbi +0 -200
  318. data/rbi/stripe/resources/discount.rbi +0 -53
  319. data/rbi/stripe/resources/dispute.rbi +0 -761
  320. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  321. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  322. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  323. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  324. data/rbi/stripe/resources/event.rbi +0 -149
  325. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  326. data/rbi/stripe/resources/file.rbi +0 -143
  327. data/rbi/stripe/resources/file_link.rbi +0 -141
  328. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  329. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  330. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  331. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  332. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  333. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  334. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  335. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  336. data/rbi/stripe/resources/identity/verification_session.rbi +0 -564
  337. data/rbi/stripe/resources/invoice.rbi +0 -3842
  338. data/rbi/stripe/resources/invoice_item.rbi +0 -470
  339. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  340. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  341. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  342. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  343. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  344. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  345. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  346. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  347. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  348. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  349. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  350. data/rbi/stripe/resources/line_item.rbi +0 -72
  351. data/rbi/stripe/resources/login_link.rbi +0 -19
  352. data/rbi/stripe/resources/mandate.rbi +0 -191
  353. data/rbi/stripe/resources/payment_intent.rbi +0 -9987
  354. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  355. data/rbi/stripe/resources/payment_method.rbi +0 -1770
  356. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  357. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  358. data/rbi/stripe/resources/payout.rbi +0 -300
  359. data/rbi/stripe/resources/person.rbi +0 -401
  360. data/rbi/stripe/resources/plan.rbi +0 -371
  361. data/rbi/stripe/resources/price.rbi +0 -694
  362. data/rbi/stripe/resources/product.rbi +0 -555
  363. data/rbi/stripe/resources/product_feature.rbi +0 -26
  364. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  365. data/rbi/stripe/resources/quote.rbi +0 -1145
  366. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  367. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  368. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  369. data/rbi/stripe/resources/refund.rbi +0 -523
  370. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  371. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  372. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  373. data/rbi/stripe/resources/reversal.rbi +0 -51
  374. data/rbi/stripe/resources/review.rbi +0 -154
  375. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  376. data/rbi/stripe/resources/setup_intent.rbi +0 -3978
  377. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  378. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  379. data/rbi/stripe/resources/source.rbi +0 -1496
  380. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  381. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  382. data/rbi/stripe/resources/subscription.rbi +0 -2080
  383. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  384. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1645
  385. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  386. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  387. data/rbi/stripe/resources/tax/registration.rbi +0 -2732
  388. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  389. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  390. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  391. data/rbi/stripe/resources/tax_code.rbi +0 -44
  392. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  393. data/rbi/stripe/resources/tax_id.rbi +0 -165
  394. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  395. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1387
  396. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  397. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  398. data/rbi/stripe/resources/terminal/reader.rbi +0 -994
  399. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  400. data/rbi/stripe/resources/token.rbi +0 -1283
  401. data/rbi/stripe/resources/topup.rbi +0 -222
  402. data/rbi/stripe/resources/transfer.rbi +0 -199
  403. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  404. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  405. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -869
  406. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  407. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  408. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  409. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  410. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  411. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  412. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  413. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  414. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  415. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  416. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  417. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  418. data/rbi/stripe/resources/v2/event.rbi +0 -48
  419. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  420. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  421. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  422. data/rbi/stripe/services/account_link_service.rbi +0 -58
  423. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  424. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  425. data/rbi/stripe/services/account_service.rbi +0 -4281
  426. data/rbi/stripe/services/account_session_service.rbi +0 -646
  427. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  428. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  429. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  430. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  431. data/rbi/stripe/services/apps_service.rbi +0 -9
  432. data/rbi/stripe/services/balance_service.rbi +0 -21
  433. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  434. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  435. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  436. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  437. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  438. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  439. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  440. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  441. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  442. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  443. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  444. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  445. data/rbi/stripe/services/billing_service.rbi +0 -15
  446. data/rbi/stripe/services/charge_service.rbi +0 -448
  447. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  448. data/rbi/stripe/services/checkout/session_service.rbi +0 -2670
  449. data/rbi/stripe/services/checkout_service.rbi +0 -9
  450. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  451. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  452. data/rbi/stripe/services/climate_service.rbi +0 -11
  453. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  454. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  455. data/rbi/stripe/services/coupon_service.rbi +0 -194
  456. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  457. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  458. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  459. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  460. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  461. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  462. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  463. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  464. data/rbi/stripe/services/customer_service.rbi +0 -647
  465. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  466. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  467. data/rbi/stripe/services/dispute_service.rbi +0 -424
  468. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  469. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  470. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  471. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  472. data/rbi/stripe/services/event_service.rbi +0 -83
  473. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  474. data/rbi/stripe/services/file_link_service.rbi +0 -124
  475. data/rbi/stripe/services/file_service.rbi +0 -116
  476. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  477. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  478. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  479. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  480. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  481. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  482. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  483. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  484. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -339
  485. data/rbi/stripe/services/identity_service.rbi +0 -10
  486. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  487. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  488. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  489. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  490. data/rbi/stripe/services/invoice_service.rbi +0 -3011
  491. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  492. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  493. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  494. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  495. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  496. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  497. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  498. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  499. data/rbi/stripe/services/issuing_service.rbi +0 -16
  500. data/rbi/stripe/services/mandate_service.rbi +0 -20
  501. data/rbi/stripe/services/payment_intent_service.rbi +0 -7989
  502. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  503. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  504. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  505. data/rbi/stripe/services/payment_method_service.rbi +0 -781
  506. data/rbi/stripe/services/payout_service.rbi +0 -205
  507. data/rbi/stripe/services/plan_service.rbi +0 -282
  508. data/rbi/stripe/services/price_service.rbi +0 -546
  509. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  510. data/rbi/stripe/services/product_service.rbi +0 -477
  511. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  512. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  513. data/rbi/stripe/services/quote_service.rbi +0 -699
  514. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  515. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  516. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  517. data/rbi/stripe/services/radar_service.rbi +0 -11
  518. data/rbi/stripe/services/refund_service.rbi +0 -185
  519. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  520. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  521. data/rbi/stripe/services/reporting_service.rbi +0 -10
  522. data/rbi/stripe/services/review_service.rbi +0 -84
  523. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  524. data/rbi/stripe/services/setup_intent_service.rbi +0 -3709
  525. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  526. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  527. data/rbi/stripe/services/sigma_service.rbi +0 -9
  528. data/rbi/stripe/services/source_service.rbi +0 -663
  529. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  530. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1301
  531. data/rbi/stripe/services/subscription_service.rbi +0 -1684
  532. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  533. data/rbi/stripe/services/tax/registration_service.rbi +0 -1858
  534. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  535. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  536. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  537. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  538. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  539. data/rbi/stripe/services/tax_service.rbi +0 -12
  540. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1118
  541. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  542. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  543. data/rbi/stripe/services/terminal/reader_service.rbi +0 -540
  544. data/rbi/stripe/services/terminal_service.rbi +0 -12
  545. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  546. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  547. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  548. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  549. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  550. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  551. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  552. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  553. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  554. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  555. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  556. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  557. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  558. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  559. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  560. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  561. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  562. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  563. data/rbi/stripe/services/token_service.rbi +0 -1257
  564. data/rbi/stripe/services/topup_service.rbi +0 -176
  565. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  566. data/rbi/stripe/services/transfer_service.rbi +0 -152
  567. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  568. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  569. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  570. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  571. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  572. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  573. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  574. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  575. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  576. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  577. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  578. data/rbi/stripe/services/treasury_service.rbi +0 -18
  579. data/rbi/stripe/services/v1_services.rbi +0 -77
  580. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  581. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  582. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  583. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  584. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  585. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  586. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  587. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  588. data/rbi/stripe/services/v2_services.rbi +0 -10
  589. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,1301 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- class SubscriptionScheduleService < StripeService
7
- class ListParams < Stripe::RequestParams
8
- class CanceledAt < Stripe::RequestParams
9
- # Minimum value to filter by (exclusive)
10
- sig { returns(T.nilable(Integer)) }
11
- attr_accessor :gt
12
- # Minimum value to filter by (inclusive)
13
- sig { returns(T.nilable(Integer)) }
14
- attr_accessor :gte
15
- # Maximum value to filter by (exclusive)
16
- sig { returns(T.nilable(Integer)) }
17
- attr_accessor :lt
18
- # Maximum value to filter by (inclusive)
19
- sig { returns(T.nilable(Integer)) }
20
- attr_accessor :lte
21
- sig {
22
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
23
- }
24
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
25
- end
26
- class CompletedAt < Stripe::RequestParams
27
- # Minimum value to filter by (exclusive)
28
- sig { returns(T.nilable(Integer)) }
29
- attr_accessor :gt
30
- # Minimum value to filter by (inclusive)
31
- sig { returns(T.nilable(Integer)) }
32
- attr_accessor :gte
33
- # Maximum value to filter by (exclusive)
34
- sig { returns(T.nilable(Integer)) }
35
- attr_accessor :lt
36
- # Maximum value to filter by (inclusive)
37
- sig { returns(T.nilable(Integer)) }
38
- attr_accessor :lte
39
- sig {
40
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
41
- }
42
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
43
- end
44
- class Created < Stripe::RequestParams
45
- # Minimum value to filter by (exclusive)
46
- sig { returns(T.nilable(Integer)) }
47
- attr_accessor :gt
48
- # Minimum value to filter by (inclusive)
49
- sig { returns(T.nilable(Integer)) }
50
- attr_accessor :gte
51
- # Maximum value to filter by (exclusive)
52
- sig { returns(T.nilable(Integer)) }
53
- attr_accessor :lt
54
- # Maximum value to filter by (inclusive)
55
- sig { returns(T.nilable(Integer)) }
56
- attr_accessor :lte
57
- sig {
58
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
59
- }
60
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
61
- end
62
- class ReleasedAt < Stripe::RequestParams
63
- # Minimum value to filter by (exclusive)
64
- sig { returns(T.nilable(Integer)) }
65
- attr_accessor :gt
66
- # Minimum value to filter by (inclusive)
67
- sig { returns(T.nilable(Integer)) }
68
- attr_accessor :gte
69
- # Maximum value to filter by (exclusive)
70
- sig { returns(T.nilable(Integer)) }
71
- attr_accessor :lt
72
- # Maximum value to filter by (inclusive)
73
- sig { returns(T.nilable(Integer)) }
74
- attr_accessor :lte
75
- sig {
76
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
77
- }
78
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
79
- end
80
- # Only return subscription schedules that were created canceled the given date interval.
81
- sig {
82
- returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CanceledAt, Integer)))
83
- }
84
- attr_accessor :canceled_at
85
- # Only return subscription schedules that completed during the given date interval.
86
- sig {
87
- returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CompletedAt, Integer)))
88
- }
89
- attr_accessor :completed_at
90
- # Only return subscription schedules that were created during the given date interval.
91
- sig {
92
- returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::Created, Integer)))
93
- }
94
- attr_accessor :created
95
- # Only return subscription schedules for the given customer.
96
- sig { returns(T.nilable(String)) }
97
- attr_accessor :customer
98
- # 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.
99
- sig { returns(T.nilable(String)) }
100
- attr_accessor :ending_before
101
- # Specifies which fields in the response should be expanded.
102
- sig { returns(T.nilable(T::Array[String])) }
103
- attr_accessor :expand
104
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
105
- sig { returns(T.nilable(Integer)) }
106
- attr_accessor :limit
107
- # Only return subscription schedules that were released during the given date interval.
108
- sig {
109
- returns(T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::ReleasedAt, Integer)))
110
- }
111
- attr_accessor :released_at
112
- # Only return subscription schedules that have not started yet.
113
- sig { returns(T.nilable(T::Boolean)) }
114
- attr_accessor :scheduled
115
- # 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.
116
- sig { returns(T.nilable(String)) }
117
- attr_accessor :starting_after
118
- sig {
119
- params(canceled_at: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CanceledAt, Integer)), completed_at: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::CompletedAt, Integer)), created: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), released_at: T.nilable(T.any(::Stripe::SubscriptionScheduleService::ListParams::ReleasedAt, Integer)), scheduled: T.nilable(T::Boolean), starting_after: T.nilable(String)).void
120
- }
121
- def initialize(
122
- canceled_at: nil,
123
- completed_at: nil,
124
- created: nil,
125
- customer: nil,
126
- ending_before: nil,
127
- expand: nil,
128
- limit: nil,
129
- released_at: nil,
130
- scheduled: nil,
131
- starting_after: nil
132
- ); end
133
- end
134
- class CreateParams < Stripe::RequestParams
135
- class BillingMode < Stripe::RequestParams
136
- # Attribute for param field type
137
- sig { returns(String) }
138
- attr_accessor :type
139
- sig { params(type: String).void }
140
- def initialize(type: nil); end
141
- end
142
- class DefaultSettings < Stripe::RequestParams
143
- class AutomaticTax < Stripe::RequestParams
144
- class Liability < Stripe::RequestParams
145
- # The connected account being referenced when `type` is `account`.
146
- sig { returns(T.nilable(String)) }
147
- attr_accessor :account
148
- # Type of the account referenced in the request.
149
- sig { returns(String) }
150
- attr_accessor :type
151
- sig { params(account: T.nilable(String), type: String).void }
152
- def initialize(account: nil, type: nil); end
153
- end
154
- # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
155
- sig { returns(T::Boolean) }
156
- attr_accessor :enabled
157
- # 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.
158
- sig {
159
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax::Liability))
160
- }
161
- attr_accessor :liability
162
- sig {
163
- params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax::Liability)).void
164
- }
165
- def initialize(enabled: nil, liability: nil); end
166
- end
167
- class BillingThresholds < Stripe::RequestParams
168
- # Monetary threshold that triggers the subscription to advance to a new billing period
169
- sig { returns(T.nilable(Integer)) }
170
- attr_accessor :amount_gte
171
- # 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.
172
- sig { returns(T.nilable(T::Boolean)) }
173
- attr_accessor :reset_billing_cycle_anchor
174
- sig {
175
- params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
176
- }
177
- def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
178
- end
179
- class InvoiceSettings < Stripe::RequestParams
180
- class Issuer < Stripe::RequestParams
181
- # The connected account being referenced when `type` is `account`.
182
- sig { returns(T.nilable(String)) }
183
- attr_accessor :account
184
- # Type of the account referenced in the request.
185
- sig { returns(String) }
186
- attr_accessor :type
187
- sig { params(account: T.nilable(String), type: String).void }
188
- def initialize(account: nil, type: nil); end
189
- end
190
- # The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
191
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
192
- attr_accessor :account_tax_ids
193
- # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
194
- sig { returns(T.nilable(Integer)) }
195
- attr_accessor :days_until_due
196
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
197
- sig {
198
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings::Issuer))
199
- }
200
- attr_accessor :issuer
201
- sig {
202
- params(account_tax_ids: T.nilable(T.nilable(T.any(String, T::Array[String]))), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings::Issuer)).void
203
- }
204
- def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
205
- end
206
- class TransferData < Stripe::RequestParams
207
- # 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.
208
- sig { returns(T.nilable(Float)) }
209
- attr_accessor :amount_percent
210
- # ID of an existing, connected Stripe account.
211
- sig { returns(String) }
212
- attr_accessor :destination
213
- sig { params(amount_percent: T.nilable(Float), destination: String).void }
214
- def initialize(amount_percent: nil, destination: nil); end
215
- end
216
- # 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).
217
- sig { returns(T.nilable(Float)) }
218
- attr_accessor :application_fee_percent
219
- # Default settings for automatic tax computation.
220
- sig {
221
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax))
222
- }
223
- attr_accessor :automatic_tax
224
- # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
225
- sig { returns(T.nilable(String)) }
226
- attr_accessor :billing_cycle_anchor
227
- # 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.
228
- sig {
229
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::BillingThresholds))))
230
- }
231
- attr_accessor :billing_thresholds
232
- # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
233
- sig { returns(T.nilable(String)) }
234
- attr_accessor :collection_method
235
- # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
236
- sig { returns(T.nilable(String)) }
237
- attr_accessor :default_payment_method
238
- # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
239
- sig { returns(T.nilable(T.nilable(String))) }
240
- attr_accessor :description
241
- # All invoices will be billed using the specified settings.
242
- sig {
243
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings))
244
- }
245
- attr_accessor :invoice_settings
246
- # The account on behalf of which to charge, for each of the associated subscription's invoices.
247
- sig { returns(T.nilable(T.nilable(String))) }
248
- attr_accessor :on_behalf_of
249
- # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
250
- sig {
251
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::TransferData))))
252
- }
253
- attr_accessor :transfer_data
254
- sig {
255
- params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::BillingThresholds))), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(T.nilable(String)), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::TransferData)))).void
256
- }
257
- def initialize(
258
- application_fee_percent: nil,
259
- automatic_tax: nil,
260
- billing_cycle_anchor: nil,
261
- billing_thresholds: nil,
262
- collection_method: nil,
263
- default_payment_method: nil,
264
- description: nil,
265
- invoice_settings: nil,
266
- on_behalf_of: nil,
267
- transfer_data: nil
268
- ); end
269
- end
270
- class Phase < Stripe::RequestParams
271
- class AddInvoiceItem < Stripe::RequestParams
272
- class Discount < Stripe::RequestParams
273
- # ID of the coupon to create a new discount for.
274
- sig { returns(T.nilable(String)) }
275
- attr_accessor :coupon
276
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
277
- sig { returns(T.nilable(String)) }
278
- attr_accessor :discount
279
- # ID of the promotion code to create a new discount for.
280
- sig { returns(T.nilable(String)) }
281
- attr_accessor :promotion_code
282
- sig {
283
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
284
- }
285
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
286
- end
287
- class PriceData < Stripe::RequestParams
288
- # 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).
289
- sig { returns(String) }
290
- attr_accessor :currency
291
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
292
- sig { returns(String) }
293
- attr_accessor :product
294
- # 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.
295
- sig { returns(T.nilable(String)) }
296
- attr_accessor :tax_behavior
297
- # 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.
298
- sig { returns(T.nilable(Integer)) }
299
- attr_accessor :unit_amount
300
- # 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.
301
- sig { returns(T.nilable(String)) }
302
- attr_accessor :unit_amount_decimal
303
- sig {
304
- params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
305
- }
306
- def initialize(
307
- currency: nil,
308
- product: nil,
309
- tax_behavior: nil,
310
- unit_amount: nil,
311
- unit_amount_decimal: nil
312
- ); end
313
- end
314
- # The coupons to redeem into discounts for the item.
315
- sig {
316
- returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount]))
317
- }
318
- attr_accessor :discounts
319
- # The ID of the price object. One of `price` or `price_data` is required.
320
- sig { returns(T.nilable(String)) }
321
- attr_accessor :price
322
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
323
- sig {
324
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::PriceData))
325
- }
326
- attr_accessor :price_data
327
- # Quantity for this item. Defaults to 1.
328
- sig { returns(T.nilable(Integer)) }
329
- attr_accessor :quantity
330
- # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
331
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
332
- attr_accessor :tax_rates
333
- sig {
334
- params(discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::Discount]), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
335
- }
336
- def initialize(
337
- discounts: nil,
338
- price: nil,
339
- price_data: nil,
340
- quantity: nil,
341
- tax_rates: nil
342
- ); end
343
- end
344
- class AutomaticTax < Stripe::RequestParams
345
- class Liability < Stripe::RequestParams
346
- # The connected account being referenced when `type` is `account`.
347
- sig { returns(T.nilable(String)) }
348
- attr_accessor :account
349
- # Type of the account referenced in the request.
350
- sig { returns(String) }
351
- attr_accessor :type
352
- sig { params(account: T.nilable(String), type: String).void }
353
- def initialize(account: nil, type: nil); end
354
- end
355
- # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
356
- sig { returns(T::Boolean) }
357
- attr_accessor :enabled
358
- # 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.
359
- sig {
360
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax::Liability))
361
- }
362
- attr_accessor :liability
363
- sig {
364
- params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax::Liability)).void
365
- }
366
- def initialize(enabled: nil, liability: nil); end
367
- end
368
- class BillingThresholds < Stripe::RequestParams
369
- # Monetary threshold that triggers the subscription to advance to a new billing period
370
- sig { returns(T.nilable(Integer)) }
371
- attr_accessor :amount_gte
372
- # 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.
373
- sig { returns(T.nilable(T::Boolean)) }
374
- attr_accessor :reset_billing_cycle_anchor
375
- sig {
376
- params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
377
- }
378
- def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
379
- end
380
- class Discount < Stripe::RequestParams
381
- # ID of the coupon to create a new discount for.
382
- sig { returns(T.nilable(String)) }
383
- attr_accessor :coupon
384
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
385
- sig { returns(T.nilable(String)) }
386
- attr_accessor :discount
387
- # ID of the promotion code to create a new discount for.
388
- sig { returns(T.nilable(String)) }
389
- attr_accessor :promotion_code
390
- sig {
391
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
392
- }
393
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
394
- end
395
- class InvoiceSettings < Stripe::RequestParams
396
- class Issuer < Stripe::RequestParams
397
- # The connected account being referenced when `type` is `account`.
398
- sig { returns(T.nilable(String)) }
399
- attr_accessor :account
400
- # Type of the account referenced in the request.
401
- sig { returns(String) }
402
- attr_accessor :type
403
- sig { params(account: T.nilable(String), type: String).void }
404
- def initialize(account: nil, type: nil); end
405
- end
406
- # The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
407
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
408
- attr_accessor :account_tax_ids
409
- # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
410
- sig { returns(T.nilable(Integer)) }
411
- attr_accessor :days_until_due
412
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
413
- sig {
414
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings::Issuer))
415
- }
416
- attr_accessor :issuer
417
- sig {
418
- params(account_tax_ids: T.nilable(T.nilable(T.any(String, T::Array[String]))), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings::Issuer)).void
419
- }
420
- def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
421
- end
422
- class Item < Stripe::RequestParams
423
- class BillingThresholds < Stripe::RequestParams
424
- # 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))
425
- sig { returns(Integer) }
426
- attr_accessor :usage_gte
427
- sig { params(usage_gte: Integer).void }
428
- def initialize(usage_gte: nil); end
429
- end
430
- class Discount < Stripe::RequestParams
431
- # ID of the coupon to create a new discount for.
432
- sig { returns(T.nilable(String)) }
433
- attr_accessor :coupon
434
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
435
- sig { returns(T.nilable(String)) }
436
- attr_accessor :discount
437
- # ID of the promotion code to create a new discount for.
438
- sig { returns(T.nilable(String)) }
439
- attr_accessor :promotion_code
440
- sig {
441
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
442
- }
443
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
444
- end
445
- class PriceData < Stripe::RequestParams
446
- class Recurring < Stripe::RequestParams
447
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
448
- sig { returns(String) }
449
- attr_accessor :interval
450
- # 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).
451
- sig { returns(T.nilable(Integer)) }
452
- attr_accessor :interval_count
453
- sig { params(interval: String, interval_count: T.nilable(Integer)).void }
454
- def initialize(interval: nil, interval_count: nil); end
455
- end
456
- # 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).
457
- sig { returns(String) }
458
- attr_accessor :currency
459
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
460
- sig { returns(String) }
461
- attr_accessor :product
462
- # The recurring components of a price such as `interval` and `interval_count`.
463
- sig {
464
- returns(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData::Recurring)
465
- }
466
- attr_accessor :recurring
467
- # 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.
468
- sig { returns(T.nilable(String)) }
469
- attr_accessor :tax_behavior
470
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
471
- sig { returns(T.nilable(Integer)) }
472
- attr_accessor :unit_amount
473
- # 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.
474
- sig { returns(T.nilable(String)) }
475
- attr_accessor :unit_amount_decimal
476
- sig {
477
- params(currency: String, product: String, recurring: ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
478
- }
479
- def initialize(
480
- currency: nil,
481
- product: nil,
482
- recurring: nil,
483
- tax_behavior: nil,
484
- unit_amount: nil,
485
- unit_amount_decimal: nil
486
- ); end
487
- end
488
- # 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.
489
- sig {
490
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::BillingThresholds))))
491
- }
492
- attr_accessor :billing_thresholds
493
- # The coupons to redeem into discounts for the subscription item.
494
- sig {
495
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount]))))
496
- }
497
- attr_accessor :discounts
498
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
499
- sig { returns(T.nilable(T::Hash[String, String])) }
500
- attr_accessor :metadata
501
- # The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
502
- sig { returns(T.nilable(String)) }
503
- attr_accessor :plan
504
- # The ID of the price object.
505
- sig { returns(T.nilable(String)) }
506
- attr_accessor :price
507
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
508
- sig {
509
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData))
510
- }
511
- attr_accessor :price_data
512
- # Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
513
- sig { returns(T.nilable(Integer)) }
514
- attr_accessor :quantity
515
- # 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.
516
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
517
- attr_accessor :tax_rates
518
- sig {
519
- params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
520
- }
521
- def initialize(
522
- billing_thresholds: nil,
523
- discounts: nil,
524
- metadata: nil,
525
- plan: nil,
526
- price: nil,
527
- price_data: nil,
528
- quantity: nil,
529
- tax_rates: nil
530
- ); end
531
- end
532
- class TransferData < Stripe::RequestParams
533
- # 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.
534
- sig { returns(T.nilable(Float)) }
535
- attr_accessor :amount_percent
536
- # ID of an existing, connected Stripe account.
537
- sig { returns(String) }
538
- attr_accessor :destination
539
- sig { params(amount_percent: T.nilable(Float), destination: String).void }
540
- def initialize(amount_percent: nil, destination: nil); end
541
- end
542
- # A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
543
- sig {
544
- returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem]))
545
- }
546
- attr_accessor :add_invoice_items
547
- # 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).
548
- sig { returns(T.nilable(Float)) }
549
- attr_accessor :application_fee_percent
550
- # Automatic tax settings for this phase.
551
- sig {
552
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax))
553
- }
554
- attr_accessor :automatic_tax
555
- # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
556
- sig { returns(T.nilable(String)) }
557
- attr_accessor :billing_cycle_anchor
558
- # 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.
559
- sig {
560
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::BillingThresholds))))
561
- }
562
- attr_accessor :billing_thresholds
563
- # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
564
- sig { returns(T.nilable(String)) }
565
- attr_accessor :collection_method
566
- # 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).
567
- sig { returns(T.nilable(String)) }
568
- attr_accessor :currency
569
- # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
570
- sig { returns(T.nilable(String)) }
571
- attr_accessor :default_payment_method
572
- # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
573
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
574
- attr_accessor :default_tax_rates
575
- # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
576
- sig { returns(T.nilable(T.nilable(String))) }
577
- attr_accessor :description
578
- # The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
579
- sig {
580
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount]))))
581
- }
582
- attr_accessor :discounts
583
- # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
584
- sig { returns(T.nilable(Integer)) }
585
- attr_accessor :end_date
586
- # All invoices will be billed using the specified settings.
587
- sig {
588
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings))
589
- }
590
- attr_accessor :invoice_settings
591
- # List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
592
- sig { returns(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item]) }
593
- attr_accessor :items
594
- # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
595
- sig { returns(T.nilable(Integer)) }
596
- attr_accessor :iterations
597
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
598
- sig { returns(T.nilable(T::Hash[String, String])) }
599
- attr_accessor :metadata
600
- # The account on behalf of which to charge, for each of the associated subscription's invoices.
601
- sig { returns(T.nilable(String)) }
602
- attr_accessor :on_behalf_of
603
- # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
604
- sig { returns(T.nilable(String)) }
605
- attr_accessor :proration_behavior
606
- # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
607
- sig {
608
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TransferData))
609
- }
610
- attr_accessor :transfer_data
611
- # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
612
- sig { returns(T.nilable(T::Boolean)) }
613
- attr_accessor :trial
614
- # Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
615
- sig { returns(T.nilable(Integer)) }
616
- attr_accessor :trial_end
617
- sig {
618
- params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::BillingThresholds))), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount]))), end_date: T.nilable(Integer), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(Integer)).void
619
- }
620
- def initialize(
621
- add_invoice_items: nil,
622
- application_fee_percent: nil,
623
- automatic_tax: nil,
624
- billing_cycle_anchor: nil,
625
- billing_thresholds: nil,
626
- collection_method: nil,
627
- currency: nil,
628
- default_payment_method: nil,
629
- default_tax_rates: nil,
630
- description: nil,
631
- discounts: nil,
632
- end_date: nil,
633
- invoice_settings: nil,
634
- items: nil,
635
- iterations: nil,
636
- metadata: nil,
637
- on_behalf_of: nil,
638
- proration_behavior: nil,
639
- transfer_data: nil,
640
- trial: nil,
641
- trial_end: nil
642
- ); end
643
- end
644
- # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
645
- sig { returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::BillingMode)) }
646
- attr_accessor :billing_mode
647
- # The identifier of the customer to create the subscription schedule for.
648
- sig { returns(T.nilable(String)) }
649
- attr_accessor :customer
650
- # Object representing the subscription schedule's default settings.
651
- sig {
652
- returns(T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings))
653
- }
654
- attr_accessor :default_settings
655
- # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
656
- sig { returns(T.nilable(String)) }
657
- attr_accessor :end_behavior
658
- # Specifies which fields in the response should be expanded.
659
- sig { returns(T.nilable(T::Array[String])) }
660
- attr_accessor :expand
661
- # Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
662
- sig { returns(T.nilable(String)) }
663
- attr_accessor :from_subscription
664
- # 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`.
665
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
666
- attr_accessor :metadata
667
- # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
668
- sig {
669
- returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase]))
670
- }
671
- attr_accessor :phases
672
- # When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
673
- sig { returns(T.nilable(T.any(Integer, String))) }
674
- attr_accessor :start_date
675
- sig {
676
- params(billing_mode: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::BillingMode), customer: T.nilable(String), default_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings), end_behavior: T.nilable(String), expand: T.nilable(T::Array[String]), from_subscription: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), phases: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase]), start_date: T.nilable(T.any(Integer, String))).void
677
- }
678
- def initialize(
679
- billing_mode: nil,
680
- customer: nil,
681
- default_settings: nil,
682
- end_behavior: nil,
683
- expand: nil,
684
- from_subscription: nil,
685
- metadata: nil,
686
- phases: nil,
687
- start_date: nil
688
- ); end
689
- end
690
- class RetrieveParams < Stripe::RequestParams
691
- # Specifies which fields in the response should be expanded.
692
- sig { returns(T.nilable(T::Array[String])) }
693
- attr_accessor :expand
694
- sig { params(expand: T.nilable(T::Array[String])).void }
695
- def initialize(expand: nil); end
696
- end
697
- class UpdateParams < Stripe::RequestParams
698
- class DefaultSettings < Stripe::RequestParams
699
- class AutomaticTax < Stripe::RequestParams
700
- class Liability < Stripe::RequestParams
701
- # The connected account being referenced when `type` is `account`.
702
- sig { returns(T.nilable(String)) }
703
- attr_accessor :account
704
- # Type of the account referenced in the request.
705
- sig { returns(String) }
706
- attr_accessor :type
707
- sig { params(account: T.nilable(String), type: String).void }
708
- def initialize(account: nil, type: nil); end
709
- end
710
- # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
711
- sig { returns(T::Boolean) }
712
- attr_accessor :enabled
713
- # 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.
714
- sig {
715
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax::Liability))
716
- }
717
- attr_accessor :liability
718
- sig {
719
- params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax::Liability)).void
720
- }
721
- def initialize(enabled: nil, liability: nil); end
722
- end
723
- class BillingThresholds < Stripe::RequestParams
724
- # Monetary threshold that triggers the subscription to advance to a new billing period
725
- sig { returns(T.nilable(Integer)) }
726
- attr_accessor :amount_gte
727
- # 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.
728
- sig { returns(T.nilable(T::Boolean)) }
729
- attr_accessor :reset_billing_cycle_anchor
730
- sig {
731
- params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
732
- }
733
- def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
734
- end
735
- class InvoiceSettings < Stripe::RequestParams
736
- class Issuer < Stripe::RequestParams
737
- # The connected account being referenced when `type` is `account`.
738
- sig { returns(T.nilable(String)) }
739
- attr_accessor :account
740
- # Type of the account referenced in the request.
741
- sig { returns(String) }
742
- attr_accessor :type
743
- sig { params(account: T.nilable(String), type: String).void }
744
- def initialize(account: nil, type: nil); end
745
- end
746
- # The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
747
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
748
- attr_accessor :account_tax_ids
749
- # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
750
- sig { returns(T.nilable(Integer)) }
751
- attr_accessor :days_until_due
752
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
753
- sig {
754
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings::Issuer))
755
- }
756
- attr_accessor :issuer
757
- sig {
758
- params(account_tax_ids: T.nilable(T.nilable(T.any(String, T::Array[String]))), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings::Issuer)).void
759
- }
760
- def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
761
- end
762
- class TransferData < Stripe::RequestParams
763
- # 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.
764
- sig { returns(T.nilable(Float)) }
765
- attr_accessor :amount_percent
766
- # ID of an existing, connected Stripe account.
767
- sig { returns(String) }
768
- attr_accessor :destination
769
- sig { params(amount_percent: T.nilable(Float), destination: String).void }
770
- def initialize(amount_percent: nil, destination: nil); end
771
- end
772
- # 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).
773
- sig { returns(T.nilable(Float)) }
774
- attr_accessor :application_fee_percent
775
- # Default settings for automatic tax computation.
776
- sig {
777
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax))
778
- }
779
- attr_accessor :automatic_tax
780
- # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
781
- sig { returns(T.nilable(String)) }
782
- attr_accessor :billing_cycle_anchor
783
- # 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.
784
- sig {
785
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::BillingThresholds))))
786
- }
787
- attr_accessor :billing_thresholds
788
- # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
789
- sig { returns(T.nilable(String)) }
790
- attr_accessor :collection_method
791
- # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
792
- sig { returns(T.nilable(String)) }
793
- attr_accessor :default_payment_method
794
- # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
795
- sig { returns(T.nilable(T.nilable(String))) }
796
- attr_accessor :description
797
- # All invoices will be billed using the specified settings.
798
- sig {
799
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings))
800
- }
801
- attr_accessor :invoice_settings
802
- # The account on behalf of which to charge, for each of the associated subscription's invoices.
803
- sig { returns(T.nilable(T.nilable(String))) }
804
- attr_accessor :on_behalf_of
805
- # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
806
- sig {
807
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::TransferData))))
808
- }
809
- attr_accessor :transfer_data
810
- sig {
811
- params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::BillingThresholds))), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(T.nilable(String)), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::TransferData)))).void
812
- }
813
- def initialize(
814
- application_fee_percent: nil,
815
- automatic_tax: nil,
816
- billing_cycle_anchor: nil,
817
- billing_thresholds: nil,
818
- collection_method: nil,
819
- default_payment_method: nil,
820
- description: nil,
821
- invoice_settings: nil,
822
- on_behalf_of: nil,
823
- transfer_data: nil
824
- ); end
825
- end
826
- class Phase < Stripe::RequestParams
827
- class AddInvoiceItem < Stripe::RequestParams
828
- class Discount < Stripe::RequestParams
829
- # ID of the coupon to create a new discount for.
830
- sig { returns(T.nilable(String)) }
831
- attr_accessor :coupon
832
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
833
- sig { returns(T.nilable(String)) }
834
- attr_accessor :discount
835
- # ID of the promotion code to create a new discount for.
836
- sig { returns(T.nilable(String)) }
837
- attr_accessor :promotion_code
838
- sig {
839
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
840
- }
841
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
842
- end
843
- class PriceData < Stripe::RequestParams
844
- # 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).
845
- sig { returns(String) }
846
- attr_accessor :currency
847
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
848
- sig { returns(String) }
849
- attr_accessor :product
850
- # 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.
851
- sig { returns(T.nilable(String)) }
852
- attr_accessor :tax_behavior
853
- # 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.
854
- sig { returns(T.nilable(Integer)) }
855
- attr_accessor :unit_amount
856
- # 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.
857
- sig { returns(T.nilable(String)) }
858
- attr_accessor :unit_amount_decimal
859
- sig {
860
- params(currency: String, product: String, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
861
- }
862
- def initialize(
863
- currency: nil,
864
- product: nil,
865
- tax_behavior: nil,
866
- unit_amount: nil,
867
- unit_amount_decimal: nil
868
- ); end
869
- end
870
- # The coupons to redeem into discounts for the item.
871
- sig {
872
- returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount]))
873
- }
874
- attr_accessor :discounts
875
- # The ID of the price object. One of `price` or `price_data` is required.
876
- sig { returns(T.nilable(String)) }
877
- attr_accessor :price
878
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
879
- sig {
880
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::PriceData))
881
- }
882
- attr_accessor :price_data
883
- # Quantity for this item. Defaults to 1.
884
- sig { returns(T.nilable(Integer)) }
885
- attr_accessor :quantity
886
- # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
887
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
888
- attr_accessor :tax_rates
889
- sig {
890
- params(discounts: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::Discount]), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
891
- }
892
- def initialize(
893
- discounts: nil,
894
- price: nil,
895
- price_data: nil,
896
- quantity: nil,
897
- tax_rates: nil
898
- ); end
899
- end
900
- class AutomaticTax < Stripe::RequestParams
901
- class Liability < Stripe::RequestParams
902
- # The connected account being referenced when `type` is `account`.
903
- sig { returns(T.nilable(String)) }
904
- attr_accessor :account
905
- # Type of the account referenced in the request.
906
- sig { returns(String) }
907
- attr_accessor :type
908
- sig { params(account: T.nilable(String), type: String).void }
909
- def initialize(account: nil, type: nil); end
910
- end
911
- # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
912
- sig { returns(T::Boolean) }
913
- attr_accessor :enabled
914
- # 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.
915
- sig {
916
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax::Liability))
917
- }
918
- attr_accessor :liability
919
- sig {
920
- params(enabled: T::Boolean, liability: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax::Liability)).void
921
- }
922
- def initialize(enabled: nil, liability: nil); end
923
- end
924
- class BillingThresholds < Stripe::RequestParams
925
- # Monetary threshold that triggers the subscription to advance to a new billing period
926
- sig { returns(T.nilable(Integer)) }
927
- attr_accessor :amount_gte
928
- # 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.
929
- sig { returns(T.nilable(T::Boolean)) }
930
- attr_accessor :reset_billing_cycle_anchor
931
- sig {
932
- params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
933
- }
934
- def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
935
- end
936
- class Discount < Stripe::RequestParams
937
- # ID of the coupon to create a new discount for.
938
- sig { returns(T.nilable(String)) }
939
- attr_accessor :coupon
940
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
941
- sig { returns(T.nilable(String)) }
942
- attr_accessor :discount
943
- # ID of the promotion code to create a new discount for.
944
- sig { returns(T.nilable(String)) }
945
- attr_accessor :promotion_code
946
- sig {
947
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
948
- }
949
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
950
- end
951
- class InvoiceSettings < Stripe::RequestParams
952
- class Issuer < Stripe::RequestParams
953
- # The connected account being referenced when `type` is `account`.
954
- sig { returns(T.nilable(String)) }
955
- attr_accessor :account
956
- # Type of the account referenced in the request.
957
- sig { returns(String) }
958
- attr_accessor :type
959
- sig { params(account: T.nilable(String), type: String).void }
960
- def initialize(account: nil, type: nil); end
961
- end
962
- # The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
963
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
964
- attr_accessor :account_tax_ids
965
- # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
966
- sig { returns(T.nilable(Integer)) }
967
- attr_accessor :days_until_due
968
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
969
- sig {
970
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings::Issuer))
971
- }
972
- attr_accessor :issuer
973
- sig {
974
- params(account_tax_ids: T.nilable(T.nilable(T.any(String, T::Array[String]))), days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings::Issuer)).void
975
- }
976
- def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
977
- end
978
- class Item < Stripe::RequestParams
979
- class BillingThresholds < Stripe::RequestParams
980
- # 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))
981
- sig { returns(Integer) }
982
- attr_accessor :usage_gte
983
- sig { params(usage_gte: Integer).void }
984
- def initialize(usage_gte: nil); end
985
- end
986
- class Discount < Stripe::RequestParams
987
- # ID of the coupon to create a new discount for.
988
- sig { returns(T.nilable(String)) }
989
- attr_accessor :coupon
990
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
991
- sig { returns(T.nilable(String)) }
992
- attr_accessor :discount
993
- # ID of the promotion code to create a new discount for.
994
- sig { returns(T.nilable(String)) }
995
- attr_accessor :promotion_code
996
- sig {
997
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
998
- }
999
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
1000
- end
1001
- class PriceData < Stripe::RequestParams
1002
- class Recurring < Stripe::RequestParams
1003
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1004
- sig { returns(String) }
1005
- attr_accessor :interval
1006
- # 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).
1007
- sig { returns(T.nilable(Integer)) }
1008
- attr_accessor :interval_count
1009
- sig { params(interval: String, interval_count: T.nilable(Integer)).void }
1010
- def initialize(interval: nil, interval_count: nil); end
1011
- end
1012
- # 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).
1013
- sig { returns(String) }
1014
- attr_accessor :currency
1015
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
1016
- sig { returns(String) }
1017
- attr_accessor :product
1018
- # The recurring components of a price such as `interval` and `interval_count`.
1019
- sig {
1020
- returns(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData::Recurring)
1021
- }
1022
- attr_accessor :recurring
1023
- # 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.
1024
- sig { returns(T.nilable(String)) }
1025
- attr_accessor :tax_behavior
1026
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
1027
- sig { returns(T.nilable(Integer)) }
1028
- attr_accessor :unit_amount
1029
- # 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.
1030
- sig { returns(T.nilable(String)) }
1031
- attr_accessor :unit_amount_decimal
1032
- sig {
1033
- params(currency: String, product: String, recurring: ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
1034
- }
1035
- def initialize(
1036
- currency: nil,
1037
- product: nil,
1038
- recurring: nil,
1039
- tax_behavior: nil,
1040
- unit_amount: nil,
1041
- unit_amount_decimal: nil
1042
- ); end
1043
- end
1044
- # 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.
1045
- sig {
1046
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::BillingThresholds))))
1047
- }
1048
- attr_accessor :billing_thresholds
1049
- # The coupons to redeem into discounts for the subscription item.
1050
- sig {
1051
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount]))))
1052
- }
1053
- attr_accessor :discounts
1054
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
1055
- sig { returns(T.nilable(T::Hash[String, String])) }
1056
- attr_accessor :metadata
1057
- # The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
1058
- sig { returns(T.nilable(String)) }
1059
- attr_accessor :plan
1060
- # The ID of the price object.
1061
- sig { returns(T.nilable(String)) }
1062
- attr_accessor :price
1063
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
1064
- sig {
1065
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData))
1066
- }
1067
- attr_accessor :price_data
1068
- # Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
1069
- sig { returns(T.nilable(Integer)) }
1070
- attr_accessor :quantity
1071
- # 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.
1072
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
1073
- attr_accessor :tax_rates
1074
- sig {
1075
- params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
1076
- }
1077
- def initialize(
1078
- billing_thresholds: nil,
1079
- discounts: nil,
1080
- metadata: nil,
1081
- plan: nil,
1082
- price: nil,
1083
- price_data: nil,
1084
- quantity: nil,
1085
- tax_rates: nil
1086
- ); end
1087
- end
1088
- class TransferData < Stripe::RequestParams
1089
- # 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.
1090
- sig { returns(T.nilable(Float)) }
1091
- attr_accessor :amount_percent
1092
- # ID of an existing, connected Stripe account.
1093
- sig { returns(String) }
1094
- attr_accessor :destination
1095
- sig { params(amount_percent: T.nilable(Float), destination: String).void }
1096
- def initialize(amount_percent: nil, destination: nil); end
1097
- end
1098
- # A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
1099
- sig {
1100
- returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem]))
1101
- }
1102
- attr_accessor :add_invoice_items
1103
- # 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).
1104
- sig { returns(T.nilable(Float)) }
1105
- attr_accessor :application_fee_percent
1106
- # Automatic tax settings for this phase.
1107
- sig {
1108
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax))
1109
- }
1110
- attr_accessor :automatic_tax
1111
- # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
1112
- sig { returns(T.nilable(String)) }
1113
- attr_accessor :billing_cycle_anchor
1114
- # 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.
1115
- sig {
1116
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::BillingThresholds))))
1117
- }
1118
- attr_accessor :billing_thresholds
1119
- # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
1120
- sig { returns(T.nilable(String)) }
1121
- attr_accessor :collection_method
1122
- # 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).
1123
- sig { returns(T.nilable(String)) }
1124
- attr_accessor :currency
1125
- # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
1126
- sig { returns(T.nilable(String)) }
1127
- attr_accessor :default_payment_method
1128
- # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
1129
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
1130
- attr_accessor :default_tax_rates
1131
- # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1132
- sig { returns(T.nilable(T.nilable(String))) }
1133
- attr_accessor :description
1134
- # The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
1135
- sig {
1136
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount]))))
1137
- }
1138
- attr_accessor :discounts
1139
- # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
1140
- sig { returns(T.nilable(T.any(Integer, String))) }
1141
- attr_accessor :end_date
1142
- # All invoices will be billed using the specified settings.
1143
- sig {
1144
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings))
1145
- }
1146
- attr_accessor :invoice_settings
1147
- # List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
1148
- sig { returns(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item]) }
1149
- attr_accessor :items
1150
- # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
1151
- sig { returns(T.nilable(Integer)) }
1152
- attr_accessor :iterations
1153
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
1154
- sig { returns(T.nilable(T::Hash[String, String])) }
1155
- attr_accessor :metadata
1156
- # The account on behalf of which to charge, for each of the associated subscription's invoices.
1157
- sig { returns(T.nilable(String)) }
1158
- attr_accessor :on_behalf_of
1159
- # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
1160
- sig { returns(T.nilable(String)) }
1161
- attr_accessor :proration_behavior
1162
- # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
1163
- sig { returns(T.nilable(T.any(Integer, String))) }
1164
- attr_accessor :start_date
1165
- # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
1166
- sig {
1167
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TransferData))
1168
- }
1169
- attr_accessor :transfer_data
1170
- # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
1171
- sig { returns(T.nilable(T::Boolean)) }
1172
- attr_accessor :trial
1173
- # Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
1174
- sig { returns(T.nilable(T.any(Integer, String))) }
1175
- attr_accessor :trial_end
1176
- sig {
1177
- params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::BillingThresholds))), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount]))), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void
1178
- }
1179
- def initialize(
1180
- add_invoice_items: nil,
1181
- application_fee_percent: nil,
1182
- automatic_tax: nil,
1183
- billing_cycle_anchor: nil,
1184
- billing_thresholds: nil,
1185
- collection_method: nil,
1186
- currency: nil,
1187
- default_payment_method: nil,
1188
- default_tax_rates: nil,
1189
- description: nil,
1190
- discounts: nil,
1191
- end_date: nil,
1192
- invoice_settings: nil,
1193
- items: nil,
1194
- iterations: nil,
1195
- metadata: nil,
1196
- on_behalf_of: nil,
1197
- proration_behavior: nil,
1198
- start_date: nil,
1199
- transfer_data: nil,
1200
- trial: nil,
1201
- trial_end: nil
1202
- ); end
1203
- end
1204
- # Object representing the subscription schedule's default settings.
1205
- sig {
1206
- returns(T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings))
1207
- }
1208
- attr_accessor :default_settings
1209
- # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
1210
- sig { returns(T.nilable(String)) }
1211
- attr_accessor :end_behavior
1212
- # Specifies which fields in the response should be expanded.
1213
- sig { returns(T.nilable(T::Array[String])) }
1214
- attr_accessor :expand
1215
- # 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`.
1216
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
1217
- attr_accessor :metadata
1218
- # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
1219
- sig {
1220
- returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase]))
1221
- }
1222
- attr_accessor :phases
1223
- # If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.
1224
- sig { returns(T.nilable(String)) }
1225
- attr_accessor :proration_behavior
1226
- sig {
1227
- params(default_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings), end_behavior: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), phases: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase]), proration_behavior: T.nilable(String)).void
1228
- }
1229
- def initialize(
1230
- default_settings: nil,
1231
- end_behavior: nil,
1232
- expand: nil,
1233
- metadata: nil,
1234
- phases: nil,
1235
- proration_behavior: nil
1236
- ); end
1237
- end
1238
- class CancelParams < Stripe::RequestParams
1239
- # Specifies which fields in the response should be expanded.
1240
- sig { returns(T.nilable(T::Array[String])) }
1241
- attr_accessor :expand
1242
- # If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.
1243
- sig { returns(T.nilable(T::Boolean)) }
1244
- attr_accessor :invoice_now
1245
- # If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.
1246
- sig { returns(T.nilable(T::Boolean)) }
1247
- attr_accessor :prorate
1248
- sig {
1249
- params(expand: T.nilable(T::Array[String]), invoice_now: T.nilable(T::Boolean), prorate: T.nilable(T::Boolean)).void
1250
- }
1251
- def initialize(expand: nil, invoice_now: nil, prorate: nil); end
1252
- end
1253
- class ReleaseParams < Stripe::RequestParams
1254
- # Specifies which fields in the response should be expanded.
1255
- sig { returns(T.nilable(T::Array[String])) }
1256
- attr_accessor :expand
1257
- # Keep any cancellation on the subscription that the schedule has set
1258
- sig { returns(T.nilable(T::Boolean)) }
1259
- attr_accessor :preserve_cancel_date
1260
- sig {
1261
- params(expand: T.nilable(T::Array[String]), preserve_cancel_date: T.nilable(T::Boolean)).void
1262
- }
1263
- def initialize(expand: nil, preserve_cancel_date: nil); end
1264
- end
1265
- # Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
1266
- sig {
1267
- params(schedule: String, params: T.any(::Stripe::SubscriptionScheduleService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
1268
- }
1269
- def cancel(schedule, params = {}, opts = {}); end
1270
-
1271
- # Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
1272
- sig {
1273
- params(params: T.any(::Stripe::SubscriptionScheduleService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
1274
- }
1275
- def create(params = {}, opts = {}); end
1276
-
1277
- # Retrieves the list of your subscription schedules.
1278
- sig {
1279
- params(params: T.any(::Stripe::SubscriptionScheduleService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1280
- }
1281
- def list(params = {}, opts = {}); end
1282
-
1283
- # Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
1284
- sig {
1285
- params(schedule: String, params: T.any(::Stripe::SubscriptionScheduleService::ReleaseParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
1286
- }
1287
- def release(schedule, params = {}, opts = {}); end
1288
-
1289
- # Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.
1290
- sig {
1291
- params(schedule: String, params: T.any(::Stripe::SubscriptionScheduleService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
1292
- }
1293
- def retrieve(schedule, params = {}, opts = {}); end
1294
-
1295
- # Updates an existing subscription schedule.
1296
- sig {
1297
- params(schedule: String, params: T.any(::Stripe::SubscriptionScheduleService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionSchedule)
1298
- }
1299
- def update(schedule, params = {}, opts = {}); end
1300
- end
1301
- end