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

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

Price.php

138 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
8	* <a href="https://stripe.com/docs/api#products">Products</a> help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
9	*
10	* For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
11	*
12	* Related guides: <a href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up a subscription</a>, <a href="https://stripe.com/docs/billing/invoices/create">create an invoice</a>, and more about <a href="https://stripe.com/docs/products-prices/overview">products and prices</a>.
13	*
14	* @property string $id Unique identifier for the object.
15	* @property string $object String representing the object's type. Objects of the same type share the same value.
16	* @property bool $active Whether the price can be used for new purchases.
17	* @property string $billing_scheme Describes how to compute the price per period. Either <code>per_unit</code> or <code>tiered</code>. <code>per_unit</code> indicates that the fixed amount (specified in <code>unit_amount</code> or <code>unit_amount_decimal</code>) will be charged per unit in <code>quantity</code> (for prices with <code>usage_type=licensed</code>), or per unit of total usage (for prices with <code>usage_type=metered</code>). <code>tiered</code> indicates that the unit pricing will be computed using a tiering strategy as defined using the <code>tiers</code> and <code>tiers_mode</code> attributes.
18	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
19	* @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>.
20	* @property null\|\Stripe\StripeObject $currency_options Prices 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>.
21	* @property null\|\Stripe\StripeObject $custom_unit_amount When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
22	* @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.
23	* @property null\|string $lookup_key A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
24	* @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.
25	* @property null\|string $nickname A brief description of the price, hidden from customers.
26	* @property string\|\Stripe\Product $product The ID of the product this price is associated with.
27	* @property null\|\Stripe\StripeObject $recurring The recurring components of a price such as <code>interval</code> and <code>usage_type</code>.
28	* @property null\|string $tax_behavior Only required if a <a href="https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)">default tax behavior</a> was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of <code>inclusive</code>, <code>exclusive</code>, or <code>unspecified</code>. Once specified as either <code>inclusive</code> or <code>exclusive</code>, it cannot be changed.
29	* @property null\|\Stripe\StripeObject[] $tiers Each element represents a pricing tier. This parameter requires <code>billing_scheme</code> to be set to <code>tiered</code>. See also the documentation for <code>billing_scheme</code>.
30	* @property null\|string $tiers_mode Defines if the tiering price should be <code>graduated</code> or <code>volume</code> based. In <code>volume</code>-based tiering, the maximum quantity within a period determines the per unit price. In <code>graduated</code> tiering, pricing can change as the quantity grows.
31	* @property null\|\Stripe\StripeObject $transform_quantity Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with <code>tiers</code>.
32	* @property string $type One of <code>one_time</code> or <code>recurring</code> depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
33	* @property null\|int $unit_amount The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if <code>billing_scheme=per_unit</code>.
34	* @property null\|string $unit_amount_decimal The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if <code>billing_scheme=per_unit</code>.
35	*/
36	class Price extends ApiResource
37	{
38	const OBJECT_NAME = 'price';
39	use ApiOperations\Update;
40	const BILLING_SCHEME_PER_UNIT = 'per_unit';
41	const BILLING_SCHEME_TIERED = 'tiered';
42	const TAX_BEHAVIOR_EXCLUSIVE = 'exclusive';
43	const TAX_BEHAVIOR_INCLUSIVE = 'inclusive';
44	const TAX_BEHAVIOR_UNSPECIFIED = 'unspecified';
45	const TIERS_MODE_GRADUATED = 'graduated';
46	const TIERS_MODE_VOLUME = 'volume';
47	const TYPE_ONE_TIME = 'one_time';
48	const TYPE_RECURRING = 'recurring';
49	/**
50	* Creates a new price for an existing product. The price can be recurring or
51	* one-time.
52	*
53	* @param null\|array $params
54	* @param null\|array\|string $options
55	*
56	* @throws \Stripe\Exception\ApiErrorException if the request fails
57	*
58	* @return \Stripe\Price the created resource
59	*/
60	public static function create($params = null, $options = null)
61	{
62	self::_validateParams($params);
63	$url = static::classUrl();
64	list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
65	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
66	$obj->setLastResponse($response);
67	return $obj;
68	}
69	/**
70	* Returns a list of your active prices, excluding <a
71	* href="/docs/products-prices/pricing-models#inline-pricing">inline prices</a>.
72	* For the list of inactive prices, set <code>active</code> to false.
73	*
74	* @param null\|array $params
75	* @param null\|array\|string $opts
76	*
77	* @throws \Stripe\Exception\ApiErrorException if the request fails
78	*
79	* @return \Stripe\Collection<\Stripe\Price> of ApiResources
80	*/
81	public static function all($params = null, $opts = null)
82	{
83	$url = static::classUrl();
84	return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts);
85	}
86	/**
87	* Retrieves the price with the given ID.
88	*
89	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
90	* @param null\|array\|string $opts
91	*
92	* @throws \Stripe\Exception\ApiErrorException if the request fails
93	*
94	* @return \Stripe\Price
95	*/
96	public static function retrieve($id, $opts = null)
97	{
98	$opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts);
99	$instance = new static($id, $opts);
100	$instance->refresh();
101	return $instance;
102	}
103	/**
104	* Updates the specified price by setting the values of the parameters passed. Any
105	* parameters not provided are left unchanged.
106	*
107	* @param string $id the ID of the resource to update
108	* @param null\|array $params
109	* @param null\|array\|string $opts
110	*
111	* @throws \Stripe\Exception\ApiErrorException if the request fails
112	*
113	* @return \Stripe\Price the updated resource
114	*/
115	public static function update($id, $params = null, $opts = null)
116	{
117	self::_validateParams($params);
118	$url = static::resourceUrl($id);
119	list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
120	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
121	$obj->setLastResponse($response);
122	return $obj;
123	}
124	/**
125	* @param null\|array $params
126	* @param null\|array\|string $opts
127	*
128	* @throws \Stripe\Exception\ApiErrorException if the request fails
129	*
130	* @return \Stripe\SearchResult<\Stripe\Price> the price search results
131	*/
132	public static function search($params = null, $opts = null)
133	{
134	$url = '/v1/prices/search';
135	return static::_requestPage($url, \ProfilePressVendor\Stripe\SearchResult::class, $params, $opts);
136	}
137	}
138