View Source Stripe.ExchangeRate (Striped v0.5.0) (generated)
Exchange Rate objects allow you to determine the rates that Stripe is
currently using to convert from one currency to another. Since this number is
variable throughout the day, there are various reasons why you might want to
know the current rate (for example, to dynamically price an item for a user
with a default payment in a foreign currency).
If you want a guarantee that the charge is made with a certain exchange rate
you expect is current, you can pass in exchange_rate to charges endpoints.
If the value is no longer up to date, the charge won't go through. Please
refer to our Exchange Rates API guide for more
details.
Link to this section Summary
Functions
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.
Retrieves the exchange rates from the given currency to every supported currency.
Link to this section Types
The exchange_rate type.
idUnique identifier for the object. Represented as the three-letter ISO currency code in lowercase.objectString representing the object's type. Objects of the same type share the same value.ratesHash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
Link to this section Functions
@spec list( client :: Stripe.t(), 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()}
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.
Details
- Method:
get - Path:
/v1/exchange_rates
@spec retrieve( client :: Stripe.t(), rate_id :: binary(), params :: %{optional(:expand) => [binary()]}, opts :: Keyword.t() ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Retrieves the exchange rates from the given currency to every supported currency.
Details
- Method:
get - Path:
/v1/exchange_rates/{rate_id}