Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetPrices

Description

Contains the different functions to run the operation getPrices

Synopsis

getPrices :: forall m. MonadHTTP m => GetPricesParameters -> ClientT m (Response GetPricesResponse)
data GetPricesParameters = GetPricesParameters {
}
mkGetPricesParameters :: GetPricesParameters
data GetPricesParametersQueryCreated'OneOf1 = GetPricesParametersQueryCreated'OneOf1 {
}
mkGetPricesParametersQueryCreated'OneOf1 :: GetPricesParametersQueryCreated'OneOf1
data GetPricesParametersQueryCreated'Variants
- = GetPricesParametersQueryCreated'GetPricesParametersQueryCreated'OneOf1 GetPricesParametersQueryCreated'OneOf1
- | GetPricesParametersQueryCreated'Int Int
data GetPricesParametersQueryRecurring' = GetPricesParametersQueryRecurring' {
- getPricesParametersQueryRecurring'Interval :: Maybe GetPricesParametersQueryRecurring'Interval'
- getPricesParametersQueryRecurring'UsageType :: Maybe GetPricesParametersQueryRecurring'UsageType'
}
mkGetPricesParametersQueryRecurring' :: GetPricesParametersQueryRecurring'
data GetPricesParametersQueryRecurring'Interval'
data GetPricesParametersQueryRecurring'UsageType'
data GetPricesParametersQueryType'
data GetPricesResponse
data GetPricesResponseBody200 = GetPricesResponseBody200 {
}
mkGetPricesResponseBody200 :: [Price] -> Bool -> Text -> GetPricesResponseBody200

Documentation

getPrices Source #

Arguments

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

Constructors

GetPricesParameters

Fields

getPricesParametersQueryActive :: Maybe Bool
queryActive: Represents the parameter named 'active'
Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
getPricesParametersQueryCreated :: Maybe GetPricesParametersQueryCreated'Variants
queryCreated: 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.
getPricesParametersQueryCurrency :: Maybe Text
queryCurrency: Represents the parameter named 'currency'
Only return prices for the given currency.
getPricesParametersQueryEndingBefore :: Maybe Text
queryEnding_before: Represents the parameter named 'ending_before'
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
Constraints:
- Maximum length of 5000
getPricesParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getPricesParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
getPricesParametersQueryLookupKeys :: Maybe [Text]
queryLookup_keys: Represents the parameter named 'lookup_keys'
Only return the price with these lookup_keys, if any exist.
getPricesParametersQueryProduct :: Maybe Text
queryProduct: Represents the parameter named 'product'
Only return prices for the given product.
Constraints:
- Maximum length of 5000
getPricesParametersQueryRecurring :: Maybe GetPricesParametersQueryRecurring'
queryRecurring: Represents the parameter named 'recurring'
Only return prices with these recurring fields.
getPricesParametersQueryStartingAfter :: Maybe Text
queryStarting_after: Represents the parameter named 'starting_after'
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
Constraints:
- Maximum length of 5000
getPricesParametersQueryType :: Maybe GetPricesParametersQueryType'
queryType: Represents the parameter named 'type'
Only return prices of type `recurring` or `one_time`.

Instances

Instances details

Eq GetPricesParameters Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods (==) :: GetPricesParameters -> GetPricesParameters -> Bool # (/=) :: GetPricesParameters -> GetPricesParameters -> Bool #
Show GetPricesParameters Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods showsPrec :: Int -> GetPricesParameters -> ShowS # show :: GetPricesParameters -> String # showList :: [GetPricesParameters] -> ShowS #
ToJSON GetPricesParameters Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods toJSON :: GetPricesParameters -> Value # toEncoding :: GetPricesParameters -> Encoding # toJSONList :: [GetPricesParameters] -> Value # toEncodingList :: [GetPricesParameters] -> Encoding #
FromJSON GetPricesParameters Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods 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.

Constructors

GetPricesParametersQueryCreated'OneOf1
Fields getPricesParametersQueryCreated'OneOf1Gt :: Maybe Int gt getPricesParametersQueryCreated'OneOf1Gte :: Maybe Int gte getPricesParametersQueryCreated'OneOf1Lt :: Maybe Int lt getPricesParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

Eq GetPricesParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods (==) :: GetPricesParametersQueryCreated'OneOf1 -> GetPricesParametersQueryCreated'OneOf1 -> Bool # (/=) :: GetPricesParametersQueryCreated'OneOf1 -> GetPricesParametersQueryCreated'OneOf1 -> Bool #
Show GetPricesParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods showsPrec :: Int -> GetPricesParametersQueryCreated'OneOf1 -> ShowS # show :: GetPricesParametersQueryCreated'OneOf1 -> String # showList :: [GetPricesParametersQueryCreated'OneOf1] -> ShowS #
ToJSON GetPricesParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods toJSON :: GetPricesParametersQueryCreated'OneOf1 -> Value # toEncoding :: GetPricesParametersQueryCreated'OneOf1 -> Encoding # toJSONList :: [GetPricesParametersQueryCreated'OneOf1] -> Value # toEncodingList :: [GetPricesParametersQueryCreated'OneOf1] -> Encoding #
FromJSON GetPricesParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods parseJSON :: Value -> Parser GetPricesParametersQueryCreated'OneOf1 # parseJSONList :: Value -> Parser [GetPricesParametersQueryCreated'OneOf1] #

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.

