stripe 15.5.0 → 15.6.0.pre.alpha.2

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