stripe 15.4.0 → 15.5.0.pre.beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (596) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +1634 -662
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_requestor.rb +32 -0
  6. data/lib/stripe/api_version.rb +1 -2
  7. data/lib/stripe/errors.rb +60 -0
  8. data/lib/stripe/event_types.rb +102 -0
  9. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  10. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  16. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +23 -0
  18. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +21 -0
  19. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  21. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  22. data/lib/stripe/events/v2_core_account_link_returned_event.rb +13 -0
  23. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  24. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  25. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  26. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_payout_method_updated_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  52. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  53. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  58. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  59. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  60. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  61. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  62. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +22 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  65. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  66. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  67. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  68. data/lib/stripe/object_types.rb +53 -0
  69. data/lib/stripe/resources/account.rb +653 -1
  70. data/lib/stripe/resources/account_notice.rb +123 -0
  71. data/lib/stripe/resources/account_session.rb +256 -1
  72. data/lib/stripe/resources/balance_settings.rb +105 -0
  73. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  74. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  75. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  76. data/lib/stripe/resources/billing/meter_usage.rb +23 -0
  77. data/lib/stripe/resources/billing/meter_usage_row.rb +28 -0
  78. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  79. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  80. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  81. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  82. data/lib/stripe/resources/card.rb +2 -0
  83. data/lib/stripe/resources/cash_balance.rb +2 -0
  84. data/lib/stripe/resources/charge.rb +1538 -0
  85. data/lib/stripe/resources/checkout/session.rb +399 -3
  86. data/lib/stripe/resources/confirmation_token.rb +170 -0
  87. data/lib/stripe/resources/coupon.rb +30 -1
  88. data/lib/stripe/resources/credit_note.rb +6 -0
  89. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  90. data/lib/stripe/resources/customer.rb +2 -0
  91. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  92. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  93. data/lib/stripe/resources/customer_session.rb +6 -1
  94. data/lib/stripe/resources/discount.rb +2 -0
  95. data/lib/stripe/resources/dispute.rb +11 -0
  96. data/lib/stripe/resources/event.rb +31 -0
  97. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  98. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  99. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  100. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  101. data/lib/stripe/resources/fx_quote.rb +186 -0
  102. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  103. data/lib/stripe/resources/invoice.rb +1140 -16
  104. data/lib/stripe/resources/invoice_item.rb +78 -2
  105. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  106. data/lib/stripe/resources/invoice_payment.rb +2 -53
  107. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  108. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  109. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  110. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  111. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  112. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  113. data/lib/stripe/resources/line_item.rb +37 -0
  114. data/lib/stripe/resources/mandate.rb +24 -0
  115. data/lib/stripe/resources/margin.rb +115 -0
  116. data/lib/stripe/resources/order.rb +2958 -0
  117. data/lib/stripe/resources/payment_attempt_record.rb +1101 -0
  118. data/lib/stripe/resources/payment_intent.rb +9469 -3712
  119. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  120. data/lib/stripe/resources/payment_method.rb +192 -1
  121. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  122. data/lib/stripe/resources/payment_record.rb +1630 -0
  123. data/lib/stripe/resources/payout.rb +6 -0
  124. data/lib/stripe/resources/price.rb +30 -0
  125. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  126. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  127. data/lib/stripe/resources/promotion_code.rb +10 -0
  128. data/lib/stripe/resources/quote.rb +2038 -7
  129. data/lib/stripe/resources/quote_line.rb +274 -0
  130. data/lib/stripe/resources/quote_preview_invoice.rb +680 -0
  131. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +371 -0
  132. data/lib/stripe/resources/refund.rb +9 -0
  133. data/lib/stripe/resources/setup_attempt.rb +21 -0
  134. data/lib/stripe/resources/setup_intent.rb +578 -9
  135. data/lib/stripe/resources/source.rb +29 -0
  136. data/lib/stripe/resources/subscription.rb +365 -9
  137. data/lib/stripe/resources/subscription_item.rb +84 -3
  138. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  139. data/lib/stripe/resources/tax/association.rb +66 -0
  140. data/lib/stripe/resources/tax/form.rb +211 -0
  141. data/lib/stripe/resources/tax_id.rb +12 -2
  142. data/lib/stripe/resources/terminal/onboarding_link.rb +84 -0
  143. data/lib/stripe/resources/terminal/reader.rb +8 -0
  144. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  145. data/lib/stripe/resources/transfer.rb +6 -0
  146. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  147. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  148. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  149. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  150. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  151. data/lib/stripe/resources/v2/core/account.rb +1930 -0
  152. data/lib/stripe/resources/v2/core/account_link.rb +72 -0
  153. data/lib/stripe/resources/v2/core/person.rb +276 -0
  154. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  155. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  156. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  157. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  158. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  159. data/lib/stripe/resources/v2/money_management/financial_account.rb +77 -0
  160. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  161. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  162. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  163. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  164. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  165. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  166. data/lib/stripe/resources/v2/money_management/payout_method.rb +77 -0
  167. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  168. data/lib/stripe/resources/v2/money_management/received_credit.rb +122 -0
  169. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  170. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  171. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  172. data/lib/stripe/resources/v2/payments/off_session_payment.rb +89 -0
  173. data/lib/stripe/resources.rb +109 -0
  174. data/lib/stripe/services/account_notice_service.rb +101 -0
  175. data/lib/stripe/services/account_service.rb +562 -1
  176. data/lib/stripe/services/account_session_service.rb +226 -1
  177. data/lib/stripe/services/balance_settings_service.rb +96 -0
  178. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  179. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  180. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  181. data/lib/stripe/services/billing/meter_usage_service.rb +76 -0
  182. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  183. data/lib/stripe/services/billing_service.rb +2 -1
  184. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  185. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  186. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  187. data/lib/stripe/services/capital_service.rb +15 -0
  188. data/lib/stripe/services/charge_service.rb +1418 -0
  189. data/lib/stripe/services/checkout/session_service.rb +316 -3
  190. data/lib/stripe/services/coupon_service.rb +17 -1
  191. data/lib/stripe/services/credit_note_service.rb +4 -0
  192. data/lib/stripe/services/customer_session_service.rb +4 -1
  193. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  194. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  195. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  196. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  197. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  198. data/lib/stripe/services/financial_connections_service.rb +2 -1
  199. data/lib/stripe/services/fx_quote_service.rb +123 -0
  200. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  201. data/lib/stripe/services/invoice_item_service.rb +74 -2
  202. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  203. data/lib/stripe/services/invoice_service.rb +1074 -16
  204. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  205. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  206. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  207. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  208. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  209. data/lib/stripe/services/issuing_service.rb +5 -1
  210. data/lib/stripe/services/margin_service.rb +119 -0
  211. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  212. data/lib/stripe/services/order_service.rb +2388 -0
  213. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  214. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  215. data/lib/stripe/services/payment_intent_service.rb +5724 -435
  216. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  217. data/lib/stripe/services/payment_method_service.rb +120 -1
  218. data/lib/stripe/services/payment_record_service.rb +542 -0
  219. data/lib/stripe/services/payout_service.rb +4 -0
  220. data/lib/stripe/services/price_service.rb +19 -0
  221. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  222. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  223. data/lib/stripe/services/privacy_service.rb +13 -0
  224. data/lib/stripe/services/promotion_code_service.rb +8 -0
  225. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  226. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  227. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  228. data/lib/stripe/services/quote_service.rb +1723 -8
  229. data/lib/stripe/services/setup_intent_service.rb +538 -9
  230. data/lib/stripe/services/subscription_item_service.rb +75 -3
  231. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  232. data/lib/stripe/services/subscription_service.rb +309 -9
  233. data/lib/stripe/services/tax/association_service.rb +31 -0
  234. data/lib/stripe/services/tax/form_service.rb +100 -0
  235. data/lib/stripe/services/tax_id_service.rb +8 -2
  236. data/lib/stripe/services/tax_service.rb +3 -1
  237. data/lib/stripe/services/terminal/onboarding_link_service.rb +56 -0
  238. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  239. data/lib/stripe/services/terminal_service.rb +3 -1
  240. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  241. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  242. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  243. data/lib/stripe/services/transfer_service.rb +4 -0
  244. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  245. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  246. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  247. data/lib/stripe/services/v1_services.rb +11 -2
  248. data/lib/stripe/services/v2/core/account_link_service.rb +114 -0
  249. data/lib/stripe/services/v2/core/account_service.rb +4522 -0
  250. data/lib/stripe/services/v2/core/accounts/person_service.rb +1045 -0
  251. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +130 -0
  252. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  253. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  254. data/lib/stripe/services/v2/core_service.rb +4 -1
  255. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  256. data/lib/stripe/services/v2/money_management/financial_account_service.rb +116 -0
  257. data/lib/stripe/services/v2/money_management/financial_address_service.rb +82 -0
  258. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  259. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  260. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +199 -0
  261. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  262. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  263. data/lib/stripe/services/v2/money_management/payout_method_service.rb +90 -0
  264. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  265. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  266. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  267. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  268. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  269. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  270. data/lib/stripe/services/v2/payment_service.rb +15 -0
  271. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +152 -0
  272. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  273. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +53 -0
  274. data/lib/stripe/services/v2_services.rb +4 -1
  275. data/lib/stripe/services.rb +55 -1
  276. data/lib/stripe/stripe_configuration.rb +3 -1
  277. data/lib/stripe/stripe_object.rb +1 -1
  278. data/lib/stripe/util.rb +7 -1
  279. data/lib/stripe/version.rb +1 -1
  280. data/lib/stripe.rb +53 -0
  281. data/rbi/stripe.rbi +199016 -0
  282. data/stripe.gemspec +4 -1
  283. metadata +168 -324
  284. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  285. data/rbi/stripe/resources/account.rbi +0 -4995
  286. data/rbi/stripe/resources/account_link.rbi +0 -76
  287. data/rbi/stripe/resources/account_session.rbi +0 -1074
  288. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  289. data/rbi/stripe/resources/application.rbi +0 -20
  290. data/rbi/stripe/resources/application_fee.rbi +0 -118
  291. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  292. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  293. data/rbi/stripe/resources/balance.rbi +0 -235
  294. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  295. data/rbi/stripe/resources/bank_account.rbi +0 -127
  296. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  297. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  298. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  299. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  300. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  301. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  302. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  303. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  304. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  305. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -703
  306. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  307. data/rbi/stripe/resources/capability.rbi +0 -125
  308. data/rbi/stripe/resources/card.rbi +0 -125
  309. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  310. data/rbi/stripe/resources/charge.rbi +0 -2089
  311. data/rbi/stripe/resources/checkout/session.rbi +0 -4095
  312. data/rbi/stripe/resources/climate/order.rbi +0 -245
  313. data/rbi/stripe/resources/climate/product.rbi +0 -75
  314. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  315. data/rbi/stripe/resources/confirmation_token.rbi +0 -1818
  316. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  317. data/rbi/stripe/resources/country_spec.rbi +0 -85
  318. data/rbi/stripe/resources/coupon.rbi +0 -250
  319. data/rbi/stripe/resources/credit_note.rbi +0 -752
  320. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  321. data/rbi/stripe/resources/customer.rbi +0 -1005
  322. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  323. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  324. data/rbi/stripe/resources/customer_session.rbi +0 -200
  325. data/rbi/stripe/resources/discount.rbi +0 -53
  326. data/rbi/stripe/resources/dispute.rbi +0 -761
  327. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  328. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  329. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  330. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  331. data/rbi/stripe/resources/event.rbi +0 -137
  332. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  333. data/rbi/stripe/resources/file.rbi +0 -143
  334. data/rbi/stripe/resources/file_link.rbi +0 -141
  335. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  336. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  337. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  338. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  339. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  340. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  341. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  342. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  343. data/rbi/stripe/resources/identity/verification_session.rbi +0 -564
  344. data/rbi/stripe/resources/invoice.rbi +0 -3858
  345. data/rbi/stripe/resources/invoice_item.rbi +0 -470
  346. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  347. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  348. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  349. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  350. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  351. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  352. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  353. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  354. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  355. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  356. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  357. data/rbi/stripe/resources/line_item.rbi +0 -72
  358. data/rbi/stripe/resources/login_link.rbi +0 -19
  359. data/rbi/stripe/resources/mandate.rbi +0 -191
  360. data/rbi/stripe/resources/payment_intent.rbi +0 -9997
  361. data/rbi/stripe/resources/payment_link.rbi +0 -1893
  362. data/rbi/stripe/resources/payment_method.rbi +0 -1770
  363. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  364. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  365. data/rbi/stripe/resources/payout.rbi +0 -300
  366. data/rbi/stripe/resources/person.rbi +0 -401
  367. data/rbi/stripe/resources/plan.rbi +0 -371
  368. data/rbi/stripe/resources/price.rbi +0 -694
  369. data/rbi/stripe/resources/product.rbi +0 -555
  370. data/rbi/stripe/resources/product_feature.rbi +0 -26
  371. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  372. data/rbi/stripe/resources/quote.rbi +0 -1145
  373. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  374. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  375. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  376. data/rbi/stripe/resources/refund.rbi +0 -523
  377. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  378. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  379. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  380. data/rbi/stripe/resources/reversal.rbi +0 -51
  381. data/rbi/stripe/resources/review.rbi +0 -154
  382. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  383. data/rbi/stripe/resources/setup_intent.rbi +0 -3978
  384. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  385. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  386. data/rbi/stripe/resources/source.rbi +0 -1496
  387. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  388. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  389. data/rbi/stripe/resources/subscription.rbi +0 -2080
  390. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  391. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1673
  392. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  393. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  394. data/rbi/stripe/resources/tax/registration.rbi +0 -3216
  395. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  396. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  397. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  398. data/rbi/stripe/resources/tax_code.rbi +0 -44
  399. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  400. data/rbi/stripe/resources/tax_id.rbi +0 -165
  401. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  402. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1595
  403. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  404. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  405. data/rbi/stripe/resources/terminal/reader.rbi +0 -994
  406. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  407. data/rbi/stripe/resources/token.rbi +0 -1283
  408. data/rbi/stripe/resources/topup.rbi +0 -222
  409. data/rbi/stripe/resources/transfer.rbi +0 -199
  410. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  411. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  412. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -869
  413. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  414. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  415. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  416. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  417. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  418. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  419. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  420. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  421. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  422. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  423. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  424. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  425. data/rbi/stripe/resources/v2/event.rbi +0 -48
  426. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  427. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  428. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  429. data/rbi/stripe/services/account_link_service.rbi +0 -60
  430. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  431. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  432. data/rbi/stripe/services/account_service.rbi +0 -4281
  433. data/rbi/stripe/services/account_session_service.rbi +0 -685
  434. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  435. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  436. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  437. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  438. data/rbi/stripe/services/apps_service.rbi +0 -9
  439. data/rbi/stripe/services/balance_service.rbi +0 -21
  440. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  441. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  442. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  443. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  444. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  445. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  446. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  447. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  448. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  449. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -555
  450. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  451. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  452. data/rbi/stripe/services/billing_service.rbi +0 -15
  453. data/rbi/stripe/services/charge_service.rbi +0 -448
  454. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  455. data/rbi/stripe/services/checkout/session_service.rbi +0 -2690
  456. data/rbi/stripe/services/checkout_service.rbi +0 -9
  457. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  458. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  459. data/rbi/stripe/services/climate_service.rbi +0 -11
  460. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  461. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  462. data/rbi/stripe/services/coupon_service.rbi +0 -194
  463. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  464. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  465. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  466. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  467. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  468. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  469. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  470. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  471. data/rbi/stripe/services/customer_service.rbi +0 -647
  472. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  473. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  474. data/rbi/stripe/services/dispute_service.rbi +0 -424
  475. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  476. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  477. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  478. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  479. data/rbi/stripe/services/event_service.rbi +0 -83
  480. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  481. data/rbi/stripe/services/file_link_service.rbi +0 -124
  482. data/rbi/stripe/services/file_service.rbi +0 -116
  483. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  484. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  485. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  486. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  487. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  488. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  489. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  490. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  491. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -339
  492. data/rbi/stripe/services/identity_service.rbi +0 -10
  493. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  494. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  495. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  496. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  497. data/rbi/stripe/services/invoice_service.rbi +0 -3027
  498. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  499. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  500. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  501. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  502. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  503. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  504. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  505. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  506. data/rbi/stripe/services/issuing_service.rbi +0 -16
  507. data/rbi/stripe/services/mandate_service.rbi +0 -20
  508. data/rbi/stripe/services/payment_intent_service.rbi +0 -7994
  509. data/rbi/stripe/services/payment_link_service.rbi +0 -1441
  510. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  511. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  512. data/rbi/stripe/services/payment_method_service.rbi +0 -781
  513. data/rbi/stripe/services/payout_service.rbi +0 -205
  514. data/rbi/stripe/services/plan_service.rbi +0 -282
  515. data/rbi/stripe/services/price_service.rbi +0 -546
  516. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  517. data/rbi/stripe/services/product_service.rbi +0 -477
  518. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  519. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  520. data/rbi/stripe/services/quote_service.rbi +0 -699
  521. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  522. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  523. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  524. data/rbi/stripe/services/radar_service.rbi +0 -11
  525. data/rbi/stripe/services/refund_service.rbi +0 -185
  526. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  527. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  528. data/rbi/stripe/services/reporting_service.rbi +0 -10
  529. data/rbi/stripe/services/review_service.rbi +0 -84
  530. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  531. data/rbi/stripe/services/setup_intent_service.rbi +0 -3709
  532. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  533. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  534. data/rbi/stripe/services/sigma_service.rbi +0 -9
  535. data/rbi/stripe/services/source_service.rbi +0 -663
  536. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  537. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1333
  538. data/rbi/stripe/services/subscription_service.rbi +0 -1684
  539. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  540. data/rbi/stripe/services/tax/registration_service.rbi +0 -2278
  541. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  542. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  543. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  544. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  545. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  546. data/rbi/stripe/services/tax_service.rbi +0 -12
  547. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1286
  548. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  549. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  550. data/rbi/stripe/services/terminal/reader_service.rbi +0 -540
  551. data/rbi/stripe/services/terminal_service.rbi +0 -12
  552. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  553. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  554. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  555. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  556. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  557. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  558. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  559. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  560. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  561. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  562. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  563. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  564. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  565. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  566. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  567. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  568. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  569. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  570. data/rbi/stripe/services/token_service.rbi +0 -1257
  571. data/rbi/stripe/services/topup_service.rbi +0 -176
  572. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  573. data/rbi/stripe/services/transfer_service.rbi +0 -152
  574. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  575. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  576. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  577. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  578. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  579. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  580. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  581. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  582. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  583. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  584. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  585. data/rbi/stripe/services/treasury_service.rbi +0 -18
  586. data/rbi/stripe/services/v1_services.rbi +0 -77
  587. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  588. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  589. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  590. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  591. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  592. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  593. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  594. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  595. data/rbi/stripe/services/v2_services.rbi +0 -10
  596. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,1005 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information,