Constructors

GetPricesParametersQueryCreated'GetPricesParametersQueryCreated'OneOf1 GetPricesParametersQueryCreated'OneOf1
GetPricesParametersQueryCreated'Int Int

Instances

Instances details

Eq GetPricesParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods (==) :: GetPricesParametersQueryCreated'Variants -> GetPricesParametersQueryCreated'Variants -> Bool # (/=) :: GetPricesParametersQueryCreated'Variants -> GetPricesParametersQueryCreated'Variants -> Bool #
Show GetPricesParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods showsPrec :: Int -> GetPricesParametersQueryCreated'Variants -> ShowS # show :: GetPricesParametersQueryCreated'Variants -> String # showList :: [GetPricesParametersQueryCreated'Variants] -> ShowS #
ToJSON GetPricesParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods toJSON :: GetPricesParametersQueryCreated'Variants -> Value # toEncoding :: GetPricesParametersQueryCreated'Variants -> Encoding # toJSONList :: [GetPricesParametersQueryCreated'Variants] -> Value # toEncodingList :: [GetPricesParametersQueryCreated'Variants] -> Encoding #
FromJSON GetPricesParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods parseJSON :: Value -> Parser GetPricesParametersQueryCreated'Variants # parseJSONList :: Value -> Parser [GetPricesParametersQueryCreated'Variants] #

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.

Constructors

GetPricesParametersQueryRecurring'
Fields getPricesParametersQueryRecurring'Interval :: Maybe GetPricesParametersQueryRecurring'Interval' interval getPricesParametersQueryRecurring'UsageType :: Maybe GetPricesParametersQueryRecurring'UsageType' usage_type

Instances

Instances details

Eq GetPricesParametersQueryRecurring' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods (==) :: GetPricesParametersQueryRecurring' -> GetPricesParametersQueryRecurring' -> Bool # (/=) :: GetPricesParametersQueryRecurring' -> GetPricesParametersQueryRecurring' -> Bool #
Show GetPricesParametersQueryRecurring' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods showsPrec :: Int -> GetPricesParametersQueryRecurring' -> ShowS # show :: GetPricesParametersQueryRecurring' -> String # showList :: [GetPricesParametersQueryRecurring'] -> ShowS #
ToJSON GetPricesParametersQueryRecurring' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods toJSON :: GetPricesParametersQueryRecurring' -> Value # toEncoding :: GetPricesParametersQueryRecurring' -> Encoding # toJSONList :: [GetPricesParametersQueryRecurring'] -> Value # toEncodingList :: [GetPricesParametersQueryRecurring'] -> Encoding #
FromJSON GetPricesParametersQueryRecurring' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods parseJSON :: Value -> Parser GetPricesParametersQueryRecurring' # parseJSONList :: Value -> Parser [GetPricesParametersQueryRecurring'] #

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.

Constructors

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 `"day"`
GetPricesParametersQueryRecurring'Interval'EnumMonth	Represents the JSON value `"month"`
GetPricesParametersQueryRecurring'Interval'EnumWeek	Represents the JSON value `"week"`
GetPricesParametersQueryRecurring'Interval'EnumYear	Represents the JSON value `"year"`

Instances

Instances details

Eq GetPricesParametersQueryRecurring'Interval' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods (==) :: GetPricesParametersQueryRecurring'Interval' -> GetPricesParametersQueryRecurring'Interval' -> Bool # (/=) :: GetPricesParametersQueryRecurring'Interval' -> GetPricesParametersQueryRecurring'Interval' -> Bool #
Show GetPricesParametersQueryRecurring'Interval' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods showsPrec :: Int -> GetPricesParametersQueryRecurring'Interval' -> ShowS # show :: GetPricesParametersQueryRecurring'Interval' -> String # showList :: [GetPricesParametersQueryRecurring'Interval'] -> ShowS #
ToJSON GetPricesParametersQueryRecurring'Interval' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods toJSON :: GetPricesParametersQueryRecurring'Interval' -> Value # toEncoding :: GetPricesParametersQueryRecurring'Interval' -> Encoding # toJSONList :: [GetPricesParametersQueryRecurring'Interval'] -> Value # toEncodingList :: [GetPricesParametersQueryRecurring'Interval'] -> Encoding #
FromJSON GetPricesParametersQueryRecurring'Interval' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods parseJSON :: Value -> Parser GetPricesParametersQueryRecurring'Interval' # parseJSONList :: Value -> Parser [GetPricesParametersQueryRecurring'Interval'] #

