stripe 15.4.0 → 15.5.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 (596) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +1634 -662
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_requestor.rb +32 -0
  6. data/lib/stripe/api_version.rb +1 -2
  7. data/lib/stripe/errors.rb +60 -0
  8. data/lib/stripe/event_types.rb +102 -0
  9. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  10. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  16. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +23 -0
  18. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +21 -0
  19. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  21. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  22. data/lib/stripe/events/v2_core_account_link_returned_event.rb +13 -0
  23. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  24. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  25. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  26. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_payout_method_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_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +22 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  65. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  66. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  67. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  68. data/lib/stripe/object_types.rb +53 -0
  69. data/lib/stripe/resources/account.rb +653 -1
  70. data/lib/stripe/resources/account_notice.rb +123 -0
  71. data/lib/stripe/resources/account_session.rb +256 -1
  72. data/lib/stripe/resources/balance_settings.rb +105 -0
  73. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  74. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  75. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  76. data/lib/stripe/resources/billing/meter_usage.rb +23 -0
  77. data/lib/stripe/resources/billing/meter_usage_row.rb +28 -0
  78. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  79. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  80. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  81. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  82. data/lib/stripe/resources/card.rb +2 -0
  83. data/lib/stripe/resources/cash_balance.rb +2 -0
  84. data/lib/stripe/resources/charge.rb +1538 -0
  85. data/lib/stripe/resources/checkout/session.rb +399 -3
  86. data/lib/stripe/resources/confirmation_token.rb +170 -0
  87. data/lib/stripe/resources/coupon.rb +30 -1
  88. data/lib/stripe/resources/credit_note.rb +6 -0
  89. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  90. data/lib/stripe/resources/customer.rb +2 -0
  91. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  92. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  93. data/lib/stripe/resources/customer_session.rb +6 -1
  94. data/lib/stripe/resources/discount.rb +2 -0
  95. data/lib/stripe/resources/dispute.rb +11 -0
  96. data/lib/stripe/resources/event.rb +31 -0
  97. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  98. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  99. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  100. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  101. data/lib/stripe/resources/fx_quote.rb +186 -0
  102. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  103. data/lib/stripe/resources/invoice.rb +1140 -16
  104. data/lib/stripe/resources/invoice_item.rb +78 -2
  105. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  106. data/lib/stripe/resources/invoice_payment.rb +2 -53
  107. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  108. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  109. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  110. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  111. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  112. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  113. data/lib/stripe/resources/line_item.rb +37 -0
  114. data/lib/stripe/resources/mandate.rb +24 -0
  115. data/lib/stripe/resources/margin.rb +115 -0
  116. data/lib/stripe/resources/order.rb +2958 -0
  117. data/lib/stripe/resources/payment_attempt_record.rb +1101 -0
  118. data/lib/stripe/resources/payment_intent.rb +9469 -3712
  119. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  120. data/lib/stripe/resources/payment_method.rb +192 -1
  121. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  122. data/lib/stripe/resources/payment_record.rb +1630 -0
  123. data/lib/stripe/resources/payout.rb +6 -0
  124. data/lib/stripe/resources/price.rb +30 -0
  125. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  126. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  127. data/lib/stripe/resources/promotion_code.rb +10 -0
  128. data/lib/stripe/resources/quote.rb +2038 -7
  129. data/lib/stripe/resources/quote_line.rb +274 -0
  130. data/lib/stripe/resources/quote_preview_invoice.rb +680 -0
  131. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +371 -0
  132. data/lib/stripe/resources/refund.rb +9 -0
  133. data/lib/stripe/resources/setup_attempt.rb +21 -0
  134. data/lib/stripe/resources/setup_intent.rb +578 -9
  135. data/lib/stripe/resources/source.rb +29 -0
  136. data/lib/stripe/resources/subscription.rb +365 -9
  137. data/lib/stripe/resources/subscription_item.rb +84 -3
  138. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  139. data/lib/stripe/resources/tax/association.rb +66 -0
  140. data/lib/stripe/resources/tax/form.rb +211 -0
  141. data/lib/stripe/resources/tax_id.rb +12 -2
  142. data/lib/stripe/resources/terminal/onboarding_link.rb +84 -0
  143. data/lib/stripe/resources/terminal/reader.rb +8 -0
  144. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  145. data/lib/stripe/resources/transfer.rb +6 -0
  146. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  147. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  148. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  149. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  150. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  151. data/lib/stripe/resources/v2/core/account.rb +1930 -0
  152. data/lib/stripe/resources/v2/core/account_link.rb +72 -0
  153. data/lib/stripe/resources/v2/core/person.rb +276 -0
  154. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  155. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  156. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  157. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  158. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  159. data/lib/stripe/resources/v2/money_management/financial_account.rb +77 -0
  160. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  161. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  162. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  163. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  164. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  165. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  166. data/lib/stripe/resources/v2/money_management/payout_method.rb +77 -0
  167. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  168. data/lib/stripe/resources/v2/money_management/received_credit.rb +122 -0
  169. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  170. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  171. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  172. data/lib/stripe/resources/v2/payments/off_session_payment.rb +89 -0
  173. data/lib/stripe/resources.rb +109 -0
  174. data/lib/stripe/services/account_notice_service.rb +101 -0
  175. data/lib/stripe/services/account_service.rb +562 -1
  176. data/lib/stripe/services/account_session_service.rb +226 -1
  177. data/lib/stripe/services/balance_settings_service.rb +96 -0
  178. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  179. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  180. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  181. data/lib/stripe/services/billing/meter_usage_service.rb +76 -0
  182. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  183. data/lib/stripe/services/billing_service.rb +2 -1
  184. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  185. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  186. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  187. data/lib/stripe/services/capital_service.rb +15 -0
  188. data/lib/stripe/services/charge_service.rb +1418 -0
  189. data/lib/stripe/services/checkout/session_service.rb +316 -3
  190. data/lib/stripe/services/coupon_service.rb +17 -1
  191. data/lib/stripe/services/credit_note_service.rb +4 -0
  192. data/lib/stripe/services/customer_session_service.rb +4 -1
  193. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  194. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  195. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  196. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  197. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  198. data/lib/stripe/services/financial_connections_service.rb +2 -1
  199. data/lib/stripe/services/fx_quote_service.rb +123 -0
  200. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  201. data/lib/stripe/services/invoice_item_service.rb +74 -2
  202. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  203. data/lib/stripe/services/invoice_service.rb +1074 -16
  204. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  205. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  206. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  207. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  208. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  209. data/lib/stripe/services/issuing_service.rb +5 -1
  210. data/lib/stripe/services/margin_service.rb +119 -0
  211. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  212. data/lib/stripe/services/order_service.rb +2388 -0
  213. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  214. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  215. data/lib/stripe/services/payment_intent_service.rb +5724 -435
  216. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  217. data/lib/stripe/services/payment_method_service.rb +120 -1
  218. data/lib/stripe/services/payment_record_service.rb +542 -0
  219. data/lib/stripe/services/payout_service.rb +4 -0
  220. data/lib/stripe/services/price_service.rb +19 -0
  221. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  222. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  223. data/lib/stripe/services/privacy_service.rb +13 -0
  224. data/lib/stripe/services/promotion_code_service.rb +8 -0
  225. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  226. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  227. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  228. data/lib/stripe/services/quote_service.rb +1723 -8
  229. data/lib/stripe/services/setup_intent_service.rb +538 -9
  230. data/lib/stripe/services/subscription_item_service.rb +75 -3
  231. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  232. data/lib/stripe/services/subscription_service.rb +309 -9
  233. data/lib/stripe/services/tax/association_service.rb +31 -0
  234. data/lib/stripe/services/tax/form_service.rb +100 -0
  235. data/lib/stripe/services/tax_id_service.rb +8 -2
  236. data/lib/stripe/services/tax_service.rb +3 -1
  237. data/lib/stripe/services/terminal/onboarding_link_service.rb +56 -0
  238. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  239. data/lib/stripe/services/terminal_service.rb +3 -1
  240. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  241. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  242. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  243. data/lib/stripe/services/transfer_service.rb +4 -0
  244. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  245. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  246. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  247. data/lib/stripe/services/v1_services.rb +11 -2
  248. data/lib/stripe/services/v2/core/account_link_service.rb +114 -0
  249. data/lib/stripe/services/v2/core/account_service.rb +4522 -0
  250. data/lib/stripe/services/v2/core/accounts/person_service.rb +1045 -0
  251. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +130 -0
  252. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  253. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  254. data/lib/stripe/services/v2/core_service.rb +4 -1
  255. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  256. data/lib/stripe/services/v2/money_management/financial_account_service.rb +116 -0
  257. data/lib/stripe/services/v2/money_management/financial_address_service.rb +82 -0
  258. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  259. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  260. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +199 -0
  261. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  262. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  263. data/lib/stripe/services/v2/money_management/payout_method_service.rb +90 -0
  264. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  265. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  266. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  267. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  268. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  269. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  270. data/lib/stripe/services/v2/payment_service.rb +15 -0
  271. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +152 -0
  272. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  273. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +53 -0
  274. data/lib/stripe/services/v2_services.rb +4 -1
  275. data/lib/stripe/services.rb +55 -1
  276. data/lib/stripe/stripe_configuration.rb +3 -1
  277. data/lib/stripe/stripe_object.rb +1 -1
  278. data/lib/stripe/util.rb +7 -1
  279. data/lib/stripe/version.rb +1 -1
  280. data/lib/stripe.rb +53 -0
  281. data/rbi/stripe.rbi +199016 -0
  282. data/stripe.gemspec +4 -1
  283. metadata +168 -324
  284. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  285. data/rbi/stripe/resources/account.rbi +0 -4995
  286. data/rbi/stripe/resources/account_link.rbi +0 -76
  287. data/rbi/stripe/resources/account_session.rbi +0 -1074
  288. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  289. data/rbi/stripe/resources/application.rbi +0 -20
  290. data/rbi/stripe/resources/application_fee.rbi +0 -118
  291. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  292. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  293. data/rbi/stripe/resources/balance.rbi +0 -235
  294. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  295. data/rbi/stripe/resources/bank_account.rbi +0 -127
  296. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  297. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  298. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  299. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  300. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  301. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  302. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  303. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  304. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  305. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -703
  306. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  307. data/rbi/stripe/resources/capability.rbi +0 -125
  308. data/rbi/stripe/resources/card.rbi +0 -125
  309. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  310. data/rbi/stripe/resources/charge.rbi +0 -2089
  311. data/rbi/stripe/resources/checkout/session.rbi +0 -4095
  312. data/rbi/stripe/resources/climate/order.rbi +0 -245
  313. data/rbi/stripe/resources/climate/product.rbi +0 -75
  314. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  315. data/rbi/stripe/resources/confirmation_token.rbi +0 -1818
  316. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  317. data/rbi/stripe/resources/country_spec.rbi +0 -85
  318. data/rbi/stripe/resources/coupon.rbi +0 -250
  319. data/rbi/stripe/resources/credit_note.rbi +0 -752
  320. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  321. data/rbi/stripe/resources/customer.rbi +0 -1005
  322. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  323. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  324. data/rbi/stripe/resources/customer_session.rbi +0 -200
  325. data/rbi/stripe/resources/discount.rbi +0 -53
  326. data/rbi/stripe/resources/dispute.rbi +0 -761
  327. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  328. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  329. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  330. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  331. data/rbi/stripe/resources/event.rbi +0 -137
  332. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  333. data/rbi/stripe/resources/file.rbi +0 -143
  334. data/rbi/stripe/resources/file_link.rbi +0 -141
  335. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  336. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  337. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  338. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  339. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  340. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  341. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  342. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  343. data/rbi/stripe/resources/identity/verification_session.rbi +0 -564
  344. data/rbi/stripe/resources/invoice.rbi +0 -3858
  345. data/rbi/stripe/resources/invoice_item.rbi +0 -470
  346. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  347. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  348. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  349. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  350. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  351. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  352. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  353. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  354. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  355. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  356. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  357. data/rbi/stripe/resources/line_item.rbi +0 -72
  358. data/rbi/stripe/resources/login_link.rbi +0 -19
  359. data/rbi/stripe/resources/mandate.rbi +0 -191
  360. data/rbi/stripe/resources/payment_intent.rbi +0 -9997
  361. data/rbi/stripe/resources/payment_link.rbi +0 -1893
  362. data/rbi/stripe/resources/payment_method.rbi +0 -1770
  363. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  364. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  365. data/rbi/stripe/resources/payout.rbi +0 -300
  366. data/rbi/stripe/resources/person.rbi +0 -401
  367. data/rbi/stripe/resources/plan.rbi +0 -371
  368. data/rbi/stripe/resources/price.rbi +0 -694
  369. data/rbi/stripe/resources/product.rbi +0 -555
  370. data/rbi/stripe/resources/product_feature.rbi +0 -26
  371. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  372. data/rbi/stripe/resources/quote.rbi +0 -1145
  373. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  374. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  375. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  376. data/rbi/stripe/resources/refund.rbi +0 -523
  377. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  378. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  379. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  380. data/rbi/stripe/resources/reversal.rbi +0 -51
  381. data/rbi/stripe/resources/review.rbi +0 -154
  382. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  383. data/rbi/stripe/resources/setup_intent.rbi +0 -3978
  384. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  385. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  386. data/rbi/stripe/resources/source.rbi +0 -1496
  387. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  388. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  389. data/rbi/stripe/resources/subscription.rbi +0 -2080
  390. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  391. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1673
  392. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  393. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  394. data/rbi/stripe/resources/tax/registration.rbi +0 -3216
  395. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  396. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  397. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  398. data/rbi/stripe/resources/tax_code.rbi +0 -44
  399. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  400. data/rbi/stripe/resources/tax_id.rbi +0 -165
  401. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  402. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1595
  403. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  404. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  405. data/rbi/stripe/resources/terminal/reader.rbi +0 -994
  406. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  407. data/rbi/stripe/resources/token.rbi +0 -1283
  408. data/rbi/stripe/resources/topup.rbi +0 -222
  409. data/rbi/stripe/resources/transfer.rbi +0 -199
  410. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  411. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  412. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -869
  413. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  414. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  415. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  416. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  417. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  418. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  419. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  420. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  421. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  422. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  423. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  424. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  425. data/rbi/stripe/resources/v2/event.rbi +0 -48
  426. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  427. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  428. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  429. data/rbi/stripe/services/account_link_service.rbi +0 -60
  430. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  431. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  432. data/rbi/stripe/services/account_service.rbi +0 -4281
  433. data/rbi/stripe/services/account_session_service.rbi +0 -685
  434. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  435. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  436. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  437. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  438. data/rbi/stripe/services/apps_service.rbi +0 -9
  439. data/rbi/stripe/services/balance_service.rbi +0 -21
  440. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  441. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  442. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  443. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  444. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  445. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  446. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  447. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  448. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  449. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -555
  450. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  451. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  452. data/rbi/stripe/services/billing_service.rbi +0 -15
  453. data/rbi/stripe/services/charge_service.rbi +0 -448
  454. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  455. data/rbi/stripe/services/checkout/session_service.rbi +0 -2690
  456. data/rbi/stripe/services/checkout_service.rbi +0 -9
  457. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  458. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  459. data/rbi/stripe/services/climate_service.rbi +0 -11
  460. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  461. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  462. data/rbi/stripe/services/coupon_service.rbi +0 -194
  463. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  464. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  465. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  466. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  467. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  468. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  469. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  470. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  471. data/rbi/stripe/services/customer_service.rbi +0 -647
  472. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  473. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  474. data/rbi/stripe/services/dispute_service.rbi +0 -424
  475. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  476. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  477. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  478. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  479. data/rbi/stripe/services/event_service.rbi +0 -83
  480. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  481. data/rbi/stripe/services/file_link_service.rbi +0 -124
  482. data/rbi/stripe/services/file_service.rbi +0 -116
  483. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  484. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  485. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  486. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  487. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  488. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  489. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  490. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  491. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -339
  492. data/rbi/stripe/services/identity_service.rbi +0 -10
  493. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  494. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  495. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  496. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  497. data/rbi/stripe/services/invoice_service.rbi +0 -3027
  498. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  499. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  500. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  501. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  502. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  503. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  504. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  505. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  506. data/rbi/stripe/services/issuing_service.rbi +0 -16
  507. data/rbi/stripe/services/mandate_service.rbi +0 -20
  508. data/rbi/stripe/services/payment_intent_service.rbi +0 -7994
  509. data/rbi/stripe/services/payment_link_service.rbi +0 -1441
  510. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  511. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  512. data/rbi/stripe/services/payment_method_service.rbi +0 -781
  513. data/rbi/stripe/services/payout_service.rbi +0 -205
  514. data/rbi/stripe/services/plan_service.rbi +0 -282
  515. data/rbi/stripe/services/price_service.rbi +0 -546
  516. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  517. data/rbi/stripe/services/product_service.rbi +0 -477
  518. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  519. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  520. data/rbi/stripe/services/quote_service.rbi +0 -699
  521. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  522. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  523. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  524. data/rbi/stripe/services/radar_service.rbi +0 -11
  525. data/rbi/stripe/services/refund_service.rbi +0 -185
  526. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  527. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  528. data/rbi/stripe/services/reporting_service.rbi +0 -10
  529. data/rbi/stripe/services/review_service.rbi +0 -84
  530. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  531. data/rbi/stripe/services/setup_intent_service.rbi +0 -3709
  532. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  533. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  534. data/rbi/stripe/services/sigma_service.rbi +0 -9
  535. data/rbi/stripe/services/source_service.rbi +0 -663
  536. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  537. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1333
  538. data/rbi/stripe/services/subscription_service.rbi +0 -1684
  539. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  540. data/rbi/stripe/services/tax/registration_service.rbi +0 -2278
  541. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  542. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  543. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  544. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  545. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  546. data/rbi/stripe/services/tax_service.rbi +0 -12
  547. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1286
  548. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  549. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  550. data/rbi/stripe/services/terminal/reader_service.rbi +0 -540
  551. data/rbi/stripe/services/terminal_service.rbi +0 -12
  552. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  553. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  554. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  555. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  556. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  557. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  558. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  559. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  560. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  561. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  562. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  563. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  564. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  565. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  566. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  567. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  568. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  569. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  570. data/rbi/stripe/services/token_service.rbi +0 -1257
  571. data/rbi/stripe/services/topup_service.rbi +0 -176
  572. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  573. data/rbi/stripe/services/transfer_service.rbi +0 -152
  574. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  575. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  576. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  577. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  578. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  579. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  580. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  581. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  582. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  583. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  584. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  585. data/rbi/stripe/services/treasury_service.rbi +0 -18
  586. data/rbi/stripe/services/v1_services.rbi +0 -77
  587. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  588. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  589. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  590. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  591. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  592. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  593. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  594. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  595. data/rbi/stripe/services/v2_services.rbi +0 -10
  596. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,555 +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
