stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetAccountPeople

Description

Contains the different functions to run the operation getAccountPeople

Synopsis

Documentation

getAccountPeople Source #

Arguments

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

The configuration to use in the request

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

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

relationship: Filters on the list of people returned based on the person's relationship to the account's company.

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

-> GetAccountPeopleRequestBody

The request body to send

-> m (Either HttpException (Response GetAccountPeopleResponse))

Monad containing the result of the operation

GET /v1/account/people

<p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>

data GetAccountPeopleResponse Source #

Represents a response of the operation getAccountPeople.

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

Constructors

GetAccountPeopleResponseError String

Means either no matching case available or a parse error

GetAccountPeopleResponse200 GetAccountPeopleResponseBody200

Successful response.

GetAccountPeopleResponseDefault Error

Error response.

data GetAccountPeopleResponseBody200 Source #

Defines the data type for the schema GetAccountPeopleResponseBody200

Constructors

GetAccountPeopleResponseBody200 

Fields

data GetAccountPeopleResponseBody200Object' Source #

Defines the enum schema GetAccountPeopleResponseBody200Object'

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