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,7 +5,7 @@ module Stripe
5
5
  module Tax
6
6
  # A Tax Calculation allows you to calculate the tax to collect from your customer.
7
7
  #
8
- # Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)
8
+ # Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom)
9
9
  class Calculation < APIResource
10
10
  extend Stripe::APIOperations::Create
11
11
 
@@ -144,7 +144,7 @@ module Stripe
144
144
  @field_remappings = {}
145
145
  end
146
146
  end
147
- # The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
147
+ # The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
148
148
  attr_reader :amount
149
149
  # Attribute for field jurisdiction
150
150
  attr_reader :jurisdiction
@@ -154,7 +154,7 @@ module Stripe
154
154
  attr_reader :tax_rate_details
155
155
  # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
156
156
  attr_reader :taxability_reason
157
- # The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
157
+ # The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
158
158
  attr_reader :taxable_amount
159
159
 
160
160
  def self.inner_class_types
@@ -165,17 +165,17 @@ module Stripe
165
165
  @field_remappings = {}
166
166
  end
167
167
  end
168
- # The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
168
+ # The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
169
169
  attr_reader :amount
170
- # The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
170
+ # The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
171
171
  attr_reader :amount_tax
172
- # The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).
172
+ # The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object).
173
173
  attr_reader :shipping_rate
174
174
  # Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
175
175
  attr_reader :tax_behavior
176
176
  # Detailed account of taxes relevant to shipping cost.
177
177
  attr_reader :tax_breakdown
178
- # The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.
178
+ # The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping.
179
179
  attr_reader :tax_code
180
180
 
181
181
  def self.inner_class_types
@@ -211,7 +211,7 @@ module Stripe
211
211
  attr_reader :percentage_decimal
212
212
  # Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.
213
213
  attr_reader :rate_type
214
- # State, county, province, or region.
214
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
215
215
  attr_reader :state
216
216
  # The tax type, such as `vat` or `sales_tax`.
217
217
  attr_reader :tax_type
@@ -224,7 +224,7 @@ module Stripe
224
224
  @field_remappings = {}
225
225
  end
226
226
  end
227
- # The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
227
+ # The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
228
228
  attr_reader :amount
229
229
  # Specifies whether the tax amount is included in the line item amount.
230
230
  attr_reader :inclusive
@@ -232,7 +232,7 @@ module Stripe
232
232
  attr_reader :tax_rate_details
233
233
  # The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.
234
234
  attr_reader :taxability_reason
235
- # The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
235
+ # The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
236
236
  attr_reader :taxable_amount
237
237
 
238
238
  def self.inner_class_types
@@ -243,11 +243,11 @@ module Stripe
243
243
  @field_remappings = {}
244
244
  end
245
245
  end
246
- # Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
246
+ # Total amount after taxes in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
247
247
  attr_reader :amount_total
248
248
  # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
249
249
  attr_reader :currency
250
- # The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.
250
+ # The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource.
251
251
  attr_reader :customer
252
252
  # Attribute for field customer_details
253
253
  attr_reader :customer_details
@@ -45,7 +45,7 @@ module Stripe
45
45
  @field_remappings = {}
46
46
  end
47
47
  end
48
- # The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
48
+ # The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
49
49
  attr_reader :amount
50
50
  # Attribute for field jurisdiction
51
51
  attr_reader :jurisdiction
@@ -55,7 +55,7 @@ module Stripe
55
55
  attr_reader :tax_rate_details
56
56
  # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
57
57
  attr_reader :taxability_reason
58
- # The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
58
+ # The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
59
59
  attr_reader :taxable_amount
60
60
 
61
61
  def self.inner_class_types
@@ -66,19 +66,19 @@ module Stripe
66
66
  @field_remappings = {}
67
67
  end
68
68
  end
69
- # The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
69
+ # The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
70
70
  attr_reader :amount
71
- # The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
71
+ # The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
72
72
  attr_reader :amount_tax
73
73
  # Unique identifier for the object.
74
74
  attr_reader :id
75
75
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
76
76
  attr_reader :livemode
77
- # 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.
77
+ # 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.
78
78
  attr_reader :metadata
79
79
  # String representing the object's type. Objects of the same type share the same value.
80
80
  attr_reader :object
81
- # The ID of an existing [Product](https://stripe.com/docs/api/products/object).
81
+ # The ID of an existing [Product](https://docs.stripe.com/api/products/object).
82
82
  attr_reader :product
