stripe 18.1.0.pre.alpha.4 → 18.2.0.pre.alpha.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 (449) hide show
  1. checksums.yaml +4 -4
  2. data/lib/data/ca-certificates.crt +682 -518
  3. data/lib/stripe/api_requestor.rb +2 -0
  4. data/lib/stripe/api_version.rb +1 -1
  5. data/lib/stripe/errors.rb +3 -0
  6. data/lib/stripe/event_types.rb +56 -0
  7. data/lib/stripe/events/v2_core_health_api_error_firing_event.rb +19 -1
  8. data/lib/stripe/events/v2_core_health_api_error_resolved_event.rb +19 -1
  9. data/lib/stripe/events/v2_core_health_api_latency_firing_event.rb +19 -1
  10. data/lib/stripe/events/v2_core_health_api_latency_resolved_event.rb +19 -1
  11. data/lib/stripe/events/v2_core_health_payment_method_error_firing_event.rb +19 -1
  12. data/lib/stripe/events/v2_core_health_payment_method_error_resolved_event.rb +19 -1
  13. data/lib/stripe/events/v2_core_health_sepa_debit_delayed_firing_event.rb +58 -0
  14. data/lib/stripe/events/v2_core_health_sepa_debit_delayed_resolved_event.rb +60 -0
  15. data/lib/stripe/events/v2_money_management_payout_method_created_event.rb +44 -0
  16. data/lib/stripe/events/v2_payments_settlement_allocation_intent_canceled_event.rb +44 -0
  17. data/lib/stripe/events/v2_payments_settlement_allocation_intent_created_event.rb +44 -0
  18. data/lib/stripe/events/v2_payments_settlement_allocation_intent_errored_event.rb +65 -0
  19. data/lib/stripe/events/v2_payments_settlement_allocation_intent_funds_not_received_event.rb +44 -0
  20. data/lib/stripe/events/v2_payments_settlement_allocation_intent_matched_event.rb +44 -0
  21. data/lib/stripe/events/v2_payments_settlement_allocation_intent_not_found_event.rb +38 -0
  22. data/lib/stripe/events/v2_payments_settlement_allocation_intent_settled_event.rb +44 -0
  23. data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_canceled_event.rb +61 -0
  24. data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_created_event.rb +61 -0
  25. data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_settled_event.rb +61 -0
  26. data/lib/stripe/events/v2_payments_settlement_allocation_intent_submitted_event.rb +44 -0
  27. data/lib/stripe/object_types.rb +6 -0
  28. data/lib/stripe/params/account_create_params.rb +50 -28
  29. data/lib/stripe/params/account_external_account_create_params.rb +2 -2
  30. data/lib/stripe/params/account_external_account_update_params.rb +2 -2
  31. data/lib/stripe/params/account_notice_update_params.rb +1 -1
  32. data/lib/stripe/params/account_person_create_params.rb +10 -10
  33. data/lib/stripe/params/account_person_update_params.rb +10 -10
  34. data/lib/stripe/params/account_session_create_params.rb +17 -0
  35. data/lib/stripe/params/account_update_params.rb +49 -27
  36. data/lib/stripe/params/application_fee_refund_create_params.rb +1 -1
  37. data/lib/stripe/params/application_fee_refund_update_params.rb +1 -1
  38. data/lib/stripe/params/balance_transfer_create_params.rb +1 -1
  39. data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb +2 -2
  40. data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb +2 -2
  41. data/lib/stripe/params/billing/credit_grant_create_params.rb +2 -2
  42. data/lib/stripe/params/billing/credit_grant_list_params.rb +1 -1
  43. data/lib/stripe/params/billing/meter_event_create_params.rb +1 -1
  44. data/lib/stripe/params/billing_portal/configuration_create_params.rb +7 -3
  45. data/lib/stripe/params/billing_portal/configuration_update_params.rb +7 -3
  46. data/lib/stripe/params/billing_portal/session_create_params.rb +7 -7
  47. data/lib/stripe/params/charge_capture_params.rb +9 -9
  48. data/lib/stripe/params/charge_create_params.rb +12 -12
  49. data/lib/stripe/params/charge_search_params.rb +1 -1
  50. data/lib/stripe/params/charge_update_params.rb +10 -10
  51. data/lib/stripe/params/checkout/session_create_params.rb +53 -41
  52. data/lib/stripe/params/checkout/session_update_params.rb +27 -15
  53. data/lib/stripe/params/climate/order_create_params.rb +1 -1
  54. data/lib/stripe/params/climate/order_update_params.rb +1 -1
  55. data/lib/stripe/params/confirmation_token_create_params.rb +6 -6
  56. data/lib/stripe/params/coupon_create_params.rb +1 -1
  57. data/lib/stripe/params/coupon_update_params.rb +1 -1
  58. data/lib/stripe/params/credit_note_create_params.rb +1 -1
  59. data/lib/stripe/params/credit_note_list_params.rb +1 -1
  60. data/lib/stripe/params/credit_note_list_preview_line_items_params.rb +1 -1
  61. data/lib/stripe/params/credit_note_preview_lines_list_params.rb +1 -1
  62. data/lib/stripe/params/credit_note_preview_params.rb +1 -1
  63. data/lib/stripe/params/credit_note_update_params.rb +1 -1
  64. data/lib/stripe/params/customer_balance_transaction_create_params.rb +2 -2
  65. data/lib/stripe/params/customer_balance_transaction_list_params.rb +11 -1
  66. data/lib/stripe/params/customer_balance_transaction_update_params.rb +1 -1
  67. data/lib/stripe/params/customer_cash_balance_update_params.rb +1 -1
  68. data/lib/stripe/params/customer_create_params.rb +5 -5
  69. data/lib/stripe/params/customer_fund_cash_balance_params.rb +2 -2
  70. data/lib/stripe/params/customer_payment_source_create_params.rb +2 -2
  71. data/lib/stripe/params/customer_payment_source_update_params.rb +2 -2
  72. data/lib/stripe/params/customer_search_params.rb +1 -1
  73. data/lib/stripe/params/customer_update_params.rb +7 -7
  74. data/lib/stripe/params/delegated_checkout/requested_session_confirm_params.rb +84 -1
  75. data/lib/stripe/params/dispute_update_params.rb +3 -3
  76. data/lib/stripe/params/external_account_create_params.rb +2 -2
  77. data/lib/stripe/params/external_account_update_params.rb +2 -2
  78. data/lib/stripe/params/file_create_params.rb +3 -3
  79. data/lib/stripe/params/file_link_create_params.rb +1 -1
  80. data/lib/stripe/params/file_link_update_params.rb +1 -1
  81. data/lib/stripe/params/financial_connections/account_list_params.rb +3 -3
  82. data/lib/stripe/params/financial_connections/session_create_params.rb +3 -3
  83. data/lib/stripe/params/forwarding/request_create_params.rb +1 -1
  84. data/lib/stripe/params/identity/verification_session_create_params.rb +6 -6
  85. data/lib/stripe/params/identity/verification_session_list_params.rb +3 -3
  86. data/lib/stripe/params/identity/verification_session_update_params.rb +5 -5
  87. data/lib/stripe/params/invoice_add_lines_params.rb +21 -9
  88. data/lib/stripe/params/invoice_attach_payment_params.rb +1 -1
  89. data/lib/stripe/params/invoice_create_params.rb +37 -13
  90. data/lib/stripe/params/invoice_create_preview_params.rb +60 -60
  91. data/lib/stripe/params/invoice_finalize_invoice_params.rb +1 -1
  92. data/lib/stripe/params/invoice_item_create_params.rb +8 -8
  93. data/lib/stripe/params/invoice_item_list_params.rb +2 -2
  94. data/lib/stripe/params/invoice_item_update_params.rb +6 -6
  95. data/lib/stripe/params/invoice_line_item_update_params.rb +20 -8
  96. data/lib/stripe/params/invoice_list_params.rb +2 -2
  97. data/lib/stripe/params/invoice_remove_lines_params.rb +1 -1
  98. data/lib/stripe/params/invoice_search_params.rb +1 -1
  99. data/lib/stripe/params/invoice_update_lines_params.rb +21 -9
  100. data/lib/stripe/params/invoice_update_params.rb +34 -10
  101. data/lib/stripe/params/issuing/authorization_approve_params.rb +2 -2
  102. data/lib/stripe/params/issuing/authorization_capture_params.rb +1 -1
  103. data/lib/stripe/params/issuing/authorization_create_params.rb +5 -5
  104. data/lib/stripe/params/issuing/authorization_decline_params.rb +1 -1
  105. data/lib/stripe/params/issuing/authorization_finalize_amount_params.rb +1 -1
  106. data/lib/stripe/params/issuing/authorization_increment_params.rb +2 -2
  107. data/lib/stripe/params/issuing/authorization_reverse_params.rb +1 -1
  108. data/lib/stripe/params/issuing/authorization_update_params.rb +1 -1
  109. data/lib/stripe/params/issuing/card_create_params.rb +7 -7
  110. data/lib/stripe/params/issuing/card_list_params.rb +34 -1
  111. data/lib/stripe/params/issuing/card_update_params.rb +6 -6
  112. data/lib/stripe/params/issuing/cardholder_create_params.rb +11 -11
  113. data/lib/stripe/params/issuing/cardholder_update_params.rb +10 -10
  114. data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +5 -5
  115. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +1 -1
  116. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +5 -5
  117. data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +4 -4
  118. data/lib/stripe/params/issuing/dispute_create_params.rb +2 -2
  119. data/lib/stripe/params/issuing/dispute_submit_params.rb +1 -1
  120. data/lib/stripe/params/issuing/dispute_update_params.rb +2 -2
  121. data/lib/stripe/params/issuing/personalization_design_create_params.rb +1 -1
  122. data/lib/stripe/params/issuing/personalization_design_update_params.rb +1 -1
  123. data/lib/stripe/params/issuing/program_update_params.rb +1 -1
  124. data/lib/stripe/params/issuing/transaction_create_force_capture_params.rb +2 -2
  125. data/lib/stripe/params/issuing/transaction_create_unlinked_refund_params.rb +2 -2
  126. data/lib/stripe/params/issuing/transaction_refund_params.rb +1 -1
  127. data/lib/stripe/params/issuing/transaction_update_params.rb +1 -1
  128. data/lib/stripe/params/mandate_list_params.rb +1 -1
  129. data/lib/stripe/params/margin_create_params.rb +1 -1
  130. data/lib/stripe/params/margin_update_params.rb +1 -1
  131. data/lib/stripe/params/order_create_params.rb +12 -12
  132. data/lib/stripe/params/order_update_params.rb +12 -12
  133. data/lib/stripe/params/payment_intent_apply_customer_balance_params.rb +1 -1
  134. data/lib/stripe/params/payment_intent_capture_params.rb +18 -18
  135. data/lib/stripe/params/payment_intent_confirm_params.rb +43 -39
  136. data/lib/stripe/params/payment_intent_create_params.rb +61 -57
  137. data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +4 -4
  138. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +10 -10
  139. data/lib/stripe/params/payment_intent_list_params.rb +1 -1
  140. data/lib/stripe/params/payment_intent_search_params.rb +1 -1
  141. data/lib/stripe/params/payment_intent_update_params.rb +40 -40
  142. data/lib/stripe/params/payment_link_create_params.rb +32 -20
  143. data/lib/stripe/params/payment_link_update_params.rb +9 -9
  144. data/lib/stripe/params/payment_method_attach_params.rb +1 -1
  145. data/lib/stripe/params/payment_method_configuration_create_params.rb +40 -40
  146. data/lib/stripe/params/payment_method_configuration_update_params.rb +40 -40
  147. data/lib/stripe/params/payment_method_create_params.rb +4 -4
  148. data/lib/stripe/params/payment_method_update_params.rb +2 -2
  149. data/lib/stripe/params/payment_record_report_payment_attempt_informational_params.rb +2 -2
  150. data/lib/stripe/params/payment_record_report_payment_attempt_params.rb +3 -3
  151. data/lib/stripe/params/payment_record_report_payment_params.rb +4 -4
  152. data/lib/stripe/params/payment_record_report_refund_params.rb +3 -3
  153. data/lib/stripe/params/payout_create_params.rb +1 -1
  154. data/lib/stripe/params/payout_reverse_params.rb +1 -1
  155. data/lib/stripe/params/payout_update_params.rb +1 -1
  156. data/lib/stripe/params/plan_create_params.rb +4 -4
  157. data/lib/stripe/params/plan_update_params.rb +2 -2
  158. data/lib/stripe/params/price_create_params.rb +6 -6
  159. data/lib/stripe/params/price_search_params.rb +1 -1
  160. data/lib/stripe/params/price_update_params.rb +3 -3
  161. data/lib/stripe/params/product_create_params.rb +21 -8
  162. data/lib/stripe/params/product_feature_create_params.rb +1 -1
  163. data/lib/stripe/params/product_list_params.rb +1 -1
  164. data/lib/stripe/params/product_search_params.rb +1 -1
  165. data/lib/stripe/params/product_update_params.rb +18 -5
  166. data/lib/stripe/params/promotion_code_create_params.rb +3 -3
  167. data/lib/stripe/params/promotion_code_list_params.rb +1 -1
  168. data/lib/stripe/params/promotion_code_update_params.rb +1 -1
  169. data/lib/stripe/params/quote_create_params.rb +14 -14
  170. data/lib/stripe/params/quote_list_params.rb +2 -2
  171. data/lib/stripe/params/quote_update_params.rb +14 -14
  172. data/lib/stripe/params/radar/value_list_create_params.rb +1 -1
  173. data/lib/stripe/params/radar/value_list_update_params.rb +1 -1
  174. data/lib/stripe/params/refund_create_params.rb +2 -2
  175. data/lib/stripe/params/refund_update_params.rb +1 -1
  176. data/lib/stripe/params/reporting/report_run_create_params.rb +2 -2
  177. data/lib/stripe/params/setup_intent_confirm_params.rb +6 -6
  178. data/lib/stripe/params/setup_intent_create_params.rb +12 -12
  179. data/lib/stripe/params/setup_intent_update_params.rb +8 -8
  180. data/lib/stripe/params/shared_payment/granted_token_create_params.rb +47 -0
  181. data/lib/stripe/params/shared_payment/granted_token_retrieve_params.rb +15 -0
  182. data/lib/stripe/params/shared_payment/granted_token_update_params.rb +15 -0
  183. data/lib/stripe/params/shipping_rate_create_params.rb +2 -2
  184. data/lib/stripe/params/shipping_rate_update_params.rb +1 -1
  185. data/lib/stripe/params/source_create_params.rb +3 -3
  186. data/lib/stripe/params/source_update_params.rb +3 -3
  187. data/lib/stripe/params/subscription_create_params.rb +51 -27
  188. data/lib/stripe/params/subscription_item_create_params.rb +15 -15
  189. data/lib/stripe/params/subscription_item_delete_params.rb +2 -2
  190. data/lib/stripe/params/subscription_item_update_params.rb +15 -15
  191. data/lib/stripe/params/subscription_list_params.rb +3 -3
  192. data/lib/stripe/params/subscription_resume_params.rb +2 -2
  193. data/lib/stripe/params/subscription_schedule_amend_params.rb +10 -10
  194. data/lib/stripe/params/subscription_schedule_create_params.rb +31 -31
  195. data/lib/stripe/params/subscription_schedule_update_params.rb +31 -31
  196. data/lib/stripe/params/subscription_search_params.rb +1 -1
  197. data/lib/stripe/params/subscription_update_params.rb +49 -25
  198. data/lib/stripe/params/tax/association_find_params.rb +1 -1
  199. data/lib/stripe/params/tax/calculation_create_params.rb +7 -7
  200. data/lib/stripe/params/tax/settings_update_params.rb +1 -1
  201. data/lib/stripe/params/tax/transaction_create_from_calculation_params.rb +1 -1
  202. data/lib/stripe/params/tax/transaction_create_reversal_params.rb +9 -9
  203. data/lib/stripe/params/tax_id_create_params.rb +2 -2
  204. data/lib/stripe/params/tax_id_list_params.rb +2 -2
  205. data/lib/stripe/params/tax_rate_create_params.rb +1 -1
  206. data/lib/stripe/params/tax_rate_update_params.rb +1 -1
  207. data/lib/stripe/params/terminal/location_create_params.rb +2 -2
  208. data/lib/stripe/params/terminal/location_update_params.rb +2 -2
  209. data/lib/stripe/params/terminal/reader_collect_inputs_params.rb +1 -1
  210. data/lib/stripe/params/terminal/reader_create_params.rb +1 -1
  211. data/lib/stripe/params/terminal/reader_refund_payment_params.rb +1 -1
  212. data/lib/stripe/params/terminal/reader_set_reader_display_params.rb +3 -3
  213. data/lib/stripe/params/terminal/reader_update_params.rb +1 -1
  214. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +6 -6
  215. data/lib/stripe/params/test_helpers/customer_fund_cash_balance_params.rb +2 -2
  216. data/lib/stripe/params/test_helpers/issuing/authorization_capture_params.rb +1 -1
  217. data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +5 -5
  218. data/lib/stripe/params/test_helpers/issuing/authorization_finalize_amount_params.rb +1 -1
  219. data/lib/stripe/params/test_helpers/issuing/authorization_increment_params.rb +2 -2
  220. data/lib/stripe/params/test_helpers/issuing/authorization_reverse_params.rb +1 -1
  221. data/lib/stripe/params/test_helpers/issuing/transaction_create_force_capture_params.rb +2 -2
  222. data/lib/stripe/params/test_helpers/issuing/transaction_create_unlinked_refund_params.rb +2 -2
  223. data/lib/stripe/params/test_helpers/issuing/transaction_refund_params.rb +1 -1
  224. data/lib/stripe/params/test_helpers/shared_payment/granted_token_create_params.rb +49 -0
  225. data/lib/stripe/params/test_helpers/shared_payment/granted_token_update_params.rb +17 -0
  226. data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +1 -1
  227. data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +1 -1
  228. data/lib/stripe/params/token_create_params.rb +22 -22
  229. data/lib/stripe/params/topup_create_params.rb +2 -2
  230. data/lib/stripe/params/topup_update_params.rb +1 -1
  231. data/lib/stripe/params/transfer_create_params.rb +3 -3
  232. data/lib/stripe/params/transfer_reversal_create_params.rb +1 -1
  233. data/lib/stripe/params/transfer_reversal_update_params.rb +1 -1
  234. data/lib/stripe/params/transfer_update_params.rb +1 -1
  235. data/lib/stripe/params/treasury/credit_reversal_create_params.rb +1 -1
  236. data/lib/stripe/params/treasury/debit_reversal_create_params.rb +1 -1
  237. data/lib/stripe/params/treasury/financial_account_create_params.rb +1 -1
  238. data/lib/stripe/params/treasury/financial_account_update_params.rb +1 -1
  239. data/lib/stripe/params/treasury/inbound_transfer_create_params.rb +2 -2
  240. data/lib/stripe/params/treasury/outbound_payment_create_params.rb +5 -5
  241. data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +3 -3
  242. data/lib/stripe/params/treasury/received_credit_create_params.rb +1 -1
  243. data/lib/stripe/params/treasury/received_debit_create_params.rb +1 -1
  244. data/lib/stripe/params/v2/billing/intent_create_params.rb +110 -40
  245. data/lib/stripe/params/v2/core/account_create_params.rb +36 -24
  246. data/lib/stripe/params/v2/core/account_link_create_params.rb +5 -5
  247. data/lib/stripe/params/v2/core/account_token_create_params.rb +8 -8
  248. data/lib/stripe/params/v2/core/account_update_params.rb +41 -29
  249. data/lib/stripe/params/v2/core/accounts/person_create_params.rb +5 -5
  250. data/lib/stripe/params/v2/core/accounts/person_token_create_params.rb +5 -5
  251. data/lib/stripe/params/v2/core/accounts/person_update_params.rb +5 -5
  252. data/lib/stripe/params/v2/core/claimable_sandbox_create_params.rb +1 -1
  253. data/lib/stripe/params/v2/iam/api_key_create_params.rb +51 -0
  254. data/lib/stripe/params/v2/iam/api_key_expire_params.rb +10 -0
  255. data/lib/stripe/params/v2/iam/api_key_list_params.rb +20 -0
  256. data/lib/stripe/params/v2/iam/api_key_retrieve_params.rb +10 -0
  257. data/lib/stripe/params/v2/iam/api_key_rotate_params.rb +46 -0
  258. data/lib/stripe/params/v2/iam/api_key_update_params.rb +20 -0
  259. data/lib/stripe/params/v2/money_management/financial_account_list_params.rb +4 -1
  260. data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +4 -1
  261. data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +4 -1
  262. data/lib/stripe/params/v2/payments/settlement_allocation_intent_cancel_params.rb +10 -0
  263. data/lib/stripe/params/v2/payments/settlement_allocation_intent_create_params.rb +46 -0
  264. data/lib/stripe/params/v2/payments/settlement_allocation_intent_retrieve_params.rb +10 -0
  265. data/lib/stripe/params/v2/payments/settlement_allocation_intent_submit_params.rb +10 -0
  266. data/lib/stripe/params/v2/payments/settlement_allocation_intent_update_params.rb +31 -0
  267. data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_cancel_params.rb +12 -0
  268. data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_create_params.rb +39 -0
  269. data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_retrieve_params.rb +12 -0
  270. data/lib/stripe/params/v2/tax/manual_rule_create_params.rb +94 -0
  271. data/lib/stripe/params/v2/tax/manual_rule_deactivate_params.rb +10 -0
  272. data/lib/stripe/params/v2/tax/manual_rule_list_params.rb +17 -0
  273. data/lib/stripe/params/v2/tax/manual_rule_retrieve_params.rb +10 -0
  274. data/lib/stripe/params/v2/tax/manual_rule_update_params.rb +94 -0
  275. data/lib/stripe/params/webhook_endpoint_create_params.rb +1 -1
  276. data/lib/stripe/params/webhook_endpoint_update_params.rb +1 -1
  277. data/lib/stripe/params.rb +24 -0
  278. data/lib/stripe/resources/account.rb +27 -27
  279. data/lib/stripe/resources/account_link.rb +1 -1
  280. data/lib/stripe/resources/account_notice.rb +6 -6
  281. data/lib/stripe/resources/account_session.rb +5 -5
  282. data/lib/stripe/resources/application_fee_refund.rb +2 -2
  283. data/lib/stripe/resources/apps/secret.rb +1 -1
  284. data/lib/stripe/resources/balance.rb +2 -2
  285. data/lib/stripe/resources/balance_settings.rb +1 -1
  286. data/lib/stripe/resources/balance_transaction.rb +1 -1
  287. data/lib/stripe/resources/balance_transfer.rb +3 -3
  288. data/lib/stripe/resources/bank_account.rb +10 -10
  289. data/lib/stripe/resources/billing/alert.rb +2 -2
  290. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -2
  291. data/lib/stripe/resources/billing/credit_balance_transaction.rb +2 -2
  292. data/lib/stripe/resources/billing/credit_grant.rb +3 -3
  293. data/lib/stripe/resources/billing/meter_event.rb +1 -1
  294. data/lib/stripe/resources/billing_portal/configuration.rb +5 -3
  295. data/lib/stripe/resources/billing_portal/session.rb +6 -6
  296. data/lib/stripe/resources/capability.rb +16 -16
  297. data/lib/stripe/resources/capital/financing_offer.rb +2 -2
  298. data/lib/stripe/resources/capital/financing_summary.rb +7 -4
  299. data/lib/stripe/resources/card.rb +2 -2
  300. data/lib/stripe/resources/cash_balance.rb +2 -2
  301. data/lib/stripe/resources/charge.rb +47 -35
  302. data/lib/stripe/resources/checkout/session.rb +19 -19
  303. data/lib/stripe/resources/climate/order.rb +1 -1
  304. data/lib/stripe/resources/confirmation_token.rb +11 -11
  305. data/lib/stripe/resources/coupon.rb +3 -3
  306. data/lib/stripe/resources/credit_note.rb +5 -5
  307. data/lib/stripe/resources/credit_note_line_item.rb +1 -1
  308. data/lib/stripe/resources/customer.rb +8 -8
  309. data/lib/stripe/resources/customer_balance_transaction.rb +6 -6
  310. data/lib/stripe/resources/customer_cash_balance_transaction.rb +10 -10
  311. data/lib/stripe/resources/delegated_checkout/requested_session.rb +63 -10
  312. data/lib/stripe/resources/discount.rb +5 -5
  313. data/lib/stripe/resources/dispute.rb +5 -5
  314. data/lib/stripe/resources/entitlements/active_entitlement.rb +1 -1
  315. data/lib/stripe/resources/event.rb +1 -1
  316. data/lib/stripe/resources/exchange_rate.rb +2 -2
  317. data/lib/stripe/resources/file.rb +4 -4
  318. data/lib/stripe/resources/file_link.rb +1 -1
  319. data/lib/stripe/resources/financial_connections/account.rb +3 -3
  320. data/lib/stripe/resources/financial_connections/session.rb +2 -2
  321. data/lib/stripe/resources/forwarding/request.rb +1 -1
  322. data/lib/stripe/resources/funding_instructions.rb +14 -14
  323. data/lib/stripe/resources/identity/blocklist_entry.rb +1 -1
  324. data/lib/stripe/resources/identity/verification_report.rb +9 -9
  325. data/lib/stripe/resources/identity/verification_session.rb +11 -11
  326. data/lib/stripe/resources/invoice.rb +66 -34
  327. data/lib/stripe/resources/invoice_item.rb +9 -9
  328. data/lib/stripe/resources/invoice_line_item.rb +7 -7
  329. data/lib/stripe/resources/invoice_payment.rb +1 -1
  330. data/lib/stripe/resources/invoice_rendering_template.rb +1 -1
  331. data/lib/stripe/resources/issuing/authorization.rb +20 -20
  332. data/lib/stripe/resources/issuing/card.rb +16 -12
  333. data/lib/stripe/resources/issuing/cardholder.rb +14 -14
  334. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +5 -5
  335. data/lib/stripe/resources/issuing/dispute.rb +7 -7
  336. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +1 -1
  337. data/lib/stripe/resources/issuing/personalization_design.rb +1 -1
  338. data/lib/stripe/resources/issuing/program.rb +1 -1
  339. data/lib/stripe/resources/issuing/settlement.rb +2 -2
  340. data/lib/stripe/resources/issuing/token.rb +1 -1
  341. data/lib/stripe/resources/issuing/transaction.rb +13 -13
  342. data/lib/stripe/resources/line_item.rb +3 -3
  343. data/lib/stripe/resources/login_link.rb +1 -1
  344. data/lib/stripe/resources/margin.rb +1 -1
  345. data/lib/stripe/resources/order.rb +13 -13
  346. data/lib/stripe/resources/payment_attempt_record.rb +80 -22
  347. data/lib/stripe/resources/payment_intent.rb +117 -74
  348. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +3 -3
  349. data/lib/stripe/resources/payment_link.rb +7 -7
  350. data/lib/stripe/resources/payment_method.rb +13 -13
  351. data/lib/stripe/resources/payment_method_configuration.rb +4 -4
  352. data/lib/stripe/resources/payment_method_domain.rb +1 -1
  353. data/lib/stripe/resources/payment_record.rb +82 -22
  354. data/lib/stripe/resources/payout.rb +7 -7
  355. data/lib/stripe/resources/person.rb +23 -23
  356. data/lib/stripe/resources/plan.rb +5 -5
  357. data/lib/stripe/resources/price.rb +6 -6
  358. data/lib/stripe/resources/product.rb +9 -9
  359. data/lib/stripe/resources/promotion_code.rb +4 -4
  360. data/lib/stripe/resources/quote.rb +15 -15
  361. data/lib/stripe/resources/quote_line.rb +5 -5
  362. data/lib/stripe/resources/quote_preview_invoice.rb +64 -32
  363. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +100 -100
  364. data/lib/stripe/resources/radar/early_fraud_warning.rb +1 -1
  365. data/lib/stripe/resources/radar/value_list.rb +2 -2
  366. data/lib/stripe/resources/radar/value_list_item.rb +1 -1
  367. data/lib/stripe/resources/refund.rb +3 -3
  368. data/lib/stripe/resources/reporting/report_run.rb +3 -3
  369. data/lib/stripe/resources/reporting/report_type.rb +3 -3
  370. data/lib/stripe/resources/reversal.rb +4 -4
  371. data/lib/stripe/resources/review.rb +1 -1
  372. data/lib/stripe/resources/setup_attempt.rb +17 -17
  373. data/lib/stripe/resources/setup_intent.rb +19 -19
  374. data/lib/stripe/resources/shared_payment/granted_token.rb +126 -0
  375. data/lib/stripe/resources/shipping_rate.rb +3 -3
  376. data/lib/stripe/resources/sigma/scheduled_query_run.rb +1 -1
  377. data/lib/stripe/resources/source.rb +8 -8
  378. data/lib/stripe/resources/source_mandate_notification.rb +3 -3
  379. data/lib/stripe/resources/subscription.rb +46 -14
  380. data/lib/stripe/resources/subscription_item.rb +22 -22
  381. data/lib/stripe/resources/subscription_schedule.rb +101 -101
  382. data/lib/stripe/resources/tax/association.rb +3 -3
  383. data/lib/stripe/resources/tax/calculation.rb +12 -12
  384. data/lib/stripe/resources/tax/calculation_line_item.rb +7 -7
  385. data/lib/stripe/resources/tax/registration.rb +3 -3
  386. data/lib/stripe/resources/tax/settings.rb +2 -2
  387. data/lib/stripe/resources/tax/transaction.rb +9 -9
  388. data/lib/stripe/resources/tax/transaction_line_item.rb +5 -5
  389. data/lib/stripe/resources/tax_id.rb +4 -4
  390. data/lib/stripe/resources/tax_rate.rb +1 -1
  391. data/lib/stripe/resources/terminal/connection_token.rb +1 -1
  392. data/lib/stripe/resources/terminal/location.rb +3 -3
  393. data/lib/stripe/resources/terminal/reader.rb +10 -10
  394. data/lib/stripe/resources/token.rb +4 -4
  395. data/lib/stripe/resources/topup.rb +3 -3
  396. data/lib/stripe/resources/transfer.rb +5 -5
  397. data/lib/stripe/resources/treasury/credit_reversal.rb +3 -3
  398. data/lib/stripe/resources/treasury/debit_reversal.rb +3 -3
  399. data/lib/stripe/resources/treasury/financial_account.rb +1 -1
  400. data/lib/stripe/resources/treasury/inbound_transfer.rb +5 -5
  401. data/lib/stripe/resources/treasury/outbound_payment.rb +6 -6
  402. data/lib/stripe/resources/treasury/outbound_transfer.rb +5 -5
  403. data/lib/stripe/resources/treasury/received_credit.rb +10 -10
  404. data/lib/stripe/resources/treasury/received_debit.rb +7 -7
  405. data/lib/stripe/resources/treasury/transaction.rb +11 -11
  406. data/lib/stripe/resources/treasury/transaction_entry.rb +11 -11
  407. data/lib/stripe/resources/v2/billing/intent_action.rb +139 -51
  408. data/lib/stripe/resources/v2/core/account.rb +174 -289
  409. data/lib/stripe/resources/v2/core/account_link.rb +11 -11
  410. data/lib/stripe/resources/v2/core/account_person.rb +10 -10
  411. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +21 -1
  412. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +23 -1
  413. data/lib/stripe/resources/v2/iam/api_key.rb +129 -0
  414. data/lib/stripe/resources/v2/money_management/financial_account.rb +35 -0
  415. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +2 -0
  416. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +2 -0
  417. data/lib/stripe/resources/v2/money_management/payout_method.rb +20 -0
  418. data/lib/stripe/resources/v2/money_management/received_credit.rb +2 -0
  419. data/lib/stripe/resources/v2/payments/settlement_allocation_intent.rb +92 -0
  420. data/lib/stripe/resources/v2/payments/settlement_allocation_intent_split.rb +78 -0
  421. data/lib/stripe/resources/v2/tax/manual_rule.rb +115 -0
  422. data/lib/stripe/resources/webhook_endpoint.rb +1 -1
  423. data/lib/stripe/resources.rb +19 -0
  424. data/lib/stripe/services/capital/financing_summary_service.rb +1 -1
  425. data/lib/stripe/services/payment_method_service.rb +1 -1
  426. data/lib/stripe/services/shared_payment/granted_token_service.rb +19 -0
  427. data/lib/stripe/services/shared_payment_service.rb +13 -0
  428. data/lib/stripe/services/test_helpers/shared_payment/granted_token_service.rb +32 -0
  429. data/lib/stripe/services/test_helpers/shared_payment_service.rb +15 -0
  430. data/lib/stripe/services/test_helpers_service.rb +2 -1
  431. data/lib/stripe/services/v1_services.rb +2 -1
  432. data/lib/stripe/services/v2/core/account_link_service.rb +1 -1
  433. data/lib/stripe/services/v2/core/account_service.rb +0 -4
  434. data/lib/stripe/services/v2/core/accounts/person_service.rb +2 -2
  435. data/lib/stripe/services/v2/iam/api_key_service.rb +76 -0
  436. data/lib/stripe/services/v2/iam_service.rb +15 -0
  437. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +2 -0
  438. data/lib/stripe/services/v2/money_management/payout_method_service.rb +2 -0
  439. data/lib/stripe/services/v2/payment_service.rb +3 -1
  440. data/lib/stripe/services/v2/payments/settlement_allocation_intent_service.rb +72 -0
  441. data/lib/stripe/services/v2/payments/settlement_allocation_intents/split_service.rb +45 -0
  442. data/lib/stripe/services/v2/tax/manual_rule_service.rb +65 -0
  443. data/lib/stripe/services/v2/tax_service.rb +15 -0
  444. data/lib/stripe/services/v2_services.rb +3 -1
  445. data/lib/stripe/services.rb +10 -0
  446. data/lib/stripe/stripe_object.rb +11 -3
  447. data/lib/stripe/version.rb +1 -1
  448. data/rbi/stripe.rbi +6022 -3221
  449. metadata +55 -2
