Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetCustomersCustomerBalanceTransactions

Description

Contains the different functions to run the operation getCustomersCustomerBalanceTransactions

Synopsis

getCustomersCustomerBalanceTransactions :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerBalanceTransactionsRequestBody -> m (Either HttpException (Response GetCustomersCustomerBalanceTransactionsResponse))
getCustomersCustomerBalanceTransactionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerBalanceTransactionsRequestBody -> m (Either HttpException (Response ByteString))
getCustomersCustomerBalanceTransactionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerBalanceTransactionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCustomersCustomerBalanceTransactionsResponse))
getCustomersCustomerBalanceTransactionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerBalanceTransactionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetCustomersCustomerBalanceTransactionsRequestBody = GetCustomersCustomerBalanceTransactionsRequestBody {
}
data GetCustomersCustomerBalanceTransactionsResponse
data GetCustomersCustomerBalanceTransactionsResponseBody200 = GetCustomersCustomerBalanceTransactionsResponseBody200 {
}
data GetCustomersCustomerBalanceTransactionsResponseBody200Object'

Documentation

getCustomersCustomerBalanceTransactions Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	customer \| 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	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 GetCustomersCustomerBalanceTransactionsRequestBody	The request body to send
-> m (Either HttpException (Response GetCustomersCustomerBalanceTransactionsResponse))	Monad containing the result of the operation

GET /v1/customers/{customer}/balance_transactions

<p>Returns a list of transactions that updated the customer’s <a href="/docs/api/customers/object#customer_object-balance"><code>balance</code></a>.</p>

getCustomersCustomerBalanceTransactionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerBalanceTransactionsRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/customers/{customer}/balance_transactions

The same as getCustomersCustomerBalanceTransactions but returns the raw ByteString

getCustomersCustomerBalanceTransactionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerBalanceTransactionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCustomersCustomerBalanceTransactionsResponse)) Source #

GET /v1/customers/{customer}/balance_transactions

Monadic version of getCustomersCustomerBalanceTransactions (use with runWithConfiguration)

getCustomersCustomerBalanceTransactionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCustomersCustomerBalanceTransactionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

GET /v1/customers/{customer}/balance_transactions

Monadic version of getCustomersCustomerBalanceTransactionsRaw (use with runWithConfiguration)

data GetCustomersCustomerBalanceTransactionsRequestBody Source #

Defines the data type for the schema getCustomersCustomerBalanceTransactionsRequestBody

Constructors

GetCustomersCustomerBalanceTransactionsRequestBody

Instances

Eq GetCustomersCustomerBalanceTransactionsRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods (==) :: GetCustomersCustomerBalanceTransactionsRequestBody -> GetCustomersCustomerBalanceTransactionsRequestBody -> Bool # (/=) :: GetCustomersCustomerBalanceTransactionsRequestBody -> GetCustomersCustomerBalanceTransactionsRequestBody -> Bool #
Show GetCustomersCustomerBalanceTransactionsRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods showsPrec :: Int -> GetCustomersCustomerBalanceTransactionsRequestBody -> ShowS # show :: GetCustomersCustomerBalanceTransactionsRequestBody -> String # showList :: [GetCustomersCustomerBalanceTransactionsRequestBody] -> ShowS #
ToJSON GetCustomersCustomerBalanceTransactionsRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods toJSON :: GetCustomersCustomerBalanceTransactionsRequestBody -> Value # toEncoding :: GetCustomersCustomerBalanceTransactionsRequestBody -> Encoding # toJSONList :: [GetCustomersCustomerBalanceTransactionsRequestBody] -> Value # toEncodingList :: [GetCustomersCustomerBalanceTransactionsRequestBody] -> Encoding #
FromJSON GetCustomersCustomerBalanceTransactionsRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods parseJSON :: Value -> Parser GetCustomersCustomerBalanceTransactionsRequestBody # parseJSONList :: Value -> Parser [GetCustomersCustomerBalanceTransactionsRequestBody] #

data GetCustomersCustomerBalanceTransactionsResponse Source #

Represents a response of the operation getCustomersCustomerBalanceTransactions.

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

Constructors

GetCustomersCustomerBalanceTransactionsResponseError String	Means either no matching case available or a parse error
GetCustomersCustomerBalanceTransactionsResponse200 GetCustomersCustomerBalanceTransactionsResponseBody200	Successful response.
GetCustomersCustomerBalanceTransactionsResponseDefault Error	Error response.

Instances

Eq GetCustomersCustomerBalanceTransactionsResponse Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods (==) :: GetCustomersCustomerBalanceTransactionsResponse -> GetCustomersCustomerBalanceTransactionsResponse -> Bool # (/=) :: GetCustomersCustomerBalanceTransactionsResponse -> GetCustomersCustomerBalanceTransactionsResponse -> Bool #
Show GetCustomersCustomerBalanceTransactionsResponse Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods showsPrec :: Int -> GetCustomersCustomerBalanceTransactionsResponse -> ShowS # show :: GetCustomersCustomerBalanceTransactionsResponse -> String # showList :: [GetCustomersCustomerBalanceTransactionsResponse] -> ShowS #

