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

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

ApplicationFee.php

117 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* @property string $id Unique identifier for the object.
8	* @property string $object String representing the object's type. Objects of the same type share the same value.
9	* @property string\|\Stripe\Account $account ID of the Stripe account this fee was taken from.
10	* @property int $amount Amount earned, in cents (or local equivalent).
11	* @property int $amount_refunded Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)
12	* @property string\|\Stripe\Application $application ID of the Connect application that earned the fee.
13	* @property null\|string\|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
14	* @property string\|\Stripe\Charge $charge ID of the charge that the application fee was taken from.
15	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
16	* @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>.
17	* @property null\|\Stripe\StripeObject $fee_source Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.
18	* @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.
19	* @property null\|string\|\Stripe\Charge $originating_transaction ID of the corresponding charge on the platform account, if this fee was the result of a charge using the <code>destination</code> parameter.
20	* @property bool $refunded Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
21	* @property \Stripe\Collection<\Stripe\ApplicationFeeRefund> $refunds A list of refunds that have been applied to the fee.
22	*/
23	class ApplicationFee extends ApiResource
24	{
25	const OBJECT_NAME = 'application_fee';
26	use ApiOperations\NestedResource;
27	/**
28	* Returns a list of application fees you’ve previously collected. The application
29	* fees are returned in sorted order, with the most recent fees appearing first.
30	*
31	* @param null\|array $params
32	* @param null\|array\|string $opts
33	*
34	* @throws \Stripe\Exception\ApiErrorException if the request fails
35	*
36	* @return \Stripe\Collection<\Stripe\ApplicationFee> of ApiResources
37	*/
38	public static function all($params = null, $opts = null)
39	{
40	$url = static::classUrl();
41	return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts);
42	}
43	/**
44	* Retrieves the details of an application fee that your account has collected. The
45	* same information is returned when refunding the application fee.
46	*
47	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
48	* @param null\|array\|string $opts
49	*
50	* @throws \Stripe\Exception\ApiErrorException if the request fails
51	*
52	* @return \Stripe\ApplicationFee
53	*/
54	public static function retrieve($id, $opts = null)
55	{
56	$opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts);
57	$instance = new static($id, $opts);
58	$instance->refresh();
59	return $instance;
60	}
61	const PATH_REFUNDS = '/refunds';
62	/**
63	* @param string $id the ID of the application fee on which to retrieve the application fee refunds
64	* @param null\|array $params
65	* @param null\|array\|string $opts
66	*
67	* @throws \Stripe\Exception\ApiErrorException if the request fails
68	*
69	* @return \Stripe\Collection<\Stripe\ApplicationFeeRefund> the list of application fee refunds
70	*/
71	public static function allRefunds($id, $params = null, $opts = null)
72	{
73	return self::_allNestedResources($id, static::PATH_REFUNDS, $params, $opts);
74	}
75	/**
76	* @param string $id the ID of the application fee on which to create the application fee refund
77	* @param null\|array $params
78	* @param null\|array\|string $opts
79	*
80	* @throws \Stripe\Exception\ApiErrorException if the request fails
81	*
82	* @return \Stripe\ApplicationFeeRefund
83	*/
84	public static function createRefund($id, $params = null, $opts = null)
85	{
86	return self::_createNestedResource($id, static::PATH_REFUNDS, $params, $opts);
87	}
88	/**
89	* @param string $id the ID of the application fee to which the application fee refund belongs
90	* @param string $refundId the ID of the application fee refund to retrieve
91	* @param null\|array $params
92	* @param null\|array\|string $opts
93	*
94	* @throws \Stripe\Exception\ApiErrorException if the request fails
95	*
96	* @return \Stripe\ApplicationFeeRefund
97	*/
98	public static function retrieveRefund($id, $refundId, $params = null, $opts = null)
99	{
100	return self::_retrieveNestedResource($id, static::PATH_REFUNDS, $refundId, $params, $opts);
101	}
102	/**
103	* @param string $id the ID of the application fee to which the application fee refund belongs
104	* @param string $refundId the ID of the application fee refund to update
105	* @param null\|array $params
106	* @param null\|array\|string $opts
107	*
108	* @throws \Stripe\Exception\ApiErrorException if the request fails
109	*
110	* @return \Stripe\ApplicationFeeRefund
111	*/
112	public static function updateRefund($id, $refundId, $params = null, $opts = null)
113	{
114	return self::_updateNestedResource($id, static::PATH_REFUNDS, $refundId, $params, $opts);
115	}
116	}
117