give / vendor / stripe / stripe-php / lib / Quote.php

Quote.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.4, at vendor/stripe/stripe-php/lib/Quote.php

172 lines 8.8 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe;
6
7	/**
8	* A Quote is a way to model prices that you'd like to provide to a customer. Once
9	* accepted, it will automatically create an invoice, subscription or subscription
10	* schedule.
11	*
12	* @property string $id Unique identifier for the object.
13	* @property string $object String representing the object's type. Objects of the same type share the same value.
14	* @property int $amount_subtotal Total before any discounts or taxes are applied.
15	* @property int $amount_total Total after discounts and taxes are applied.
16	* @property null\|string\|\Stripe\StripeObject $application ID of the Connect Application that created the quote.
17	* @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. Only applicable if there are no line items with recurring prices on the quote.
18	* @property null\|float $application_fee_percent A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.
19	* @property \Stripe\StripeObject $automatic_tax
20	* @property string $collection_method Either <code>charge_automatically</code>, or <code>send_invoice</code>. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to <code>charge_automatically</code>.
21	* @property \Stripe\StripeObject $computed
22	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
23	* @property null\|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>.
24	* @property null\|string\|\Stripe\Customer $customer The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
25	* @property (string\|\Stripe\TaxRate)[] $default_tax_rates The tax rates applied to this quote.
26	* @property null\|string $description A description that will be displayed on the quote PDF.
27	* @property (string\|\Stripe\Discount)[] $discounts The discounts applied to this quote.
28	* @property int $expires_at The date on which the quote will be canceled if in <code>open</code> or <code>draft</code> status. Measured in seconds since the Unix epoch.
29	* @property null\|string $footer A footer that will be displayed on the quote PDF.
30	* @property null\|\Stripe\StripeObject $from_quote Details of the quote that was cloned. See the <a href="https://stripe.com/docs/quotes/clone">cloning documentation</a> for more details.
31	* @property null\|string $header A header that will be displayed on the quote PDF.
32	* @property null\|string\|\Stripe\Invoice $invoice The invoice that was created from this quote.
33	* @property null\|\Stripe\StripeObject $invoice_settings All invoices will be billed using the specified settings.
34	* @property \Stripe\Collection<\Stripe\LineItem> $line_items A list of items the customer is being quoted for.
35	* @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.
36	* @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.
37	* @property null\|string $number A unique number that identifies this particular quote. This number is assigned once the quote is <a href="https://stripe.com/docs/quotes/overview#finalize">finalized</a>.
38	* @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.
39	* @property string $status The status of the quote.
40	* @property \Stripe\StripeObject $status_transitions
41	* @property null\|string\|\Stripe\Subscription $subscription The subscription that was created or updated from this quote.
42	* @property \Stripe\StripeObject $subscription_data
43	* @property null\|string\|\Stripe\SubscriptionSchedule $subscription_schedule The subscription schedule that was created or updated from this quote.
44	* @property null\|string\|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this quote belongs to.
45	* @property \Stripe\StripeObject $total_details
46	* @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 for each of the invoices.
47	*/
48	class Quote extends ApiResource
49	{
50	const OBJECT_NAME = 'quote';
51
52	use ApiOperations\All;
53	use ApiOperations\Create;
54	use ApiOperations\Retrieve;
55	use ApiOperations\Update;
56
57	const COLLECTION_METHOD_CHARGE_AUTOMATICALLY = 'charge_automatically';
58	const COLLECTION_METHOD_SEND_INVOICE = 'send_invoice';
59
60	const STATUS_ACCEPTED = 'accepted';
61	const STATUS_CANCELED = 'canceled';
62	const STATUS_DRAFT = 'draft';
63	const STATUS_OPEN = 'open';
64
65	/**
66	* @param callable $readBodyChunkCallable
67	* @param null\|array $params
68	* @param null\|array\|string $opts
69	*
70	* @throws \Stripe\Exception\ApiErrorException if the request fails
71	*/
72	public function pdf($readBodyChunkCallable, $params = null, $opts = null)
73	{
74	$opts = \Stripe\Util\RequestOptions::parse($opts);
75	if (null === $opts->apiBase) {
76	$opts->apiBase = Stripe::$apiUploadBase;
77	}
78
79	$url = $this->instanceUrl() . '/pdf';
80	$this->_requestStream('get', $url, $readBodyChunkCallable, $params, $opts);
81	}
82
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\Quote the accepted quote
90	*/
91	public function accept($params = null, $opts = null)
92	{
93	$url = $this->instanceUrl() . '/accept';
94	list($response, $opts) = $this->_request('post', $url, $params, $opts);
95	$this->refreshFrom($response, $opts);
96
97	return $this;
98	}
99
100	/**
101	* @param null\|array $params
102	* @param null\|array\|string $opts
103	*
104	* @throws \Stripe\Exception\ApiErrorException if the request fails
105	*
106	* @return \Stripe\Quote the canceled quote
107	*/
108	public function cancel($params = null, $opts = null)
109	{
110	$url = $this->instanceUrl() . '/cancel';
111	list($response, $opts) = $this->_request('post', $url, $params, $opts);
112	$this->refreshFrom($response, $opts);
113
114	return $this;
115	}
116
117	/**
118	* @param null\|array $params
119	* @param null\|array\|string $opts
120	*
121	* @throws \Stripe\Exception\ApiErrorException if the request fails
122	*
123	* @return \Stripe\Quote the finalized quote
124	*/
125	public function finalizeQuote($params = null, $opts = null)
126	{
127	$url = $this->instanceUrl() . '/finalize';
128	list($response, $opts) = $this->_request('post', $url, $params, $opts);
129	$this->refreshFrom($response, $opts);
130
131	return $this;
132	}
133
134	/**
135	* @param null\|array $params
136	* @param null\|array\|string $opts
137	* @param mixed $id
138	*
139	* @throws \Stripe\Exception\ApiErrorException if the request fails
140	*
141	* @return \Stripe\Collection<\Stripe\Quote> list of LineItems
142	*/
143	public static function allComputedUpfrontLineItems($id, $params = null, $opts = null)
144	{
145	$url = static::resourceUrl($id) . '/computed_upfront_line_items';
146	list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
147	$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
148	$obj->setLastResponse($response);
149
150	return $obj;
151	}
152
153	/**
154	* @param null\|array $params
155	* @param null\|array\|string $opts
156	* @param mixed $id
157	*
158	* @throws \Stripe\Exception\ApiErrorException if the request fails
159	*
160	* @return \Stripe\Collection<\Stripe\Quote> list of LineItems
161	*/
162	public static function allLineItems($id, $params = null, $opts = null)
163	{
164	$url = static::resourceUrl($id) . '/line_items';
165	list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
166	$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
167	$obj->setLastResponse($response);
168
169	return $obj;
170	}
171	}
172