stripe 13.5.0 → 14.0.0

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 (641) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +33 -3
  3. data/Gemfile +4 -0
  4. data/OPENAPI_VERSION +1 -1
  5. data/README.md +29 -0
  6. data/VERSION +1 -1
  7. data/lib/stripe/api_operations/request.rb +1 -0
  8. data/lib/stripe/api_requestor.rb +3 -0
  9. data/lib/stripe/api_version.rb +1 -1
  10. data/lib/stripe/errors.rb +0 -7
  11. data/lib/stripe/object_types.rb +8 -2
  12. data/lib/stripe/request_params.rb +24 -0
  13. data/lib/stripe/resources/account.rb +4634 -0
  14. data/lib/stripe/resources/account_link.rb +54 -0
  15. data/lib/stripe/resources/account_session.rb +739 -0
  16. data/lib/stripe/resources/apple_pay_domain.rb +54 -0
  17. data/lib/stripe/resources/application.rb +20 -0
  18. data/lib/stripe/resources/application_fee.rb +87 -0
  19. data/lib/stripe/resources/application_fee_refund.rb +17 -0
  20. data/lib/stripe/resources/apps/secret.rb +141 -0
  21. data/lib/stripe/resources/balance.rb +122 -0
  22. data/lib/stripe/resources/balance_transaction.rb +103 -0
  23. data/lib/stripe/resources/bank_account.rb +84 -2
  24. data/lib/stripe/resources/billing/alert.rb +135 -0
  25. data/lib/stripe/resources/billing/alert_triggered.rb +26 -0
  26. data/lib/stripe/resources/billing/credit_balance_summary.rb +40 -0
  27. data/lib/stripe/resources/billing/credit_balance_transaction.rb +107 -0
  28. data/lib/stripe/resources/billing/credit_grant.rb +217 -0
  29. data/lib/stripe/resources/billing/meter.rb +169 -0
  30. data/lib/stripe/resources/billing/meter_event.rb +35 -0
  31. data/lib/stripe/resources/billing/meter_event_adjustment.rb +43 -0
  32. data/lib/stripe/resources/billing/meter_event_summary.rb +15 -0
  33. data/lib/stripe/resources/billing_portal/configuration.rb +553 -0
  34. data/lib/stripe/resources/billing_portal/session.rb +271 -0
  35. data/lib/stripe/resources/capability.rb +84 -0
  36. data/lib/stripe/resources/card.rb +77 -0
  37. data/lib/stripe/resources/cash_balance.rb +17 -0
  38. data/lib/stripe/resources/charge.rb +1612 -0
  39. data/lib/stripe/resources/checkout/session.rb +3530 -6
  40. data/lib/stripe/resources/climate/order.rb +167 -0
  41. data/lib/stripe/resources/climate/product.rb +47 -0
  42. data/lib/stripe/resources/climate/supplier.rb +45 -0
  43. data/lib/stripe/resources/confirmation_token.rb +1448 -0
  44. data/lib/stripe/resources/connect_collection_transfer.rb +24 -0
  45. data/lib/stripe/resources/country_spec.rb +54 -0
  46. data/lib/stripe/resources/coupon.rb +189 -0
  47. data/lib/stripe/resources/credit_note.rb +639 -0
  48. data/lib/stripe/resources/credit_note_line_item.rb +67 -0
  49. data/lib/stripe/resources/customer.rb +824 -0
  50. data/lib/stripe/resources/customer_balance_transaction.rb +29 -0
  51. data/lib/stripe/resources/customer_cash_balance_transaction.rb +109 -0
  52. data/lib/stripe/resources/customer_session.rb +159 -0
  53. data/lib/stripe/resources/discount.rb +29 -0
  54. data/lib/stripe/resources/dispute.rb +610 -0
  55. data/lib/stripe/resources/entitlements/active_entitlement.rb +37 -0
  56. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +23 -0
  57. data/lib/stripe/resources/entitlements/feature.rb +81 -0
  58. data/lib/stripe/resources/ephemeral_key.rb +21 -0
  59. data/lib/stripe/resources/event.rb +90 -0
  60. data/lib/stripe/resources/exchange_rate.rb +24 -0
  61. data/lib/stripe/resources/file.rb +102 -0
  62. data/lib/stripe/resources/file_link.rb +103 -0
  63. data/lib/stripe/resources/financial_connections/account.rb +237 -0
  64. data/lib/stripe/resources/financial_connections/account_owner.rb +17 -0
  65. data/lib/stripe/resources/financial_connections/account_ownership.rb +9 -0
  66. data/lib/stripe/resources/financial_connections/session.rb +95 -0
  67. data/lib/stripe/resources/financial_connections/transaction.rb +92 -0
  68. data/lib/stripe/resources/forwarding/request.rb +156 -0
  69. data/lib/stripe/resources/funding_instructions.rb +308 -0
  70. data/lib/stripe/resources/identity/verification_report.rb +257 -0
  71. data/lib/stripe/resources/identity/verification_session.rb +352 -0
  72. data/lib/stripe/resources/invoice.rb +3204 -21
  73. data/lib/stripe/resources/invoice_item.rb +400 -0
  74. data/lib/stripe/resources/invoice_line_item.rb +350 -0
  75. data/lib/stripe/resources/invoice_payment.rb +105 -0
  76. data/lib/stripe/resources/invoice_rendering_template.rb +55 -0
  77. data/lib/stripe/resources/issuing/authorization.rb +1104 -0
  78. data/lib/stripe/resources/issuing/card.rb +657 -0
  79. data/lib/stripe/resources/issuing/cardholder.rb +648 -0
  80. data/lib/stripe/resources/issuing/dispute.rb +781 -0
  81. data/lib/stripe/resources/issuing/personalization_design.rb +276 -0
  82. data/lib/stripe/resources/issuing/physical_bundle.rb +54 -0
  83. data/lib/stripe/resources/issuing/token.rb +166 -0
  84. data/lib/stripe/resources/issuing/transaction.rb +912 -0
  85. data/lib/stripe/resources/line_item.rb +47 -0
  86. data/lib/stripe/resources/login_link.rb +7 -0
  87. data/lib/stripe/resources/mandate.rb +142 -0
  88. data/lib/stripe/resources/payment_intent.rb +8650 -0
  89. data/lib/stripe/resources/payment_link.rb +1632 -0
  90. data/lib/stripe/resources/payment_method.rb +1542 -0
  91. data/lib/stripe/resources/payment_method_configuration.rb +2776 -0
  92. data/lib/stripe/resources/payment_method_domain.rb +150 -6
  93. data/lib/stripe/resources/payout.rb +209 -0
  94. data/lib/stripe/resources/person.rb +264 -1
  95. data/lib/stripe/resources/plan.rb +302 -0
  96. data/lib/stripe/resources/price.rb +605 -1
  97. data/lib/stripe/resources/product.rb +472 -0
  98. data/lib/stripe/resources/product_feature.rb +12 -0
  99. data/lib/stripe/resources/promotion_code.rb +212 -0
  100. data/lib/stripe/resources/quote.rb +917 -0
  101. data/lib/stripe/resources/radar/early_fraud_warning.rb +68 -0
  102. data/lib/stripe/resources/radar/value_list.rb +116 -0
  103. data/lib/stripe/resources/radar/value_list_item.rb +86 -0
  104. data/lib/stripe/resources/refund.rb +392 -0
  105. data/lib/stripe/resources/reporting/report_run.rb +141 -0
  106. data/lib/stripe/resources/reporting/report_type.rb +27 -0
  107. data/lib/stripe/resources/reserve_transaction.rb +22 -0
  108. data/lib/stripe/resources/reversal.rb +21 -0
  109. data/lib/stripe/resources/review.rb +99 -0
  110. data/lib/stripe/resources/setup_attempt.rb +368 -0
  111. data/lib/stripe/resources/setup_intent.rb +3473 -0
  112. data/lib/stripe/resources/shipping_rate.rb +250 -0
  113. data/lib/stripe/resources/sigma/scheduled_query_run.rb +45 -0
  114. data/lib/stripe/resources/source.rb +1198 -0
  115. data/lib/stripe/resources/source_mandate_notification.rb +66 -0
  116. data/lib/stripe/resources/source_transaction.rb +85 -0
  117. data/lib/stripe/resources/subscription.rb +1686 -0
  118. data/lib/stripe/resources/subscription_item.rb +313 -5
  119. data/lib/stripe/resources/subscription_schedule.rb +1281 -0
  120. data/lib/stripe/resources/tax/calculation.rb +378 -0
  121. data/lib/stripe/resources/tax/calculation_line_item.rb +56 -0
  122. data/lib/stripe/resources/tax/registration.rb +2373 -0
  123. data/lib/stripe/resources/tax/settings.rb +117 -0
  124. data/lib/stripe/resources/tax/transaction.rb +258 -0
  125. data/lib/stripe/resources/tax/transaction_line_item.rb +31 -0
  126. data/lib/stripe/resources/tax_code.rb +26 -0
  127. data/lib/stripe/resources/tax_deducted_at_source.rb +22 -0
  128. data/lib/stripe/resources/tax_id.rb +112 -0
  129. data/lib/stripe/resources/tax_rate.rb +191 -0
  130. data/lib/stripe/resources/terminal/configuration.rb +1260 -0
  131. data/lib/stripe/resources/terminal/connection_token.rb +18 -0
  132. data/lib/stripe/resources/terminal/location.rb +166 -0
  133. data/lib/stripe/resources/terminal/reader.rb +427 -0
  134. data/lib/stripe/resources/test_helpers/test_clock.rb +77 -0
  135. data/lib/stripe/resources/token.rb +1159 -0
  136. data/lib/stripe/resources/topup.rb +165 -0
  137. data/lib/stripe/resources/transfer.rb +144 -0
  138. data/lib/stripe/resources/treasury/credit_reversal.rb +83 -0
  139. data/lib/stripe/resources/treasury/debit_reversal.rb +94 -0
  140. data/lib/stripe/resources/treasury/financial_account.rb +725 -1
  141. data/lib/stripe/resources/treasury/financial_account_features.rb +189 -0
  142. data/lib/stripe/resources/treasury/inbound_transfer.rb +226 -0
  143. data/lib/stripe/resources/treasury/outbound_payment.rb +486 -0
  144. data/lib/stripe/resources/treasury/outbound_transfer.rb +341 -0
  145. data/lib/stripe/resources/treasury/received_credit.rb +237 -0
  146. data/lib/stripe/resources/treasury/received_debit.rb +196 -0
  147. data/lib/stripe/resources/treasury/transaction.rb +167 -0
  148. data/lib/stripe/resources/treasury/transaction_entry.rb +148 -0
  149. data/lib/stripe/resources/v2/amount.rb +9 -0
  150. data/lib/stripe/resources/v2/billing/meter_event.rb +18 -0
  151. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +21 -0
  152. data/lib/stripe/resources/v2/billing/meter_event_session.rb +14 -0
  153. data/lib/stripe/resources/v2/event.rb +28 -0
  154. data/lib/stripe/resources/v2/event_destination.rb +60 -0
  155. data/lib/stripe/resources/webhook_endpoint.rb +113 -0
  156. data/lib/stripe/resources.rb +8 -2
  157. data/lib/stripe/services/account_capability_service.rb +32 -0
  158. data/lib/stripe/services/account_external_account_service.rb +250 -0
  159. data/lib/stripe/services/account_link_service.rb +46 -0
  160. data/lib/stripe/services/account_login_link_service.rb +9 -0
  161. data/lib/stripe/services/account_person_service.rb +875 -0
  162. data/lib/stripe/services/account_service.rb +4000 -0
  163. data/lib/stripe/services/account_session_service.rb +484 -0
  164. data/lib/stripe/services/apple_pay_domain_service.rb +51 -0
  165. data/lib/stripe/services/application_fee_refund_service.rb +54 -0
  166. data/lib/stripe/services/application_fee_service.rb +57 -0
  167. data/lib/stripe/services/apps/secret_service.rb +116 -0
  168. data/lib/stripe/services/balance_service.rb +9 -0
  169. data/lib/stripe/services/balance_transaction_service.rb +69 -0
  170. data/lib/stripe/services/billing/alert_service.rb +113 -0
  171. data/lib/stripe/services/billing/credit_balance_summary_service.rb +48 -0
  172. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +40 -0
  173. data/lib/stripe/services/billing/credit_grant_service.rb +166 -0
  174. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +26 -0
  175. data/lib/stripe/services/billing/meter_event_service.rb +21 -0
  176. data/lib/stripe/services/billing/meter_event_summary_service.rb +39 -0
  177. data/lib/stripe/services/billing/meter_service.rb +130 -0
  178. data/lib/stripe/services/billing_portal/configuration_service.rb +444 -0
  179. data/lib/stripe/services/billing_portal/session_service.rb +173 -0
  180. data/lib/stripe/services/charge_service.rb +402 -0
  181. data/lib/stripe/services/checkout/session_line_item_service.rb +18 -0
  182. data/lib/stripe/services/checkout/session_service.rb +2399 -5
  183. data/lib/stripe/services/climate/order_service.rb +102 -0
  184. data/lib/stripe/services/climate/product_service.rb +27 -0
  185. data/lib/stripe/services/climate/supplier_service.rb +27 -0
  186. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  187. data/lib/stripe/services/country_spec_service.rb +27 -0
  188. data/lib/stripe/services/coupon_service.rb +152 -0
  189. data/lib/stripe/services/credit_note_line_item_service.rb +18 -0
  190. data/lib/stripe/services/credit_note_preview_lines_service.rb +152 -0
  191. data/lib/stripe/services/credit_note_service.rb +365 -0
  192. data/lib/stripe/services/customer_balance_transaction_service.rb +63 -0
  193. data/lib/stripe/services/customer_cash_balance_service.rb +29 -0
  194. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +27 -0
  195. data/lib/stripe/services/customer_funding_instructions_service.rb +42 -0
  196. data/lib/stripe/services/customer_payment_method_service.rb +40 -0
  197. data/lib/stripe/services/customer_payment_source_service.rb +179 -0
  198. data/lib/stripe/services/customer_service.rb +577 -0
  199. data/lib/stripe/services/customer_session_service.rb +96 -0
  200. data/lib/stripe/services/customer_tax_id_service.rb +45 -0
  201. data/lib/stripe/services/dispute_service.rb +374 -0
  202. data/lib/stripe/services/entitlements/active_entitlement_service.rb +36 -0
  203. data/lib/stripe/services/entitlements/feature_service.rb +76 -0
  204. data/lib/stripe/services/ephemeral_key_service.rb +36 -0
  205. data/lib/stripe/services/event_service.rb +65 -0
  206. data/lib/stripe/services/exchange_rate_service.rb +27 -0
  207. data/lib/stripe/services/file_link_service.rb +94 -0
  208. data/lib/stripe/services/file_service.rb +89 -0
  209. data/lib/stripe/services/financial_connections/account_owner_service.rb +27 -0
  210. data/lib/stripe/services/financial_connections/account_service.rb +96 -0
  211. data/lib/stripe/services/financial_connections/session_service.rb +68 -0
  212. data/lib/stripe/services/financial_connections/transaction_service.rb +70 -0
  213. data/lib/stripe/services/forwarding/request_service.rb +106 -0
  214. data/lib/stripe/services/identity/verification_report_service.rb +65 -0
  215. data/lib/stripe/services/identity/verification_session_service.rb +231 -0
  216. data/lib/stripe/services/invoice_item_service.rb +334 -0
  217. data/lib/stripe/services/invoice_line_item_service.rb +221 -0
  218. data/lib/stripe/services/invoice_payment_service.rb +83 -0
  219. data/lib/stripe/services/invoice_rendering_template_service.rb +51 -0
  220. data/lib/stripe/services/invoice_service.rb +2648 -19
  221. data/lib/stripe/services/issuing/authorization_service.rb +104 -0
  222. data/lib/stripe/services/issuing/card_service.rb +455 -0
  223. data/lib/stripe/services/issuing/cardholder_service.rb +525 -0
  224. data/lib/stripe/services/issuing/dispute_service.rb +633 -0
  225. data/lib/stripe/services/issuing/personalization_design_service.rb +193 -0
  226. data/lib/stripe/services/issuing/physical_bundle_service.rb +40 -0
  227. data/lib/stripe/services/issuing/token_service.rb +73 -0
  228. data/lib/stripe/services/issuing/transaction_service.rb +77 -0
  229. data/lib/stripe/services/mandate_service.rb +9 -0
  230. data/lib/stripe/services/payment_intent_service.rb +7054 -0
  231. data/lib/stripe/services/payment_link_line_item_service.rb +18 -0
  232. data/lib/stripe/services/payment_link_service.rb +1276 -0
  233. data/lib/stripe/services/payment_method_configuration_service.rb +2004 -0
  234. data/lib/stripe/services/payment_method_domain_service.rb +79 -3
  235. data/lib/stripe/services/payment_method_service.rb +808 -0
  236. data/lib/stripe/services/payout_service.rb +159 -0
  237. data/lib/stripe/services/plan_service.rb +249 -0
  238. data/lib/stripe/services/price_service.rb +494 -1
  239. data/lib/stripe/services/product_feature_service.rb +42 -0
  240. data/lib/stripe/services/product_service.rb +425 -0
  241. data/lib/stripe/services/promotion_code_service.rb +178 -0
  242. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +18 -0
  243. data/lib/stripe/services/quote_line_item_service.rb +18 -0
  244. data/lib/stripe/services/quote_service.rb +611 -0
  245. data/lib/stripe/services/radar/early_fraud_warning_service.rb +61 -0
  246. data/lib/stripe/services/radar/value_list_item_service.rb +79 -0
  247. data/lib/stripe/services/radar/value_list_service.rb +103 -0
  248. data/lib/stripe/services/refund_service.rb +137 -0
  249. data/lib/stripe/services/reporting/report_run_service.rb +106 -0
  250. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  251. data/lib/stripe/services/review_service.rb +56 -0
  252. data/lib/stripe/services/setup_attempt_service.rb +51 -0
  253. data/lib/stripe/services/setup_intent_service.rb +3163 -0
  254. data/lib/stripe/services/shipping_rate_service.rb +200 -0
  255. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +27 -0
  256. data/lib/stripe/services/source_service.rb +601 -0
  257. data/lib/stripe/services/source_transaction_service.rb +18 -0
  258. data/lib/stripe/services/subscription_item_service.rb +282 -5
  259. data/lib/stripe/services/subscription_schedule_service.rb +1062 -0
  260. data/lib/stripe/services/subscription_service.rb +1412 -0
  261. data/lib/stripe/services/tax/calculation_line_item_service.rb +18 -0
  262. data/lib/stripe/services/tax/calculation_service.rb +205 -0
  263. data/lib/stripe/services/tax/registration_service.rb +1564 -0
  264. data/lib/stripe/services/tax/settings_service.rb +74 -0
  265. data/lib/stripe/services/tax/transaction_line_item_service.rb +18 -0
  266. data/lib/stripe/services/tax/transaction_service.rb +111 -0
  267. data/lib/stripe/services/tax_code_service.rb +27 -0
  268. data/lib/stripe/services/tax_id_service.rb +79 -0
  269. data/lib/stripe/services/tax_rate_service.rb +155 -0
  270. data/lib/stripe/services/terminal/configuration_service.rb +997 -0
  271. data/lib/stripe/services/terminal/connection_token_service.rb +12 -0
  272. data/lib/stripe/services/terminal/location_service.rb +144 -0
  273. data/lib/stripe/services/terminal/reader_service.rb +266 -0
  274. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +642 -0
  275. data/lib/stripe/services/test_helpers/customer_service.rb +18 -0
  276. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +745 -0
  277. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  278. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +41 -0
  279. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +632 -0
  280. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  281. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +44 -0
  282. data/lib/stripe/services/test_helpers/test_clock_service.rb +57 -0
  283. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +38 -0
  284. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +87 -0
  285. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +87 -0
  286. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +60 -0
  287. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +60 -0
  288. data/lib/stripe/services/token_service.rb +1140 -0
  289. data/lib/stripe/services/topup_service.rb +142 -0
  290. data/lib/stripe/services/transfer_reversal_service.rb +66 -0
  291. data/lib/stripe/services/transfer_service.rb +119 -0
  292. data/lib/stripe/services/treasury/credit_reversal_service.rb +59 -0
  293. data/lib/stripe/services/treasury/debit_reversal_service.rb +63 -0
  294. data/lib/stripe/services/treasury/financial_account_features_service.rb +166 -0
  295. data/lib/stripe/services/treasury/financial_account_service.rb +485 -1
  296. data/lib/stripe/services/treasury/inbound_transfer_service.rb +88 -0
  297. data/lib/stripe/services/treasury/outbound_payment_service.rb +258 -0
  298. data/lib/stripe/services/treasury/outbound_transfer_service.rb +124 -0
  299. data/lib/stripe/services/treasury/received_credit_service.rb +52 -0
  300. data/lib/stripe/services/treasury/received_debit_service.rb +40 -0
  301. data/lib/stripe/services/treasury/transaction_entry_service.rb +87 -0
  302. data/lib/stripe/services/treasury/transaction_service.rb +95 -0
  303. data/lib/stripe/services/v1_services.rb +2 -1
  304. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +23 -0
  305. data/lib/stripe/services/v2/billing/meter_event_service.rb +25 -0
  306. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  307. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +33 -0
  308. data/lib/stripe/services/v2/core/event_destination_service.rb +143 -0
  309. data/lib/stripe/services/v2/core/event_service.rb +15 -0
  310. data/lib/stripe/services/webhook_endpoint_service.rb +96 -0
  311. data/lib/stripe/services.rb +1 -3
  312. data/lib/stripe/stripe_client.rb +2 -1
  313. data/lib/stripe/stripe_object.rb +5 -0
  314. data/lib/stripe/version.rb +1 -1
  315. data/lib/stripe.rb +1 -0
  316. data/rbi/stripe/resources/account.rbi +4840 -0
  317. data/rbi/stripe/resources/account_link.rbi +74 -0
  318. data/rbi/stripe/resources/account_session.rbi +894 -0
  319. data/rbi/stripe/resources/apple_pay_domain.rbi +90 -0
  320. data/rbi/stripe/resources/application.rbi +20 -0
  321. data/rbi/stripe/resources/application_fee.rbi +118 -0
  322. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  323. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  324. data/rbi/stripe/resources/balance.rbi +180 -0
  325. data/rbi/stripe/resources/balance_transaction.rbi +144 -0
  326. data/rbi/stripe/resources/bank_account.rbi +127 -0
  327. data/rbi/stripe/resources/billing/alert.rbi +201 -0
  328. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  329. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
  330. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
  331. data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
  332. data/rbi/stripe/resources/billing/meter.rbi +226 -0
  333. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  334. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  335. data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
  336. data/rbi/stripe/resources/billing_portal/configuration.rbi +645 -0
  337. data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
  338. data/rbi/stripe/resources/capability.rbi +125 -0
  339. data/rbi/stripe/resources/card.rbi +125 -0
  340. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  341. data/rbi/stripe/resources/charge.rbi +2054 -0
  342. data/rbi/stripe/resources/checkout/session.rbi +3951 -0
  343. data/rbi/stripe/resources/climate/order.rbi +245 -0
  344. data/rbi/stripe/resources/climate/product.rbi +75 -0
  345. data/rbi/stripe/resources/climate/supplier.rbi +72 -0
  346. data/rbi/stripe/resources/confirmation_token.rbi +1793 -0
  347. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  348. data/rbi/stripe/resources/country_spec.rbi +85 -0
  349. data/rbi/stripe/resources/coupon.rbi +252 -0
  350. data/rbi/stripe/resources/credit_note.rbi +747 -0
  351. data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
  352. data/rbi/stripe/resources/customer.rbi +1009 -0
  353. data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
  354. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  355. data/rbi/stripe/resources/customer_session.rbi +200 -0
  356. data/rbi/stripe/resources/discount.rbi +53 -0
  357. data/rbi/stripe/resources/dispute.rbi +761 -0
  358. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
  359. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  360. data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
  361. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  362. data/rbi/stripe/resources/event.rbi +146 -0
  363. data/rbi/stripe/resources/exchange_rate.rbi +66 -0
  364. data/rbi/stripe/resources/file.rbi +143 -0
  365. data/rbi/stripe/resources/file_link.rbi +141 -0
  366. data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
  367. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  368. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  369. data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
  370. data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
  371. data/rbi/stripe/resources/forwarding/request.rbi +216 -0
  372. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  373. data/rbi/stripe/resources/identity/verification_report.rbi +351 -0
  374. data/rbi/stripe/resources/identity/verification_session.rbi +517 -0
  375. data/rbi/stripe/resources/invoice.rbi +3733 -0
  376. data/rbi/stripe/resources/invoice_item.rbi +475 -0
  377. data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
  378. data/rbi/stripe/resources/invoice_payment.rbi +114 -0
  379. data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
  380. data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
  381. data/rbi/stripe/resources/issuing/card.rbi +741 -0
  382. data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
  383. data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
  384. data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
  385. data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
  386. data/rbi/stripe/resources/issuing/token.rbi +226 -0
  387. data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
  388. data/rbi/stripe/resources/line_item.rbi +72 -0
  389. data/rbi/stripe/resources/login_link.rbi +18 -0
  390. data/rbi/stripe/resources/mandate.rbi +187 -0
  391. data/rbi/stripe/resources/payment_intent.rbi +9731 -0
  392. data/rbi/stripe/resources/payment_link.rbi +1801 -0
  393. data/rbi/stripe/resources/payment_method.rbi +1822 -0
  394. data/rbi/stripe/resources/payment_method_configuration.rbi +3154 -0
  395. data/rbi/stripe/resources/payment_method_domain.rbi +212 -0
  396. data/rbi/stripe/resources/payout.rbi +300 -0
  397. data/rbi/stripe/resources/person.rbi +371 -0
  398. data/rbi/stripe/resources/plan.rbi +373 -0
  399. data/rbi/stripe/resources/price.rbi +694 -0
  400. data/rbi/stripe/resources/product.rbi +557 -0
  401. data/rbi/stripe/resources/product_feature.rbi +26 -0
  402. data/rbi/stripe/resources/promotion_code.rbi +261 -0
  403. data/rbi/stripe/resources/quote.rbi +1123 -0
  404. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
  405. data/rbi/stripe/resources/radar/value_list.rbi +170 -0
  406. data/rbi/stripe/resources/radar/value_list_item.rbi +131 -0
  407. data/rbi/stripe/resources/refund.rbi +516 -0
  408. data/rbi/stripe/resources/reporting/report_run.rbi +191 -0
  409. data/rbi/stripe/resources/reporting/report_type.rbi +57 -0
  410. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  411. data/rbi/stripe/resources/reversal.rbi +51 -0
  412. data/rbi/stripe/resources/review.rbi +154 -0
  413. data/rbi/stripe/resources/setup_attempt.rbi +477 -0
  414. data/rbi/stripe/resources/setup_intent.rbi +3860 -0
  415. data/rbi/stripe/resources/shipping_rate.rbi +305 -0
  416. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +75 -0
  417. data/rbi/stripe/resources/source.rbi +1496 -0
  418. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  419. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  420. data/rbi/stripe/resources/subscription.rbi +1964 -0
  421. data/rbi/stripe/resources/subscription_item.rbi +370 -0
  422. data/rbi/stripe/resources/subscription_schedule.rbi +1495 -0
  423. data/rbi/stripe/resources/tax/calculation.rbi +474 -0
  424. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  425. data/rbi/stripe/resources/tax/registration.rbi +2485 -0
  426. data/rbi/stripe/resources/tax/settings.rbi +141 -0
  427. data/rbi/stripe/resources/tax/transaction.rbi +351 -0
  428. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  429. data/rbi/stripe/resources/tax_code.rbi +44 -0
  430. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  431. data/rbi/stripe/resources/tax_id.rbi +167 -0
  432. data/rbi/stripe/resources/tax_rate.rbi +239 -0
  433. data/rbi/stripe/resources/terminal/configuration.rbi +1388 -0
  434. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  435. data/rbi/stripe/resources/terminal/location.rbi +224 -0
  436. data/rbi/stripe/resources/terminal/reader.rbi +587 -0
  437. data/rbi/stripe/resources/test_helpers/test_clock.rbi +134 -0
  438. data/rbi/stripe/resources/token.rbi +1217 -0
  439. data/rbi/stripe/resources/topup.rbi +222 -0
  440. data/rbi/stripe/resources/transfer.rbi +199 -0
  441. data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
  442. data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
  443. data/rbi/stripe/resources/treasury/financial_account.rbi +865 -0
  444. data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
  445. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
  446. data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
  447. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
  448. data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
  449. data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
  450. data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
  451. data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
  452. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  453. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  454. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  455. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  456. data/rbi/stripe/resources/v2/event.rbi +48 -0
  457. data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
  458. data/rbi/stripe/resources/webhook_endpoint.rbi +170 -0
  459. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  460. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  461. data/rbi/stripe/services/account_link_service.rbi +58 -0
  462. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  463. data/rbi/stripe/services/account_person_service.rbi +923 -0
  464. data/rbi/stripe/services/account_service.rbi +4143 -0
  465. data/rbi/stripe/services/account_session_service.rbi +572 -0
  466. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  467. data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
  468. data/rbi/stripe/services/application_fee_service.rbi +78 -0
  469. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  470. data/rbi/stripe/services/apps_service.rbi +9 -0
  471. data/rbi/stripe/services/balance_service.rbi +21 -0
  472. data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
  473. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  474. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
  475. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  476. data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
  477. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
  478. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  479. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  480. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  481. data/rbi/stripe/services/billing_portal/configuration_service.rbi +511 -0
  482. data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
  483. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  484. data/rbi/stripe/services/billing_service.rbi +15 -0
  485. data/rbi/stripe/services/charge_service.rbi +448 -0
  486. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  487. data/rbi/stripe/services/checkout/session_service.rbi +2585 -0
  488. data/rbi/stripe/services/checkout_service.rbi +9 -0
  489. data/rbi/stripe/services/climate/order_service.rbi +142 -0
  490. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  491. data/rbi/stripe/services/climate/supplier_service.rbi +46 -0
  492. data/rbi/stripe/services/climate_service.rbi +11 -0
  493. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  494. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  495. data/rbi/stripe/services/coupon_service.rbi +196 -0
  496. data/rbi/stripe/services/credit_note_line_item_service.rbi +31 -0
  497. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  498. data/rbi/stripe/services/credit_note_service.rbi +416 -0
  499. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  500. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  501. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  502. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  503. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  504. data/rbi/stripe/services/customer_payment_source_service.rbi +232 -0
  505. data/rbi/stripe/services/customer_service.rbi +651 -0
  506. data/rbi/stripe/services/customer_session_service.rbi +116 -0
  507. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  508. data/rbi/stripe/services/dispute_service.rbi +424 -0
  509. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  510. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  511. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  512. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  513. data/rbi/stripe/services/event_service.rbi +83 -0
  514. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  515. data/rbi/stripe/services/file_link_service.rbi +124 -0
  516. data/rbi/stripe/services/file_service.rbi +116 -0
  517. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  518. data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
  519. data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
  520. data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
  521. data/rbi/stripe/services/financial_connections_service.rbi +11 -0
  522. data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
  523. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  524. data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
  525. data/rbi/stripe/services/identity/verification_session_service.rbi +323 -0
  526. data/rbi/stripe/services/identity_service.rbi +10 -0
  527. data/rbi/stripe/services/invoice_item_service.rbi +368 -0
  528. data/rbi/stripe/services/invoice_line_item_service.rbi +259 -0
  529. data/rbi/stripe/services/invoice_payment_service.rbi +71 -0
  530. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  531. data/rbi/stripe/services/invoice_service.rbi +2920 -0
  532. data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
  533. data/rbi/stripe/services/issuing/card_service.rbi +495 -0
  534. data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
  535. data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
  536. data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
  537. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  538. data/rbi/stripe/services/issuing/token_service.rbi +99 -0
  539. data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
  540. data/rbi/stripe/services/issuing_service.rbi +16 -0
  541. data/rbi/stripe/services/mandate_service.rbi +20 -0
  542. data/rbi/stripe/services/payment_intent_service.rbi +7759 -0
  543. data/rbi/stripe/services/payment_link_line_item_service.rbi +31 -0
  544. data/rbi/stripe/services/payment_link_service.rbi +1352 -0
  545. data/rbi/stripe/services/payment_method_configuration_service.rbi +2211 -0
  546. data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
  547. data/rbi/stripe/services/payment_method_service.rbi +840 -0
  548. data/rbi/stripe/services/payout_service.rbi +205 -0
  549. data/rbi/stripe/services/plan_service.rbi +284 -0
  550. data/rbi/stripe/services/price_service.rbi +546 -0
  551. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  552. data/rbi/stripe/services/product_service.rbi +479 -0
  553. data/rbi/stripe/services/promotion_code_service.rbi +214 -0
  554. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  555. data/rbi/stripe/services/quote_line_item_service.rbi +31 -0
  556. data/rbi/stripe/services/quote_service.rbi +686 -0
  557. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
  558. data/rbi/stripe/services/radar/value_list_item_service.rbi +111 -0
  559. data/rbi/stripe/services/radar/value_list_service.rbi +143 -0
  560. data/rbi/stripe/services/radar_service.rbi +11 -0
  561. data/rbi/stripe/services/refund_service.rbi +185 -0
  562. data/rbi/stripe/services/reporting/report_run_service.rbi +135 -0
  563. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  564. data/rbi/stripe/services/reporting_service.rbi +10 -0
  565. data/rbi/stripe/services/review_service.rbi +84 -0
  566. data/rbi/stripe/services/setup_attempt_service.rbi +65 -0
  567. data/rbi/stripe/services/setup_intent_service.rbi +3596 -0
  568. data/rbi/stripe/services/shipping_rate_service.rbi +241 -0
  569. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  570. data/rbi/stripe/services/sigma_service.rbi +9 -0
  571. data/rbi/stripe/services/source_service.rbi +663 -0
  572. data/rbi/stripe/services/source_transaction_service.rbi +31 -0
  573. data/rbi/stripe/services/subscription_item_service.rbi +324 -0
  574. data/rbi/stripe/services/subscription_schedule_service.rbi +1192 -0
  575. data/rbi/stripe/services/subscription_service.rbi +1596 -0
  576. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  577. data/rbi/stripe/services/tax/calculation_service.rbi +230 -0
  578. data/rbi/stripe/services/tax/registration_service.rbi +1689 -0
  579. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  580. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +33 -0
  581. data/rbi/stripe/services/tax/transaction_service.rbi +146 -0
  582. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  583. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  584. data/rbi/stripe/services/tax_rate_service.rbi +185 -0
  585. data/rbi/stripe/services/tax_service.rbi +12 -0
  586. data/rbi/stripe/services/terminal/configuration_service.rbi +1120 -0
  587. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  588. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  589. data/rbi/stripe/services/terminal/reader_service.rbi +344 -0
  590. data/rbi/stripe/services/terminal_service.rbi +12 -0
  591. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +746 -0
  592. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  593. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +848 -0
  594. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  595. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +69 -0
  596. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +711 -0
  597. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  598. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  599. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  600. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  601. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +92 -0
  602. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  603. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
  604. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
  605. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
  606. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
  607. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  608. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  609. data/rbi/stripe/services/token_service.rbi +1189 -0
  610. data/rbi/stripe/services/topup_service.rbi +176 -0
  611. data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
  612. data/rbi/stripe/services/transfer_service.rbi +152 -0
  613. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  614. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  615. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
  616. data/rbi/stripe/services/treasury/financial_account_service.rbi +562 -0
  617. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  618. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
  619. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
  620. data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
  621. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  622. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
  623. data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
  624. data/rbi/stripe/services/treasury_service.rbi +18 -0
  625. data/rbi/stripe/services/v1_services.rbi +77 -0
  626. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  627. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  628. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  629. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  630. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  631. data/rbi/stripe/services/v2/core/event_destination_service.rbi +200 -0
  632. data/rbi/stripe/services/v2/core/event_service.rbi +36 -0
  633. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  634. data/rbi/stripe/services/v2_services.rbi +10 -0
  635. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  636. metadata +333 -7
  637. data/lib/stripe/resources/usage_record.rb +0 -17
  638. data/lib/stripe/resources/usage_record_summary.rb +0 -12
  639. data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -17
  640. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -23
  641. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -19
