StripeAPI.Operations.GetProducts

Contains the different functions to run the operation getProducts

Documentation

getProducts

Arguments

:: forall m. MonadHTTP m

=> GetProductsParameters

Contains all available parameters of this operation (query and path parameters)

-> StripeT m (Response GetProductsResponse)

Monadic computation which returns the result of the operation

GET /v1/products

<p>Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.</p>

data GetProductsParameters

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

Constructors

GetProductsParameters

Fields

• getProductsParametersQueryActive :: Maybe Bool

  queryActive: Represents the parameter named 'active'

  Only return products that are active or inactive (e.g., pass `false` to list all inactive products).

• getProductsParametersQueryCreated :: Maybe GetProductsParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

  Only return products that were created during the given date interval.

• getProductsParametersQueryEndingBefore :: 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
• getProductsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getProductsParametersQueryIds :: Maybe [Text]

  queryIds: Represents the parameter named 'ids'

  Only return products with the given IDs.

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

• getProductsParametersQueryShippable :: Maybe Bool

  queryShippable: Represents the parameter named 'shippable'

  Only return products that can be shipped (i.e., physical, not digital products).

• getProductsParametersQueryStartingAfter :: 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
• getProductsParametersQueryUrl :: Maybe Text

  queryUrl: Represents the parameter named 'url'

  Only return products with the given url.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetProductsParameters

Defined in StripeAPI.Operations.GetProducts

Methods

(==) :: GetProductsParameters -> GetProductsParameters -> Bool

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

Show GetProductsParameters

Defined in StripeAPI.Operations.GetProducts

Methods

showsPrec :: Int -> GetProductsParameters -> ShowS

show :: GetProductsParameters -> String

showList :: [GetProductsParameters] -> ShowS

ToJSON GetProductsParameters

Defined in StripeAPI.Operations.GetProducts

Methods

toJSON :: GetProductsParameters -> Value

toEncoding :: GetProductsParameters -> Encoding

toJSONList :: [GetProductsParameters] -> Value

toEncodingList :: [GetProductsParameters] -> Encoding

FromJSON GetProductsParameters

Defined in StripeAPI.Operations.GetProducts

Methods

parseJSON :: Value -> Parser GetProductsParameters

parseJSONList :: Value -> Parser [GetProductsParameters]

mkGetProductsParameters :: GetProductsParameters

Create a new GetProductsParameters with all required fields.

data GetProductsParametersQueryCreated'OneOf1

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

Constructors

GetProductsParametersQueryCreated'OneOf1

Fields

• getProductsParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getProductsParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getProductsParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getProductsParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetProductsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetProducts

Methods

(==) :: GetProductsParametersQueryCreated'OneOf1 -> GetProductsParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetProductsParametersQueryCreated'OneOf1 -> GetProductsParametersQueryCreated'OneOf1 -> Bool

Show GetProductsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetProducts

Methods

showsPrec :: Int -> GetProductsParametersQueryCreated'OneOf1 -> ShowS

show :: GetProductsParametersQueryCreated'OneOf1 -> String

showList :: [GetProductsParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetProductsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetProducts

Methods

toJSON :: GetProductsParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetProductsParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetProductsParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetProductsParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetProductsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetProducts

Methods

parseJSON :: Value -> Parser GetProductsParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetProductsParametersQueryCreated'OneOf1]

mkGetProductsParametersQueryCreated'OneOf1 :: GetProductsParametersQueryCreated'OneOf1

Create a new GetProductsParametersQueryCreated'OneOf1 with all required fields.

data GetProductsParametersQueryCreated'Variants

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

Represents the parameter named 'created'

Only return products that were created during the given date interval.

Constructors

GetProductsParametersQueryCreated'GetProductsParametersQueryCreated'OneOf1 GetProductsParametersQueryCreated'OneOf1

GetProductsParametersQueryCreated'Int Int

Instances

Eq GetProductsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetProducts

Methods

(==) :: GetProductsParametersQueryCreated'Variants -> GetProductsParametersQueryCreated'Variants -> Bool

(/=) :: GetProductsParametersQueryCreated'Variants -> GetProductsParametersQueryCreated'Variants -> Bool

Show GetProductsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetProducts

Methods

showsPrec :: Int -> GetProductsParametersQueryCreated'Variants -> ShowS

show :: GetProductsParametersQueryCreated'Variants -> String

showList :: [GetProductsParametersQueryCreated'Variants] -> ShowS

ToJSON GetProductsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetProducts

Methods

toJSON :: GetProductsParametersQueryCreated'Variants -> Value

toEncoding :: GetProductsParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetProductsParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetProductsParametersQueryCreated'Variants] -> Encoding

FromJSON GetProductsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetProducts

Methods

parseJSON :: Value -> Parser GetProductsParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetProductsParametersQueryCreated'Variants]

data GetProductsResponse

Represents a response of the operation getProducts.

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), GetProductsResponseError is used.

Constructors

GetProductsResponseError String

Means either no matching case available or a parse error

GetProductsResponse200 GetProductsResponseBody200

Successful response.

GetProductsResponseDefault Error

Error response.

Instances

Eq GetProductsResponse

Defined in StripeAPI.Operations.GetProducts

Methods

(==) :: GetProductsResponse -> GetProductsResponse -> Bool

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

Show GetProductsResponse

Defined in StripeAPI.Operations.GetProducts

Methods

showsPrec :: Int -> GetProductsResponse -> ShowS

show :: GetProductsResponse -> String

showList :: [GetProductsResponse] -> ShowS

data GetProductsResponseBody200

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

Constructors

GetProductsResponseBody200

Fields

• getProductsResponseBody200Data :: [Product]

  data

• getProductsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getProductsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/products'

Instances

Eq GetProductsResponseBody200

Defined in StripeAPI.Operations.GetProducts

Methods

(==) :: GetProductsResponseBody200 -> GetProductsResponseBody200 -> Bool

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

Show GetProductsResponseBody200

Defined in StripeAPI.Operations.GetProducts

Methods

showsPrec :: Int -> GetProductsResponseBody200 -> ShowS

show :: GetProductsResponseBody200 -> String

showList :: [GetProductsResponseBody200] -> ShowS

ToJSON GetProductsResponseBody200

Defined in StripeAPI.Operations.GetProducts

Methods

toJSON :: GetProductsResponseBody200 -> Value

toEncoding :: GetProductsResponseBody200 -> Encoding

toJSONList :: [GetProductsResponseBody200] -> Value

toEncodingList :: [GetProductsResponseBody200] -> Encoding

FromJSON GetProductsResponseBody200

Defined in StripeAPI.Operations.GetProducts

Methods

parseJSON :: Value -> Parser GetProductsResponseBody200

parseJSONList :: Value -> Parser [GetProductsResponseBody200]

mkGetProductsResponseBody200

Arguments

:: [Product]

getProductsResponseBody200Data

-> Bool

getProductsResponseBody200HasMore

-> Text

getProductsResponseBody200Url

-> GetProductsResponseBody200

Create a new GetProductsResponseBody200 with all required fields.