Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetCustomersCustomerBalanceTransactions

Description

Contains the different functions to run the operation getCustomersCustomerBalanceTransactions

Synopsis

getCustomersCustomerBalanceTransactions :: forall m. MonadHTTP m => GetCustomersCustomerBalanceTransactionsParameters -> ClientT m (Response GetCustomersCustomerBalanceTransactionsResponse)
data GetCustomersCustomerBalanceTransactionsParameters = GetCustomersCustomerBalanceTransactionsParameters {
}
mkGetCustomersCustomerBalanceTransactionsParameters :: Text -> GetCustomersCustomerBalanceTransactionsParameters
data GetCustomersCustomerBalanceTransactionsResponse
data GetCustomersCustomerBalanceTransactionsResponseBody200 = GetCustomersCustomerBalanceTransactionsResponseBody200 {
}
mkGetCustomersCustomerBalanceTransactionsResponseBody200 :: [CustomerBalanceTransaction] -> Bool -> Text -> GetCustomersCustomerBalanceTransactionsResponseBody200

Documentation

getCustomersCustomerBalanceTransactions Source #

Arguments

:: forall m. MonadHTTP m
=> GetCustomersCustomerBalanceTransactionsParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetCustomersCustomerBalanceTransactionsResponse)	Monadic computation which returns 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/billing/customer/balance">balances</a>.</p>

data GetCustomersCustomerBalanceTransactionsParameters Source #

Defines the object schema located at paths./v1/customers/{customer}/balance_transactions.GET.parameters in the specification.

Constructors

GetCustomersCustomerBalanceTransactionsParameters

Fields

getCustomersCustomerBalanceTransactionsParametersPathCustomer :: Text
pathCustomer: Represents the parameter named 'customer'
Constraints:
- Maximum length of 5000
getCustomersCustomerBalanceTransactionsParametersQueryEndingBefore :: 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.
Constraints:
- Maximum length of 5000
getCustomersCustomerBalanceTransactionsParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getCustomersCustomerBalanceTransactionsParametersQueryLimit :: 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.
getCustomersCustomerBalanceTransactionsParametersQueryStartingAfter :: 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.
Constraints:
- Maximum length of 5000

Instances

Instances details

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

mkGetCustomersCustomerBalanceTransactionsParameters Source #

Arguments

:: Text	`getCustomersCustomerBalanceTransactionsParametersPathCustomer`
-> GetCustomersCustomerBalanceTransactionsParameters

Create a new GetCustomersCustomerBalanceTransactionsParameters with all required fields.

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

Instances details

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

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.
getCustomersCustomerBalanceTransactionsResponseBody200Url :: Text
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000

Instances

Instances details

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

mkGetCustomersCustomerBalanceTransactionsResponseBody200 Source #

Arguments

:: [CustomerBalanceTransaction]	`getCustomersCustomerBalanceTransactionsResponseBody200Data`
-> Bool	`getCustomersCustomerBalanceTransactionsResponseBody200HasMore`
-> Text	`getCustomersCustomerBalanceTransactionsResponseBody200Url`
-> GetCustomersCustomerBalanceTransactionsResponseBody200

Create a new GetCustomersCustomerBalanceTransactionsResponseBody200 with all required fields.