StripeAPI.Operations.GetCustomers

Contains the different functions to run the operation getCustomers

Documentation

getCustomers

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe String

created

-> Maybe String

email: A filter on the list based on the customer's `email` field. The value must be a string. | Constraints: Maximum length of 512

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

-> GetCustomersRequestBody

The request body to send

-> m (Either HttpException (Response GetCustomersResponse))

Monad containing the result of the operation

GET /v1/customers

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

getCustomersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCustomersRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/customers

The same as getCustomers but returns the raw ByteString

getCustomersM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCustomersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCustomersResponse))

GET /v1/customers

Monadic version of getCustomers (use with runWithConfiguration)

getCustomersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCustomersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/customers

Monadic version of getCustomersRaw (use with runWithConfiguration)

data GetCustomersRequestBody

Defines the data type for the schema getCustomersRequestBody

Constructors

GetCustomersRequestBody

Instances

Eq GetCustomersRequestBody

Defined in StripeAPI.Operations.GetCustomers

Methods

(==) :: GetCustomersRequestBody -> GetCustomersRequestBody -> Bool

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

Show GetCustomersRequestBody

Defined in StripeAPI.Operations.GetCustomers

Methods

showsPrec :: Int -> GetCustomersRequestBody -> ShowS

show :: GetCustomersRequestBody -> String

showList :: [GetCustomersRequestBody] -> ShowS

ToJSON GetCustomersRequestBody

Defined in StripeAPI.Operations.GetCustomers

Methods

toJSON :: GetCustomersRequestBody -> Value

toEncoding :: GetCustomersRequestBody -> Encoding

toJSONList :: [GetCustomersRequestBody] -> Value

toEncodingList :: [GetCustomersRequestBody] -> Encoding

FromJSON GetCustomersRequestBody

Defined in StripeAPI.Operations.GetCustomers

Methods

parseJSON :: Value -> Parser GetCustomersRequestBody

parseJSONList :: Value -> Parser [GetCustomersRequestBody]

data GetCustomersResponse

Represents a response of the operation getCustomers.

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

Constructors

GetCustomersResponseError String

Means either no matching case available or a parse error

GetCustomersResponse200 GetCustomersResponseBody200

Successful response.

GetCustomersResponseDefault Error

Error response.

Instances

Eq GetCustomersResponse

Defined in StripeAPI.Operations.GetCustomers

Methods

(==) :: GetCustomersResponse -> GetCustomersResponse -> Bool

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

Show GetCustomersResponse

Defined in StripeAPI.Operations.GetCustomers

Methods

showsPrec :: Int -> GetCustomersResponse -> ShowS

show :: GetCustomersResponse -> String

showList :: [GetCustomersResponse] -> ShowS

data GetCustomersResponseBody200

Defines the data type for the schema GetCustomersResponseBody200

Constructors

GetCustomersResponseBody200

Fields

• getCustomersResponseBody200Data :: [] Customer

  data

• getCustomersResponseBody200HasMore :: Bool

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

• getCustomersResponseBody200Object :: GetCustomersResponseBody200Object'

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

• getCustomersResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetCustomersResponseBody200

Defined in StripeAPI.Operations.GetCustomers

Methods

(==) :: GetCustomersResponseBody200 -> GetCustomersResponseBody200 -> Bool

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

Show GetCustomersResponseBody200

Defined in StripeAPI.Operations.GetCustomers

Methods

showsPrec :: Int -> GetCustomersResponseBody200 -> ShowS

show :: GetCustomersResponseBody200 -> String

showList :: [GetCustomersResponseBody200] -> ShowS

ToJSON GetCustomersResponseBody200

Defined in StripeAPI.Operations.GetCustomers

Methods

toJSON :: GetCustomersResponseBody200 -> Value

toEncoding :: GetCustomersResponseBody200 -> Encoding

toJSONList :: [GetCustomersResponseBody200] -> Value

toEncodingList :: [GetCustomersResponseBody200] -> Encoding

FromJSON GetCustomersResponseBody200

Defined in StripeAPI.Operations.GetCustomers

Methods

parseJSON :: Value -> Parser GetCustomersResponseBody200

parseJSONList :: Value -> Parser [GetCustomersResponseBody200]

data GetCustomersResponseBody200Object'

Defines the enum schema GetCustomersResponseBody200Object'

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

Constructors

GetCustomersResponseBody200Object'EnumOther Value

GetCustomersResponseBody200Object'EnumTyped String

GetCustomersResponseBody200Object'EnumStringList

Instances

Eq GetCustomersResponseBody200Object'

Defined in StripeAPI.Operations.GetCustomers

Methods

(==) :: GetCustomersResponseBody200Object' -> GetCustomersResponseBody200Object' -> Bool

(/=) :: GetCustomersResponseBody200Object' -> GetCustomersResponseBody200Object' -> Bool

Show GetCustomersResponseBody200Object'

Defined in StripeAPI.Operations.GetCustomers

Methods

showsPrec :: Int -> GetCustomersResponseBody200Object' -> ShowS

show :: GetCustomersResponseBody200Object' -> String

showList :: [GetCustomersResponseBody200Object'] -> ShowS

ToJSON GetCustomersResponseBody200Object'

Defined in StripeAPI.Operations.GetCustomers

Methods

toJSON :: GetCustomersResponseBody200Object' -> Value

toEncoding :: GetCustomersResponseBody200Object' -> Encoding

toJSONList :: [GetCustomersResponseBody200Object'] -> Value

toEncodingList :: [GetCustomersResponseBody200Object'] -> Encoding

FromJSON GetCustomersResponseBody200Object'

Defined in StripeAPI.Operations.GetCustomers

Methods

parseJSON :: Value -> Parser GetCustomersResponseBody200Object'

parseJSONList :: Value -> Parser [GetCustomersResponseBody200Object']