stripeapi-0.1.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

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe Bool

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

-> Maybe String

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

-> Maybe String

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

-> Maybe String

expand: Specifies which fields in the response should be expanded.

-> Maybe String

ids: Only return products with the given IDs.

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe Bool

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

-> Maybe String

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

-> Maybe String

type: Only return products of this type. | Constraints: Maximum length of 5000

-> Maybe String

url: Only return products with the given url. | Constraints: Maximum length of 5000

-> GetProductsRequestBody

The request body to send

-> m (Either HttpException (Response GetProductsResponse))

Monad containing 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 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 data type for the schema GetProductsResponseBody200

Constructors

GetProductsResponseBody200 

Fields

data GetProductsResponseBody200Object' Source #

Defines the enum schema GetProductsResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.