View Source ExOAPI.Stripe.SDK.ApplicationFees (exoapi_stripe v0.1.4)

Link to this section Summary

Functions

description: <p>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.</p>

description: <p>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.</p>

description: <p>Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.</p>

description: <p>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 <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.</p>

description: <p>Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

description: <p>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.</p>

Link to this section Types

Link to this type

get_application_fees_fee_refunds_id_opts()

View Source
@type get_application_fees_fee_refunds_id_opts() :: {:expand, String.t()}
Link to this type

get_application_fees_id_opts()

View Source
@type get_application_fees_id_opts() :: {:expand, String.t()}
Link to this type

get_application_fees_id_refunds_opts()

View Source
@type get_application_fees_id_refunds_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
Link to this type

get_application_fees_opts()

View Source
@type get_application_fees_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
  | {:charge, String.t()}

Link to this section Functions

Link to this function

get_application_fees(client, opts \\ [])

View Source
@spec get_application_fees(client :: ExOAPI.Client.t(), [get_application_fees_opts()]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.ApplicationFee.t()]
     }
   | map()}
  | {:error, any()}

description: <p>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.</p>

Link to this function

get_application_fees_fee_refunds_id(client, id, fee, opts \\ [])

View Source
@spec get_application_fees_fee_refunds_id(
  client :: ExOAPI.Client.t(),
  id :: String.t(),
  fee :: String.t(),
  [get_application_fees_fee_refunds_id_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.FeeRefund.t() | map()}
  | {:error, any()}

description: <p>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.</p>

Link to this function

get_application_fees_id(client, id, opts \\ [])

View Source
@spec get_application_fees_id(
  client :: ExOAPI.Client.t(),
  id :: String.t(),
  [get_application_fees_id_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.ApplicationFee.t()
   | map()}
  | {:error, any()}

description: <p>Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.</p>

Link to this function

get_application_fees_id_refunds(client, id, opts \\ [])

View Source
@spec get_application_fees_id_refunds(
  client :: ExOAPI.Client.t(),
  id :: String.t(),
  [get_application_fees_id_refunds_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.FeeRefund.t()]
     }
   | map()}
  | {:error, any()}

description: <p>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 <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.</p>

Link to this function

post_application_fees_fee_refunds_id(client, body, id, fee)

View Source
@spec post_application_fees_fee_refunds_id(
  client :: ExOAPI.Client.t(),
  body :: %{metadata: String.t() | map(), expand: [String.t()]} | map(),
  id :: String.t(),
  fee :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.FeeRefund.t() | map()}
  | {:error, any()}

description: <p>Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

This request only accepts metadata as an argument.

Link to this function

post_application_fees_id_refund(client, body, id)

View Source
@spec post_application_fees_id_refund(
  client :: ExOAPI.Client.t(),
  body ::
    %{expand: [String.t()], directive: String.t(), amount: integer()} | map(),
  id :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.ApplicationFee.t()
   | map()}
  | {:error, any()}
Link to this function

post_application_fees_id_refunds(client, body, id)

View Source
@spec post_application_fees_id_refunds(
  client :: ExOAPI.Client.t(),
  body :: %{metadata: map(), expand: [String.t()], amount: integer()} | map(),
  id :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.FeeRefund.t() | map()}
  | {:error, any()}

description: <p>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.</p>

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.