exoapi_stripe v0.1.4

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

Link to this section Summary

Types

get_exchange_rates_opts()
get_exchange_rates_rate_id_opts()

Functions

get_exchange_rates(client, opts \\ [])

description: <p>Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.</p>

get_exchange_rates_rate_id(client, rate_id, opts \\ [])

description: <p>Retrieves the exchange rates from the given currency to every supported currency.</p>

Link to this section Types

Link to this type

get_exchange_rates_opts()

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

get_exchange_rates_rate_id_opts()

View Source 
@type get_exchange_rates_rate_id_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

get_exchange_rates(client, opts \\ [])

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

description: <p>Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.</p>

Link to this function

get_exchange_rates_rate_id(client, rate_id, opts \\ [])

View Source 
@spec get_exchange_rates_rate_id(
  client :: ExOAPI.Client.t(),
  rate_id :: String.t(),
  [get_exchange_rates_rate_id_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.ExchangeRate.t()
   | map()}
  | {:error, any()}

description: <p>Retrieves the exchange rates from the given currency to every supported currency.</p>