83
83
  # The number of units of the item being purchased. For reversals, this is the quantity reversed.
84
84
  attr_reader :quantity
@@ -88,7 +88,7 @@ module Stripe
88
88
  attr_reader :tax_behavior
89
89
  # Detailed account of taxes relevant to this line item.
90
90
  attr_reader :tax_breakdown
91
- # The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.
91
+ # The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource.
92
92
  attr_reader :tax_code
93
93
 
94
94
  def self.inner_class_types
@@ -3,11 +3,11 @@
3
3
 
4
4
  module Stripe
5
5
  module Tax
6
- # A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).
6
+ # A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://docs.stripe.com/tax).
7
7
  #
8
- # Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).
8
+ # Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://docs.stripe.com/tax/registering).
9
9
  #
10
- # Related guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)
10
+ # Related guide: [Using the Registrations API](https://docs.stripe.com/tax/registrations-api)
11
11
  class Registration < APIResource
12
12
  extend Stripe::APIOperations::Create
13
13
  extend Stripe::APIOperations::List
@@ -5,7 +5,7 @@ module Stripe
5
5
  module Tax
6
6
  # You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.
7
7
  #
8
- # Related guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)
8
+ # Related guide: [Using the Settings API](https://docs.stripe.com/tax/settings-api)
9
9
  class Settings < SingletonAPIResource
10
10
  include Stripe::APIOperations::SingletonSave
11
11
 
@@ -43,7 +43,7 @@ module Stripe
43
43
  attr_reader :line2
44
44
  # ZIP or postal code.
45
45
  attr_reader :postal_code
46
- # State, county, province, or region.
46
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
47
47
  attr_reader :state
48
48
 
49
49
  def self.inner_class_types
@@ -5,7 +5,7 @@ module Stripe
5
5
  module Tax
6
6
  # A Tax Transaction records the tax collected from or refunded to your customer.
7
7
  #
8
- # Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction)
8
+ # Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom#tax-transaction)
9
9
  class Transaction < APIResource
10
10
  OBJECT_NAME = "tax.transaction"
11
11
  def self.object_name
@@ -155,7 +155,7 @@ module Stripe
155
155
  @field_remappings = {}
156
156
  end
157
157
  end
158
- # The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
158
+ # The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
159
159
  attr_reader :amount
160
160
  # Attribute for field jurisdiction
161
161
  attr_reader :jurisdiction
@@ -165,7 +165,7 @@ module Stripe
165
165
  attr_reader :tax_rate_details
166
166
  # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
167
167
  attr_reader :taxability_reason
168
- # The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
168
+ # The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
169
169
  attr_reader :taxable_amount
170
170
 
171
171
  def self.inner_class_types
@@ -176,17 +176,17 @@ module Stripe
176
176
  @field_remappings = {}
177
177
  end
178
178
  end
179
- # The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
179
+ # The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
180
180
  attr_reader :amount
181
- # The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
181
+ # The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
182
182
  attr_reader :amount_tax
183
- # The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).
183
+ # The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object).
184
184
  attr_reader :shipping_rate
185
185
  # Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
186
186
  attr_reader :tax_behavior
187
187
  # Detailed account of taxes relevant to shipping cost. (It is not populated for the transaction resource object and will be removed in the next API version.)
188
188
  attr_reader :tax_breakdown
189
- # The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.
189
+ # The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping.
190
190
  attr_reader :tax_code
191
191
 
192
192
  def self.inner_class_types
@@ -201,7 +201,7 @@ module Stripe
201
201
  attr_reader :created
202
202
  # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
203
203
  attr_reader :currency
204
- # The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.
204
+ # The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource.
205
205
  attr_reader :customer
206
206
  # Attribute for field customer_details
207
207
  attr_reader :customer_details
@@ -211,7 +211,7 @@ module Stripe
211
211
  attr_reader :line_items
212
212
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
213
213
  attr_reader :livemode
214
- # 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.
214
+ # 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.
215
215
  attr_reader :metadata
216
216
  # String representing the object's type. Objects of the same type share the same value.
217
217
  attr_reader :object
@@ -21,19 +21,19 @@ module Stripe
21
21
  @field_remappings = {}
22
22
  end
23
23
  end
24
- # The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
24
+ # The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
25
25
  attr_reader :amount
26
- # The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
26
+ # The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
27
27
  attr_reader :amount_tax
28
28
  # Unique identifier for the object.
29
29
  attr_reader :id
30
30
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
31
31
  attr_reader :livemode
32
- # 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.
32
+ # 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.
33
33
  attr_reader :metadata
34
34
  # String representing the object's type. Objects of the same type share the same value.
35
35
  attr_reader :object
36
- # The ID of an existing [Product](https://stripe.com/docs/api/products/object).
36
+ # The ID of an existing [Product](https://docs.stripe.com/api/products/object).
37
37
  attr_reader :product
38
38
  # The number of units of the item being purchased. For reversals, this is the quantity reversed.
39
39
  attr_reader :quantity
@@ -43,7 +43,7 @@ module Stripe
43
43
  attr_reader :reversal
44
44
  # Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
45
45
  attr_reader :tax_behavior
46
- # The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.
46
+ # The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource.
47
47
  attr_reader :tax_code
48
48
  # If `reversal`, this line item reverses an earlier transaction.
49
49
  attr_reader :type
@@ -2,10 +2,10 @@
2
2
  # frozen_string_literal: true
3
3
 
4
4
  module Stripe
5
- # You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.
5
+ # You can add one or multiple tax IDs to a [customer](https://docs.stripe.com/api/customers) or account.
6
6
  # Customer and account tax IDs get displayed on related invoices and credit notes.
7
7
  #
8
- # Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)
8
+ # Related guides: [Customer tax identification numbers](https://docs.stripe.com/billing/taxes/tax-ids), [Account tax IDs](https://docs.stripe.com/invoicing/connect#account-tax-ids)
9
9
  class TaxId < APIResource
10
10
  extend Stripe::APIOperations::Create
11
11
  include Stripe::APIOperations::Delete
@@ -23,7 +23,7 @@ module Stripe
23
23
  attr_reader :application
24
24
  # The customer being referenced when `type` is `customer`.
25
25
  attr_reader :customer
26
- # The account being referenced when `type` is `customer`.
26
+ # The Account representing the customer being referenced when `type` is `customer`.
27
27
  attr_reader :customer_account
28
28
  # Type of owner referenced.
29
29
  attr_reader :type
@@ -59,7 +59,7 @@ module Stripe
59
59
  attr_reader :created
60
60
  # ID of the customer.
61
61
  attr_reader :customer
62
- # ID of the account.
62
+ # ID of the Account representing the customer.
63
63
  attr_reader :customer_account
64
64
  # Unique identifier for the object.
65
65
  attr_reader :id
@@ -55,7 +55,7 @@ module Stripe
55
55
  attr_reader :jurisdiction_level
56
56
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
57
57
  attr_reader :livemode
58
- # 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.
58
+ # 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.
59
59
  attr_reader :metadata
60
60
  # String representing the object's type. Objects of the same type share the same value.
61
61
  attr_reader :object
@@ -5,7 +5,7 @@ module Stripe
5
5
  module Terminal
6
6
  # A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
7
7
  #
8
- # Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)
8
+ # Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)
9
9
  class ConnectionToken < APIResource
10
10
  extend Stripe::APIOperations::Create
11
11
 
@@ -5,7 +5,7 @@ module Stripe
5
5
  module Terminal
6
6
  # A Location represents a grouping of readers.
7
7
  #
8
- # Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)
8
+ # Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)
9
9
  class Location < APIResource
10
10
  extend Stripe::APIOperations::Create
11
11
  include Stripe::APIOperations::Delete
@@ -28,7 +28,7 @@ module Stripe
28
28
  attr_reader :line2
29
29
  # ZIP or postal code.
30
30
  attr_reader :postal_code
31
- # State, county, province, or region.
31
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
32
32
  attr_reader :state
33
33
 
34
34
  def self.inner_class_types
@@ -107,7 +107,7 @@ module Stripe
107
107
  attr_reader :id
108
108
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
109
109
  attr_reader :livemode
110
- # 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.
110
+ # 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.
111
111
  attr_reader :metadata
112
112
  # String representing the object's type. Objects of the same type share the same value.
113
113
  attr_reader :object
@@ -5,7 +5,7 @@ module Stripe
5
5
  module Terminal
6
6
  # A Reader represents a physical device for accepting payment details.
7
7
  #
8
- # Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)
8
+ # Related guide: [Connecting to a reader](https://docs.stripe.com/terminal/payments/connect-reader)
9
9
  class Reader < APIResource
10
10
  extend Stripe::APIOperations::Create
11
11
  include Stripe::APIOperations::Delete
@@ -197,7 +197,7 @@ module Stripe
197
197
  end
198
198
  # List of inputs to be collected.
199
199
  attr_reader :inputs
200
- # 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.
200
+ # 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.
201
201
  attr_reader :metadata
202
202
 
203
203
  def self.inner_class_types
@@ -245,10 +245,10 @@ module Stripe
245
245
  # Most recent PaymentIntent processed by the reader.
246
246
  attr_reader :payment_intent
247
247
  # PaymentMethod objects represent your customer's payment instruments.
248
- # You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
248
+ # You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to
249
249
  # Customer objects to store instrument details for future payments.
250
250
  #
251
- # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
251
+ # Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios).
252
252
  attr_reader :payment_method
253
253
 
254
254
  def self.inner_class_types
@@ -384,7 +384,7 @@ module Stripe
384
384
  attr_reader :amount
385
385
  # Charge that is being refunded.
386
386
  attr_reader :charge
387
- # 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.
387
+ # 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.
388
388
  attr_reader :metadata
389
389
  # Payment intent that is being refunded.
390
390
  attr_reader :payment_intent
@@ -411,7 +411,7 @@ module Stripe
411
411
  class SetReaderDisplay < ::Stripe::StripeObject
412
412
  class Cart < ::Stripe::StripeObject
413
413
  class LineItem < ::Stripe::StripeObject
414
- # The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
414
+ # The amount of the line item. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
415
415
  attr_reader :amount
416
416
  # Description of the line item.
417
417
  attr_reader :description
@@ -430,9 +430,9 @@ module Stripe
430
430
  attr_reader :currency
431
431
  # List of line items in the cart.
432
432
  attr_reader :line_items
433
- # Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
433
+ # Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
434
434
  attr_reader :tax
435
- # Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
435
+ # Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
436
436
  attr_reader :total
437
437
 
438
438
  def self.inner_class_types
@@ -507,13 +507,13 @@ module Stripe
507
507
  attr_reader :ip_address
508
508
  # Custom label given to the reader for easier identification.
509
509
  attr_reader :label
510
- # The last time this reader reported to Stripe backend.
510
+ # The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds.
511
511
  attr_reader :last_seen_at
512
512
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
513
513
  attr_reader :livemode
514
514
  # The location identifier of the reader.
515
515
  attr_reader :location
516
- # 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.
516
+ # 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.
517
517
  attr_reader :metadata
518
518
  # String representing the object's type. Objects of the same type share the same value.
519
519
  attr_reader :object
@@ -6,7 +6,7 @@ module Stripe
6
6
  # account details, or personally identifiable information (PII), directly from
7
7
  # your customers in a secure manner. A token representing this information is
8
8
  # returned to your server to use. Use our
9
- # [recommended payments integrations](https://stripe.com/docs/payments) to perform this process
9
+ # [recommended payments integrations](https://docs.stripe.com/payments) to perform this process
10
10
  # on the client-side. This guarantees that no sensitive card data touches your server,
11
11
  # and allows your integration to operate in a PCI-compliant way.
12
12
  #
@@ -18,9 +18,9 @@ module Stripe
18
18
  # Stripe, so we can't determine how it's handled or stored.
19
19
  #
20
20
  # You can't store or use tokens more than once. To store card or bank account
21
- # information for later use, create [Customer](https://stripe.com/docs/api#customers)
21
+ # information for later use, create [Customer](https://docs.stripe.com/api#customers)
22
22
  # objects or [External accounts](https://docs.stripe.com/api#external_accounts).
23
- # [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,
23
+ # [Radar](https://docs.stripe.com/radar), our integrated solution for automatic fraud protection,
24
24
  # performs best with integrations that use client-side tokenization.
25
25
  class Token < APIResource
26
26
  extend Stripe::APIOperations::Create
@@ -42,7 +42,7 @@ module Stripe
42
42
  # later. You can also store multiple debit cards on a recipient in order to
43
43
  # transfer to those cards later.
44
44
  #
45
- # Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
45
+ # Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards)
46
46
  attr_reader :card
47
47
  # IP address of the client that generates the token.
48
48
  attr_reader :client_ip
@@ -6,7 +6,7 @@ module Stripe
6
6
  # individual top-ups, as well as list all top-ups. Top-ups are identified by a
7
7
  # unique, random ID.
8
8
  #
9
- # Related guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)
9
+ # Related guide: [Topping up your platform account](https://docs.stripe.com/connect/top-ups)
10
10
  class Topup < APIResource
