stripe 15.0.0 → 15.1.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 (576) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1537 -676
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_requestor.rb +28 -0
  6. data/lib/stripe/api_version.rb +1 -1
  7. data/lib/stripe/errors.rb +54 -0
  8. data/lib/stripe/event_types.rb +75 -0
  9. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  10. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  15. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  18. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  19. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  20. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  21. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  22. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  23. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  24. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  25. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  26. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  41. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  49. data/lib/stripe/object_types.rb +51 -0
  50. data/lib/stripe/request_signing_authenticator.rb +79 -0
  51. data/lib/stripe/resources/account.rb +663 -1
  52. data/lib/stripe/resources/account_notice.rb +123 -0
  53. data/lib/stripe/resources/account_session.rb +299 -1
  54. data/lib/stripe/resources/balance_settings.rb +101 -0
  55. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  56. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  57. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  58. data/lib/stripe/resources/billing/meter_error_report.rb +59 -0
  59. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  60. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  61. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  62. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  63. data/lib/stripe/resources/card.rb +2 -0
  64. data/lib/stripe/resources/cash_balance.rb +2 -0
  65. data/lib/stripe/resources/charge.rb +1454 -0
  66. data/lib/stripe/resources/checkout/session.rb +295 -7
  67. data/lib/stripe/resources/confirmation_token.rb +237 -3
  68. data/lib/stripe/resources/coupon.rb +1 -1
  69. data/lib/stripe/resources/credit_note.rb +10 -0
  70. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  71. data/lib/stripe/resources/customer.rb +2 -0
  72. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  73. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  74. data/lib/stripe/resources/customer_session.rb +6 -1
  75. data/lib/stripe/resources/discount.rb +2 -0
  76. data/lib/stripe/resources/event.rb +33 -0
  77. data/lib/stripe/resources/financial_connections/account.rb +20 -1
  78. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  79. data/lib/stripe/resources/financial_connections/institution.rb +90 -0
  80. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  81. data/lib/stripe/resources/gift_cards/card.rb +208 -0
  82. data/lib/stripe/resources/gift_cards/transaction.rb +272 -0
  83. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  84. data/lib/stripe/resources/invoice.rb +1176 -16
  85. data/lib/stripe/resources/invoice_item.rb +78 -2
  86. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  87. data/lib/stripe/resources/invoice_payment.rb +2 -53
  88. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  89. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  90. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  91. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  93. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  94. data/lib/stripe/resources/line_item.rb +37 -0
  95. data/lib/stripe/resources/login_link.rb +2 -1
  96. data/lib/stripe/resources/mandate.rb +24 -0
  97. data/lib/stripe/resources/margin.rb +115 -0
  98. data/lib/stripe/resources/order.rb +2859 -0
  99. data/lib/stripe/resources/payment_attempt_record.rb +1078 -0
  100. data/lib/stripe/resources/payment_intent.rb +5242 -440
  101. data/lib/stripe/resources/payment_method.rb +199 -4
  102. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  103. data/lib/stripe/resources/payment_method_domain.rb +13 -0
  104. data/lib/stripe/resources/payment_record.rb +1607 -0
  105. data/lib/stripe/resources/payout.rb +6 -0
  106. data/lib/stripe/resources/price.rb +30 -0
  107. data/lib/stripe/resources/privacy/redaction_job.rb +251 -0
  108. data/lib/stripe/resources/privacy/redaction_job_root_objects.rb +35 -0
  109. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +54 -0
  110. data/lib/stripe/resources/product.rb +59 -0
  111. data/lib/stripe/resources/promotion_code.rb +10 -0
  112. data/lib/stripe/resources/quote.rb +2042 -6
  113. data/lib/stripe/resources/quote_line.rb +274 -0
  114. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  115. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +337 -0
  116. data/lib/stripe/resources/refund.rb +9 -0
  117. data/lib/stripe/resources/setup_attempt.rb +21 -0
  118. data/lib/stripe/resources/setup_intent.rb +605 -18
  119. data/lib/stripe/resources/source.rb +30 -1
  120. data/lib/stripe/resources/subscription.rb +292 -9
  121. data/lib/stripe/resources/subscription_item.rb +84 -3
  122. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  123. data/lib/stripe/resources/tax/association.rb +89 -0
  124. data/lib/stripe/resources/tax/form.rb +211 -0
  125. data/lib/stripe/resources/tax/registration.rb +20 -0
  126. data/lib/stripe/resources/tax_id.rb +12 -2
  127. data/lib/stripe/resources/terminal/reader.rb +406 -0
  128. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  129. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  130. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  131. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  132. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  133. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  134. data/lib/stripe/resources/v2/core/account.rb +1715 -0
  135. data/lib/stripe/resources/v2/core/account_link.rb +54 -0
  136. data/lib/stripe/resources/v2/core/person.rb +272 -0
  137. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +72 -0
  138. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +37 -0
  139. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +18 -0
  140. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +20 -0
  141. data/lib/stripe/resources/v2/money_management/adjustment.rb +49 -0
  142. data/lib/stripe/resources/v2/money_management/financial_account.rb +56 -0
  143. data/lib/stripe/resources/v2/money_management/financial_address.rb +66 -0
  144. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +92 -0
  145. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +127 -0
  146. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +74 -0
  147. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +43 -0
  148. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +115 -0
  149. data/lib/stripe/resources/v2/money_management/payout_method.rb +73 -0
  150. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +47 -0
  151. data/lib/stripe/resources/v2/money_management/received_credit.rb +134 -0
  152. data/lib/stripe/resources/v2/money_management/received_debit.rb +106 -0
  153. data/lib/stripe/resources/v2/money_management/transaction.rb +76 -0
  154. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +66 -0
  155. data/lib/stripe/resources.rb +88 -0
  156. data/lib/stripe/services/account_notice_service.rb +101 -0
  157. data/lib/stripe/services/account_service.rb +570 -1
  158. data/lib/stripe/services/account_session_service.rb +269 -1
  159. data/lib/stripe/services/balance_settings_service.rb +96 -0
  160. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  161. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  162. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  163. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  164. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  165. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  166. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  167. data/lib/stripe/services/capital_service.rb +15 -0
  168. data/lib/stripe/services/charge_service.rb +1334 -0
  169. data/lib/stripe/services/checkout/session_service.rb +195 -4
  170. data/lib/stripe/services/credit_note_service.rb +4 -0
  171. data/lib/stripe/services/customer_session_service.rb +4 -1
  172. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -123
  173. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  174. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  175. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  176. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  177. data/lib/stripe/services/financial_connections_service.rb +2 -1
  178. data/lib/stripe/services/gift_cards/card_service.rb +170 -0
  179. data/lib/stripe/services/gift_cards/transaction_service.rb +209 -0
  180. data/lib/stripe/services/gift_cards_service.rb +14 -0
  181. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  182. data/lib/stripe/services/invoice_item_service.rb +74 -2
  183. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  184. data/lib/stripe/services/invoice_payment_service.rb +5 -33
  185. data/lib/stripe/services/invoice_service.rb +1088 -17
  186. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  187. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  188. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  189. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  190. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  191. data/lib/stripe/services/issuing_service.rb +5 -1
  192. data/lib/stripe/services/margin_service.rb +119 -0
  193. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  194. data/lib/stripe/services/order_service.rb +2268 -0
  195. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  196. data/lib/stripe/services/payment_intent_service.rb +4634 -261
  197. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  198. data/lib/stripe/services/payment_method_service.rb +129 -4
  199. data/lib/stripe/services/payment_record_service.rb +542 -0
  200. data/lib/stripe/services/payout_service.rb +4 -0
  201. data/lib/stripe/services/price_service.rb +19 -0
  202. data/lib/stripe/services/privacy/redaction_job_service.rb +231 -0
  203. data/{rbi/stripe/services/climate/product_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +36 -25
  204. data/lib/stripe/services/privacy_service.rb +13 -0
  205. data/lib/stripe/services/product_service.rb +38 -0
  206. data/lib/stripe/services/promotion_code_service.rb +8 -0
  207. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  208. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  209. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_subscription_schedule_service.rb} +20 -16
  210. data/lib/stripe/services/quote_service.rb +1726 -7
  211. data/lib/stripe/services/setup_intent_service.rb +565 -18
  212. data/lib/stripe/services/subscription_item_service.rb +75 -3
  213. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  214. data/lib/stripe/services/subscription_service.rb +253 -9
  215. data/lib/stripe/services/tax/association_service.rb +31 -0
  216. data/lib/stripe/services/tax/form_service.rb +100 -0
  217. data/lib/stripe/services/tax/registration_service.rb +13 -0
  218. data/lib/stripe/services/tax_id_service.rb +8 -2
  219. data/lib/stripe/services/tax_service.rb +3 -1
  220. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  221. data/lib/stripe/services/terminal/reader_service.rb +180 -0
  222. data/lib/stripe/services/terminal_service.rb +2 -1
  223. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +151 -3
  224. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +43 -0
  225. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  226. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  227. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  228. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  229. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  230. data/lib/stripe/services/v1_services.rb +11 -2
  231. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  232. data/lib/stripe/services/v2/core/account_service.rb +4130 -0
  233. data/lib/stripe/services/v2/core/accounts/person_service.rb +1040 -0
  234. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +135 -0
  235. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +109 -0
  236. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  237. data/lib/stripe/services/v2/core_service.rb +4 -1
  238. data/lib/stripe/services/v2/money_management/adjustment_service.rb +75 -0
  239. data/lib/stripe/services/v2/money_management/financial_account_service.rb +44 -0
  240. data/lib/stripe/services/v2/money_management/financial_address_service.rb +81 -0
  241. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +126 -0
  242. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +80 -0
  243. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +202 -0
  244. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +237 -0
  245. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +174 -0
  246. data/lib/stripe/services/v2/money_management/payout_method_service.rb +95 -0
  247. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  248. data/lib/stripe/services/v2/money_management/received_credit_service.rb +71 -0
  249. data/lib/stripe/services/v2/money_management/received_debit_service.rb +44 -0
  250. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +70 -0
  251. data/lib/stripe/services/v2/money_management/transaction_service.rb +74 -0
  252. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  253. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  254. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +50 -0
  255. data/lib/stripe/services/v2_services.rb +4 -2
  256. data/lib/stripe/services.rb +52 -0
  257. data/lib/stripe/stripe_configuration.rb +3 -1
  258. data/lib/stripe/stripe_object.rb +1 -1
  259. data/lib/stripe/util.rb +7 -1
  260. data/lib/stripe/version.rb +1 -1
  261. data/lib/stripe.rb +55 -0
  262. data/rbi/stripe.rbi +190156 -0
  263. data/stripe.gemspec +4 -1
  264. metadata +146 -324
  265. data/rbi/stripe/resources/account.rbi +0 -4840
  266. data/rbi/stripe/resources/account_link.rbi +0 -74
  267. data/rbi/stripe/resources/account_session.rbi +0 -894
  268. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -90
  269. data/rbi/stripe/resources/application.rbi +0 -20
  270. data/rbi/stripe/resources/application_fee.rbi +0 -118
  271. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  272. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  273. data/rbi/stripe/resources/balance.rbi +0 -180
  274. data/rbi/stripe/resources/balance_transaction.rbi +0 -144
  275. data/rbi/stripe/resources/bank_account.rbi +0 -127
  276. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  277. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  278. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  279. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  280. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  281. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  282. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  283. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  284. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  285. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  286. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  287. data/rbi/stripe/resources/capability.rbi +0 -125
  288. data/rbi/stripe/resources/card.rbi +0 -125
  289. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  290. data/rbi/stripe/resources/charge.rbi +0 -2054
  291. data/rbi/stripe/resources/checkout/session.rbi +0 -3951
  292. data/rbi/stripe/resources/climate/order.rbi +0 -245
  293. data/rbi/stripe/resources/climate/product.rbi +0 -75
  294. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  295. data/rbi/stripe/resources/confirmation_token.rbi +0 -1793
  296. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  297. data/rbi/stripe/resources/country_spec.rbi +0 -85
  298. data/rbi/stripe/resources/coupon.rbi +0 -252
  299. data/rbi/stripe/resources/credit_note.rbi +0 -747
  300. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  301. data/rbi/stripe/resources/customer.rbi +0 -1009
  302. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  303. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  304. data/rbi/stripe/resources/customer_session.rbi +0 -200
  305. data/rbi/stripe/resources/discount.rbi +0 -53
  306. data/rbi/stripe/resources/dispute.rbi +0 -761
  307. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  308. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  309. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  310. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  311. data/rbi/stripe/resources/event.rbi +0 -146
  312. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  313. data/rbi/stripe/resources/file.rbi +0 -143
  314. data/rbi/stripe/resources/file_link.rbi +0 -141
  315. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  316. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  317. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  318. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  319. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  320. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  321. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  322. data/rbi/stripe/resources/identity/verification_report.rbi +0 -351
  323. data/rbi/stripe/resources/identity/verification_session.rbi +0 -517
  324. data/rbi/stripe/resources/invoice.rbi +0 -3733
  325. data/rbi/stripe/resources/invoice_item.rbi +0 -475
  326. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  327. data/rbi/stripe/resources/invoice_payment.rbi +0 -114
  328. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  329. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  330. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  331. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  332. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  333. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  334. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  335. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  336. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  337. data/rbi/stripe/resources/line_item.rbi +0 -72
  338. data/rbi/stripe/resources/login_link.rbi +0 -18
  339. data/rbi/stripe/resources/mandate.rbi +0 -187
  340. data/rbi/stripe/resources/payment_intent.rbi +0 -9731
  341. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  342. data/rbi/stripe/resources/payment_method.rbi +0 -1822
  343. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3154
  344. data/rbi/stripe/resources/payment_method_domain.rbi +0 -212
  345. data/rbi/stripe/resources/payout.rbi +0 -300
  346. data/rbi/stripe/resources/person.rbi +0 -371
  347. data/rbi/stripe/resources/plan.rbi +0 -373
  348. data/rbi/stripe/resources/price.rbi +0 -694
  349. data/rbi/stripe/resources/product.rbi +0 -557
  350. data/rbi/stripe/resources/product_feature.rbi +0 -26
  351. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  352. data/rbi/stripe/resources/quote.rbi +0 -1123
  353. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  354. data/rbi/stripe/resources/radar/value_list.rbi +0 -170
  355. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -131
  356. data/rbi/stripe/resources/refund.rbi +0 -516
  357. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  358. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  359. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  360. data/rbi/stripe/resources/reversal.rbi +0 -51
  361. data/rbi/stripe/resources/review.rbi +0 -154
  362. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  363. data/rbi/stripe/resources/setup_intent.rbi +0 -3860
  364. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  365. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  366. data/rbi/stripe/resources/source.rbi +0 -1496
  367. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  368. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  369. data/rbi/stripe/resources/subscription.rbi +0 -1964
  370. data/rbi/stripe/resources/subscription_item.rbi +0 -370
  371. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1495
  372. data/rbi/stripe/resources/tax/calculation.rbi +0 -474
  373. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -88
  374. data/rbi/stripe/resources/tax/registration.rbi +0 -2485
  375. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  376. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  377. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  378. data/rbi/stripe/resources/tax_code.rbi +0 -44
  379. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  380. data/rbi/stripe/resources/tax_id.rbi +0 -167
  381. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  382. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1388
  383. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  384. data/rbi/stripe/resources/terminal/location.rbi +0 -224
  385. data/rbi/stripe/resources/terminal/reader.rbi +0 -587
  386. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -134
  387. data/rbi/stripe/resources/token.rbi +0 -1217
  388. data/rbi/stripe/resources/topup.rbi +0 -222
  389. data/rbi/stripe/resources/transfer.rbi +0 -199
  390. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  391. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  392. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -865
  393. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  394. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  395. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  396. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  397. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  398. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  399. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  400. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  401. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  402. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  403. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  404. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  405. data/rbi/stripe/resources/v2/event.rbi +0 -48
  406. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  407. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -170
  408. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  409. data/rbi/stripe/services/account_link_service.rbi +0 -58
  410. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  411. data/rbi/stripe/services/account_person_service.rbi +0 -923
  412. data/rbi/stripe/services/account_service.rbi +0 -4143
  413. data/rbi/stripe/services/account_session_service.rbi +0 -572
  414. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -78
  415. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  416. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  417. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  418. data/rbi/stripe/services/apps_service.rbi +0 -9
  419. data/rbi/stripe/services/balance_service.rbi +0 -21
  420. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  421. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  422. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  423. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  424. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  425. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  426. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  427. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  428. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  429. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  430. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  431. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  432. data/rbi/stripe/services/billing_service.rbi +0 -15
  433. data/rbi/stripe/services/charge_service.rbi +0 -448
  434. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  435. data/rbi/stripe/services/checkout/session_service.rbi +0 -2585
  436. data/rbi/stripe/services/checkout_service.rbi +0 -9
  437. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  438. data/rbi/stripe/services/climate_service.rbi +0 -11
  439. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  440. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  441. data/rbi/stripe/services/coupon_service.rbi +0 -196
  442. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  443. data/rbi/stripe/services/credit_note_service.rbi +0 -416
  444. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  445. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  446. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  447. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  448. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  449. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  450. data/rbi/stripe/services/customer_service.rbi +0 -651
  451. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  452. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -72
  453. data/rbi/stripe/services/dispute_service.rbi +0 -424
  454. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  455. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  456. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  457. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  458. data/rbi/stripe/services/event_service.rbi +0 -83
  459. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  460. data/rbi/stripe/services/file_link_service.rbi +0 -124
  461. data/rbi/stripe/services/file_service.rbi +0 -116
  462. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  463. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  464. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  465. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  466. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  467. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  468. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  469. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  470. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -323
  471. data/rbi/stripe/services/identity_service.rbi +0 -10
  472. data/rbi/stripe/services/invoice_item_service.rbi +0 -368
  473. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  474. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  475. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  476. data/rbi/stripe/services/invoice_service.rbi +0 -2920
  477. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  478. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  479. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  480. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  481. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  482. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  483. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  484. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  485. data/rbi/stripe/services/issuing_service.rbi +0 -16
  486. data/rbi/stripe/services/mandate_service.rbi +0 -20
  487. data/rbi/stripe/services/payment_intent_service.rbi +0 -7759
  488. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  489. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2211
  490. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  491. data/rbi/stripe/services/payment_method_service.rbi +0 -840
  492. data/rbi/stripe/services/payout_service.rbi +0 -205
  493. data/rbi/stripe/services/plan_service.rbi +0 -284
  494. data/rbi/stripe/services/price_service.rbi +0 -546
  495. data/rbi/stripe/services/product_feature_service.rbi +0 -69
  496. data/rbi/stripe/services/product_service.rbi +0 -479
  497. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  498. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  499. data/rbi/stripe/services/quote_service.rbi +0 -686
  500. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  501. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -111
  502. data/rbi/stripe/services/radar/value_list_service.rbi +0 -143
  503. data/rbi/stripe/services/radar_service.rbi +0 -11
  504. data/rbi/stripe/services/refund_service.rbi +0 -185
  505. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  506. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  507. data/rbi/stripe/services/reporting_service.rbi +0 -10
  508. data/rbi/stripe/services/review_service.rbi +0 -84
  509. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  510. data/rbi/stripe/services/setup_intent_service.rbi +0 -3596
  511. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  512. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  513. data/rbi/stripe/services/sigma_service.rbi +0 -9
  514. data/rbi/stripe/services/source_service.rbi +0 -663
  515. data/rbi/stripe/services/subscription_item_service.rbi +0 -324
  516. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1192
  517. data/rbi/stripe/services/subscription_service.rbi +0 -1596
  518. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -33
  519. data/rbi/stripe/services/tax/calculation_service.rbi +0 -230
  520. data/rbi/stripe/services/tax/registration_service.rbi +0 -1689
  521. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  522. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  523. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  524. data/rbi/stripe/services/tax_id_service.rbi +0 -112
  525. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  526. data/rbi/stripe/services/tax_service.rbi +0 -12
  527. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1120
  528. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  529. data/rbi/stripe/services/terminal/location_service.rbi +0 -184
  530. data/rbi/stripe/services/terminal/reader_service.rbi +0 -344
  531. data/rbi/stripe/services/terminal_service.rbi +0 -12
  532. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  533. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  534. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  535. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  536. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  537. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  538. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  539. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  540. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -62
  541. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  542. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -92
  543. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  544. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  545. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  546. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  547. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  548. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  549. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  550. data/rbi/stripe/services/token_service.rbi +0 -1189
  551. data/rbi/stripe/services/topup_service.rbi +0 -176
  552. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  553. data/rbi/stripe/services/transfer_service.rbi +0 -152
  554. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  555. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  556. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  557. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -562
  558. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  559. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  560. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  561. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  562. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  563. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  564. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  565. data/rbi/stripe/services/treasury_service.rbi +0 -18
  566. data/rbi/stripe/services/v1_services.rbi +0 -77
  567. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  568. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  569. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -20
  570. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  571. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  572. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -200
  573. data/rbi/stripe/services/v2/core/event_service.rbi +0 -38
  574. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  575. data/rbi/stripe/services/v2_services.rbi +0 -10
  576. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -131
