Coupon.php — Booking for Appointments and Events Calendar – Amelia 2.4.4

ameliabooking / vendor / stripe / stripe-php / lib / Coupon.php

ameliabooking / vendor / stripe / stripe-php / lib Last commit date

Coupon.php

143 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace AmeliaVendor\Stripe;
5
6	/**
7	* A coupon contains information about a percent-off or amount-off discount you
8	* might want to apply to a customer. Coupons may be applied to <a href="https://stripe.com/docs/api#subscriptions">subscriptions</a>, <a href="https://stripe.com/docs/api#invoices">invoices</a>,
9	* <a href="https://stripe.com/docs/api/checkout/sessions">checkout sessions</a>, <a href="https://stripe.com/docs/api#quotes">quotes</a>, and more. Coupons do not work with conventional one-off <a href="https://stripe.com/docs/api#create_charge">charges</a> or <a href="https://stripe.com/docs/api/payment_intents">payment intents</a>.
10	*
11	* @property string $id Unique identifier for the object.
12	* @property string $object String representing the object's type. Objects of the same type share the same value.
13	* @property null\|int $amount_off Amount (in the <code>currency</code> specified) that will be taken off the subtotal of any invoices for this customer.
14	* @property null\|(object{products: string[]}&StripeObject) $applies_to
15	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
16	* @property null\|string $currency If <code>amount_off</code> has been set, the three-letter <a href="https://stripe.com/docs/currencies">ISO code for the currency</a> of the amount to take off.
17	* @property null\|StripeObject $currency_options Coupons defined in each available currency option. Each key must be a three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a> and a <a href="https://stripe.com/docs/currencies">supported currency</a>.
18	* @property string $duration One of <code>forever</code>, <code>once</code>, or <code>repeating</code>. Describes how long a customer who applies this coupon will get the discount.
19	* @property null\|int $duration_in_months If <code>duration</code> is <code>repeating</code>, the number of months the coupon applies. Null if coupon <code>duration</code> is <code>forever</code> or <code>once</code>.
20	* @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.
21	* @property null\|int $max_redemptions Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
22	* @property null\|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.
23	* @property null\|string $name Name of the coupon displayed to customers on for instance invoices or receipts.
24	* @property null\|float $percent_off Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
25	* @property null\|int $redeem_by Date after which the coupon can no longer be redeemed.
26	* @property int $times_redeemed Number of times this coupon has been applied to a customer.
27	* @property bool $valid Taking account of the above properties, whether this coupon can still be applied to a customer.
28	*/
29	class Coupon extends ApiResource
30	{
31	const OBJECT_NAME = 'coupon';
32	use \AmeliaVendor\Stripe\ApiOperations\Update;
33	const DURATION_FOREVER = 'forever';
34	const DURATION_ONCE = 'once';
35	const DURATION_REPEATING = 'repeating';
36	/**
37	* You can create coupons easily via the <a
38	* href="https://dashboard.stripe.com/coupons">coupon management</a> page of the
39	* Stripe dashboard. Coupon creation is also accessible via the API if you need to
40	* create coupons on the fly.
41	*
42	* A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and
43	* <code>currency</code>. If you set an <code>amount_off</code>, that amount will
44	* be subtracted from any invoice’s subtotal. For example, an invoice with a
45	* subtotal of <currency>100</currency> will have a final total of
46	* <currency>0</currency> if a coupon with an <code>amount_off</code> of
47	* <amount>200</amount> is applied to it and an invoice with a subtotal of
48	* <currency>300</currency> will have a final total of <currency>100</currency> if
49	* a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to
50	* it.
51	*
52	* @param null\|array{amount_off?: int, applies_to?: array{products?: string[]}, currency?: string, currency_options?: array<string, array{amount_off: int}>, duration?: string, duration_in_months?: int, expand?: string[], id?: string, max_redemptions?: int, metadata?: null\|array<string, string>, name?: string, percent_off?: float, redeem_by?: int} $params
53	* @param null\|array\|string $options
54	*
55	* @return Coupon the created resource
56	*
57	* @throws Exception\ApiErrorException if the request fails
58	*/
59	public static function create($params = null, $options = null)
60	{
61	self::_validateParams($params);
62	$url = static::classUrl();
63	list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
64	$obj = \AmeliaVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
65	$obj->setLastResponse($response);
66	return $obj;
67	}
68	/**
69	* You can delete coupons via the <a
70	* href="https://dashboard.stripe.com/coupons">coupon management</a> page of the
71	* Stripe dashboard. However, deleting a coupon does not affect any customers who
72	* have already applied the coupon; it means that new customers can’t redeem the
73	* coupon. You can also delete coupons via the API.
74	*
75	* @param null\|array $params
76	* @param null\|array\|string $opts
77	*
78	* @return Coupon the deleted resource
79	*
80	* @throws Exception\ApiErrorException if the request fails
81	*/
82	public function delete($params = null, $opts = null)
83	{
84	self::_validateParams($params);
85	$url = $this->instanceUrl();
86	list($response, $opts) = $this->_request('delete', $url, $params, $opts);
87	$this->refreshFrom($response, $opts);
88	return $this;
89	}
90	/**
91	* Returns a list of your coupons.
92	*
93	* @param null\|array{created?: array\|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
94	* @param null\|array\|string $opts
95	*
96	* @return Collection<Coupon> of ApiResources
97	*
98	* @throws Exception\ApiErrorException if the request fails
99	*/
100	public static function all($params = null, $opts = null)
101	{
102	$url = static::classUrl();
103	return static::_requestPage($url, Collection::class, $params, $opts);
104	}
105	/**
106	* Retrieves the coupon with the given ID.
107	*
108	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
109	* @param null\|array\|string $opts
110	*
111	* @return Coupon
112	*
113	* @throws Exception\ApiErrorException if the request fails
114	*/
115	public static function retrieve($id, $opts = null)
116	{
117	$opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts);
118	$instance = new static($id, $opts);
119	$instance->refresh();
120	return $instance;
121	}
122	/**
123	* Updates the metadata of a coupon. Other coupon details (currency, duration,
124	* amount_off) are, by design, not editable.
125	*
126	* @param string $id the ID of the resource to update
127	* @param null\|array{currency_options?: array<string, array{amount_off: int}>, expand?: string[], metadata?: null\|array<string, string>, name?: string} $params
128	* @param null\|array\|string $opts
129	*
130	* @return Coupon the updated resource
131	*
132	* @throws Exception\ApiErrorException if the request fails
133	*/
134	public static function update($id, $params = null, $opts = null)
135	{
136	self::_validateParams($params);
137	$url = static::resourceUrl($id);
138	list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
139	$obj = \AmeliaVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
140	$obj->setLastResponse($response);
141	return $obj;
142	}
143	}