stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetAccounts

Description

Contains the different functions to run the operation getAccounts

Synopsis

Documentation

getAccounts Source #

Arguments

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

The configuration to use in the request

-> Maybe String

created

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

-> Maybe String

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

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

data GetAccountsResponse Source #

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.

data GetAccountsResponseBody200 Source #

Defines the data type for the schema GetAccountsResponseBody200

Constructors

GetAccountsResponseBody200 

Fields

data GetAccountsResponseBody200Object' Source #

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