View Source Stripe.FeeRefund (stripity_stripe v3.2.0)

Application Fee Refund objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

Related guide: Refunding application fees

Summary

Types

t()

The fee_refund type.

Functions

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

Refunds an application fee that has previously been collected but not yet refunded.Funds will be refunded to the Stripe account from which the fee was originally collected.

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

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

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

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

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

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Types

t()

@type t() :: %Stripe.FeeRefund{
  amount: integer(),
  balance_transaction: (binary() | Stripe.BalanceTransaction.t()) | nil,
  created: integer(),
  currency: binary(),
  fee: binary() | Stripe.ApplicationFee.t(),
  id: binary(),
  metadata: term() | nil,
  object: binary()
}

The fee_refund type.

amount Amount, in cents (or local equivalent).
balance_transaction Balance transaction that describes the impact on your account balance.
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.
fee ID of the application fee that was refunded.
id Unique identifier for the object.
metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
object String representing the object's type. Objects of the same type share the same value.

Functions

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

@spec create(
  id :: binary(),
  params :: %{
    optional(:amount) => integer(),
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()}
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Refunds an application fee that has previously been collected but not yet refunded.Funds will be refunded to the Stripe account from which the fee was originally collected.

You can optionally refund only part of an application fee.You can do so multiple times, until the entire fee has been refunded.

Once entirely refunded, an application fee can’t be refunded again.This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.

#### Details * Method: `post` * Path: `/v1/application_fees/{id}/refunds`

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

@spec list(
  id :: binary(),
  params :: %{
    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()}

Details

Method: get
Path: /v1/application_fees/{id}/refunds

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

@spec retrieve(
  fee :: binary(),
  id :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

Details

Method: get
Path: /v1/application_fees/{fee}/refunds/{id}

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

@spec update(
  fee :: binary(),
  id :: binary(),
  params :: %{
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()} | binary()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata as an argument.

Details

Method: post
Path: /v1/application_fees/{fee}/refunds/{id}