stripeapi-1.0.0.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetProducts

Description

Contains the different functions to run the operation getProducts

Synopsis

Documentation

getProducts Source #

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

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

data GetProductsParametersQueryCreated'OneOf1 Source #

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

data GetProductsParametersQueryCreated'Variants Source #

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.

data GetProductsResponse Source #

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.

data GetProductsResponseBody200 Source #

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

Constructors

GetProductsResponseBody200 

Fields