StripeAPI.Operations.GetAccounts

Contains the different functions to run the operation getAccounts

Documentation

getAccounts

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

created

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

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

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.

-> Maybe GetAccountsRequestBody

The request body to send

-> m (Either HttpException (Response GetAccountsResponse))

Monad containing the result of the operation

GET /v1/accounts

<p>Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>. If you’re not a platform, the list is empty.</p>

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

GET /v1/accounts

The same as getAccounts but returns the raw ByteString

getAccountsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetAccountsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetAccountsResponse))

GET /v1/accounts

Monadic version of getAccounts (use with runWithConfiguration)

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

GET /v1/accounts

Monadic version of getAccountsRaw (use with runWithConfiguration)

data GetAccountsRequestBody

Defines the data type for the schema getAccountsRequestBody

Constructors

GetAccountsRequestBody

Instances

Eq GetAccountsRequestBody

Defined in StripeAPI.Operations.GetAccounts

Methods

(==) :: GetAccountsRequestBody -> GetAccountsRequestBody -> Bool

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

Show GetAccountsRequestBody

Defined in StripeAPI.Operations.GetAccounts

Methods

showsPrec :: Int -> GetAccountsRequestBody -> ShowS

show :: GetAccountsRequestBody -> String

showList :: [GetAccountsRequestBody] -> ShowS

ToJSON GetAccountsRequestBody

Defined in StripeAPI.Operations.GetAccounts

Methods

toJSON :: GetAccountsRequestBody -> Value

toEncoding :: GetAccountsRequestBody -> Encoding

toJSONList :: [GetAccountsRequestBody] -> Value

toEncodingList :: [GetAccountsRequestBody] -> Encoding

FromJSON GetAccountsRequestBody

Defined in StripeAPI.Operations.GetAccounts

Methods

parseJSON :: Value -> Parser GetAccountsRequestBody

parseJSONList :: Value -> Parser [GetAccountsRequestBody]

data GetAccountsResponse

Represents a response of the operation getAccounts.

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

Constructors

GetAccountsResponseError String

Means either no matching case available or a parse error

GetAccountsResponse200 GetAccountsResponseBody200

Successful response.

GetAccountsResponseDefault Error

Error response.

Instances

Eq GetAccountsResponse

Defined in StripeAPI.Operations.GetAccounts

Methods

(==) :: GetAccountsResponse -> GetAccountsResponse -> Bool

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

Show GetAccountsResponse

Defined in StripeAPI.Operations.GetAccounts

Methods

showsPrec :: Int -> GetAccountsResponse -> ShowS

show :: GetAccountsResponse -> String

showList :: [GetAccountsResponse] -> ShowS

data GetAccountsResponseBody200

Defines the data type for the schema GetAccountsResponseBody200

Constructors

GetAccountsResponseBody200

Fields

• getAccountsResponseBody200Data :: [] Account

  data

• getAccountsResponseBody200HasMore :: Bool

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

• getAccountsResponseBody200Object :: GetAccountsResponseBody200Object'

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

• getAccountsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetAccountsResponseBody200

Defined in StripeAPI.Operations.GetAccounts

Methods

(==) :: GetAccountsResponseBody200 -> GetAccountsResponseBody200 -> Bool

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

Show GetAccountsResponseBody200

Defined in StripeAPI.Operations.GetAccounts

Methods

showsPrec :: Int -> GetAccountsResponseBody200 -> ShowS

show :: GetAccountsResponseBody200 -> String

showList :: [GetAccountsResponseBody200] -> ShowS

ToJSON GetAccountsResponseBody200

Defined in StripeAPI.Operations.GetAccounts

Methods

toJSON :: GetAccountsResponseBody200 -> Value

toEncoding :: GetAccountsResponseBody200 -> Encoding

toJSONList :: [GetAccountsResponseBody200] -> Value

toEncodingList :: [GetAccountsResponseBody200] -> Encoding

FromJSON GetAccountsResponseBody200

Defined in StripeAPI.Operations.GetAccounts

Methods

parseJSON :: Value -> Parser GetAccountsResponseBody200

parseJSONList :: Value -> Parser [GetAccountsResponseBody200]

data GetAccountsResponseBody200Object'

Defines the enum schema GetAccountsResponseBody200Object'

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

Constructors

GetAccountsResponseBody200Object'EnumOther Value

GetAccountsResponseBody200Object'EnumTyped Text

GetAccountsResponseBody200Object'EnumStringList

Instances

Eq GetAccountsResponseBody200Object'

Defined in StripeAPI.Operations.GetAccounts

Methods

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

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

Show GetAccountsResponseBody200Object'

Defined in StripeAPI.Operations.GetAccounts

Methods

showsPrec :: Int -> GetAccountsResponseBody200Object' -> ShowS

show :: GetAccountsResponseBody200Object' -> String

showList :: [GetAccountsResponseBody200Object'] -> ShowS

ToJSON GetAccountsResponseBody200Object'

Defined in StripeAPI.Operations.GetAccounts

Methods

toJSON :: GetAccountsResponseBody200Object' -> Value

toEncoding :: GetAccountsResponseBody200Object' -> Encoding

toJSONList :: [GetAccountsResponseBody200Object'] -> Value

toEncodingList :: [GetAccountsResponseBody200Object'] -> Encoding

FromJSON GetAccountsResponseBody200Object'

Defined in StripeAPI.Operations.GetAccounts

Methods

parseJSON :: Value -> Parser GetAccountsResponseBody200Object'

parseJSONList :: Value -> Parser [GetAccountsResponseBody200Object']