give / vendor / stripe / stripe-php / lib / Service / SubscriptionService.php

SubscriptionService.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.5, at vendor/stripe/stripe-php/lib/Service/SubscriptionService.php

156 lines 6.0 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class SubscriptionService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* By default, returns a list of subscriptions that have not been canceled. In
11	* order to list canceled subscriptions, specify <code>status=canceled</code>.
12	*
13	* @param null\|array $params
14	* @param null\|array\|\Stripe\Util\RequestOptions $opts
15	*
16	* @throws \Stripe\Exception\ApiErrorException if the request fails
17	*
18	* @return \Stripe\Collection<\Stripe\Subscription>
19	*/
20	public function all($params = null, $opts = null)
21	{
22	return $this->requestCollection('get', '/v1/subscriptions', $params, $opts);
23	}
24
25	/**
26	* Cancels a customer’s subscription immediately. The customer will not be charged
27	* again for the subscription.
28	*
29	* Note, however, that any pending invoice items that you’ve created will still be
30	* charged for at the end of the period, unless manually <a
31	* href="#delete_invoiceitem">deleted</a>. If you’ve set the subscription to cancel
32	* at the end of the period, any pending prorations will also be left in place and
33	* collected at the end of the period. But if the subscription is set to cancel
34	* immediately, pending prorations will be removed.
35	*
36	* By default, upon subscription cancellation, Stripe will stop automatic
37	* collection of all finalized invoices for the customer. This is intended to
38	* prevent unexpected payment attempts after the customer has canceled a
39	* subscription. However, you can resume automatic collection of the invoices
40	* manually after subscription cancellation to have us proceed. Or, you could check
41	* for unpaid invoices before allowing the customer to cancel the subscription at
42	* all.
43	*
44	* @param string $id
45	* @param null\|array $params
46	* @param null\|array\|\Stripe\Util\RequestOptions $opts
47	*
48	* @throws \Stripe\Exception\ApiErrorException if the request fails
49	*
50	* @return \Stripe\Subscription
51	*/
52	public function cancel($id, $params = null, $opts = null)
53	{
54	return $this->request('delete', $this->buildPath('/v1/subscriptions/%s', $id), $params, $opts);
55	}
56
57	/**
58	* Creates a new subscription on an existing customer. Each customer can have up to
59	* 500 active or scheduled subscriptions.
60	*
61	* When you create a subscription with
62	* <code>collection_method=charge_automatically</code>, the first invoice is
63	* finalized as part of the request. The <code>payment_behavior</code> parameter
64	* determines the exact behavior of the initial payment.
65	*
66	* To start subscriptions where the first invoice always begins in a
67	* <code>draft</code> status, use <a
68	* href="/docs/billing/subscriptions/subscription-schedules#managing">subscription
69	* schedules</a> instead. Schedules provide the flexibility to model more complex
70	* billing configurations that change over time.
71	*
72	* @param null\|array $params
73	* @param null\|array\|\Stripe\Util\RequestOptions $opts
74	*
75	* @throws \Stripe\Exception\ApiErrorException if the request fails
76	*
77	* @return \Stripe\Subscription
78	*/
79	public function create($params = null, $opts = null)
80	{
81	return $this->request('post', '/v1/subscriptions', $params, $opts);
82	}
83
84	/**
85	* Removes the currently applied discount on a subscription.
86	*
87	* @param string $id
88	* @param null\|array $params
89	* @param null\|array\|\Stripe\Util\RequestOptions $opts
90	*
91	* @throws \Stripe\Exception\ApiErrorException if the request fails
92	*
93	* @return \Stripe\Subscription
94	*/
95	public function deleteDiscount($id, $params = null, $opts = null)
96	{
97	return $this->request('delete', $this->buildPath('/v1/subscriptions/%s/discount', $id), $params, $opts);
98	}
99
100	/**
101	* Retrieves the subscription with the given ID.
102	*
103	* @param string $id
104	* @param null\|array $params
105	* @param null\|array\|\Stripe\Util\RequestOptions $opts
106	*
107	* @throws \Stripe\Exception\ApiErrorException if the request fails
108	*
109	* @return \Stripe\Subscription
110	*/
111	public function retrieve($id, $params = null, $opts = null)
112	{
113	return $this->request('get', $this->buildPath('/v1/subscriptions/%s', $id), $params, $opts);
114	}
115
116	/**
117	* Search for subscriptions you’ve previously created using Stripe’s <a
118	* href="/docs/search#search-query-language">Search Query Language</a>. Don’t use
119	* search in read-after-write flows where strict consistency is necessary. Under
120	* normal operating conditions, data is searchable in less than a minute.
121	* Occasionally, propagation of new or updated data can be up to an hour behind
122	* during outages. Search functionality is not available to merchants in India.
123	*
124	* @param null\|array $params
125	* @param null\|array\|\Stripe\Util\RequestOptions $opts
126	*
127	* @throws \Stripe\Exception\ApiErrorException if the request fails
128	*
129	* @return \Stripe\SearchResult<\Stripe\Subscription>
130	*/
131	public function search($params = null, $opts = null)
132	{
133	return $this->requestSearchResult('get', '/v1/subscriptions/search', $params, $opts);
134	}
135
136	/**
137	* Updates an existing subscription on a customer to match the specified
138	* parameters. When changing plans or quantities, we will optionally prorate the
139	* price we charge next month to make up for any price changes. To preview how the
140	* proration will be calculated, use the <a href="#upcoming_invoice">upcoming
141	* invoice</a> endpoint.
142	*
143	* @param string $id
144	* @param null\|array $params
145	* @param null\|array\|\Stripe\Util\RequestOptions $opts
146	*
147	* @throws \Stripe\Exception\ApiErrorException if the request fails
148	*
149	* @return \Stripe\Subscription
150	*/
151	public function update($id, $params = null, $opts = null)
152	{
153	return $this->request('post', $this->buildPath('/v1/subscriptions/%s', $id), $params, $opts);
154	}
155	}
156