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
@@ -87,7 +87,7 @@ module Stripe
87
87
  attr_accessor :currency
88
88
  # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
89
89
  attr_accessor :product
90
- # 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.
90
+ # Only required if a [default tax behavior](https://docs.stripe.com/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.
91
91
  attr_accessor :tax_behavior
92
92
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
93
93
  attr_accessor :unit_amount
@@ -110,13 +110,13 @@ module Stripe
110
110
  end
111
111
  # The coupons to redeem into discounts for the item.
112
112
  attr_accessor :discounts
113
- # 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`.
113
+ # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
114
114
  attr_accessor :metadata
115
115
  # The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
116
116
  attr_accessor :period
117
117
  # The ID of the price object. One of `price` or `price_data` is required.
118
118
  attr_accessor :price
119
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
119
+ # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
120
120
  attr_accessor :price_data
121
121
  # Quantity for this item. Defaults to 1.
122
122
  attr_accessor :quantity
@@ -338,7 +338,7 @@ module Stripe
338
338
 
339
339
  class Item < ::Stripe::RequestParams
340
340
  class BillingThresholds < ::Stripe::RequestParams
341
- # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
341
+ # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
342
342
  attr_accessor :usage_gte
343
343
 
344
344
  def initialize(usage_gte: nil)
@@ -419,7 +419,7 @@ module Stripe
419
419
  attr_accessor :product
420
420
  # The recurring components of a price such as `interval` and `interval_count`.
421
421
  attr_accessor :recurring
422
- # 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.
422
+ # Only required if a [default tax behavior](https://docs.stripe.com/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.
423
423
  attr_accessor :tax_behavior
424
424
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
425
425
  attr_accessor :unit_amount
@@ -456,27 +456,28 @@ module Stripe
456
456
  end
457
457
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
458
458
  attr_accessor :billing_thresholds
459
+ # The trial offer to apply to this subscription item.
460
+ attr_accessor :current_trial
459
461
  # The coupons to redeem into discounts for the subscription item.
460
462
  attr_accessor :discounts
461
- # 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`.
463
+ # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
462
464
  attr_accessor :metadata
463
465
  # Plan ID for this item, as a string.
464
466
  attr_accessor :plan
465
467
  # The ID of the price object.
466
468
  attr_accessor :price
467
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
469
+ # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
468
470
  attr_accessor :price_data
469
471
  # Quantity for this item.
470
472
  attr_accessor :quantity
471
- # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
473
+ # A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
472
474
  attr_accessor :tax_rates
473
475
  # Define options to configure the trial on the subscription item.
474
476
  attr_accessor :trial
475
- # The trial offer to apply to this subscription item.
476
- attr_accessor :current_trial
477
477
 
478
478
  def initialize(
479
479
  billing_thresholds: nil,
480
+ current_trial: nil,
480
481
  discounts: nil,
481
482
  metadata: nil,
482
483
  plan: nil,
@@ -484,10 +485,10 @@ module Stripe
484
485
  price_data: nil,
485
486
  quantity: nil,
486
487
  tax_rates: nil,
487
- trial: nil,
488
- current_trial: nil
488
+ trial: nil
489
489
  )
490
490
  @billing_thresholds = billing_thresholds
491
+ @current_trial = current_trial
491
492
  @discounts = discounts
492
493
  @metadata = metadata
493
494
  @plan = plan
@@ -496,7 +497,6 @@ module Stripe
496
497
  @quantity = quantity
497
498
  @tax_rates = tax_rates
498
499
  @trial = trial
499
- @current_trial = current_trial
500
500
  end
501
501
  end
502
502
 
@@ -550,7 +550,7 @@ module Stripe
550
550
  attr_accessor :mandate_options
551
551
  # Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
552
552
  attr_accessor :network
553
- # 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.
553
+ # 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.
554
554
  attr_accessor :request_three_d_secure
555
555
 
556
556
  def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil)
@@ -594,6 +594,26 @@ module Stripe
594
594
  class IdBankTransfer < ::Stripe::RequestParams; end
