PaymentLink.php — Paid Membership Plugin, Ecommerce, User Registration Form, Login Form, User Profile & Restrict Content – ProfilePress 4.17.1

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib / PaymentLink.php

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib Last commit date

PaymentLink.php

151 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.
8	*
9	* When a customer opens a payment link it will open a new <a href="https://stripe.com/docs/api/checkout/sessions">checkout session</a> to render the payment page. You can use <a href="https://stripe.com/docs/api/events/types#event_types-checkout.session.completed">checkout session events</a> to track payments through payment links.
10	*
11	* Related guide: <a href="https://stripe.com/docs/payment-links">Payment Links API</a>
12	*
13	* @property string $id Unique identifier for the object.
14	* @property string $object String representing the object's type. Objects of the same type share the same value.
15	* @property bool $active Whether the payment link's <code>url</code> is active. If <code>false</code>, customers visiting the URL will be shown a page saying that the link has been deactivated.
16	* @property \Stripe\StripeObject $after_completion
17	* @property bool $allow_promotion_codes Whether user redeemable promotion codes are enabled.
18	* @property null\|string\|\Stripe\Application $application The ID of the Connect application that created the Payment Link.
19	* @property null\|int $application_fee_amount 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.
20	* @property null\|float $application_fee_percent This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
21	* @property \Stripe\StripeObject $automatic_tax
22	* @property string $billing_address_collection Configuration for collecting the customer's billing address. Defaults to <code>auto</code>.
23	* @property null\|\Stripe\StripeObject $consent_collection When set, provides configuration to gather active consent from customers.
24	* @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
25	* @property \Stripe\StripeObject[] $custom_fields Collect additional information from your customer using custom fields. Up to 3 fields are supported.
26	* @property \Stripe\StripeObject $custom_text
27	* @property string $customer_creation Configuration for Customer creation during checkout.
28	* @property null\|string $inactive_message The custom message to be displayed to a customer when a payment link is no longer active.
29	* @property null\|\Stripe\StripeObject $invoice_creation Configuration for creating invoice for payment mode payment links.
30	* @property null\|\Stripe\Collection<\Stripe\LineItem> $line_items The line items representing what is being sold.
31	* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
32	* @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
33	* @property null\|string\|\Stripe\Account $on_behalf_of The account on behalf of which to charge. See the <a href="https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts">Connect documentation</a> for details.
34	* @property null\|\Stripe\StripeObject $payment_intent_data Indicates the parameters to be passed to PaymentIntent creation during checkout.
35	* @property string $payment_method_collection Configuration for collecting a payment method during checkout. Defaults to <code>always</code>.
36	* @property null\|string[] $payment_method_types The list of payment method types that customers can use. When <code>null</code>, Stripe will dynamically show relevant payment methods you've enabled in your <a href="https://dashboard.stripe.com/settings/payment_methods">payment method settings</a>.
37	* @property \Stripe\StripeObject $phone_number_collection
38	* @property null\|\Stripe\StripeObject $restrictions Settings that restrict the usage of a payment link.
39	* @property null\|\Stripe\StripeObject $shipping_address_collection Configuration for collecting the customer's shipping address.
40	* @property \Stripe\StripeObject[] $shipping_options The shipping rate options applied to the session.
41	* @property string $submit_type Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
42	* @property null\|\Stripe\StripeObject $subscription_data 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 <code>subscription_data</code>.
43	* @property \Stripe\StripeObject $tax_id_collection
44	* @property null\|\Stripe\StripeObject $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
45	* @property string $url The public URL that can be shared with customers.
46	*/
47	class PaymentLink extends ApiResource
48	{
49	const OBJECT_NAME = 'payment_link';
50	use ApiOperations\Update;
51	const BILLING_ADDRESS_COLLECTION_AUTO = 'auto';
52	const BILLING_ADDRESS_COLLECTION_REQUIRED = 'required';
53	const CUSTOMER_CREATION_ALWAYS = 'always';
54	const CUSTOMER_CREATION_IF_REQUIRED = 'if_required';
55	const PAYMENT_METHOD_COLLECTION_ALWAYS = 'always';
56	const PAYMENT_METHOD_COLLECTION_IF_REQUIRED = 'if_required';
57	const SUBMIT_TYPE_AUTO = 'auto';
58	const SUBMIT_TYPE_BOOK = 'book';
59	const SUBMIT_TYPE_DONATE = 'donate';
60	const SUBMIT_TYPE_PAY = 'pay';
61	const SUBMIT_TYPE_SUBSCRIBE = 'subscribe';
62	/**
63	* Creates a payment link.
64	*
65	* @param null\|array $params
66	* @param null\|array\|string $options
67	*
68	* @throws \Stripe\Exception\ApiErrorException if the request fails
69	*
70	* @return \Stripe\PaymentLink the created resource
71	*/
72	public static function create($params = null, $options = null)
73	{
74	self::_validateParams($params);
75	$url = static::classUrl();
76	list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
77	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
78	$obj->setLastResponse($response);
79	return $obj;
80	}
81	/**
82	* Returns a list of your payment links.
83	*
84	* @param null\|array $params
85	* @param null\|array\|string $opts
86	*
87	* @throws \Stripe\Exception\ApiErrorException if the request fails
88	*
89	* @return \Stripe\Collection<\Stripe\PaymentLink> of ApiResources
90	*/
91	public static function all($params = null, $opts = null)
92	{
93	$url = static::classUrl();
94	return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts);
95	}
96	/**
97	* Retrieve a payment link.
98	*
99	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
100	* @param null\|array\|string $opts
101	*
102	* @throws \Stripe\Exception\ApiErrorException if the request fails
103	*
104	* @return \Stripe\PaymentLink
105	*/
106	public static function retrieve($id, $opts = null)
107	{
108	$opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts);
109	$instance = new static($id, $opts);
110	$instance->refresh();
111	return $instance;
112	}
113	/**
114	* Updates a payment link.
115	*
116	* @param string $id the ID of the resource to update
117	* @param null\|array $params
118	* @param null\|array\|string $opts
119	*
120	* @throws \Stripe\Exception\ApiErrorException if the request fails
121	*
122	* @return \Stripe\PaymentLink the updated resource
123	*/
124	public static function update($id, $params = null, $opts = null)
125	{
126	self::_validateParams($params);
127	$url = static::resourceUrl($id);
128	list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
129	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
130	$obj->setLastResponse($response);
131	return $obj;
132	}
133	/**
134	* @param string $id
135	* @param null\|array $params
136	* @param null\|array\|string $opts
137	*
138	* @throws \Stripe\Exception\ApiErrorException if the request fails
139	*
140	* @return \Stripe\Collection<\Stripe\LineItem> list of line items
141	*/
142	public static function allLineItems($id, $params = null, $opts = null)
143	{
144	$url = static::resourceUrl($id) . '/line_items';
145	list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
146	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
147	$obj->setLastResponse($response);
148	return $obj;
149	}
150	}
151