TaxRate.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 / TaxRate.php

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

TaxRate.php

129 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* Tax rates can be applied to <a href="/invoicing/taxes/tax-rates">invoices</a>, <a href="/billing/taxes/tax-rates">subscriptions</a> and <a href="/payments/checkout/use-manual-tax-rates">Checkout Sessions</a> to collect tax.
8	*
9	* Related guide: <a href="/billing/taxes/tax-rates">Tax rates</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 bool $active Defaults to <code>true</code>. When set to <code>false</code>, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
14	* @property null\|string $country Two-letter country code (<a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a>).
15	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
16	* @property null\|string $description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
17	* @property string $display_name The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
18	* @property null\|float $effective_percentage Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
19	* @property null\|\Stripe\StripeObject $flat_amount The amount of the tax rate when the <code>rate_type</code> is <code>flat_amount</code>. Tax rates with <code>rate_type</code> <code>percentage</code> can vary based on the transaction, resulting in this field being <code>null</code>. This field exposes the amount and currency of the flat tax rate.
20	* @property bool $inclusive This specifies if the tax rate is inclusive or exclusive.
21	* @property null\|string $jurisdiction The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
22	* @property null\|string $jurisdiction_level The level of the jurisdiction that imposes this tax rate. Will be <code>null</code> for manually defined tax rates.
23	* @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.
24	* @property null\|\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.
25	* @property float $percentage Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
26	* @property null\|string $rate_type Indicates the type of tax rate applied to the taxable amount. This value can be <code>null</code> when no tax applies to the location.
27	* @property null\|string $state <a href="https://en.wikipedia.org/wiki/ISO_3166-2">ISO 3166-2 subdivision code</a>, without country prefix. For example, "NY" for New York, United States.
28	* @property null\|string $tax_type The high-level tax type, such as <code>vat</code> or <code>sales_tax</code>.
29	*/
30	class TaxRate extends ApiResource
31	{
32	const OBJECT_NAME = 'tax_rate';
33	use ApiOperations\Update;
34	const JURISDICTION_LEVEL_CITY = 'city';
35	const JURISDICTION_LEVEL_COUNTRY = 'country';
36	const JURISDICTION_LEVEL_COUNTY = 'county';
37	const JURISDICTION_LEVEL_DISTRICT = 'district';
38	const JURISDICTION_LEVEL_MULTIPLE = 'multiple';
39	const JURISDICTION_LEVEL_STATE = 'state';
40	const RATE_TYPE_FLAT_AMOUNT = 'flat_amount';
41	const RATE_TYPE_PERCENTAGE = 'percentage';
42	const TAX_TYPE_AMUSEMENT_TAX = 'amusement_tax';
43	const TAX_TYPE_COMMUNICATIONS_TAX = 'communications_tax';
44	const TAX_TYPE_GST = 'gst';
45	const TAX_TYPE_HST = 'hst';
46	const TAX_TYPE_IGST = 'igst';
47	const TAX_TYPE_JCT = 'jct';
48	const TAX_TYPE_LEASE_TAX = 'lease_tax';
49	const TAX_TYPE_PST = 'pst';
50	const TAX_TYPE_QST = 'qst';
51	const TAX_TYPE_RETAIL_DELIVERY_FEE = 'retail_delivery_fee';
52	const TAX_TYPE_RST = 'rst';
53	const TAX_TYPE_SALES_TAX = 'sales_tax';
54	const TAX_TYPE_SERVICE_TAX = 'service_tax';
55	const TAX_TYPE_VAT = 'vat';
56	/**
57	* Creates a new tax rate.
58	*
59	* @param null\|array $params
60	* @param null\|array\|string $options
61	*
62	* @throws \Stripe\Exception\ApiErrorException if the request fails
63	*
64	* @return \Stripe\TaxRate the created resource
65	*/
66	public static function create($params = null, $options = null)
67	{
68	self::_validateParams($params);
69	$url = static::classUrl();
70	list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
71	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
72	$obj->setLastResponse($response);
73	return $obj;
74	}
75	/**
76	* Returns a list of your tax rates. Tax rates are returned sorted by creation
77	* date, with the most recently created tax rates appearing first.
78	*
79	* @param null\|array $params
80	* @param null\|array\|string $opts
81	*
82	* @throws \Stripe\Exception\ApiErrorException if the request fails
83	*
84	* @return \Stripe\Collection<\Stripe\TaxRate> of ApiResources
85	*/
86	public static function all($params = null, $opts = null)
87	{
88	$url = static::classUrl();
89	return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts);
90	}
91	/**
92	* Retrieves a tax rate with the given ID.
93	*
94	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
95	* @param null\|array\|string $opts
96	*
97	* @throws \Stripe\Exception\ApiErrorException if the request fails
98	*
99	* @return \Stripe\TaxRate
100	*/
101	public static function retrieve($id, $opts = null)
102	{
103	$opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts);
104	$instance = new static($id, $opts);
105	$instance->refresh();
106	return $instance;
107	}
108	/**
109	* Updates an existing tax rate.
110	*
111	* @param string $id the ID of the resource to update
112	* @param null\|array $params
113	* @param null\|array\|string $opts
114	*
115	* @throws \Stripe\Exception\ApiErrorException if the request fails
116	*
117	* @return \Stripe\TaxRate the updated resource
118	*/
119	public static function update($id, $params = null, $opts = null)
120	{
121	self::_validateParams($params);
122	$url = static::resourceUrl($id);
123	list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
124	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
125	$obj->setLastResponse($response);
126	return $obj;
127	}
128	}
129