@@ -5,13 +5,13 @@ module Stripe
5
5
  # Invoices are statements of amounts owed by a customer, and are either
6
6
  # generated one-off, or generated periodically from a subscription.
7
7
  #
8
- # They contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments
8
+ # They contain [invoice items](https://api.stripe.com#invoiceitems), and proration adjustments
9
9
  # that may be caused by subscription upgrades/downgrades (if necessary).
10
10
  #
11
11
  # If your invoice is configured to be billed through automatic charges,
12
12
  # Stripe automatically finalizes your invoice and attempts payment. Note
13
13
  # that finalizing the invoice,
14
- # [when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does
14
+ # [when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does
15
15
  # not happen immediately as the invoice is created. Stripe waits
16
16
  # until one hour after the last webhook was successfully sent (or the last
17
17
  # webhook timed out after failing). If you (and the platforms you may have
@@ -31,9 +31,9 @@ module Stripe
31
31
  # customer's credit balance which is applied to the next invoice.
32
32
  #
33
33
  # More details on the customer's credit balance are
34
- # [here](https://stripe.com/docs/billing/customer/balance).
34
+ # [here](https://docs.stripe.com/billing/customer/balance).
35
35
  #
36
- # Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)
36
+ # Related guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending)
37
37
  class QuotePreviewInvoice < APIResource
