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