StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Contains the different functions to run the operation postCustomersCustomerBalanceTransactions

Documentation

postCustomersCustomerBalanceTransactions

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Text

customer | Constraints: Maximum length of 5000

-> PostCustomersCustomerBalanceTransactionsRequestBody

The request body to send

-> m (Either HttpException (Response PostCustomersCustomerBalanceTransactionsResponse))

Monad containing the result of the operation

POST /v1/customers/{customer}/balance_transactions

<p>Creates an immutable transaction that updates the customer’s <a href="/docs/api/customers/object#customer_object-balance"><code>balance</code></a>.</p>

postCustomersCustomerBalanceTransactionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> PostCustomersCustomerBalanceTransactionsRequestBody -> m (Either HttpException (Response ByteString))

POST /v1/customers/{customer}/balance_transactions

The same as postCustomersCustomerBalanceTransactions but returns the raw ByteString

postCustomersCustomerBalanceTransactionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> PostCustomersCustomerBalanceTransactionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCustomersCustomerBalanceTransactionsResponse))

POST /v1/customers/{customer}/balance_transactions

Monadic version of postCustomersCustomerBalanceTransactions (use with runWithConfiguration)

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

POST /v1/customers/{customer}/balance_transactions

Monadic version of postCustomersCustomerBalanceTransactionsRaw (use with runWithConfiguration)

data PostCustomersCustomerBalanceTransactionsRequestBody

Defines the data type for the schema postCustomersCustomerBalanceTransactionsRequestBody

Constructors

PostCustomersCustomerBalanceTransactionsRequestBody

Fields

• postCustomersCustomerBalanceTransactionsRequestBodyAmount :: Integer

  amount: The integer amount in **%s** to apply to the customer's balance. Pass a negative amount to credit the customer's balance, and pass in a positive amount to debit the customer's balance.

• postCustomersCustomerBalanceTransactionsRequestBodyCurrency :: Text

  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency. If the customer's `currency` is set, this value must match it. If the customer's `currency` is not set, it will be updated to this value.

• postCustomersCustomerBalanceTransactionsRequestBodyDescription :: Maybe Text

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 350
• postCustomersCustomerBalanceTransactionsRequestBodyExpand :: Maybe ([] Text)

  expand: Specifies which fields in the response should be expanded.

• postCustomersCustomerBalanceTransactionsRequestBodyMetadata :: Maybe PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'

  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 PostCustomersCustomerBalanceTransactionsRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Methods

(==) :: PostCustomersCustomerBalanceTransactionsRequestBody -> PostCustomersCustomerBalanceTransactionsRequestBody -> Bool

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

Show PostCustomersCustomerBalanceTransactionsRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Methods

showsPrec :: Int -> PostCustomersCustomerBalanceTransactionsRequestBody -> ShowS

show :: PostCustomersCustomerBalanceTransactionsRequestBody -> String

showList :: [PostCustomersCustomerBalanceTransactionsRequestBody] -> ShowS

ToJSON PostCustomersCustomerBalanceTransactionsRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Methods

toJSON :: PostCustomersCustomerBalanceTransactionsRequestBody -> Value

toEncoding :: PostCustomersCustomerBalanceTransactionsRequestBody -> Encoding

toJSONList :: [PostCustomersCustomerBalanceTransactionsRequestBody] -> Value

toEncodingList :: [PostCustomersCustomerBalanceTransactionsRequestBody] -> Encoding

FromJSON PostCustomersCustomerBalanceTransactionsRequestBody

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerBalanceTransactionsRequestBody

parseJSONList :: Value -> Parser [PostCustomersCustomerBalanceTransactionsRequestBody]

data PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'

Defines the data type for the schema postCustomersCustomerBalanceTransactionsRequestBodyMetadata'

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'

Instances

Eq PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Methods

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

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

Show PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Methods

showsPrec :: Int -> PostCustomersCustomerBalanceTransactionsRequestBodyMetadata' -> ShowS

show :: PostCustomersCustomerBalanceTransactionsRequestBodyMetadata' -> String

showList :: [PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'] -> ShowS

ToJSON PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Methods

toJSON :: PostCustomersCustomerBalanceTransactionsRequestBodyMetadata' -> Value

toEncoding :: PostCustomersCustomerBalanceTransactionsRequestBodyMetadata' -> Encoding

toJSONList :: [PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'] -> Value

toEncodingList :: [PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'] -> Encoding

FromJSON PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Methods

parseJSON :: Value -> Parser PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'

parseJSONList :: Value -> Parser [PostCustomersCustomerBalanceTransactionsRequestBodyMetadata']

data PostCustomersCustomerBalanceTransactionsResponse

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.

Instances

Eq PostCustomersCustomerBalanceTransactionsResponse

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Methods

(==) :: PostCustomersCustomerBalanceTransactionsResponse -> PostCustomersCustomerBalanceTransactionsResponse -> Bool

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

Show PostCustomersCustomerBalanceTransactionsResponse

Defined in StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Methods

showsPrec :: Int -> PostCustomersCustomerBalanceTransactionsResponse -> ShowS

show :: PostCustomersCustomerBalanceTransactionsResponse -> String

showList :: [PostCustomersCustomerBalanceTransactionsResponse] -> ShowS