38
38
  OBJECT_NAME = "quote_preview_invoice"
39
39
  def self.object_name
@@ -101,7 +101,7 @@ module Stripe
101
101
  end
102
102
  # If Stripe disabled automatic tax, this enum describes why.
103
103
  attr_reader :disabled_reason
104
- # Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
104
+ # Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
105
105
  attr_reader :enabled
106
106
  # 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.
107
107
  attr_reader :liability
@@ -160,7 +160,7 @@ module Stripe
160
160
  attr_reader :line2
161
161
  # ZIP or postal code.
162
162
  attr_reader :postal_code
163
- # State, county, province, or region.
163
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
164
164
  attr_reader :state
165
165
 
166
166
  def self.inner_class_types
@@ -184,7 +184,7 @@ module Stripe
184
184
  attr_reader :line2
185
185
  # ZIP or postal code.
186
186
  attr_reader :postal_code
187
- # State, county, province, or region.
187
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
188
188
  attr_reader :state
189
189
 
190
190
  def self.inner_class_types
@@ -261,15 +261,15 @@ module Stripe
261
261
  end
262
262
 
263
263
  class LastFinalizationError < ::Stripe::StripeObject
264
- # For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
264
+ # For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one.
265
265
  attr_reader :advice_code
266
266
  # For card errors, the ID of the failed charge.