- class ConfigurationService < StripeService
8
- class ListParams < Stripe::RequestParams
9
- # Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).
10
- sig { returns(T.nilable(T::Boolean)) }
11
- attr_accessor :active
12
- # 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.
13
- sig { returns(T.nilable(String)) }
14
- attr_accessor :ending_before
15
- # Specifies which fields in the response should be expanded.
16
- sig { returns(T.nilable(T::Array[String])) }
17
- attr_accessor :expand
18
- # Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).
19
- sig { returns(T.nilable(T::Boolean)) }
20
- attr_accessor :is_default
21
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
22
- sig { returns(T.nilable(Integer)) }
23
- attr_accessor :limit
24
- # 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.
25
- sig { returns(T.nilable(String)) }
26
- attr_accessor :starting_after
27
- sig {
28
- 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
29
- }
30
- def initialize(
31
- active: nil,
32
- ending_before: nil,
33
- expand: nil,
34
- is_default: nil,
35
- limit: nil,
36
- starting_after: nil
37
- ); end
38
- end
39
- class CreateParams < Stripe::RequestParams
40
- class BusinessProfile < Stripe::RequestParams
41
- # The messaging shown to customers in the portal.
42
- sig { returns(T.nilable(T.nilable(String))) }
43
- attr_accessor :headline
44
- # A link to the business’s publicly available privacy policy.
45
- sig { returns(T.nilable(String)) }
46
- attr_accessor :privacy_policy_url
47
- # A link to the business’s publicly available terms of service.
48
- sig { returns(T.nilable(String)) }
49
- attr_accessor :terms_of_service_url
50
- sig {
51
- params(headline: T.nilable(T.nilable(String)), privacy_policy_url: T.nilable(String), terms_of_service_url: T.nilable(String)).void
52
- }
53
- def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
54
- end
55
- class Features < Stripe::RequestParams
56
- class CustomerUpdate < Stripe::RequestParams
57
- # The types of customer updates that are supported. When empty, customers are not updateable.
58
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
59
- attr_accessor :allowed_updates
60
- # Whether the feature is enabled.
61
- sig { returns(T::Boolean) }
62
- attr_accessor :enabled
63
- sig {
64
- params(allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T::Boolean).void
65
- }
66
- def initialize(allowed_updates: nil, enabled: nil); end
67
- end
68
- class InvoiceHistory < Stripe::RequestParams
69
- # Whether the feature is enabled.
70
- sig { returns(T::Boolean) }
71
- attr_accessor :enabled
72
- sig { params(enabled: T::Boolean).void }
73
- def initialize(enabled: nil); end
74
- end
75
- class PaymentMethodUpdate < Stripe::RequestParams
76
- # Whether the feature is enabled.
77
- sig { returns(T::Boolean) }
78
- attr_accessor :enabled
79
- sig { params(enabled: T::Boolean).void }
80
- def initialize(enabled: nil); end
81
- end
82
- class SubscriptionCancel < Stripe::RequestParams
83
- class CancellationReason < Stripe::RequestParams
84
- # Whether the feature is enabled.
85
- sig { returns(T::Boolean) }
86
- attr_accessor :enabled
87
- # Which cancellation reasons will be given as options to the customer.
88
- sig { returns(T.nilable(T.any(String, T::Array[String]))) }
89
- attr_accessor :options
90
- sig {
91
- params(enabled: T::Boolean, options: T.nilable(T.any(String, T::Array[String]))).void
92
- }
93
- def initialize(enabled: nil, options: nil); end
94
- end
95
- # Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
96
- sig {
97
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel::CancellationReason))
98
- }
99
- attr_accessor :cancellation_reason
100
- # Whether the feature is enabled.
101
- sig { returns(T::Boolean) }
102
- attr_accessor :enabled
103
- # Whether to cancel subscriptions immediately or at the end of the billing period.
104
- sig { returns(T.nilable(String)) }
105
- attr_accessor :mode
106
- # 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.
107
- sig { returns(T.nilable(String)) }
108
- attr_accessor :proration_behavior
109
- sig {
110
- params(cancellation_reason: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel::CancellationReason), enabled: T::Boolean, mode: T.nilable(String), proration_behavior: T.nilable(String)).void
111
- }
112
- def initialize(
113
- cancellation_reason: nil,
114
- enabled: nil,
115
- mode: nil,
116
- proration_behavior: nil
117
- ); end
118
- end
119
- class SubscriptionUpdate < Stripe::RequestParams
120
- class Product < Stripe::RequestParams
121
- class AdjustableQuantity < Stripe::RequestParams
122
- # Set to true if the quantity can be adjusted to any non-negative integer.
123
- sig { returns(T::Boolean) }
124
- attr_accessor :enabled
125
- # The maximum quantity that can be set for the product.
126
- sig { returns(T.nilable(Integer)) }
127
- attr_accessor :maximum
128
- # The minimum quantity that can be set for the product.
129
- sig { returns(T.nilable(Integer)) }
130
- attr_accessor :minimum
131
- sig {
132
- params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
133
- }
134
- def initialize(enabled: nil, maximum: nil, minimum: nil); end
135
- end
136
- # Control whether the quantity of the product can be adjusted.
137
- sig {
138
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity))
139
- }
140
- attr_accessor :adjustable_quantity
141
- # The list of price IDs for the product that a subscription can be updated to.
142
- sig { returns(T::Array[String]) }
143
- attr_accessor :prices
144
- # The product id.
145
- sig { returns(String) }
146
- attr_accessor :product
147
- sig {
148
- params(adjustable_quantity: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity), prices: T::Array[String], product: String).void
149
- }
150
- def initialize(adjustable_quantity: nil, prices: nil, product: nil); end
151
- end
152
- class ScheduleAtPeriodEnd < Stripe::RequestParams
153
- class Condition < Stripe::RequestParams
154
- # The type of condition.
155
- sig { returns(String) }
156
- attr_accessor :type
157
- sig { params(type: String).void }
158
- def initialize(type: nil); end
159
- end
160
- # List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
161
- sig {
162
- returns(T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))
163
- }
164
- attr_accessor :conditions
165
- sig {
166
- params(conditions: T.nilable(T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])).void
167
- }
168
- def initialize(conditions: nil); end
169
- end
170
- # The types of subscription updates that are supported. When empty, subscriptions are not updateable.
171
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
172
- attr_accessor :default_allowed_updates
173
- # Whether the feature is enabled.
174
- sig { returns(T::Boolean) }
175
- attr_accessor :enabled
176
- # The list of up to 10 products that support subscription updates.
177
- sig {
178
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product]))))
179
- }
180
- attr_accessor :products
181
- # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
182
- sig { returns(T.nilable(String)) }
183
- attr_accessor :proration_behavior
184
- # Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
185
- sig {
186
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
187
- }
188
- attr_accessor :schedule_at_period_end
189
- sig {
190
- 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::ConfigurationService::CreateParams::Features::SubscriptionUpdate::Product]))), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).void
191
- }
192
- def initialize(
193
- default_allowed_updates: nil,
194
- enabled: nil,
195
- products: nil,
196
- proration_behavior: nil,
197
- schedule_at_period_end: nil
198
- ); end
199
- end
200
- # Information about updating the customer details in the portal.
201
- sig {
202
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::CustomerUpdate))
203
- }
204
- attr_accessor :customer_update
205
- # Information about showing the billing history in the portal.
206
- sig {
207
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::InvoiceHistory))
208
- }
209
- attr_accessor :invoice_history
210
- # Information about updating payment methods in the portal.
211
- sig {
212
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::PaymentMethodUpdate))
213
- }
214
- attr_accessor :payment_method_update
215
- # Information about canceling subscriptions in the portal.
216
- sig {
217
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel))
218
- }
219
- attr_accessor :subscription_cancel
220
- # Information about updating subscriptions in the portal.
221
- sig {
222
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate))
223
- }
224
- attr_accessor :subscription_update
225
- sig {
226
- params(customer_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features::SubscriptionUpdate)).void
227
- }
228
- def initialize(
229
- customer_update: nil,
230
- invoice_history: nil,
231
- payment_method_update: nil,
232
- subscription_cancel: nil,
233
- subscription_update: nil
234
- ); end
235
- end
236
- class LoginPage < Stripe::RequestParams
237
- # 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.
238
- sig { returns(T::Boolean) }
239
- attr_accessor :enabled
240
- sig { params(enabled: T::Boolean).void }
241
- def initialize(enabled: nil); end
242
- end
243
- # The business information shown to customers in the portal.
244
- sig {
245
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::BusinessProfile))
246
- }
247
- attr_accessor :business_profile
248
- # 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.
249
- sig { returns(T.nilable(T.nilable(String))) }
250
- attr_accessor :default_return_url
251
- # Specifies which fields in the response should be expanded.
252
- sig { returns(T.nilable(T::Array[String])) }
253
- attr_accessor :expand
254
- # Information about the features available in the portal.
255
- sig { returns(::Stripe::BillingPortal::ConfigurationService::CreateParams::Features) }
256
- attr_accessor :features
257
- # 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).
258
- sig {
259
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::LoginPage))
260
- }
261
- attr_accessor :login_page
262
- # 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`.
263
- sig { returns(T.nilable(T::Hash[String, String])) }
264
- attr_accessor :metadata
265
- sig {
266
- params(business_profile: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::BusinessProfile), default_return_url: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), features: ::Stripe::BillingPortal::ConfigurationService::CreateParams::Features, login_page: T.nilable(::Stripe::BillingPortal::ConfigurationService::CreateParams::LoginPage), metadata: T.nilable(T::Hash[String, String])).void
267
- }
268
- def initialize(
269
- business_profile: nil,
270
- default_return_url: nil,
271
- expand: nil,
272
- features: nil,
273
- login_page: nil,
274
- metadata: nil
275
- ); end
276
- end
277
- class RetrieveParams < Stripe::RequestParams
278
- # Specifies which fields in the response should be expanded.
279
- sig { returns(T.nilable(T::Array[String])) }
280
- attr_accessor :expand
281
- sig { params(expand: T.nilable(T::Array[String])).void }
282
- def initialize(expand: nil); end
283
- end
284
- class UpdateParams < Stripe::RequestParams
285
- class BusinessProfile < Stripe::RequestParams
286
- # The messaging shown to customers in the portal.
287
- sig { returns(T.nilable(T.nilable(String))) }
288
- attr_accessor :headline
289
- # A link to the business’s publicly available privacy policy.
290
- sig { returns(T.nilable(T.nilable(String))) }
291
- attr_accessor :privacy_policy_url
292
- # A link to the business’s publicly available terms of service.
293
- sig { returns(T.nilable(T.nilable(String))) }
294
- attr_accessor :terms_of_service_url
295
- sig {
296
- 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
297
- }
298
- def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
299
- end
300
- class Features < Stripe::RequestParams
301
- class CustomerUpdate < Stripe::RequestParams
302
- # The types of customer updates that are supported. When empty, customers are not updateable.
303
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
304
- attr_accessor :allowed_updates
305
- # Whether the feature is enabled.
306
- sig { returns(T.nilable(T::Boolean)) }
307
- attr_accessor :enabled
308
- sig {
309
- params(allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T.nilable(T::Boolean)).void
310
- }
311
- def initialize(allowed_updates: nil, enabled: nil); end
312
- end
313
- class InvoiceHistory < Stripe::RequestParams
314
- # Whether the feature is enabled.
315
- sig { returns(T::Boolean) }
316
- attr_accessor :enabled
317
- sig { params(enabled: T::Boolean).void }
318
- def initialize(enabled: nil); end
319
- end
320
- class PaymentMethodUpdate < Stripe::RequestParams
321
- # Whether the feature is enabled.
322
- sig { returns(T::Boolean) }
323
- attr_accessor :enabled
324
- sig { params(enabled: T::Boolean).void }
325
- def initialize(enabled: nil); end
326
- end
327
- class SubscriptionCancel < Stripe::RequestParams
328
- class CancellationReason < Stripe::RequestParams
329
- # Whether the feature is enabled.
330
- sig { returns(T::Boolean) }
331
- attr_accessor :enabled
332
- # Which cancellation reasons will be given as options to the customer.
333
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
334
- attr_accessor :options
335
- sig {
336
- params(enabled: T::Boolean, options: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
337
- }
338
- def initialize(enabled: nil, options: nil); end
339
- end
340
- # Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
341
- sig {
342
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel::CancellationReason))
343
- }
344
- attr_accessor :cancellation_reason
345
- # Whether the feature is enabled.
346
- sig { returns(T.nilable(T::Boolean)) }
347
- attr_accessor :enabled
348
- # Whether to cancel subscriptions immediately or at the end of the billing period.
349
- sig { returns(T.nilable(String)) }
350
- attr_accessor :mode
351
- # 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.
352
- sig { returns(T.nilable(String)) }
353
- attr_accessor :proration_behavior
354
- sig {
355
- params(cancellation_reason: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel::CancellationReason), enabled: T.nilable(T::Boolean), mode: T.nilable(String), proration_behavior: T.nilable(String)).void
356
- }
357
- def initialize(
358
- cancellation_reason: nil,
359
- enabled: nil,
360
- mode: nil,
361
- proration_behavior: nil
362
- ); end
363
- end
364
- class SubscriptionUpdate < Stripe::RequestParams
365
- class Product < Stripe::RequestParams
366
- class AdjustableQuantity < Stripe::RequestParams
367
- # Set to true if the quantity can be adjusted to any non-negative integer.
368
- sig { returns(T::Boolean) }
369
- attr_accessor :enabled
370
- # The maximum quantity that can be set for the product.
371
- sig { returns(T.nilable(Integer)) }
372
- attr_accessor :maximum
373
- # The minimum quantity that can be set for the product.
374
- sig { returns(T.nilable(Integer)) }
375
- attr_accessor :minimum
376
- sig {
377
- params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
378
- }
379
- def initialize(enabled: nil, maximum: nil, minimum: nil); end
380
- end
381
- # Control whether the quantity of the product can be adjusted.
382
- sig {
383
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity))
384
- }
385
- attr_accessor :adjustable_quantity
386
- # The list of price IDs for the product that a subscription can be updated to.
387
- sig { returns(T::Array[String]) }
388
- attr_accessor :prices
389
- # The product id.
390
- sig { returns(String) }
391
- attr_accessor :product
392
- sig {
393
- params(adjustable_quantity: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product::AdjustableQuantity), prices: T::Array[String], product: String).void
394
- }
395
- def initialize(adjustable_quantity: nil, prices: nil, product: nil); end
396
- end
397
- class ScheduleAtPeriodEnd < Stripe::RequestParams
398
- class Condition < Stripe::RequestParams
399
- # The type of condition.
400
- sig { returns(String) }
401
- attr_accessor :type
402
- sig { params(type: String).void }
403
- def initialize(type: nil); end
404
- end
405
- # List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
406
- sig {
407
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))))
408
- }
409
- attr_accessor :conditions
410
- sig {
411
- params(conditions: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])))).void
412
- }
413
- def initialize(conditions: nil); end
414
- end
415
- # The types of subscription updates that are supported. When empty, subscriptions are not updateable.
416
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
417
- attr_accessor :default_allowed_updates
418
- # Whether the feature is enabled.
419
- sig { returns(T.nilable(T::Boolean)) }
420
- attr_accessor :enabled
421
- # The list of up to 10 products that support subscription updates.
422
- sig {
423
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product]))))
424
- }
425
- attr_accessor :products
426
- # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
427
- sig { returns(T.nilable(String)) }
428
- attr_accessor :proration_behavior
429
- # Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
430
- sig {
431
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
432
- }
433
- attr_accessor :schedule_at_period_end
434
- sig {
435
- 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::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::Product]))), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).void
436
- }
437
- def initialize(
438
- default_allowed_updates: nil,
439
- enabled: nil,
440
- products: nil,
441
- proration_behavior: nil,
442
- schedule_at_period_end: nil
443
- ); end
444
- end
445
- # Information about updating the customer details in the portal.
446
- sig {
447
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::CustomerUpdate))
448
- }
449
- attr_accessor :customer_update
450
- # Information about showing the billing history in the portal.
451
- sig {
452
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::InvoiceHistory))
453
- }
454
- attr_accessor :invoice_history
455
- # Information about updating payment methods in the portal.
456
- sig {
457
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::PaymentMethodUpdate))
458
- }
459
- attr_accessor :payment_method_update
460
- # Information about canceling subscriptions in the portal.
461
- sig {
462
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel))
463
- }
464
- attr_accessor :subscription_cancel
465
- # Information about updating subscriptions in the portal.
466
- sig {
467
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate))
468
- }
469
- attr_accessor :subscription_update
470
- sig {
471
- params(customer_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features::SubscriptionUpdate)).void
472
- }
473
- def initialize(
474
- customer_update: nil,
475
- invoice_history: nil,
476
- payment_method_update: nil,
477
- subscription_cancel: nil,
478
- subscription_update: nil
479
- ); end
480
- end
481
- class LoginPage < Stripe::RequestParams
482
- # 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.
483
- #
484
- # Set to `false` to deactivate the `login_page.url`.
485
- sig { returns(T::Boolean) }
486
- attr_accessor :enabled
487
- sig { params(enabled: T::Boolean).void }
488
- def initialize(enabled: nil); end
489
- end
490
- # Whether the configuration is active and can be used to create portal sessions.
491
- sig { returns(T.nilable(T::Boolean)) }
492
- attr_accessor :active
493
- # The business information shown to customers in the portal.
494
- sig {
495
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::BusinessProfile))
496
- }
497
- attr_accessor :business_profile
498
- # 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.
499
- sig { returns(T.nilable(T.nilable(String))) }
500
- attr_accessor :default_return_url
501
- # Specifies which fields in the response should be expanded.
502
- sig { returns(T.nilable(T::Array[String])) }
503
- attr_accessor :expand
504
- # Information about the features available in the portal.
505
- sig {
506
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features))
507
- }
508
- attr_accessor :features
509
- # 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).
510
- sig {
511
- returns(T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::LoginPage))
512
- }
513
- attr_accessor :login_page
514
- # 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`.
515
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
516
- attr_accessor :metadata
517
- sig {
518
- params(active: T.nilable(T::Boolean), business_profile: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::BusinessProfile), default_return_url: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), features: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::Features), login_page: T.nilable(::Stripe::BillingPortal::ConfigurationService::UpdateParams::LoginPage), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
519
- }
520
- def initialize(
521
- active: nil,
522
- business_profile: nil,
523
- default_return_url: nil,
524
- expand: nil,
525
- features: nil,
526
- login_page: nil,
527
- metadata: nil
528
- ); end
529
- end
530
- # Creates a configuration that describes the functionality and behavior of a PortalSession
531
- sig {
532
- params(params: T.any(::Stripe::BillingPortal::ConfigurationService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Configuration)
533
- }
534
- def create(params = {}, opts = {}); end
535
-
536
- # Returns a list of configurations that describe the functionality of the customer portal.
537
- sig {
538
- params(params: T.any(::Stripe::BillingPortal::ConfigurationService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
539
- }
540
- def list(params = {}, opts = {}); end
541
-
542
- # Retrieves a configuration that describes the functionality of the customer portal.
543
- sig {
544
- params(configuration: String, params: T.any(::Stripe::BillingPortal::ConfigurationService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Configuration)
545
- }
546
- def retrieve(configuration, params = {}, opts = {}); end
547
-
548
- # Updates a configuration that describes the functionality of the customer portal.
549
- sig {
550
- params(configuration: String, params: T.any(::Stripe::BillingPortal::ConfigurationService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Configuration)
551
- }
552
- def update(configuration, params = {}, opts = {}); end
553
- end
554
- end
555
- end