stripe 15.4.0 → 15.5.0.pre.beta.1

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