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

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

SubscriptionItem.php

147 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* Subscription items allow you to create customer subscriptions with more than
8	* one plan, making it easy to represent complex billing relationships.
9	*
10	* @property string $id Unique identifier for the object.
11	* @property string $object String representing the object's type. Objects of the same type share the same value.
12	* @property null\|\Stripe\StripeObject $billing_thresholds Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
13	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
14	* @property (string\|\Stripe\Discount)[] $discounts The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use <code>expand[]=discounts</code> to expand each discount.
15	* @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.
16	* @property \Stripe\Plan $plan <p>You can now model subscriptions more flexibly using the <a href="https://stripe.com/docs/api#prices">Prices API</a>. It replaces the Plans API and is backwards compatible to simplify your migration.</p><p>Plans define the base price, currency, and billing cycle for recurring purchases of products. <a href="https://stripe.com/docs/api#products">Products</a> help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.</p><p>For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.</p><p>Related guides: <a href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up a subscription</a> and more about <a href="https://stripe.com/docs/products-prices/overview">products and prices</a>.</p>
17	* @property \Stripe\Price $price <p>Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. <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.</p><p>For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.</p><p>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>.</p>
18	* @property null\|int $quantity The <a href="https://stripe.com/docs/subscriptions/quantities">quantity</a> of the plan to which the customer should be subscribed.
19	* @property string $subscription The <code>subscription</code> this <code>subscription_item</code> belongs to.
20	* @property null\|\Stripe\TaxRate[] $tax_rates The tax rates which apply to this <code>subscription_item</code>. When set, the <code>default_tax_rates</code> on the subscription do not apply to this <code>subscription_item</code>.
21	*/
22	class SubscriptionItem extends ApiResource
23	{
24	const OBJECT_NAME = 'subscription_item';
25	use ApiOperations\NestedResource;
26	use ApiOperations\Update;
27	/**
28	* Adds a new item to an existing subscription. No existing items will be changed
29	* or replaced.
30	*
31	* @param null\|array $params
32	* @param null\|array\|string $options
33	*
34	* @throws \Stripe\Exception\ApiErrorException if the request fails
35	*
36	* @return \Stripe\SubscriptionItem the created resource
37	*/
38	public static function create($params = null, $options = null)
39	{
40	self::_validateParams($params);
41	$url = static::classUrl();
42	list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
43	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
44	$obj->setLastResponse($response);
45	return $obj;
46	}
47	/**
48	* Deletes an item from the subscription. Removing a subscription item from a
49	* subscription will not cancel the subscription.
50	*
51	* @param null\|array $params
52	* @param null\|array\|string $opts
53	*
54	* @throws \Stripe\Exception\ApiErrorException if the request fails
55	*
56	* @return \Stripe\SubscriptionItem the deleted resource
57	*/
58	public function delete($params = null, $opts = null)
59	{
60	self::_validateParams($params);
61	$url = $this->instanceUrl();
62	list($response, $opts) = $this->_request('delete', $url, $params, $opts);
63	$this->refreshFrom($response, $opts);
64	return $this;
65	}
66	/**
67	* Returns a list of your subscription items for a given subscription.
68	*
69	* @param null\|array $params
70	* @param null\|array\|string $opts
71	*
72	* @throws \Stripe\Exception\ApiErrorException if the request fails
73	*
74	* @return \Stripe\Collection<\Stripe\SubscriptionItem> of ApiResources
75	*/
76	public static function all($params = null, $opts = null)
77	{
78	$url = static::classUrl();
79	return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts);
80	}
81	/**
82	* Retrieves the subscription item with the given ID.
83	*
84	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
85	* @param null\|array\|string $opts
86	*
87	* @throws \Stripe\Exception\ApiErrorException if the request fails
88	*
89	* @return \Stripe\SubscriptionItem
90	*/
91	public static function retrieve($id, $opts = null)
92	{
93	$opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts);
94	$instance = new static($id, $opts);
95	$instance->refresh();
96	return $instance;
97	}
98	/**
99	* Updates the plan or quantity of an item on a current subscription.
100	*
101	* @param string $id the ID of the resource to update
102	* @param null\|array $params
103	* @param null\|array\|string $opts
104	*
105	* @throws \Stripe\Exception\ApiErrorException if the request fails
106	*
107	* @return \Stripe\SubscriptionItem the updated resource
108	*/
109	public static function update($id, $params = null, $opts = null)
110	{
111	self::_validateParams($params);
112	$url = static::resourceUrl($id);
113	list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
114	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
115	$obj->setLastResponse($response);
116	return $obj;
117	}
118	const PATH_USAGE_RECORDS = '/usage_records';
119	/**
120	* @param string $id the ID of the subscription item on which to create the usage record
121	* @param null\|array $params
122	* @param null\|array\|string $opts
123	*
124	* @throws \Stripe\Exception\ApiErrorException if the request fails
125	*
126	* @return \Stripe\UsageRecord
127	*/
128	public static function createUsageRecord($id, $params = null, $opts = null)
129	{
130	return self::_createNestedResource($id, static::PATH_USAGE_RECORDS, $params, $opts);
131	}
132	const PATH_USAGE_RECORD_SUMMARIES = '/usage_record_summaries';
133	/**
134	* @param string $id the ID of the subscription item on which to retrieve the usage record summaries
135	* @param null\|array $params
136	* @param null\|array\|string $opts
137	*
138	* @throws \Stripe\Exception\ApiErrorException if the request fails
139	*
140	* @return \Stripe\Collection<\Stripe\UsageRecordSummary> the list of usage record summaries
141	*/
142	public static function allUsageRecordSummaries($id, $params = null, $opts = null)
143	{
144	return self::_allNestedResources($id, static::PATH_USAGE_RECORD_SUMMARIES, $params, $opts);
145	}
146	}
147