charitable / vendor / stripe / stripe-php / lib / PaymentLink.php

PaymentLink.php in Charitable – Donation & Fundraising Platform (Donation Forms, Recurring Donations & Fundraising Campaigns) 1.8.13, at vendor/stripe/stripe-php/lib/PaymentLink.php

85 lines 5.3 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe;
6
7	/**
8	* A payment link is a shareable URL that will take your customers to a hosted
9	* payment page. A payment link can be shared and used multiple times.
10	*
11	* When a customer opens a payment link it will open a new <a
12	* href="https://stripe.com/docs/api/checkout/sessions">checkout session</a> to
13	* render the payment page. You can use <a
14	* href="https://stripe.com/docs/api/events/types#event_types-checkout.session.completed">checkout
15	* session events</a> to track payments through payment links.
16	*
17	* Related guide: <a
18	* href="https://stripe.com/docs/payments/payment-links/api">Payment Links API</a>
19	*
20	* @property string $id Unique identifier for the object.
21	* @property string $object String representing the object's type. Objects of the same type share the same value.
22	* @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.
23	* @property \Stripe\StripeObject $after_completion
24	* @property bool $allow_promotion_codes Whether user redeemable promotion codes are enabled.
25	* @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.
26	* @property null\|float $application_fee_percent This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.
27	* @property \Stripe\StripeObject $automatic_tax
28	* @property string $billing_address_collection Configuration for collecting the customer's billing address.
29	* @property null\|\Stripe\StripeObject $consent_collection When set, provides configuration to gather active consent from customers.
30	* @property string $customer_creation Configuration for Customer creation during checkout.
31	* @property \Stripe\Collection<\Stripe\LineItem> $line_items The line items representing what is being sold.
32	* @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.
33	* @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.
34	* @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.
35	* @property null\|\Stripe\StripeObject $payment_intent_data Indicates the parameters to be passed to PaymentIntent creation during checkout.
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 $shipping_address_collection Configuration for collecting the customer's shipping address.
39	* @property \Stripe\StripeObject[] $shipping_options The shipping rate options applied to the session.
40	* @property string $submit_type Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
41	* @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>.
42	* @property \Stripe\StripeObject $tax_id_collection
43	* @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.
44	* @property string $url The public URL that can be shared with customers.
45	*/
46	class PaymentLink extends ApiResource
47	{
48	const OBJECT_NAME = 'payment_link';
49
50	use ApiOperations\All;
51	use ApiOperations\Create;
52	use ApiOperations\Retrieve;
53	use ApiOperations\Update;
54
55	const BILLING_ADDRESS_COLLECTION_AUTO = 'auto';
56	const BILLING_ADDRESS_COLLECTION_REQUIRED = 'required';
57
58	const CUSTOMER_CREATION_ALWAYS = 'always';
59	const CUSTOMER_CREATION_IF_REQUIRED = 'if_required';
60
61	const SUBMIT_TYPE_AUTO = 'auto';
62	const SUBMIT_TYPE_BOOK = 'book';
63	const SUBMIT_TYPE_DONATE = 'donate';
64	const SUBMIT_TYPE_PAY = 'pay';
65
66	/**
67	* @param string $id
68	* @param null\|array $params
69	* @param null\|array\|string $opts
70	*
71	* @throws \Stripe\Exception\ApiErrorException if the request fails
72	*
73	* @return \Stripe\Collection<\Stripe\LineItem> list of LineItems
74	*/
75	public static function allLineItems($id, $params = null, $opts = null)
76	{
77	$url = static::resourceUrl($id) . '/line_items';
78	list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
79	$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
80	$obj->setLastResponse($response);
81
82	return $obj;
83	}
84	}
85