| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostCustomersCustomerBalanceTransactions
Description
Contains the different functions to run the operation postCustomersCustomerBalanceTransactions
Synopsis
- postCustomersCustomerBalanceTransactions :: forall m. MonadHTTP m => Text -> PostCustomersCustomerBalanceTransactionsRequestBody -> ClientT m (Response PostCustomersCustomerBalanceTransactionsResponse)
- data PostCustomersCustomerBalanceTransactionsRequestBody = PostCustomersCustomerBalanceTransactionsRequestBody {
- postCustomersCustomerBalanceTransactionsRequestBodyAmount :: Int
- postCustomersCustomerBalanceTransactionsRequestBodyCurrency :: Text
- postCustomersCustomerBalanceTransactionsRequestBodyDescription :: Maybe Text
- postCustomersCustomerBalanceTransactionsRequestBodyExpand :: Maybe [Text]
- postCustomersCustomerBalanceTransactionsRequestBodyMetadata :: Maybe PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'Variants
- mkPostCustomersCustomerBalanceTransactionsRequestBody :: Int -> Text -> PostCustomersCustomerBalanceTransactionsRequestBody
- data PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'Variants
- data PostCustomersCustomerBalanceTransactionsResponse
Documentation
postCustomersCustomerBalanceTransactions Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | customer | Constraints: Maximum length of 5000 |
| -> PostCustomersCustomerBalanceTransactionsRequestBody | The request body to send |
| -> ClientT m (Response PostCustomersCustomerBalanceTransactionsResponse) | Monadic computation which returns the result of the operation |
POST /v1/customers/{customer}/balance_transactions<p>Creates an immutable transaction that updates the customer’s credit <a href="/docs/billing/customer/balance">balance</a>.</p>
data PostCustomersCustomerBalanceTransactionsRequestBody Source #
Defines the object schema located at paths./v1/customers/{customer}/balance_transactions.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostCustomersCustomerBalanceTransactionsRequestBody | |
Fields
| |
Instances
mkPostCustomersCustomerBalanceTransactionsRequestBody Source #
Arguments
| :: Int | |
| -> Text | |
| -> PostCustomersCustomerBalanceTransactionsRequestBody |
Create a new PostCustomersCustomerBalanceTransactionsRequestBody with all required fields.
data PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}/balance_transactions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
Constructors
| PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'EmptyString | Represents the JSON value |
| PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'Object Object |
Instances
data PostCustomersCustomerBalanceTransactionsResponse Source #
Represents a response of the operation postCustomersCustomerBalanceTransactions.
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), PostCustomersCustomerBalanceTransactionsResponseError is used.
Constructors
| PostCustomersCustomerBalanceTransactionsResponseError String | Means either no matching case available or a parse error |
| PostCustomersCustomerBalanceTransactionsResponse200 CustomerBalanceTransaction | Successful response. |
| PostCustomersCustomerBalanceTransactionsResponseDefault Error | Error response. |