Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetExchangeRates

Contains the different functions to run the operation getExchangeRates

3 types
3 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetExchangeRates.hs

valuegetExchangeRates

:: MonadHTTP m
=> GetExchangeRatesParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetExchangeRatesResponse)
Monadic computation which returns the result of the operation

GET /v1/exchange_rates

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

datadata GetExchangeRatesParameters

Defines the object schema located at paths./v1/exchange_rates.GET.parameters in the specification.

Constructors

GetExchangeRatesParameters
- getExchangeRatesParametersQueryEndingBefore :: Maybe Text
  queryEnding_before: Represents the parameter named 'ending_before'
  A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  Constraints:
  - Maximum length of 5000
- getExchangeRatesParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getExchangeRatesParametersQueryLimit :: Maybe Int
  queryLimit: Represents the parameter named 'limit'
  A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.
- getExchangeRatesParametersQueryStartingAfter :: Maybe Text
  queryStarting_after: Represents the parameter named 'starting_after'
  A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetExchangeRatesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetExchangeRates
Show GetExchangeRatesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetExchangeRates
FromJSON GetExchangeRatesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetExchangeRates
ToJSON GetExchangeRatesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetExchangeRates

valuemkGetExchangeRatesParameters :: GetExchangeRatesParameters

Create a new GetExchangeRatesParameters with all required fields.

datadata GetExchangeRatesResponse

Represents a response of the operation getExchangeRates.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetExchangeRatesResponseError is used.

Constructors

GetExchangeRatesResponseError String
Means either no matching case available or a parse error
GetExchangeRatesResponse200 GetExchangeRatesResponseBody200
Successful response.
GetExchangeRatesResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetExchangeRatesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetExchangeRates
Show GetExchangeRatesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetExchangeRates

datadata GetExchangeRatesResponseBody200

Defines the object schema located at paths./v1/exchange_rates.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetExchangeRatesResponseBody200
- getExchangeRatesResponseBody200Data :: [ExchangeRate]
  data
- getExchangeRatesResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getExchangeRatesResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/exchange_rates'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetExchangeRatesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetExchangeRates
Show GetExchangeRatesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetExchangeRates
FromJSON GetExchangeRatesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetExchangeRates
ToJSON GetExchangeRatesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetExchangeRates

valuemkGetExchangeRatesResponseBody200

:: [ExchangeRate]
getExchangeRatesResponseBody200Data
-> Bool
getExchangeRatesResponseBody200HasMore
-> Text
getExchangeRatesResponseBody200Url
-> GetExchangeRatesResponseBody200

Create a new GetExchangeRatesResponseBody200 with all required fields.