stripity_stripe v2.7.0 Stripe.FeeRefund View Source
Work with Stripe Connect application fees refund.
Stripe API reference: https://stripe.com/docs/api#fee_refunds
Link to this section Summary
Functions
Create a application fee refund
List all transfers.
Retrieve a application fee refund.
Update a transfer.
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %Stripe.FeeRefund{
amount: integer(),
balance_transaction: Stripe.id() | Stripe.BalanceTransaction.t(),
created: Stripe.timestamp(),
currency: String.t(),
fee: String.t(),
id: Stripe.id(),
metadata: Stripe.Types.metadata(),
object: String.t()
}
t() :: %Stripe.FeeRefund{ amount: integer(), balance_transaction: Stripe.id() | Stripe.BalanceTransaction.t(), created: Stripe.timestamp(), currency: String.t(), fee: String.t(), id: Stripe.id(), metadata: Stripe.Types.metadata(), object: String.t() }
Link to this section Functions
Link to this function
create(id, params, opts \\ [])
View Source
create(id, params, opts \\ [])
View Source
create(Stripe.id() | t(), params, Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
optional(:amount) => pos_integer(),
optional(:metadata) => Stripe.Types.metadata()
}
create(Stripe.id() | t(), params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ optional(:amount) => pos_integer(), optional(:metadata) => Stripe.Types.metadata() }
Create a application fee refund
Link to this function
list(id, params \\ %{}, opts \\ [])
View Source
list(id, params \\ %{}, opts \\ [])
View Source
list(Stripe.id() | t(), params, Stripe.options()) ::
{:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
optional(:ending_before) => t() | Stripe.id(),
optional(:limit) => 1..100,
optional(:starting_after) => t() | Stripe.id()
}
list(Stripe.id() | t(), params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:ending_before) => t() | Stripe.id(), optional(:limit) => 1..100, optional(:starting_after) => t() | Stripe.id() }
List all transfers.
Link to this function
retrieve(id, fee_id, opts \\ [])
View Source
retrieve(id, fee_id, opts \\ [])
View Source
retrieve(Stripe.id() | t(), Stripe.id() | t(), Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
retrieve(Stripe.id() | t(), Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve a application fee refund.
Link to this function
update(id, fee_id, params, opts \\ [])
View Source
update(id, fee_id, params, opts \\ [])
View Source
update(Stripe.id() | t(), Stripe.id() | t(), params, Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
when params: %{optional(:metadata) => Stripe.Types.metadata()}
update(Stripe.id() | t(), Stripe.id() | t(), params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{optional(:metadata) => Stripe.Types.metadata()}
Update a transfer.
Takes the id
and a map of changes.