StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Contains the different functions to run the operation postCustomersCustomerBalanceTransactionsTransaction

Documentation

postCustomersCustomerBalanceTransactionsTransaction

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Text

customer | Constraints: Maximum length of 5000

-> Text

transaction | Constraints: Maximum length of 5000

-> Maybe PostCustomersCustomerBalanceTransactionsTransactionRequestBody

The request body to send

-> m (Either HttpException (Response PostCustomersCustomerBalanceTransactionsTransactionResponse))

Monad containing the result of the operation

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

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

postCustomersCustomerBalanceTransactionsTransactionRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Text -> Maybe PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> m (Either HttpException (Response ByteString))

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

The same as postCustomersCustomerBalanceTransactionsTransaction but returns the raw ByteString

postCustomersCustomerBalanceTransactionsTransactionM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Text -> Maybe PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCustomersCustomerBalanceTransactionsTransactionResponse))

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

Monadic version of postCustomersCustomerBalanceTransactionsTransaction (use with runWithConfiguration)

postCustomersCustomerBalanceTransactionsTransactionRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Text -> Maybe PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

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

Monadic version of postCustomersCustomerBalanceTransactionsTransactionRaw (use with runWithConfiguration)

data PostCustomersCustomerBalanceTransactionsTransactionRequestBody

Defines the data type for the schema postCustomersCustomerBalanceTransactionsTransactionRequestBody

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'

  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

Eq PostCustomersCustomerBalanceTransactionsTransactionRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Methods

(==) :: PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> Bool

(/=) :: PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> Bool

Show PostCustomersCustomerBalanceTransactionsTransactionRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Methods

showsPrec :: Int -> PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> ShowS

show :: PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> String

showList :: [PostCustomersCustomerBalanceTransactionsTransactionRequestBody] -> ShowS

ToJSON PostCustomersCustomerBalanceTransactionsTransactionRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Methods

toJSON :: PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> Value

toEncoding :: PostCustomersCustomerBalanceTransactionsTransactionRequestBody -> Encoding

toJSONList :: [PostCustomersCustomerBalanceTransactionsTransactionRequestBody] -> Value

toEncodingList :: [PostCustomersCustomerBalanceTransactionsTransactionRequestBody] -> Encoding

FromJSON PostCustomersCustomerBalanceTransactionsTransactionRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Methods

parseJSON :: Value -> Parser PostCustomersCustomerBalanceTransactionsTransactionRequestBody

parseJSONList :: Value -> Parser [PostCustomersCustomerBalanceTransactionsTransactionRequestBody]

data PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'

Defines the data type for the schema postCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'

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'

Instances

Eq PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Methods

(==) :: PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata' -> PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata' -> Bool

(/=) :: PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata' -> PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata' -> Bool

Show PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Methods

showsPrec :: Int -> PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata' -> ShowS

show :: PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata' -> String

showList :: [PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'] -> ShowS

ToJSON PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Methods

toJSON :: PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata' -> Value

toEncoding :: PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata' -> Encoding

toJSONList :: [PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'] -> Value

toEncodingList :: [PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'] -> Encoding

FromJSON PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Methods

parseJSON :: Value -> Parser PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata'

parseJSONList :: Value -> Parser [PostCustomersCustomerBalanceTransactionsTransactionRequestBodyMetadata']

data PostCustomersCustomerBalanceTransactionsTransactionResponse

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

Eq PostCustomersCustomerBalanceTransactionsTransactionResponse

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Methods

(==) :: PostCustomersCustomerBalanceTransactionsTransactionResponse -> PostCustomersCustomerBalanceTransactionsTransactionResponse -> Bool

(/=) :: PostCustomersCustomerBalanceTransactionsTransactionResponse -> PostCustomersCustomerBalanceTransactionsTransactionResponse -> Bool

Show PostCustomersCustomerBalanceTransactionsTransactionResponse

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactionsTransaction

Methods

showsPrec :: Int -> PostCustomersCustomerBalanceTransactionsTransactionResponse -> ShowS

show :: PostCustomersCustomerBalanceTransactionsTransactionResponse -> String

showList :: [PostCustomersCustomerBalanceTransactionsTransactionResponse] -> ShowS