Stripe.ApplicationFee (stripity_stripe_fb v2.13.1) View Source

Work with Stripe Connect application fees.

Stripe API reference: https://stripe.com/docs/api#application_fees

Link to this section Summary

Types

t()

Functions

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

List all application fees

retrieve(id, opts \\ [])

Retrieves the details of the application fees

Link to this section Types

t()

Specs

t() :: %Stripe.ApplicationFee{
  account: Stripe.id() | Stripe.Account.t(),
  amount: integer(),
  amount_refunded: integer(),
  application: Stripe.id(),
  balance_transaction: Stripe.id() | Stripe.BalanceTransaction.t(),
  charge: Stripe.id() | Stripe.Charge.t(),
  created: Stripe.timestamp(),
  currency: String.t(),
  id: Stripe.id(),
  livemode: boolean(),
  object: String.t(),
  originating_transaction: Stripe.id() | Stripe.Charge.t(),
  refunded: boolean(),
  refunds: Stripe.List.t(Stripe.FeeRefund.t())
}

Link to this section Functions

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

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:charge) => Stripe.id(),
         optional(:created) => Stripe.date_query(),
         optional(:ending_before) => t() | Stripe.id(),
         optional(:limit) => 1..100,
         optional(:starting_after) => t() | Stripe.id()
       }
       | %{}

List all application fees

retrieve(id, opts \\ [])

Specs

retrieve(Stripe.id(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieves the details of the application fees