stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetIssuingCardholders

Description

Contains the different functions to run the operation getIssuingCardholders

Synopsis

Documentation

getIssuingCardholders Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe String

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

-> Maybe String

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

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

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

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

-> Maybe String

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

-> Maybe String

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

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

data GetIssuingCardholdersResponse Source #

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.

data GetIssuingCardholdersResponseBody200 Source #

Defines the data type for the schema GetIssuingCardholdersResponseBody200

Constructors

GetIssuingCardholdersResponseBody200 

Fields

data GetIssuingCardholdersResponseBody200Object' Source #

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