7
- # and track payments that belong to the same customer.
8
- class Customer < APIResource
9
- class Address < Stripe::StripeObject
10
- # City, district, suburb, town, or village.
11
- sig { returns(T.nilable(String)) }
12
- attr_reader :city
13
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
14
- sig { returns(T.nilable(String)) }
15
- attr_reader :country
16
- # Address line 1 (e.g., street, PO Box, or company name).
17
- sig { returns(T.nilable(String)) }
18
- attr_reader :line1
19
- # Address line 2 (e.g., apartment, suite, unit, or building).
20
- sig { returns(T.nilable(String)) }
21
- attr_reader :line2
22
- # ZIP or postal code.
23
- sig { returns(T.nilable(String)) }
24
- attr_reader :postal_code
25
- # State, county, province, or region.
26
- sig { returns(T.nilable(String)) }
27
- attr_reader :state
28
- end
29
- class InvoiceSettings < Stripe::StripeObject
30
- class CustomField < Stripe::StripeObject
31
- # The name of the custom field.
32
- sig { returns(String) }
33
- attr_reader :name
34
- # The value of the custom field.
35
- sig { returns(String) }
36
- attr_reader :value
37
- end
38
- class RenderingOptions < Stripe::StripeObject
39
- # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
40
- sig { returns(T.nilable(String)) }
41
- attr_reader :amount_tax_display
42
- # ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.
43
- sig { returns(T.nilable(String)) }
44
- attr_reader :template
45
- end
46
- # Default custom fields to be displayed on invoices for this customer.
47
- sig { returns(T.nilable(T::Array[CustomField])) }
48
- attr_reader :custom_fields
49
- # ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
50
- sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
51
- attr_reader :default_payment_method
52
- # Default footer to be displayed on invoices for this customer.
53
- sig { returns(T.nilable(String)) }
54
- attr_reader :footer
55
- # Default options for invoice PDF rendering for this customer.
56
- sig { returns(T.nilable(RenderingOptions)) }
57
- attr_reader :rendering_options
58
- end
59
- class Shipping < Stripe::StripeObject
60
- class Address < Stripe::StripeObject
61
- # City, district, suburb, town, or village.
62
- sig { returns(T.nilable(String)) }
63
- attr_reader :city
64
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
65
- sig { returns(T.nilable(String)) }
66
- attr_reader :country
67
- # Address line 1 (e.g., street, PO Box, or company name).
68
- sig { returns(T.nilable(String)) }
69
- attr_reader :line1
70
- # Address line 2 (e.g., apartment, suite, unit, or building).
71
- sig { returns(T.nilable(String)) }
72
- attr_reader :line2
73
- # ZIP or postal code.
74
- sig { returns(T.nilable(String)) }
75
- attr_reader :postal_code
76
- # State, county, province, or region.
77
- sig { returns(T.nilable(String)) }
78
- attr_reader :state
79
- end
80
- # Attribute for field address
81
- sig { returns(Address) }
82
- attr_reader :address
83
- # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
84
- sig { returns(T.nilable(String)) }
85
- attr_reader :carrier
86
- # Recipient name.
87
- sig { returns(String) }
88
- attr_reader :name
89
- # Recipient phone (including extension).
90
- sig { returns(T.nilable(String)) }
91
- attr_reader :phone
92
- # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
93
- sig { returns(T.nilable(String)) }
94
- attr_reader :tracking_number
95
- end
96
- class Tax < Stripe::StripeObject
97
- class Location < Stripe::StripeObject
98
- # The identified tax country of the customer.
99
- sig { returns(String) }
100
- attr_reader :country
101
- # The data source used to infer the customer's location.
102
- sig { returns(String) }
103
- attr_reader :source
104
- # The identified tax state, county, province, or region of the customer.
105
- sig { returns(T.nilable(String)) }
106
- attr_reader :state
107
- end
108
- # Surfaces if automatic tax computation is possible given the current customer location information.
109
- sig { returns(String) }
110
- attr_reader :automatic_tax
111
- # A recent IP address of the customer used for tax reporting and tax location inference.
112
- sig { returns(T.nilable(String)) }
113
- attr_reader :ip_address
114
- # The identified tax location of the customer.
115
- sig { returns(T.nilable(Location)) }
116
- attr_reader :location
117
- end
118
- # The customer's address.
119
- sig { returns(T.nilable(Address)) }
120
- attr_reader :address
121
- # The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance).
122
- sig { returns(Integer) }
123
- attr_reader :balance
124
- # The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.
125
- sig { returns(T.nilable(Stripe::CashBalance)) }
126
- attr_reader :cash_balance
127
- # Time at which the object was created. Measured in seconds since the Unix epoch.
128
- sig { returns(Integer) }
129
- attr_reader :created
130
- # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.
131
- sig { returns(T.nilable(String)) }
132
- attr_reader :currency
133
- # ID of the default payment source for the customer.
134
- #
135
- # If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.
136
- sig {
137
- returns(T.nilable(T.any(String, T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))))
138
- }
139
- attr_reader :default_source
140
- # Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.
141
- #
142
- # If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.
143
- #
144
- # If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.
145
- sig { returns(T.nilable(T::Boolean)) }
146
- attr_reader :delinquent
147
- # An arbitrary string attached to the object. Often useful for displaying to users.
148
- sig { returns(T.nilable(String)) }
149
- attr_reader :description
150
- # Describes the current discount active on the customer, if there is one.
151
- sig { returns(T.nilable(Stripe::Discount)) }
152
- attr_reader :discount
153
- # The customer's email address.
154
- sig { returns(T.nilable(String)) }
155
- attr_reader :email
156
- # Unique identifier for the object.
157
- sig { returns(String) }
158
- attr_reader :id
159
- # The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.
160
- sig { returns(T::Hash[String, Integer]) }
161
- attr_reader :invoice_credit_balance
162
- # The prefix for the customer used to generate unique invoice numbers.
163
- sig { returns(T.nilable(String)) }
164
- attr_reader :invoice_prefix
165
- # Attribute for field invoice_settings
166
- sig { returns(InvoiceSettings) }
167
- attr_reader :invoice_settings
168
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
169
- sig { returns(T::Boolean) }
170
- attr_reader :livemode
171
- # 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.
172
- sig { returns(T::Hash[String, String]) }
173
- attr_reader :metadata
174
- # The customer's full name or business name.
175
- sig { returns(T.nilable(String)) }
176
- attr_reader :name
177
- # The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.
178
- sig { returns(Integer) }
179
- attr_reader :next_invoice_sequence
180
- # String representing the object's type. Objects of the same type share the same value.
181
- sig { returns(String) }
182
- attr_reader :object
183
- # The customer's phone number.
184
- sig { returns(T.nilable(String)) }
185
- attr_reader :phone
186
- # The customer's preferred locales (languages), ordered by preference.
187
- sig { returns(T.nilable(T::Array[String])) }
188
- attr_reader :preferred_locales
189
- # Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
190
- sig { returns(T.nilable(Shipping)) }
191
- attr_reader :shipping
192
- # The customer's payment sources, if any.
193
- sig { returns(Stripe::ListObject) }
194
- attr_reader :sources
195
- # The customer's current subscriptions, if any.
196
- sig { returns(Stripe::ListObject) }
197
- attr_reader :subscriptions
198
- # Attribute for field tax
199
- sig { returns(Tax) }
200
- attr_reader :tax
201
- # Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**.
202
- sig { returns(T.nilable(String)) }
203
- attr_reader :tax_exempt
204
- # The customer's tax IDs.
205
- sig { returns(Stripe::ListObject) }
206
- attr_reader :tax_ids
207
- # ID of the test clock that this customer belongs to.
208
- sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
209
- attr_reader :test_clock
210
- # Always true for a deleted object
211
- sig { returns(T::Boolean) }
212
- attr_reader :deleted
213
- class DeleteParams < Stripe::RequestParams; end
214
- class UpdateParams < Stripe::RequestParams
215
- class Address < Stripe::RequestParams
216
- # City, district, suburb, town, or village.
217
- sig { returns(T.nilable(String)) }
218
- attr_accessor :city
219
- # A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
220
- sig { returns(T.nilable(String)) }
221
- attr_accessor :country
222
- # Address line 1 (e.g., street, PO Box, or company name).
223
- sig { returns(T.nilable(String)) }
224
- attr_accessor :line1
225
- # Address line 2 (e.g., apartment, suite, unit, or building).
226
- sig { returns(T.nilable(String)) }
227
- attr_accessor :line2
228
- # ZIP or postal code.
229
- sig { returns(T.nilable(String)) }
230
- attr_accessor :postal_code
231
- # State, county, province, or region.
232
- sig { returns(T.nilable(String)) }
233
- attr_accessor :state
234
- sig {
235
- params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
236
- }
237
- def initialize(
238
- city: nil,
239
- country: nil,
240
- line1: nil,
241
- line2: nil,
242
- postal_code: nil,
243
- state: nil
244
- ); end
245
- end
246
- class CashBalance < Stripe::RequestParams
247
- class Settings < Stripe::RequestParams
248
- # Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
249
- sig { returns(T.nilable(String)) }
250
- attr_accessor :reconciliation_mode
251
- sig { params(reconciliation_mode: T.nilable(String)).void }
252
- def initialize(reconciliation_mode: nil); end
253
- end
254
- # Settings controlling the behavior of the customer's cash balance,
255
- # such as reconciliation of funds received.
256
- sig { returns(T.nilable(::Stripe::Customer::UpdateParams::CashBalance::Settings)) }
257
- attr_accessor :settings
258
- sig {
259
- params(settings: T.nilable(::Stripe::Customer::UpdateParams::CashBalance::Settings)).void
260
- }
261
- def initialize(settings: nil); end
262
- end
263
- class InvoiceSettings < Stripe::RequestParams
264
- class CustomField < Stripe::RequestParams
265
- # The name of the custom field. This may be up to 40 characters.
266
- sig { returns(String) }
267
- attr_accessor :name
268
- # The value of the custom field. This may be up to 140 characters.
269
- sig { returns(String) }
270
- attr_accessor :value
271
- sig { params(name: String, value: String).void }
272
- def initialize(name: nil, value: nil); end
273
- end
274
- class RenderingOptions < Stripe::RequestParams
275
- # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
276
- sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
277
- attr_accessor :amount_tax_display
278
- # ID of the invoice rendering template to use for future invoices.
279
- sig { returns(T.nilable(String)) }
280
- attr_accessor :template
281
- sig {
282
- params(amount_tax_display: T.nilable(T.nilable(T.any(String, String))), template: T.nilable(String)).void
283
- }
284
- def initialize(amount_tax_display: nil, template: nil); end
285
- end
286
- # The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
287
- sig {
288
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Customer::UpdateParams::InvoiceSettings::CustomField]))))
289
- }
290
- attr_accessor :custom_fields
291
- # ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
292
- sig { returns(T.nilable(String)) }
293
- attr_accessor :default_payment_method
294
- # Default footer to be displayed on invoices for this customer.
295
- sig { returns(T.nilable(String)) }
296
- attr_accessor :footer
297
- # Default options for invoice PDF rendering for this customer.
298
- sig {
299
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::InvoiceSettings::RenderingOptions))))
300
- }
301
- attr_accessor :rendering_options
302
- sig {
303
- params(custom_fields: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Customer::UpdateParams::InvoiceSettings::CustomField]))), default_payment_method: T.nilable(String), footer: T.nilable(String), rendering_options: T.nilable(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::InvoiceSettings::RenderingOptions)))).void
304
- }
305
- def initialize(
306
- custom_fields: nil,
307
- default_payment_method: nil,
308
- footer: nil,
309
- rendering_options: nil
310
- ); end
311
- end
312
- class Shipping < Stripe::RequestParams
313
- class Address < Stripe::RequestParams
314
- # City, district, suburb, town, or village.
315
- sig { returns(T.nilable(String)) }
316
- attr_accessor :city
317
- # A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
318
- sig { returns(T.nilable(String)) }
319
- attr_accessor :country
320
- # Address line 1 (e.g., street, PO Box, or company name).
321
- sig { returns(T.nilable(String)) }
322
- attr_accessor :line1
323
- # Address line 2 (e.g., apartment, suite, unit, or building).
324
- sig { returns(T.nilable(String)) }
325
- attr_accessor :line2
326
- # ZIP or postal code.
327
- sig { returns(T.nilable(String)) }
328
- attr_accessor :postal_code
329
- # State, county, province, or region.
330
- sig { returns(T.nilable(String)) }
331
- attr_accessor :state
332
- sig {
333
- params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
334
- }
335
- def initialize(
336
- city: nil,
337
- country: nil,
338
- line1: nil,
339
- line2: nil,
340
- postal_code: nil,
341
- state: nil
342
- ); end
343
- end
344
- # Customer shipping address.
345
- sig { returns(::Stripe::Customer::UpdateParams::Shipping::Address) }
346
- attr_accessor :address
347
- # Customer name.
348
- sig { returns(String) }
349
- attr_accessor :name
350
- # Customer phone (including extension).
351
- sig { returns(T.nilable(String)) }
352
- attr_accessor :phone
353
- sig {
354
- params(address: ::Stripe::Customer::UpdateParams::Shipping::Address, name: String, phone: T.nilable(String)).void
355
- }
356
- def initialize(address: nil, name: nil, phone: nil); end
357
- end
358
- class Tax < Stripe::RequestParams
359
- # A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
360
- sig { returns(T.nilable(T.nilable(String))) }
361
- attr_accessor :ip_address
362
- # A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.
363
- sig { returns(T.nilable(String)) }
364
- attr_accessor :validate_location
365
- sig {
366
- params(ip_address: T.nilable(T.nilable(String)), validate_location: T.nilable(String)).void
367
- }
368
- def initialize(ip_address: nil, validate_location: nil); end
369
- end
370
- # The customer's address.
371
- sig {
372
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Address))))
373
- }
374
- attr_accessor :address
375
- # An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
376
- sig { returns(T.nilable(Integer)) }
377
- attr_accessor :balance
378
- # Balance information and default balance settings for this customer.
379
- sig { returns(T.nilable(::Stripe::Customer::UpdateParams::CashBalance)) }
380
- attr_accessor :cash_balance
381
- # If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.
382
- #
383
- # Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.
384
- #
385
- # If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.
386
- sig { returns(T.nilable(String)) }
387
- attr_accessor :default_source
388
- # An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
389
- sig { returns(T.nilable(String)) }
390
- attr_accessor :description
391
- # Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
392
- sig { returns(T.nilable(String)) }
393
- attr_accessor :email
394
- # Specifies which fields in the response should be expanded.
395
- sig { returns(T.nilable(T::Array[String])) }
396
- attr_accessor :expand
397
- # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
398
- sig { returns(T.nilable(String)) }
399
- attr_accessor :invoice_prefix
400
- # Default invoice settings for this customer.
401
- sig { returns(T.nilable(::Stripe::Customer::UpdateParams::InvoiceSettings)) }
402
- attr_accessor :invoice_settings
403
- # 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`.
404
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
405
- attr_accessor :metadata
406
- # The customer's full name or business name.
407
- sig { returns(T.nilable(String)) }
408
- attr_accessor :name
409
- # The sequence to be used on the customer's next invoice. Defaults to 1.
410
- sig { returns(T.nilable(Integer)) }
411
- attr_accessor :next_invoice_sequence
412
- # The customer's phone number.
413
- sig { returns(T.nilable(String)) }
414
- attr_accessor :phone
415
- # Customer's preferred languages, ordered by preference.
416
- sig { returns(T.nilable(T::Array[String])) }
417
- attr_accessor :preferred_locales
418
- # The customer's shipping information. Appears on invoices emailed to this customer.
419
- sig {
420
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Shipping))))
421
- }
422
- attr_accessor :shipping
423
- # Attribute for param field source
424
- sig { returns(T.nilable(String)) }
425
- attr_accessor :source
426
- # Tax details about the customer.
427
- sig { returns(T.nilable(::Stripe::Customer::UpdateParams::Tax)) }
428
- attr_accessor :tax
429
- # The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
430
- sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
431
- attr_accessor :tax_exempt
432
- # Attribute for param field validate
433
- sig { returns(T.nilable(T::Boolean)) }
434
- attr_accessor :validate
435
- sig {
436
- params(address: T.nilable(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Address))), balance: T.nilable(Integer), cash_balance: T.nilable(::Stripe::Customer::UpdateParams::CashBalance), default_source: T.nilable(String), description: T.nilable(String), email: T.nilable(String), expand: T.nilable(T::Array[String]), invoice_prefix: T.nilable(String), invoice_settings: T.nilable(::Stripe::Customer::UpdateParams::InvoiceSettings), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), name: T.nilable(String), next_invoice_sequence: T.nilable(Integer), phone: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), shipping: T.nilable(T.nilable(T.any(String, ::Stripe::Customer::UpdateParams::Shipping))), source: T.nilable(String), tax: T.nilable(::Stripe::Customer::UpdateParams::Tax), tax_exempt: T.nilable(T.nilable(T.any(String, String))), validate: T.nilable(T::Boolean)).void
437
- }
438
- def initialize(
439
- address: nil,
440
- balance: nil,
441
- cash_balance: nil,
442
- default_source: nil,
443
- description: nil,
444
- email: nil,
445
- expand: nil,
446
- invoice_prefix: nil,
447
- invoice_settings: nil,
448
- metadata: nil,
449
- name: nil,
450
- next_invoice_sequence: nil,
451
- phone: nil,
452
- preferred_locales: nil,
453
- shipping: nil,
454
- source: nil,
455
- tax: nil,
456
- tax_exempt: nil,
457
- validate: nil
458
- ); end
459
- end
460
- class DeleteDiscountParams < Stripe::RequestParams; end
461
- class ListParams < Stripe::RequestParams
462
- class Created < Stripe::RequestParams
463
- # Minimum value to filter by (exclusive)
464
- sig { returns(T.nilable(Integer)) }
465
- attr_accessor :gt
466
- # Minimum value to filter by (inclusive)
467
- sig { returns(T.nilable(Integer)) }
468
- attr_accessor :gte
469
- # Maximum value to filter by (exclusive)
470
- sig { returns(T.nilable(Integer)) }
471
- attr_accessor :lt
472
- # Maximum value to filter by (inclusive)
473
- sig { returns(T.nilable(Integer)) }
474
- attr_accessor :lte
475
- sig {
476
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
477
- }
478
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
479
- end
480
- # Only return customers that were created during the given date interval.
481
- sig { returns(T.nilable(T.any(::Stripe::Customer::ListParams::Created, Integer))) }
482
- attr_accessor :created
483
- # A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.
484
- sig { returns(T.nilable(String)) }
485
- attr_accessor :email
486
- # 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.
487
- sig { returns(T.nilable(String)) }
488
- attr_accessor :ending_before
489
- # Specifies which fields in the response should be expanded.
490
- sig { returns(T.nilable(T::Array[String])) }
491
- attr_accessor :expand
492
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
493
- sig { returns(T.nilable(Integer)) }
494
- attr_accessor :limit
495
- # 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.
496
- sig { returns(T.nilable(String)) }
497
- attr_accessor :starting_after
498
- # Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.
499
- sig { returns(T.nilable(String)) }
500
- attr_accessor :test_clock
501
- sig {
502
- params(created: T.nilable(T.any(::Stripe::Customer::ListParams::Created, Integer)), email: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), test_clock: T.nilable(String)).void
503
- }
504
- def initialize(
505
- created: nil,
506
- email: nil,
507
- ending_before: nil,
508
- expand: nil,
509
- limit: nil,
510
- starting_after: nil,
511
- test_clock: nil
512
- ); end
513
- end
514
- class CreateParams < Stripe::RequestParams
515
- class Address < Stripe::RequestParams
516
- # City, district, suburb, town, or village.
517
- sig { returns(T.nilable(String)) }
518
- attr_accessor :city
519
- # A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
520
- sig { returns(T.nilable(String)) }
521
- attr_accessor :country
522
- # Address line 1 (e.g., street, PO Box, or company name).
523
- sig { returns(T.nilable(String)) }
524
- attr_accessor :line1
525
- # Address line 2 (e.g., apartment, suite, unit, or building).
526
- sig { returns(T.nilable(String)) }
527
- attr_accessor :line2
528
- # ZIP or postal code.
529
- sig { returns(T.nilable(String)) }
530
- attr_accessor :postal_code
531
- # State, county, province, or region.
532
- sig { returns(T.nilable(String)) }
533
- attr_accessor :state
534
- sig {
535
- params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
536
- }
537
- def initialize(
538
- city: nil,
539
- country: nil,
540
- line1: nil,
541
- line2: nil,
542
- postal_code: nil,
543
- state: nil
544
- ); end
545
- end
546
- class CashBalance < Stripe::RequestParams
547
- class Settings < Stripe::RequestParams
548
- # Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
549
- sig { returns(T.nilable(String)) }
550
- attr_accessor :reconciliation_mode
551
- sig { params(reconciliation_mode: T.nilable(String)).void }
552
- def initialize(reconciliation_mode: nil); end
553
- end
554
- # Settings controlling the behavior of the customer's cash balance,
555
- # such as reconciliation of funds received.
556
- sig { returns(T.nilable(::Stripe::Customer::CreateParams::CashBalance::Settings)) }
557
- attr_accessor :settings
558
- sig {
559
- params(settings: T.nilable(::Stripe::Customer::CreateParams::CashBalance::Settings)).void
560
- }
561
- def initialize(settings: nil); end
562
- end
563
- class InvoiceSettings < Stripe::RequestParams
564
- class CustomField < Stripe::RequestParams
565
- # The name of the custom field. This may be up to 40 characters.
566
- sig { returns(String) }
567
- attr_accessor :name
568
- # The value of the custom field. This may be up to 140 characters.
569
- sig { returns(String) }
570
- attr_accessor :value
571
- sig { params(name: String, value: String).void }
572
- def initialize(name: nil, value: nil); end
573
- end
574
- class RenderingOptions < Stripe::RequestParams
575
- # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
576
- sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
577
- attr_accessor :amount_tax_display
578
- # ID of the invoice rendering template to use for future invoices.
579
- sig { returns(T.nilable(String)) }
580
- attr_accessor :template
581
- sig {
582
- params(amount_tax_display: T.nilable(T.nilable(T.any(String, String))), template: T.nilable(String)).void
583
- }
584
- def initialize(amount_tax_display: nil, template: nil); end
585
- end
586
- # The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
587
- sig {
588
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Customer::CreateParams::InvoiceSettings::CustomField]))))
589
- }
590
- attr_accessor :custom_fields
591
- # ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
592
- sig { returns(T.nilable(String)) }
593
- attr_accessor :default_payment_method
594
- # Default footer to be displayed on invoices for this customer.
595
- sig { returns(T.nilable(String)) }
596
- attr_accessor :footer
597
- # Default options for invoice PDF rendering for this customer.
598
- sig {
599
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::InvoiceSettings::RenderingOptions))))
600
- }
601
- attr_accessor :rendering_options
602
- sig {
603
- params(custom_fields: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Customer::CreateParams::InvoiceSettings::CustomField]))), default_payment_method: T.nilable(String), footer: T.nilable(String), rendering_options: T.nilable(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::InvoiceSettings::RenderingOptions)))).void
604
- }
605
- def initialize(
606
- custom_fields: nil,
607
- default_payment_method: nil,
608
- footer: nil,
609
- rendering_options: nil
610
- ); end
611
- end
612
- class Shipping < Stripe::RequestParams
613
- class Address < Stripe::RequestParams
614
- # City, district, suburb, town, or village.
615
- sig { returns(T.nilable(String)) }
616
- attr_accessor :city
617
- # A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
618
- sig { returns(T.nilable(String)) }
619
- attr_accessor :country
620
- # Address line 1 (e.g., street, PO Box, or company name).
621
- sig { returns(T.nilable(String)) }
622
- attr_accessor :line1
623
- # Address line 2 (e.g., apartment, suite, unit, or building).
624
- sig { returns(T.nilable(String)) }
625
- attr_accessor :line2
626
- # ZIP or postal code.
627
- sig { returns(T.nilable(String)) }
628
- attr_accessor :postal_code
629
- # State, county, province, or region.
630
- sig { returns(T.nilable(String)) }
631
- attr_accessor :state
632
- sig {
633
- params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
634
- }
635
- def initialize(
636
- city: nil,
637
- country: nil,
638
- line1: nil,
639
- line2: nil,
640
- postal_code: nil,
641
- state: nil
642
- ); end
643
- end
644
- # Customer shipping address.
645
- sig { returns(::Stripe::Customer::CreateParams::Shipping::Address) }
646
- attr_accessor :address
647
- # Customer name.
648
- sig { returns(String) }
649
- attr_accessor :name
650
- # Customer phone (including extension).
651
- sig { returns(T.nilable(String)) }
652
- attr_accessor :phone
653
- sig {
654
- params(address: ::Stripe::Customer::CreateParams::Shipping::Address, name: String, phone: T.nilable(String)).void
655
- }
656
- def initialize(address: nil, name: nil, phone: nil); end
657
- end
658
- class Tax < Stripe::RequestParams
659
- # A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
660
- sig { returns(T.nilable(T.nilable(String))) }
661
- attr_accessor :ip_address
662
- # A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.
663
- sig { returns(T.nilable(String)) }
664
- attr_accessor :validate_location
665
- sig {
666
- params(ip_address: T.nilable(T.nilable(String)), validate_location: T.nilable(String)).void
667
- }
668
- def initialize(ip_address: nil, validate_location: nil); end
669
- end
670
- class TaxIdDatum < Stripe::RequestParams
671
- # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
672
- sig { returns(String) }
673
- attr_accessor :type
674
- # Value of the tax ID.
675
- sig { returns(String) }
676
- attr_accessor :value
677
- sig { params(type: String, value: String).void }
678
- def initialize(type: nil, value: nil); end
679
- end
680
- # The customer's address.
681
- sig {
682
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Address))))
683
- }
684
- attr_accessor :address
685
- # An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
686
- sig { returns(T.nilable(Integer)) }
687
- attr_accessor :balance
688
- # Balance information and default balance settings for this customer.
689
- sig { returns(T.nilable(::Stripe::Customer::CreateParams::CashBalance)) }
690
- attr_accessor :cash_balance
691
- # An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
692
- sig { returns(T.nilable(String)) }
693
- attr_accessor :description
694
- # Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
695
- sig { returns(T.nilable(String)) }
696
- attr_accessor :email
697
- # Specifies which fields in the response should be expanded.
698
- sig { returns(T.nilable(T::Array[String])) }
699
- attr_accessor :expand
700
- # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
701
- sig { returns(T.nilable(String)) }
702
- attr_accessor :invoice_prefix
703
- # Default invoice settings for this customer.
704
- sig { returns(T.nilable(::Stripe::Customer::CreateParams::InvoiceSettings)) }
705
- attr_accessor :invoice_settings
706
- # 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`.
707
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
708
- attr_accessor :metadata
709
- # The customer's full name or business name.
710
- sig { returns(T.nilable(String)) }
711
- attr_accessor :name
712
- # The sequence to be used on the customer's next invoice. Defaults to 1.
713
- sig { returns(T.nilable(Integer)) }
714
- attr_accessor :next_invoice_sequence
715
- # Attribute for param field payment_method
716
- sig { returns(T.nilable(String)) }
717
- attr_accessor :payment_method
718
- # The customer's phone number.
719
- sig { returns(T.nilable(String)) }
720
- attr_accessor :phone
721
- # Customer's preferred languages, ordered by preference.
722
- sig { returns(T.nilable(T::Array[String])) }
723
- attr_accessor :preferred_locales
724
- # The customer's shipping information. Appears on invoices emailed to this customer.
725
- sig {
726
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Shipping))))
727
- }
728
- attr_accessor :shipping
729
- # Attribute for param field source
730
- sig { returns(T.nilable(String)) }
731
- attr_accessor :source
732
- # Tax details about the customer.
733
- sig { returns(T.nilable(::Stripe::Customer::CreateParams::Tax)) }
734
- attr_accessor :tax
735
- # The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
736
- sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
737
- attr_accessor :tax_exempt
738
- # The customer's tax IDs.
739
- sig { returns(T.nilable(T::Array[::Stripe::Customer::CreateParams::TaxIdDatum])) }
740
- attr_accessor :tax_id_data
741
- # ID of the test clock to attach to the customer.
742
- sig { returns(T.nilable(String)) }
743
- attr_accessor :test_clock
744
- # Attribute for param field validate
745
- sig { returns(T.nilable(T::Boolean)) }
746
- attr_accessor :validate
747
- sig {
748
- params(address: T.nilable(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Address))), balance: T.nilable(Integer), cash_balance: T.nilable(::Stripe::Customer::CreateParams::CashBalance), description: T.nilable(String), email: T.nilable(String), expand: T.nilable(T::Array[String]), invoice_prefix: T.nilable(String), invoice_settings: T.nilable(::Stripe::Customer::CreateParams::InvoiceSettings), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), name: T.nilable(String), next_invoice_sequence: T.nilable(Integer), payment_method: T.nilable(String), phone: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), shipping: T.nilable(T.nilable(T.any(String, ::Stripe::Customer::CreateParams::Shipping))), source: T.nilable(String), tax: T.nilable(::Stripe::Customer::CreateParams::Tax), tax_exempt: T.nilable(T.nilable(T.any(String, String))), tax_id_data: T.nilable(T::Array[::Stripe::Customer::CreateParams::TaxIdDatum]), test_clock: T.nilable(String), validate: T.nilable(T::Boolean)).void
749
- }
750
- def initialize(
751
- address: nil,
752
- balance: nil,
753
- cash_balance: nil,
754
- description: nil,
755
- email: nil,
756
- expand: nil,
757
- invoice_prefix: nil,
758
- invoice_settings: nil,
759
- metadata: nil,
760
- name: nil,
761
- next_invoice_sequence: nil,
762
- payment_method: nil,
763
- phone: nil,
764
- preferred_locales: nil,
765
- shipping: nil,
766
- source: nil,
767
- tax: nil,
768
- tax_exempt: nil,
769
- tax_id_data: nil,
770
- test_clock: nil,
771
- validate: nil
772
- ); end
773
- end
774
- class ListPaymentMethodsParams < Stripe::RequestParams
775
- # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
776
- sig { returns(T.nilable(String)) }
777
- attr_accessor :allow_redisplay
778
- # 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.
779
- sig { returns(T.nilable(String)) }
780
- attr_accessor :ending_before
781
- # Specifies which fields in the response should be expanded.
782
- sig { returns(T.nilable(T::Array[String])) }
783
- attr_accessor :expand
784
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
785
- sig { returns(T.nilable(Integer)) }
786
- attr_accessor :limit
787
- # 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.
788
- sig { returns(T.nilable(String)) }
789
- attr_accessor :starting_after
790
- # An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
791
- sig { returns(T.nilable(String)) }
792
- attr_accessor :type
793
- sig {
794
- params(allow_redisplay: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String)).void
795
- }
796
- def initialize(
797
- allow_redisplay: nil,
798
- ending_before: nil,
799
- expand: nil,
800
- limit: nil,
801
- starting_after: nil,
802
- type: nil
803
- ); end
804
- end
805
- class RetrievePaymentMethodParams < Stripe::RequestParams
806
- # Specifies which fields in the response should be expanded.
807
- sig { returns(T.nilable(T::Array[String])) }
808
- attr_accessor :expand
809
- sig { params(expand: T.nilable(T::Array[String])).void }
810
- def initialize(expand: nil); end
811
- end
812
- class SearchParams < Stripe::RequestParams
813
- # Specifies which fields in the response should be expanded.
814
- sig { returns(T.nilable(T::Array[String])) }
815
- attr_accessor :expand
816
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
817
- sig { returns(T.nilable(Integer)) }
818
- attr_accessor :limit
819
- # A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
820
- sig { returns(T.nilable(String)) }
821
- attr_accessor :page
822
- # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers).
823
- sig { returns(String) }
824
- attr_accessor :query
825
- sig {
826
- params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
827
- }
828
- def initialize(expand: nil, limit: nil, page: nil, query: nil); end
829
- end
830
- class CreateFundingInstructionsParams < Stripe::RequestParams
831
- class BankTransfer < Stripe::RequestParams
832
- class EuBankTransfer < Stripe::RequestParams
833
- # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
834
- sig { returns(String) }
835
- attr_accessor :country
836
- sig { params(country: String).void }
837
- def initialize(country: nil); end
838
- end
839
- # Configuration for eu_bank_transfer funding type.
840
- sig {
841
- returns(T.nilable(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer::EuBankTransfer))
842
- }
843
- attr_accessor :eu_bank_transfer
844
- # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
845
- #
846
- # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
847
- sig { returns(T.nilable(T::Array[String])) }
848
- attr_accessor :requested_address_types
849
- # The type of the `bank_transfer`
850
- sig { returns(String) }
851
- attr_accessor :type
852
- sig {
853
- params(eu_bank_transfer: T.nilable(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
854
- }
855
- def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
856
- end
857
- # Additional parameters for `bank_transfer` funding types
858
- sig { returns(::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer) }
859
- attr_accessor :bank_transfer
860
- # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
861
- sig { returns(String) }
862
- attr_accessor :currency
863
- # Specifies which fields in the response should be expanded.
864
- sig { returns(T.nilable(T::Array[String])) }
865
- attr_accessor :expand
866
- # The `funding_type` to get the instructions for.
867
- sig { returns(String) }
868
- attr_accessor :funding_type
869
- sig {
870
- params(bank_transfer: ::Stripe::Customer::CreateFundingInstructionsParams::BankTransfer, currency: String, expand: T.nilable(T::Array[String]), funding_type: String).void
871
- }
872
- def initialize(bank_transfer: nil, currency: nil, expand: nil, funding_type: nil); end
873
- end
874
- class RetrieveParams < Stripe::RequestParams
875
- # Specifies which fields in the response should be expanded.
876
- sig { returns(T.nilable(T::Array[String])) }
877
- attr_accessor :expand
878
- sig { params(expand: T.nilable(T::Array[String])).void }
879
- def initialize(expand: nil); end
880
- end
881
- class FundCashBalanceParams < Stripe::RequestParams
882
- # Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
883
- sig { returns(Integer) }
884
- attr_accessor :amount
885
- # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
886
- sig { returns(String) }
887
- attr_accessor :currency
888
- # Specifies which fields in the response should be expanded.
889
- sig { returns(T.nilable(T::Array[String])) }
890
- attr_accessor :expand
891
- # A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs.
892
- sig { returns(T.nilable(String)) }
893
- attr_accessor :reference
894
- sig {
895
- params(amount: Integer, currency: String, expand: T.nilable(T::Array[String]), reference: T.nilable(String)).void
896
- }
897
- def initialize(amount: nil, currency: nil, expand: nil, reference: nil); end
898
- end
899
- # Creates a new customer object.
900
- sig {
901
- params(params: T.any(::Stripe::Customer::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
902
- }
903
- def self.create(params = {}, opts = {}); end
904
-
905
- # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
906
- # funding instructions will be created. If funding instructions have already been created for a given customer, the same
907
- # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
908
- sig {
909
- params(params: T.any(::Stripe::Customer::CreateFundingInstructionsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FundingInstructions)
910
- }
911
- def create_funding_instructions(params = {}, opts = {}); end
912
-
913
- # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
914
- # funding instructions will be created. If funding instructions have already been created for a given customer, the same
915
- # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
916
- sig {
917
- params(customer: String, params: T.any(::Stripe::Customer::CreateFundingInstructionsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::FundingInstructions)
918
- }
919
- def self.create_funding_instructions(customer, params = {}, opts = {}); end
920
-
921
- # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
922
- sig {
923
- params(customer: String, params: T.any(::Stripe::Customer::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
924
- }
925
- def self.delete(customer, params = {}, opts = {}); end
926
-
927
- # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
928
- sig {
929
- params(params: T.any(::Stripe::Customer::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
930
- }
931
- def delete(params = {}, opts = {}); end
932
-
933
- # Removes the currently applied discount on a customer.
934
- sig {
935
- params(params: T.any(::Stripe::Customer::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
936
- }
937
- def delete_discount(params = {}, opts = {}); end
938
-
939
- # Removes the currently applied discount on a customer.
940
- sig {
941
- params(customer: String, params: T.any(::Stripe::Customer::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
942
- }
943
- def self.delete_discount(customer, params = {}, opts = {}); end
944
-
945
- # Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
946
- sig {
947
- params(params: T.any(::Stripe::Customer::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
948
- }
949
- def self.list(params = {}, opts = {}); end
950
-
951
- # Returns a list of PaymentMethods for a given Customer
952
- sig {
953
- params(params: T.any(::Stripe::Customer::ListPaymentMethodsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
954
- }
955
- def list_payment_methods(params = {}, opts = {}); end
956
-
957
- # Returns a list of PaymentMethods for a given Customer
958
- sig {
959
- params(customer: String, params: T.any(::Stripe::Customer::ListPaymentMethodsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
960
- }
961
- def self.list_payment_methods(customer, params = {}, opts = {}); end
962
-
963
- # Retrieves a customer's cash balance.
964
- sig {
965
- params(customer: String, params: T.any(::Stripe::Customer::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.untyped)
966
- }
967
- def self.retrieve_cash_balance(customer, params = {}, opts = {}); end
968
-
969
- # Retrieves a PaymentMethod object for a given Customer.
970
- sig {
971
- params(payment_method: String, params: T.any(::Stripe::Customer::RetrievePaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
972
- }
973
- def retrieve_payment_method(payment_method, params = {}, opts = {}); end
974
-
975
- # Retrieves a PaymentMethod object for a given Customer.
976
- sig {
977
- params(customer: String, payment_method: String, params: T.any(::Stripe::Customer::RetrievePaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod)
978
- }
979
- def self.retrieve_payment_method(customer, payment_method, params = {}, opts = {}); end
980
-
981
- sig {
982
- params(params: T.any(::Stripe::Customer::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
983
- }
984
- def self.search(params = {}, opts = {}); end
985
-
986
- sig {
987
- params(params: T.any(::Stripe::Customer::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
988
- }
989
- def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
990
-
991
- # Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer's active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer's current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
992
- #
993
- # This request accepts mostly the same arguments as the customer creation call.
994
- sig {
995
- params(customer: String, params: T.any(::Stripe::Customer::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Customer)
996
- }
997
- def self.update(customer, params = {}, opts = {}); end
998
-
999
- # Changes the settings on a customer's cash balance.
1000
- sig {
1001
- params(customer: String, params: T.any(::Stripe::Customer::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.untyped)
1002
- }
1003
- def self.update_cash_balance(customer, params = {}, opts = {}); end
1004
- end
1005
- end