Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetIssuingCardholders

Contains the different functions to run the operation getIssuingCardholders

7 types
4 values

Packagestripeapi-3.0.0.0
Exports11
LanguageHaskell2010
LicenceMIT
SourceGetIssuingCardholders.hs

valuegetIssuingCardholders

:: MonadHTTP m
=> GetIssuingCardholdersParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetIssuingCardholdersResponse)
Monadic computation which returns the result of the operation

GET /v1/issuing/cardholders

<p>Returns a list of Issuing <code>Cardholder</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

datadata GetIssuingCardholdersParameters

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

Constructors

GetIssuingCardholdersParameters
- getIssuingCardholdersParametersQueryCreated :: Maybe GetIssuingCardholdersParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
  Only return cardholders that were created during the given date interval.
- getIssuingCardholdersParametersQueryEmail :: Maybe Text
  queryEmail: Represents the parameter named 'email'
  Only return cardholders that have the given email address.
- getIssuingCardholdersParametersQueryEndingBefore :: 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
- getIssuingCardholdersParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getIssuingCardholdersParametersQueryLimit :: 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.
- getIssuingCardholdersParametersQueryPhoneNumber :: Maybe Text
  queryPhone_number: Represents the parameter named 'phone_number'
  Only return cardholders that have the given phone number.
- getIssuingCardholdersParametersQueryStartingAfter :: 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
- getIssuingCardholdersParametersQueryStatus :: Maybe GetIssuingCardholdersParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.
- getIssuingCardholdersParametersQueryType :: Maybe GetIssuingCardholdersParametersQueryType'
  queryType: Represents the parameter named 'type'
  Only return cardholders that have the given type. One of `individual` or `company`.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingCardholdersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
Show GetIssuingCardholdersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
FromJSON GetIssuingCardholdersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
ToJSON GetIssuingCardholdersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders

valuemkGetIssuingCardholdersParameters :: GetIssuingCardholdersParameters

Create a new GetIssuingCardholdersParameters with all required fields.

datadata GetIssuingCardholdersParametersQueryCreated'OneOf1

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

Constructors

GetIssuingCardholdersParametersQueryCreated'OneOf1
- getIssuingCardholdersParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getIssuingCardholdersParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getIssuingCardholdersParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getIssuingCardholdersParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingCardholdersParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
Show GetIssuingCardholdersParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
FromJSON GetIssuingCardholdersParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
ToJSON GetIssuingCardholdersParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders

valuemkGetIssuingCardholdersParametersQueryCreated'OneOf1 :: GetIssuingCardholdersParametersQueryCreated'OneOf1

Create a new GetIssuingCardholdersParametersQueryCreated'OneOf1 with all required fields.

datadata GetIssuingCardholdersParametersQueryCreated'Variants

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

Represents the parameter named 'created'

Only return cardholders that were created during the given date interval.

Constructors

GetIssuingCardholdersParametersQueryCreated'GetIssuingCardholdersParametersQueryCreated'OneOf1 GetIssuingCardholdersParametersQueryCreated'OneOf1
GetIssuingCardholdersParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingCardholdersParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
Show GetIssuingCardholdersParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
FromJSON GetIssuingCardholdersParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
ToJSON GetIssuingCardholdersParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders

datadata GetIssuingCardholdersParametersQueryStatus'

Defines the enum schema located at paths./v1/issuing/cardholders.GET.parameters.properties.queryStatus in the specification.

Represents the parameter named 'status'

Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.

Constructors

GetIssuingCardholdersParametersQueryStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetIssuingCardholdersParametersQueryStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetIssuingCardholdersParametersQueryStatus'EnumActive
Represents the JSON value "active"
GetIssuingCardholdersParametersQueryStatus'EnumBlocked
Represents the JSON value "blocked"
GetIssuingCardholdersParametersQueryStatus'EnumInactive
Represents the JSON value "inactive"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingCardholdersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
Show GetIssuingCardholdersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
FromJSON GetIssuingCardholdersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
ToJSON GetIssuingCardholdersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders

datadata GetIssuingCardholdersParametersQueryType'

Defines the enum schema located at paths./v1/issuing/cardholders.GET.parameters.properties.queryType in the specification.

Represents the parameter named 'type'

Only return cardholders that have the given type. One of `individual` or `company`.

Constructors

GetIssuingCardholdersParametersQueryType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetIssuingCardholdersParametersQueryType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetIssuingCardholdersParametersQueryType'EnumCompany
Represents the JSON value "company"
GetIssuingCardholdersParametersQueryType'EnumIndividual
Represents the JSON value "individual"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingCardholdersParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
Show GetIssuingCardholdersParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
FromJSON GetIssuingCardholdersParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
ToJSON GetIssuingCardholdersParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders

datadata GetIssuingCardholdersResponse

Represents a response of the operation getIssuingCardholders.

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

Constructors

GetIssuingCardholdersResponseError String
Means either no matching case available or a parse error
GetIssuingCardholdersResponse200 GetIssuingCardholdersResponseBody200
Successful response.
GetIssuingCardholdersResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetIssuingCardholdersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
Show GetIssuingCardholdersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders

datadata GetIssuingCardholdersResponseBody200

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

Constructors

GetIssuingCardholdersResponseBody200
- getIssuingCardholdersResponseBody200Data :: [Issuing'cardholder]
  data
- getIssuingCardholdersResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getIssuingCardholdersResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/issuing/cardholders'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingCardholdersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
Show GetIssuingCardholdersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
FromJSON GetIssuingCardholdersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders
ToJSON GetIssuingCardholdersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingCardholders

valuemkGetIssuingCardholdersResponseBody200

:: [Issuing'cardholder]
getIssuingCardholdersResponseBody200Data
-> Bool
getIssuingCardholdersResponseBody200HasMore
-> Text
getIssuingCardholdersResponseBody200Url
-> GetIssuingCardholdersResponseBody200

Create a new GetIssuingCardholdersResponseBody200 with all required fields.