11
11
  extend Stripe::APIOperations::Create
12
12
  extend Stripe::APIOperations::List
@@ -29,7 +29,7 @@ module Stripe
29
29
  attr_reader :description
30
30
  # Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
31
31
  attr_reader :expected_availability_date
32
- # Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).
32
+ # Error code explaining reason for top-up failure if available (see [the errors section](https://docs.stripe.com/api#errors) for a list of codes).
33
33
  attr_reader :failure_code
34
34
  # Message to user further explaining reason for top-up failure if available.
35
35
  attr_reader :failure_message
@@ -37,7 +37,7 @@ module Stripe
37
37
  attr_reader :id
38
38
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
39
39
  attr_reader :livemode
40
- # 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.
40
+ # 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.
41
41
  attr_reader :metadata
42
42
  # String representing the object's type. Objects of the same type share the same value.
43
43
  attr_reader :object
@@ -7,11 +7,11 @@ module Stripe
7
7
  #
8
8
  # Before April 6, 2017, transfers also represented movement of funds from a
9
9
  # Stripe account to a card or bank account. This behavior has since been split
10
- # out into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more
10
+ # out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more
11
11
  # information, read about the
12
- # [transfer/payout split](https://stripe.com/docs/transfer-payout-split).
12
+ # [transfer/payout split](https://docs.stripe.com/transfer-payout-split).
13
13
  #
14
- # Related guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers)
14
+ # Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers)
15
15
  class Transfer < APIResource
16
16
  extend Stripe::APIOperations::Create
17
17
  extend Stripe::APIOperations::List
@@ -51,7 +51,7 @@ module Stripe
51
51
  attr_reader :id
52
52
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
53
53
  attr_reader :livemode
54
- # 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.
54
+ # 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.
55
55
  attr_reader :metadata
56
56
  # String representing the object's type. Objects of the same type share the same value.
57
57
  attr_reader :object
@@ -63,7 +63,7 @@ module Stripe
63
63
  attr_reader :source_transaction
64
64
  # The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.
65
65
  attr_reader :source_type
66
- # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
66
+ # A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.
67
67
  attr_reader :transfer_group
68
68
 
69
69
  # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
@@ -3,7 +3,7 @@
3
3
 
4
4
  module Stripe
5
5
  module Treasury
6
- # You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
6
+ # You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
7
7
  class CreditReversal < APIResource
8
8
  extend Stripe::APIOperations::Create
9
9
  extend Stripe::APIOperations::List
@@ -33,13 +33,13 @@ module Stripe
33
33
  attr_reader :currency
34
34
  # The FinancialAccount to reverse funds from.
35
35
  attr_reader :financial_account
36
- # A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
36
+ # A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
37
37
  attr_reader :hosted_regulatory_receipt_url
38
38
  # Unique identifier for the object.
39
39
  attr_reader :id
40
40
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
41
41
  attr_reader :livemode
42
- # 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.
42
+ # 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.
43
43
  attr_reader :metadata
44
44
  # The rails used to reverse the funds.
45
45
  attr_reader :network
@@ -3,7 +3,7 @@
3
3
 
4
4
  module Stripe
5
5
  module Treasury
6
- # You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
6
+ # You can reverse some [ReceivedDebits](https://api.stripe.com#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
7
7
  class DebitReversal < APIResource
8
8
  extend Stripe::APIOperations::Create
9
9
  extend Stripe::APIOperations::List
@@ -46,7 +46,7 @@ module Stripe
46
46
  attr_reader :currency
47
47
  # The FinancialAccount to reverse funds from.
48
48
  attr_reader :financial_account
49
- # A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
49
+ # A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
50
50
  attr_reader :hosted_regulatory_receipt_url
51
51
  # Unique identifier for the object.
52
52
  attr_reader :id
@@ -54,7 +54,7 @@ module Stripe
54
54
  attr_reader :linked_flows
55
55
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
56
56
  attr_reader :livemode
57
- # 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.
57
+ # 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.
58
58
  attr_reader :metadata
59
59
  # The rails used to reverse the funds.
60
60
  attr_reader :network
@@ -129,7 +129,7 @@ module Stripe
129
129
  attr_reader :is_default
130
130
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
131
131
  attr_reader :livemode
132
- # 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.
132
+ # 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.
133
133
  attr_reader :metadata
134
134
  # The nickname for the FinancialAccount.
135
135
  attr_reader :nickname