@@ -17,6 +17,1638 @@ module Stripe
17
17
  "payment_link"
18
18
  end
19
19
 
20
+ class AfterCompletion < Stripe::StripeObject
21
+ class HostedConfirmation < Stripe::StripeObject
22
+ # The custom message that is displayed to the customer after the purchase is complete.
23
+ attr_reader :custom_message
24
+ end
25
+
26
+ class Redirect < Stripe::StripeObject
27
+ # The URL the customer will be redirected to after the purchase is complete.
28
+ attr_reader :url
29
+ end
30
+ # Attribute for field hosted_confirmation
31
+ attr_reader :hosted_confirmation
32
+ # Attribute for field redirect
33
+ attr_reader :redirect
34
+ # The specified behavior after the purchase is complete.
35
+ attr_reader :type
36
+ end
37
+
38
+ class AutomaticTax < Stripe::StripeObject
39
+ class Liability < Stripe::StripeObject
40
+ # The connected account being referenced when `type` is `account`.
41
+ attr_reader :account
42
+ # Type of the account referenced.
43
+ attr_reader :type
44
+ end
45
+ # If `true`, tax will be calculated automatically using the customer's location.
46
+ attr_reader :enabled
47
+ # 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.
48
+ attr_reader :liability
49
+ end
50
+
51
+ class ConsentCollection < Stripe::StripeObject
52
+ class PaymentMethodReuseAgreement < Stripe::StripeObject
53
+ # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.
54
+ #
55
+ # When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
56
+ attr_reader :position
57
+ end
58
+ # Settings related to the payment method reuse text shown in the Checkout UI.
59
+ attr_reader :payment_method_reuse_agreement
60
+ # If set to `auto`, enables the collection of customer consent for promotional communications.
61
+ attr_reader :promotions
62
+ # If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service.
63
+ attr_reader :terms_of_service
64
+ end
65
+
66
+ class CustomField < Stripe::StripeObject
67
+ class Dropdown < Stripe::StripeObject
68
+ class Option < Stripe::StripeObject
69
+ # The label for the option, displayed to the customer. Up to 100 characters.
70
+ attr_reader :label
71
+ # 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.
72
+ attr_reader :value
73
+ end
74
+ # The value that will pre-fill on the payment page.
75
+ attr_reader :default_value
76
+ # The options available for the customer to select. Up to 200 options allowed.
77
+ attr_reader :options
78
+ end
79
+
80
+ class Label < Stripe::StripeObject
81
+ # Custom text for the label, displayed to the customer. Up to 50 characters.
82
+ attr_reader :custom
83
+ # The type of the label.
84
+ attr_reader :type
85
+ end
86
+
87
+ class Numeric < Stripe::StripeObject
88
+ # The value that will pre-fill the field on the payment page.
89
+ attr_reader :default_value
90
+ # The maximum character length constraint for the customer's input.
91
+ attr_reader :maximum_length
92
+ # The minimum character length requirement for the customer's input.
93
+ attr_reader :minimum_length
94
+ end
95
+
96
+ class Text < Stripe::StripeObject
97
+ # The value that will pre-fill the field on the payment page.
98
+ attr_reader :default_value
99
+ # The maximum character length constraint for the customer's input.
100
+ attr_reader :maximum_length
101
+ # The minimum character length requirement for the customer's input.
102
+ attr_reader :minimum_length
103
+ end
104
+ # Attribute for field dropdown
105
+ attr_reader :dropdown
106
+ # 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.
107
+ attr_reader :key
108
+ # Attribute for field label
109
+ attr_reader :label
110
+ # Attribute for field numeric
111
+ attr_reader :numeric
112
+ # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
113
+ attr_reader :optional
114
+ # Attribute for field text
115
+ attr_reader :text
116
+ # The type of the field.
117
+ attr_reader :type
118
+ end
119
+
120
+ class CustomText < Stripe::StripeObject
121
+ class AfterSubmit < Stripe::StripeObject
122
+ # Text may be up to 1200 characters in length.
123
+ attr_reader :message
124
+ end
125
+
126
+ class ShippingAddress < Stripe::StripeObject
127
+ # Text may be up to 1200 characters in length.
128
+ attr_reader :message
129
+ end
130
+
131
+ class Submit < Stripe::StripeObject
132
+ # Text may be up to 1200 characters in length.
133
+ attr_reader :message
134
+ end
135
+
136
+ class TermsOfServiceAcceptance < Stripe::StripeObject
137
+ # Text may be up to 1200 characters in length.
138
+ attr_reader :message
139
+ end
140
+ # Custom text that should be displayed after the payment confirmation button.
141
+ attr_reader :after_submit
142
+ # Custom text that should be displayed alongside shipping address collection.
143
+ attr_reader :shipping_address
144
+ # Custom text that should be displayed alongside the payment confirmation button.
145
+ attr_reader :submit
146
+ # Custom text that should be displayed in place of the default terms of service agreement text.
147
+ attr_reader :terms_of_service_acceptance
148
+ end
149
+
150
+ class InvoiceCreation < Stripe::StripeObject
151
+ class InvoiceData < Stripe::StripeObject
152
+ class CustomField < Stripe::StripeObject
153
+ # The name of the custom field.
154
+ attr_reader :name
155
+ # The value of the custom field.
156
+ attr_reader :value
157
+ end
158
+
159
+ class Issuer < Stripe::StripeObject
160
+ # The connected account being referenced when `type` is `account`.
161
+ attr_reader :account
162
+ # Type of the account referenced.
163
+ attr_reader :type
164
+ end
165
+
166
+ class RenderingOptions < Stripe::StripeObject
167
+ # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
168
+ attr_reader :amount_tax_display
169
+ end
170
+ # The account tax IDs associated with the invoice.
171
+ attr_reader :account_tax_ids
172
+ # A list of up to 4 custom fields to be displayed on the invoice.
173
+ attr_reader :custom_fields
174
+ # An arbitrary string attached to the object. Often useful for displaying to users.
175
+ attr_reader :description
176
+ # Footer to be displayed on the invoice.
177
+ attr_reader :footer
178
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
179
+ attr_reader :issuer
180
+ # 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.
181
+ attr_reader :metadata
182
+ # Options for invoice PDF rendering.
183
+ attr_reader :rendering_options
184
+ end
185
+ # Enable creating an invoice on successful payment.
186
+ attr_reader :enabled
187
+ # Configuration for the invoice. Default invoice values will be used if unspecified.
188
+ attr_reader :invoice_data
189
+ end
190
+
191
+ class OptionalItem < Stripe::StripeObject
192
+ class AdjustableQuantity < Stripe::StripeObject
193
+ # Set to true if the quantity can be adjusted to any non-negative integer.
194
+ attr_reader :enabled
195
+ # The maximum quantity of this item the customer can purchase. By default this value is 99.
196
+ attr_reader :maximum
197
+ # 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.
198
+ attr_reader :minimum
199
+ end
200
+ # Attribute for field adjustable_quantity
201
+ attr_reader :adjustable_quantity
202
+ # Attribute for field price
203
+ attr_reader :price
204
+ # Attribute for field quantity
205
+ attr_reader :quantity
206
+ end
207
+
208
+ class PaymentIntentData < Stripe::StripeObject
209
+ # Indicates when the funds will be captured from the customer's account.
210
+ attr_reader :capture_method
211
+ # An arbitrary string attached to the object. Often useful for displaying to users.
212
+ attr_reader :description
213
+ # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link.
214
+ attr_reader :metadata
215
+ # Indicates that you intend to make future payments with the payment method collected during checkout.
216
+ attr_reader :setup_future_usage
217
+ # For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.
218
+ attr_reader :statement_descriptor
219
+ # For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
220
+ attr_reader :statement_descriptor_suffix
221
+ # 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.
222
+ attr_reader :transfer_group
223
+ end
224
+
225
+ class PhoneNumberCollection < Stripe::StripeObject
226
+ # If `true`, a phone number will be collected during checkout.
227
+ attr_reader :enabled
228
+ end
229
+
230
+ class Restrictions < Stripe::StripeObject
231
+ class CompletedSessions < Stripe::StripeObject
232
+ # The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met.
233
+ attr_reader :count
234
+ # The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
235
+ attr_reader :limit
236
+ end
237
+ # Attribute for field completed_sessions
238
+ attr_reader :completed_sessions
239
+ end
240
+
241
+ class ShippingAddressCollection < Stripe::StripeObject
242
+ # An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.
243
+ attr_reader :allowed_countries
244
+ end
245
+
246
+ class ShippingOption < Stripe::StripeObject
247
+ # A non-negative integer in cents representing how much to charge.
248
+ attr_reader :shipping_amount
249
+ # The ID of the Shipping Rate to use for this shipping option.
250
+ attr_reader :shipping_rate
251
+ end
252
+
253
+ class SubscriptionData < Stripe::StripeObject
254
+ class InvoiceSettings < Stripe::StripeObject
255
+ class Issuer < Stripe::StripeObject
256
+ # The connected account being referenced when `type` is `account`.
257
+ attr_reader :account
258
+ # Type of the account referenced.
259
+ attr_reader :type
260
+ end
261
+ # Attribute for field issuer
262
+ attr_reader :issuer
263
+ end
264
+
265
+ class TrialSettings < Stripe::StripeObject
266
+ class EndBehavior < Stripe::StripeObject
267
+ # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
268
+ attr_reader :missing_payment_method
269
+ end
270
+ # Defines how a subscription behaves when a free trial ends.
271
+ attr_reader :end_behavior
272
+ end
273
+ # 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.
274
+ attr_reader :description
275
+ # Attribute for field invoice_settings
276
+ attr_reader :invoice_settings
277
+ # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link.
278
+ attr_reader :metadata
279
+ # Integer representing the number of trial period days before the customer is charged for the first time.
280
+ attr_reader :trial_period_days
281
+ # Settings related to subscription trials.
282
+ attr_reader :trial_settings
283
+ end
284
+
285
+ class TaxIdCollection < Stripe::StripeObject
286
+ # Indicates whether tax ID collection is enabled for the session.
287
+ attr_reader :enabled
288
+ # Attribute for field required
289
+ attr_reader :required
290
+ end
291
+
292
+ class TransferData < Stripe::StripeObject
293
+ # The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
294
+ attr_reader :amount
295
+ # The connected account receiving the transfer.
296
+ attr_reader :destination
297
+ end
298
+
299
+ class ListParams < Stripe::RequestParams
300
+ # Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).
301
+ attr_accessor :active
302
+ # 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.
303
+ attr_accessor :ending_before
304
+ # Specifies which fields in the response should be expanded.
305
+ attr_accessor :expand
306
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
307
+ attr_accessor :limit
308
+ # 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.
309
+ attr_accessor :starting_after
310
+
311
+ def initialize(active: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil)
312
+ @active = active
313
+ @ending_before = ending_before
314
+ @expand = expand
315
+ @limit = limit
316
+ @starting_after = starting_after
317
+ end
318
+ end
319
+
320
+ class CreateParams < Stripe::RequestParams
321
+ class AfterCompletion < Stripe::RequestParams
322
+ class HostedConfirmation < Stripe::RequestParams
323
+ # A custom message to display to the customer after the purchase is complete.
324
+ attr_accessor :custom_message
325
+
326
+ def initialize(custom_message: nil)
327
+ @custom_message = custom_message
328
+ end
329
+ end
330
+
331
+ class Redirect < Stripe::RequestParams
332
+ # 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.
333
+ attr_accessor :url
334
+
335
+ def initialize(url: nil)
336
+ @url = url
337
+ end
338
+ end
339
+ # Configuration when `type=hosted_confirmation`.
340
+ attr_accessor :hosted_confirmation
341
+ # Configuration when `type=redirect`.
342
+ attr_accessor :redirect
343
+ # The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.
344
+ attr_accessor :type
345
+
346
+ def initialize(hosted_confirmation: nil, redirect: nil, type: nil)
347
+ @hosted_confirmation = hosted_confirmation
348
+ @redirect = redirect
349
+ @type = type
350
+ end
351
+ end
352
+
353
+ class AutomaticTax < Stripe::RequestParams
354
+ class Liability < Stripe::RequestParams
355
+ # The connected account being referenced when `type` is `account`.
356
+ attr_accessor :account
357
+ # Type of the account referenced in the request.
358
+ attr_accessor :type
359
+
360
+ def initialize(account: nil, type: nil)
361
+ @account = account
362
+ @type = type
363
+ end
364
+ end
365
+ # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
366
+ #
367
+ # Enabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.
368
+ attr_accessor :enabled
369
+ # 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.
370
+ attr_accessor :liability
371
+
372
+ def initialize(enabled: nil, liability: nil)
373
+ @enabled = enabled
374
+ @liability = liability
375
+ end
376
+ end
377
+
378
+ class ConsentCollection < Stripe::RequestParams
379
+ class PaymentMethodReuseAgreement < Stripe::RequestParams
380
+ # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
381
+ # defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
382
+ attr_accessor :position
383
+
384
+ def initialize(position: nil)
385
+ @position = position
386
+ end
387
+ end
388
+ # 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.
389
+ attr_accessor :payment_method_reuse_agreement
390
+ # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
391
+ # Session will determine whether to display an option to opt into promotional communication
392
+ # from the merchant depending on the customer's locale. Only available to US merchants.
393
+ attr_accessor :promotions
394
+ # If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
395
+ # There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
396
+ attr_accessor :terms_of_service
397
+
398
+ def initialize(payment_method_reuse_agreement: nil, promotions: nil, terms_of_service: nil)
399
+ @payment_method_reuse_agreement = payment_method_reuse_agreement
400
+ @promotions = promotions
401
+ @terms_of_service = terms_of_service
402
+ end
403
+ end
404
+
405
+ class CustomField < Stripe::RequestParams
406
+ class Dropdown < Stripe::RequestParams
407
+ class Option < Stripe::RequestParams
408
+ # The label for the option, displayed to the customer. Up to 100 characters.
409
+ attr_accessor :label
410
+ # 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.
411
+ attr_accessor :value
412
+
413
+ def initialize(label: nil, value: nil)
414
+ @label = label
415
+ @value = value
416
+ end
417
+ end
418
+ # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
419
+ attr_accessor :default_value
420
+ # The options available for the customer to select. Up to 200 options allowed.
421
+ attr_accessor :options
422
+
423
+ def initialize(default_value: nil, options: nil)
424
+ @default_value = default_value
425
+ @options = options
426
+ end
427
+ end
428
+
429
+ class Label < Stripe::RequestParams
430
+ # Custom text for the label, displayed to the customer. Up to 50 characters.
431
+ attr_accessor :custom
432
+ # The type of the label.
433
+ attr_accessor :type
434
+
435
+ def initialize(custom: nil, type: nil)
436
+ @custom = custom
437
+ @type = type
438
+ end
439
+ end
440
+
441
+ class Numeric < Stripe::RequestParams
442
+ # The value that will pre-fill the field on the payment page.
443
+ attr_accessor :default_value
444
+ # The maximum character length constraint for the customer's input.
445
+ attr_accessor :maximum_length
446
+ # The minimum character length requirement for the customer's input.
447
+ attr_accessor :minimum_length
448
+
449
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil)
450
+ @default_value = default_value
451
+ @maximum_length = maximum_length
452
+ @minimum_length = minimum_length
453
+ end
454
+ end
455
+
456
+ class Text < Stripe::RequestParams
457
+ # The value that will pre-fill the field on the payment page.
458
+ attr_accessor :default_value
459
+ # The maximum character length constraint for the customer's input.
460
+ attr_accessor :maximum_length
461
+ # The minimum character length requirement for the customer's input.
462
+ attr_accessor :minimum_length
463
+
464
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil)
465
+ @default_value = default_value
466
+ @maximum_length = maximum_length
467
+ @minimum_length = minimum_length
468
+ end
469
+ end
470
+ # Configuration for `type=dropdown` fields.
471
+ attr_accessor :dropdown
472
+ # 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.
473
+ attr_accessor :key
474
+ # The label for the field, displayed to the customer.
475
+ attr_accessor :label
476
+ # Configuration for `type=numeric` fields.
477
+ attr_accessor :numeric
478
+ # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
479
+ attr_accessor :optional
480
+ # Configuration for `type=text` fields.
481
+ attr_accessor :text
482
+ # The type of the field.
483
+ attr_accessor :type
484
+
485
+ def initialize(
486
+ dropdown: nil,
487
+ key: nil,
488
+ label: nil,
489
+ numeric: nil,
490
+ optional: nil,
491
+ text: nil,
492
+ type: nil
493
+ )
494
+ @dropdown = dropdown
495
+ @key = key
496
+ @label = label
497
+ @numeric = numeric
498
+ @optional = optional
499
+ @text = text
500
+ @type = type
501
+ end
502
+ end
503
+
504
+ class CustomText < Stripe::RequestParams
505
+ class AfterSubmit < Stripe::RequestParams
506
+ # Text may be up to 1200 characters in length.
507
+ attr_accessor :message
508
+
509
+ def initialize(message: nil)
510
+ @message = message
511
+ end
512
+ end
513
+
514
+ class ShippingAddress < Stripe::RequestParams
515
+ # Text may be up to 1200 characters in length.
516
+ attr_accessor :message
517
+
518
+ def initialize(message: nil)
519
+ @message = message
520
+ end
521
+ end
522
+
523
+ class Submit < Stripe::RequestParams
524
+ # Text may be up to 1200 characters in length.
525
+ attr_accessor :message
526
+
527
+ def initialize(message: nil)
528
+ @message = message
529
+ end
530
+ end
531
+
532
+ class TermsOfServiceAcceptance < Stripe::RequestParams
533
+ # Text may be up to 1200 characters in length.
534
+ attr_accessor :message
535
+
536
+ def initialize(message: nil)
537
+ @message = message
538
+ end
539
+ end
540
+ # Custom text that should be displayed after the payment confirmation button.
541
+ attr_accessor :after_submit
542
+ # Custom text that should be displayed alongside shipping address collection.
543
+ attr_accessor :shipping_address
544
+ # Custom text that should be displayed alongside the payment confirmation button.
545
+ attr_accessor :submit
546
+ # Custom text that should be displayed in place of the default terms of service agreement text.
547
+ attr_accessor :terms_of_service_acceptance
548
+
549
+ def initialize(
550
+ after_submit: nil,
551
+ shipping_address: nil,
552
+ submit: nil,
553
+ terms_of_service_acceptance: nil
554
+ )
555
+ @after_submit = after_submit
556
+ @shipping_address = shipping_address
557
+ @submit = submit
558
+ @terms_of_service_acceptance = terms_of_service_acceptance
559
+ end
560
+ end
561
+
562
+ class InvoiceCreation < Stripe::RequestParams
563
+ class InvoiceData < Stripe::RequestParams
564
+ class CustomField < Stripe::RequestParams
565
+ # The name of the custom field. This may be up to 40 characters.
566
+ attr_accessor :name
567
+ # The value of the custom field. This may be up to 140 characters.
568
+ attr_accessor :value
569
+
570
+ def initialize(name: nil, value: nil)
571
+ @name = name
572
+ @value = value
573
+ end
574
+ end
575
+
576
+ class Issuer < Stripe::RequestParams
577
+ # The connected account being referenced when `type` is `account`.
578
+ attr_accessor :account
579
+ # Type of the account referenced in the request.
580
+ attr_accessor :type
581
+
582
+ def initialize(account: nil, type: nil)
583
+ @account = account
584
+ @type = type
585
+ end
586
+ end
587
+
588
+ class RenderingOptions < Stripe::RequestParams
589
+ # 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.
590
+ attr_accessor :amount_tax_display
591
+
592
+ def initialize(amount_tax_display: nil)
593
+ @amount_tax_display = amount_tax_display
594
+ end
595
+ end
596
+ # The account tax IDs associated with the invoice.
597
+ attr_accessor :account_tax_ids
598
+ # Default custom fields to be displayed on invoices for this customer.
599
+ attr_accessor :custom_fields
600
+ # An arbitrary string attached to the object. Often useful for displaying to users.
601
+ attr_accessor :description
602
+ # Default footer to be displayed on invoices for this customer.
603
+ attr_accessor :footer
604
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
605
+ attr_accessor :issuer
606
+ # 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`.
607
+ attr_accessor :metadata
608
+ # Default options for invoice PDF rendering for this customer.
609
+ attr_accessor :rendering_options
610
+
611
+ def initialize(
612
+ account_tax_ids: nil,
613
+ custom_fields: nil,
614
+ description: nil,
615
+ footer: nil,
616
+ issuer: nil,
617
+ metadata: nil,
618
+ rendering_options: nil
619
+ )
620
+ @account_tax_ids = account_tax_ids
621
+ @custom_fields = custom_fields
622
+ @description = description
623
+ @footer = footer
624
+ @issuer = issuer
625
+ @metadata = metadata
626
+ @rendering_options = rendering_options
627
+ end
628
+ end
629
+ # Whether the feature is enabled
630
+ attr_accessor :enabled
631
+ # Invoice PDF configuration.
632
+ attr_accessor :invoice_data
633
+
634
+ def initialize(enabled: nil, invoice_data: nil)
635
+ @enabled = enabled
636
+ @invoice_data = invoice_data
637
+ end
638
+ end
639
+
640
+ class LineItem < Stripe::RequestParams
641
+ class AdjustableQuantity < Stripe::RequestParams
642
+ # Set to true if the quantity can be adjusted to any non-negative Integer.
643
+ attr_accessor :enabled
644
+ # The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.
645
+ attr_accessor :maximum
646
+ # 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.
647
+ attr_accessor :minimum
648
+
649
+ def initialize(enabled: nil, maximum: nil, minimum: nil)
650
+ @enabled = enabled
651
+ @maximum = maximum
652
+ @minimum = minimum
653
+ end
654
+ end
655
+ # When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
656
+ attr_accessor :adjustable_quantity
657
+ # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
658
+ attr_accessor :price
659
+ # The quantity of the line item being purchased.
660
+ attr_accessor :quantity
661
+
662
+ def initialize(adjustable_quantity: nil, price: nil, quantity: nil)
663
+ @adjustable_quantity = adjustable_quantity
664
+ @price = price
665
+ @quantity = quantity
666
+ end
667
+ end
668
+
669
+ class OptionalItem < Stripe::RequestParams
670
+ class AdjustableQuantity < Stripe::RequestParams
671
+ # Set to true if the quantity can be adjusted to any non-negative integer.
672
+ attr_accessor :enabled
673
+ # The maximum quantity of this item the customer can purchase. By default this value is 99.
674
+ attr_accessor :maximum
675
+ # 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.
676
+ attr_accessor :minimum
677
+
678
+ def initialize(enabled: nil, maximum: nil, minimum: nil)
679
+ @enabled = enabled
680
+ @maximum = maximum
681
+ @minimum = minimum
682
+ end
683
+ end
684
+ # 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.
685
+ attr_accessor :adjustable_quantity
686
+ # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
687
+ attr_accessor :price
688
+ # The initial quantity of the line item created when a customer chooses to add this optional item to their order.
689
+ attr_accessor :quantity
690
+
691
+ def initialize(adjustable_quantity: nil, price: nil, quantity: nil)
692
+ @adjustable_quantity = adjustable_quantity
693
+ @price = price
694
+ @quantity = quantity
695
+ end
696
+ end
697
+
698
+ class PaymentIntentData < Stripe::RequestParams
699
+ # Controls when the funds will be captured from the customer's account.
700
+ attr_accessor :capture_method
701
+ # An arbitrary string attached to the object. Often useful for displaying to users.
702
+ attr_accessor :description
703
+ # 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.
704
+ attr_accessor :metadata
705
+ # 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.
706
+ #
707
+ # When setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.
708
+ #
709
+ # 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.
710
+ #
711
+ # If a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.
712
+ #
713
+ # 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.
714
+ #
715
+ # 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.
716
+ attr_accessor :setup_future_usage
717
+ # 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).
718
+ #
719
+ # 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.
720
+ attr_accessor :statement_descriptor
721
+ # 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.
722
+ attr_accessor :statement_descriptor_suffix
723
+ # 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.
724
+ attr_accessor :transfer_group
725
+
726
+ def initialize(
727
+ capture_method: nil,
728
+ description: nil,
729
+ metadata: nil,
730
+ setup_future_usage: nil,
731
+ statement_descriptor: nil,
732
+ statement_descriptor_suffix: nil,
733
+ transfer_group: nil
734
+ )
735
+ @capture_method = capture_method
736
+ @description = description
737
+ @metadata = metadata
738
+ @setup_future_usage = setup_future_usage
739
+ @statement_descriptor = statement_descriptor
740
+ @statement_descriptor_suffix = statement_descriptor_suffix
741
+ @transfer_group = transfer_group
742
+ end
743
+ end
744
+
745
+ class PhoneNumberCollection < Stripe::RequestParams
746
+ # Set to `true` to enable phone number collection.
747
+ attr_accessor :enabled
748
+
749
+ def initialize(enabled: nil)
750
+ @enabled = enabled
751
+ end
752
+ end
753
+
754
+ class Restrictions < Stripe::RequestParams
755
+ class CompletedSessions < Stripe::RequestParams
756
+ # The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
757
+ attr_accessor :limit
758
+
759
+ def initialize(limit: nil)
760
+ @limit = limit
761
+ end
762
+ end
763
+ # Configuration for the `completed_sessions` restriction type.
764
+ attr_accessor :completed_sessions
765
+
766
+ def initialize(completed_sessions: nil)
767
+ @completed_sessions = completed_sessions
768
+ end
769
+ end
770
+
771
+ class ShippingAddressCollection < Stripe::RequestParams
772
+ # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
773
+ # shipping locations.
774
+ attr_accessor :allowed_countries
775
+
776
+ def initialize(allowed_countries: nil)
777
+ @allowed_countries = allowed_countries
778
+ end
779
+ end
780
+
781
+ class ShippingOption < Stripe::RequestParams
782
+ # The ID of the Shipping Rate to use for this shipping option.
783
+ attr_accessor :shipping_rate
784
+
785
+ def initialize(shipping_rate: nil)
786
+ @shipping_rate = shipping_rate
787
+ end
788
+ end
789
+
790
+ class SubscriptionData < Stripe::RequestParams
791
+ class InvoiceSettings < Stripe::RequestParams
792
+ class Issuer < Stripe::RequestParams
793
+ # The connected account being referenced when `type` is `account`.
794
+ attr_accessor :account
795
+ # Type of the account referenced in the request.
796
+ attr_accessor :type
797
+
798
+ def initialize(account: nil, type: nil)
799
+ @account = account
800
+ @type = type
801
+ end
802
+ end
803
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
804
+ attr_accessor :issuer
805
+
806
+ def initialize(issuer: nil)
807
+ @issuer = issuer
808
+ end
809
+ end
810
+
811
+ class TrialSettings < Stripe::RequestParams
812
+ class EndBehavior < Stripe::RequestParams
813
+ # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
814
+ attr_accessor :missing_payment_method
815
+
816
+ def initialize(missing_payment_method: nil)
817
+ @missing_payment_method = missing_payment_method
818
+ end
819
+ end
820
+ # Defines how the subscription should behave when the user's free trial ends.
821
+ attr_accessor :end_behavior
822
+
823
+ def initialize(end_behavior: nil)
824
+ @end_behavior = end_behavior
825
+ end
826
+ end
827
+ # 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.
828
+ attr_accessor :description
829
+ # All invoices will be billed using the specified settings.
830
+ attr_accessor :invoice_settings
831
+ # 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.
832
+ attr_accessor :metadata
833
+ # Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
834
+ attr_accessor :trial_period_days
835
+ # Settings related to subscription trials.
836
+ attr_accessor :trial_settings
837
+
838
+ def initialize(
839
+ description: nil,
840
+ invoice_settings: nil,
841
+ metadata: nil,
842
+ trial_period_days: nil,
843
+ trial_settings: nil
844
+ )
845
+ @description = description
846
+ @invoice_settings = invoice_settings
847
+ @metadata = metadata
848
+ @trial_period_days = trial_period_days
849
+ @trial_settings = trial_settings
850
+ end
851
+ end
852
+
853
+ class TaxIdCollection < Stripe::RequestParams
854
+ # Enable tax ID collection during checkout. Defaults to `false`.
855
+ attr_accessor :enabled
856
+ # Describes whether a tax ID is required during checkout. Defaults to `never`.
857
+ attr_accessor :required
858
+
859
+ def initialize(enabled: nil, required: nil)
860
+ @enabled = enabled
861
+ @required = required
862
+ end
863
+ end
864
+
865
+ class TransferData < Stripe::RequestParams
866
+ # The amount that will be transferred automatically when a charge succeeds.
867
+ attr_accessor :amount
868
+ # If specified, successful charges will be attributed to the destination
869
+ # account for tax reporting, and the funds from charges will be transferred
870
+ # to the destination account. The ID of the resulting transfer will be
871
+ # returned on the successful charge's `transfer` field.
872
+ attr_accessor :destination
873
+
874
+ def initialize(amount: nil, destination: nil)
875
+ @amount = amount
876
+ @destination = destination
877
+ end
878
+ end
879
+ # Behavior after the purchase is complete.
880
+ attr_accessor :after_completion
881
+ # Enables user redeemable promotion codes.
882
+ attr_accessor :allow_promotion_codes
883
+ # 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.
884
+ attr_accessor :application_fee_amount
885
+ # 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.
886
+ attr_accessor :application_fee_percent
887
+ # Configuration for automatic tax collection.
888
+ attr_accessor :automatic_tax
889
+ # Configuration for collecting the customer's billing address. Defaults to `auto`.
890
+ attr_accessor :billing_address_collection
891
+ # Configure fields to gather active consent from customers.
892
+ attr_accessor :consent_collection
893
+ # 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.
894
+ attr_accessor :currency
895
+ # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
896
+ attr_accessor :custom_fields
897
+ # Display additional text for your customers using custom text.
898
+ attr_accessor :custom_text
899
+ # 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).
900
+ attr_accessor :customer_creation
901
+ # Specifies which fields in the response should be expanded.
902
+ attr_accessor :expand
903
+ # The custom message to be displayed to a customer when a payment link is no longer active.
904
+ attr_accessor :inactive_message
905
+ # Generate a post-purchase Invoice for one-time payments.
906
+ attr_accessor :invoice_creation
907
+ # The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
908
+ attr_accessor :line_items
909
+ # 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.
910
+ attr_accessor :metadata
911
+ # The account on behalf of which to charge.
912
+ attr_accessor :on_behalf_of
913
+ # 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).
914
+ # 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.
915
+ # There is a maximum of 20 combined line items and optional items.
916
+ attr_accessor :optional_items
917
+ # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
918
+ attr_accessor :payment_intent_data
919
+ # 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.
920
+ #
921
+ # Can only be set in `subscription` mode. Defaults to `always`.
922
+ #
923
+ # 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).
924
+ attr_accessor :payment_method_collection
925
+ # 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)).
926
+ attr_accessor :payment_method_types
927
+ # Controls phone number collection settings during checkout.
928
+ #
929
+ # We recommend that you review your privacy policy and check with your legal contacts.
930
+ attr_accessor :phone_number_collection
931
+ # Settings that restrict the usage of a payment link.
932
+ attr_accessor :restrictions
933
+ # Configuration for collecting the customer's shipping address.
934
+ attr_accessor :shipping_address_collection
935
+ # The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
936
+ attr_accessor :shipping_options
937
+ # 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`).
938
+ attr_accessor :submit_type
939
+ # 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`.
940
+ attr_accessor :subscription_data
941
+ # Controls tax ID collection during checkout.
942
+ attr_accessor :tax_id_collection
943
+ # The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
944
+ attr_accessor :transfer_data
945
+
946
+ def initialize(
947
+ after_completion: nil,
948
+ allow_promotion_codes: nil,
949
+ application_fee_amount: nil,
950
+ application_fee_percent: nil,
951
+ automatic_tax: nil,
952
+ billing_address_collection: nil,
953
+ consent_collection: nil,
954
+ currency: nil,
955
+ custom_fields: nil,
956
+ custom_text: nil,
957
+ customer_creation: nil,
958
+ expand: nil,
959
+ inactive_message: nil,
960
+ invoice_creation: nil,
961
+ line_items: nil,
962
+ metadata: nil,
963
+ on_behalf_of: nil,
964
+ optional_items: nil,
965
+ payment_intent_data: nil,
966
+ payment_method_collection: nil,
967
+ payment_method_types: nil,
968
+ phone_number_collection: nil,
969
+ restrictions: nil,
970
+ shipping_address_collection: nil,
971
+ shipping_options: nil,
972
+ submit_type: nil,
973
+ subscription_data: nil,
974
+ tax_id_collection: nil,
975
+ transfer_data: nil
976
+ )
977
+ @after_completion = after_completion
978
+ @allow_promotion_codes = allow_promotion_codes
979
+ @application_fee_amount = application_fee_amount
980
+ @application_fee_percent = application_fee_percent
981
+ @automatic_tax = automatic_tax
982
+ @billing_address_collection = billing_address_collection
983
+ @consent_collection = consent_collection
984
+ @currency = currency
985
+ @custom_fields = custom_fields
986
+ @custom_text = custom_text
987
+ @customer_creation = customer_creation
988
+ @expand = expand
989
+ @inactive_message = inactive_message
990
+ @invoice_creation = invoice_creation
991
+ @line_items = line_items
992
+ @metadata = metadata
993
+ @on_behalf_of = on_behalf_of
994
+ @optional_items = optional_items
995
+ @payment_intent_data = payment_intent_data
996
+ @payment_method_collection = payment_method_collection
997
+ @payment_method_types = payment_method_types
998
+ @phone_number_collection = phone_number_collection
999
+ @restrictions = restrictions
1000
+ @shipping_address_collection = shipping_address_collection
1001
+ @shipping_options = shipping_options
1002
+ @submit_type = submit_type
1003
+ @subscription_data = subscription_data
1004
+ @tax_id_collection = tax_id_collection
1005
+ @transfer_data = transfer_data
1006
+ end
1007
+ end
1008
+
1009
+ class UpdateParams < Stripe::RequestParams
1010
+ class AfterCompletion < Stripe::RequestParams
1011
+ class HostedConfirmation < Stripe::RequestParams
1012
+ # A custom message to display to the customer after the purchase is complete.
1013
+ attr_accessor :custom_message
1014
+
1015
+ def initialize(custom_message: nil)
1016
+ @custom_message = custom_message
1017
+ end
1018
+ end
1019
+
1020
+ class Redirect < Stripe::RequestParams
1021
+ # 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.
1022
+ attr_accessor :url
1023
+
1024
+ def initialize(url: nil)
1025
+ @url = url
1026
+ end
1027
+ end
1028
+ # Configuration when `type=hosted_confirmation`.
1029
+ attr_accessor :hosted_confirmation
1030
+ # Configuration when `type=redirect`.
1031
+ attr_accessor :redirect
1032
+ # The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.
1033
+ attr_accessor :type
1034
+
1035
+ def initialize(hosted_confirmation: nil, redirect: nil, type: nil)
1036
+ @hosted_confirmation = hosted_confirmation
1037
+ @redirect = redirect
1038
+ @type = type
1039
+ end
1040
+ end
1041
+
1042
+ class AutomaticTax < Stripe::RequestParams
1043
+ class Liability < Stripe::RequestParams
1044
+ # The connected account being referenced when `type` is `account`.
1045
+ attr_accessor :account
1046
+ # Type of the account referenced in the request.
1047
+ attr_accessor :type
1048
+
1049
+ def initialize(account: nil, type: nil)
1050
+ @account = account
1051
+ @type = type
1052
+ end
1053
+ end
1054
+ # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
1055
+ #
1056
+ # Enabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.
1057
+ attr_accessor :enabled
1058
+ # 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.
1059
+ attr_accessor :liability
1060
+
1061
+ def initialize(enabled: nil, liability: nil)
1062
+ @enabled = enabled
1063
+ @liability = liability
1064
+ end
1065
+ end
1066
+
1067
+ class CustomField < Stripe::RequestParams
1068
+ class Dropdown < Stripe::RequestParams
1069
+ class Option < Stripe::RequestParams
1070
+ # The label for the option, displayed to the customer. Up to 100 characters.
1071
+ attr_accessor :label
1072
+ # 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.
1073
+ attr_accessor :value
1074
+
1075
+ def initialize(label: nil, value: nil)
1076
+ @label = label
1077
+ @value = value
1078
+ end
1079
+ end
1080
+ # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
1081
+ attr_accessor :default_value
1082
+ # The options available for the customer to select. Up to 200 options allowed.
1083
+ attr_accessor :options
1084
+
1085
+ def initialize(default_value: nil, options: nil)
1086
+ @default_value = default_value
1087
+ @options = options
1088
+ end
1089
+ end
1090
+
1091
+ class Label < Stripe::RequestParams
1092
+ # Custom text for the label, displayed to the customer. Up to 50 characters.
1093
+ attr_accessor :custom
1094
+ # The type of the label.
1095
+ attr_accessor :type
1096
+
1097
+ def initialize(custom: nil, type: nil)
1098
+ @custom = custom
1099
+ @type = type
1100
+ end
1101
+ end
1102
+
1103
+ class Numeric < Stripe::RequestParams
1104
+ # The value that will pre-fill the field on the payment page.
1105
+ attr_accessor :default_value
1106
+ # The maximum character length constraint for the customer's input.
1107
+ attr_accessor :maximum_length
1108
+ # The minimum character length requirement for the customer's input.
1109
+ attr_accessor :minimum_length
1110
+
1111
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil)
1112
+ @default_value = default_value
1113
+ @maximum_length = maximum_length
1114
+ @minimum_length = minimum_length
1115
+ end
1116
+ end
1117
+
1118
+ class Text < Stripe::RequestParams
1119
+ # The value that will pre-fill the field on the payment page.
1120
+ attr_accessor :default_value
1121
+ # The maximum character length constraint for the customer's input.
1122
+ attr_accessor :maximum_length
1123
+ # The minimum character length requirement for the customer's input.
1124
+ attr_accessor :minimum_length
1125
+
1126
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil)
1127
+ @default_value = default_value
1128
+ @maximum_length = maximum_length
1129
+ @minimum_length = minimum_length
1130
+ end
1131
+ end
1132
+ # Configuration for `type=dropdown` fields.
1133
+ attr_accessor :dropdown
1134
+ # 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.
1135
+ attr_accessor :key
1136
+ # The label for the field, displayed to the customer.
1137
+ attr_accessor :label
1138
+ # Configuration for `type=numeric` fields.
1139
+ attr_accessor :numeric
1140
+ # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
1141
+ attr_accessor :optional
1142
+ # Configuration for `type=text` fields.
1143
+ attr_accessor :text
1144
+ # The type of the field.
1145
+ attr_accessor :type
1146
+
1147
+ def initialize(
1148
+ dropdown: nil,
1149
+ key: nil,
1150
+ label: nil,
1151
+ numeric: nil,
1152
+ optional: nil,
1153
+ text: nil,
1154
+ type: nil
1155
+ )
1156
+ @dropdown = dropdown
1157
+ @key = key
1158
+ @label = label
1159
+ @numeric = numeric
1160
+ @optional = optional
1161
+ @text = text
1162
+ @type = type
1163
+ end
1164
+ end
1165
+
1166
+ class CustomText < Stripe::RequestParams
1167
+ class AfterSubmit < Stripe::RequestParams
1168
+ # Text may be up to 1200 characters in length.
1169
+ attr_accessor :message
1170
+
1171
+ def initialize(message: nil)
1172
+ @message = message
1173
+ end
1174
+ end
1175
+
1176
+ class ShippingAddress < Stripe::RequestParams
1177
+ # Text may be up to 1200 characters in length.
1178
+ attr_accessor :message
1179
+
1180
+ def initialize(message: nil)
1181
+ @message = message
1182
+ end
1183
+ end
1184
+
1185
+ class Submit < Stripe::RequestParams
1186
+ # Text may be up to 1200 characters in length.
1187
+ attr_accessor :message
1188
+
1189
+ def initialize(message: nil)
1190
+ @message = message
1191
+ end
1192
+ end
1193
+
1194
+ class TermsOfServiceAcceptance < Stripe::RequestParams
1195
+ # Text may be up to 1200 characters in length.
1196
+ attr_accessor :message
1197
+
1198
+ def initialize(message: nil)
1199
+ @message = message
1200
+ end
1201
+ end
1202
+ # Custom text that should be displayed after the payment confirmation button.
1203
+ attr_accessor :after_submit
1204
+ # Custom text that should be displayed alongside shipping address collection.
1205
+ attr_accessor :shipping_address
1206
+ # Custom text that should be displayed alongside the payment confirmation button.
1207
+ attr_accessor :submit
1208
+ # Custom text that should be displayed in place of the default terms of service agreement text.
1209
+ attr_accessor :terms_of_service_acceptance
1210
+
1211
+ def initialize(
1212
+ after_submit: nil,
1213
+ shipping_address: nil,
1214
+ submit: nil,
1215
+ terms_of_service_acceptance: nil
1216
+ )
1217
+ @after_submit = after_submit
1218
+ @shipping_address = shipping_address
1219
+ @submit = submit
1220
+ @terms_of_service_acceptance = terms_of_service_acceptance
1221
+ end
1222
+ end
1223
+
1224
+ class InvoiceCreation < Stripe::RequestParams
1225
+ class InvoiceData < Stripe::RequestParams
1226
+ class CustomField < Stripe::RequestParams
1227
+ # The name of the custom field. This may be up to 40 characters.
1228
+ attr_accessor :name
1229
+ # The value of the custom field. This may be up to 140 characters.
1230
+ attr_accessor :value
1231
+
1232
+ def initialize(name: nil, value: nil)
1233
+ @name = name
1234
+ @value = value
1235
+ end
1236
+ end
1237
+
1238
+ class Issuer < Stripe::RequestParams
1239
+ # The connected account being referenced when `type` is `account`.
1240
+ attr_accessor :account
1241
+ # Type of the account referenced in the request.
1242
+ attr_accessor :type
1243
+
1244
+ def initialize(account: nil, type: nil)
1245
+ @account = account
1246
+ @type = type
1247
+ end
1248
+ end
1249
+
1250
+ class RenderingOptions < Stripe::RequestParams
1251
+ # 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.
1252
+ attr_accessor :amount_tax_display
1253
+
1254
+ def initialize(amount_tax_display: nil)
1255
+ @amount_tax_display = amount_tax_display
1256
+ end
1257
+ end
1258
+ # The account tax IDs associated with the invoice.
1259
+ attr_accessor :account_tax_ids
1260
+ # Default custom fields to be displayed on invoices for this customer.
1261
+ attr_accessor :custom_fields
1262
+ # An arbitrary string attached to the object. Often useful for displaying to users.
1263
+ attr_accessor :description
1264
+ # Default footer to be displayed on invoices for this customer.
1265
+ attr_accessor :footer
1266
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1267
+ attr_accessor :issuer
1268
+ # 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`.
1269
+ attr_accessor :metadata
1270
+ # Default options for invoice PDF rendering for this customer.
1271
+ attr_accessor :rendering_options
1272
+
1273
+ def initialize(
1274
+ account_tax_ids: nil,
1275
+ custom_fields: nil,
1276
+ description: nil,
1277
+ footer: nil,
1278
+ issuer: nil,
1279
+ metadata: nil,
1280
+ rendering_options: nil
1281
+ )
1282
+ @account_tax_ids = account_tax_ids
1283
+ @custom_fields = custom_fields
1284
+ @description = description
1285
+ @footer = footer
1286
+ @issuer = issuer
1287
+ @metadata = metadata
1288
+ @rendering_options = rendering_options
1289
+ end
1290
+ end
1291
+ # Whether the feature is enabled
1292
+ attr_accessor :enabled
1293
+ # Invoice PDF configuration.
1294
+ attr_accessor :invoice_data
1295
+
1296
+ def initialize(enabled: nil, invoice_data: nil)
1297
+ @enabled = enabled
1298
+ @invoice_data = invoice_data
1299
+ end
1300
+ end
1301
+
1302
+ class LineItem < Stripe::RequestParams
1303
+ class AdjustableQuantity < Stripe::RequestParams
1304
+ # Set to true if the quantity can be adjusted to any non-negative Integer.
1305
+ attr_accessor :enabled
1306
+ # The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.
1307
+ attr_accessor :maximum
1308
+ # 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.
1309
+ attr_accessor :minimum
1310
+
1311
+ def initialize(enabled: nil, maximum: nil, minimum: nil)
1312
+ @enabled = enabled
1313
+ @maximum = maximum
1314
+ @minimum = minimum
1315
+ end
1316
+ end
1317
+ # When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
1318
+ attr_accessor :adjustable_quantity
1319
+ # The ID of an existing line item on the payment link.
1320
+ attr_accessor :id
1321
+ # The quantity of the line item being purchased.
1322
+ attr_accessor :quantity
1323
+
1324
+ def initialize(adjustable_quantity: nil, id: nil, quantity: nil)
1325
+ @adjustable_quantity = adjustable_quantity
1326
+ @id = id
1327
+ @quantity = quantity
1328
+ end
1329
+ end
1330
+
1331
+ class PaymentIntentData < Stripe::RequestParams
1332
+ # An arbitrary string attached to the object. Often useful for displaying to users.
1333
+ attr_accessor :description
1334
+ # 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.
1335
+ attr_accessor :metadata
1336
+ # 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).
1337
+ #
1338
+ # 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.
1339
+ attr_accessor :statement_descriptor
1340
+ # 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.
1341
+ attr_accessor :statement_descriptor_suffix
1342
+ # 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.
1343
+ attr_accessor :transfer_group
1344
+
1345
+ def initialize(
1346
+ description: nil,
1347
+ metadata: nil,
1348
+ statement_descriptor: nil,
1349
+ statement_descriptor_suffix: nil,
1350
+ transfer_group: nil
1351
+ )
1352
+ @description = description
1353
+ @metadata = metadata
1354
+ @statement_descriptor = statement_descriptor
1355
+ @statement_descriptor_suffix = statement_descriptor_suffix
1356
+ @transfer_group = transfer_group
1357
+ end
1358
+ end
1359
+
1360
+ class PhoneNumberCollection < Stripe::RequestParams
1361
+ # Set to `true` to enable phone number collection.
1362
+ attr_accessor :enabled
1363
+
1364
+ def initialize(enabled: nil)
1365
+ @enabled = enabled
1366
+ end
1367
+ end
1368
+
1369
+ class Restrictions < Stripe::RequestParams
1370
+ class CompletedSessions < Stripe::RequestParams
1371
+ # The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
1372
+ attr_accessor :limit
1373
+
1374
+ def initialize(limit: nil)
1375
+ @limit = limit
1376
+ end
1377
+ end
1378
+ # Configuration for the `completed_sessions` restriction type.
1379
+ attr_accessor :completed_sessions
1380
+
1381
+ def initialize(completed_sessions: nil)
1382
+ @completed_sessions = completed_sessions
1383
+ end
1384
+ end
1385
+
1386
+ class ShippingAddressCollection < Stripe::RequestParams
1387
+ # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1388
+ # shipping locations.
1389
+ attr_accessor :allowed_countries
1390
+
1391
+ def initialize(allowed_countries: nil)
1392
+ @allowed_countries = allowed_countries
1393
+ end
1394
+ end
1395
+
1396
+ class SubscriptionData < Stripe::RequestParams
1397
+ class InvoiceSettings < Stripe::RequestParams
1398
+ class Issuer < Stripe::RequestParams
1399
+ # The connected account being referenced when `type` is `account`.
1400
+ attr_accessor :account
1401
+ # Type of the account referenced in the request.
1402
+ attr_accessor :type
1403
+
1404
+ def initialize(account: nil, type: nil)
1405
+ @account = account
1406
+ @type = type
1407
+ end
1408
+ end
1409
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1410
+ attr_accessor :issuer
1411
+
1412
+ def initialize(issuer: nil)
1413
+ @issuer = issuer
1414
+ end
1415
+ end
1416
+
1417
+ class TrialSettings < Stripe::RequestParams
1418
+ class EndBehavior < Stripe::RequestParams
1419
+ # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
1420
+ attr_accessor :missing_payment_method
1421
+
1422
+ def initialize(missing_payment_method: nil)
1423
+ @missing_payment_method = missing_payment_method
1424
+ end
1425
+ end
1426
+ # Defines how the subscription should behave when the user's free trial ends.
1427
+ attr_accessor :end_behavior
1428
+
1429
+ def initialize(end_behavior: nil)
1430
+ @end_behavior = end_behavior
1431
+ end
1432
+ end
1433
+ # All invoices will be billed using the specified settings.
1434
+ attr_accessor :invoice_settings
1435
+ # 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.
1436
+ attr_accessor :metadata
1437
+ # Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
1438
+ attr_accessor :trial_period_days
1439
+ # Settings related to subscription trials.
1440
+ attr_accessor :trial_settings
1441
+
1442
+ def initialize(
1443
+ invoice_settings: nil,
1444
+ metadata: nil,
1445
+ trial_period_days: nil,
1446
+ trial_settings: nil
1447
+ )
1448
+ @invoice_settings = invoice_settings
1449
+ @metadata = metadata
1450
+ @trial_period_days = trial_period_days
1451
+ @trial_settings = trial_settings
1452
+ end
1453
+ end
1454
+
1455
+ class TaxIdCollection < Stripe::RequestParams
1456
+ # Enable tax ID collection during checkout. Defaults to `false`.
1457
+ attr_accessor :enabled
1458
+ # Describes whether a tax ID is required during checkout. Defaults to `never`.
1459
+ attr_accessor :required
1460
+
1461
+ def initialize(enabled: nil, required: nil)
1462
+ @enabled = enabled
1463
+ @required = required
1464
+ end
1465
+ end
1466
+ # 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.
1467
+ attr_accessor :active
1468
+ # Behavior after the purchase is complete.
1469
+ attr_accessor :after_completion
1470
+ # Enables user redeemable promotion codes.
1471
+ attr_accessor :allow_promotion_codes
1472
+ # Configuration for automatic tax collection.
1473
+ attr_accessor :automatic_tax
1474
+ # Configuration for collecting the customer's billing address. Defaults to `auto`.
1475
+ attr_accessor :billing_address_collection
1476
+ # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
1477
+ attr_accessor :custom_fields
1478
+ # Display additional text for your customers using custom text.
1479
+ attr_accessor :custom_text
1480
+ # 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).
1481
+ attr_accessor :customer_creation
1482
+ # Specifies which fields in the response should be expanded.
1483
+ attr_accessor :expand
1484
+ # The custom message to be displayed to a customer when a payment link is no longer active.
1485
+ attr_accessor :inactive_message
1486
+ # Generate a post-purchase Invoice for one-time payments.
1487
+ attr_accessor :invoice_creation
1488
+ # The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
1489
+ attr_accessor :line_items
1490
+ # 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.
1491
+ attr_accessor :metadata
1492
+ # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
1493
+ attr_accessor :payment_intent_data
1494
+ # 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.
1495
+ #
1496
+ # Can only be set in `subscription` mode. Defaults to `always`.
1497
+ #
1498
+ # 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).
1499
+ attr_accessor :payment_method_collection
1500
+ # 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).
1501
+ attr_accessor :payment_method_types
1502
+ # Controls phone number collection settings during checkout.
1503
+ #
1504
+ # We recommend that you review your privacy policy and check with your legal contacts.
1505
+ attr_accessor :phone_number_collection
1506
+ # Settings that restrict the usage of a payment link.
1507
+ attr_accessor :restrictions
1508
+ # Configuration for collecting the customer's shipping address.
1509
+ attr_accessor :shipping_address_collection
1510
+ # 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`).
1511
+ attr_accessor :submit_type
1512
+ # 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`.
1513
+ attr_accessor :subscription_data
1514
+ # Controls tax ID collection during checkout.
1515
+ attr_accessor :tax_id_collection
1516
+
1517
+ def initialize(
1518
+ active: nil,
1519
+ after_completion: nil,
1520
+ allow_promotion_codes: nil,
1521
+ automatic_tax: nil,
1522
+ billing_address_collection: nil,
1523
+ custom_fields: nil,
1524
+ custom_text: nil,
1525
+ customer_creation: nil,
1526
+ expand: nil,
1527
+ inactive_message: nil,
1528
+ invoice_creation: nil,
1529
+ line_items: nil,
1530
+ metadata: nil,
1531
+ payment_intent_data: nil,
1532
+ payment_method_collection: nil,
1533
+ payment_method_types: nil,
1534
+ phone_number_collection: nil,
1535
+ restrictions: nil,
1536
+ shipping_address_collection: nil,
1537
+ submit_type: nil,
1538
+ subscription_data: nil,
1539
+ tax_id_collection: nil
1540
+ )
1541
+ @active = active
1542
+ @after_completion = after_completion
1543
+ @allow_promotion_codes = allow_promotion_codes
1544
+ @automatic_tax = automatic_tax
1545
+ @billing_address_collection = billing_address_collection
1546
+ @custom_fields = custom_fields
1547
+ @custom_text = custom_text
1548
+ @customer_creation = customer_creation
1549
+ @expand = expand
1550
+ @inactive_message = inactive_message
1551
+ @invoice_creation = invoice_creation
1552
+ @line_items = line_items
1553
+ @metadata = metadata
1554
+ @payment_intent_data = payment_intent_data
1555
+ @payment_method_collection = payment_method_collection
1556
+ @payment_method_types = payment_method_types
1557
+ @phone_number_collection = phone_number_collection
1558
+ @restrictions = restrictions
1559
+ @shipping_address_collection = shipping_address_collection
1560
+ @submit_type = submit_type
1561
+ @subscription_data = subscription_data
1562
+ @tax_id_collection = tax_id_collection
1563
+ end
1564
+ end
1565
+
1566
+ class ListLineItemsParams < Stripe::RequestParams
1567
+ # 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.
1568
+ attr_accessor :ending_before
1569
+ # Specifies which fields in the response should be expanded.
1570
+ attr_accessor :expand
1571
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1572
+ attr_accessor :limit
1573
+ # 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.
1574
+ attr_accessor :starting_after
1575
+
1576
+ def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
1577
+ @ending_before = ending_before
1578
+ @expand = expand
1579
+ @limit = limit
1580
+ @starting_after = starting_after
1581
+ end
1582
+ end
1583
+ # 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.
1584
+ attr_reader :active
1585
+ # Attribute for field after_completion
1586
+ attr_reader :after_completion
1587
+ # Whether user redeemable promotion codes are enabled.
1588
+ attr_reader :allow_promotion_codes
1589
+ # The ID of the Connect application that created the Payment Link.
1590
+ attr_reader :application
1591
+ # 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.
1592
+ attr_reader :application_fee_amount
1593
+ # This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
1594
+ attr_reader :application_fee_percent
1595
+ # Attribute for field automatic_tax
1596
+ attr_reader :automatic_tax
1597
+ # Configuration for collecting the customer's billing address. Defaults to `auto`.
1598
+ attr_reader :billing_address_collection
1599
+ # When set, provides configuration to gather active consent from customers.
1600
+ attr_reader :consent_collection
1601
+ # 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).
1602
+ attr_reader :currency
1603
+ # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
1604
+ attr_reader :custom_fields
1605
+ # Attribute for field custom_text
1606
+ attr_reader :custom_text
1607
+ # Configuration for Customer creation during checkout.
1608
+ attr_reader :customer_creation
1609
+ # Unique identifier for the object.
1610
+ attr_reader :id
1611
+ # The custom message to be displayed to a customer when a payment link is no longer active.
1612
+ attr_reader :inactive_message
1613
+ # Configuration for creating invoice for payment mode payment links.
1614
+ attr_reader :invoice_creation
1615
+ # The line items representing what is being sold.
1616
+ attr_reader :line_items
1617
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
1618
+ attr_reader :livemode
1619
+ # 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.
1620
+ attr_reader :metadata
1621
+ # String representing the object's type. Objects of the same type share the same value.
1622
+ attr_reader :object
1623
+ # The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.
1624
+ attr_reader :on_behalf_of
1625
+ # The optional items presented to the customer at checkout.
1626
+ attr_reader :optional_items
1627
+ # Indicates the parameters to be passed to PaymentIntent creation during checkout.
1628
+ attr_reader :payment_intent_data
1629
+ # Configuration for collecting a payment method during checkout. Defaults to `always`.
1630
+ attr_reader :payment_method_collection
1631
+ # The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
1632
+ attr_reader :payment_method_types
1633
+ # Attribute for field phone_number_collection
1634
+ attr_reader :phone_number_collection
1635
+ # Settings that restrict the usage of a payment link.
1636
+ attr_reader :restrictions
1637
+ # Configuration for collecting the customer's shipping address.
1638
+ attr_reader :shipping_address_collection
1639
+ # The shipping rate options applied to the session.
1640
+ attr_reader :shipping_options
1641
+ # Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
1642
+ attr_reader :submit_type
1643
+ # 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`.
1644
+ attr_reader :subscription_data
1645
+ # Attribute for field tax_id_collection
1646
+ attr_reader :tax_id_collection
1647
+ # The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
1648
+ attr_reader :transfer_data
1649
+ # The public URL that can be shared with customers.
1650
+ attr_reader :url
1651
+
20
1652
  # Creates a payment link.
21
1653
  def self.create(params = {}, opts = {})
22
1654
  request_stripe_object(method: :post, path: "/v1/payment_links", params: params, opts: opts)