StripeAPI.Types.ExchangeRate

Contains the types generated from the schema ExchangeRate

Documentation

data ExchangeRate

Defines the object schema located at components.schemas.exchange_rate in the specification.

`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.

Constructors

ExchangeRate

Fields

• exchangeRateId :: Text

  id: Unique identifier for the object. Represented as the three-letter ISO currency code in lowercase.

  Constraints:

  • Maximum length of 5000
• exchangeRateRates :: Object

  rates: Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.

Instances

Eq ExchangeRate

Defined in StripeAPI.Types.ExchangeRate

Methods

(==) :: ExchangeRate -> ExchangeRate -> Bool

(/=) :: ExchangeRate -> ExchangeRate -> Bool

Show ExchangeRate

Defined in StripeAPI.Types.ExchangeRate

Methods

showsPrec :: Int -> ExchangeRate -> ShowS

show :: ExchangeRate -> String

showList :: [ExchangeRate] -> ShowS

ToJSON ExchangeRate

Defined in StripeAPI.Types.ExchangeRate

Methods

toJSON :: ExchangeRate -> Value

toEncoding :: ExchangeRate -> Encoding

toJSONList :: [ExchangeRate] -> Value

toEncodingList :: [ExchangeRate] -> Encoding

FromJSON ExchangeRate

Defined in StripeAPI.Types.ExchangeRate

Methods

parseJSON :: Value -> Parser ExchangeRate

parseJSONList :: Value -> Parser [ExchangeRate]

mkExchangeRate

Arguments

:: Text

exchangeRateId

-> Object

exchangeRateRates

-> ExchangeRate

Create a new ExchangeRate with all required fields.