data GetPricesParametersQueryRecurring'UsageType' Source #

Defines the enum schema located at paths./v1/prices.GET.parameters.properties.queryRecurring.properties.usage_type in the specification.

Constructors

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 `"licensed"`
GetPricesParametersQueryRecurring'UsageType'EnumMetered	Represents the JSON value `"metered"`

Instances

Instances details

Eq GetPricesParametersQueryRecurring'UsageType' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods (==) :: GetPricesParametersQueryRecurring'UsageType' -> GetPricesParametersQueryRecurring'UsageType' -> Bool # (/=) :: GetPricesParametersQueryRecurring'UsageType' -> GetPricesParametersQueryRecurring'UsageType' -> Bool #
Show GetPricesParametersQueryRecurring'UsageType' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods showsPrec :: Int -> GetPricesParametersQueryRecurring'UsageType' -> ShowS # show :: GetPricesParametersQueryRecurring'UsageType' -> String # showList :: [GetPricesParametersQueryRecurring'UsageType'] -> ShowS #
ToJSON GetPricesParametersQueryRecurring'UsageType' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods toJSON :: GetPricesParametersQueryRecurring'UsageType' -> Value # toEncoding :: GetPricesParametersQueryRecurring'UsageType' -> Encoding # toJSONList :: [GetPricesParametersQueryRecurring'UsageType'] -> Value # toEncodingList :: [GetPricesParametersQueryRecurring'UsageType'] -> Encoding #
FromJSON GetPricesParametersQueryRecurring'UsageType' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods parseJSON :: Value -> Parser GetPricesParametersQueryRecurring'UsageType' # parseJSONList :: Value -> Parser [GetPricesParametersQueryRecurring'UsageType'] #

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

Constructors

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 `"one_time"`
GetPricesParametersQueryType'EnumRecurring	Represents the JSON value `"recurring"`

Instances

Instances details

Eq GetPricesParametersQueryType' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods (==) :: GetPricesParametersQueryType' -> GetPricesParametersQueryType' -> Bool # (/=) :: GetPricesParametersQueryType' -> GetPricesParametersQueryType' -> Bool #
Show GetPricesParametersQueryType' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods showsPrec :: Int -> GetPricesParametersQueryType' -> ShowS # show :: GetPricesParametersQueryType' -> String # showList :: [GetPricesParametersQueryType'] -> ShowS #
ToJSON GetPricesParametersQueryType' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods toJSON :: GetPricesParametersQueryType' -> Value # toEncoding :: GetPricesParametersQueryType' -> Encoding # toJSONList :: [GetPricesParametersQueryType'] -> Value # toEncodingList :: [GetPricesParametersQueryType'] -> Encoding #
FromJSON GetPricesParametersQueryType' Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods parseJSON :: Value -> Parser GetPricesParametersQueryType' # parseJSONList :: Value -> Parser [GetPricesParametersQueryType'] #

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.

Constructors

GetPricesResponseError String	Means either no matching case available or a parse error
GetPricesResponse200 GetPricesResponseBody200	Successful response.
GetPricesResponseDefault Error	Error response.

Instances

Instances details

Eq GetPricesResponse Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods (==) :: GetPricesResponse -> GetPricesResponse -> Bool # (/=) :: GetPricesResponse -> GetPricesResponse -> Bool #
Show GetPricesResponse Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods 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.

Constructors

GetPricesResponseBody200
Fields getPricesResponseBody200Data :: [Price] data: Details about each object. getPricesResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getPricesResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000 Must match pattern '^/v1/prices'

Instances

Instances details

Eq GetPricesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods (==) :: GetPricesResponseBody200 -> GetPricesResponseBody200 -> Bool # (/=) :: GetPricesResponseBody200 -> GetPricesResponseBody200 -> Bool #
Show GetPricesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods showsPrec :: Int -> GetPricesResponseBody200 -> ShowS # show :: GetPricesResponseBody200 -> String # showList :: [GetPricesResponseBody200] -> ShowS #
ToJSON GetPricesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods toJSON :: GetPricesResponseBody200 -> Value # toEncoding :: GetPricesResponseBody200 -> Encoding # toJSONList :: [GetPricesResponseBody200] -> Value # toEncodingList :: [GetPricesResponseBody200] -> Encoding #
FromJSON GetPricesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPrices Methods parseJSON :: Value -> Parser GetPricesResponseBody200 # parseJSONList :: Value -> Parser [GetPricesResponseBody200] #

mkGetPricesResponseBody200 Source #

Arguments

:: [Price]	`getPricesResponseBody200Data`
-> Bool	`getPricesResponseBody200HasMore`
-> Text	`getPricesResponseBody200Url`
-> GetPricesResponseBody200

Create a new GetPricesResponseBody200 with all required fields.