stripe 15.3.0 → 15.4.0.pre.beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (591) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +1603 -667
  4. data/README.md +1 -1
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_requestor.rb +32 -0
  7. data/lib/stripe/api_version.rb +1 -2
  8. data/lib/stripe/errors.rb +60 -0
  9. data/lib/stripe/event_types.rb +102 -0
  10. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  17. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +23 -0
  19. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  21. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  22. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  23. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  24. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  25. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  26. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  27. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  52. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  53. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  58. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  59. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  60. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  61. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  62. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
  65. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  66. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  67. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  68. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  69. data/lib/stripe/object_types.rb +50 -0
  70. data/lib/stripe/resources/account.rb +653 -1
  71. data/lib/stripe/resources/account_notice.rb +123 -0
  72. data/lib/stripe/resources/account_session.rb +256 -1
  73. data/lib/stripe/resources/balance_settings.rb +105 -0
  74. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  75. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  76. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  77. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  78. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  79. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  80. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  81. data/lib/stripe/resources/card.rb +2 -0
  82. data/lib/stripe/resources/cash_balance.rb +2 -0
  83. data/lib/stripe/resources/charge.rb +1538 -0
  84. data/lib/stripe/resources/checkout/session.rb +326 -2
  85. data/lib/stripe/resources/confirmation_token.rb +170 -0
  86. data/lib/stripe/resources/coupon.rb +30 -1
  87. data/lib/stripe/resources/credit_note.rb +6 -0
  88. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  89. data/lib/stripe/resources/customer.rb +2 -0
  90. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  91. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  92. data/lib/stripe/resources/customer_session.rb +6 -1
  93. data/lib/stripe/resources/discount.rb +2 -0
  94. data/lib/stripe/resources/dispute.rb +2 -0
  95. data/lib/stripe/resources/event.rb +31 -0
  96. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  97. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  98. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  99. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  100. data/lib/stripe/resources/fx_quote.rb +184 -0
  101. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  102. data/lib/stripe/resources/invoice.rb +1063 -16
  103. data/lib/stripe/resources/invoice_item.rb +78 -2
  104. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  105. data/lib/stripe/resources/invoice_payment.rb +2 -53
  106. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  107. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  108. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  109. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  110. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  111. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  112. data/lib/stripe/resources/line_item.rb +37 -0
  113. data/lib/stripe/resources/mandate.rb +24 -0
  114. data/lib/stripe/resources/margin.rb +115 -0
  115. data/lib/stripe/resources/order.rb +2958 -0
  116. data/lib/stripe/resources/payment_attempt_record.rb +1099 -0
  117. data/lib/stripe/resources/payment_intent.rb +8540 -3584
  118. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  119. data/lib/stripe/resources/payment_method.rb +192 -1
  120. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  121. data/lib/stripe/resources/payment_record.rb +1628 -0
  122. data/lib/stripe/resources/payout.rb +6 -0
  123. data/lib/stripe/resources/price.rb +30 -0
  124. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  125. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  126. data/lib/stripe/resources/promotion_code.rb +10 -0
  127. data/lib/stripe/resources/quote.rb +2038 -7
  128. data/lib/stripe/resources/quote_line.rb +274 -0
  129. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  130. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +371 -0
  131. data/lib/stripe/resources/refund.rb +9 -0
  132. data/lib/stripe/resources/setup_attempt.rb +21 -0
  133. data/lib/stripe/resources/setup_intent.rb +578 -9
  134. data/lib/stripe/resources/source.rb +29 -0
  135. data/lib/stripe/resources/subscription.rb +288 -9
  136. data/lib/stripe/resources/subscription_item.rb +84 -3
  137. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  138. data/lib/stripe/resources/tax/association.rb +66 -0
  139. data/lib/stripe/resources/tax/form.rb +211 -0
  140. data/lib/stripe/resources/tax_id.rb +12 -2
  141. data/lib/stripe/resources/terminal/reader.rb +8 -0
  142. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  143. data/lib/stripe/resources/transfer.rb +6 -0
  144. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  145. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  146. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  147. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  148. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  149. data/lib/stripe/resources/v2/core/account.rb +1919 -0
  150. data/lib/stripe/resources/v2/core/account_link.rb +56 -0
  151. data/lib/stripe/resources/v2/core/person.rb +276 -0
  152. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  153. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  154. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  155. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  156. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  157. data/lib/stripe/resources/v2/money_management/financial_account.rb +77 -0
  158. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  159. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  160. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  161. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  162. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  163. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  164. data/lib/stripe/resources/v2/money_management/payout_method.rb +75 -0
  165. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  166. data/lib/stripe/resources/v2/money_management/received_credit.rb +122 -0
  167. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  168. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  169. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  170. data/lib/stripe/resources/v2/payments/off_session_payment.rb +72 -0
  171. data/lib/stripe/resources.rb +106 -0
  172. data/lib/stripe/services/account_notice_service.rb +101 -0
  173. data/lib/stripe/services/account_service.rb +562 -1
  174. data/lib/stripe/services/account_session_service.rb +226 -1
  175. data/lib/stripe/services/balance_settings_service.rb +96 -0
  176. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  177. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  178. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  179. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  180. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  181. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  182. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  183. data/lib/stripe/services/capital_service.rb +15 -0
  184. data/lib/stripe/services/charge_service.rb +1418 -0
  185. data/lib/stripe/services/checkout/session_service.rb +243 -2
  186. data/lib/stripe/services/coupon_service.rb +17 -1
  187. data/lib/stripe/services/credit_note_service.rb +4 -0
  188. data/lib/stripe/services/customer_session_service.rb +4 -1
  189. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  190. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  191. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  192. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  193. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  194. data/lib/stripe/services/financial_connections_service.rb +2 -1
  195. data/lib/stripe/services/fx_quote_service.rb +123 -0
  196. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  197. data/lib/stripe/services/invoice_item_service.rb +74 -2
  198. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  199. data/lib/stripe/services/invoice_service.rb +1014 -16
  200. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  201. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  202. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  203. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  204. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  205. data/lib/stripe/services/issuing_service.rb +5 -1
  206. data/lib/stripe/services/margin_service.rb +119 -0
  207. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  208. data/lib/stripe/services/order_service.rb +2388 -0
  209. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  210. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  211. data/lib/stripe/services/payment_intent_service.rb +4879 -391
  212. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  213. data/lib/stripe/services/payment_method_service.rb +120 -1
  214. data/lib/stripe/services/payment_record_service.rb +542 -0
  215. data/lib/stripe/services/payout_service.rb +4 -0
  216. data/lib/stripe/services/price_service.rb +19 -0
  217. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  218. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  219. data/lib/stripe/services/privacy_service.rb +13 -0
  220. data/lib/stripe/services/promotion_code_service.rb +8 -0
  221. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  222. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  223. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  224. data/lib/stripe/services/quote_service.rb +1723 -8
  225. data/lib/stripe/services/setup_intent_service.rb +538 -9
  226. data/lib/stripe/services/subscription_item_service.rb +75 -3
  227. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  228. data/lib/stripe/services/subscription_service.rb +249 -9
  229. data/lib/stripe/services/tax/association_service.rb +31 -0
  230. data/lib/stripe/services/tax/form_service.rb +100 -0
  231. data/lib/stripe/services/tax_id_service.rb +8 -2
  232. data/lib/stripe/services/tax_service.rb +3 -1
  233. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  234. data/lib/stripe/services/terminal_service.rb +2 -1
  235. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  236. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  237. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  238. data/lib/stripe/services/transfer_service.rb +4 -0
  239. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  240. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  241. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  242. data/lib/stripe/services/v1_services.rb +11 -2
  243. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  244. data/lib/stripe/services/v2/core/account_service.rb +4486 -0
  245. data/lib/stripe/services/v2/core/accounts/person_service.rb +1045 -0
  246. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +130 -0
  247. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  248. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  249. data/lib/stripe/services/v2/core_service.rb +4 -1
  250. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  251. data/lib/stripe/services/v2/money_management/financial_account_service.rb +116 -0
  252. data/lib/stripe/services/v2/money_management/financial_address_service.rb +82 -0
  253. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  254. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  255. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +199 -0
  256. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  257. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  258. data/lib/stripe/services/v2/money_management/payout_method_service.rb +90 -0
  259. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  260. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  261. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  262. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  263. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  264. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  265. data/lib/stripe/services/v2/payment_service.rb +15 -0
  266. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +137 -0
  267. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  268. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +49 -0
  269. data/lib/stripe/services/v2_services.rb +4 -1
  270. data/lib/stripe/services.rb +53 -1
  271. data/lib/stripe/stripe_configuration.rb +3 -1
  272. data/lib/stripe/stripe_object.rb +1 -1
  273. data/lib/stripe/util.rb +7 -1
  274. data/lib/stripe/version.rb +1 -1
  275. data/lib/stripe.rb +53 -0
  276. data/rbi/stripe.rbi +194513 -0
  277. data/stripe.gemspec +4 -1
  278. metadata +164 -325
  279. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  280. data/rbi/stripe/resources/account.rbi +0 -4995
  281. data/rbi/stripe/resources/account_link.rbi +0 -74
  282. data/rbi/stripe/resources/account_session.rbi +0 -1013
  283. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  284. data/rbi/stripe/resources/application.rbi +0 -20
  285. data/rbi/stripe/resources/application_fee.rbi +0 -118
  286. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  287. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  288. data/rbi/stripe/resources/balance.rbi +0 -235
  289. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  290. data/rbi/stripe/resources/bank_account.rbi +0 -127
  291. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  292. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  293. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  294. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  295. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  296. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  297. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  298. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  299. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  300. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  301. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  302. data/rbi/stripe/resources/capability.rbi +0 -125
  303. data/rbi/stripe/resources/card.rbi +0 -125
  304. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  305. data/rbi/stripe/resources/charge.rbi +0 -2086
  306. data/rbi/stripe/resources/checkout/session.rbi +0 -4060
  307. data/rbi/stripe/resources/climate/order.rbi +0 -245
  308. data/rbi/stripe/resources/climate/product.rbi +0 -75
  309. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  310. data/rbi/stripe/resources/confirmation_token.rbi +0 -1818
  311. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  312. data/rbi/stripe/resources/country_spec.rbi +0 -85
  313. data/rbi/stripe/resources/coupon.rbi +0 -250
  314. data/rbi/stripe/resources/credit_note.rbi +0 -752
  315. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  316. data/rbi/stripe/resources/customer.rbi +0 -1005
  317. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  318. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  319. data/rbi/stripe/resources/customer_session.rbi +0 -200
  320. data/rbi/stripe/resources/discount.rbi +0 -53
  321. data/rbi/stripe/resources/dispute.rbi +0 -761
  322. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  323. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  324. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  325. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  326. data/rbi/stripe/resources/event.rbi +0 -149
  327. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  328. data/rbi/stripe/resources/file.rbi +0 -143
  329. data/rbi/stripe/resources/file_link.rbi +0 -141
  330. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  331. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  332. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  333. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  334. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  335. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  336. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  337. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  338. data/rbi/stripe/resources/identity/verification_session.rbi +0 -564
  339. data/rbi/stripe/resources/invoice.rbi +0 -3842
  340. data/rbi/stripe/resources/invoice_item.rbi +0 -470
  341. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  342. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  343. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  344. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  345. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  346. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  347. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  348. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  349. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  350. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  351. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  352. data/rbi/stripe/resources/line_item.rbi +0 -72
  353. data/rbi/stripe/resources/login_link.rbi +0 -19
  354. data/rbi/stripe/resources/mandate.rbi +0 -191
  355. data/rbi/stripe/resources/payment_intent.rbi +0 -9987
  356. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  357. data/rbi/stripe/resources/payment_method.rbi +0 -1770
  358. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  359. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  360. data/rbi/stripe/resources/payout.rbi +0 -300
  361. data/rbi/stripe/resources/person.rbi +0 -401
  362. data/rbi/stripe/resources/plan.rbi +0 -371
  363. data/rbi/stripe/resources/price.rbi +0 -694
  364. data/rbi/stripe/resources/product.rbi +0 -555
  365. data/rbi/stripe/resources/product_feature.rbi +0 -26
  366. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  367. data/rbi/stripe/resources/quote.rbi +0 -1145
  368. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  369. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  370. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  371. data/rbi/stripe/resources/refund.rbi +0 -523
  372. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  373. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  374. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  375. data/rbi/stripe/resources/reversal.rbi +0 -51
  376. data/rbi/stripe/resources/review.rbi +0 -154
  377. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  378. data/rbi/stripe/resources/setup_intent.rbi +0 -3978
  379. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  380. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  381. data/rbi/stripe/resources/source.rbi +0 -1496
  382. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  383. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  384. data/rbi/stripe/resources/subscription.rbi +0 -2080
  385. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  386. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1645
  387. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  388. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  389. data/rbi/stripe/resources/tax/registration.rbi +0 -2732
  390. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  391. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  392. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  393. data/rbi/stripe/resources/tax_code.rbi +0 -44
  394. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  395. data/rbi/stripe/resources/tax_id.rbi +0 -165
  396. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  397. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1387
  398. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  399. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  400. data/rbi/stripe/resources/terminal/reader.rbi +0 -994
  401. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  402. data/rbi/stripe/resources/token.rbi +0 -1283
  403. data/rbi/stripe/resources/topup.rbi +0 -222
  404. data/rbi/stripe/resources/transfer.rbi +0 -199
  405. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  406. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  407. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -869
  408. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  409. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  410. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  411. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  412. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  413. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  414. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  415. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  416. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  417. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  418. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  419. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  420. data/rbi/stripe/resources/v2/event.rbi +0 -48
  421. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  422. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  423. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  424. data/rbi/stripe/services/account_link_service.rbi +0 -58
  425. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  426. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  427. data/rbi/stripe/services/account_service.rbi +0 -4281
  428. data/rbi/stripe/services/account_session_service.rbi +0 -646
  429. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  430. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  431. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  432. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  433. data/rbi/stripe/services/apps_service.rbi +0 -9
  434. data/rbi/stripe/services/balance_service.rbi +0 -21
  435. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  436. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  437. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  438. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  439. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  440. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  441. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  442. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  443. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  444. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  445. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  446. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  447. data/rbi/stripe/services/billing_service.rbi +0 -15
  448. data/rbi/stripe/services/charge_service.rbi +0 -448
  449. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  450. data/rbi/stripe/services/checkout/session_service.rbi +0 -2670
  451. data/rbi/stripe/services/checkout_service.rbi +0 -9
  452. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  453. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  454. data/rbi/stripe/services/climate_service.rbi +0 -11
  455. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  456. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  457. data/rbi/stripe/services/coupon_service.rbi +0 -194
  458. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  459. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  460. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  461. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  462. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  463. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  464. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  465. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  466. data/rbi/stripe/services/customer_service.rbi +0 -647
  467. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  468. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  469. data/rbi/stripe/services/dispute_service.rbi +0 -424
  470. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  471. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  472. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  473. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  474. data/rbi/stripe/services/event_service.rbi +0 -83
  475. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  476. data/rbi/stripe/services/file_link_service.rbi +0 -124
  477. data/rbi/stripe/services/file_service.rbi +0 -116
  478. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  479. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  480. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  481. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  482. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  483. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  484. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  485. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  486. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -339
  487. data/rbi/stripe/services/identity_service.rbi +0 -10
  488. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  489. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  490. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  491. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  492. data/rbi/stripe/services/invoice_service.rbi +0 -3011
  493. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  494. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  495. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  496. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  497. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  498. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  499. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  500. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  501. data/rbi/stripe/services/issuing_service.rbi +0 -16
  502. data/rbi/stripe/services/mandate_service.rbi +0 -20
  503. data/rbi/stripe/services/payment_intent_service.rbi +0 -7989
  504. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  505. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  506. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  507. data/rbi/stripe/services/payment_method_service.rbi +0 -781
  508. data/rbi/stripe/services/payout_service.rbi +0 -205
  509. data/rbi/stripe/services/plan_service.rbi +0 -282
  510. data/rbi/stripe/services/price_service.rbi +0 -546
  511. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  512. data/rbi/stripe/services/product_service.rbi +0 -477
  513. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  514. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  515. data/rbi/stripe/services/quote_service.rbi +0 -699
  516. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  517. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  518. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  519. data/rbi/stripe/services/radar_service.rbi +0 -11
  520. data/rbi/stripe/services/refund_service.rbi +0 -185
  521. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  522. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  523. data/rbi/stripe/services/reporting_service.rbi +0 -10
  524. data/rbi/stripe/services/review_service.rbi +0 -84
  525. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  526. data/rbi/stripe/services/setup_intent_service.rbi +0 -3709
  527. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  528. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  529. data/rbi/stripe/services/sigma_service.rbi +0 -9
  530. data/rbi/stripe/services/source_service.rbi +0 -663
  531. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  532. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1301
  533. data/rbi/stripe/services/subscription_service.rbi +0 -1684
  534. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  535. data/rbi/stripe/services/tax/registration_service.rbi +0 -1858
  536. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  537. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  538. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  539. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  540. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  541. data/rbi/stripe/services/tax_service.rbi +0 -12
  542. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1118
  543. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  544. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  545. data/rbi/stripe/services/terminal/reader_service.rbi +0 -540
  546. data/rbi/stripe/services/terminal_service.rbi +0 -12
  547. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  548. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  549. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  550. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  551. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  552. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  553. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  554. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  555. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  556. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  557. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  558. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  559. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  560. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  561. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  562. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  563. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  564. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  565. data/rbi/stripe/services/token_service.rbi +0 -1257
  566. data/rbi/stripe/services/topup_service.rbi +0 -176
  567. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  568. data/rbi/stripe/services/transfer_service.rbi +0 -152
  569. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  570. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  571. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  572. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  573. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  574. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  575. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  576. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  577. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  578. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  579. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  580. data/rbi/stripe/services/treasury_service.rbi +0 -18
  581. data/rbi/stripe/services/v1_services.rbi +0 -77
  582. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  583. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  584. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  585. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  586. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  587. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  588. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  589. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  590. data/rbi/stripe/services/v2_services.rbi +0 -10
  591. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,345 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- module BillingPortal