267
267
  attr_reader :charge
268
- # For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
268
+ # For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported.
269
269
  attr_reader :code
270
- # For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
270
+ # For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one.
271
271
  attr_reader :decline_code
272
- # A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
272
+ # A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
273
273
  attr_reader :doc_url
274
274
  # A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
275
275
  attr_reader :message
@@ -285,17 +285,17 @@ module Stripe
285
285
  # see the history of payment attempts for a particular session.
286
286
  #
287
287
  # A PaymentIntent transitions through
288
- # [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
288
+ # [multiple statuses](/payments/paymentintents/lifecycle)
289
289
  # throughout its lifetime as it interfaces with Stripe.js to perform
290
290
  # authentication flows and ultimately creates at most one successful charge.
291
291
  #
292
- # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)
292
+ # Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents)
293
293
  attr_reader :payment_intent
294
294
  # PaymentMethod objects represent your customer's payment instruments.
295
- # You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
295
+ # You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to
296
296
  # Customer objects to store instrument details for future payments.
297
297
  #
298
- # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
298
+ # Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios).
299
299
  attr_reader :payment_method
300
300
  # If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
301
301
  attr_reader :payment_method_type
@@ -303,7 +303,7 @@ module Stripe
303
303
  attr_reader :request_log_url
304
304
  # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
