View Source Stripe.ApplicationFee (stripity_stripe v3.2.0)

Summary

Types

created()
t()

The application_fee type.

Functions

list(params \\ %{}, opts \\ [])

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.

retrieve(id, params \\ %{}, opts \\ [])

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

Types

Link to this type

created()

View Source 
@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}
Link to this type

t()

View Source 
@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.

  • account ID of the Stripe account this fee was taken from.
  • amount Amount earned, in cents (or local equivalent).
  • 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)
  • application ID of the Connect application that earned the fee.
  • balance_transaction Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
  • charge ID of the charge that the application fee was taken from.
  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
  • id Unique identifier for the object.
  • livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • object String representing the object's type. Objects of the same type share the same value.
  • originating_transaction ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destination parameter.
  • refunded Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
  • refunds A list of refunds that have been applied to the fee.

Functions

Link to this function

list(params \\ %{}, opts \\ [])

View Source 
@spec list(
  params :: %{
    optional(:charge) => binary(),
    optional(:created) => created() | integer(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {: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
Link to this function

retrieve(id, params \\ %{}, opts \\ [])

View Source 
@spec retrieve(
  id :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {: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}