Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetPrices

Contains the different functions to run the operation getPrices

9 types
5 values

Packagestripeapi-3.0.0.0
Exports14
LanguageHaskell2010
LicenceMIT
SourceGetPrices.hs

valuegetPrices

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

datadata GetPricesParameters

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPricesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
Show GetPricesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
FromJSON GetPricesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
ToJSON GetPricesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices

valuemkGetPricesParameters :: GetPricesParameters

Create a new GetPricesParameters with all required fields.

datadata GetPricesParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/prices.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPricesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
Show GetPricesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
FromJSON GetPricesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
ToJSON GetPricesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices

valuemkGetPricesParametersQueryCreated'OneOf1 :: GetPricesParametersQueryCreated'OneOf1

Create a new GetPricesParametersQueryCreated'OneOf1 with all required fields.

datadata GetPricesParametersQueryCreated'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPricesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
Show GetPricesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
FromJSON GetPricesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
ToJSON GetPricesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices

datadata GetPricesParametersQueryRecurring'

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'
- getPricesParametersQueryRecurring'Interval :: Maybe GetPricesParametersQueryRecurring'Interval'
  interval
- getPricesParametersQueryRecurring'UsageType :: Maybe GetPricesParametersQueryRecurring'UsageType'
  usage_type

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPricesParametersQueryRecurring'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
Show GetPricesParametersQueryRecurring'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
FromJSON GetPricesParametersQueryRecurring'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
ToJSON GetPricesParametersQueryRecurring'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices

valuemkGetPricesParametersQueryRecurring' :: GetPricesParametersQueryRecurring'

Create a new GetPricesParametersQueryRecurring' with all required fields.

datadata GetPricesParametersQueryRecurring'Interval'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPricesParametersQueryRecurring'Interval'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
Show GetPricesParametersQueryRecurring'Interval'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
FromJSON GetPricesParametersQueryRecurring'Interval'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
ToJSON GetPricesParametersQueryRecurring'Interval'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices

datadata GetPricesParametersQueryRecurring'UsageType'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPricesParametersQueryRecurring'UsageType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
Show GetPricesParametersQueryRecurring'UsageType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
FromJSON GetPricesParametersQueryRecurring'UsageType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
ToJSON GetPricesParametersQueryRecurring'UsageType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices

datadata GetPricesParametersQueryType'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPricesParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
Show GetPricesParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
FromJSON GetPricesParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
ToJSON GetPricesParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices

datadata GetPricesResponse

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.

Instances2Eq, Show

Eq GetPricesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
Show GetPricesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices

datadata GetPricesResponseBody200

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPricesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
Show GetPricesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
FromJSON GetPricesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices
ToJSON GetPricesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPrices

valuemkGetPricesResponseBody200

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

Create a new GetPricesResponseBody200 with all required fields.