305
305
  # For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
306
- # Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
306
+ # Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow.
307
307
  #
308
308
  # Create a SetupIntent when you're ready to collect your customer's payment credentials.
309
309
  # Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
@@ -314,9 +314,9 @@ module Stripe
314
314
  # For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
315
315
  # [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
316
316
  # to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
317
- # If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
317
+ # If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer),
318
318
  # it automatically attaches the resulting payment method to that Customer after successful setup.
319
- # We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
319
+ # We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on
320
320
  # PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
321
321
  #
322
322
  # By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
@@ -392,10 +392,10 @@ module Stripe
392
392
  @field_remappings = {}
393
393
  end
394
394
  end
395
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
395
+ # Set of [key-value pairs](https://docs.stripe.com/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
396
396
  # *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
397
397
  attr_reader :metadata
398
- # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
398
+ # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
399
399
  attr_reader :pause_collection
400
400
  # The subscription that generated this invoice
401
401
  attr_reader :subscription
@@ -414,19 +414,19 @@ module Stripe
414
414
  attr_reader :billing_cadence_details
415
415
  # Details about the quote that generated this invoice
416
416
  attr_reader :quote_details
417
+ # Details about the schedule that generated this invoice
418
+ attr_reader :schedule_details
417
419
  # Details about the subscription that generated this invoice
