StripeAPI.Operations.GetCustomers

Contains the different functions to run the operation getCustomers

Documentation

getCustomers

Arguments

:: forall m. MonadHTTP m

=> GetCustomersParameters

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

-> ClientT m (Response GetCustomersResponse)

Monadic computation which returns 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>

data GetCustomersParameters

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

Constructors

GetCustomersParameters

Fields

• getCustomersParametersQueryCreated :: Maybe GetCustomersParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

• getCustomersParametersQueryEmail :: Maybe Text

  queryEmail: Represents the parameter named 'email'

  A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.

  Constraints:

  • Maximum length of 512
• getCustomersParametersQueryEndingBefore :: 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
• getCustomersParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

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

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

Instances

Eq GetCustomersParameters

Defined in StripeAPI.Operations.GetCustomers

Methods

(==) :: GetCustomersParameters -> GetCustomersParameters -> Bool

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

Show GetCustomersParameters

Defined in StripeAPI.Operations.GetCustomers

Methods

showsPrec :: Int -> GetCustomersParameters -> ShowS

show :: GetCustomersParameters -> String

showList :: [GetCustomersParameters] -> ShowS

ToJSON GetCustomersParameters

Defined in StripeAPI.Operations.GetCustomers

Methods

toJSON :: GetCustomersParameters -> Value

toEncoding :: GetCustomersParameters -> Encoding

toJSONList :: [GetCustomersParameters] -> Value

toEncodingList :: [GetCustomersParameters] -> Encoding

FromJSON GetCustomersParameters

Defined in StripeAPI.Operations.GetCustomers

Methods

parseJSON :: Value -> Parser GetCustomersParameters

parseJSONList :: Value -> Parser [GetCustomersParameters]

mkGetCustomersParameters :: GetCustomersParameters

Create a new GetCustomersParameters with all required fields.

data GetCustomersParametersQueryCreated'OneOf1

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

Constructors

GetCustomersParametersQueryCreated'OneOf1

Fields

• getCustomersParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getCustomersParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getCustomersParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getCustomersParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetCustomersParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCustomers

Methods

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

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

Show GetCustomersParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCustomers

Methods

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

show :: GetCustomersParametersQueryCreated'OneOf1 -> String

showList :: [GetCustomersParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetCustomersParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCustomers

Methods

toJSON :: GetCustomersParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetCustomersParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetCustomersParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetCustomersParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetCustomersParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCustomers

Methods

parseJSON :: Value -> Parser GetCustomersParametersQueryCreated'OneOf1

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

mkGetCustomersParametersQueryCreated'OneOf1 :: GetCustomersParametersQueryCreated'OneOf1

Create a new GetCustomersParametersQueryCreated'OneOf1 with all required fields.

data GetCustomersParametersQueryCreated'Variants

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

Represents the parameter named 'created'

Constructors

GetCustomersParametersQueryCreated'GetCustomersParametersQueryCreated'OneOf1 GetCustomersParametersQueryCreated'OneOf1

GetCustomersParametersQueryCreated'Int Int

Instances

Eq GetCustomersParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCustomers

Methods

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

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

Show GetCustomersParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCustomers

Methods

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

show :: GetCustomersParametersQueryCreated'Variants -> String

showList :: [GetCustomersParametersQueryCreated'Variants] -> ShowS

ToJSON GetCustomersParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCustomers

Methods

toJSON :: GetCustomersParametersQueryCreated'Variants -> Value

toEncoding :: GetCustomersParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetCustomersParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetCustomersParametersQueryCreated'Variants] -> Encoding

FromJSON GetCustomersParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCustomers

Methods

parseJSON :: Value -> Parser GetCustomersParametersQueryCreated'Variants

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

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 object schema located at paths./v1/customers.GET.responses.200.content.application/json.schema in the specification.

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.

• getCustomersResponseBody200Url :: Text

  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]

mkGetCustomersResponseBody200

Arguments

:: [Customer]

getCustomersResponseBody200Data

-> Bool

getCustomersResponseBody200HasMore

-> Text

getCustomersResponseBody200Url

-> GetCustomersResponseBody200

Create a new GetCustomersResponseBody200 with all required fields.