StripeAPI.Operations.GetCustomersCustomerCards

Contains the different functions to run the operation getCustomersCustomerCards

Documentation

getCustomersCustomerCards

Arguments

:: forall m. MonadHTTP m

=> GetCustomersCustomerCardsParameters

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

-> ClientT m (Response GetCustomersCustomerCardsResponse)

Monadic computation which returns the result of the operation

GET /v1/customers/{customer}/cards

<p>You can see a list of the cards belonging to a customer. Note that the 10 most recent sources are always available on the <code>Customer</code> object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional cards.</p>

data GetCustomersCustomerCardsParameters

Defines the object schema located at paths./v1/customers/{customer}/cards.GET.parameters in the specification.

Constructors

GetCustomersCustomerCardsParameters

Fields

• getCustomersCustomerCardsParametersPathCustomer :: Text

  pathCustomer: Represents the parameter named 'customer'

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerCardsParametersQueryEndingBefore :: 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.

• getCustomersCustomerCardsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

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

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

Instances

Eq GetCustomersCustomerCardsParameters

Defined in StripeAPI.Operations.GetCustomersCustomerCards

Methods

(==) :: GetCustomersCustomerCardsParameters -> GetCustomersCustomerCardsParameters -> Bool

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

Show GetCustomersCustomerCardsParameters

Defined in StripeAPI.Operations.GetCustomersCustomerCards

Methods

showsPrec :: Int -> GetCustomersCustomerCardsParameters -> ShowS

show :: GetCustomersCustomerCardsParameters -> String

showList :: [GetCustomersCustomerCardsParameters] -> ShowS

ToJSON GetCustomersCustomerCardsParameters

Defined in StripeAPI.Operations.GetCustomersCustomerCards

Methods

toJSON :: GetCustomersCustomerCardsParameters -> Value

toEncoding :: GetCustomersCustomerCardsParameters -> Encoding

toJSONList :: [GetCustomersCustomerCardsParameters] -> Value

toEncodingList :: [GetCustomersCustomerCardsParameters] -> Encoding

FromJSON GetCustomersCustomerCardsParameters

Defined in StripeAPI.Operations.GetCustomersCustomerCards

Methods

parseJSON :: Value -> Parser GetCustomersCustomerCardsParameters

parseJSONList :: Value -> Parser [GetCustomersCustomerCardsParameters]

mkGetCustomersCustomerCardsParameters

Arguments

:: Text

getCustomersCustomerCardsParametersPathCustomer

-> GetCustomersCustomerCardsParameters

Create a new GetCustomersCustomerCardsParameters with all required fields.

data GetCustomersCustomerCardsResponse

Represents a response of the operation getCustomersCustomerCards.

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

Constructors

GetCustomersCustomerCardsResponseError String

Means either no matching case available or a parse error

GetCustomersCustomerCardsResponse200 GetCustomersCustomerCardsResponseBody200

Successful response.

GetCustomersCustomerCardsResponseDefault Error

Error response.

Instances

Eq GetCustomersCustomerCardsResponse

Defined in StripeAPI.Operations.GetCustomersCustomerCards

Methods

(==) :: GetCustomersCustomerCardsResponse -> GetCustomersCustomerCardsResponse -> Bool

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

Show GetCustomersCustomerCardsResponse

Defined in StripeAPI.Operations.GetCustomersCustomerCards

Methods

showsPrec :: Int -> GetCustomersCustomerCardsResponse -> ShowS

show :: GetCustomersCustomerCardsResponse -> String

showList :: [GetCustomersCustomerCardsResponse] -> ShowS

data GetCustomersCustomerCardsResponseBody200

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

Constructors

GetCustomersCustomerCardsResponseBody200

Fields

• getCustomersCustomerCardsResponseBody200Data :: [Card]

  data

• getCustomersCustomerCardsResponseBody200HasMore :: Bool

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

• getCustomersCustomerCardsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetCustomersCustomerCardsResponseBody200

Defined in StripeAPI.Operations.GetCustomersCustomerCards

Methods

(==) :: GetCustomersCustomerCardsResponseBody200 -> GetCustomersCustomerCardsResponseBody200 -> Bool

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

Show GetCustomersCustomerCardsResponseBody200

Defined in StripeAPI.Operations.GetCustomersCustomerCards

Methods

showsPrec :: Int -> GetCustomersCustomerCardsResponseBody200 -> ShowS

show :: GetCustomersCustomerCardsResponseBody200 -> String

showList :: [GetCustomersCustomerCardsResponseBody200] -> ShowS

ToJSON GetCustomersCustomerCardsResponseBody200

Defined in StripeAPI.Operations.GetCustomersCustomerCards

Methods

toJSON :: GetCustomersCustomerCardsResponseBody200 -> Value

toEncoding :: GetCustomersCustomerCardsResponseBody200 -> Encoding

toJSONList :: [GetCustomersCustomerCardsResponseBody200] -> Value

toEncodingList :: [GetCustomersCustomerCardsResponseBody200] -> Encoding

FromJSON GetCustomersCustomerCardsResponseBody200

Defined in StripeAPI.Operations.GetCustomersCustomerCards

Methods

parseJSON :: Value -> Parser GetCustomersCustomerCardsResponseBody200

parseJSONList :: Value -> Parser [GetCustomersCustomerCardsResponseBody200]

mkGetCustomersCustomerCardsResponseBody200

Arguments

:: [Card]

getCustomersCustomerCardsResponseBody200Data

-> Bool

getCustomersCustomerCardsResponseBody200HasMore

-> Text

getCustomersCustomerCardsResponseBody200Url

-> GetCustomersCustomerCardsResponseBody200

Create a new GetCustomersCustomerCardsResponseBody200 with all required fields.