418
420
  attr_reader :subscription_details
419
421
  # The type of parent that generated this invoice
420
422
  attr_reader :type
421
- # Details about the schedule that generated this invoice
422
- attr_reader :schedule_details
423
423
 
424
424
  def self.inner_class_types
425
425
  @inner_class_types = {
426
426
  billing_cadence_details: BillingCadenceDetails,
427
427
  quote_details: QuoteDetails,
428
- subscription_details: SubscriptionDetails,
429
428
  schedule_details: ScheduleDetails,
429
+ subscription_details: SubscriptionDetails,
430
430
  }
431
431
  end
432
432
 
@@ -492,7 +492,7 @@ module Stripe
492
492
  end
493
493
  # Attribute for field installments
494
494
  attr_reader :installments
495
- # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
495
+ # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
496
496
  attr_reader :request_three_d_secure
497
497
 
498
498
  def self.inner_class_types
@@ -565,6 +565,35 @@ module Stripe
565
565
  end
566
566
  end
567
567
 
568
+ class Payto < ::Stripe::StripeObject
569
+ class MandateOptions < ::Stripe::StripeObject
570
+ # The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
571
+ attr_reader :amount
572
+ # Only `maximum` is supported.
573
+ attr_reader :amount_type
574
+ # The purpose for which payments are made. Has a default value based on your merchant category code.
575
+ attr_reader :purpose
576
+
577
+ def self.inner_class_types
578
+ @inner_class_types = {}
579
+ end
580
+
581
+ def self.field_remappings
582
+ @field_remappings = {}
583
+ end
584
+ end
585
+ # Attribute for field mandate_options
586
+ attr_reader :mandate_options
587
+
588
+ def self.inner_class_types
589
+ @inner_class_types = { mandate_options: MandateOptions }
590
+ end
591
+
592
+ def self.field_remappings
593
+ @field_remappings = {}
594
+ end
595
+ end
596
+
568
597
  class Pix < ::Stripe::StripeObject
569
598
  # Determines if the amount includes the IOF tax.
570
599
  attr_reader :amount_includes_iof
@@ -675,6 +704,8 @@ module Stripe
675
704
  attr_reader :id_bank_transfer
676
705
  # If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
677
706
  attr_reader :konbini
707
+ # If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
708
+ attr_reader :payto
678
709
  # If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
679
710
  attr_reader :pix
680
711
  # If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
@@ -692,6 +723,7 @@ module Stripe
692
723
  customer_balance: CustomerBalance,
693
724
  id_bank_transfer: IdBankTransfer,
694
725
  konbini: Konbini,
726
+ payto: Payto,
695
727
  pix: Pix,
696
728
  sepa_debit: SepaDebit,
697
729
  upi: Upi,
@@ -803,7 +835,7 @@ module Stripe
803
835
  attr_reader :line2
804
836
  # ZIP or postal code.
805
837
  attr_reader :postal_code
806
- # State, county, province, or region.
838
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
807
839
  attr_reader :state
808
840
 
809
841
  def self.inner_class_types
@@ -935,7 +967,7 @@ module Stripe
935
967
 
936
968
  class TotalTax < ::Stripe::StripeObject
937
969
  class TaxRateDetails < ::Stripe::StripeObject
938
- # Attribute for field tax_rate
970
+ # ID of the tax rate
939
971
  attr_reader :tax_rate
940
972
 
941
973
  def self.inner_class_types
@@ -1017,7 +1049,7 @@ module Stripe
1017
1049
  attr_reader :currency
1018
1050
  # Custom fields displayed on the invoice.
1019
1051
  attr_reader :custom_fields
1020
- # The ID of the account who will be billed.
1052
+ # The ID of the account representing the customer to bill.
1021
1053
  attr_reader :customer_account
