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

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

SubscriptionSchedule.php

148 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
8	*
9	* Related guide: <a href="https://stripe.com/docs/billing/subscriptions/subscription-schedules">Subscription schedules</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\|string\|\Stripe\Application $application ID of the Connect Application that created the schedule.
14	* @property null\|int $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
15	* @property null\|int $completed_at Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
16	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
17	* @property null\|\Stripe\StripeObject $current_phase Object representing the start and end dates for the current phase of the subscription schedule, if it is <code>active</code>.
18	* @property string\|\Stripe\Customer $customer ID of the customer who owns the subscription schedule.
19	* @property \Stripe\StripeObject $default_settings
20	* @property string $end_behavior Behavior of the subscription schedule and underlying subscription when it ends. Possible values are <code>release</code> or <code>cancel</code> with the default being <code>release</code>. <code>release</code> will end the subscription schedule and keep the underlying subscription running. <code>cancel</code> will end the subscription schedule and cancel the underlying subscription.
21	* @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.
22	* @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.
23	* @property \Stripe\StripeObject[] $phases Configuration for the subscription schedule's phases.
24	* @property null\|int $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
25	* @property null\|string $released_subscription ID of the subscription once managed by the subscription schedule (if it is released).
26	* @property string $status The present status of the subscription schedule. Possible values are <code>not_started</code>, <code>active</code>, <code>completed</code>, <code>released</code>, and <code>canceled</code>. You can read more about the different states in our <a href="https://stripe.com/docs/billing/subscriptions/subscription-schedules">behavior guide</a>.
27	* @property null\|string\|\Stripe\Subscription $subscription ID of the subscription managed by the subscription schedule.
28	* @property null\|string\|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this subscription schedule belongs to.
29	*/
30	class SubscriptionSchedule extends ApiResource
31	{
32	const OBJECT_NAME = 'subscription_schedule';
33	use ApiOperations\Update;
34	const END_BEHAVIOR_CANCEL = 'cancel';
35	const END_BEHAVIOR_NONE = 'none';
36	const END_BEHAVIOR_RELEASE = 'release';
37	const END_BEHAVIOR_RENEW = 'renew';
38	const STATUS_ACTIVE = 'active';
39	const STATUS_CANCELED = 'canceled';
40	const STATUS_COMPLETED = 'completed';
41	const STATUS_NOT_STARTED = 'not_started';
42	const STATUS_RELEASED = 'released';
43	/**
44	* Creates a new subscription schedule object. Each customer can have up to 500
45	* active or scheduled subscriptions.
46	*
47	* @param null\|array $params
48	* @param null\|array\|string $options
49	*
50	* @throws \Stripe\Exception\ApiErrorException if the request fails
51	*
52	* @return \Stripe\SubscriptionSchedule the created resource
53	*/
54	public static function create($params = null, $options = null)
55	{
56	self::_validateParams($params);
57	$url = static::classUrl();
58	list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
59	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
60	$obj->setLastResponse($response);
61	return $obj;
62	}
63	/**
64	* Retrieves the list of your subscription schedules.
65	*
66	* @param null\|array $params
67	* @param null\|array\|string $opts
68	*
69	* @throws \Stripe\Exception\ApiErrorException if the request fails
70	*
71	* @return \Stripe\Collection<\Stripe\SubscriptionSchedule> of ApiResources
72	*/
73	public static function all($params = null, $opts = null)
74	{
75	$url = static::classUrl();
76	return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts);
77	}
78	/**
79	* Retrieves the details of an existing subscription schedule. You only need to
80	* supply the unique subscription schedule identifier that was returned upon
81	* subscription schedule creation.
82	*
83	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
84	* @param null\|array\|string $opts
85	*
86	* @throws \Stripe\Exception\ApiErrorException if the request fails
87	*
88	* @return \Stripe\SubscriptionSchedule
89	*/
90	public static function retrieve($id, $opts = null)
91	{
92	$opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts);
93	$instance = new static($id, $opts);
94	$instance->refresh();
95	return $instance;
96	}
97	/**
98	* Updates an existing subscription schedule.
99	*
100	* @param string $id the ID of the resource to update
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\SubscriptionSchedule the updated resource
107	*/
108	public static function update($id, $params = null, $opts = null)
109	{
110	self::_validateParams($params);
111	$url = static::resourceUrl($id);
112	list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
113	$obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
114	$obj->setLastResponse($response);
115	return $obj;
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\SubscriptionSchedule the canceled subscription schedule
124	*/
125	public function cancel($params = null, $opts = null)
126	{
127	$url = $this->instanceUrl() . '/cancel';
128	list($response, $opts) = $this->_request('post', $url, $params, $opts);
129	$this->refreshFrom($response, $opts);
130	return $this;
131	}
132	/**
133	* @param null\|array $params
134	* @param null\|array\|string $opts
135	*
136	* @throws \Stripe\Exception\ApiErrorException if the request fails
137	*
138	* @return \Stripe\SubscriptionSchedule the released subscription schedule
139	*/
140	public function release($params = null, $opts = null)
141	{
142	$url = $this->instanceUrl() . '/release';
143	list($response, $opts) = $this->_request('post', $url, $params, $opts);
144	$this->refreshFrom($response, $opts);
145	return $this;
146	}
147	}
148