Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation getPrices
Synopsis
- getPrices :: forall m. MonadHTTP m => GetPricesParameters -> ClientT m (Response GetPricesResponse)
- data GetPricesParameters = GetPricesParameters {
- getPricesParametersQueryActive :: Maybe Bool
- getPricesParametersQueryCreated :: Maybe GetPricesParametersQueryCreated'Variants
- getPricesParametersQueryCurrency :: Maybe Text
- getPricesParametersQueryEndingBefore :: Maybe Text
- getPricesParametersQueryExpand :: Maybe [Text]
- getPricesParametersQueryLimit :: Maybe Int
- getPricesParametersQueryLookupKeys :: Maybe [Text]
- getPricesParametersQueryProduct :: Maybe Text
- getPricesParametersQueryRecurring :: Maybe GetPricesParametersQueryRecurring'
- getPricesParametersQueryStartingAfter :: Maybe Text
- getPricesParametersQueryType :: Maybe GetPricesParametersQueryType'
- mkGetPricesParameters :: GetPricesParameters
- data GetPricesParametersQueryCreated'OneOf1 = GetPricesParametersQueryCreated'OneOf1 {}
- mkGetPricesParametersQueryCreated'OneOf1 :: GetPricesParametersQueryCreated'OneOf1
- data GetPricesParametersQueryCreated'Variants
- data GetPricesParametersQueryRecurring' = GetPricesParametersQueryRecurring' {}
- mkGetPricesParametersQueryRecurring' :: GetPricesParametersQueryRecurring'
- data GetPricesParametersQueryRecurring'Interval'
- = GetPricesParametersQueryRecurring'Interval'Other Value
- | GetPricesParametersQueryRecurring'Interval'Typed Text
- | GetPricesParametersQueryRecurring'Interval'EnumDay
- | GetPricesParametersQueryRecurring'Interval'EnumMonth
- | GetPricesParametersQueryRecurring'Interval'EnumWeek
- | GetPricesParametersQueryRecurring'Interval'EnumYear
- data GetPricesParametersQueryRecurring'UsageType'
- data GetPricesParametersQueryType'
- data GetPricesResponse
- data GetPricesResponseBody200 = GetPricesResponseBody200 {}
- mkGetPricesResponseBody200 :: [Price] -> Bool -> Text -> GetPricesResponseBody200
Documentation
:: forall m. MonadHTTP m | |
=> GetPricesParameters | Contains all available parameters of this operation (query and path parameters) |
-> ClientT m (Response GetPricesResponse) | Monadic computation which returns the result of the operation |
GET /v1/prices
<p>Returns a list of your prices.</p>
data GetPricesParameters Source #
Defines the object schema located at paths./v1/prices.GET.parameters
in the specification.
GetPricesParameters | |
|
Instances
Eq GetPricesParameters Source # | |
Defined in StripeAPI.Operations.GetPrices (==) :: GetPricesParameters -> GetPricesParameters -> Bool # (/=) :: GetPricesParameters -> GetPricesParameters -> Bool # | |
Show GetPricesParameters Source # | |
Defined in StripeAPI.Operations.GetPrices showsPrec :: Int -> GetPricesParameters -> ShowS # show :: GetPricesParameters -> String # showList :: [GetPricesParameters] -> ShowS # | |
ToJSON GetPricesParameters Source # | |
Defined in StripeAPI.Operations.GetPrices toJSON :: GetPricesParameters -> Value # toEncoding :: GetPricesParameters -> Encoding # toJSONList :: [GetPricesParameters] -> Value # toEncodingList :: [GetPricesParameters] -> Encoding # | |
FromJSON GetPricesParameters Source # | |
Defined in StripeAPI.Operations.GetPrices parseJSON :: Value -> Parser GetPricesParameters # parseJSONList :: Value -> Parser [GetPricesParameters] # |
mkGetPricesParameters :: GetPricesParameters Source #
Create a new GetPricesParameters
with all required fields.
data GetPricesParametersQueryCreated'OneOf1 Source #
Defines the object schema located at paths./v1/prices.GET.parameters.properties.queryCreated.anyOf
in the specification.
mkGetPricesParametersQueryCreated'OneOf1 :: GetPricesParametersQueryCreated'OneOf1 Source #
Create a new GetPricesParametersQueryCreated'OneOf1
with all required fields.
data GetPricesParametersQueryCreated'Variants Source #
Defines the oneOf schema located at paths./v1/prices.GET.parameters.properties.queryCreated.anyOf
in the specification.
Represents the parameter named 'created'
A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
GetPricesParametersQueryCreated'GetPricesParametersQueryCreated'OneOf1 GetPricesParametersQueryCreated'OneOf1 | |
GetPricesParametersQueryCreated'Int Int |
data GetPricesParametersQueryRecurring' Source #
Defines the object schema located at paths./v1/prices.GET.parameters.properties.queryRecurring
in the specification.
Represents the parameter named 'recurring'
Only return prices with these recurring fields.
mkGetPricesParametersQueryRecurring' :: GetPricesParametersQueryRecurring' Source #
Create a new GetPricesParametersQueryRecurring'
with all required fields.
data GetPricesParametersQueryRecurring'Interval' Source #
Defines the enum schema located at paths./v1/prices.GET.parameters.properties.queryRecurring.properties.interval
in the specification.
GetPricesParametersQueryRecurring'Interval'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
GetPricesParametersQueryRecurring'Interval'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
GetPricesParametersQueryRecurring'Interval'EnumDay | Represents the JSON value |
GetPricesParametersQueryRecurring'Interval'EnumMonth | Represents the JSON value |
GetPricesParametersQueryRecurring'Interval'EnumWeek | Represents the JSON value |
GetPricesParametersQueryRecurring'Interval'EnumYear | Represents the JSON value |
data GetPricesParametersQueryRecurring'UsageType' Source #
Defines the enum schema located at paths./v1/prices.GET.parameters.properties.queryRecurring.properties.usage_type
in the specification.
GetPricesParametersQueryRecurring'UsageType'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
GetPricesParametersQueryRecurring'UsageType'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
GetPricesParametersQueryRecurring'UsageType'EnumLicensed | Represents the JSON value |
GetPricesParametersQueryRecurring'UsageType'EnumMetered | Represents the JSON value |
data GetPricesParametersQueryType' Source #
Defines the enum schema located at paths./v1/prices.GET.parameters.properties.queryType
in the specification.
Represents the parameter named 'type'
Only return prices of type `recurring` or `one_time`.
GetPricesParametersQueryType'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
GetPricesParametersQueryType'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
GetPricesParametersQueryType'EnumOneTime | Represents the JSON value |
GetPricesParametersQueryType'EnumRecurring | Represents the JSON value |
Instances
data GetPricesResponse Source #
Represents a response of the operation getPrices
.
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), GetPricesResponseError
is used.
GetPricesResponseError String | Means either no matching case available or a parse error |
GetPricesResponse200 GetPricesResponseBody200 | Successful response. |
GetPricesResponseDefault Error | Error response. |
Instances
Eq GetPricesResponse Source # | |
Defined in StripeAPI.Operations.GetPrices (==) :: GetPricesResponse -> GetPricesResponse -> Bool # (/=) :: GetPricesResponse -> GetPricesResponse -> Bool # | |
Show GetPricesResponse Source # | |
Defined in StripeAPI.Operations.GetPrices showsPrec :: Int -> GetPricesResponse -> ShowS # show :: GetPricesResponse -> String # showList :: [GetPricesResponse] -> ShowS # |
data GetPricesResponseBody200 Source #
Defines the object schema located at paths./v1/prices.GET.responses.200.content.application/json.schema
in the specification.
GetPricesResponseBody200 | |
|
Instances
Eq GetPricesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetPrices | |
Show GetPricesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetPrices showsPrec :: Int -> GetPricesResponseBody200 -> ShowS # show :: GetPricesResponseBody200 -> String # showList :: [GetPricesResponseBody200] -> ShowS # | |
ToJSON GetPricesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetPrices | |
FromJSON GetPricesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetPrices |
mkGetPricesResponseBody200 Source #
:: [Price] | |
-> Bool | |
-> Text | |
-> GetPricesResponseBody200 |
Create a new GetPricesResponseBody200
with all required fields.