StripeAPI.Operations.GetIssuingCardholders

Contains the different functions to run the operation getIssuingCardholders

Documentation

getIssuingCardholders

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

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

-> Maybe Text

email: Only return cardholders that have the given email address.

-> Maybe Text

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 Text

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

-> Maybe Bool

is_default: Only return the default cardholder.

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

phone_number: Only return cardholders that have the given phone number.

-> Maybe Text

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 Text

status: Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. | Constraints: Maximum length of 5000

-> Maybe Text

type: Only return cardholders that have the given type. One of `individual` or `business_entity`. | Constraints: Maximum length of 5000

-> Maybe GetIssuingCardholdersRequestBody

The request body to send

-> m (Either HttpException (Response GetIssuingCardholdersResponse))

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

getIssuingCardholdersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetIssuingCardholdersRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/issuing/cardholders

The same as getIssuingCardholders but returns the raw ByteString

getIssuingCardholdersM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetIssuingCardholdersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetIssuingCardholdersResponse))

GET /v1/issuing/cardholders

Monadic version of getIssuingCardholders (use with runWithConfiguration)

getIssuingCardholdersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetIssuingCardholdersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/issuing/cardholders

Monadic version of getIssuingCardholdersRaw (use with runWithConfiguration)

data GetIssuingCardholdersRequestBody

Defines the data type for the schema getIssuingCardholdersRequestBody

Constructors

GetIssuingCardholdersRequestBody

Instances

Eq GetIssuingCardholdersRequestBody

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

(==) :: GetIssuingCardholdersRequestBody -> GetIssuingCardholdersRequestBody -> Bool

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

Show GetIssuingCardholdersRequestBody

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

showsPrec :: Int -> GetIssuingCardholdersRequestBody -> ShowS

show :: GetIssuingCardholdersRequestBody -> String

showList :: [GetIssuingCardholdersRequestBody] -> ShowS

ToJSON GetIssuingCardholdersRequestBody

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

toJSON :: GetIssuingCardholdersRequestBody -> Value

toEncoding :: GetIssuingCardholdersRequestBody -> Encoding

toJSONList :: [GetIssuingCardholdersRequestBody] -> Value

toEncodingList :: [GetIssuingCardholdersRequestBody] -> Encoding

FromJSON GetIssuingCardholdersRequestBody

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

parseJSON :: Value -> Parser GetIssuingCardholdersRequestBody

parseJSONList :: Value -> Parser [GetIssuingCardholdersRequestBody]

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

Instances

Eq GetIssuingCardholdersResponse

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

(==) :: GetIssuingCardholdersResponse -> GetIssuingCardholdersResponse -> Bool

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

Show GetIssuingCardholdersResponse

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

showsPrec :: Int -> GetIssuingCardholdersResponse -> ShowS

show :: GetIssuingCardholdersResponse -> String

showList :: [GetIssuingCardholdersResponse] -> ShowS

data GetIssuingCardholdersResponseBody200

Defines the data type for the schema GetIssuingCardholdersResponseBody200

Constructors

GetIssuingCardholdersResponseBody200

Fields

• getIssuingCardholdersResponseBody200Data :: [] Issuing'cardholder

  data

• getIssuingCardholdersResponseBody200HasMore :: Bool

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

• getIssuingCardholdersResponseBody200Object :: GetIssuingCardholdersResponseBody200Object'

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

• getIssuingCardholdersResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetIssuingCardholdersResponseBody200

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

(==) :: GetIssuingCardholdersResponseBody200 -> GetIssuingCardholdersResponseBody200 -> Bool

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

Show GetIssuingCardholdersResponseBody200

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

showsPrec :: Int -> GetIssuingCardholdersResponseBody200 -> ShowS

show :: GetIssuingCardholdersResponseBody200 -> String

showList :: [GetIssuingCardholdersResponseBody200] -> ShowS

ToJSON GetIssuingCardholdersResponseBody200

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

toJSON :: GetIssuingCardholdersResponseBody200 -> Value

toEncoding :: GetIssuingCardholdersResponseBody200 -> Encoding

toJSONList :: [GetIssuingCardholdersResponseBody200] -> Value

toEncodingList :: [GetIssuingCardholdersResponseBody200] -> Encoding

FromJSON GetIssuingCardholdersResponseBody200

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

parseJSON :: Value -> Parser GetIssuingCardholdersResponseBody200

parseJSONList :: Value -> Parser [GetIssuingCardholdersResponseBody200]

data GetIssuingCardholdersResponseBody200Object'

Defines the enum schema GetIssuingCardholdersResponseBody200Object'

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

Constructors

GetIssuingCardholdersResponseBody200Object'EnumOther Value

GetIssuingCardholdersResponseBody200Object'EnumTyped Text

GetIssuingCardholdersResponseBody200Object'EnumStringList

Instances

Eq GetIssuingCardholdersResponseBody200Object'

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

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

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

Show GetIssuingCardholdersResponseBody200Object'

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

showsPrec :: Int -> GetIssuingCardholdersResponseBody200Object' -> ShowS

show :: GetIssuingCardholdersResponseBody200Object' -> String

showList :: [GetIssuingCardholdersResponseBody200Object'] -> ShowS

ToJSON GetIssuingCardholdersResponseBody200Object'

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

toJSON :: GetIssuingCardholdersResponseBody200Object' -> Value

toEncoding :: GetIssuingCardholdersResponseBody200Object' -> Encoding

toJSONList :: [GetIssuingCardholdersResponseBody200Object'] -> Value

toEncodingList :: [GetIssuingCardholdersResponseBody200Object'] -> Encoding

FromJSON GetIssuingCardholdersResponseBody200Object'

Defined in StripeAPI.Operations.GetIssuingCardholders

Methods

parseJSON :: Value -> Parser GetIssuingCardholdersResponseBody200Object'

parseJSONList :: Value -> Parser [GetIssuingCardholdersResponseBody200Object']