595
595
  class Konbini < ::Stripe::RequestParams; end
596
596
 
597
+ class Payto < ::Stripe::RequestParams
598
+ class MandateOptions < ::Stripe::RequestParams
599
+ # The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
600
+ attr_accessor :amount
601
+ # The purpose for which payments are made. Has a default value based on your merchant category code.
602
+ attr_accessor :purpose
603
+
604
+ def initialize(amount: nil, purpose: nil)
605
+ @amount = amount
606
+ @purpose = purpose
607
+ end
608
+ end
609
+ # Additional fields for Mandate creation.
610
+ attr_accessor :mandate_options
611
+
612
+ def initialize(mandate_options: nil)
613
+ @mandate_options = mandate_options
614
+ end
615
+ end
616
+
597
617
  class Pix < ::Stripe::RequestParams
598
618
  class MandateOptions < ::Stripe::RequestParams
599
619
  # Amount to be charged for future payments. If not provided, defaults to 40000.
@@ -701,6 +721,8 @@ module Stripe
701
721
  attr_accessor :id_bank_transfer
702
722
  # This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
703
723
  attr_accessor :konbini
724
+ # This sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
725
+ attr_accessor :payto
704
726
  # This sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
705
727
  attr_accessor :pix
706
728
  # This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
@@ -717,6 +739,7 @@ module Stripe
717
739
  customer_balance: nil,
718
740
  id_bank_transfer: nil,
719
741
  konbini: nil,
742
+ payto: nil,
720
743
  pix: nil,
721
744
  sepa_debit: nil,
722
745
  upi: nil,
@@ -728,6 +751,7 @@ module Stripe
728
751
  @customer_balance = customer_balance
729
752
  @id_bank_transfer = id_bank_transfer
730
753
  @konbini = konbini
754
+ @payto = payto
731
755
  @pix = pix
732
756
  @sepa_debit = sepa_debit
733
757
  @upi = upi
@@ -814,7 +838,7 @@ module Stripe
814
838
  attr_accessor :backdate_start_date
815
839
  # The Billing Cadence which controls the timing of recurring invoice generation for this subscription. If unset, the subscription will bill according to its own configured schedule and create its own invoices. If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
816
840
  attr_accessor :billing_cadence
817
- # A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
841
+ # A future timestamp in UTC format to anchor the subscription's [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
818
842
  attr_accessor :billing_cycle_anchor
819
843
  # Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurrence of the day_of_month at the hour, minute, and second UTC.
820
844
  attr_accessor :billing_cycle_anchor_config
@@ -834,13 +858,13 @@ module Stripe
834
858
  attr_accessor :currency
835
859
  # The identifier of the customer to subscribe.
836
860
  attr_accessor :customer
837
- # The identifier of the account to subscribe.
861
+ # The identifier of the account representing the customer to subscribe.
838
862
  attr_accessor :customer_account
839
863
  # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
840
864
  attr_accessor :days_until_due
841
- # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
865
+ # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
842
866
  attr_accessor :default_payment_method
843
- # ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
867
+ # ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
844
868
  attr_accessor :default_source
845
869
  # The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
846
870
  attr_accessor :default_tax_rates
@@ -854,7 +878,7 @@ module Stripe
854
878
  attr_accessor :invoice_settings
855
879
  # A list of up to 20 subscription items, each with an attached price.
856
880
  attr_accessor :items
857
- # 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`.
881
+ # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
858
882
  attr_accessor :metadata
859
883
  # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
860
884
  attr_accessor :off_session
@@ -862,11 +886,11 @@ module Stripe
862
886
  attr_accessor :on_behalf_of
863
887
  # Only applies to subscriptions with `collection_method=charge_automatically`.
864
888
  #
865
- # Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
889
+ # Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
866
890
  #
867
- # Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.
891
+ # Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.
868
892
  #
869
- # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
893
+ # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/upgrades#2019-03-14) to learn more.
870
894
  #
871
895
  # `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.
872
896
  #
