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

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

126 lines 4.7 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class ApplicationFeeService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of application fees you’ve previously collected. The application
11	* fees are returned in sorted order, with the most recent fees appearing first.
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\ApplicationFee>
19	*/
20	public function all($params = null, $opts = null)
21	{
22	return $this->requestCollection('get', '/v1/application_fees', $params, $opts);
23	}
24
25	/**
26	* You can see a list of the refunds belonging to a specific application fee. Note
27	* that the 10 most recent refunds are always available by default on the
28	* application fee object. If you need more than those 10, you can use this API
29	* method and the <code>limit</code> and <code>starting_after</code> parameters to
30	* page through additional refunds.
31	*
32	* @param string $parentId
33	* @param null\|array $params
34	* @param null\|array\|\Stripe\Util\RequestOptions $opts
35	*
36	* @throws \Stripe\Exception\ApiErrorException if the request fails
37	*
38	* @return \Stripe\Collection<\Stripe\ApplicationFeeRefund>
39	*/
40	public function allRefunds($parentId, $params = null, $opts = null)
41	{
42	return $this->requestCollection('get', $this->buildPath('/v1/application_fees/%s/refunds', $parentId), $params, $opts);
43	}
44
45	/**
46	* Refunds an application fee that has previously been collected but not yet
47	* refunded. Funds will be refunded to the Stripe account from which the fee was
48	* originally collected.
49	*
50	* You can optionally refund only part of an application fee. You can do so
51	* multiple times, until the entire fee has been refunded.
52	*
53	* Once entirely refunded, an application fee can’t be refunded again. This method
54	* will raise an error when called on an already-refunded application fee, or when
55	* trying to refund more money than is left on an application fee.
56	*
57	* @param string $parentId
58	* @param null\|array $params
59	* @param null\|array\|\Stripe\Util\RequestOptions $opts
60	*
61	* @throws \Stripe\Exception\ApiErrorException if the request fails
62	*
63	* @return \Stripe\ApplicationFeeRefund
64	*/
65	public function createRefund($parentId, $params = null, $opts = null)
66	{
67	return $this->request('post', $this->buildPath('/v1/application_fees/%s/refunds', $parentId), $params, $opts);
68	}
69
70	/**
71	* Retrieves the details of an application fee that your account has collected. The
72	* same information is returned when refunding the application fee.
73	*
74	* @param string $id
75	* @param null\|array $params
76	* @param null\|array\|\Stripe\Util\RequestOptions $opts
77	*
78	* @throws \Stripe\Exception\ApiErrorException if the request fails
79	*
80	* @return \Stripe\ApplicationFee
81	*/
82	public function retrieve($id, $params = null, $opts = null)
83	{
84	return $this->request('get', $this->buildPath('/v1/application_fees/%s', $id), $params, $opts);
85	}
86
87	/**
88	* By default, you can see the 10 most recent refunds stored directly on the
89	* application fee object, but you can also retrieve details about a specific
90	* refund stored on the application fee.
91	*
92	* @param string $parentId
93	* @param string $id
94	* @param null\|array $params
95	* @param null\|array\|\Stripe\Util\RequestOptions $opts
96	*
97	* @throws \Stripe\Exception\ApiErrorException if the request fails
98	*
99	* @return \Stripe\ApplicationFeeRefund
100	*/
101	public function retrieveRefund($parentId, $id, $params = null, $opts = null)
102	{
103	return $this->request('get', $this->buildPath('/v1/application_fees/%s/refunds/%s', $parentId, $id), $params, $opts);
104	}
105
106	/**
107	* Updates the specified application fee refund by setting the values of the
108	* parameters passed. Any parameters not provided will be left unchanged.
109	*
110	* This request only accepts metadata as an argument.
111	*
112	* @param string $parentId
113	* @param string $id
114	* @param null\|array $params
115	* @param null\|array\|\Stripe\Util\RequestOptions $opts
116	*
117	* @throws \Stripe\Exception\ApiErrorException if the request fails
118	*
119	* @return \Stripe\ApplicationFeeRefund
120	*/
121	public function updateRefund($parentId, $id, $params = null, $opts = null)
122	{
123	return $this->request('post', $this->buildPath('/v1/application_fees/%s/refunds/%s', $parentId, $id), $params, $opts);
124	}
125	}
126