7
- # The Billing customer portal is a Stripe-hosted UI for subscription and
8
- # billing management.
9
- #
10
- # A portal configuration describes the functionality and features that you
11
- # want to provide to your customers through the portal.
12
- #
13
- # A portal session describes the instantiation of the customer portal for
14
- # a particular customer. By visiting the session's URL, the customer
15
- # can manage their subscriptions and billing details. For security reasons,
16
- # sessions are short-lived and will expire if the customer does not visit the URL.
17
- # Create sessions on-demand when customers intend to manage their subscriptions
18
- # and billing details.
19
- #
20
- # Related guide: [Customer management](https://docs.stripe.com/customer-management)
21
- class Session < APIResource
22
- class Flow < Stripe::StripeObject
23
- class AfterCompletion < Stripe::StripeObject
24
- class HostedConfirmation < Stripe::StripeObject
25
- # A custom message to display to the customer after the flow is completed.
26
- sig { returns(T.nilable(String)) }
27
- attr_reader :custom_message
28
- end
29
- class Redirect < Stripe::StripeObject
30
- # The URL the customer will be redirected to after the flow is completed.
31
- sig { returns(String) }
32
- attr_reader :return_url
33
- end
34
- # Configuration when `after_completion.type=hosted_confirmation`.
35
- sig { returns(T.nilable(HostedConfirmation)) }
36
- attr_reader :hosted_confirmation
37
- # Configuration when `after_completion.type=redirect`.
38
- sig { returns(T.nilable(Redirect)) }
39
- attr_reader :redirect
40
- # The specified type of behavior after the flow is completed.
41
- sig { returns(String) }
42
- attr_reader :type
43
- end
44
- class SubscriptionCancel < Stripe::StripeObject
45
- class Retention < Stripe::StripeObject
46
- class CouponOffer < Stripe::StripeObject
47
- # The ID of the coupon to be offered.
48
- sig { returns(String) }
49
- attr_reader :coupon
50
- end
51
- # Configuration when `retention.type=coupon_offer`.
52
- sig { returns(T.nilable(CouponOffer)) }
53
- attr_reader :coupon_offer
54
- # Type of retention strategy that will be used.
55
- sig { returns(String) }
56
- attr_reader :type
57
- end
58
- # Specify a retention strategy to be used in the cancellation flow.
59
- sig { returns(T.nilable(Retention)) }
60
- attr_reader :retention
61
- # The ID of the subscription to be canceled.
62
- sig { returns(String) }
63
- attr_reader :subscription
64
- end
65
- class SubscriptionUpdate < Stripe::StripeObject
66
- # The ID of the subscription to be updated.
67
- sig { returns(String) }
68
- attr_reader :subscription
69
- end
70
- class SubscriptionUpdateConfirm < Stripe::StripeObject
71
- class Discount < Stripe::StripeObject
72
- # The ID of the coupon to apply to this subscription update.
73
- sig { returns(T.nilable(String)) }
74
- attr_reader :coupon
75
- # The ID of a promotion code to apply to this subscription update.
76
- sig { returns(T.nilable(String)) }
77
- attr_reader :promotion_code
78
- end
79
- class Item < Stripe::StripeObject
80
- # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
81
- sig { returns(T.nilable(String)) }
82
- attr_reader :id
83
- # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
84
- sig { returns(T.nilable(String)) }
85
- attr_reader :price
86
- # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
87
- sig { returns(Integer) }
88
- attr_reader :quantity
89
- end
90
- # The coupon or promotion code to apply to this subscription update.
91
- sig { returns(T.nilable(T::Array[Discount])) }
92
- attr_reader :discounts
93
- # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
94
- sig { returns(T::Array[Item]) }
95
- attr_reader :items
96
- # The ID of the subscription to be updated.
97
- sig { returns(String) }
98
- attr_reader :subscription
99
- end
100
- # Attribute for field after_completion
101
- sig { returns(AfterCompletion) }
102
- attr_reader :after_completion
103
- # Configuration when `flow.type=subscription_cancel`.
104
- sig { returns(T.nilable(SubscriptionCancel)) }
105
- attr_reader :subscription_cancel
106
- # Configuration when `flow.type=subscription_update`.
107
- sig { returns(T.nilable(SubscriptionUpdate)) }
108
- attr_reader :subscription_update
109
- # Configuration when `flow.type=subscription_update_confirm`.
110
- sig { returns(T.nilable(SubscriptionUpdateConfirm)) }
111
- attr_reader :subscription_update_confirm
112
- # Type of flow that the customer will go through.
113
- sig { returns(String) }
114
- attr_reader :type
115
- end
116
- # The configuration used by this session, describing the features available.
117
- sig { returns(T.any(String, Stripe::BillingPortal::Configuration)) }
118
- attr_reader :configuration
119
- # Time at which the object was created. Measured in seconds since the Unix epoch.
120
- sig { returns(Integer) }
121
- attr_reader :created
122
- # The ID of the customer for this session.
123
- sig { returns(String) }
124
- attr_reader :customer
125
- # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
126
- sig { returns(T.nilable(Flow)) }
127
- attr_reader :flow
128
- # Unique identifier for the object.
129
- sig { returns(String) }
130
- attr_reader :id
131
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
132
- sig { returns(T::Boolean) }
133
- attr_reader :livemode
134
- # The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
135
- sig { returns(T.nilable(String)) }
136
- attr_reader :locale
137
- # String representing the object's type. Objects of the same type share the same value.
138
- sig { returns(String) }
139
- attr_reader :object
140
- # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
141
- sig { returns(T.nilable(String)) }
142
- attr_reader :on_behalf_of
143
- # The URL to redirect customers to when they click on the portal's link to return to your website.
144
- sig { returns(T.nilable(String)) }
145
- attr_reader :return_url
146
- # The short-lived URL of the session that gives customers access to the customer portal.
147
- sig { returns(String) }
148
- attr_reader :url
149
- class CreateParams < Stripe::RequestParams
150
- class FlowData < Stripe::RequestParams
151
- class AfterCompletion < Stripe::RequestParams
152
- class HostedConfirmation < Stripe::RequestParams
153
- # A custom message to display to the customer after the flow is completed.
154
- sig { returns(T.nilable(String)) }
155
- attr_accessor :custom_message
156
- sig { params(custom_message: T.nilable(String)).void }
157
- def initialize(custom_message: nil); end
158
- end
159
- class Redirect < Stripe::RequestParams
160
- # The URL the customer will be redirected to after the flow is completed.
161
- sig { returns(String) }
162
- attr_accessor :return_url
163
- sig { params(return_url: String).void }
164
- def initialize(return_url: nil); end
165
- end
166
- # Configuration when `after_completion.type=hosted_confirmation`.
167
- sig {
168
- returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation))
169
- }
170
- attr_accessor :hosted_confirmation
171
- # Configuration when `after_completion.type=redirect`.
172
- sig {
173
- returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect))
174
- }
175
- attr_accessor :redirect
176
- # The specified behavior after the flow is completed.
177
- sig { returns(String) }
178
- attr_accessor :type
179
- sig {
180
- params(hosted_confirmation: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect), type: String).void
181
- }
182
- def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
183
- end
184
- class SubscriptionCancel < Stripe::RequestParams
185
- class Retention < Stripe::RequestParams
186
- class CouponOffer < Stripe::RequestParams
187
- # The ID of the coupon to be offered.
188
- sig { returns(String) }
189
- attr_accessor :coupon
190
- sig { params(coupon: String).void }
191
- def initialize(coupon: nil); end
192
- end
193
- # Configuration when `retention.type=coupon_offer`.
194
- sig {
195
- returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer)
196
- }
197
- attr_accessor :coupon_offer
198
- # Type of retention strategy to use with the customer.
199
- sig { returns(String) }
200
- attr_accessor :type
201
- sig {
202
- params(coupon_offer: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer, type: String).void
203
- }
204
- def initialize(coupon_offer: nil, type: nil); end
205
- end
206
- # Specify a retention strategy to be used in the cancellation flow.
207
- sig {
208
- returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention))
209
- }
210
- attr_accessor :retention
211
- # The ID of the subscription to be canceled.
212
- sig { returns(String) }
213
- attr_accessor :subscription
214
- sig {
215
- params(retention: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention), subscription: String).void
216
- }
217
- def initialize(retention: nil, subscription: nil); end
218
- end
219
- class SubscriptionUpdate < Stripe::RequestParams
220
- # The ID of the subscription to be updated.
221
- sig { returns(String) }
222
- attr_accessor :subscription
223
- sig { params(subscription: String).void }
224
- def initialize(subscription: nil); end
225
- end
226
- class SubscriptionUpdateConfirm < Stripe::RequestParams
227
- class Discount < Stripe::RequestParams
228
- # The ID of the coupon to apply to this subscription update.
229
- sig { returns(T.nilable(String)) }
230
- attr_accessor :coupon
231
- # The ID of a promotion code to apply to this subscription update.
232
- sig { returns(T.nilable(String)) }
233
- attr_accessor :promotion_code
234
- sig { params(coupon: T.nilable(String), promotion_code: T.nilable(String)).void }
235
- def initialize(coupon: nil, promotion_code: nil); end
236
- end
237
- class Item < Stripe::RequestParams
238
- # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
239
- sig { returns(String) }
240
- attr_accessor :id
241
- # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
242
- sig { returns(T.nilable(String)) }
243
- attr_accessor :price
244
- # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
245
- sig { returns(T.nilable(Integer)) }
246
- attr_accessor :quantity
247
- sig {
248
- params(id: String, price: T.nilable(String), quantity: T.nilable(Integer)).void
249
- }
250
- def initialize(id: nil, price: nil, quantity: nil); end
251
- end
252
- # The coupon or promotion code to apply to this subscription update.
253
- sig {
254
- returns(T.nilable(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
255
- }
256
- attr_accessor :discounts
257
- # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
258
- sig {
259
- returns(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Item])
260
- }
261
- attr_accessor :items
262
- # The ID of the subscription to be updated.
263
- sig { returns(String) }
264
- attr_accessor :subscription
265
- sig {
266
- params(discounts: T.nilable(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]), items: T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Item], subscription: String).void
267
- }
268
- def initialize(discounts: nil, items: nil, subscription: nil); end
269
- end
270
- # Behavior after the flow is completed.
271
- sig {
272
- returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion))
273
- }
274
- attr_accessor :after_completion
275
- # Configuration when `flow_data.type=subscription_cancel`.
276
- sig {
277
- returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel))
278
- }
279
- attr_accessor :subscription_cancel
280
- # Configuration when `flow_data.type=subscription_update`.
281
- sig {
282
- returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate))
283
- }
284
- attr_accessor :subscription_update
285
- # Configuration when `flow_data.type=subscription_update_confirm`.
286
- sig {
287
- returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm))
288
- }
289
- attr_accessor :subscription_update_confirm
290
- # Type of flow that the customer will go through.
291
- sig { returns(String) }
292
- attr_accessor :type
293
- sig {
294
- params(after_completion: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion), subscription_cancel: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate), subscription_update_confirm: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm), type: String).void
295
- }
296
- def initialize(
297
- after_completion: nil,
298
- subscription_cancel: nil,
299
- subscription_update: nil,
300
- subscription_update_confirm: nil,
301
- type: nil
302
- ); end
303
- end
304
- # The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
305
- sig { returns(T.nilable(String)) }
306
- attr_accessor :configuration
307
- # The ID of an existing customer.
308
- sig { returns(String) }
309
- attr_accessor :customer
310
- # Specifies which fields in the response should be expanded.
311
- sig { returns(T.nilable(T::Array[String])) }
312
- attr_accessor :expand
313
- # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
314
- sig { returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData)) }
315
- attr_accessor :flow_data
316
- # The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
317
- sig { returns(T.nilable(String)) }
318
- attr_accessor :locale
319
- # The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
320
- sig { returns(T.nilable(String)) }
321
- attr_accessor :on_behalf_of
322
- # The default URL to redirect customers to when they click on the portal's link to return to your website.
323
- sig { returns(T.nilable(String)) }
324
- attr_accessor :return_url
325
- sig {
326
- params(configuration: T.nilable(String), customer: String, expand: T.nilable(T::Array[String]), flow_data: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData), locale: T.nilable(String), on_behalf_of: T.nilable(String), return_url: T.nilable(String)).void
327
- }
328
- def initialize(
329
- configuration: nil,
330
- customer: nil,
331
- expand: nil,
332
- flow_data: nil,
333
- locale: nil,
334
- on_behalf_of: nil,
335
- return_url: nil
336
- ); end
337
- end
338
- # Creates a session of the customer portal.
339
- sig {
340
- params(params: T.any(::Stripe::BillingPortal::Session::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Session)
341
- }
342
- def self.create(params = {}, opts = {}); end
343
- end
344
- end
345
- end
@@ -1,125 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # This is an object representing a capability for a Stripe account.
7
- #
8
- # Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
9
- class Capability < APIResource
10
- class FutureRequirements < Stripe::StripeObject
11
- class Alternative < Stripe::StripeObject
12
- # Fields that can be provided to satisfy all fields in `original_fields_due`.
13
- sig { returns(T::Array[String]) }
14
- attr_reader :alternative_fields_due
15
- # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
16
- sig { returns(T::Array[String]) }
17
- attr_reader :original_fields_due
18
- end
19
- class Error < Stripe::StripeObject
20
- # The code for the type of error.
21
- sig { returns(String) }
22
- attr_reader :code
23
- # An informative message that indicates the error type and provides additional details about the error.
24
- sig { returns(String) }
25
- attr_reader :reason
26
- # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
27
- sig { returns(String) }
28
- attr_reader :requirement
29
- end
30
- # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
31
- sig { returns(T.nilable(T::Array[Alternative])) }
32
- attr_reader :alternatives
33
- # Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
34
- sig { returns(T.nilable(Integer)) }
35
- attr_reader :current_deadline
36
- # Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
37
- sig { returns(T::Array[String]) }
38
- attr_reader :currently_due
39
- # This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.
40
- sig { returns(T.nilable(String)) }
41
- attr_reader :disabled_reason
42
- # Fields that are `currently_due` and need to be collected again because validation or verification failed.
43
- sig { returns(T::Array[Error]) }
44
- attr_reader :errors
45
- # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
46
- sig { returns(T::Array[String]) }
47
- attr_reader :eventually_due
48
- # Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
49
- sig { returns(T::Array[String]) }
50
- attr_reader :past_due
51
- # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
52
- sig { returns(T::Array[String]) }
53
- attr_reader :pending_verification
54
- end
55
- class Requirements < Stripe::StripeObject
56
- class Alternative < Stripe::StripeObject
57
- # Fields that can be provided to satisfy all fields in `original_fields_due`.
58
- sig { returns(T::Array[String]) }
59
- attr_reader :alternative_fields_due
60
- # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
61
- sig { returns(T::Array[String]) }
62
- attr_reader :original_fields_due
63
- end
64
- class Error < Stripe::StripeObject
65
- # The code for the type of error.
66
- sig { returns(String) }
67
- attr_reader :code
68
- # An informative message that indicates the error type and provides additional details about the error.
69
- sig { returns(String) }
70
- attr_reader :reason
71
- # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
72
- sig { returns(String) }
73
- attr_reader :requirement
74
- end
75
- # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
76
- sig { returns(T.nilable(T::Array[Alternative])) }
77
- attr_reader :alternatives
78
- # The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested.
79
- sig { returns(T.nilable(Integer)) }
80
- attr_reader :current_deadline
81
- # Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.
82
- sig { returns(T::Array[String]) }
83
- attr_reader :currently_due
84
- # Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).
85
- sig { returns(T.nilable(String)) }
86
- attr_reader :disabled_reason
87
- # Fields that are `currently_due` and need to be collected again because validation or verification failed.
88
- sig { returns(T::Array[Error]) }
89
- attr_reader :errors
90
- # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
91
- sig { returns(T::Array[String]) }
92
- attr_reader :eventually_due
93
- # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.
94
- sig { returns(T::Array[String]) }
95
- attr_reader :past_due
96
- # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
97
- sig { returns(T::Array[String]) }
98
- attr_reader :pending_verification
99
- end
100
- # The account for which the capability enables functionality.
101
- sig { returns(T.any(String, Stripe::Account)) }
102
- attr_reader :account
103
- # Attribute for field future_requirements
104
- sig { returns(FutureRequirements) }
105
- attr_reader :future_requirements
106
- # The identifier for the capability.
107
- sig { returns(String) }
108
- attr_reader :id
109
- # String representing the object's type. Objects of the same type share the same value.
110
- sig { returns(String) }
111
- attr_reader :object
112
- # Whether the capability has been requested.
113
- sig { returns(T::Boolean) }
114
- attr_reader :requested
115
- # Time at which the capability was requested. Measured in seconds since the Unix epoch.
116
- sig { returns(T.nilable(Integer)) }
117
- attr_reader :requested_at
118
- # Attribute for field requirements
119
- sig { returns(Requirements) }
120
- attr_reader :requirements
121
- # The status of the capability.
122
- sig { returns(String) }
123
- attr_reader :status
124
- end
125
- end
@@ -1,125 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # You can store multiple cards on a customer in order to charge the customer
7
- # later. You can also store multiple debit cards on a recipient in order to
8
- # transfer to those cards later.
9
- #
10
- # Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
11
- class Card < APIResource
12
- class Networks < Stripe::StripeObject
13
- # The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.
14
- sig { returns(T.nilable(String)) }
15
- attr_reader :preferred
16
- end
17
- # Attribute for field account
18
- sig { returns(T.nilable(T.any(String, Stripe::Account))) }
19
- attr_reader :account
20
- # City/District/Suburb/Town/Village.
21
- sig { returns(T.nilable(String)) }
22
- attr_reader :address_city
23
- # Billing address country, if provided when creating card.
24
- sig { returns(T.nilable(String)) }
25
- attr_reader :address_country
26
- # Address line 1 (Street address/PO Box/Company name).
27
- sig { returns(T.nilable(String)) }
28
- attr_reader :address_line1
29
- # If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
30
- sig { returns(T.nilable(String)) }
31
- attr_reader :address_line1_check
32
- # Address line 2 (Apartment/Suite/Unit/Building).
33
- sig { returns(T.nilable(String)) }
34
- attr_reader :address_line2
35
- # State/County/Province/Region.
36
- sig { returns(T.nilable(String)) }
37
- attr_reader :address_state
38
- # ZIP or postal code.
39
- sig { returns(T.nilable(String)) }
40
- attr_reader :address_zip
41
- # If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
42
- sig { returns(T.nilable(String)) }
43
- attr_reader :address_zip_check
44
- # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
45
- sig { returns(T.nilable(String)) }
46
- attr_reader :allow_redisplay
47
- # A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.
48
- sig { returns(T.nilable(T::Array[String])) }
49
- attr_reader :available_payout_methods
50
- # Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
51
- sig { returns(String) }
52
- attr_reader :brand
53
- # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
54
- sig { returns(T.nilable(String)) }
55
- attr_reader :country
56
- # Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.
57
- sig { returns(T.nilable(String)) }
58
- attr_reader :currency
59
- # The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
60
- sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
61
- attr_reader :customer
62
- # If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).
63
- sig { returns(T.nilable(String)) }
64
- attr_reader :cvc_check
65
- # Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
66
- sig { returns(T.nilable(T::Boolean)) }
67
- attr_reader :default_for_currency
68
- # A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
69
- sig { returns(String) }
70
- attr_reader :description
71
- # (For tokenized numbers only.) The last four digits of the device account number.
72
- sig { returns(T.nilable(String)) }
73
- attr_reader :dynamic_last4
74
- # Two-digit number representing the card's expiration month.
75
- sig { returns(Integer) }
76
- attr_reader :exp_month
77
- # Four-digit number representing the card's expiration year.
78
- sig { returns(Integer) }
79
- attr_reader :exp_year
80
- # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
81
- #
82
- # *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
83
- sig { returns(T.nilable(String)) }
84
- attr_reader :fingerprint
85
- # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
86
- sig { returns(String) }
87
- attr_reader :funding
88
- # Unique identifier for the object.
89
- sig { returns(String) }
90
- attr_reader :id
91
- # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
92
- sig { returns(String) }
93
- attr_reader :iin
94
- # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
95
- sig { returns(String) }
96
- attr_reader :issuer
97
- # The last four digits of the card.
98
- sig { returns(String) }
99
- attr_reader :last4
100
- # 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.
101
- sig { returns(T.nilable(T::Hash[String, String])) }
102
- attr_reader :metadata
103
- # Cardholder name.
104
- sig { returns(T.nilable(String)) }
105
- attr_reader :name
106
- # Attribute for field networks
107
- sig { returns(Networks) }
108
- attr_reader :networks
109
- # String representing the object's type. Objects of the same type share the same value.
110
- sig { returns(String) }
111
- attr_reader :object
112
- # Status of a card based on the card issuer.
113
- sig { returns(T.nilable(String)) }
114
- attr_reader :regulated_status
115
- # For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.
116
- sig { returns(T.nilable(String)) }
117
- attr_reader :status
118
- # If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.
119
- sig { returns(T.nilable(String)) }
120
- attr_reader :tokenization_method
121
- # Always true for a deleted object
122
- sig { returns(T::Boolean) }
123
- attr_reader :deleted
124
- end
125
- end
@@ -1,32 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
7
- class CashBalance < APIResource
8
- class Settings < Stripe::StripeObject
9
- # The configuration for how funds that land in the customer cash balance are reconciled.
10
- sig { returns(String) }
11
- attr_reader :reconciliation_mode
12
- # A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance
13
- sig { returns(T::Boolean) }
14
- attr_reader :using_merchant_default
15
- end
16
- # A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
17
- sig { returns(T.nilable(T::Hash[String, Integer])) }
18
- attr_reader :available
19
- # The ID of the customer whose cash balance this object represents.
20
- sig { returns(String) }
21
- attr_reader :customer
22
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
23
- sig { returns(T::Boolean) }
24
- attr_reader :livemode
25
- # String representing the object's type. Objects of the same type share the same value.
26
- sig { returns(String) }
27
- attr_reader :object
28
- # Attribute for field settings
29
- sig { returns(Settings) }
30
- attr_reader :settings
31
- end
32
- end