data GetCustomersCustomerBalanceTransactionsResponseBody200 Source #

Defines the data type for the schema GetCustomersCustomerBalanceTransactionsResponseBody200

Constructors

GetCustomersCustomerBalanceTransactionsResponseBody200

Fields

getCustomersCustomerBalanceTransactionsResponseBody200Data :: [] CustomerBalanceTransaction
data: Details about each object.
getCustomersCustomerBalanceTransactionsResponseBody200HasMore :: Bool
has_more: True if this list has another page of items after this one that can be fetched.
getCustomersCustomerBalanceTransactionsResponseBody200Object :: GetCustomersCustomerBalanceTransactionsResponseBody200Object'
object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
getCustomersCustomerBalanceTransactionsResponseBody200Url :: Text
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000

Instances

Eq GetCustomersCustomerBalanceTransactionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods (==) :: GetCustomersCustomerBalanceTransactionsResponseBody200 -> GetCustomersCustomerBalanceTransactionsResponseBody200 -> Bool # (/=) :: GetCustomersCustomerBalanceTransactionsResponseBody200 -> GetCustomersCustomerBalanceTransactionsResponseBody200 -> Bool #
Show GetCustomersCustomerBalanceTransactionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods showsPrec :: Int -> GetCustomersCustomerBalanceTransactionsResponseBody200 -> ShowS # show :: GetCustomersCustomerBalanceTransactionsResponseBody200 -> String # showList :: [GetCustomersCustomerBalanceTransactionsResponseBody200] -> ShowS #
ToJSON GetCustomersCustomerBalanceTransactionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods toJSON :: GetCustomersCustomerBalanceTransactionsResponseBody200 -> Value # toEncoding :: GetCustomersCustomerBalanceTransactionsResponseBody200 -> Encoding # toJSONList :: [GetCustomersCustomerBalanceTransactionsResponseBody200] -> Value # toEncodingList :: [GetCustomersCustomerBalanceTransactionsResponseBody200] -> Encoding #
FromJSON GetCustomersCustomerBalanceTransactionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods parseJSON :: Value -> Parser GetCustomersCustomerBalanceTransactionsResponseBody200 # parseJSONList :: Value -> Parser [GetCustomersCustomerBalanceTransactionsResponseBody200] #

data GetCustomersCustomerBalanceTransactionsResponseBody200Object' Source #

Defines the enum schema GetCustomersCustomerBalanceTransactionsResponseBody200Object'

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

Constructors

GetCustomersCustomerBalanceTransactionsResponseBody200Object'EnumOther Value
GetCustomersCustomerBalanceTransactionsResponseBody200Object'EnumTyped Text
GetCustomersCustomerBalanceTransactionsResponseBody200Object'EnumStringList

Instances

Eq GetCustomersCustomerBalanceTransactionsResponseBody200Object' Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods (==) :: GetCustomersCustomerBalanceTransactionsResponseBody200Object' -> GetCustomersCustomerBalanceTransactionsResponseBody200Object' -> Bool # (/=) :: GetCustomersCustomerBalanceTransactionsResponseBody200Object' -> GetCustomersCustomerBalanceTransactionsResponseBody200Object' -> Bool #
Show GetCustomersCustomerBalanceTransactionsResponseBody200Object' Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods showsPrec :: Int -> GetCustomersCustomerBalanceTransactionsResponseBody200Object' -> ShowS # show :: GetCustomersCustomerBalanceTransactionsResponseBody200Object' -> String # showList :: [GetCustomersCustomerBalanceTransactionsResponseBody200Object'] -> ShowS #
ToJSON GetCustomersCustomerBalanceTransactionsResponseBody200Object' Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods toJSON :: GetCustomersCustomerBalanceTransactionsResponseBody200Object' -> Value # toEncoding :: GetCustomersCustomerBalanceTransactionsResponseBody200Object' -> Encoding # toJSONList :: [GetCustomersCustomerBalanceTransactionsResponseBody200Object'] -> Value # toEncodingList :: [GetCustomersCustomerBalanceTransactionsResponseBody200Object'] -> Encoding #
FromJSON GetCustomersCustomerBalanceTransactionsResponseBody200Object' Source #
Instance details Defined in StripeAPI.Operations.GetCustomersCustomerBalanceTransactions Methods parseJSON :: Value -> Parser GetCustomersCustomerBalanceTransactionsResponseBody200Object' # parseJSONList :: Value -> Parser [GetCustomersCustomerBalanceTransactionsResponseBody200Object'] #