stripe 15.0.0 → 15.1.0.pre.beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (576) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1537 -676
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_requestor.rb +28 -0
  6. data/lib/stripe/api_version.rb +1 -1
  7. data/lib/stripe/errors.rb +54 -0
  8. data/lib/stripe/event_types.rb +75 -0
  9. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  10. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  15. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  18. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  19. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  20. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  21. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  22. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  23. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  24. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  25. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  26. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  41. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  49. data/lib/stripe/object_types.rb +51 -0
  50. data/lib/stripe/request_signing_authenticator.rb +79 -0
  51. data/lib/stripe/resources/account.rb +663 -1
  52. data/lib/stripe/resources/account_notice.rb +123 -0
  53. data/lib/stripe/resources/account_session.rb +299 -1
  54. data/lib/stripe/resources/balance_settings.rb +101 -0
  55. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  56. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  57. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  58. data/lib/stripe/resources/billing/meter_error_report.rb +59 -0
  59. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  60. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  61. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  62. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  63. data/lib/stripe/resources/card.rb +2 -0
  64. data/lib/stripe/resources/cash_balance.rb +2 -0
  65. data/lib/stripe/resources/charge.rb +1454 -0
  66. data/lib/stripe/resources/checkout/session.rb +295 -7
  67. data/lib/stripe/resources/confirmation_token.rb +237 -3
  68. data/lib/stripe/resources/coupon.rb +1 -1
  69. data/lib/stripe/resources/credit_note.rb +10 -0
  70. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  71. data/lib/stripe/resources/customer.rb +2 -0
  72. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  73. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  74. data/lib/stripe/resources/customer_session.rb +6 -1
  75. data/lib/stripe/resources/discount.rb +2 -0
  76. data/lib/stripe/resources/event.rb +33 -0
  77. data/lib/stripe/resources/financial_connections/account.rb +20 -1
  78. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  79. data/lib/stripe/resources/financial_connections/institution.rb +90 -0
  80. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  81. data/lib/stripe/resources/gift_cards/card.rb +208 -0
  82. data/lib/stripe/resources/gift_cards/transaction.rb +272 -0
  83. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  84. data/lib/stripe/resources/invoice.rb +1176 -16
  85. data/lib/stripe/resources/invoice_item.rb +78 -2
  86. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  87. data/lib/stripe/resources/invoice_payment.rb +2 -53
  88. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  89. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  90. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  91. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  93. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  94. data/lib/stripe/resources/line_item.rb +37 -0
  95. data/lib/stripe/resources/login_link.rb +2 -1
  96. data/lib/stripe/resources/mandate.rb +24 -0
  97. data/lib/stripe/resources/margin.rb +115 -0
  98. data/lib/stripe/resources/order.rb +2859 -0
  99. data/lib/stripe/resources/payment_attempt_record.rb +1078 -0
  100. data/lib/stripe/resources/payment_intent.rb +5242 -440
  101. data/lib/stripe/resources/payment_method.rb +199 -4
  102. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  103. data/lib/stripe/resources/payment_method_domain.rb +13 -0
  104. data/lib/stripe/resources/payment_record.rb +1607 -0
  105. data/lib/stripe/resources/payout.rb +6 -0
  106. data/lib/stripe/resources/price.rb +30 -0
  107. data/lib/stripe/resources/privacy/redaction_job.rb +251 -0
  108. data/lib/stripe/resources/privacy/redaction_job_root_objects.rb +35 -0
  109. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +54 -0
  110. data/lib/stripe/resources/product.rb +59 -0
  111. data/lib/stripe/resources/promotion_code.rb +10 -0
  112. data/lib/stripe/resources/quote.rb +2042 -6
  113. data/lib/stripe/resources/quote_line.rb +274 -0
  114. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  115. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +337 -0
  116. data/lib/stripe/resources/refund.rb +9 -0
  117. data/lib/stripe/resources/setup_attempt.rb +21 -0
  118. data/lib/stripe/resources/setup_intent.rb +605 -18
  119. data/lib/stripe/resources/source.rb +30 -1
  120. data/lib/stripe/resources/subscription.rb +292 -9
  121. data/lib/stripe/resources/subscription_item.rb +84 -3
  122. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  123. data/lib/stripe/resources/tax/association.rb +89 -0
  124. data/lib/stripe/resources/tax/form.rb +211 -0
  125. data/lib/stripe/resources/tax/registration.rb +20 -0
  126. data/lib/stripe/resources/tax_id.rb +12 -2
  127. data/lib/stripe/resources/terminal/reader.rb +406 -0
  128. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  129. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  130. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  131. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  132. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  133. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  134. data/lib/stripe/resources/v2/core/account.rb +1715 -0
  135. data/lib/stripe/resources/v2/core/account_link.rb +54 -0
  136. data/lib/stripe/resources/v2/core/person.rb +272 -0
  137. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +72 -0
  138. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +37 -0
  139. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +18 -0
  140. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +20 -0
  141. data/lib/stripe/resources/v2/money_management/adjustment.rb +49 -0
  142. data/lib/stripe/resources/v2/money_management/financial_account.rb +56 -0
  143. data/lib/stripe/resources/v2/money_management/financial_address.rb +66 -0
  144. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +92 -0
  145. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +127 -0
  146. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +74 -0
  147. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +43 -0
  148. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +115 -0
  149. data/lib/stripe/resources/v2/money_management/payout_method.rb +73 -0
  150. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +47 -0
  151. data/lib/stripe/resources/v2/money_management/received_credit.rb +134 -0
  152. data/lib/stripe/resources/v2/money_management/received_debit.rb +106 -0
  153. data/lib/stripe/resources/v2/money_management/transaction.rb +76 -0
  154. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +66 -0
  155. data/lib/stripe/resources.rb +88 -0
  156. data/lib/stripe/services/account_notice_service.rb +101 -0
  157. data/lib/stripe/services/account_service.rb +570 -1
  158. data/lib/stripe/services/account_session_service.rb +269 -1
  159. data/lib/stripe/services/balance_settings_service.rb +96 -0
  160. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  161. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  162. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  163. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  164. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  165. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  166. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  167. data/lib/stripe/services/capital_service.rb +15 -0
  168. data/lib/stripe/services/charge_service.rb +1334 -0
  169. data/lib/stripe/services/checkout/session_service.rb +195 -4
  170. data/lib/stripe/services/credit_note_service.rb +4 -0
  171. data/lib/stripe/services/customer_session_service.rb +4 -1
  172. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -123
  173. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  174. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  175. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  176. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  177. data/lib/stripe/services/financial_connections_service.rb +2 -1
  178. data/lib/stripe/services/gift_cards/card_service.rb +170 -0
  179. data/lib/stripe/services/gift_cards/transaction_service.rb +209 -0
  180. data/lib/stripe/services/gift_cards_service.rb +14 -0
  181. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  182. data/lib/stripe/services/invoice_item_service.rb +74 -2
  183. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  184. data/lib/stripe/services/invoice_payment_service.rb +5 -33
  185. data/lib/stripe/services/invoice_service.rb +1088 -17
  186. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  187. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  188. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  189. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  190. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  191. data/lib/stripe/services/issuing_service.rb +5 -1
  192. data/lib/stripe/services/margin_service.rb +119 -0
  193. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  194. data/lib/stripe/services/order_service.rb +2268 -0
  195. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  196. data/lib/stripe/services/payment_intent_service.rb +4634 -261
  197. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  198. data/lib/stripe/services/payment_method_service.rb +129 -4
  199. data/lib/stripe/services/payment_record_service.rb +542 -0
  200. data/lib/stripe/services/payout_service.rb +4 -0
  201. data/lib/stripe/services/price_service.rb +19 -0
  202. data/lib/stripe/services/privacy/redaction_job_service.rb +231 -0
  203. data/{rbi/stripe/services/climate/product_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +36 -25
  204. data/lib/stripe/services/privacy_service.rb +13 -0
  205. data/lib/stripe/services/product_service.rb +38 -0
  206. data/lib/stripe/services/promotion_code_service.rb +8 -0
  207. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  208. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  209. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_subscription_schedule_service.rb} +20 -16
  210. data/lib/stripe/services/quote_service.rb +1726 -7
  211. data/lib/stripe/services/setup_intent_service.rb +565 -18
  212. data/lib/stripe/services/subscription_item_service.rb +75 -3
  213. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  214. data/lib/stripe/services/subscription_service.rb +253 -9
  215. data/lib/stripe/services/tax/association_service.rb +31 -0
  216. data/lib/stripe/services/tax/form_service.rb +100 -0
  217. data/lib/stripe/services/tax/registration_service.rb +13 -0
  218. data/lib/stripe/services/tax_id_service.rb +8 -2
  219. data/lib/stripe/services/tax_service.rb +3 -1
  220. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  221. data/lib/stripe/services/terminal/reader_service.rb +180 -0
  222. data/lib/stripe/services/terminal_service.rb +2 -1
  223. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +151 -3
  224. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +43 -0
  225. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  226. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  227. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  228. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  229. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  230. data/lib/stripe/services/v1_services.rb +11 -2
  231. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  232. data/lib/stripe/services/v2/core/account_service.rb +4130 -0
  233. data/lib/stripe/services/v2/core/accounts/person_service.rb +1040 -0
  234. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +135 -0
  235. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +109 -0
  236. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  237. data/lib/stripe/services/v2/core_service.rb +4 -1
  238. data/lib/stripe/services/v2/money_management/adjustment_service.rb +75 -0
  239. data/lib/stripe/services/v2/money_management/financial_account_service.rb +44 -0
  240. data/lib/stripe/services/v2/money_management/financial_address_service.rb +81 -0
  241. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +126 -0
  242. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +80 -0
  243. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +202 -0
  244. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +237 -0
  245. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +174 -0
  246. data/lib/stripe/services/v2/money_management/payout_method_service.rb +95 -0
  247. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  248. data/lib/stripe/services/v2/money_management/received_credit_service.rb +71 -0
  249. data/lib/stripe/services/v2/money_management/received_debit_service.rb +44 -0
  250. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +70 -0
  251. data/lib/stripe/services/v2/money_management/transaction_service.rb +74 -0
  252. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  253. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  254. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +50 -0
  255. data/lib/stripe/services/v2_services.rb +4 -2
  256. data/lib/stripe/services.rb +52 -0
  257. data/lib/stripe/stripe_configuration.rb +3 -1
  258. data/lib/stripe/stripe_object.rb +1 -1
  259. data/lib/stripe/util.rb +7 -1
  260. data/lib/stripe/version.rb +1 -1
  261. data/lib/stripe.rb +55 -0
  262. data/rbi/stripe.rbi +190156 -0
  263. data/stripe.gemspec +4 -1
  264. metadata +146 -324
  265. data/rbi/stripe/resources/account.rbi +0 -4840
  266. data/rbi/stripe/resources/account_link.rbi +0 -74
  267. data/rbi/stripe/resources/account_session.rbi +0 -894
  268. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -90
  269. data/rbi/stripe/resources/application.rbi +0 -20
  270. data/rbi/stripe/resources/application_fee.rbi +0 -118
  271. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  272. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  273. data/rbi/stripe/resources/balance.rbi +0 -180
  274. data/rbi/stripe/resources/balance_transaction.rbi +0 -144
  275. data/rbi/stripe/resources/bank_account.rbi +0 -127
  276. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  277. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  278. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  279. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  280. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  281. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  282. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  283. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  284. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  285. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  286. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  287. data/rbi/stripe/resources/capability.rbi +0 -125
  288. data/rbi/stripe/resources/card.rbi +0 -125
  289. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  290. data/rbi/stripe/resources/charge.rbi +0 -2054
  291. data/rbi/stripe/resources/checkout/session.rbi +0 -3951
  292. data/rbi/stripe/resources/climate/order.rbi +0 -245
  293. data/rbi/stripe/resources/climate/product.rbi +0 -75
  294. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  295. data/rbi/stripe/resources/confirmation_token.rbi +0 -1793
  296. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  297. data/rbi/stripe/resources/country_spec.rbi +0 -85
  298. data/rbi/stripe/resources/coupon.rbi +0 -252
  299. data/rbi/stripe/resources/credit_note.rbi +0 -747
  300. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  301. data/rbi/stripe/resources/customer.rbi +0 -1009
  302. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  303. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  304. data/rbi/stripe/resources/customer_session.rbi +0 -200
  305. data/rbi/stripe/resources/discount.rbi +0 -53
  306. data/rbi/stripe/resources/dispute.rbi +0 -761
  307. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  308. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  309. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  310. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  311. data/rbi/stripe/resources/event.rbi +0 -146
  312. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  313. data/rbi/stripe/resources/file.rbi +0 -143
  314. data/rbi/stripe/resources/file_link.rbi +0 -141
  315. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  316. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  317. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  318. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  319. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  320. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  321. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  322. data/rbi/stripe/resources/identity/verification_report.rbi +0 -351
  323. data/rbi/stripe/resources/identity/verification_session.rbi +0 -517
  324. data/rbi/stripe/resources/invoice.rbi +0 -3733
  325. data/rbi/stripe/resources/invoice_item.rbi +0 -475
  326. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  327. data/rbi/stripe/resources/invoice_payment.rbi +0 -114
  328. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  329. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  330. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  331. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  332. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  333. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  334. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  335. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  336. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  337. data/rbi/stripe/resources/line_item.rbi +0 -72
  338. data/rbi/stripe/resources/login_link.rbi +0 -18
  339. data/rbi/stripe/resources/mandate.rbi +0 -187
  340. data/rbi/stripe/resources/payment_intent.rbi +0 -9731
  341. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  342. data/rbi/stripe/resources/payment_method.rbi +0 -1822
  343. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3154
  344. data/rbi/stripe/resources/payment_method_domain.rbi +0 -212
  345. data/rbi/stripe/resources/payout.rbi +0 -300
  346. data/rbi/stripe/resources/person.rbi +0 -371
  347. data/rbi/stripe/resources/plan.rbi +0 -373
  348. data/rbi/stripe/resources/price.rbi +0 -694
  349. data/rbi/stripe/resources/product.rbi +0 -557
  350. data/rbi/stripe/resources/product_feature.rbi +0 -26
  351. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  352. data/rbi/stripe/resources/quote.rbi +0 -1123
  353. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  354. data/rbi/stripe/resources/radar/value_list.rbi +0 -170
  355. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -131
  356. data/rbi/stripe/resources/refund.rbi +0 -516
  357. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  358. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  359. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  360. data/rbi/stripe/resources/reversal.rbi +0 -51
  361. data/rbi/stripe/resources/review.rbi +0 -154
  362. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  363. data/rbi/stripe/resources/setup_intent.rbi +0 -3860
  364. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  365. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  366. data/rbi/stripe/resources/source.rbi +0 -1496
  367. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  368. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  369. data/rbi/stripe/resources/subscription.rbi +0 -1964
  370. data/rbi/stripe/resources/subscription_item.rbi +0 -370
  371. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1495
  372. data/rbi/stripe/resources/tax/calculation.rbi +0 -474
  373. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -88
  374. data/rbi/stripe/resources/tax/registration.rbi +0 -2485
  375. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  376. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  377. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  378. data/rbi/stripe/resources/tax_code.rbi +0 -44
  379. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  380. data/rbi/stripe/resources/tax_id.rbi +0 -167
  381. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  382. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1388
  383. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  384. data/rbi/stripe/resources/terminal/location.rbi +0 -224
  385. data/rbi/stripe/resources/terminal/reader.rbi +0 -587
  386. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -134
  387. data/rbi/stripe/resources/token.rbi +0 -1217
  388. data/rbi/stripe/resources/topup.rbi +0 -222
  389. data/rbi/stripe/resources/transfer.rbi +0 -199
  390. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  391. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  392. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -865
  393. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  394. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  395. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  396. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  397. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  398. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  399. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  400. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  401. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  402. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  403. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  404. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  405. data/rbi/stripe/resources/v2/event.rbi +0 -48
  406. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  407. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -170
  408. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  409. data/rbi/stripe/services/account_link_service.rbi +0 -58
  410. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  411. data/rbi/stripe/services/account_person_service.rbi +0 -923
  412. data/rbi/stripe/services/account_service.rbi +0 -4143
  413. data/rbi/stripe/services/account_session_service.rbi +0 -572
  414. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -78
  415. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  416. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  417. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  418. data/rbi/stripe/services/apps_service.rbi +0 -9
  419. data/rbi/stripe/services/balance_service.rbi +0 -21
  420. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  421. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  422. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  423. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  424. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  425. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  426. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  427. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  428. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  429. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  430. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  431. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  432. data/rbi/stripe/services/billing_service.rbi +0 -15
  433. data/rbi/stripe/services/charge_service.rbi +0 -448
  434. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  435. data/rbi/stripe/services/checkout/session_service.rbi +0 -2585
  436. data/rbi/stripe/services/checkout_service.rbi +0 -9
  437. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  438. data/rbi/stripe/services/climate_service.rbi +0 -11
  439. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  440. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  441. data/rbi/stripe/services/coupon_service.rbi +0 -196
  442. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  443. data/rbi/stripe/services/credit_note_service.rbi +0 -416
  444. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  445. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  446. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  447. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  448. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  449. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  450. data/rbi/stripe/services/customer_service.rbi +0 -651
  451. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  452. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -72
  453. data/rbi/stripe/services/dispute_service.rbi +0 -424
  454. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  455. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  456. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  457. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  458. data/rbi/stripe/services/event_service.rbi +0 -83
  459. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  460. data/rbi/stripe/services/file_link_service.rbi +0 -124
  461. data/rbi/stripe/services/file_service.rbi +0 -116
  462. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  463. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  464. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  465. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  466. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  467. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  468. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  469. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  470. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -323
  471. data/rbi/stripe/services/identity_service.rbi +0 -10
  472. data/rbi/stripe/services/invoice_item_service.rbi +0 -368
  473. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  474. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  475. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  476. data/rbi/stripe/services/invoice_service.rbi +0 -2920
  477. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  478. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  479. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  480. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  481. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  482. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  483. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  484. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  485. data/rbi/stripe/services/issuing_service.rbi +0 -16
  486. data/rbi/stripe/services/mandate_service.rbi +0 -20
  487. data/rbi/stripe/services/payment_intent_service.rbi +0 -7759
  488. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  489. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2211
  490. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  491. data/rbi/stripe/services/payment_method_service.rbi +0 -840
  492. data/rbi/stripe/services/payout_service.rbi +0 -205
  493. data/rbi/stripe/services/plan_service.rbi +0 -284
  494. data/rbi/stripe/services/price_service.rbi +0 -546
  495. data/rbi/stripe/services/product_feature_service.rbi +0 -69
  496. data/rbi/stripe/services/product_service.rbi +0 -479
  497. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  498. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  499. data/rbi/stripe/services/quote_service.rbi +0 -686
  500. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  501. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -111
  502. data/rbi/stripe/services/radar/value_list_service.rbi +0 -143
  503. data/rbi/stripe/services/radar_service.rbi +0 -11
  504. data/rbi/stripe/services/refund_service.rbi +0 -185
  505. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  506. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  507. data/rbi/stripe/services/reporting_service.rbi +0 -10
  508. data/rbi/stripe/services/review_service.rbi +0 -84
  509. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  510. data/rbi/stripe/services/setup_intent_service.rbi +0 -3596
  511. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  512. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  513. data/rbi/stripe/services/sigma_service.rbi +0 -9
  514. data/rbi/stripe/services/source_service.rbi +0 -663
  515. data/rbi/stripe/services/subscription_item_service.rbi +0 -324
  516. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1192
  517. data/rbi/stripe/services/subscription_service.rbi +0 -1596
  518. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -33
  519. data/rbi/stripe/services/tax/calculation_service.rbi +0 -230
  520. data/rbi/stripe/services/tax/registration_service.rbi +0 -1689
  521. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  522. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  523. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  524. data/rbi/stripe/services/tax_id_service.rbi +0 -112
  525. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  526. data/rbi/stripe/services/tax_service.rbi +0 -12
  527. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1120
  528. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  529. data/rbi/stripe/services/terminal/location_service.rbi +0 -184
  530. data/rbi/stripe/services/terminal/reader_service.rbi +0 -344
  531. data/rbi/stripe/services/terminal_service.rbi +0 -12
  532. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  533. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  534. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  535. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  536. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  537. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  538. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  539. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  540. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -62
  541. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  542. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -92
  543. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  544. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  545. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  546. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  547. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  548. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  549. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  550. data/rbi/stripe/services/token_service.rbi +0 -1189
  551. data/rbi/stripe/services/topup_service.rbi +0 -176
  552. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  553. data/rbi/stripe/services/transfer_service.rbi +0 -152
  554. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  555. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  556. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  557. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -562
  558. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  559. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  560. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  561. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  562. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  563. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  564. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  565. data/rbi/stripe/services/treasury_service.rbi +0 -18
  566. data/rbi/stripe/services/v1_services.rbi +0 -77
  567. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  568. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  569. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -20
  570. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  571. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  572. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -200
  573. data/rbi/stripe/services/v2/core/event_service.rbi +0 -38
  574. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  575. data/rbi/stripe/services/v2_services.rbi +0 -10
  576. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -131
