stripe 15.3.0 → 15.4.0.pre.beta.2

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