StripeAPI.Operations.GetSetupIntents

Contains the different functions to run the operation getSetupIntents

Documentation

getSetupIntents

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

created: A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

-> Maybe Text

customer: Only return SetupIntents for the customer specified by this customer ID. | Constraints: Maximum length of 5000

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

payment_method: Only return SetupIntents associated with the specified payment method. | Constraints: Maximum length of 5000

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

The request body to send

-> m (Either HttpException (Response GetSetupIntentsResponse))

Monad containing the result of the operation

GET /v1/setup_intents

<p>Returns a list of SetupIntents.</p>

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

GET /v1/setup_intents

The same as getSetupIntents but returns the raw ByteString

getSetupIntentsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetSetupIntentsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSetupIntentsResponse))

GET /v1/setup_intents

Monadic version of getSetupIntents (use with runWithConfiguration)

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

GET /v1/setup_intents

Monadic version of getSetupIntentsRaw (use with runWithConfiguration)

data GetSetupIntentsRequestBody

Defines the data type for the schema getSetupIntentsRequestBody

Constructors

GetSetupIntentsRequestBody

Instances

Eq GetSetupIntentsRequestBody

Defined in StripeAPI.Operations.GetSetupIntents

Methods

(==) :: GetSetupIntentsRequestBody -> GetSetupIntentsRequestBody -> Bool

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

Show GetSetupIntentsRequestBody

Defined in StripeAPI.Operations.GetSetupIntents

Methods

showsPrec :: Int -> GetSetupIntentsRequestBody -> ShowS

show :: GetSetupIntentsRequestBody -> String

showList :: [GetSetupIntentsRequestBody] -> ShowS

ToJSON GetSetupIntentsRequestBody

Defined in StripeAPI.Operations.GetSetupIntents

Methods

toJSON :: GetSetupIntentsRequestBody -> Value

toEncoding :: GetSetupIntentsRequestBody -> Encoding

toJSONList :: [GetSetupIntentsRequestBody] -> Value

toEncodingList :: [GetSetupIntentsRequestBody] -> Encoding

FromJSON GetSetupIntentsRequestBody

Defined in StripeAPI.Operations.GetSetupIntents

Methods

parseJSON :: Value -> Parser GetSetupIntentsRequestBody

parseJSONList :: Value -> Parser [GetSetupIntentsRequestBody]

data GetSetupIntentsResponse

Represents a response of the operation getSetupIntents.

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

Constructors

GetSetupIntentsResponseError String

Means either no matching case available or a parse error

GetSetupIntentsResponse200 GetSetupIntentsResponseBody200

Successful response.

GetSetupIntentsResponseDefault Error

Error response.

Instances

Eq GetSetupIntentsResponse

Defined in StripeAPI.Operations.GetSetupIntents

Methods

(==) :: GetSetupIntentsResponse -> GetSetupIntentsResponse -> Bool

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

Show GetSetupIntentsResponse

Defined in StripeAPI.Operations.GetSetupIntents

Methods

showsPrec :: Int -> GetSetupIntentsResponse -> ShowS

show :: GetSetupIntentsResponse -> String

showList :: [GetSetupIntentsResponse] -> ShowS

data GetSetupIntentsResponseBody200

Defines the data type for the schema GetSetupIntentsResponseBody200

Constructors

GetSetupIntentsResponseBody200

Fields

• getSetupIntentsResponseBody200Data :: [] SetupIntent

  data

• getSetupIntentsResponseBody200HasMore :: Bool

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

• getSetupIntentsResponseBody200Object :: GetSetupIntentsResponseBody200Object'

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

• getSetupIntentsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetSetupIntentsResponseBody200

Defined in StripeAPI.Operations.GetSetupIntents

Methods

(==) :: GetSetupIntentsResponseBody200 -> GetSetupIntentsResponseBody200 -> Bool

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

Show GetSetupIntentsResponseBody200

Defined in StripeAPI.Operations.GetSetupIntents

Methods

showsPrec :: Int -> GetSetupIntentsResponseBody200 -> ShowS

show :: GetSetupIntentsResponseBody200 -> String

showList :: [GetSetupIntentsResponseBody200] -> ShowS

ToJSON GetSetupIntentsResponseBody200

Defined in StripeAPI.Operations.GetSetupIntents

Methods

toJSON :: GetSetupIntentsResponseBody200 -> Value

toEncoding :: GetSetupIntentsResponseBody200 -> Encoding

toJSONList :: [GetSetupIntentsResponseBody200] -> Value

toEncodingList :: [GetSetupIntentsResponseBody200] -> Encoding

FromJSON GetSetupIntentsResponseBody200

Defined in StripeAPI.Operations.GetSetupIntents

Methods

parseJSON :: Value -> Parser GetSetupIntentsResponseBody200

parseJSONList :: Value -> Parser [GetSetupIntentsResponseBody200]

data GetSetupIntentsResponseBody200Object'

Defines the enum schema GetSetupIntentsResponseBody200Object'

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

Constructors

GetSetupIntentsResponseBody200Object'EnumOther Value

GetSetupIntentsResponseBody200Object'EnumTyped Text

GetSetupIntentsResponseBody200Object'EnumStringList

Instances

Eq GetSetupIntentsResponseBody200Object'

Defined in StripeAPI.Operations.GetSetupIntents

Methods

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

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

Show GetSetupIntentsResponseBody200Object'

Defined in StripeAPI.Operations.GetSetupIntents

Methods

showsPrec :: Int -> GetSetupIntentsResponseBody200Object' -> ShowS

show :: GetSetupIntentsResponseBody200Object' -> String

showList :: [GetSetupIntentsResponseBody200Object'] -> ShowS

ToJSON GetSetupIntentsResponseBody200Object'

Defined in StripeAPI.Operations.GetSetupIntents

Methods

toJSON :: GetSetupIntentsResponseBody200Object' -> Value

toEncoding :: GetSetupIntentsResponseBody200Object' -> Encoding

toJSONList :: [GetSetupIntentsResponseBody200Object'] -> Value

toEncodingList :: [GetSetupIntentsResponseBody200Object'] -> Encoding

FromJSON GetSetupIntentsResponseBody200Object'

Defined in StripeAPI.Operations.GetSetupIntents

Methods

parseJSON :: Value -> Parser GetSetupIntentsResponseBody200Object'

parseJSONList :: Value -> Parser [GetSetupIntentsResponseBody200Object']