@@ -874,19 +898,19 @@ module Stripe
874
898
  attr_accessor :payment_behavior
875
899
  # Payment settings to pass to invoices created by the subscription.
876
900
  attr_accessor :payment_settings
877
- # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
901
+ # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval.
878
902
  attr_accessor :pending_invoice_item_interval
879
903
  # If specified, the invoicing for the given billing cycle iterations will be processed now.
880
904
  attr_accessor :prebilling
881
- # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
905
+ # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
882
906
  attr_accessor :proration_behavior
883
907
  # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
884
908
  attr_accessor :transfer_data
885
- # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
909
+ # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
886
910
  attr_accessor :trial_end
887
- # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
911
+ # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
888
912
  attr_accessor :trial_from_plan
889
- # Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
913
+ # Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
890
914
  attr_accessor :trial_period_days
891
915
  # Settings related to subscription trials.
892
916
  attr_accessor :trial_settings
@@ -4,7 +4,7 @@
4
4
  module Stripe
5
5
  class SubscriptionItemCreateParams < ::Stripe::RequestParams
6
6
  class BillingThresholds < ::Stripe::RequestParams
7
- # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
7
+ # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
8
8
  attr_accessor :usage_gte
9
9
 
10
10
  def initialize(usage_gte: nil)
@@ -85,7 +85,7 @@ module Stripe
85
85
  attr_accessor :product
86
86
  # The recurring components of a price such as `interval` and `interval_count`.
87
87
  attr_accessor :recurring
88
- # 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.
88
+ # Only required if a [default tax behavior](https://docs.stripe.com/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.
89
89
  attr_accessor :tax_behavior
90
90
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
91
91
  attr_accessor :unit_amount
@@ -122,17 +122,19 @@ module Stripe
122
122
  end
123
123
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
124
124
  attr_accessor :billing_thresholds
125
+ # The trial offer to apply to this subscription item.
126
+ attr_accessor :current_trial
125
127
  # The coupons to redeem into discounts for the subscription item.
126
128
  attr_accessor :discounts
127
129
  # Specifies which fields in the response should be expanded.
128
130
  attr_accessor :expand
129
- # 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`.
131
+ # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
130
132
  attr_accessor :metadata
131
- # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
133
+ # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
132
134
  #
133
- # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
135
+ # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
134
136
  #
135
- # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
137
+ # Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes).
136
138
  #
137
139
  # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
138
140
  attr_accessor :payment_behavior
@@ -140,25 +142,24 @@ module Stripe
140
142
  attr_accessor :plan
141
143
  # The ID of the price object.
142
144
  attr_accessor :price
143
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
145
+ # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
144
146
  attr_accessor :price_data
145
- # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
147
+ # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
146
148
  attr_accessor :proration_behavior
147
- # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
149
+ # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint.
148
150
  attr_accessor :proration_date
149
151
  # The quantity you'd like to apply to the subscription item you're creating.
150
152
  attr_accessor :quantity
151
153
  # The identifier of the subscription to modify.
152
154
  attr_accessor :subscription
153
- # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
155
+ # A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
154
156
  attr_accessor :tax_rates
155
157
  # Options that configure the trial on the subscription item.
156
158
  attr_accessor :trial
157
- # The trial offer to apply to this subscription item.
158
- attr_accessor :current_trial
159
159
 
160
160
  def initialize(
161
161
  billing_thresholds: nil,
162
+ current_trial: nil,
162
163
  discounts: nil,
163
164
  expand: nil,
164
165
  metadata: nil,
@@ -171,10 +172,10 @@ module Stripe
171
172
  quantity: nil,
172
173
  subscription: nil,
173
174
  tax_rates: nil,
174
- trial: nil,
175
- current_trial: nil
175
+ trial: nil
176
176
  )
177
177
  @billing_thresholds = billing_thresholds
178
+ @current_trial = current_trial
178
179
  @discounts = discounts
179
180
  @expand = expand
180
181
  @metadata = metadata
@@ -188,7 +189,6 @@ module Stripe
188
189
  @subscription = subscription
