stripe 15.2.1 → 15.3.0.pre.beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (588) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1599 -674
  3. data/VERSION +1 -1
  4. data/lib/stripe/api_requestor.rb +28 -0
  5. data/lib/stripe/api_version.rb +1 -1
  6. data/lib/stripe/errors.rb +54 -0
  7. data/lib/stripe/event_types.rb +98 -0
  8. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  9. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  10. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  11. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  19. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  20. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  21. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  22. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  23. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  24. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  25. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  26. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  30. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  48. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  52. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  53. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  58. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
  59. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  60. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
  61. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  62. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  65. data/lib/stripe/object_types.rb +50 -0
  66. data/lib/stripe/resources/account.rb +653 -1
  67. data/lib/stripe/resources/account_notice.rb +123 -0
  68. data/lib/stripe/resources/account_session.rb +256 -1
  69. data/lib/stripe/resources/balance_settings.rb +105 -0
  70. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  71. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  72. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  73. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  74. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  75. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  76. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  77. data/lib/stripe/resources/card.rb +2 -0
  78. data/lib/stripe/resources/cash_balance.rb +2 -0
  79. data/lib/stripe/resources/charge.rb +1538 -0
  80. data/lib/stripe/resources/checkout/session.rb +330 -2
  81. data/lib/stripe/resources/confirmation_token.rb +170 -0
  82. data/lib/stripe/resources/coupon.rb +30 -1
  83. data/lib/stripe/resources/credit_note.rb +6 -0
  84. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  85. data/lib/stripe/resources/customer.rb +2 -0
  86. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  87. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  88. data/lib/stripe/resources/customer_session.rb +6 -1
  89. data/lib/stripe/resources/discount.rb +2 -0
  90. data/lib/stripe/resources/event.rb +31 -0
  91. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  92. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  93. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  94. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  95. data/lib/stripe/resources/fx_quote.rb +184 -0
  96. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  97. data/lib/stripe/resources/invoice.rb +1070 -16
  98. data/lib/stripe/resources/invoice_item.rb +78 -2
  99. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  100. data/lib/stripe/resources/invoice_payment.rb +2 -53
  101. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  102. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  103. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  104. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  105. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  106. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  107. data/lib/stripe/resources/line_item.rb +37 -0
  108. data/lib/stripe/resources/mandate.rb +24 -0
  109. data/lib/stripe/resources/margin.rb +115 -0
  110. data/lib/stripe/resources/order.rb +2806 -0
  111. data/lib/stripe/resources/payment_attempt_record.rb +1086 -0
  112. data/lib/stripe/resources/payment_intent.rb +7694 -2738
  113. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  114. data/lib/stripe/resources/payment_method.rb +192 -1
  115. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  116. data/lib/stripe/resources/payment_record.rb +1615 -0
  117. data/lib/stripe/resources/payout.rb +6 -0
  118. data/lib/stripe/resources/price.rb +30 -0
  119. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  120. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  121. data/lib/stripe/resources/promotion_code.rb +10 -0
  122. data/lib/stripe/resources/quote.rb +2046 -6
  123. data/lib/stripe/resources/quote_line.rb +274 -0
  124. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  125. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +364 -0
  126. data/lib/stripe/resources/refund.rb +9 -0
  127. data/lib/stripe/resources/setup_attempt.rb +21 -0
  128. data/lib/stripe/resources/setup_intent.rb +578 -9
  129. data/lib/stripe/resources/source.rb +29 -0
  130. data/lib/stripe/resources/subscription.rb +333 -9
  131. data/lib/stripe/resources/subscription_item.rb +84 -3
  132. data/lib/stripe/resources/subscription_schedule.rb +1013 -10
  133. data/lib/stripe/resources/tax/association.rb +66 -0
  134. data/lib/stripe/resources/tax/form.rb +211 -0
  135. data/lib/stripe/resources/tax_id.rb +12 -2
  136. data/lib/stripe/resources/terminal/reader.rb +156 -0
  137. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  138. data/lib/stripe/resources/transfer.rb +6 -0
  139. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  140. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  141. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  142. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  143. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  144. data/lib/stripe/resources/v2/core/account.rb +1746 -0
  145. data/lib/stripe/resources/v2/core/account_link.rb +56 -0
  146. data/lib/stripe/resources/v2/core/person.rb +276 -0
  147. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  148. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  149. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  150. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  151. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  152. data/lib/stripe/resources/v2/money_management/financial_account.rb +58 -0
  153. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  154. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  155. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  156. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  157. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  158. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  159. data/lib/stripe/resources/v2/money_management/payout_method.rb +75 -0
  160. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  161. data/lib/stripe/resources/v2/money_management/received_credit.rb +116 -0
  162. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  163. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  164. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  165. data/lib/stripe/resources/v2/payments/off_session_payment.rb +74 -0
  166. data/lib/stripe/resources.rb +104 -0
  167. data/lib/stripe/services/account_notice_service.rb +101 -0
  168. data/lib/stripe/services/account_service.rb +562 -1
  169. data/lib/stripe/services/account_session_service.rb +226 -1
  170. data/lib/stripe/services/balance_settings_service.rb +96 -0
  171. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  172. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  173. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  174. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  175. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  176. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  177. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  178. data/lib/stripe/services/capital_service.rb +15 -0
  179. data/lib/stripe/services/charge_service.rb +1418 -0
  180. data/lib/stripe/services/checkout/session_service.rb +247 -2
  181. data/lib/stripe/services/coupon_service.rb +17 -1
  182. data/lib/stripe/services/credit_note_service.rb +4 -0
  183. data/lib/stripe/services/customer_session_service.rb +4 -1
  184. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  185. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  186. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  187. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  188. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  189. data/lib/stripe/services/financial_connections_service.rb +2 -1
  190. data/lib/stripe/services/fx_quote_service.rb +123 -0
  191. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  192. data/lib/stripe/services/invoice_item_service.rb +74 -2
  193. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  194. data/lib/stripe/services/invoice_service.rb +1021 -16
  195. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  196. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  197. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  198. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  199. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  200. data/lib/stripe/services/issuing_service.rb +5 -1
  201. data/lib/stripe/services/margin_service.rb +119 -0
  202. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  203. data/lib/stripe/services/order_service.rb +2236 -0
  204. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  205. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  206. data/lib/stripe/services/payment_intent_service.rb +4733 -245
  207. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  208. data/lib/stripe/services/payment_method_service.rb +120 -1
  209. data/lib/stripe/services/payment_record_service.rb +542 -0
  210. data/lib/stripe/services/payout_service.rb +4 -0
  211. data/lib/stripe/services/price_service.rb +19 -0
  212. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  213. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  214. data/lib/stripe/services/privacy_service.rb +13 -0
  215. data/lib/stripe/services/promotion_code_service.rb +8 -0
  216. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  217. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  218. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  219. data/lib/stripe/services/quote_service.rb +1730 -7
  220. data/lib/stripe/services/setup_intent_service.rb +538 -9
  221. data/lib/stripe/services/subscription_item_service.rb +75 -3
  222. data/lib/stripe/services/subscription_schedule_service.rb +915 -10
  223. data/lib/stripe/services/subscription_service.rb +276 -9
  224. data/lib/stripe/services/tax/association_service.rb +31 -0
  225. data/lib/stripe/services/tax/form_service.rb +100 -0
  226. data/lib/stripe/services/tax_id_service.rb +8 -2
  227. data/lib/stripe/services/tax_service.rb +3 -1
  228. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  229. data/lib/stripe/services/terminal/reader_service.rb +90 -0
  230. data/lib/stripe/services/terminal_service.rb +2 -1
  231. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  232. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  233. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  234. data/lib/stripe/services/transfer_service.rb +4 -0
  235. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  236. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  237. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  238. data/lib/stripe/services/v1_services.rb +11 -2
  239. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  240. data/lib/stripe/services/v2/core/account_service.rb +4138 -0
  241. data/lib/stripe/services/v2/core/accounts/person_service.rb +1046 -0
  242. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +131 -0
  243. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  244. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  245. data/lib/stripe/services/v2/core_service.rb +4 -1
  246. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  247. data/lib/stripe/services/v2/money_management/financial_account_service.rb +43 -0
  248. data/lib/stripe/services/v2/money_management/financial_address_service.rb +81 -0
  249. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  250. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  251. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +200 -0
  252. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  253. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  254. data/lib/stripe/services/v2/money_management/payout_method_service.rb +91 -0
  255. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  256. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  257. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  258. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  259. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  260. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  261. data/lib/stripe/services/v2/payment_service.rb +15 -0
  262. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +138 -0
  263. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  264. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +49 -0
  265. data/lib/stripe/services/v2_services.rb +5 -2
  266. data/lib/stripe/services.rb +53 -1
  267. data/lib/stripe/stripe_configuration.rb +3 -1
  268. data/lib/stripe/stripe_object.rb +1 -1
  269. data/lib/stripe/util.rb +7 -1
  270. data/lib/stripe/version.rb +1 -1
  271. data/lib/stripe/webhook.rb +1 -1
  272. data/lib/stripe.rb +53 -0
  273. data/rbi/stripe.rbi +191639 -0
  274. data/stripe.gemspec +4 -1
  275. metadata +162 -325
  276. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  277. data/rbi/stripe/resources/account.rbi +0 -4926
  278. data/rbi/stripe/resources/account_link.rbi +0 -74
  279. data/rbi/stripe/resources/account_session.rbi +0 -1013
  280. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  281. data/rbi/stripe/resources/application.rbi +0 -20
  282. data/rbi/stripe/resources/application_fee.rbi +0 -118
  283. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  284. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  285. data/rbi/stripe/resources/balance.rbi +0 -235
  286. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  287. data/rbi/stripe/resources/bank_account.rbi +0 -127
  288. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  289. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  290. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  291. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  292. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  293. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  294. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  295. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  296. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  297. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  298. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  299. data/rbi/stripe/resources/capability.rbi +0 -125
  300. data/rbi/stripe/resources/card.rbi +0 -125
  301. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  302. data/rbi/stripe/resources/charge.rbi +0 -2069
  303. data/rbi/stripe/resources/checkout/session.rbi +0 -4004
  304. data/rbi/stripe/resources/climate/order.rbi +0 -245
  305. data/rbi/stripe/resources/climate/product.rbi +0 -75
  306. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  307. data/rbi/stripe/resources/confirmation_token.rbi +0 -1807
  308. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  309. data/rbi/stripe/resources/country_spec.rbi +0 -85
  310. data/rbi/stripe/resources/coupon.rbi +0 -250
  311. data/rbi/stripe/resources/credit_note.rbi +0 -752
  312. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  313. data/rbi/stripe/resources/customer.rbi +0 -1005
  314. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  315. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  316. data/rbi/stripe/resources/customer_session.rbi +0 -200
  317. data/rbi/stripe/resources/discount.rbi +0 -53
  318. data/rbi/stripe/resources/dispute.rbi +0 -761
  319. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  320. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  321. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  322. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  323. data/rbi/stripe/resources/event.rbi +0 -149
  324. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  325. data/rbi/stripe/resources/file.rbi +0 -143
  326. data/rbi/stripe/resources/file_link.rbi +0 -141
  327. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  328. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  329. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  330. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  331. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  332. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  333. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  334. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  335. data/rbi/stripe/resources/identity/verification_session.rbi +0 -526
  336. data/rbi/stripe/resources/invoice.rbi +0 -3812
  337. data/rbi/stripe/resources/invoice_item.rbi +0 -473
  338. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  339. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  340. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  341. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  342. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  343. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  344. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  345. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  346. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  347. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  348. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  349. data/rbi/stripe/resources/line_item.rbi +0 -72
  350. data/rbi/stripe/resources/login_link.rbi +0 -19
  351. data/rbi/stripe/resources/mandate.rbi +0 -187
  352. data/rbi/stripe/resources/payment_intent.rbi +0 -9647
  353. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  354. data/rbi/stripe/resources/payment_method.rbi +0 -1761
  355. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  356. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  357. data/rbi/stripe/resources/payout.rbi +0 -300
  358. data/rbi/stripe/resources/person.rbi +0 -401
  359. data/rbi/stripe/resources/plan.rbi +0 -371
  360. data/rbi/stripe/resources/price.rbi +0 -694
  361. data/rbi/stripe/resources/product.rbi +0 -555
  362. data/rbi/stripe/resources/product_feature.rbi +0 -26
  363. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  364. data/rbi/stripe/resources/quote.rbi +0 -1126
  365. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  366. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  367. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  368. data/rbi/stripe/resources/refund.rbi +0 -523
  369. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  370. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  371. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  372. data/rbi/stripe/resources/reversal.rbi +0 -51
  373. data/rbi/stripe/resources/review.rbi +0 -154
  374. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  375. data/rbi/stripe/resources/setup_intent.rbi +0 -3655
  376. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  377. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  378. data/rbi/stripe/resources/source.rbi +0 -1496
  379. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  380. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  381. data/rbi/stripe/resources/subscription.rbi +0 -2027
  382. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  383. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1623
  384. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  385. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  386. data/rbi/stripe/resources/tax/registration.rbi +0 -2713
  387. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  388. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  389. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  390. data/rbi/stripe/resources/tax_code.rbi +0 -44
  391. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  392. data/rbi/stripe/resources/tax_id.rbi +0 -165
  393. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  394. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1386
  395. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  396. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  397. data/rbi/stripe/resources/terminal/reader.rbi +0 -847
  398. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  399. data/rbi/stripe/resources/token.rbi +0 -1283
  400. data/rbi/stripe/resources/topup.rbi +0 -222
  401. data/rbi/stripe/resources/transfer.rbi +0 -199
  402. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  403. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  404. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -865
  405. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  406. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  407. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  408. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  409. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  410. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  411. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  412. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  413. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  414. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  415. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  416. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  417. data/rbi/stripe/resources/v2/event.rbi +0 -48
  418. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  419. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  420. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  421. data/rbi/stripe/services/account_link_service.rbi +0 -58
  422. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  423. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  424. data/rbi/stripe/services/account_service.rbi +0 -4213
  425. data/rbi/stripe/services/account_session_service.rbi +0 -646
  426. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  427. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  428. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  429. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  430. data/rbi/stripe/services/apps_service.rbi +0 -9
  431. data/rbi/stripe/services/balance_service.rbi +0 -21
  432. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  433. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  434. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  435. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  436. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  437. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  438. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  439. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  440. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  441. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  442. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  443. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  444. data/rbi/stripe/services/billing_service.rbi +0 -15
  445. data/rbi/stripe/services/charge_service.rbi +0 -448
  446. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  447. data/rbi/stripe/services/checkout/session_service.rbi +0 -2614
  448. data/rbi/stripe/services/checkout_service.rbi +0 -9
  449. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  450. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  451. data/rbi/stripe/services/climate_service.rbi +0 -11
  452. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  453. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  454. data/rbi/stripe/services/coupon_service.rbi +0 -194
  455. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  456. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  457. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  458. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  459. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  460. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  461. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  462. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  463. data/rbi/stripe/services/customer_service.rbi +0 -647
  464. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  465. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  466. data/rbi/stripe/services/dispute_service.rbi +0 -424
  467. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  468. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  469. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  470. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  471. data/rbi/stripe/services/event_service.rbi +0 -83
  472. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  473. data/rbi/stripe/services/file_link_service.rbi +0 -124
  474. data/rbi/stripe/services/file_service.rbi +0 -116
  475. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  476. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  477. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  478. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  479. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  480. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  481. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  482. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  483. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -323
  484. data/rbi/stripe/services/identity_service.rbi +0 -10
  485. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  486. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  487. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  488. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  489. data/rbi/stripe/services/invoice_service.rbi +0 -2981
  490. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  491. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  492. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  493. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  494. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  495. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  496. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  497. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  498. data/rbi/stripe/services/issuing_service.rbi +0 -16
  499. data/rbi/stripe/services/mandate_service.rbi +0 -20
  500. data/rbi/stripe/services/payment_intent_service.rbi +0 -7659
  501. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  502. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  503. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  504. data/rbi/stripe/services/payment_method_service.rbi +0 -776
  505. data/rbi/stripe/services/payout_service.rbi +0 -205
  506. data/rbi/stripe/services/plan_service.rbi +0 -282
  507. data/rbi/stripe/services/price_service.rbi +0 -546
  508. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  509. data/rbi/stripe/services/product_service.rbi +0 -477
  510. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  511. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  512. data/rbi/stripe/services/quote_service.rbi +0 -686
  513. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  514. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  515. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  516. data/rbi/stripe/services/radar_service.rbi +0 -11
  517. data/rbi/stripe/services/refund_service.rbi +0 -185
  518. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  519. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  520. data/rbi/stripe/services/reporting_service.rbi +0 -10
  521. data/rbi/stripe/services/review_service.rbi +0 -84
  522. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  523. data/rbi/stripe/services/setup_intent_service.rbi +0 -3391
  524. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  525. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  526. data/rbi/stripe/services/sigma_service.rbi +0 -9
  527. data/rbi/stripe/services/source_service.rbi +0 -663
  528. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  529. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1290
  530. data/rbi/stripe/services/subscription_service.rbi +0 -1648
  531. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  532. data/rbi/stripe/services/tax/registration_service.rbi +0 -1845
  533. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  534. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  535. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  536. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  537. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  538. data/rbi/stripe/services/tax_service.rbi +0 -12
  539. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1118
  540. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  541. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  542. data/rbi/stripe/services/terminal/reader_service.rbi +0 -455
  543. data/rbi/stripe/services/terminal_service.rbi +0 -12
  544. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -739
  545. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  546. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  547. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  548. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  549. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  550. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  551. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  552. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  553. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  554. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  555. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  556. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  557. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  558. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  559. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  560. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  561. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  562. data/rbi/stripe/services/token_service.rbi +0 -1257
  563. data/rbi/stripe/services/topup_service.rbi +0 -176
  564. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  565. data/rbi/stripe/services/transfer_service.rbi +0 -152
  566. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  567. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  568. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  569. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -562
  570. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  571. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  572. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  573. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  574. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  575. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  576. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  577. data/rbi/stripe/services/treasury_service.rbi +0 -18
  578. data/rbi/stripe/services/v1_services.rbi +0 -77
  579. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  580. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  581. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  582. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  583. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  584. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  585. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  586. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  587. data/rbi/stripe/services/v2_services.rbi +0 -10
  588. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,645 +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