1022
1054
  # The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
1023
1055
  attr_reader :customer_address
@@ -1053,7 +1085,7 @@ module Stripe
1053
1085
  attr_reader :ending_balance
1054
1086
  # Footer displayed on the invoice.
1055
1087
  attr_reader :footer
1056
- # Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
1088
+ # Details of the invoice that was cloned. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details.
1057
1089
  attr_reader :from_invoice
1058
1090
  # Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.
1059
1091
  attr_reader :id
@@ -1067,7 +1099,7 @@ module Stripe
1067
1099
  attr_reader :lines
1068
1100
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
1069
1101
  attr_reader :livemode
1070
- # 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.
1102
+ # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
1071
1103
  attr_reader :metadata
1072
1104
  # The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.
1073
1105
  attr_reader :next_payment_attempt
@@ -1075,7 +1107,7 @@ module Stripe
1075
1107
  attr_reader :number
1076
1108
  # String representing the object's type. Objects of the same type share the same value.
1077
1109
  attr_reader :object
1078
- # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
1110
+ # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.
1079
1111
  attr_reader :on_behalf_of
1080
1112
  # The parent that generated this invoice
1081
1113
  attr_reader :parent
@@ -1103,7 +1135,7 @@ module Stripe
1103
1135
  attr_reader :starting_balance
1104
1136
  # Extra information about an invoice for the customer's credit card statement.
1105
1137
  attr_reader :statement_descriptor
1106
- # The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
1138
+ # The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview)
1107
1139
  attr_reader :status
1108
1140
  # Attribute for field status_transitions
1109
1141
  attr_reader :status_transitions
@@ -1129,7 +1161,7 @@ module Stripe
1129
1161
  attr_reader :total_pretax_credit_amounts
1130
1162
  # The aggregate tax information of all line items.
1131
1163
  attr_reader :total_taxes
1132
- # Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
1164
+ # Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
1133
1165
  attr_reader :webhooks_delivered_at
1134
1166
 
1135
1167
  def self.inner_class_types
@@ -54,6 +54,89 @@ module Stripe
54
54
  end
55
55
  end
56
56
 
57
+ class BillingSchedule < ::Stripe::StripeObject
58
+ class AppliesTo < ::Stripe::StripeObject
59
+ # The billing schedule will apply to the subscription item with the given price ID.
60
+ attr_reader :price
61
+ # Controls which subscription items the billing schedule applies to.
62
+ attr_reader :type
63
+
64
+ def self.inner_class_types
65
+ @inner_class_types = {}
66
+ end
67
+
68
+ def self.field_remappings
69
+ @field_remappings = {}
70
+ end
71
+ end
72
+
73
+ class BillFrom < ::Stripe::StripeObject
74
+ # The time the billing schedule applies from.
75
+ attr_reader :computed_timestamp
76
+ # Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
77
+ attr_reader :timestamp
78
+ # Describes how the billing schedule determines the start date. Possible values are `timestamp`.
79
+ attr_reader :type
80
+
81
+ def self.inner_class_types
82
+ @inner_class_types = {}
83
+ end
84
+
85
+ def self.field_remappings
86
+ @field_remappings = {}
87
+ end
88
+ end
89
+
90
+ class BillUntil < ::Stripe::StripeObject
91
+ class Duration < ::Stripe::StripeObject
92
+ # Specifies billing duration. Either `day`, `week`, `month` or `year`.
93
+ attr_reader :interval
94
+ # The multiplier applied to the interval.
95
+ attr_reader :interval_count
96
+
97
+ def self.inner_class_types
98
+ @inner_class_types = {}
99
+ end
100
+
101
+ def self.field_remappings
102
+ @field_remappings = {}
103
+ end
104
+ end
105
+ # The timestamp the billing schedule will apply until.
106
+ attr_reader :computed_timestamp
107
+ # Specifies the billing period.
108
+ attr_reader :duration
109
+ # If specified, the billing schedule will apply until the specified timestamp.
110
+ attr_reader :timestamp
111
+ # Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
112
+ attr_reader :type
113
+
114
+ def self.inner_class_types
115
+ @inner_class_types = { duration: Duration }
116
+ end
117
+
118
+ def self.field_remappings
119
+ @field_remappings = {}
120
+ end
121
+ end
122
+ # Specifies which subscription items the billing schedule applies to.
123
+ attr_reader :applies_to
124
+ # Specifies the start of the billing period.
125
+ attr_reader :bill_from
126
+ # Specifies the end of billing period.
127
+ attr_reader :bill_until
128
+ # Unique identifier for the billing schedule.
129
+ attr_reader :key
130
+
131
+ def self.inner_class_types
132
+ @inner_class_types = { applies_to: AppliesTo, bill_from: BillFrom, bill_until: BillUntil }
133
+ end
134
+
135
+ def self.field_remappings
136
+ @field_remappings = {}
137
+ end
138
+ end
139
+
57
140
  class CurrentPhase < ::Stripe::StripeObject
58
141
  # The end of this phase of the subscription schedule.
59
142
  attr_reader :end_date
@@ -165,7 +248,7 @@ module Stripe
165
248
  attr_reader :application_fee_percent
166
249
  # Attribute for field automatic_tax
167
250
  attr_reader :automatic_tax
168
- # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
251
+ # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
169
252
  attr_reader :billing_cycle_anchor
170
253
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
171
254
  attr_reader :billing_thresholds
@@ -179,10 +262,10 @@ module Stripe
179
262
  attr_reader :invoice_settings
180
263
  # The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
181
264
  attr_reader :on_behalf_of
182
- # The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
183
- attr_reader :transfer_data
184
265
  # Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
185
266
  attr_reader :phase_effective_at
267
+ # The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
268
+ attr_reader :transfer_data
186
269
 
187
270
  def self.inner_class_types