189
190
  @tax_rates = tax_rates
190
191
  @trial = trial
191
- @current_trial = current_trial
192
192
  end
193
193
  end
194
194
  end
@@ -5,9 +5,9 @@ module Stripe
5
5
  class SubscriptionItemDeleteParams < ::Stripe::RequestParams
6
6
  # Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.
7
7
  attr_accessor :clear_usage
8
- # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
8
+ # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
9
9
  attr_accessor :proration_behavior
10
- # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
10
+ # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint.
11
11
  attr_accessor :proration_date
12
12
 
13
13
  def initialize(clear_usage: nil, proration_behavior: nil, proration_date: nil)
@@ -4,7 +4,7 @@
4
4
  module Stripe
5
5
  class SubscriptionItemUpdateParams < ::Stripe::RequestParams
6
6
  class BillingThresholds < ::Stripe::RequestParams
7
- # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
7
+ # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
8
8
  attr_accessor :usage_gte
9
9
 
10
10
  def initialize(usage_gte: nil)
@@ -85,7 +85,7 @@ module Stripe
85
85
  attr_accessor :product
86
86
  # The recurring components of a price such as `interval` and `interval_count`.
87
87
  attr_accessor :recurring
88
- # 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.
88
+ # Only required if a [default tax behavior](https://docs.stripe.com/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.
89
89
  attr_accessor :tax_behavior
90
90
  # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
91
91
  attr_accessor :unit_amount
@@ -110,19 +110,21 @@ module Stripe
110
110
  end
111
111
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
112
112
  attr_accessor :billing_thresholds
113
+ # The trial offer to apply to this subscription item.
114
+ attr_accessor :current_trial
113
115
  # The coupons to redeem into discounts for the subscription item.
114
116
  attr_accessor :discounts
115
117
  # Specifies which fields in the response should be expanded.
116
118
  attr_accessor :expand
117
- # 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`.
119
+ # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
118
120
  attr_accessor :metadata
119
121
  # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
120
122
  attr_accessor :off_session
121
- # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
123
+ # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
122
124
  #
123
- # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
125
+ # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
124
126
  #
125
- # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
127
+ # Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes).
126
128
  #
127
129
  # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
128
130
  attr_accessor :payment_behavior
@@ -130,21 +132,20 @@ module Stripe
130
132
  attr_accessor :plan
131
133
  # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
132
134
  attr_accessor :price
133
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
135
+ # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
134
136
  attr_accessor :price_data
135
- # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
137
+ # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
136
138
  attr_accessor :proration_behavior
137
- # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
139
+ # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint.
138
140
  attr_accessor :proration_date
139
141
  # The quantity you'd like to apply to the subscription item you're creating.
140
142
  attr_accessor :quantity
141
- # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
143
+ # A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
142
144
  attr_accessor :tax_rates
143
- # The trial offer to apply to this subscription item.
144
- attr_accessor :current_trial
145
145
 
146
146
  def initialize(
147
147
  billing_thresholds: nil,
148
+ current_trial: nil,
148
149
  discounts: nil,
149
150
  expand: nil,
150
151
  metadata: nil,
@@ -156,10 +157,10 @@ module Stripe
156
157
  proration_behavior: nil,
157
158
  proration_date: nil,
158
159
  quantity: nil,
159
- tax_rates: nil,
160
- current_trial: nil
160
+ tax_rates: nil
161
161
  )
162
162
  @billing_thresholds = billing_thresholds
163
+ @current_trial = current_trial
163
164
  @discounts = discounts
164
165
  @expand = expand
165
166
  @metadata = metadata
@@ -172,7 +173,6 @@ module Stripe
172
173
  @proration_date = proration_date
173
174
  @quantity = quantity
174
175
  @tax_rates = tax_rates
175
- @current_trial = current_trial
176
176
  end
177
177
  end
178
178
  end
@@ -75,9 +75,9 @@ module Stripe
75
75
  attr_accessor :current_period_end