@@ -1,1123 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # A Quote is a way to model prices that you'd like to provide to a customer.
7
- # Once accepted, it will automatically create an invoice, subscription or subscription schedule.
8
- class Quote < APIResource
9
- class AutomaticTax < Stripe::StripeObject
10
- class Liability < Stripe::StripeObject
11
- # The connected account being referenced when `type` is `account`.
12
- sig { returns(T.any(String, Stripe::Account)) }
13
- attr_reader :account
14
- # Type of the account referenced.
15
- sig { returns(String) }
16
- attr_reader :type
17
- end
18
- # Automatically calculate taxes
19
- sig { returns(T::Boolean) }
20
- attr_reader :enabled
21
- # 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.
22
- sig { returns(T.nilable(Liability)) }
23
- attr_reader :liability
24
- # The status of the most recent automated tax calculation for this quote.
25
- sig { returns(T.nilable(String)) }
26
- attr_reader :status
27
- end
28
- class Computed < Stripe::StripeObject
29
- class Recurring < Stripe::StripeObject
30
- class TotalDetails < Stripe::StripeObject
31
- class Breakdown < Stripe::StripeObject
32
- class Discount < Stripe::StripeObject
33
- # The amount discounted.
34
- sig { returns(Integer) }
35
- attr_reader :amount
36
- # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
37
- # It contains information about when the discount began, when it will end, and what it is applied to.
38
- #
39
- # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
40
- sig { returns(Stripe::Discount) }
41
- attr_reader :discount
42
- end
43
- class Tax < Stripe::StripeObject
44
- # Amount of tax applied for this rate.
45
- sig { returns(Integer) }
46
- attr_reader :amount
47
- # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
48
- #
49
- # Related guide: [Tax rates](/billing/taxes/tax-rates)
50
- sig { returns(Stripe::TaxRate) }
51
- attr_reader :rate
52
- # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
53
- sig { returns(T.nilable(String)) }
54
- attr_reader :taxability_reason
55
- # The amount on which tax is calculated, in cents (or local equivalent).
56
- sig { returns(T.nilable(Integer)) }
57
- attr_reader :taxable_amount
58
- end
59
- # The aggregated discounts.
60
- sig { returns(T::Array[Discount]) }
61
- attr_reader :discounts
62
- # The aggregated tax amounts by rate.
63
- sig { returns(T::Array[Tax]) }
64
- attr_reader :taxes
65
- end
66
- # This is the sum of all the discounts.
67
- sig { returns(Integer) }
68
- attr_reader :amount_discount
69
- # This is the sum of all the shipping amounts.
70
- sig { returns(T.nilable(Integer)) }
71
- attr_reader :amount_shipping
72
- # This is the sum of all the tax amounts.
73
- sig { returns(Integer) }
74
- attr_reader :amount_tax
75
- # Attribute for field breakdown
76
- sig { returns(Breakdown) }
77
- attr_reader :breakdown
78
- end
79
- # Total before any discounts or taxes are applied.
80
- sig { returns(Integer) }
81
- attr_reader :amount_subtotal
82
- # Total after discounts and taxes are applied.
83
- sig { returns(Integer) }
84
- attr_reader :amount_total
85
- # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
86
- sig { returns(String) }
87
- attr_reader :interval
88
- # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
89
- sig { returns(Integer) }
90
- attr_reader :interval_count
91
- # Attribute for field total_details
92
- sig { returns(TotalDetails) }
93
- attr_reader :total_details
94
- end
95
- class Upfront < Stripe::StripeObject
96
- class TotalDetails < Stripe::StripeObject
97
- class Breakdown < Stripe::StripeObject
98
- class Discount < Stripe::StripeObject
99
- # The amount discounted.
100
- sig { returns(Integer) }
101
- attr_reader :amount
102
- # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
103
- # It contains information about when the discount began, when it will end, and what it is applied to.
104
- #
105
- # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
106
- sig { returns(Stripe::Discount) }
107
- attr_reader :discount
108
- end
109
- class Tax < Stripe::StripeObject
110
- # Amount of tax applied for this rate.
111
- sig { returns(Integer) }
112
- attr_reader :amount
113
- # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
114
- #
115
- # Related guide: [Tax rates](/billing/taxes/tax-rates)
116
- sig { returns(Stripe::TaxRate) }
117
- attr_reader :rate
118
- # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
119
- sig { returns(T.nilable(String)) }
120
- attr_reader :taxability_reason
121
- # The amount on which tax is calculated, in cents (or local equivalent).
122
- sig { returns(T.nilable(Integer)) }
123
- attr_reader :taxable_amount
124
- end
125
- # The aggregated discounts.
126
- sig { returns(T::Array[Discount]) }
127
- attr_reader :discounts
128
- # The aggregated tax amounts by rate.
129
- sig { returns(T::Array[Tax]) }
130
- attr_reader :taxes
131
- end
132
- # This is the sum of all the discounts.
133
- sig { returns(Integer) }
134
- attr_reader :amount_discount
135
- # This is the sum of all the shipping amounts.
136
- sig { returns(T.nilable(Integer)) }
137
- attr_reader :amount_shipping
138
- # This is the sum of all the tax amounts.
139
- sig { returns(Integer) }
140
- attr_reader :amount_tax
141
- # Attribute for field breakdown
142
- sig { returns(Breakdown) }
143
- attr_reader :breakdown
144
- end
145
- # Total before any discounts or taxes are applied.
146
- sig { returns(Integer) }
147
- attr_reader :amount_subtotal
148
- # Total after discounts and taxes are applied.
149
- sig { returns(Integer) }
150
- attr_reader :amount_total
151
- # The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice.
152
- sig { returns(Stripe::ListObject) }
153
- attr_reader :line_items
154
- # Attribute for field total_details
155
- sig { returns(TotalDetails) }
156
- attr_reader :total_details
157
- end
158
- # The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.
159
- sig { returns(T.nilable(Recurring)) }
160
- attr_reader :recurring
161
- # Attribute for field upfront
162
- sig { returns(Upfront) }
163
- attr_reader :upfront
164
- end
165
- class FromQuote < Stripe::StripeObject
166
- # Whether this quote is a revision of a different quote.
167
- sig { returns(T::Boolean) }
168
- attr_reader :is_revision
169
- # The quote that was cloned.
170
- sig { returns(T.any(String, Stripe::Quote)) }
171
- attr_reader :quote
172
- end
173
- class InvoiceSettings < Stripe::StripeObject
174
- class Issuer < Stripe::StripeObject
175
- # The connected account being referenced when `type` is `account`.
176
- sig { returns(T.any(String, Stripe::Account)) }
177
- attr_reader :account
178
- # Type of the account referenced.
179
- sig { returns(String) }
180
- attr_reader :type
181
- end
182
- # Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
183
- sig { returns(T.nilable(Integer)) }
184
- attr_reader :days_until_due
185
- # Attribute for field issuer
186
- sig { returns(Issuer) }
187
- attr_reader :issuer
188
- end
189
- class StatusTransitions < Stripe::StripeObject
190
- # The time that the quote was accepted. Measured in seconds since Unix epoch.
191
- sig { returns(T.nilable(Integer)) }
192
- attr_reader :accepted_at
193
- # The time that the quote was canceled. Measured in seconds since Unix epoch.
194
- sig { returns(T.nilable(Integer)) }
195
- attr_reader :canceled_at
196
- # The time that the quote was finalized. Measured in seconds since Unix epoch.
197
- sig { returns(T.nilable(Integer)) }
198
- attr_reader :finalized_at
199
- end
200
- class SubscriptionData < Stripe::StripeObject
201
- # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
202
- sig { returns(T.nilable(String)) }
203
- attr_reader :description
204
- # When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
205
- sig { returns(T.nilable(Integer)) }
206
- attr_reader :effective_date
207
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
208
- sig { returns(T.nilable(T::Hash[String, String])) }
209
- attr_reader :metadata
210
- # Integer representing the number of trial period days before the customer is charged for the first time.
211
- sig { returns(T.nilable(Integer)) }
212
- attr_reader :trial_period_days
213
- end
214
- class TotalDetails < Stripe::StripeObject
215
- class Breakdown < Stripe::StripeObject
216
- class Discount < Stripe::StripeObject
217
- # The amount discounted.
218
- sig { returns(Integer) }
219
- attr_reader :amount
220
- # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
221
- # It contains information about when the discount began, when it will end, and what it is applied to.
222
- #
223
- # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
224
- sig { returns(Stripe::Discount) }
225
- attr_reader :discount
226
- end
227
- class Tax < Stripe::StripeObject
228
- # Amount of tax applied for this rate.
229
- sig { returns(Integer) }
230
- attr_reader :amount
231
- # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
232
- #
233
- # Related guide: [Tax rates](/billing/taxes/tax-rates)
234
- sig { returns(Stripe::TaxRate) }
235
- attr_reader :rate
236
- # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
237
- sig { returns(T.nilable(String)) }
238
- attr_reader :taxability_reason
239
- # The amount on which tax is calculated, in cents (or local equivalent).
240
- sig { returns(T.nilable(Integer)) }
241
- attr_reader :taxable_amount
242
- end
243
- # The aggregated discounts.
244
- sig { returns(T::Array[Discount]) }
245
- attr_reader :discounts
246
- # The aggregated tax amounts by rate.
247
- sig { returns(T::Array[Tax]) }
248
- attr_reader :taxes
249
- end
250
- # This is the sum of all the discounts.
251
- sig { returns(Integer) }
252
- attr_reader :amount_discount
253
- # This is the sum of all the shipping amounts.
254
- sig { returns(T.nilable(Integer)) }
255
- attr_reader :amount_shipping
256
- # This is the sum of all the tax amounts.
257
- sig { returns(Integer) }
258
- attr_reader :amount_tax
259
- # Attribute for field breakdown
260
- sig { returns(Breakdown) }
261
- attr_reader :breakdown
262
- end
263
- class TransferData < Stripe::StripeObject
264
- # The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
265
- sig { returns(T.nilable(Integer)) }
266
- attr_reader :amount
267
- # 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 will be transferred to the destination.
268
- sig { returns(T.nilable(Float)) }
269
- attr_reader :amount_percent
270
- # The account where funds from the payment will be transferred to upon payment success.
271
- sig { returns(T.any(String, Stripe::Account)) }
272
- attr_reader :destination
273
- end
274
- # Total before any discounts or taxes are applied.
275
- sig { returns(Integer) }
276
- attr_reader :amount_subtotal
277
- # Total after discounts and taxes are applied.
278
- sig { returns(Integer) }
279
- attr_reader :amount_total
280
- # ID of the Connect Application that created the quote.
281
- sig { returns(T.nilable(T.any(String, Stripe::Application))) }
282
- attr_reader :application
283
- # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.
284
- sig { returns(T.nilable(Integer)) }
285
- attr_reader :application_fee_amount
286
- # 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. Only applicable if there are line items with recurring prices on the quote.
287
- sig { returns(T.nilable(Float)) }
288
- attr_reader :application_fee_percent
289
- # Attribute for field automatic_tax
290
- sig { returns(AutomaticTax) }
291
- attr_reader :automatic_tax
292
- # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or 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`.
293
- sig { returns(String) }
294
- attr_reader :collection_method
295
- # Attribute for field computed
296
- sig { returns(Computed) }
297
- attr_reader :computed
298
- # Time at which the object was created. Measured in seconds since the Unix epoch.
299
- sig { returns(Integer) }
300
- attr_reader :created
301
- # 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).
302
- sig { returns(T.nilable(String)) }
303
- attr_reader :currency
304
- # The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
305
- sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
306
- attr_reader :customer
307
- # The tax rates applied to this quote.
308
- sig { returns(T::Array[T.any(String, Stripe::TaxRate)]) }
309
- attr_reader :default_tax_rates
310
- # A description that will be displayed on the quote PDF.
311
- sig { returns(T.nilable(String)) }
312
- attr_reader :description
313
- # The discounts applied to this quote.
314
- sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
315
- attr_reader :discounts
316
- # The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
317
- sig { returns(Integer) }
318
- attr_reader :expires_at
319
- # A footer that will be displayed on the quote PDF.
320
- sig { returns(T.nilable(String)) }
321
- attr_reader :footer
322
- # Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.
323
- sig { returns(T.nilable(FromQuote)) }
324
- attr_reader :from_quote
325
- # A header that will be displayed on the quote PDF.
326
- sig { returns(T.nilable(String)) }
327
- attr_reader :header
328
- # Unique identifier for the object.
329
- sig { returns(String) }
330
- attr_reader :id
331
- # The invoice that was created from this quote.
332
- sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
333
- attr_reader :invoice
334
- # Attribute for field invoice_settings
335
- sig { returns(InvoiceSettings) }
336
- attr_reader :invoice_settings
337
- # A list of items the customer is being quoted for.
338
- sig { returns(Stripe::ListObject) }
339
- attr_reader :line_items
340
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
341
- sig { returns(T::Boolean) }
342
- attr_reader :livemode
343
- # 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.
344
- sig { returns(T::Hash[String, String]) }
345
- attr_reader :metadata
346
- # A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).
347
- sig { returns(T.nilable(String)) }
348
- attr_reader :number
349
- # String representing the object's type. Objects of the same type share the same value.
350
- sig { returns(String) }
351
- attr_reader :object
352
- # The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.
353
- sig { returns(T.nilable(T.any(String, Stripe::Account))) }
354
- attr_reader :on_behalf_of
355
- # The status of the quote.
356
- sig { returns(String) }
357
- attr_reader :status
358
- # Attribute for field status_transitions
359
- sig { returns(StatusTransitions) }
360
- attr_reader :status_transitions
361
- # The subscription that was created or updated from this quote.
362
- sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
363
- attr_reader :subscription
364
- # Attribute for field subscription_data
365
- sig { returns(SubscriptionData) }
366
- attr_reader :subscription_data
367
- # The subscription schedule that was created or updated from this quote.
368
- sig { returns(T.nilable(T.any(String, Stripe::SubscriptionSchedule))) }
369
- attr_reader :subscription_schedule
370
- # ID of the test clock this quote belongs to.
371
- sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
372
- attr_reader :test_clock
373
- # Attribute for field total_details
374
- sig { returns(TotalDetails) }
375
- attr_reader :total_details
376
- # The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.
377
- sig { returns(T.nilable(TransferData)) }
378
- attr_reader :transfer_data
379
- class ListParams < Stripe::RequestParams
380
- # The ID of the customer whose quotes will be retrieved.
381
- sig { returns(T.nilable(String)) }
382
- attr_accessor :customer
383
- # 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.
384
- sig { returns(T.nilable(String)) }
385
- attr_accessor :ending_before
386
- # Specifies which fields in the response should be expanded.
387
- sig { returns(T.nilable(T::Array[String])) }
388
- attr_accessor :expand
389
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
390
- sig { returns(T.nilable(Integer)) }
391
- attr_accessor :limit
392
- # 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.
393
- sig { returns(T.nilable(String)) }
394
- attr_accessor :starting_after
395
- # The status of the quote.
396
- sig { returns(T.nilable(String)) }
397
- attr_accessor :status
398
- # Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.
399
- sig { returns(T.nilable(String)) }
400
- attr_accessor :test_clock
401
- sig {
402
- params(customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String), test_clock: T.nilable(String)).void
403
- }
404
- def initialize(
405
- customer: nil,
406
- ending_before: nil,
407
- expand: nil,
408
- limit: nil,
409
- starting_after: nil,
410
- status: nil,
411
- test_clock: nil
412
- ); end
413
- end
414
- class CreateParams < Stripe::RequestParams
415
- class AutomaticTax < Stripe::RequestParams
416
- class Liability < Stripe::RequestParams
417
- # The connected account being referenced when `type` is `account`.
418
- sig { returns(T.nilable(String)) }
419
- attr_accessor :account
420
- # Type of the account referenced in the request.
421
- sig { returns(String) }
422
- attr_accessor :type
423
- sig { params(account: T.nilable(String), type: String).void }
424
- def initialize(account: nil, type: nil); end
425
- end
426
- # Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
427
- sig { returns(T::Boolean) }
428
- attr_accessor :enabled
429
- # 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.
430
- sig { returns(T.nilable(::Stripe::Quote::CreateParams::AutomaticTax::Liability)) }
431
- attr_accessor :liability
432
- sig {
433
- params(enabled: T::Boolean, liability: T.nilable(::Stripe::Quote::CreateParams::AutomaticTax::Liability)).void
434
- }
435
- def initialize(enabled: nil, liability: nil); end
436
- end
437
- class Discount < Stripe::RequestParams
438
- # ID of the coupon to create a new discount for.
439
- sig { returns(T.nilable(String)) }
440
- attr_accessor :coupon
441
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
442
- sig { returns(T.nilable(String)) }
443
- attr_accessor :discount
444
- # ID of the promotion code to create a new discount for.
445
- sig { returns(T.nilable(String)) }
446
- attr_accessor :promotion_code
447
- sig {
448
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
449
- }
450
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
451
- end
452
- class FromQuote < Stripe::RequestParams
453
- # Whether this quote is a revision of the previous quote.
454
- sig { returns(T.nilable(T::Boolean)) }
455
- attr_accessor :is_revision
456
- # The `id` of the quote that will be cloned.
457
- sig { returns(String) }
458
- attr_accessor :quote
459
- sig { params(is_revision: T.nilable(T::Boolean), quote: String).void }
460
- def initialize(is_revision: nil, quote: nil); end
461
- end
462
- class InvoiceSettings < Stripe::RequestParams
463
- class Issuer < Stripe::RequestParams
464
- # The connected account being referenced when `type` is `account`.
465
- sig { returns(T.nilable(String)) }
466
- attr_accessor :account
467
- # Type of the account referenced in the request.
468
- sig { returns(String) }
469
- attr_accessor :type
470
- sig { params(account: T.nilable(String), type: String).void }
471
- def initialize(account: nil, type: nil); end
472
- end
473
- # Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
474
- sig { returns(T.nilable(Integer)) }
475
- attr_accessor :days_until_due
476
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
477
- sig { returns(T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings::Issuer)) }
478
- attr_accessor :issuer
479
- sig {
480
- params(days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings::Issuer)).void
481
- }
482
- def initialize(days_until_due: nil, issuer: nil); end
483
- end
484
- class LineItem < Stripe::RequestParams
485
- class Discount < Stripe::RequestParams
486
- # ID of the coupon to create a new discount for.
487
- sig { returns(T.nilable(String)) }
488
- attr_accessor :coupon
489
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
490
- sig { returns(T.nilable(String)) }
491
- attr_accessor :discount
492
- # ID of the promotion code to create a new discount for.
493
- sig { returns(T.nilable(String)) }
494
- attr_accessor :promotion_code
495
- sig {
496
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
497
- }
498
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
499
- end
500
- class PriceData < Stripe::RequestParams
501
- class Recurring < Stripe::RequestParams
502
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
503
- sig { returns(String) }
504
- attr_accessor :interval
505
- # 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).
506
- sig { returns(T.nilable(Integer)) }
507
- attr_accessor :interval_count
508
- sig { params(interval: String, interval_count: T.nilable(Integer)).void }
509
- def initialize(interval: nil, interval_count: nil); end
510
- end
511
- # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
512
- sig { returns(String) }
513
- attr_accessor :currency
514
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
515
- sig { returns(String) }
516
- attr_accessor :product
517
- # The recurring components of a price such as `interval` and `interval_count`.
518
- sig { returns(T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData::Recurring)) }
519
- attr_accessor :recurring
520
- # 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.
521
- sig { returns(T.nilable(String)) }
522
- attr_accessor :tax_behavior
523
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
524
- sig { returns(T.nilable(Integer)) }
525
- attr_accessor :unit_amount
526
- # 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.
527
- sig { returns(T.nilable(String)) }
528
- attr_accessor :unit_amount_decimal
529
- sig {
530
- params(currency: String, product: String, recurring: T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
531
- }
532
- def initialize(
533
- currency: nil,
534
- product: nil,
535
- recurring: nil,
536
- tax_behavior: nil,
537
- unit_amount: nil,
538
- unit_amount_decimal: nil
539
- ); end
540
- end
541
- # The discounts applied to this line item.
542
- sig {
543
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::LineItem::Discount]))))
544
- }
545
- attr_accessor :discounts
546
- # The ID of the price object. One of `price` or `price_data` is required.
547
- sig { returns(T.nilable(String)) }
548
- attr_accessor :price
549
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
550
- sig { returns(T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData)) }
551
- attr_accessor :price_data
552
- # The quantity of the line item.
553
- sig { returns(T.nilable(Integer)) }
554
- attr_accessor :quantity
555
- # The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
556
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
557
- attr_accessor :tax_rates
558
- sig {
559
- params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::LineItem::Discount]))), price: T.nilable(String), price_data: T.nilable(::Stripe::Quote::CreateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
560
- }
561
- def initialize(
562
- discounts: nil,
563
- price: nil,
564
- price_data: nil,
565
- quantity: nil,
566
- tax_rates: nil
567
- ); end
568
- end
569
- class SubscriptionData < Stripe::RequestParams
570
- # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
571
- sig { returns(T.nilable(String)) }
572
- attr_accessor :description
573
- # When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
574
- sig { returns(T.nilable(T.nilable(T.any(String, T.any(String, Integer))))) }
575
- attr_accessor :effective_date
576
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
577
- sig { returns(T.nilable(T::Hash[String, String])) }
578
- attr_accessor :metadata
579
- # Integer representing the number of trial period days before the customer is charged for the first time.
580
- sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
581
- attr_accessor :trial_period_days
582
- sig {
583
- params(description: T.nilable(String), effective_date: T.nilable(T.nilable(T.any(String, T.any(String, Integer)))), metadata: T.nilable(T::Hash[String, String]), trial_period_days: T.nilable(T.nilable(T.any(String, Integer)))).void
584
- }
585
- def initialize(
586
- description: nil,
587
- effective_date: nil,
588
- metadata: nil,
589
- trial_period_days: nil
590
- ); end
591
- end
592
- class TransferData < Stripe::RequestParams
593
- # The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
594
- sig { returns(T.nilable(Integer)) }
595
- attr_accessor :amount
596
- # 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. There must be at least 1 line item with a recurring price to use this field.
597
- sig { returns(T.nilable(Float)) }
598
- attr_accessor :amount_percent
599
- # ID of an existing, connected Stripe account.
600
- sig { returns(String) }
601
- attr_accessor :destination
602
- sig {
603
- params(amount: T.nilable(Integer), amount_percent: T.nilable(Float), destination: String).void
604
- }
605
- def initialize(amount: nil, amount_percent: nil, destination: nil); end
606
- end
607
- # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
608
- sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
609
- attr_accessor :application_fee_amount
610
- # 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. There must be at least 1 line item with a recurring price to use this field.
611
- sig { returns(T.nilable(T.nilable(T.any(String, Float)))) }
612
- attr_accessor :application_fee_percent
613
- # Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
614
- sig { returns(T.nilable(::Stripe::Quote::CreateParams::AutomaticTax)) }
615
- attr_accessor :automatic_tax
616
- # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or 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`.
617
- sig { returns(T.nilable(String)) }
618
- attr_accessor :collection_method
619
- # The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
620
- sig { returns(T.nilable(String)) }
621
- attr_accessor :customer
622
- # The tax rates that will apply to any line item that does not have `tax_rates` set.
623
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
624
- attr_accessor :default_tax_rates
625
- # A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
626
- sig { returns(T.nilable(T.nilable(String))) }
627
- attr_accessor :description
628
- # The discounts applied to the quote.
629
- sig {
630
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::Discount]))))
631
- }
632
- attr_accessor :discounts
633
- # Specifies which fields in the response should be expanded.
634
- sig { returns(T.nilable(T::Array[String])) }
635
- attr_accessor :expand
636
- # A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
637
- sig { returns(T.nilable(Integer)) }
638
- attr_accessor :expires_at
639
- # A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
640
- sig { returns(T.nilable(T.nilable(String))) }
641
- attr_accessor :footer
642
- # Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`.
643
- sig { returns(T.nilable(::Stripe::Quote::CreateParams::FromQuote)) }
644
- attr_accessor :from_quote
645
- # A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.
646
- sig { returns(T.nilable(T.nilable(String))) }
647
- attr_accessor :header
648
- # All invoices will be billed using the specified settings.
649
- sig { returns(T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings)) }
650
- attr_accessor :invoice_settings
651
- # A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
652
- sig { returns(T.nilable(T::Array[::Stripe::Quote::CreateParams::LineItem])) }
653
- attr_accessor :line_items
654
- # 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`.
655
- sig { returns(T.nilable(T::Hash[String, String])) }
656
- attr_accessor :metadata
657
- # The account on behalf of which to charge.
658
- sig { returns(T.nilable(T.nilable(String))) }
659
- attr_accessor :on_behalf_of
660
- # When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
661
- sig { returns(T.nilable(::Stripe::Quote::CreateParams::SubscriptionData)) }
662
- attr_accessor :subscription_data
663
- # ID of the test clock to attach to the quote.
664
- sig { returns(T.nilable(String)) }
665
- attr_accessor :test_clock
666
- # The data with which to automatically create a Transfer for each of the invoices.
667
- sig {
668
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Quote::CreateParams::TransferData))))
669
- }
670
- attr_accessor :transfer_data
671
- sig {
672
- params(application_fee_amount: T.nilable(T.nilable(T.any(String, Integer))), application_fee_percent: T.nilable(T.nilable(T.any(String, Float))), automatic_tax: T.nilable(::Stripe::Quote::CreateParams::AutomaticTax), collection_method: T.nilable(String), customer: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Quote::CreateParams::Discount]))), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), footer: T.nilable(T.nilable(String)), from_quote: T.nilable(::Stripe::Quote::CreateParams::FromQuote), header: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::Quote::CreateParams::InvoiceSettings), line_items: T.nilable(T::Array[::Stripe::Quote::CreateParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(T.nilable(String)), subscription_data: T.nilable(::Stripe::Quote::CreateParams::SubscriptionData), test_clock: T.nilable(String), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::Quote::CreateParams::TransferData)))).void
673
- }
674
- def initialize(
675
- application_fee_amount: nil,
676
- application_fee_percent: nil,
677
- automatic_tax: nil,
678
- collection_method: nil,
679
- customer: nil,
680
- default_tax_rates: nil,
681
- description: nil,
682
- discounts: nil,
683
- expand: nil,
684
- expires_at: nil,
685
- footer: nil,
686
- from_quote: nil,
687
- header: nil,
688
- invoice_settings: nil,
689
- line_items: nil,
690
- metadata: nil,
691
- on_behalf_of: nil,
692
- subscription_data: nil,
693
- test_clock: nil,
694
- transfer_data: nil
695
- ); end
696
- end
697
- class UpdateParams < Stripe::RequestParams
698
- class AutomaticTax < Stripe::RequestParams
699
- class Liability < Stripe::RequestParams
700
- # The connected account being referenced when `type` is `account`.
701
- sig { returns(T.nilable(String)) }
702
- attr_accessor :account
703
- # Type of the account referenced in the request.
704
- sig { returns(String) }
705
- attr_accessor :type
706
- sig { params(account: T.nilable(String), type: String).void }
707
- def initialize(account: nil, type: nil); end
708
- end
709
- # Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
710
- sig { returns(T::Boolean) }
711
- attr_accessor :enabled
712
- # 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.
713
- sig { returns(T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax::Liability)) }
714
- attr_accessor :liability
715
- sig {
716
- params(enabled: T::Boolean, liability: T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax::Liability)).void
717
- }
718
- def initialize(enabled: nil, liability: nil); end
719
- end
720
- class Discount < Stripe::RequestParams
721
- # ID of the coupon to create a new discount for.
722
- sig { returns(T.nilable(String)) }
723
- attr_accessor :coupon
724
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
725
- sig { returns(T.nilable(String)) }
726
- attr_accessor :discount
727
- # ID of the promotion code to create a new discount for.
728
- sig { returns(T.nilable(String)) }
729
- attr_accessor :promotion_code
730
- sig {
731
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
732
- }
733
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
734
- end
735
- class InvoiceSettings < Stripe::RequestParams
736
- class Issuer < Stripe::RequestParams
737
- # The connected account being referenced when `type` is `account`.
738
- sig { returns(T.nilable(String)) }
739
- attr_accessor :account
740
- # Type of the account referenced in the request.
741
- sig { returns(String) }
742
- attr_accessor :type
743
- sig { params(account: T.nilable(String), type: String).void }
744
- def initialize(account: nil, type: nil); end
745
- end
746
- # Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
747
- sig { returns(T.nilable(Integer)) }
748
- attr_accessor :days_until_due
749
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
750
- sig { returns(T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings::Issuer)) }
751
- attr_accessor :issuer
752
- sig {
753
- params(days_until_due: T.nilable(Integer), issuer: T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings::Issuer)).void
754
- }
755
- def initialize(days_until_due: nil, issuer: nil); end
756
- end
757
- class LineItem < Stripe::RequestParams
758
- class Discount < Stripe::RequestParams
759
- # ID of the coupon to create a new discount for.
760
- sig { returns(T.nilable(String)) }
761
- attr_accessor :coupon
762
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
763
- sig { returns(T.nilable(String)) }
764
- attr_accessor :discount
765
- # ID of the promotion code to create a new discount for.
766
- sig { returns(T.nilable(String)) }
767
- attr_accessor :promotion_code
768
- sig {
769
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
770
- }
771
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
772
- end
773
- class PriceData < Stripe::RequestParams
774
- class Recurring < Stripe::RequestParams
775
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
776
- sig { returns(String) }
777
- attr_accessor :interval
778
- # 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).
779
- sig { returns(T.nilable(Integer)) }
780
- attr_accessor :interval_count
781
- sig { params(interval: String, interval_count: T.nilable(Integer)).void }
782
- def initialize(interval: nil, interval_count: nil); end
783
- end
784
- # 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).
785
- sig { returns(String) }
786
- attr_accessor :currency
787
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
788
- sig { returns(String) }
789
- attr_accessor :product
790
- # The recurring components of a price such as `interval` and `interval_count`.
791
- sig { returns(T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData::Recurring)) }
792
- attr_accessor :recurring
793
- # 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.
794
- sig { returns(T.nilable(String)) }
795
- attr_accessor :tax_behavior
796
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
797
- sig { returns(T.nilable(Integer)) }
798
- attr_accessor :unit_amount
799
- # 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.
800
- sig { returns(T.nilable(String)) }
801
- attr_accessor :unit_amount_decimal
802
- sig {
803
- params(currency: String, product: String, recurring: T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
804
- }
805
- def initialize(
806
- currency: nil,
807
- product: nil,
808
- recurring: nil,
809
- tax_behavior: nil,
810
- unit_amount: nil,
811
- unit_amount_decimal: nil
812
- ); end
813
- end
814
- # The discounts applied to this line item.
815
- sig {
816
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::LineItem::Discount]))))
817
- }
818
- attr_accessor :discounts
819
- # The ID of an existing line item on the quote.
820
- sig { returns(T.nilable(String)) }
821
- attr_accessor :id
822
- # The ID of the price object. One of `price` or `price_data` is required.
823
- sig { returns(T.nilable(String)) }
824
- attr_accessor :price
825
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
826
- sig { returns(T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData)) }
827
- attr_accessor :price_data
828
- # The quantity of the line item.
829
- sig { returns(T.nilable(Integer)) }
830
- attr_accessor :quantity
831
- # The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
832
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
833
- attr_accessor :tax_rates
834
- sig {
835
- params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::LineItem::Discount]))), id: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Quote::UpdateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
836
- }
837
- def initialize(
838
- discounts: nil,
839
- id: nil,
840
- price: nil,
841
- price_data: nil,
842
- quantity: nil,
843
- tax_rates: nil
844
- ); end
845
- end
846
- class SubscriptionData < Stripe::RequestParams
847
- # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
848
- sig { returns(T.nilable(T.nilable(String))) }
849
- attr_accessor :description
850
- # When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
851
- sig { returns(T.nilable(T.nilable(T.any(String, T.any(String, Integer))))) }
852
- attr_accessor :effective_date
853
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
854
- sig { returns(T.nilable(T::Hash[String, String])) }
855
- attr_accessor :metadata
856
- # Integer representing the number of trial period days before the customer is charged for the first time.
857
- sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
858
- attr_accessor :trial_period_days
859
- sig {
860
- params(description: T.nilable(T.nilable(String)), effective_date: T.nilable(T.nilable(T.any(String, T.any(String, Integer)))), metadata: T.nilable(T::Hash[String, String]), trial_period_days: T.nilable(T.nilable(T.any(String, Integer)))).void
861
- }
862
- def initialize(
863
- description: nil,
864
- effective_date: nil,
865
- metadata: nil,
866
- trial_period_days: nil
867
- ); end
868
- end
869
- class TransferData < Stripe::RequestParams
870
- # The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
871
- sig { returns(T.nilable(Integer)) }
872
- attr_accessor :amount
873
- # 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. There must be at least 1 line item with a recurring price to use this field.
874
- sig { returns(T.nilable(Float)) }
875
- attr_accessor :amount_percent
876
- # ID of an existing, connected Stripe account.
877
- sig { returns(String) }
878
- attr_accessor :destination
879
- sig {
880
- params(amount: T.nilable(Integer), amount_percent: T.nilable(Float), destination: String).void
881
- }
882
- def initialize(amount: nil, amount_percent: nil, destination: nil); end
883
- end
884
- # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
885
- sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
886
- attr_accessor :application_fee_amount
887
- # 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. There must be at least 1 line item with a recurring price to use this field.
888
- sig { returns(T.nilable(T.nilable(T.any(String, Float)))) }
889
- attr_accessor :application_fee_percent
890
- # Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
891
- sig { returns(T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax)) }
892
- attr_accessor :automatic_tax
893
- # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or 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`.
894
- sig { returns(T.nilable(String)) }
895
- attr_accessor :collection_method
896
- # The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
897
- sig { returns(T.nilable(String)) }
898
- attr_accessor :customer
899
- # The tax rates that will apply to any line item that does not have `tax_rates` set.
900
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
901
- attr_accessor :default_tax_rates
902
- # A description that will be displayed on the quote PDF.
903
- sig { returns(T.nilable(T.nilable(String))) }
904
- attr_accessor :description
905
- # The discounts applied to the quote.
906
- sig {
907
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::Discount]))))
908
- }
909
- attr_accessor :discounts
910
- # Specifies which fields in the response should be expanded.
911
- sig { returns(T.nilable(T::Array[String])) }
912
- attr_accessor :expand
913
- # A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
914
- sig { returns(T.nilable(Integer)) }
915
- attr_accessor :expires_at
916
- # A footer that will be displayed on the quote PDF.
917
- sig { returns(T.nilable(T.nilable(String))) }
918
- attr_accessor :footer
919
- # A header that will be displayed on the quote PDF.
920
- sig { returns(T.nilable(T.nilable(String))) }
921
- attr_accessor :header
922
- # All invoices will be billed using the specified settings.
923
- sig { returns(T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings)) }
924
- attr_accessor :invoice_settings
925
- # A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
926
- sig { returns(T.nilable(T::Array[::Stripe::Quote::UpdateParams::LineItem])) }
927
- attr_accessor :line_items
928
- # 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`.
929
- sig { returns(T.nilable(T::Hash[String, String])) }
930
- attr_accessor :metadata
931
- # The account on behalf of which to charge.
932
- sig { returns(T.nilable(T.nilable(String))) }
933
- attr_accessor :on_behalf_of
934
- # When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
935
- sig { returns(T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData)) }
936
- attr_accessor :subscription_data
937
- # The data with which to automatically create a Transfer for each of the invoices.
938
- sig {
939
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::TransferData))))
940
- }
941
- attr_accessor :transfer_data
942
- sig {
943
- params(application_fee_amount: T.nilable(T.nilable(T.any(String, Integer))), application_fee_percent: T.nilable(T.nilable(T.any(String, Float))), automatic_tax: T.nilable(::Stripe::Quote::UpdateParams::AutomaticTax), collection_method: T.nilable(String), customer: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Quote::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), footer: T.nilable(T.nilable(String)), header: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::Quote::UpdateParams::InvoiceSettings), line_items: T.nilable(T::Array[::Stripe::Quote::UpdateParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(T.nilable(String)), subscription_data: T.nilable(::Stripe::Quote::UpdateParams::SubscriptionData), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::Quote::UpdateParams::TransferData)))).void
944
- }
945
- def initialize(
946
- application_fee_amount: nil,
947
- application_fee_percent: nil,
948
- automatic_tax: nil,
949
- collection_method: nil,
950
- customer: nil,
951
- default_tax_rates: nil,
952
- description: nil,
953
- discounts: nil,
954
- expand: nil,
955
- expires_at: nil,
956
- footer: nil,
957
- header: nil,
958
- invoice_settings: nil,
959
- line_items: nil,
960
- metadata: nil,
961
- on_behalf_of: nil,
962
- subscription_data: nil,
963
- transfer_data: nil
964
- ); end
965
- end
966
- class ListComputedUpfrontLineItemsParams < Stripe::RequestParams
967
- # 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.
968
- sig { returns(T.nilable(String)) }
969
- attr_accessor :ending_before
970
- # Specifies which fields in the response should be expanded.
971
- sig { returns(T.nilable(T::Array[String])) }
972
- attr_accessor :expand
973
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
974
- sig { returns(T.nilable(Integer)) }
975
- attr_accessor :limit
976
- # 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.
977
- sig { returns(T.nilable(String)) }
978
- attr_accessor :starting_after
979
- sig {
980
- params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
981
- }
982
- def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
983
- end
984
- class ListLineItemsParams < Stripe::RequestParams
985
- # 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.
986
- sig { returns(T.nilable(String)) }
987
- attr_accessor :ending_before
988
- # Specifies which fields in the response should be expanded.
989
- sig { returns(T.nilable(T::Array[String])) }
990
- attr_accessor :expand
991
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
992
- sig { returns(T.nilable(Integer)) }
993
- attr_accessor :limit
994
- # 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.
995
- sig { returns(T.nilable(String)) }
996
- attr_accessor :starting_after
997
- sig {
998
- params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
999
- }
1000
- def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
1001
- end
1002
- class AcceptParams < Stripe::RequestParams
1003
- # Specifies which fields in the response should be expanded.
1004
- sig { returns(T.nilable(T::Array[String])) }
1005
- attr_accessor :expand
1006
- sig { params(expand: T.nilable(T::Array[String])).void }
1007
- def initialize(expand: nil); end
1008
- end
1009
- class CancelParams < Stripe::RequestParams
1010
- # Specifies which fields in the response should be expanded.
1011
- sig { returns(T.nilable(T::Array[String])) }
1012
- attr_accessor :expand
1013
- sig { params(expand: T.nilable(T::Array[String])).void }
1014
- def initialize(expand: nil); end
1015
- end
1016
- class FinalizeQuoteParams < Stripe::RequestParams
1017
- # Specifies which fields in the response should be expanded.
1018
- sig { returns(T.nilable(T::Array[String])) }
1019
- attr_accessor :expand
1020
- # A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
1021
- sig { returns(T.nilable(Integer)) }
1022
- attr_accessor :expires_at
1023
- sig { params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer)).void }
1024
- def initialize(expand: nil, expires_at: nil); end
1025
- end
1026
- class PdfParams < Stripe::RequestParams
1027
- # Specifies which fields in the response should be expanded.
1028
- sig { returns(T.nilable(T::Array[String])) }
1029
- attr_accessor :expand
1030
- sig { params(expand: T.nilable(T::Array[String])).void }
1031
- def initialize(expand: nil); end
1032
- end
1033
- # Accepts the specified quote.
1034
- sig {
1035
- params(params: T.any(::Stripe::Quote::AcceptParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
1036
- }
1037
- def accept(params = {}, opts = {}); end
1038
-
1039
- # Accepts the specified quote.
1040
- sig {
1041
- params(quote: String, params: T.any(::Stripe::Quote::AcceptParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
1042
- }
1043
- def self.accept(quote, params = {}, opts = {}); end
1044
-
1045
- # Cancels the quote.
1046
- sig {
1047
- params(params: T.any(::Stripe::Quote::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
1048
- }
1049
- def cancel(params = {}, opts = {}); end
1050
-
1051
- # Cancels the quote.
1052
- sig {
1053
- params(quote: String, params: T.any(::Stripe::Quote::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
1054
- }
1055
- def self.cancel(quote, params = {}, opts = {}); end
1056
-
1057
- # A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the [quote template](https://dashboard.stripe.com/settings/billing/quote).
1058
- sig {
1059
- params(params: T.any(::Stripe::Quote::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
1060
- }
1061
- def self.create(params = {}, opts = {}); end
1062
-
1063
- # Finalizes the quote.
1064
- sig {
1065
- params(params: T.any(::Stripe::Quote::FinalizeQuoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
1066
- }
1067
- def finalize_quote(params = {}, opts = {}); end
1068
-
1069
- # Finalizes the quote.
1070
- sig {
1071
- params(quote: String, params: T.any(::Stripe::Quote::FinalizeQuoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
1072
- }
1073
- def self.finalize_quote(quote, params = {}, opts = {}); end
1074
-
1075
- # Returns a list of your quotes.
1076
- sig {
1077
- params(params: T.any(::Stripe::Quote::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1078
- }
1079
- def self.list(params = {}, opts = {}); end
1080
-
1081
- # When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
1082
- sig {
1083
- params(params: T.any(::Stripe::Quote::ListComputedUpfrontLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1084
- }
1085
- def list_computed_upfront_line_items(params = {}, opts = {}); end
1086
-
1087
- # When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
1088
- sig {
1089
- params(quote: String, params: T.any(::Stripe::Quote::ListComputedUpfrontLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1090
- }
1091
- def self.list_computed_upfront_line_items(quote, params = {}, opts = {}); end
1092
-
1093
- # When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
1094
- sig {
1095
- params(params: T.any(::Stripe::Quote::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1096
- }
1097
- def list_line_items(params = {}, opts = {}); end
1098
-
1099
- # When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
1100
- sig {
1101
- params(quote: String, params: T.any(::Stripe::Quote::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1102
- }
1103
- def self.list_line_items(quote, params = {}, opts = {}); end
1104
-
1105
- # Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
1106
- sig {
1107
- params(params: T.any(::Stripe::Quote::PdfParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, read_body_chunk_block: T.untyped).returns(T.untyped)
1108
- }
1109
- def pdf(params = {}, opts = {}, &read_body_chunk_block); end
1110
-
1111
- # Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
1112
- sig {
1113
- params(quote: String, params: T.any(::Stripe::Quote::PdfParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, read_body_chunk_block: T.untyped).returns(T.untyped)
1114
- }
1115
- def self.pdf(quote, params = {}, opts = {}, &read_body_chunk_block); end
1116
-
1117
- # A quote models prices and services for a customer.
1118
- sig {
1119
- params(quote: String, params: T.any(::Stripe::Quote::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Quote)
1120
- }
1121
- def self.update(quote, params = {}, opts = {}); end
1122
- end
1123
- end