View Source Stripe.ApplicationFee (Striped v0.1.0)
Link to this section Summary
Functions
Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.
Link to this section Types
@type t() :: %Stripe.ApplicationFee{ account: binary() | Stripe.Account.t(), amount: integer(), amount_refunded: integer(), application: binary() | term(), balance_transaction: (binary() | Stripe.BalanceTransaction.t()) | nil, charge: binary() | Stripe.Charge.t(), created: integer(), currency: binary(), id: binary(), livemode: boolean(), object: binary(), originating_transaction: (binary() | Stripe.Charge.t()) | nil, refunded: boolean(), refunds: term() }
The application_fee type.
accountID of the Stripe account this fee was taken from.amountAmount earned, in %s.amount_refundedAmount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued)applicationID of the Connect application that earned the fee.balance_transactionBalance transaction that describes the impact of this collected application fee on your account balance (not including refunds).chargeID of the charge that the application fee was taken from.createdTime at which the object was created. Measured in seconds since the Unix epoch.currencyThree-letter ISO currency code, in lowercase. Must be a supported currency.idUnique identifier for the object.livemodeHas the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.objectString representing the object's type. Objects of the same type share the same value.originating_transactionID of the corresponding charge on the platform account, if this fee was the result of a charge using thedestinationparameter.refundedWhether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.refundsA list of refunds that have been applied to the fee.
Link to this section Functions
@spec list(client :: term(), params :: map()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
Details
- Method:
get - Path:
/v1/application_fees
Query parameters
:chargestring:createdany of:- object with (optional) properties:
gt: integergte: integerlt: integerlte: integer
- integer
- object with (optional) properties:
:ending_beforestring:expandarray of: string:limitinteger:starting_afterstring
@spec retrieve(client :: term(), id :: binary(), params :: map()) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.
Details
- Method:
get - Path:
/v1/application_fees/{id}
Query parameters
:expandarray of: string