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