- # A portal configuration describes the functionality and behavior of a portal session.
8
- class Configuration < APIResource
9
- class BusinessProfile < Stripe::StripeObject
10
- # The messaging shown to customers in the portal.
11
- sig { returns(T.nilable(String)) }
12
- attr_reader :headline
13
- # A link to the business’s publicly available privacy policy.
14
- sig { returns(T.nilable(String)) }
15
- attr_reader :privacy_policy_url
16
- # A link to the business’s publicly available terms of service.
17
- sig { returns(T.nilable(String)) }
18
- attr_reader :terms_of_service_url
19
- end
20
- class Features < Stripe::StripeObject
21
- class CustomerUpdate < Stripe::StripeObject
22
- # The types of customer updates that are supported. When empty, customers are not updateable.
23
- sig { returns(T::Array[String]) }
24
- attr_reader :allowed_updates
25
- # Whether the feature is enabled.
26
- sig { returns(T::Boolean) }
27
- attr_reader :enabled
28
- end
29
- class InvoiceHistory < Stripe::StripeObject
30
- # Whether the feature is enabled.
31
- sig { returns(T::Boolean) }
32
- attr_reader :enabled
33
- end
34
- class PaymentMethodUpdate < Stripe::StripeObject
35
- # Whether the feature is enabled.
36
- sig { returns(T::Boolean) }
37
- attr_reader :enabled
38
- end
39
- class SubscriptionCancel < Stripe::StripeObject
40
- class CancellationReason < Stripe::StripeObject
41
- # Whether the feature is enabled.
42
- sig { returns(T::Boolean) }
43
- attr_reader :enabled
44
- # Which cancellation reasons will be given as options to the customer.
45
- sig { returns(T::Array[String]) }
46
- attr_reader :options
47
- end
48
- # Attribute for field cancellation_reason
49
- sig { returns(CancellationReason) }
50
- attr_reader :cancellation_reason
51
- # Whether the feature is enabled.
52
- sig { returns(T::Boolean) }
53
- attr_reader :enabled
54
- # Whether to cancel subscriptions immediately or at the end of the billing period.
55
- sig { returns(String) }
56
- attr_reader :mode
57
- # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.
58
- sig { returns(String) }
59
- attr_reader :proration_behavior
60
- end
61
- class SubscriptionUpdate < Stripe::StripeObject
62
- class Product < Stripe::StripeObject
63
- # The list of price IDs which, when subscribed to, a subscription can be updated.
64
- sig { returns(T::Array[String]) }
65
- attr_reader :prices
66
- # The product ID.
67
- sig { returns(String) }
68
- attr_reader :product
69
- end
70
- class ScheduleAtPeriodEnd < Stripe::StripeObject
71
- class Condition < Stripe::StripeObject
72
- # The type of condition.
73
- sig { returns(String) }
74
- attr_reader :type
75
- end
76
- # List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
77
- sig { returns(T::Array[Condition]) }
78
- attr_reader :conditions
79
- end
80
- # The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.
81
- sig { returns(T::Array[String]) }
82
- attr_reader :default_allowed_updates
83
- # Whether the feature is enabled.
84
- sig { returns(T::Boolean) }
85
- attr_reader :enabled
86
- # The list of up to 10 products that support subscription updates.
87
- sig { returns(T.nilable(T::Array[Product])) }
88
- attr_reader :products
89
- # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.
90
- sig { returns(String) }
91
- attr_reader :proration_behavior
92
- # Attribute for field schedule_at_period_end
93
- sig { returns(ScheduleAtPeriodEnd) }
94
- attr_reader :schedule_at_period_end
95
- end
96
- # Attribute for field customer_update
97
- sig { returns(CustomerUpdate) }
98
- attr_reader :customer_update
99
- # Attribute for field invoice_history
100
- sig { returns(InvoiceHistory) }
101
- attr_reader :invoice_history
102
- # Attribute for field payment_method_update
103
- sig { returns(PaymentMethodUpdate) }
104
- attr_reader :payment_method_update
105
- # Attribute for field subscription_cancel
106
- sig { returns(SubscriptionCancel) }
107
- attr_reader :subscription_cancel
108
- # Attribute for field subscription_update
109
- sig { returns(SubscriptionUpdate) }
110
- attr_reader :subscription_update
111
- end
112
- class LoginPage < Stripe::StripeObject
113
- # If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.
114
- #
115
- # If `false`, the previously generated `url`, if any, will be deactivated.
116
- sig { returns(T::Boolean) }
117
- attr_reader :enabled
118
- # A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.
119
- sig { returns(T.nilable(String)) }
120
- attr_reader :url
121
- end
122
- # Whether the configuration is active and can be used to create portal sessions.
123
- sig { returns(T::Boolean) }
124
- attr_reader :active
125
- # ID of the Connect Application that created the configuration.
126
- sig { returns(T.nilable(T.any(String, Stripe::Application))) }
127
- attr_reader :application
128
- # Attribute for field business_profile
129
- sig { returns(BusinessProfile) }
130
- attr_reader :business_profile
131
- # Time at which the object was created. Measured in seconds since the Unix epoch.
132
- sig { returns(Integer) }
133
- attr_reader :created
134
- # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
135
- sig { returns(T.nilable(String)) }
136
- attr_reader :default_return_url
137
- # Attribute for field features
138
- sig { returns(Features) }
139
- attr_reader :features
140
- # Unique identifier for the object.
141
- sig { returns(String) }
142
- attr_reader :id
143
- # Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
144
- sig { returns(T::Boolean) }
145
- attr_reader :is_default
146
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
147
- sig { returns(T::Boolean) }
148
- attr_reader :livemode
149
- # Attribute for field login_page
150
- sig { returns(LoginPage) }
151
- attr_reader :login_page
152
- # 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.
153
- sig { returns(T.nilable(T::Hash[String, String])) }
154
- attr_reader :metadata
155
- # String representing the object's type. Objects of the same type share the same value.
156
- sig { returns(String) }
157
- attr_reader :object
158
- # Time at which the object was last updated. Measured in seconds since the Unix epoch.
159
- sig { returns(Integer) }
160
- attr_reader :updated
161
- class ListParams < Stripe::RequestParams
162
- # Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).
163
- sig { returns(T.nilable(T::Boolean)) }
164
- attr_accessor :active
165
- # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
166
- sig { returns(T.nilable(String)) }
167
- attr_accessor :ending_before
168
- # Specifies which fields in the response should be expanded.
169
- sig { returns(T.nilable(T::Array[String])) }
170
- attr_accessor :expand
171
- # Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).
172
- sig { returns(T.nilable(T::Boolean)) }
173
- attr_accessor :is_default
174
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
175
- sig { returns(T.nilable(Integer)) }
176
- attr_accessor :limit
177
- # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
178
- sig { returns(T.nilable(String)) }
179
- attr_accessor :starting_after
180
- sig {
181
- params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), is_default: T.nilable(T::Boolean), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
182
- }
183
- def initialize(
184
- active: nil,
185
- ending_before: nil,
186
- expand: nil,
187
- is_default: nil,
188
- limit: nil,
189
- starting_after: nil
190
- ); end
191
- end
192
- class CreateParams < Stripe::RequestParams
193
- class BusinessProfile < Stripe::RequestParams
194
- # The messaging shown to customers in the portal.
195
- sig { returns(T.nilable(T.nilable(String))) }
196
- attr_accessor :headline
197
- # A link to the business’s publicly available privacy policy.
198
- sig { returns(T.nilable(String)) }
199
- attr_accessor :privacy_policy_url
200
- # A link to the business’s publicly available terms of service.
201
- sig { returns(T.nilable(String)) }
202
- attr_accessor :terms_of_service_url
203
- sig {
204
- params(headline: T.nilable(T.nilable(String)), privacy_policy_url: T.nilable(String), terms_of_service_url: T.nilable(String)).void
205
- }
206
- def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
207
- end
208
- class Features < Stripe::RequestParams
209
- class CustomerUpdate < Stripe::RequestParams
210
- # The types of customer updates that are supported. When empty, customers are not updateable.
211
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
212
- attr_accessor :allowed_updates
213
- # Whether the feature is enabled.
214
- sig { returns(T::Boolean) }
215
- attr_accessor :enabled
216
- sig {
217
- params(allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T::Boolean).void
218
- }
219
- def initialize(allowed_updates: nil, enabled: nil); end
220
- end
221
- class InvoiceHistory < Stripe::RequestParams
222
- # Whether the feature is enabled.
223
- sig { returns(T::Boolean) }
224
- attr_accessor :enabled
225
- sig { params(enabled: T::Boolean).void }
226
- def initialize(enabled: nil); end
227
- end
228
- class PaymentMethodUpdate < Stripe::RequestParams
229
- # Whether the feature is enabled.
230
- sig { returns(T::Boolean) }
231
- attr_accessor :enabled
232
- sig { params(enabled: T::Boolean).void }
233
- def initialize(enabled: nil); end
234
- end
235
- class SubscriptionCancel < Stripe::RequestParams
236
- class CancellationReason < Stripe::RequestParams
237
- # Whether the feature is enabled.
238
- sig { returns(T::Boolean) }
239
- attr_accessor :enabled
240
- # Which cancellation reasons will be given as options to the customer.
241
- sig { returns(T.nilable(T.any(String, T::Array[String]))) }
242
- attr_accessor :options
243
- sig {
244
- params(enabled: T::Boolean, options: T.nilable(T.any(String, T::Array[String]))).void
245
- }
246
- def initialize(enabled: nil, options: nil); end
247
- end
248
- # Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
249
- sig {
250
- returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel::CancellationReason))
251
- }
252
- attr_accessor :cancellation_reason
253
- # Whether the feature is enabled.
254
- sig { returns(T::Boolean) }
255
- attr_accessor :enabled
256
- # Whether to cancel subscriptions immediately or at the end of the billing period.
257
- sig { returns(T.nilable(String)) }
258
- attr_accessor :mode
259
- # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
260
- sig { returns(T.nilable(String)) }
261
- attr_accessor :proration_behavior
262
- sig {
263
- params(cancellation_reason: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel::CancellationReason), enabled: T::Boolean, mode: T.nilable(String), proration_behavior: T.nilable(String)).void
264
- }
265
- def initialize(
266
- cancellation_reason: nil,
267
- enabled: nil,
268
- mode: nil,
269
- proration_behavior: nil
270
- ); end
271
- end
272
- class SubscriptionUpdate < Stripe::RequestParams
273
- class Product < Stripe::RequestParams
274
- # The list of price IDs for the product that a subscription can be updated to.
275
- sig { returns(T::Array[String]) }
276
- attr_accessor :prices
277
- # The product id.
278
- sig { returns(String) }
279
- attr_accessor :product
280
- sig { params(prices: T::Array[String], product: String).void }
281
- def initialize(prices: nil, product: nil); end
282
- end
283
- class ScheduleAtPeriodEnd < Stripe::RequestParams
284
- class Condition < Stripe::RequestParams
285
- # The type of condition.
286
- sig { returns(String) }
287
- attr_accessor :type
288
- sig { params(type: String).void }
289
- def initialize(type: nil); end
290
- end
291
- # List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
292
- sig {
293
- returns(T.nilable(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))
294
- }
295
- attr_accessor :conditions
296
- sig {
297
- params(conditions: T.nilable(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])).void
298
- }
299
- def initialize(conditions: nil); end
300
- end
301
- # The types of subscription updates that are supported. When empty, subscriptions are not updateable.
302
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
303
- attr_accessor :default_allowed_updates
304
- # Whether the feature is enabled.
305
- sig { returns(T::Boolean) }
306
- attr_accessor :enabled
307
- # The list of up to 10 products that support subscription updates.
308
- sig {
309
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product]))))
310
- }
311
- attr_accessor :products
312
- # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
313
- sig { returns(T.nilable(String)) }
314
- attr_accessor :proration_behavior
315
- # Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
316
- sig {
317
- returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
318
- }
319
- attr_accessor :schedule_at_period_end
320
- sig {
321
- params(default_allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T::Boolean, products: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product]))), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).void
322
- }
323
- def initialize(
324
- default_allowed_updates: nil,
325
- enabled: nil,
326
- products: nil,
327
- proration_behavior: nil,
328
- schedule_at_period_end: nil
329
- ); end
330
- end
331
- # Information about updating the customer details in the portal.
332
- sig {
333
- returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::CustomerUpdate))
334
- }
335
- attr_accessor :customer_update
336
- # Information about showing the billing history in the portal.
337
- sig {
338
- returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::InvoiceHistory))
339
- }
340
- attr_accessor :invoice_history
341
- # Information about updating payment methods in the portal.
342
- sig {
343
- returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::PaymentMethodUpdate))
344
- }
345
- attr_accessor :payment_method_update
346
- # Information about canceling subscriptions in the portal.
347
- sig {
348
- returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel))
349
- }
350
- attr_accessor :subscription_cancel
351
- # Information about updating subscriptions in the portal.
352
- sig {
353
- returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate))
354
- }
355
- attr_accessor :subscription_update
356
- sig {
357
- params(customer_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate)).void
358
- }
359
- def initialize(
360
- customer_update: nil,
361
- invoice_history: nil,
362
- payment_method_update: nil,
363
- subscription_cancel: nil,
364
- subscription_update: nil
365
- ); end
366
- end
367
- class LoginPage < Stripe::RequestParams
368
- # Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
369
- sig { returns(T::Boolean) }
370
- attr_accessor :enabled
371
- sig { params(enabled: T::Boolean).void }
372
- def initialize(enabled: nil); end
373
- end
374
- # The business information shown to customers in the portal.
375
- sig {
376
- returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::BusinessProfile))
377
- }
378
- attr_accessor :business_profile
379
- # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
380
- sig { returns(T.nilable(T.nilable(String))) }
381
- attr_accessor :default_return_url
382
- # Specifies which fields in the response should be expanded.
383
- sig { returns(T.nilable(T::Array[String])) }
384
- attr_accessor :expand
385
- # Information about the features available in the portal.
386
- sig { returns(::Stripe::BillingPortal::Configuration::CreateParams::Features) }
387
- attr_accessor :features
388
- # The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
389
- sig { returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::LoginPage)) }
390
- attr_accessor :login_page
391
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
392
- sig { returns(T.nilable(T::Hash[String, String])) }
393
- attr_accessor :metadata
394
- sig {
395
- params(business_profile: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::BusinessProfile), default_return_url: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), features: ::Stripe::BillingPortal::Configuration::CreateParams::Features, login_page: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::LoginPage), metadata: T.nilable(T::Hash[String, String])).void
396
- }
397
- def initialize(
398
- business_profile: nil,
399
- default_return_url: nil,
400
- expand: nil,
401
- features: nil,
402
- login_page: nil,
403
- metadata: nil
404
- ); end
405
- end
406
- class UpdateParams < Stripe::RequestParams
407
- class BusinessProfile < Stripe::RequestParams
408
- # The messaging shown to customers in the portal.
409
- sig { returns(T.nilable(T.nilable(String))) }
410
- attr_accessor :headline
411
- # A link to the business’s publicly available privacy policy.
412
- sig { returns(T.nilable(T.nilable(String))) }
413
- attr_accessor :privacy_policy_url
414
- # A link to the business’s publicly available terms of service.
415
- sig { returns(T.nilable(T.nilable(String))) }
416
- attr_accessor :terms_of_service_url
417
- sig {
418
- params(headline: T.nilable(T.nilable(String)), privacy_policy_url: T.nilable(T.nilable(String)), terms_of_service_url: T.nilable(T.nilable(String))).void
419
- }
420
- def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
421
- end
422
- class Features < Stripe::RequestParams
423
- class CustomerUpdate < Stripe::RequestParams
424
- # The types of customer updates that are supported. When empty, customers are not updateable.
425
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
426
- attr_accessor :allowed_updates
427
- # Whether the feature is enabled.
428
- sig { returns(T.nilable(T::Boolean)) }
429
- attr_accessor :enabled
430
- sig {
431
- params(allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T.nilable(T::Boolean)).void
432
- }
433
- def initialize(allowed_updates: nil, enabled: nil); end
434
- end
435
- class InvoiceHistory < Stripe::RequestParams
436
- # Whether the feature is enabled.
437
- sig { returns(T::Boolean) }
438
- attr_accessor :enabled
439
- sig { params(enabled: T::Boolean).void }
440
- def initialize(enabled: nil); end
441
- end
442
- class PaymentMethodUpdate < Stripe::RequestParams
443
- # Whether the feature is enabled.
444
- sig { returns(T::Boolean) }
445
- attr_accessor :enabled
446
- sig { params(enabled: T::Boolean).void }
447
- def initialize(enabled: nil); end
448
- end
449
- class SubscriptionCancel < Stripe::RequestParams
450
- class CancellationReason < Stripe::RequestParams
451
- # Whether the feature is enabled.
452
- sig { returns(T::Boolean) }
453
- attr_accessor :enabled
454
- # Which cancellation reasons will be given as options to the customer.
455
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
456
- attr_accessor :options
457
- sig {
458
- params(enabled: T::Boolean, options: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
459
- }
460
- def initialize(enabled: nil, options: nil); end
461
- end
462
- # Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
463
- sig {
464
- returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel::CancellationReason))
465
- }
466
- attr_accessor :cancellation_reason
467
- # Whether the feature is enabled.
468
- sig { returns(T.nilable(T::Boolean)) }
469
- attr_accessor :enabled
470
- # Whether to cancel subscriptions immediately or at the end of the billing period.
471
- sig { returns(T.nilable(String)) }
472
- attr_accessor :mode
473
- # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
474
- sig { returns(T.nilable(String)) }
475
- attr_accessor :proration_behavior
476
- sig {
477
- params(cancellation_reason: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel::CancellationReason), enabled: T.nilable(T::Boolean), mode: T.nilable(String), proration_behavior: T.nilable(String)).void
478
- }
479
- def initialize(
480
- cancellation_reason: nil,
481
- enabled: nil,
482
- mode: nil,
483
- proration_behavior: nil
484
- ); end
485
- end
486
- class SubscriptionUpdate < Stripe::RequestParams
487
- class Product < Stripe::RequestParams
488
- # The list of price IDs for the product that a subscription can be updated to.
489
- sig { returns(T::Array[String]) }
490
- attr_accessor :prices
491
- # The product id.
492
- sig { returns(String) }
493
- attr_accessor :product
494
- sig { params(prices: T::Array[String], product: String).void }
495
- def initialize(prices: nil, product: nil); end
496
- end
497
- class ScheduleAtPeriodEnd < Stripe::RequestParams
498
- class Condition < Stripe::RequestParams
499
- # The type of condition.
500
- sig { returns(String) }
501
- attr_accessor :type
502
- sig { params(type: String).void }
503
- def initialize(type: nil); end
504
- end
505
- # List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
506
- sig {
507
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))))
508
- }
509
- attr_accessor :conditions
510
- sig {
511
- params(conditions: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])))).void
512
- }
513
- def initialize(conditions: nil); end
514
- end
515
- # The types of subscription updates that are supported. When empty, subscriptions are not updateable.
516
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
517
- attr_accessor :default_allowed_updates
518
- # Whether the feature is enabled.
519
- sig { returns(T.nilable(T::Boolean)) }
520
- attr_accessor :enabled
521
- # The list of up to 10 products that support subscription updates.
522
- sig {
523
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product]))))
524
- }
525
- attr_accessor :products
526
- # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
527
- sig { returns(T.nilable(String)) }
528
- attr_accessor :proration_behavior
529
- # Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
530
- sig {
531
- returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
532
- }
533
- attr_accessor :schedule_at_period_end
534
- sig {
535
- params(default_allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T.nilable(T::Boolean), products: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product]))), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).void
536
- }
537
- def initialize(
538
- default_allowed_updates: nil,
539
- enabled: nil,
540
- products: nil,
541
- proration_behavior: nil,
542
- schedule_at_period_end: nil
543
- ); end
544
- end
545
- # Information about updating the customer details in the portal.
546
- sig {
547
- returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::CustomerUpdate))
548
- }
549
- attr_accessor :customer_update
550
- # Information about showing the billing history in the portal.
551
- sig {
552
- returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::InvoiceHistory))
553
- }
554
- attr_accessor :invoice_history
555
- # Information about updating payment methods in the portal.
556
- sig {
557
- returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::PaymentMethodUpdate))
558
- }
559
- attr_accessor :payment_method_update
560
- # Information about canceling subscriptions in the portal.
561
- sig {
562
- returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel))
563
- }
564
- attr_accessor :subscription_cancel
565
- # Information about updating subscriptions in the portal.
566
- sig {
567
- returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate))
568
- }
569
- attr_accessor :subscription_update
570
- sig {
571
- params(customer_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate)).void
572
- }
573
- def initialize(
574
- customer_update: nil,
575
- invoice_history: nil,
576
- payment_method_update: nil,
577
- subscription_cancel: nil,
578
- subscription_update: nil
579
- ); end
580
- end
581
- class LoginPage < Stripe::RequestParams
582
- # Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
583
- #
584
- # Set to `false` to deactivate the `login_page.url`.
585
- sig { returns(T::Boolean) }
586
- attr_accessor :enabled
587
- sig { params(enabled: T::Boolean).void }
588
- def initialize(enabled: nil); end
589
- end
590
- # Whether the configuration is active and can be used to create portal sessions.
591
- sig { returns(T.nilable(T::Boolean)) }
592
- attr_accessor :active
593
- # The business information shown to customers in the portal.
594
- sig {
595
- returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::BusinessProfile))
596
- }
597
- attr_accessor :business_profile
598
- # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
599
- sig { returns(T.nilable(T.nilable(String))) }
600
- attr_accessor :default_return_url
601
- # Specifies which fields in the response should be expanded.
602
- sig { returns(T.nilable(T::Array[String])) }
603
- attr_accessor :expand
604
- # Information about the features available in the portal.
605
- sig { returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features)) }
606
- attr_accessor :features
607
- # The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
608
- sig { returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::LoginPage)) }
609
- attr_accessor :login_page
610
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
611
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
612
- attr_accessor :metadata
613
- sig {
614
- params(active: T.nilable(T::Boolean), business_profile: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::BusinessProfile), default_return_url: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), features: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features), login_page: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::LoginPage), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
615
- }
616
- def initialize(
617
- active: nil,
618
- business_profile: nil,
619
- default_return_url: nil,
620
- expand: nil,
621
- features: nil,
622
- login_page: nil,
623
- metadata: nil
624
- ); end
625
- end
626
- # Creates a configuration that describes the functionality and behavior of a PortalSession
627
- sig {
628
- params(params: T.any(::Stripe::BillingPortal::Configuration::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Configuration)
629
- }
630
- def self.create(params = {}, opts = {}); end
631
-
632
- # Returns a list of configurations that describe the functionality of the customer portal.
633
- sig {
634
- params(params: T.any(::Stripe::BillingPortal::Configuration::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
635
- }
636
- def self.list(params = {}, opts = {}); end
637
-
638
- # Updates a configuration that describes the functionality of the customer portal.
639
- sig {
640
- params(configuration: String, params: T.any(::Stripe::BillingPortal::Configuration::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Configuration)
641
- }
642
- def self.update(configuration, params = {}, opts = {}); end
643
- end
644
- end
645
- end