StripeAPI.Operations.GetAccounts

Contains the different functions to run the operation getAccounts

Documentation

getAccounts

Arguments

:: forall m. MonadHTTP m

=> GetAccountsParameters

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

-> ClientT m (Response GetAccountsResponse)

Monadic computation which returns 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>

data GetAccountsParameters

Defines the object schema located at paths./v1/accounts.GET.parameters in the specification.

Constructors

GetAccountsParameters

Fields

• getAccountsParametersQueryCreated :: Maybe GetAccountsParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

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

• getAccountsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

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

• getAccountsParametersQueryStartingAfter :: 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 GetAccountsParameters

Defined in StripeAPI.Operations.GetAccounts

Methods

(==) :: GetAccountsParameters -> GetAccountsParameters -> Bool

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

Show GetAccountsParameters

Defined in StripeAPI.Operations.GetAccounts

Methods

showsPrec :: Int -> GetAccountsParameters -> ShowS

show :: GetAccountsParameters -> String

showList :: [GetAccountsParameters] -> ShowS

ToJSON GetAccountsParameters

Defined in StripeAPI.Operations.GetAccounts

Methods

toJSON :: GetAccountsParameters -> Value

toEncoding :: GetAccountsParameters -> Encoding

toJSONList :: [GetAccountsParameters] -> Value

toEncodingList :: [GetAccountsParameters] -> Encoding

FromJSON GetAccountsParameters

Defined in StripeAPI.Operations.GetAccounts

Methods

parseJSON :: Value -> Parser GetAccountsParameters

parseJSONList :: Value -> Parser [GetAccountsParameters]

mkGetAccountsParameters :: GetAccountsParameters

Create a new GetAccountsParameters with all required fields.

data GetAccountsParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/accounts.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetAccountsParametersQueryCreated'OneOf1

Fields

• getAccountsParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getAccountsParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getAccountsParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getAccountsParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetAccountsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetAccounts

Methods

(==) :: GetAccountsParametersQueryCreated'OneOf1 -> GetAccountsParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetAccountsParametersQueryCreated'OneOf1 -> GetAccountsParametersQueryCreated'OneOf1 -> Bool

Show GetAccountsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetAccounts

Methods

showsPrec :: Int -> GetAccountsParametersQueryCreated'OneOf1 -> ShowS

show :: GetAccountsParametersQueryCreated'OneOf1 -> String

showList :: [GetAccountsParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetAccountsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetAccounts

Methods

toJSON :: GetAccountsParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetAccountsParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetAccountsParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetAccountsParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetAccountsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetAccounts

Methods

parseJSON :: Value -> Parser GetAccountsParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetAccountsParametersQueryCreated'OneOf1]

mkGetAccountsParametersQueryCreated'OneOf1 :: GetAccountsParametersQueryCreated'OneOf1

Create a new GetAccountsParametersQueryCreated'OneOf1 with all required fields.

data GetAccountsParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/accounts.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetAccountsParametersQueryCreated'GetAccountsParametersQueryCreated'OneOf1 GetAccountsParametersQueryCreated'OneOf1

GetAccountsParametersQueryCreated'Int Int

Instances

Eq GetAccountsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetAccounts

Methods

(==) :: GetAccountsParametersQueryCreated'Variants -> GetAccountsParametersQueryCreated'Variants -> Bool

(/=) :: GetAccountsParametersQueryCreated'Variants -> GetAccountsParametersQueryCreated'Variants -> Bool

Show GetAccountsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetAccounts

Methods

showsPrec :: Int -> GetAccountsParametersQueryCreated'Variants -> ShowS

show :: GetAccountsParametersQueryCreated'Variants -> String

showList :: [GetAccountsParametersQueryCreated'Variants] -> ShowS

ToJSON GetAccountsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetAccounts

Methods

toJSON :: GetAccountsParametersQueryCreated'Variants -> Value

toEncoding :: GetAccountsParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetAccountsParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetAccountsParametersQueryCreated'Variants] -> Encoding

FromJSON GetAccountsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetAccounts

Methods

parseJSON :: Value -> Parser GetAccountsParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetAccountsParametersQueryCreated'Variants]

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 object schema located at paths./v1/accounts.GET.responses.200.content.application/json.schema in the specification.

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.

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

mkGetAccountsResponseBody200

Arguments

:: [Account]

getAccountsResponseBody200Data

-> Bool

getAccountsResponseBody200HasMore

-> Text

getAccountsResponseBody200Url

-> GetAccountsResponseBody200

Create a new GetAccountsResponseBody200 with all required fields.