76
76
  # Only return subscriptions whose maximum item current_period_start falls within the given date interval.
77
77
  attr_accessor :current_period_start
78
- # The ID of the customer whose subscriptions will be retrieved.
78
+ # The ID of the customer whose subscriptions you're retrieving.
79
79
  attr_accessor :customer
80
- # The ID of the account whose subscriptions will be retrieved.
80
+ # The ID of the account representing the customer whose subscriptions you're retrieving.
81
81
  attr_accessor :customer_account
82
82
  # 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.
83
83
  attr_accessor :ending_before
@@ -91,7 +91,7 @@ module Stripe
91
91
  attr_accessor :price
92
92
  # 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.
93
93
  attr_accessor :starting_after
94
- # The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
94
+ # The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
95
95
  attr_accessor :status
96
96
  # Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.
97
97
  attr_accessor :test_clock
@@ -3,11 +3,11 @@
3
3
 
4
4
  module Stripe
5
5
  class SubscriptionResumeParams < ::Stripe::RequestParams
6
- # The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
6
+ # The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
7
7
  attr_accessor :billing_cycle_anchor
8
8
  # Specifies which fields in the response should be expanded.
9
9
  attr_accessor :expand
10
- # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
10
+ # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
11
11
  attr_accessor :proration_behavior
12
12
  # If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
13
13
  attr_accessor :proration_date
@@ -240,7 +240,7 @@ module Stripe
240
240
  end
241
241
  # The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
242
242
  attr_accessor :discounts
243
- # 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`.
243
+ # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
244
244
  attr_accessor :metadata
245
245
  # The ID of the price object.
246
246
  attr_accessor :price
@@ -446,8 +446,12 @@ module Stripe
446
446
  attr_accessor :amendment_start
447
447
  # For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
448
448
  attr_accessor :billing_cycle_anchor
449
+ # Actions to apply to the billing schedules.
450
+ attr_accessor :billing_schedules_actions
449
451
  # Changes to the coupons being redeemed or discounts being applied during the amendment time span.
450
452
  attr_accessor :discount_actions
453
+ # 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.
454
+ attr_accessor :effective_at
451
455
  # Changes to the subscription items during the amendment time span.
452
456
  attr_accessor :item_actions
453
457
  # Instructions for how to modify phase metadata
@@ -460,37 +464,33 @@ module Stripe
460
464
  attr_accessor :set_schedule_end
461
465
  # Settings related to subscription trials.
462
466
  attr_accessor :trial_settings
463
- # Actions to apply to the billing schedules.
464
- attr_accessor :billing_schedules_actions
465
- # 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.
466
- attr_accessor :effective_at
467
467
 
468
468
  def initialize(
469
469
  amendment_end: nil,
470
470
  amendment_start: nil,
471
471
  billing_cycle_anchor: nil,
472
+ billing_schedules_actions: nil,
472
473
  discount_actions: nil,
474
+ effective_at: nil,
473
475
  item_actions: nil,
474
476
  metadata_actions: nil,
475
477
  proration_behavior: nil,
476
478
  set_pause_collection: nil,
477
479
  set_schedule_end: nil,
478
- trial_settings: nil,
479
- billing_schedules_actions: nil,
480
- effective_at: nil
480
+ trial_settings: nil
481
481
  )
482
482
  @amendment_end = amendment_end
483
483
  @amendment_start = amendment_start
484
484
  @billing_cycle_anchor = billing_cycle_anchor
485
+ @billing_schedules_actions = billing_schedules_actions
485
486
  @discount_actions = discount_actions
487
+ @effective_at = effective_at
486
488
  @item_actions = item_actions
487
489
  @metadata_actions = metadata_actions
488
490
  @proration_behavior = proration_behavior
489
491
  @set_pause_collection = set_pause_collection
490
492
  @set_schedule_end = set_schedule_end
491
493
  @trial_settings = trial_settings
492
- @billing_schedules_actions = billing_schedules_actions
493
- @effective_at = effective_at
494
494
  end
495
495
  end
496
496