Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Description

Contains the different functions to run the operation postCustomersCustomerBalanceTransactionsTransaction

Synopsis

postCustomersCustomerBalanceTransactionsTransaction :: forall m. MonadHTTP m => PostCustomersCustomerBalanceTransactionsTransactionParameters -> Maybe PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> ClientT m (Response PostCustomersCustomerBalanceTransactionsTransactionResponse)
data PostCustomersCustomerBalanceTransactionsTransactionParameters = PostCustomersCustomerBalanceTransactionsTransactionParameters {
- postCustomersCustomerBalanceTransactionsTransactionParametersPathCustomer :: Text
- postCustomersCustomerBalanceTransactionsTransactionParametersPathTransaction :: Text
}
mkPostCustomersCustomerBalanceTransactionsTransactionParameters :: Text -> Text -> PostCustomersCustomerBalanceTransactionsTransactionParameters
data PostCustomersCustomerBalanceTransactionsTransactionRequestBody = PostCustomersCustomerBalanceTransactionsTransactionRequestBody {
}
mkPostCustomersCustomerBalanceTransactionsTransactionRequestBody :: PostCustomersCustomerBalanceTransactionsTransactionRequestBody
data PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'Variants
- = PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'EmptyString
- | PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'Object Object
data PostCustomersCustomerBalanceTransactionsTransactionResponse

Documentation

postCustomersCustomerBalanceTransactionsTransaction Source #

Arguments

:: forall m. MonadHTTP m
=> PostCustomersCustomerBalanceTransactionsTransactionParameters	Contains all available parameters of this operation (query and path parameters)
-> Maybe PostCustomersCustomerBalanceTransactionsTransactionRequestBody	The request body to send
-> ClientT m (Response PostCustomersCustomerBalanceTransactionsTransactionResponse)	Monadic computation which returns the result of the operation

POST /v1/customers/{customer}/balance_transactions/{transaction}

<p>Most credit balance transaction fields are immutable, but you may update its <code>description</code> and <code>metadata</code>.</p>

data PostCustomersCustomerBalanceTransactionsTransactionParameters Source #

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

Constructors

PostCustomersCustomerBalanceTransactionsTransactionParameters
Fields postCustomersCustomerBalanceTransactionsTransactionParametersPathCustomer :: Text pathCustomer: Represents the parameter named 'customer' Constraints: Maximum length of 5000 postCustomersCustomerBalanceTransactionsTransactionParametersPathTransaction :: Text pathTransaction: Represents the parameter named 'transaction' Constraints: Maximum length of 5000

Instances

Instances details

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

mkPostCustomersCustomerBalanceTransactionsTransactionParameters Source #

Arguments

:: Text	`postCustomersCustomerBalanceTransactionsTransactionParametersPathCustomer`
-> Text	`postCustomersCustomerBalanceTransactionsTransactionParametersPathTransaction`
-> PostCustomersCustomerBalanceTransactionsTransactionParameters

Create a new PostCustomersCustomerBalanceTransactionsTransactionParameters with all required fields.

data PostCustomersCustomerBalanceTransactionsTransactionRequestBody Source #

Defines the object schema located at paths./v1/customers/{customer}/balance_transactions/{transaction}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostCustomersCustomerBalanceTransactionsTransactionRequestBody

Fields

postCustomersCustomerBalanceTransactionsTransactionRequestBodyDescription :: Maybe Text
description: An arbitrary string attached to the object. Often useful for displaying to users.
Constraints:
- Maximum length of 350
postCustomersCustomerBalanceTransactionsTransactionRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata :: Maybe PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'Variants
metadata: 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`.

Instances

Instances details

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

mkPostCustomersCustomerBalanceTransactionsTransactionRequestBody :: PostCustomersCustomerBalanceTransactionsTransactionRequestBody Source #

Create a new PostCustomersCustomerBalanceTransactionsTransactionRequestBody with all required fields.

data PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'Variants Source #

Defines the oneOf schema located at paths./v1/customers/{customer}/balance_transactions/{transaction}.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

PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'EmptyString	Represents the JSON value `""`
PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'Object Object

Instances

Instances details

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

data PostCustomersCustomerBalanceTransactionsTransactionResponse Source #

Represents a response of the operation postCustomersCustomerBalanceTransactionsTransaction.

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

Constructors

PostCustomersCustomerBalanceTransactionsTransactionResponseError String	Means either no matching case available or a parse error
PostCustomersCustomerBalanceTransactionsTransactionResponse200 CustomerBalanceTransaction	Successful response.
PostCustomersCustomerBalanceTransactionsTransactionResponseDefault Error	Error response.

Instances

Instances details

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