HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetCustomers

Contains the different functions to run the operation getCustomers

  • 5 types
  • 4 values
valuegetCustomers
  1. :: MonadHTTP m
  2. => GetCustomersParameters

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

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

datadata GetCustomersParameters
#

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

Constructors

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

    • getCustomersParametersQueryTestClock :: Maybe Text

      queryTest_clock: Represents the parameter named 'test_clock'

      Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.

      Constraints:

      • Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON
datadata GetCustomersParametersQueryCreated'OneOf1
#

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata 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

Instances4Eq, Show, FromJSON, ToJSON
datadata 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

Instances2Eq, Show
datadata GetCustomersResponseBody200
#

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON