Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetCustomersCustomerBalanceTransactions

Contains the different functions to run the operation getCustomersCustomerBalanceTransactions

Synopsis

value getCustomersCustomerBalanceTransactions
data GetCustomersCustomerBalanceTransactionsParameters
value mkGetCustomersCustomerBalanceTransactionsParameters
data GetCustomersCustomerBalanceTransactionsResponse
data GetCustomersCustomerBalanceTransactionsResponseBody200
value mkGetCustomersCustomerBalanceTransactionsResponseBody200

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetCustomersCustomerBalanceTransactions.hs

valuegetCustomersCustomerBalanceTransactions

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

datadata GetCustomersCustomerBalanceTransactionsParameters

Source#

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCustomersCustomerBalanceTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCustomersCustomerBalanceTransactions
Show GetCustomersCustomerBalanceTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCustomersCustomerBalanceTransactions
FromJSON GetCustomersCustomerBalanceTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCustomersCustomerBalanceTransactions
ToJSON GetCustomersCustomerBalanceTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCustomersCustomerBalanceTransactions

valuemkGetCustomersCustomerBalanceTransactionsParameters

:: Text
getCustomersCustomerBalanceTransactionsParametersPathCustomer
-> GetCustomersCustomerBalanceTransactionsParameters

Source#

Create a new GetCustomersCustomerBalanceTransactionsParameters with all required fields.

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

Instances2Eq, Show

Eq GetCustomersCustomerBalanceTransactionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCustomersCustomerBalanceTransactions
Show GetCustomersCustomerBalanceTransactionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCustomersCustomerBalanceTransactions

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCustomersCustomerBalanceTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCustomersCustomerBalanceTransactions
Show GetCustomersCustomerBalanceTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCustomersCustomerBalanceTransactions
FromJSON GetCustomersCustomerBalanceTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCustomersCustomerBalanceTransactions
ToJSON GetCustomersCustomerBalanceTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCustomersCustomerBalanceTransactions

valuemkGetCustomersCustomerBalanceTransactionsResponseBody200

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

Source#

Create a new GetCustomersCustomerBalanceTransactionsResponseBody200 with all required fields.