ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
ApplicationFee.php
91 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe; |
| 6 | |
| 7 | /** |
| 8 | * @property string $id Unique identifier for the object. |
| 9 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 10 | * @property string|\Stripe\Account $account ID of the Stripe account this fee was taken from. |
| 11 | * @property int $amount Amount earned, in %s. |
| 12 | * @property int $amount_refunded Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) |
| 13 | * @property string|\Stripe\StripeObject $application ID of the Connect application that earned the fee. |
| 14 | * @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). |
| 15 | * @property string|\Stripe\Charge $charge ID of the charge that the application fee was taken from. |
| 16 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 17 | * @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>. |
| 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\StripeObject> $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 | |
| 27 | use ApiOperations\All; |
| 28 | use ApiOperations\NestedResource; |
| 29 | use ApiOperations\Retrieve; |
| 30 | |
| 31 | const PATH_REFUNDS = '/refunds'; |
| 32 | |
| 33 | /** |
| 34 | * @param string $id the ID of the application fee on which to retrieve the fee refunds |
| 35 | * @param null|array $params |
| 36 | * @param null|array|string $opts |
| 37 | * |
| 38 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 39 | * |
| 40 | * @return \Stripe\Collection<\Stripe\ApplicationFeeRefund> the list of fee refunds |
| 41 | */ |
| 42 | public static function allRefunds($id, $params = null, $opts = null) |
| 43 | { |
| 44 | return self::_allNestedResources($id, static::PATH_REFUNDS, $params, $opts); |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * @param string $id the ID of the application fee on which to create the fee refund |
| 49 | * @param null|array $params |
| 50 | * @param null|array|string $opts |
| 51 | * |
| 52 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 53 | * |
| 54 | * @return \Stripe\ApplicationFeeRefund |
| 55 | */ |
| 56 | public static function createRefund($id, $params = null, $opts = null) |
| 57 | { |
| 58 | return self::_createNestedResource($id, static::PATH_REFUNDS, $params, $opts); |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * @param string $id the ID of the application fee to which the fee refund belongs |
| 63 | * @param string $refundId the ID of the fee refund to retrieve |
| 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\ApplicationFeeRefund |
| 70 | */ |
| 71 | public static function retrieveRefund($id, $refundId, $params = null, $opts = null) |
| 72 | { |
| 73 | return self::_retrieveNestedResource($id, static::PATH_REFUNDS, $refundId, $params, $opts); |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * @param string $id the ID of the application fee to which the fee refund belongs |
| 78 | * @param string $refundId the ID of the fee refund to update |
| 79 | * @param null|array $params |
| 80 | * @param null|array|string $opts |
| 81 | * |
| 82 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 83 | * |
| 84 | * @return \Stripe\ApplicationFeeRefund |
| 85 | */ |
| 86 | public static function updateRefund($id, $refundId, $params = null, $opts = null) |
| 87 | { |
| 88 | return self::_updateNestedResource($id, static::PATH_REFUNDS, $refundId, $params, $opts); |
| 89 | } |
| 90 | } |
| 91 |