188
271
  @inner_class_types = {
@@ -309,7 +392,7 @@ module Stripe
309
392
  end
310
393
  # The stackable discounts that will be applied to the item.
311
394
  attr_reader :discounts
312
- # 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.
395
+ # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
313
396
  attr_reader :metadata
314
397
  # Attribute for field period
315
398
  attr_reader :period
@@ -504,7 +587,7 @@ module Stripe
504
587
  attr_reader :billing_thresholds
505
588
  # The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
506
589
  attr_reader :discounts
507
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
590
+ # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
508
591
  attr_reader :metadata
509
592
  # ID of the plan to which the customer should be subscribed.
510
593
  attr_reader :plan
@@ -590,7 +673,7 @@ module Stripe
590
673
  attr_reader :application_fee_percent
591
674
  # Attribute for field automatic_tax
592
675
  attr_reader :automatic_tax
593
- # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
676
+ # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
594
677
  attr_reader :billing_cycle_anchor
595
678
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
596
679
  attr_reader :billing_thresholds
@@ -606,17 +689,19 @@ module Stripe
606
689
  attr_reader :description
607
690
  # The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
608
691
  attr_reader :discounts
692
+ # Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
693
+ attr_reader :effective_at
609
694
  # The end of this phase of the subscription schedule.
610
695
  attr_reader :end_date
611
696
  # The invoice settings applicable during this phase.
612
697
  attr_reader :invoice_settings
613
698
  # Subscription items to configure the subscription to during this phase of the subscription schedule.
614
699
  attr_reader :items
615
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
700
+ # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
616
701
  attr_reader :metadata
617
702
  # The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
618
703
  attr_reader :on_behalf_of
619
- # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
704
+ # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
620
705
  attr_reader :pause_collection
621
706
  # When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
622
707
  attr_reader :proration_behavior
@@ -630,8 +715,6 @@ module Stripe
630
715
  attr_reader :trial_end
631
716
  # Settings related to any trials on the subscription during this phase.
632
717
  attr_reader :trial_settings
633
- # Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
634
- attr_reader :effective_at
635
718
 
636
719
  def self.inner_class_types
637
720
  @inner_class_types = {
@@ -670,89 +753,6 @@ module Stripe
670
753
  @field_remappings = {}
671
754
  end
672
755
  end
673
-
674
- class BillingSchedule < ::Stripe::StripeObject
675
- class AppliesTo < ::Stripe::StripeObject
676
- # The billing schedule will apply to the subscription item with the given price ID.
677
- attr_reader :price
678
- # Controls which subscription items the billing schedule applies to.
679
- attr_reader :type
680
-
681
- def self.inner_class_types
682
- @inner_class_types = {}
683
- end
684
-
685
- def self.field_remappings
686
- @field_remappings = {}
687
- end
688
- end
689
-
690
- class BillFrom < ::Stripe::StripeObject
691
- # The time the billing schedule applies from.
692
- attr_reader :computed_timestamp
693
- # Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
694
- attr_reader :timestamp
695
- # Describes how the billing schedule determines the start date. Possible values are `timestamp`.
696
- attr_reader :type
697
-
698
- def self.inner_class_types
699
- @inner_class_types = {}
700
- end
701
-
702
- def self.field_remappings
703
- @field_remappings = {}
704
- end
705
- end
706
-
707
- class BillUntil < ::Stripe::StripeObject
708
- class Duration < ::Stripe::StripeObject
709
- # Specifies billing duration. Either `day`, `week`, `month` or `year`.
710
- attr_reader :interval
711
- # The multiplier applied to the interval.
712
- attr_reader :interval_count
713
-
714
- def self.inner_class_types
715
- @inner_class_types = {}
716
- end
717
-
718
- def self.field_remappings
719
- @field_remappings = {}
720
- end
721
- end
722
- # The timestamp the billing schedule will apply until.
723
- attr_reader :computed_timestamp
724
- # Specifies the billing period.
725
- attr_reader :duration
726
- # If specified, the billing schedule will apply until the specified timestamp.
727
- attr_reader :timestamp
728
- # Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
729
- attr_reader :type
730
-
731
- def self.inner_class_types
732
- @inner_class_types = { duration: Duration }
733
- end
734
-
735
- def self.field_remappings
736
- @field_remappings = {}
737
- end
738
- end
739
- # Specifies which subscription items the billing schedule applies to.
740
- attr_reader :applies_to
741
- # Specifies the start of the billing period.
742
- attr_reader :bill_from
743
- # Specifies the end of billing period.
744
- attr_reader :bill_until
745
- # Unique identifier for the billing schedule.
746
- attr_reader :key
747
-
748
- def self.inner_class_types
749
- @inner_class_types = { applies_to: AppliesTo, bill_from: BillFrom, bill_until: BillUntil }
750
- end
751
-
752
- def self.field_remappings
753
- @field_remappings = {}
754
- end
755
- end
756
756
  # ID of the Connect Application that created the schedule.
757
757
  attr_reader :application
758
758
  # Attribute for field applies_to
@@ -761,6 +761,8 @@ module Stripe
761
761
  attr_reader :billing_behavior
762
762
  # The billing mode of the subscription.
763
763
  attr_reader :billing_mode
764
+ # Billing schedules for this subscription schedule.
765
+ attr_reader :billing_schedules
764
766
  # Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
765
767
  attr_reader :canceled_at
766
768
  # Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
@@ -781,9 +783,11 @@ module Stripe
781
783
  attr_reader :id
782
784
  # Details of the most recent price migration that failed for the subscription schedule.
783
785
  attr_reader :last_price_migration_error
786
+ # The most recent invoice this subscription schedule has generated.
787
+ attr_reader :latest_invoice
784
788
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
785
789
  attr_reader :livemode
786
- # 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.
790
+ # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
787
791
  attr_reader :metadata
788
792
  # String representing the object's type. Objects of the same type share the same value.
789
793
  attr_reader :object
@@ -795,27 +799,23 @@ module Stripe
795
799
  attr_reader :released_at
796
800
  # ID of the subscription once managed by the subscription schedule (if it is released).
797
801
  attr_reader :released_subscription
798
- # The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
802
+ # The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://docs.stripe.com/billing/subscriptions/subscription-schedules).
799
803
  attr_reader :status
800
804
  # ID of the subscription managed by the subscription schedule.
801
805
  attr_reader :subscription
802
806
  # ID of the test clock this subscription schedule belongs to.
803
807
  attr_reader :test_clock
804
- # Billing schedules for this subscription schedule.
805
- attr_reader :billing_schedules
806
- # The most recent invoice this subscription schedule has generated.
807
- attr_reader :latest_invoice
808
808
 
809
809
  def self.inner_class_types
810
810
  @inner_class_types = {
811
811
  applies_to: AppliesTo,
812
812
  billing_mode: BillingMode,
813
+ billing_schedules: BillingSchedule,
813
814
  current_phase: CurrentPhase,
814
815
  default_settings: DefaultSettings,
815
816
  last_price_migration_error: LastPriceMigrationError,
816
817
  phases: Phase,
817
818
  prebilling: Prebilling,
818
- billing_schedules: BillingSchedule,
819
819
  }
820
820
  end
821
821
 
@@ -6,7 +6,7 @@ module Stripe
6
6
  # An early fraud warning indicates that the card issuer has notified us that a
7
7
  # charge may be fraudulent.
8
8
  #
9
- # Related guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)
9
+ # Related guide: [Early fraud warnings](https://docs.stripe.com/disputes/measuring#early-fraud-warnings)
10
10
  class EarlyFraudWarning < APIResource
11
11
  extend Stripe::APIOperations::List
12
12
 
@@ -5,7 +5,7 @@ module Stripe
5
5
  module Radar
6
6
  # Value lists allow you to group values together which can then be referenced in rules.
7
7
  #
8
- # Related guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items)
8
+ # Related guide: [Default Stripe lists](https://docs.stripe.com/radar/lists#managing-list-items)
9
9
  class ValueList < APIResource
10
10
  extend Stripe::APIOperations::Create
11
11
  include Stripe::APIOperations::Delete
@@ -31,7 +31,7 @@ module Stripe
31
31
  attr_reader :list_items
32
32
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
33
33
  attr_reader :livemode
34
- # 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.
34
+ # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
35
35
  attr_reader :metadata
36
36
  # The name of the value list.
37
37
  attr_reader :name
@@ -5,7 +5,7 @@ module Stripe
5
5
  module Radar
6
6
  # Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
7
7
  #
8
- # Related guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)
8
+ # Related guide: [Managing list items](https://docs.stripe.com/radar/lists#managing-list-items)
9
9
  class ValueListItem < APIResource
10
10
  extend Stripe::APIOperations::Create
11
11
  include Stripe::APIOperations::Delete