Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostApplicationFeesIdRefunds

Description

Contains the different functions to run the operation postApplicationFeesIdRefunds

Synopsis

postApplicationFeesIdRefunds :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostApplicationFeesIdRefundsRequestBody -> m (Either HttpException (Response PostApplicationFeesIdRefundsResponse))
postApplicationFeesIdRefundsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostApplicationFeesIdRefundsRequestBody -> m (Either HttpException (Response ByteString))
postApplicationFeesIdRefundsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostApplicationFeesIdRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostApplicationFeesIdRefundsResponse))
postApplicationFeesIdRefundsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostApplicationFeesIdRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostApplicationFeesIdRefundsRequestBody = PostApplicationFeesIdRefundsRequestBody {
}
data PostApplicationFeesIdRefundsRequestBodyMetadata' = PostApplicationFeesIdRefundsRequestBodyMetadata' {
}
data PostApplicationFeesIdRefundsResponse

Documentation

postApplicationFeesIdRefunds Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	id \| Constraints: Maximum length of 5000
-> Maybe PostApplicationFeesIdRefundsRequestBody	The request body to send
-> m (Either HttpException (Response PostApplicationFeesIdRefundsResponse))	Monad containing the result of the operation

POST /v1/application_fees/{id}/refunds

Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.

Once entirely refunded, an application fee can’t be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.

postApplicationFeesIdRefundsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostApplicationFeesIdRefundsRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/application_fees/{id}/refunds

The same as postApplicationFeesIdRefunds but returns the raw ByteString

postApplicationFeesIdRefundsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostApplicationFeesIdRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostApplicationFeesIdRefundsResponse)) Source #

POST /v1/application_fees/{id}/refunds

Monadic version of postApplicationFeesIdRefunds (use with runWithConfiguration)

postApplicationFeesIdRefundsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostApplicationFeesIdRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/application_fees/{id}/refunds

Monadic version of postApplicationFeesIdRefundsRaw (use with runWithConfiguration)

data PostApplicationFeesIdRefundsRequestBody Source #

Defines the data type for the schema postApplicationFeesIdRefundsRequestBody

Constructors

PostApplicationFeesIdRefundsRequestBody

Fields

postApplicationFeesIdRefundsRequestBodyAmount :: Maybe Integer
amount: A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.
postApplicationFeesIdRefundsRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postApplicationFeesIdRefundsRequestBodyMetadata :: Maybe PostApplicationFeesIdRefundsRequestBodyMetadata'
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 PostApplicationFeesIdRefundsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostApplicationFeesIdRefunds Methods (==) :: PostApplicationFeesIdRefundsRequestBody -> PostApplicationFeesIdRefundsRequestBody -> Bool # (/=) :: PostApplicationFeesIdRefundsRequestBody -> PostApplicationFeesIdRefundsRequestBody -> Bool #
Show PostApplicationFeesIdRefundsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostApplicationFeesIdRefunds Methods showsPrec :: Int -> PostApplicationFeesIdRefundsRequestBody -> ShowS # show :: PostApplicationFeesIdRefundsRequestBody -> String # showList :: [PostApplicationFeesIdRefundsRequestBody] -> ShowS #
ToJSON PostApplicationFeesIdRefundsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostApplicationFeesIdRefunds Methods toJSON :: PostApplicationFeesIdRefundsRequestBody -> Value # toEncoding :: PostApplicationFeesIdRefundsRequestBody -> Encoding # toJSONList :: [PostApplicationFeesIdRefundsRequestBody] -> Value # toEncodingList :: [PostApplicationFeesIdRefundsRequestBody] -> Encoding #
FromJSON PostApplicationFeesIdRefundsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostApplicationFeesIdRefunds Methods parseJSON :: Value -> Parser PostApplicationFeesIdRefundsRequestBody # parseJSONList :: Value -> Parser [PostApplicationFeesIdRefundsRequestBody] #

data PostApplicationFeesIdRefundsRequestBodyMetadata' Source #

Defines the data type for the schema postApplicationFeesIdRefundsRequestBodyMetadata'

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

PostApplicationFeesIdRefundsRequestBodyMetadata'

Instances

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

data PostApplicationFeesIdRefundsResponse Source #

Represents a response of the operation postApplicationFeesIdRefunds.

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

Constructors

PostApplicationFeesIdRefundsResponseError String	Means either no matching case available or a parse error
PostApplicationFeesIdRefundsResponse200 FeeRefund	Successful response.
PostApplicationFeesIdRefundsResponseDefault Error	Error response.

Instances

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