@@ -1,1352 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- class PaymentLinkService < StripeService
7
- attr_reader :line_items
8
- class ListParams < Stripe::RequestParams
9
- # Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).
10
- sig { returns(T.nilable(T::Boolean)) }
11
- attr_accessor :active
12
- # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
13
- sig { returns(T.nilable(String)) }
14
- attr_accessor :ending_before
15
- # Specifies which fields in the response should be expanded.
16
- sig { returns(T.nilable(T::Array[String])) }
17
- attr_accessor :expand
18
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
19
- sig { returns(T.nilable(Integer)) }
20
- attr_accessor :limit
21
- # 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.
22
- sig { returns(T.nilable(String)) }
23
- attr_accessor :starting_after
24
- sig {
25
- params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
26
- }
27
- def initialize(
28
- active: nil,
29
- ending_before: nil,
30
- expand: nil,
31
- limit: nil,
32
- starting_after: nil
33
- ); end
34
- end
35
- class CreateParams < Stripe::RequestParams
36
- class AfterCompletion < Stripe::RequestParams
37
- class HostedConfirmation < Stripe::RequestParams
38
- # A custom message to display to the customer after the purchase is complete.
39
- sig { returns(T.nilable(String)) }
40
- attr_accessor :custom_message
41
- sig { params(custom_message: T.nilable(String)).void }
42
- def initialize(custom_message: nil); end
43
- end
44
- class Redirect < Stripe::RequestParams
45
- # The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.
46
- sig { returns(String) }
47
- attr_accessor :url
48
- sig { params(url: String).void }
49
- def initialize(url: nil); end
50
- end
51
- # Configuration when `type=hosted_confirmation`.
52
- sig {
53
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::HostedConfirmation))
54
- }
55
- attr_accessor :hosted_confirmation
56
- # Configuration when `type=redirect`.
57
- sig {
58
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::Redirect))
59
- }
60
- attr_accessor :redirect
61
- # The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.
62
- sig { returns(String) }
63
- attr_accessor :type
64
- sig {
65
- params(hosted_confirmation: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::Redirect), type: String).void
66
- }
67
- def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
68
- end
69
- class AutomaticTax < Stripe::RequestParams
70
- class Liability < Stripe::RequestParams
71
- # The connected account being referenced when `type` is `account`.
72
- sig { returns(T.nilable(String)) }
73
- attr_accessor :account
74
- # Type of the account referenced in the request.
75
- sig { returns(String) }
76
- attr_accessor :type
77
- sig { params(account: T.nilable(String), type: String).void }
78
- def initialize(account: nil, type: nil); end
79
- end
80
- # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
81
- #
82
- # Enabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.
83
- sig { returns(T::Boolean) }
84
- attr_accessor :enabled
85
- # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
86
- sig {
87
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax::Liability))
88
- }
89
- attr_accessor :liability
90
- sig {
91
- params(enabled: T::Boolean, liability: T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax::Liability)).void
92
- }
93
- def initialize(enabled: nil, liability: nil); end
94
- end
95
- class ConsentCollection < Stripe::RequestParams
96
- class PaymentMethodReuseAgreement < Stripe::RequestParams
97
- # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
98
- # defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
99
- sig { returns(String) }
100
- attr_accessor :position
101
- sig { params(position: String).void }
102
- def initialize(position: nil); end
103
- end
104
- # Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
105
- sig {
106
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
107
- }
108
- attr_accessor :payment_method_reuse_agreement
109
- # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
110
- # Session will determine whether to display an option to opt into promotional communication
111
- # from the merchant depending on the customer's locale. Only available to US merchants.
112
- sig { returns(T.nilable(String)) }
113
- attr_accessor :promotions
114
- # If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
115
- # There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
116
- sig { returns(T.nilable(String)) }
117
- attr_accessor :terms_of_service
118
- sig {
119
- params(payment_method_reuse_agreement: T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement), promotions: T.nilable(String), terms_of_service: T.nilable(String)).void
120
- }
121
- def initialize(
122
- payment_method_reuse_agreement: nil,
123
- promotions: nil,
124
- terms_of_service: nil
125
- ); end
126
- end
127
- class CustomField < Stripe::RequestParams
128
- class Dropdown < Stripe::RequestParams
129
- class Option < Stripe::RequestParams
130
- # The label for the option, displayed to the customer. Up to 100 characters.
131
- sig { returns(String) }
132
- attr_accessor :label
133
- # The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
134
- sig { returns(String) }
135
- attr_accessor :value
136
- sig { params(label: String, value: String).void }
137
- def initialize(label: nil, value: nil); end
138
- end
139
- # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
140
- sig { returns(T.nilable(String)) }
141
- attr_accessor :default_value
142
- # The options available for the customer to select. Up to 200 options allowed.
143
- sig {
144
- returns(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown::Option])
145
- }
146
- attr_accessor :options
147
- sig {
148
- params(default_value: T.nilable(String), options: T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown::Option]).void
149
- }
150
- def initialize(default_value: nil, options: nil); end
151
- end
152
- class Label < Stripe::RequestParams
153
- # Custom text for the label, displayed to the customer. Up to 50 characters.
154
- sig { returns(String) }
155
- attr_accessor :custom
156
- # The type of the label.
157
- sig { returns(String) }
158
- attr_accessor :type
159
- sig { params(custom: String, type: String).void }
160
- def initialize(custom: nil, type: nil); end
161
- end
162
- class Numeric < Stripe::RequestParams
163
- # The value that will pre-fill the field on the payment page.
164
- sig { returns(T.nilable(String)) }
165
- attr_accessor :default_value
166
- # The maximum character length constraint for the customer's input.
167
- sig { returns(T.nilable(Integer)) }
168
- attr_accessor :maximum_length
169
- # The minimum character length requirement for the customer's input.
170
- sig { returns(T.nilable(Integer)) }
171
- attr_accessor :minimum_length
172
- sig {
173
- params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
174
- }
175
- def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
176
- end
177
- class Text < Stripe::RequestParams
178
- # The value that will pre-fill the field on the payment page.
179
- sig { returns(T.nilable(String)) }
180
- attr_accessor :default_value
181
- # The maximum character length constraint for the customer's input.
182
- sig { returns(T.nilable(Integer)) }
183
- attr_accessor :maximum_length
184
- # The minimum character length requirement for the customer's input.
185
- sig { returns(T.nilable(Integer)) }
186
- attr_accessor :minimum_length
187
- sig {
188
- params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
189
- }
190
- def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
191
- end
192
- # Configuration for `type=dropdown` fields.
193
- sig {
194
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown))
195
- }
196
- attr_accessor :dropdown
197
- # String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
198
- sig { returns(String) }
199
- attr_accessor :key
200
- # The label for the field, displayed to the customer.
201
- sig { returns(::Stripe::PaymentLinkService::CreateParams::CustomField::Label) }
202
- attr_accessor :label
203
- # Configuration for `type=numeric` fields.
204
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Numeric)) }
205
- attr_accessor :numeric
206
- # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
207
- sig { returns(T.nilable(T::Boolean)) }
208
- attr_accessor :optional
209
- # Configuration for `type=text` fields.
210
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Text)) }
211
- attr_accessor :text
212
- # The type of the field.
213
- sig { returns(String) }
214
- attr_accessor :type
215
- sig {
216
- params(dropdown: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown), key: String, label: ::Stripe::PaymentLinkService::CreateParams::CustomField::Label, numeric: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Text), type: String).void
217
- }
218
- def initialize(
219
- dropdown: nil,
220
- key: nil,
221
- label: nil,
222
- numeric: nil,
223
- optional: nil,
224
- text: nil,
225
- type: nil
226
- ); end
227
- end
228
- class CustomText < Stripe::RequestParams
229
- class AfterSubmit < Stripe::RequestParams
230
- # Text may be up to 1200 characters in length.
231
- sig { returns(String) }
232
- attr_accessor :message
233
- sig { params(message: String).void }
234
- def initialize(message: nil); end
235
- end
236
- class ShippingAddress < Stripe::RequestParams
237
- # Text may be up to 1200 characters in length.
238
- sig { returns(String) }
239
- attr_accessor :message
240
- sig { params(message: String).void }
241
- def initialize(message: nil); end
242
- end
243
- class Submit < Stripe::RequestParams
244
- # Text may be up to 1200 characters in length.
245
- sig { returns(String) }
246
- attr_accessor :message
247
- sig { params(message: String).void }
248
- def initialize(message: nil); end
249
- end
250
- class TermsOfServiceAcceptance < Stripe::RequestParams
251
- # Text may be up to 1200 characters in length.
252
- sig { returns(String) }
253
- attr_accessor :message
254
- sig { params(message: String).void }
255
- def initialize(message: nil); end
256
- end
257
- # Custom text that should be displayed after the payment confirmation button.
258
- sig {
259
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::AfterSubmit))))
260
- }
261
- attr_accessor :after_submit
262
- # Custom text that should be displayed alongside shipping address collection.
263
- sig {
264
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::ShippingAddress))))
265
- }
266
- attr_accessor :shipping_address
267
- # Custom text that should be displayed alongside the payment confirmation button.
268
- sig {
269
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::Submit))))
270
- }
271
- attr_accessor :submit
272
- # Custom text that should be displayed in place of the default terms of service agreement text.
273
- sig {
274
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::TermsOfServiceAcceptance))))
275
- }
276
- attr_accessor :terms_of_service_acceptance
277
- sig {
278
- params(after_submit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::AfterSubmit))), shipping_address: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::ShippingAddress))), submit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::Submit))), terms_of_service_acceptance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::TermsOfServiceAcceptance)))).void
279
- }
280
- def initialize(
281
- after_submit: nil,
282
- shipping_address: nil,
283
- submit: nil,
284
- terms_of_service_acceptance: nil
285
- ); end
286
- end
287
- class InvoiceCreation < Stripe::RequestParams
288
- class InvoiceData < Stripe::RequestParams
289
- class CustomField < Stripe::RequestParams
290
- # The name of the custom field. This may be up to 40 characters.
291
- sig { returns(String) }
292
- attr_accessor :name
293
- # The value of the custom field. This may be up to 140 characters.
294
- sig { returns(String) }
295
- attr_accessor :value
296
- sig { params(name: String, value: String).void }
297
- def initialize(name: nil, value: nil); end
298
- end
299
- class Issuer < Stripe::RequestParams
300
- # The connected account being referenced when `type` is `account`.
301
- sig { returns(T.nilable(String)) }
302
- attr_accessor :account
303
- # Type of the account referenced in the request.
304
- sig { returns(String) }
305
- attr_accessor :type
306
- sig { params(account: T.nilable(String), type: String).void }
307
- def initialize(account: nil, type: nil); end
308
- end
309
- class RenderingOptions < Stripe::RequestParams
310
- # 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.
311
- sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
312
- attr_accessor :amount_tax_display
313
- sig { params(amount_tax_display: T.nilable(T.nilable(T.any(String, String)))).void }
314
- def initialize(amount_tax_display: nil); end
315
- end
316
- # The account tax IDs associated with the invoice.
317
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
318
- attr_accessor :account_tax_ids
319
- # Default custom fields to be displayed on invoices for this customer.
320
- sig {
321
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))))
322
- }
323
- attr_accessor :custom_fields
324
- # An arbitrary string attached to the object. Often useful for displaying to users.
325
- sig { returns(T.nilable(String)) }
326
- attr_accessor :description
327
- # Default footer to be displayed on invoices for this customer.
328
- sig { returns(T.nilable(String)) }
329
- attr_accessor :footer
330
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
331
- sig {
332
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::Issuer))
333
- }
334
- attr_accessor :issuer
335
- # 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`.
336
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
337
- attr_accessor :metadata
338
- # Default options for invoice PDF rendering for this customer.
339
- sig {
340
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))))
341
- }
342
- attr_accessor :rendering_options
343
- sig {
344
- params(account_tax_ids: T.nilable(T.nilable(T.any(String, T::Array[String]))), custom_fields: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), rendering_options: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))).void
345
- }
346
- def initialize(
347
- account_tax_ids: nil,
348
- custom_fields: nil,
349
- description: nil,
350
- footer: nil,
351
- issuer: nil,
352
- metadata: nil,
353
- rendering_options: nil
354
- ); end
355
- end
356
- # Whether the feature is enabled
357
- sig { returns(T::Boolean) }
358
- attr_accessor :enabled
359
- # Invoice PDF configuration.
360
- sig {
361
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData))
362
- }
363
- attr_accessor :invoice_data
364
- sig {
365
- params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData)).void
366
- }
367
- def initialize(enabled: nil, invoice_data: nil); end
368
- end
369
- class LineItem < Stripe::RequestParams
370
- class AdjustableQuantity < Stripe::RequestParams
371
- # Set to true if the quantity can be adjusted to any non-negative Integer.
372
- sig { returns(T::Boolean) }
373
- attr_accessor :enabled
374
- # The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.
375
- sig { returns(T.nilable(Integer)) }
376
- attr_accessor :maximum
377
- # The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
378
- sig { returns(T.nilable(Integer)) }
379
- attr_accessor :minimum
380
- sig {
381
- params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
382
- }
383
- def initialize(enabled: nil, maximum: nil, minimum: nil); end
384
- end
385
- # When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
386
- sig {
387
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::AdjustableQuantity))
388
- }
389
- attr_accessor :adjustable_quantity
390
- # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
391
- sig { returns(String) }
392
- attr_accessor :price
393
- # The quantity of the line item being purchased.
394
- sig { returns(Integer) }
395
- attr_accessor :quantity
396
- sig {
397
- params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::AdjustableQuantity), price: String, quantity: Integer).void
398
- }
399
- def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end
400
- end
401
- class OptionalItem < Stripe::RequestParams
402
- class AdjustableQuantity < Stripe::RequestParams
403
- # Set to true if the quantity can be adjusted to any non-negative integer.
404
- sig { returns(T::Boolean) }
405
- attr_accessor :enabled
406
- # The maximum quantity of this item the customer can purchase. By default this value is 99.
407
- sig { returns(T.nilable(Integer)) }
408
- attr_accessor :maximum
409
- # The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
410
- sig { returns(T.nilable(Integer)) }
411
- attr_accessor :minimum
412
- sig {
413
- params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
414
- }
415
- def initialize(enabled: nil, maximum: nil, minimum: nil); end
416
- end
417
- # When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
418
- sig {
419
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::OptionalItem::AdjustableQuantity))
420
- }
421
- attr_accessor :adjustable_quantity
422
- # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
423
- sig { returns(String) }
424
- attr_accessor :price
425
- # The initial quantity of the line item created when a customer chooses to add this optional item to their order.
426
- sig { returns(Integer) }
427
- attr_accessor :quantity
428
- sig {
429
- params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::CreateParams::OptionalItem::AdjustableQuantity), price: String, quantity: Integer).void
430
- }
431
- def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end
432
- end
433
- class PaymentIntentData < Stripe::RequestParams
434
- # Controls when the funds will be captured from the customer's account.
435
- sig { returns(T.nilable(String)) }
436
- attr_accessor :capture_method
437
- # An arbitrary string attached to the object. Often useful for displaying to users.
438
- sig { returns(T.nilable(String)) }
439
- attr_accessor :description
440
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
441
- sig { returns(T.nilable(T::Hash[String, String])) }
442
- attr_accessor :metadata
443
- # Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.
444
- #
445
- # When setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.
446
- #
447
- # When setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.
448
- #
449
- # If a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.
450
- #
451
- # If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.
452
- #
453
- # When processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
454
- sig { returns(T.nilable(String)) }
455
- attr_accessor :setup_future_usage
456
- # Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
457
- #
458
- # Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
459
- sig { returns(T.nilable(String)) }
460
- attr_accessor :statement_descriptor
461
- # Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
462
- sig { returns(T.nilable(String)) }
463
- attr_accessor :statement_descriptor_suffix
464
- # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
465
- sig { returns(T.nilable(String)) }
466
- attr_accessor :transfer_group
467
- sig {
468
- params(capture_method: T.nilable(String), description: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), setup_future_usage: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_group: T.nilable(String)).void
469
- }
470
- def initialize(
471
- capture_method: nil,
472
- description: nil,
473
- metadata: nil,
474
- setup_future_usage: nil,
475
- statement_descriptor: nil,
476
- statement_descriptor_suffix: nil,
477
- transfer_group: nil
478
- ); end
479
- end
480
- class PhoneNumberCollection < Stripe::RequestParams
481
- # Set to `true` to enable phone number collection.
482
- sig { returns(T::Boolean) }
483
- attr_accessor :enabled
484
- sig { params(enabled: T::Boolean).void }
485
- def initialize(enabled: nil); end
486
- end
487
- class Restrictions < Stripe::RequestParams
488
- class CompletedSessions < Stripe::RequestParams
489
- # The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
490
- sig { returns(Integer) }
491
- attr_accessor :limit
492
- sig { params(limit: Integer).void }
493
- def initialize(limit: nil); end
494
- end
495
- # Configuration for the `completed_sessions` restriction type.
496
- sig { returns(::Stripe::PaymentLinkService::CreateParams::Restrictions::CompletedSessions) }
497
- attr_accessor :completed_sessions
498
- sig {
499
- params(completed_sessions: ::Stripe::PaymentLinkService::CreateParams::Restrictions::CompletedSessions).void
500
- }
501
- def initialize(completed_sessions: nil); end
502
- end
503
- class ShippingAddressCollection < Stripe::RequestParams
504
- # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
505
- # shipping locations.
506
- sig { returns(T::Array[String]) }
507
- attr_accessor :allowed_countries
508
- sig { params(allowed_countries: T::Array[String]).void }
509
- def initialize(allowed_countries: nil); end
510
- end
511
- class ShippingOption < Stripe::RequestParams
512
- # The ID of the Shipping Rate to use for this shipping option.
513
- sig { returns(T.nilable(String)) }
514
- attr_accessor :shipping_rate
515
- sig { params(shipping_rate: T.nilable(String)).void }
516
- def initialize(shipping_rate: nil); end
517
- end
518
- class SubscriptionData < Stripe::RequestParams
519
- class InvoiceSettings < Stripe::RequestParams
520
- class Issuer < Stripe::RequestParams
521
- # The connected account being referenced when `type` is `account`.
522
- sig { returns(T.nilable(String)) }
523
- attr_accessor :account
524
- # Type of the account referenced in the request.
525
- sig { returns(String) }
526
- attr_accessor :type
527
- sig { params(account: T.nilable(String), type: String).void }
528
- def initialize(account: nil, type: nil); end
529
- end
530
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
531
- sig {
532
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
533
- }
534
- attr_accessor :issuer
535
- sig {
536
- params(issuer: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).void
537
- }
538
- def initialize(issuer: nil); end
539
- end
540
- class TrialSettings < Stripe::RequestParams
541
- class EndBehavior < Stripe::RequestParams
542
- # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
543
- sig { returns(String) }
544
- attr_accessor :missing_payment_method
545
- sig { params(missing_payment_method: String).void }
546
- def initialize(missing_payment_method: nil); end
547
- end
548
- # Defines how the subscription should behave when the user's free trial ends.
549
- sig {
550
- returns(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
551
- }
552
- attr_accessor :end_behavior
553
- sig {
554
- params(end_behavior: ::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
555
- }
556
- def initialize(end_behavior: nil); end
557
- end
558
- # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
559
- sig { returns(T.nilable(String)) }
560
- attr_accessor :description
561
- # All invoices will be billed using the specified settings.
562
- sig {
563
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings))
564
- }
565
- attr_accessor :invoice_settings
566
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
567
- sig { returns(T.nilable(T::Hash[String, String])) }
568
- attr_accessor :metadata
569
- # Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
570
- sig { returns(T.nilable(Integer)) }
571
- attr_accessor :trial_period_days
572
- # Settings related to subscription trials.
573
- sig {
574
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings))
575
- }
576
- attr_accessor :trial_settings
577
- sig {
578
- params(description: T.nilable(String), invoice_settings: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T::Hash[String, String]), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings)).void
579
- }
580
- def initialize(
581
- description: nil,
582
- invoice_settings: nil,
583
- metadata: nil,
584
- trial_period_days: nil,
585
- trial_settings: nil
586
- ); end
587
- end
588
- class TaxIdCollection < Stripe::RequestParams
589
- # Enable tax ID collection during checkout. Defaults to `false`.
590
- sig { returns(T::Boolean) }
591
- attr_accessor :enabled
592
- # Describes whether a tax ID is required during checkout. Defaults to `never`.
593
- sig { returns(T.nilable(String)) }
594
- attr_accessor :required
595
- sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
596
- def initialize(enabled: nil, required: nil); end
597
- end
598
- class TransferData < Stripe::RequestParams
599
- # The amount that will be transferred automatically when a charge succeeds.
600
- sig { returns(T.nilable(Integer)) }
601
- attr_accessor :amount
602
- # If specified, successful charges will be attributed to the destination
603
- # account for tax reporting, and the funds from charges will be transferred
604
- # to the destination account. The ID of the resulting transfer will be
605
- # returned on the successful charge's `transfer` field.
606
- sig { returns(String) }
607
- attr_accessor :destination
608
- sig { params(amount: T.nilable(Integer), destination: String).void }
609
- def initialize(amount: nil, destination: nil); end
610
- end
611
- # Behavior after the purchase is complete.
612
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion)) }
613
- attr_accessor :after_completion
614
- # Enables user redeemable promotion codes.
615
- sig { returns(T.nilable(T::Boolean)) }
616
- attr_accessor :allow_promotion_codes
617
- # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices.
618
- sig { returns(T.nilable(Integer)) }
619
- attr_accessor :application_fee_amount
620
- # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
621
- sig { returns(T.nilable(Float)) }
622
- attr_accessor :application_fee_percent
623
- # Configuration for automatic tax collection.
624
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax)) }
625
- attr_accessor :automatic_tax
626
- # Configuration for collecting the customer's billing address. Defaults to `auto`.
627
- sig { returns(T.nilable(String)) }
628
- attr_accessor :billing_address_collection
629
- # Configure fields to gather active consent from customers.
630
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection)) }
631
- attr_accessor :consent_collection
632
- # 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) and supported by each line item's price.
633
- sig { returns(T.nilable(String)) }
634
- attr_accessor :currency
635
- # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
636
- sig { returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField])) }
637
- attr_accessor :custom_fields
638
- # Display additional text for your customers using custom text.
639
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText)) }
640
- attr_accessor :custom_text
641
- # Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
642
- sig { returns(T.nilable(String)) }
643
- attr_accessor :customer_creation
644
- # Specifies which fields in the response should be expanded.
645
- sig { returns(T.nilable(T::Array[String])) }
646
- attr_accessor :expand
647
- # The custom message to be displayed to a customer when a payment link is no longer active.
648
- sig { returns(T.nilable(String)) }
649
- attr_accessor :inactive_message
650
- # Generate a post-purchase Invoice for one-time payments.
651
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation)) }
652
- attr_accessor :invoice_creation
653
- # The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
654
- sig { returns(T::Array[::Stripe::PaymentLinkService::CreateParams::LineItem]) }
655
- attr_accessor :line_items
656
- # 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
657
- sig { returns(T.nilable(T::Hash[String, String])) }
658
- attr_accessor :metadata
659
- # The account on behalf of which to charge.
660
- sig { returns(T.nilable(String)) }
661
- attr_accessor :on_behalf_of
662
- # A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
663
- # There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.
664
- # There is a maximum of 20 combined line items and optional items.
665
- sig { returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::OptionalItem])) }
666
- attr_accessor :optional_items
667
- # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
668
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::PaymentIntentData)) }
669
- attr_accessor :payment_intent_data
670
- # Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.
671
- #
672
- # Can only be set in `subscription` mode. Defaults to `always`.
673
- #
674
- # If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
675
- sig { returns(T.nilable(String)) }
676
- attr_accessor :payment_method_collection
677
- # The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).
678
- sig { returns(T.nilable(T::Array[String])) }
679
- attr_accessor :payment_method_types
680
- # Controls phone number collection settings during checkout.
681
- #
682
- # We recommend that you review your privacy policy and check with your legal contacts.
683
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::PhoneNumberCollection)) }
684
- attr_accessor :phone_number_collection
685
- # Settings that restrict the usage of a payment link.
686
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::Restrictions)) }
687
- attr_accessor :restrictions
688
- # Configuration for collecting the customer's shipping address.
689
- sig {
690
- returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ShippingAddressCollection))
691
- }
692
- attr_accessor :shipping_address_collection
693
- # The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
694
- sig {
695
- returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::ShippingOption]))
696
- }
697
- attr_accessor :shipping_options
698
- # Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
699
- sig { returns(T.nilable(String)) }
700
- attr_accessor :submit_type
701
- # When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
702
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData)) }
703
- attr_accessor :subscription_data
704
- # Controls tax ID collection during checkout.
705
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::TaxIdCollection)) }
706
- attr_accessor :tax_id_collection
707
- # The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
708
- sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::TransferData)) }
709
- attr_accessor :transfer_data
710
- sig {
711
- params(after_completion: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), application_fee_amount: T.nilable(Integer), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax), billing_address_collection: T.nilable(String), consent_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(String), invoice_creation: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation), line_items: T::Array[::Stripe::PaymentLinkService::CreateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), optional_items: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::OptionalItem]), payment_intent_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T::Array[String]), phone_number_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::PhoneNumberCollection), restrictions: T.nilable(::Stripe::PaymentLinkService::CreateParams::Restrictions), shipping_address_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::TaxIdCollection), transfer_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::TransferData)).void
712
- }
713
- def initialize(
714
- after_completion: nil,
715
- allow_promotion_codes: nil,
716
- application_fee_amount: nil,
717
- application_fee_percent: nil,
718
- automatic_tax: nil,
719
- billing_address_collection: nil,
720
- consent_collection: nil,
721
- currency: nil,
722
- custom_fields: nil,
723
- custom_text: nil,
724
- customer_creation: nil,
725
- expand: nil,
726
- inactive_message: nil,
727
- invoice_creation: nil,
728
- line_items: nil,
729
- metadata: nil,
730
- on_behalf_of: nil,
731
- optional_items: nil,
732
- payment_intent_data: nil,
733
- payment_method_collection: nil,
734
- payment_method_types: nil,
735
- phone_number_collection: nil,
736
- restrictions: nil,
737
- shipping_address_collection: nil,
738
- shipping_options: nil,
739
- submit_type: nil,
740
- subscription_data: nil,
741
- tax_id_collection: nil,
742
- transfer_data: nil
743
- ); end
744
- end
745
- class RetrieveParams < Stripe::RequestParams
746
- # Specifies which fields in the response should be expanded.
747
- sig { returns(T.nilable(T::Array[String])) }
748
- attr_accessor :expand
749
- sig { params(expand: T.nilable(T::Array[String])).void }
750
- def initialize(expand: nil); end
751
- end
752
- class UpdateParams < Stripe::RequestParams
753
- class AfterCompletion < Stripe::RequestParams
754
- class HostedConfirmation < Stripe::RequestParams
755
- # A custom message to display to the customer after the purchase is complete.
756
- sig { returns(T.nilable(String)) }
757
- attr_accessor :custom_message
758
- sig { params(custom_message: T.nilable(String)).void }
759
- def initialize(custom_message: nil); end
760
- end
761
- class Redirect < Stripe::RequestParams
762
- # The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.
763
- sig { returns(String) }
764
- attr_accessor :url
765
- sig { params(url: String).void }
766
- def initialize(url: nil); end
767
- end
768
- # Configuration when `type=hosted_confirmation`.
769
- sig {
770
- returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::HostedConfirmation))
771
- }
772
- attr_accessor :hosted_confirmation
773
- # Configuration when `type=redirect`.
774
- sig {
775
- returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::Redirect))
776
- }
777
- attr_accessor :redirect
778
- # The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.
779
- sig { returns(String) }
780
- attr_accessor :type
781
- sig {
782
- params(hosted_confirmation: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::Redirect), type: String).void
783
- }
784
- def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
785
- end
786
- class AutomaticTax < Stripe::RequestParams
787
- class Liability < Stripe::RequestParams
788
- # The connected account being referenced when `type` is `account`.
789
- sig { returns(T.nilable(String)) }
790
- attr_accessor :account
791
- # Type of the account referenced in the request.
792
- sig { returns(String) }
793
- attr_accessor :type
794
- sig { params(account: T.nilable(String), type: String).void }
795
- def initialize(account: nil, type: nil); end
796
- end
797
- # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
798
- #
799
- # Enabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.
800
- sig { returns(T::Boolean) }
801
- attr_accessor :enabled
802
- # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
803
- sig {
804
- returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax::Liability))
805
- }
806
- attr_accessor :liability
807
- sig {
808
- params(enabled: T::Boolean, liability: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax::Liability)).void
809
- }
810
- def initialize(enabled: nil, liability: nil); end
811
- end
812
- class CustomField < Stripe::RequestParams
813
- class Dropdown < Stripe::RequestParams
814
- class Option < Stripe::RequestParams
815
- # The label for the option, displayed to the customer. Up to 100 characters.
816
- sig { returns(String) }
817
- attr_accessor :label
818
- # The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
819
- sig { returns(String) }
820
- attr_accessor :value
821
- sig { params(label: String, value: String).void }
822
- def initialize(label: nil, value: nil); end
823
- end
824
- # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
825
- sig { returns(T.nilable(String)) }
826
- attr_accessor :default_value
827
- # The options available for the customer to select. Up to 200 options allowed.
828
- sig {
829
- returns(T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown::Option])
830
- }
831
- attr_accessor :options
832
- sig {
833
- params(default_value: T.nilable(String), options: T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown::Option]).void
834
- }
835
- def initialize(default_value: nil, options: nil); end
836
- end
837
- class Label < Stripe::RequestParams
838
- # Custom text for the label, displayed to the customer. Up to 50 characters.
839
- sig { returns(String) }
840
- attr_accessor :custom
841
- # The type of the label.
842
- sig { returns(String) }
843
- attr_accessor :type
844
- sig { params(custom: String, type: String).void }
845
- def initialize(custom: nil, type: nil); end
846
- end
847
- class Numeric < Stripe::RequestParams
848
- # The value that will pre-fill the field on the payment page.
849
- sig { returns(T.nilable(String)) }
850
- attr_accessor :default_value
851
- # The maximum character length constraint for the customer's input.
852
- sig { returns(T.nilable(Integer)) }
853
- attr_accessor :maximum_length
854
- # The minimum character length requirement for the customer's input.
855
- sig { returns(T.nilable(Integer)) }
856
- attr_accessor :minimum_length
857
- sig {
858
- params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
859
- }
860
- def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
861
- end
862
- class Text < Stripe::RequestParams
863
- # The value that will pre-fill the field on the payment page.
864
- sig { returns(T.nilable(String)) }
865
- attr_accessor :default_value
866
- # The maximum character length constraint for the customer's input.
867
- sig { returns(T.nilable(Integer)) }
868
- attr_accessor :maximum_length
869
- # The minimum character length requirement for the customer's input.
870
- sig { returns(T.nilable(Integer)) }
871
- attr_accessor :minimum_length
872
- sig {
873
- params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
874
- }
875
- def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
876
- end
877
- # Configuration for `type=dropdown` fields.
878
- sig {
879
- returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown))
880
- }
881
- attr_accessor :dropdown
882
- # String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
883
- sig { returns(String) }
884
- attr_accessor :key
885
- # The label for the field, displayed to the customer.
886
- sig { returns(::Stripe::PaymentLinkService::UpdateParams::CustomField::Label) }
887
- attr_accessor :label
888
- # Configuration for `type=numeric` fields.
889
- sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Numeric)) }
890
- attr_accessor :numeric
891
- # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
892
- sig { returns(T.nilable(T::Boolean)) }
893
- attr_accessor :optional
894
- # Configuration for `type=text` fields.
895
- sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Text)) }
896
- attr_accessor :text
897
- # The type of the field.
898
- sig { returns(String) }
899
- attr_accessor :type
900
- sig {
901
- params(dropdown: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown), key: String, label: ::Stripe::PaymentLinkService::UpdateParams::CustomField::Label, numeric: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Text), type: String).void
902
- }
903
- def initialize(
904
- dropdown: nil,
905
- key: nil,
906
- label: nil,
907
- numeric: nil,
908
- optional: nil,
909
- text: nil,
910
- type: nil
911
- ); end
912
- end
913
- class CustomText < Stripe::RequestParams
914
- class AfterSubmit < Stripe::RequestParams
915
- # Text may be up to 1200 characters in length.
916
- sig { returns(String) }
917
- attr_accessor :message
918
- sig { params(message: String).void }
919
- def initialize(message: nil); end
920
- end
921
- class ShippingAddress < Stripe::RequestParams
922
- # Text may be up to 1200 characters in length.
923
- sig { returns(String) }
924
- attr_accessor :message
925
- sig { params(message: String).void }
926
- def initialize(message: nil); end
927
- end
928
- class Submit < Stripe::RequestParams
929
- # Text may be up to 1200 characters in length.
930
- sig { returns(String) }
931
- attr_accessor :message
932
- sig { params(message: String).void }
933
- def initialize(message: nil); end
934
- end
935
- class TermsOfServiceAcceptance < Stripe::RequestParams
936
- # Text may be up to 1200 characters in length.
937
- sig { returns(String) }
938
- attr_accessor :message
939
- sig { params(message: String).void }
940
- def initialize(message: nil); end
941
- end
942
- # Custom text that should be displayed after the payment confirmation button.
943
- sig {
944
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::AfterSubmit))))
945
- }
946
- attr_accessor :after_submit
947
- # Custom text that should be displayed alongside shipping address collection.
948
- sig {
949
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::ShippingAddress))))
950
- }
951
- attr_accessor :shipping_address
952
- # Custom text that should be displayed alongside the payment confirmation button.
953
- sig {
954
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::Submit))))
955
- }
956
- attr_accessor :submit
957
- # Custom text that should be displayed in place of the default terms of service agreement text.
958
- sig {
959
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::TermsOfServiceAcceptance))))
960
- }
961
- attr_accessor :terms_of_service_acceptance
962
- sig {
963
- params(after_submit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::AfterSubmit))), shipping_address: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::ShippingAddress))), submit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::Submit))), terms_of_service_acceptance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::TermsOfServiceAcceptance)))).void
964
- }
965
- def initialize(
966
- after_submit: nil,
967
- shipping_address: nil,
968
- submit: nil,
969
- terms_of_service_acceptance: nil
970
- ); end
971
- end
972
- class InvoiceCreation < Stripe::RequestParams
973
- class InvoiceData < Stripe::RequestParams
974
- class CustomField < Stripe::RequestParams
975
- # The name of the custom field. This may be up to 40 characters.
976
- sig { returns(String) }
977
- attr_accessor :name
978
- # The value of the custom field. This may be up to 140 characters.
979
- sig { returns(String) }
980
- attr_accessor :value
981
- sig { params(name: String, value: String).void }
982
- def initialize(name: nil, value: nil); end
983
- end
984
- class Issuer < Stripe::RequestParams
985
- # The connected account being referenced when `type` is `account`.
986
- sig { returns(T.nilable(String)) }
987
- attr_accessor :account
988
- # Type of the account referenced in the request.
989
- sig { returns(String) }
990
- attr_accessor :type
991
- sig { params(account: T.nilable(String), type: String).void }
992
- def initialize(account: nil, type: nil); end
993
- end
994
- class RenderingOptions < Stripe::RequestParams
995
- # 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.
996
- sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
997
- attr_accessor :amount_tax_display
998
- sig { params(amount_tax_display: T.nilable(T.nilable(T.any(String, String)))).void }
999
- def initialize(amount_tax_display: nil); end
1000
- end
1001
- # The account tax IDs associated with the invoice.
1002
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
1003
- attr_accessor :account_tax_ids
1004
- # Default custom fields to be displayed on invoices for this customer.
1005
- sig {
1006
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::CustomField]))))
1007
- }
1008
- attr_accessor :custom_fields
1009
- # An arbitrary string attached to the object. Often useful for displaying to users.
1010
- sig { returns(T.nilable(String)) }
1011
- attr_accessor :description
1012
- # Default footer to be displayed on invoices for this customer.
1013
- sig { returns(T.nilable(String)) }
1014
- attr_accessor :footer
1015
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1016
- sig {
1017
- returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::Issuer))
1018
- }
1019
- attr_accessor :issuer
1020
- # 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`.
1021
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
1022
- attr_accessor :metadata
1023
- # Default options for invoice PDF rendering for this customer.
1024
- sig {
1025
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions))))
1026
- }
1027
- attr_accessor :rendering_options
1028
- sig {
1029
- params(account_tax_ids: T.nilable(T.nilable(T.any(String, T::Array[String]))), custom_fields: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::CustomField]))), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), rendering_options: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions)))).void
1030
- }
1031
- def initialize(
1032
- account_tax_ids: nil,
1033
- custom_fields: nil,
1034
- description: nil,
1035
- footer: nil,
1036
- issuer: nil,
1037
- metadata: nil,
1038
- rendering_options: nil
1039
- ); end
1040
- end
1041
- # Whether the feature is enabled
1042
- sig { returns(T::Boolean) }
1043
- attr_accessor :enabled
1044
- # Invoice PDF configuration.
1045
- sig {
1046
- returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData))
1047
- }
1048
- attr_accessor :invoice_data
1049
- sig {
1050
- params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData)).void
1051
- }
1052
- def initialize(enabled: nil, invoice_data: nil); end
1053
- end
1054
- class LineItem < Stripe::RequestParams
1055
- class AdjustableQuantity < Stripe::RequestParams
1056
- # Set to true if the quantity can be adjusted to any non-negative Integer.
1057
- sig { returns(T::Boolean) }
1058
- attr_accessor :enabled
1059
- # The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.
1060
- sig { returns(T.nilable(Integer)) }
1061
- attr_accessor :maximum
1062
- # The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
1063
- sig { returns(T.nilable(Integer)) }
1064
- attr_accessor :minimum
1065
- sig {
1066
- params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
1067
- }
1068
- def initialize(enabled: nil, maximum: nil, minimum: nil); end
1069
- end
1070
- # When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
1071
- sig {
1072
- returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::LineItem::AdjustableQuantity))
1073
- }
1074
- attr_accessor :adjustable_quantity
1075
- # The ID of an existing line item on the payment link.
1076
- sig { returns(String) }
1077
- attr_accessor :id
1078
- # The quantity of the line item being purchased.
1079
- sig { returns(T.nilable(Integer)) }
1080
- attr_accessor :quantity
1081
- sig {
1082
- params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::UpdateParams::LineItem::AdjustableQuantity), id: String, quantity: T.nilable(Integer)).void
1083
- }
1084
- def initialize(adjustable_quantity: nil, id: nil, quantity: nil); end
1085
- end
1086
- class PaymentIntentData < Stripe::RequestParams
1087
- # An arbitrary string attached to the object. Often useful for displaying to users.
1088
- sig { returns(T.nilable(T.nilable(String))) }
1089
- attr_accessor :description
1090
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
1091
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
1092
- attr_accessor :metadata
1093
- # Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
1094
- #
1095
- # Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
1096
- sig { returns(T.nilable(T.nilable(String))) }
1097
- attr_accessor :statement_descriptor
1098
- # Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
1099
- sig { returns(T.nilable(T.nilable(String))) }
1100
- attr_accessor :statement_descriptor_suffix
1101
- # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
1102
- sig { returns(T.nilable(T.nilable(String))) }
1103
- attr_accessor :transfer_group
1104
- sig {
1105
- params(description: T.nilable(T.nilable(String)), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), statement_descriptor: T.nilable(T.nilable(String)), statement_descriptor_suffix: T.nilable(T.nilable(String)), transfer_group: T.nilable(T.nilable(String))).void
1106
- }
1107
- def initialize(
1108
- description: nil,
1109
- metadata: nil,
1110
- statement_descriptor: nil,
1111
- statement_descriptor_suffix: nil,
1112
- transfer_group: nil
1113
- ); end
1114
- end
1115
- class PhoneNumberCollection < Stripe::RequestParams
1116
- # Set to `true` to enable phone number collection.
1117
- sig { returns(T::Boolean) }
1118
- attr_accessor :enabled
1119
- sig { params(enabled: T::Boolean).void }
1120
- def initialize(enabled: nil); end
1121
- end
1122
- class Restrictions < Stripe::RequestParams
1123
- class CompletedSessions < Stripe::RequestParams
1124
- # The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
1125
- sig { returns(Integer) }
1126
- attr_accessor :limit
1127
- sig { params(limit: Integer).void }
1128
- def initialize(limit: nil); end
1129
- end
1130
- # Configuration for the `completed_sessions` restriction type.
1131
- sig { returns(::Stripe::PaymentLinkService::UpdateParams::Restrictions::CompletedSessions) }
1132
- attr_accessor :completed_sessions
1133
- sig {
1134
- params(completed_sessions: ::Stripe::PaymentLinkService::UpdateParams::Restrictions::CompletedSessions).void
1135
- }
1136
- def initialize(completed_sessions: nil); end
1137
- end
1138
- class ShippingAddressCollection < Stripe::RequestParams
1139
- # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1140
- # shipping locations.
1141
- sig { returns(T::Array[String]) }
1142
- attr_accessor :allowed_countries
1143
- sig { params(allowed_countries: T::Array[String]).void }
1144
- def initialize(allowed_countries: nil); end
1145
- end
1146
- class SubscriptionData < Stripe::RequestParams
1147
- class InvoiceSettings < Stripe::RequestParams
1148
- class Issuer < Stripe::RequestParams
1149
- # The connected account being referenced when `type` is `account`.
1150
- sig { returns(T.nilable(String)) }
1151
- attr_accessor :account
1152
- # Type of the account referenced in the request.
1153
- sig { returns(String) }
1154
- attr_accessor :type
1155
- sig { params(account: T.nilable(String), type: String).void }
1156
- def initialize(account: nil, type: nil); end
1157
- end
1158
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1159
- sig {
1160
- returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer))
1161
- }
1162
- attr_accessor :issuer
1163
- sig {
1164
- params(issuer: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)).void
1165
- }
1166
- def initialize(issuer: nil); end
1167
- end
1168
- class TrialSettings < Stripe::RequestParams
1169
- class EndBehavior < Stripe::RequestParams
1170
- # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
1171
- sig { returns(String) }
1172
- attr_accessor :missing_payment_method
1173
- sig { params(missing_payment_method: String).void }
1174
- def initialize(missing_payment_method: nil); end
1175
- end
1176
- # Defines how the subscription should behave when the user's free trial ends.
1177
- sig {
1178
- returns(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings::EndBehavior)
1179
- }
1180
- attr_accessor :end_behavior
1181
- sig {
1182
- params(end_behavior: ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings::EndBehavior).void
1183
- }
1184
- def initialize(end_behavior: nil); end
1185
- end
1186
- # All invoices will be billed using the specified settings.
1187
- sig {
1188
- returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings))
1189
- }
1190
- attr_accessor :invoice_settings
1191
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
1192
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
1193
- attr_accessor :metadata
1194
- # Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
1195
- sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
1196
- attr_accessor :trial_period_days
1197
- # Settings related to subscription trials.
1198
- sig {
1199
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings))))
1200
- }
1201
- attr_accessor :trial_settings
1202
- sig {
1203
- params(invoice_settings: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), trial_period_days: T.nilable(T.nilable(T.any(String, Integer))), trial_settings: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings)))).void
1204
- }
1205
- def initialize(
1206
- invoice_settings: nil,
1207
- metadata: nil,
1208
- trial_period_days: nil,
1209
- trial_settings: nil
1210
- ); end
1211
- end
1212
- class TaxIdCollection < Stripe::RequestParams
1213
- # Enable tax ID collection during checkout. Defaults to `false`.
1214
- sig { returns(T::Boolean) }
1215
- attr_accessor :enabled
1216
- # Describes whether a tax ID is required during checkout. Defaults to `never`.
1217
- sig { returns(T.nilable(String)) }
1218
- attr_accessor :required
1219
- sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
1220
- def initialize(enabled: nil, required: nil); end
1221
- end
1222
- # Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.
1223
- sig { returns(T.nilable(T::Boolean)) }
1224
- attr_accessor :active
1225
- # Behavior after the purchase is complete.
1226
- sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion)) }
1227
- attr_accessor :after_completion
1228
- # Enables user redeemable promotion codes.
1229
- sig { returns(T.nilable(T::Boolean)) }
1230
- attr_accessor :allow_promotion_codes
1231
- # Configuration for automatic tax collection.
1232
- sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax)) }
1233
- attr_accessor :automatic_tax
1234
- # Configuration for collecting the customer's billing address. Defaults to `auto`.
1235
- sig { returns(T.nilable(String)) }
1236
- attr_accessor :billing_address_collection
1237
- # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
1238
- sig {
1239
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField]))))
1240
- }
1241
- attr_accessor :custom_fields
1242
- # Display additional text for your customers using custom text.
1243
- sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText)) }
1244
- attr_accessor :custom_text
1245
- # Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
1246
- sig { returns(T.nilable(String)) }
1247
- attr_accessor :customer_creation
1248
- # Specifies which fields in the response should be expanded.
1249
- sig { returns(T.nilable(T::Array[String])) }
1250
- attr_accessor :expand
1251
- # The custom message to be displayed to a customer when a payment link is no longer active.
1252
- sig { returns(T.nilable(T.nilable(String))) }
1253
- attr_accessor :inactive_message
1254
- # Generate a post-purchase Invoice for one-time payments.
1255
- sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation)) }
1256
- attr_accessor :invoice_creation
1257
- # The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
1258
- sig { returns(T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::LineItem])) }
1259
- attr_accessor :line_items
1260
- # 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
1261
- sig { returns(T.nilable(T::Hash[String, String])) }
1262
- attr_accessor :metadata
1263
- # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
1264
- sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::PaymentIntentData)) }
1265
- attr_accessor :payment_intent_data
1266
- # Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.
1267
- #
1268
- # Can only be set in `subscription` mode. Defaults to `always`.
1269
- #
1270
- # If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
1271
- sig { returns(T.nilable(String)) }
1272
- attr_accessor :payment_method_collection
1273
- # The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
1274
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
1275
- attr_accessor :payment_method_types
1276
- # Controls phone number collection settings during checkout.
1277
- #
1278
- # We recommend that you review your privacy policy and check with your legal contacts.
1279
- sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::PhoneNumberCollection)) }
1280
- attr_accessor :phone_number_collection
1281
- # Settings that restrict the usage of a payment link.
1282
- sig {
1283
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::Restrictions))))
1284
- }
1285
- attr_accessor :restrictions
1286
- # Configuration for collecting the customer's shipping address.
1287
- sig {
1288
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::ShippingAddressCollection))))
1289
- }
1290
- attr_accessor :shipping_address_collection
1291
- # Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
1292
- sig { returns(T.nilable(String)) }
1293
- attr_accessor :submit_type
1294
- # When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
1295
- sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData)) }
1296
- attr_accessor :subscription_data
1297
- # Controls tax ID collection during checkout.
1298
- sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::TaxIdCollection)) }
1299
- attr_accessor :tax_id_collection
1300
- sig {
1301
- params(active: T.nilable(T::Boolean), after_completion: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax), billing_address_collection: T.nilable(String), custom_fields: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField]))), custom_text: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(T.nilable(String)), invoice_creation: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), payment_intent_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T.nilable(T.any(String, T::Array[String]))), phone_number_collection: T.nilable(::Stripe::PaymentLinkService::UpdateParams::PhoneNumberCollection), restrictions: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::Restrictions))), shipping_address_collection: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::ShippingAddressCollection))), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLinkService::UpdateParams::TaxIdCollection)).void
1302
- }
1303
- def initialize(
1304
- active: nil,
1305
- after_completion: nil,
1306
- allow_promotion_codes: nil,
1307
- automatic_tax: nil,
1308
- billing_address_collection: nil,
1309
- custom_fields: nil,
1310
- custom_text: nil,
1311
- customer_creation: nil,
1312
- expand: nil,
1313
- inactive_message: nil,
1314
- invoice_creation: nil,
1315
- line_items: nil,
1316
- metadata: nil,
1317
- payment_intent_data: nil,
1318
- payment_method_collection: nil,
1319
- payment_method_types: nil,
1320
- phone_number_collection: nil,
1321
- restrictions: nil,
1322
- shipping_address_collection: nil,
1323
- submit_type: nil,
1324
- subscription_data: nil,
1325
- tax_id_collection: nil
1326
- ); end
1327
- end
1328
- # Creates a payment link.
1329
- sig {
1330
- params(params: T.any(::Stripe::PaymentLinkService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentLink)
1331
- }
1332
- def create(params = {}, opts = {}); end
1333
-
1334
- # Returns a list of your payment links.
1335
- sig {
1336
- params(params: T.any(::Stripe::PaymentLinkService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1337
- }
1338
- def list(params = {}, opts = {}); end
1339
-
1340
- # Retrieve a payment link.
1341
- sig {
1342
- params(payment_link: String, params: T.any(::Stripe::PaymentLinkService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentLink)
1343
- }
1344
- def retrieve(payment_link, params = {}, opts = {}); end
1345
-
1346
- # Updates a payment link.
1347
- sig {
1348
- params(payment_link: String, params: T.any(::Stripe::PaymentLinkService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentLink)
1349
- }
1350
- def update(payment_link, params = {}, opts = {}); end
1351
- end
1352
- end