Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostCreditNotes

Description

Contains the different functions to run the operation postCreditNotes

Synopsis

postCreditNotes :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostCreditNotesRequestBody -> m (Either HttpException (Response PostCreditNotesResponse))
postCreditNotesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostCreditNotesRequestBody -> m (Either HttpException (Response ByteString))
postCreditNotesM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostCreditNotesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCreditNotesResponse))
postCreditNotesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostCreditNotesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostCreditNotesRequestBody = PostCreditNotesRequestBody {
}
data PostCreditNotesRequestBodyLines' = PostCreditNotesRequestBodyLines' {
}
data PostCreditNotesRequestBodyLines'TaxRates'OneOf1
data PostCreditNotesRequestBodyLines'TaxRates'Variants
- = PostCreditNotesRequestBodyLines'TaxRates'PostCreditNotesRequestBodyLines'TaxRates'OneOf1 PostCreditNotesRequestBodyLines'TaxRates'OneOf1
- | PostCreditNotesRequestBodyLines'TaxRates'ListText ([] Text)
data PostCreditNotesRequestBodyLines'Type'
data PostCreditNotesRequestBodyMetadata' = PostCreditNotesRequestBodyMetadata' {
}
data PostCreditNotesRequestBodyReason'
data PostCreditNotesResponse

Documentation

postCreditNotes Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> PostCreditNotesRequestBody	The request body to send
-> m (Either HttpException (Response PostCreditNotesResponse))	Monad containing the result of the operation

POST /v1/credit_notes

Issue a credit note to adjust the amount of a finalized invoice. For a <code>status=open</code> invoice, a credit note reduces its <code>amount_due</code>. For a <code>status=paid</code> invoice, a credit note does not affect its <code>amount_due</code>. Instead, it can result in any combination of the following:

<ul> <li>Refund: create a new refund (using <code>refund_amount</code>) or link an existing refund (using <code>refund</code>).</li> <li>Customer balance credit: credit the customer’s balance (using <code>credit_amount</code>) which will be automatically applied to their next invoice when it’s finalized.</li> <li>Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using <code>out_of_band_amount</code>).</li> </ul>

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s <code>pre_payment_credit_notes_amount</code> or <code>post_payment_credit_notes_amount</code> depending on its <code>status</code> at the time of credit note creation.

postCreditNotesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostCreditNotesRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/credit_notes

The same as postCreditNotes but returns the raw ByteString

postCreditNotesM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostCreditNotesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCreditNotesResponse)) Source #

POST /v1/credit_notes

Monadic version of postCreditNotes (use with runWithConfiguration)

postCreditNotesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostCreditNotesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/credit_notes

Monadic version of postCreditNotesRaw (use with runWithConfiguration)

data PostCreditNotesRequestBody Source #

Defines the data type for the schema postCreditNotesRequestBody

Constructors

PostCreditNotesRequestBody

Fields

postCreditNotesRequestBodyAmount :: Maybe Integer
amount: The integer amount in **%s** representing the total amount of the credit note.
postCreditNotesRequestBodyCreditAmount :: Maybe Integer
credit_amount: The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
postCreditNotesRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postCreditNotesRequestBodyInvoice :: Text
invoice: ID of the invoice.
Constraints:
- Maximum length of 5000
postCreditNotesRequestBodyLines :: Maybe ([] PostCreditNotesRequestBodyLines')
lines: Line items that make up the credit note.
postCreditNotesRequestBodyMemo :: Maybe Text
memo: The credit note's memo appears on the credit note PDF.
Constraints:
- Maximum length of 5000
postCreditNotesRequestBodyMetadata :: Maybe PostCreditNotesRequestBodyMetadata'
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`.
postCreditNotesRequestBodyOutOfBandAmount :: Maybe Integer
out_of_band_amount: The integer amount in **%s** representing the amount that is credited outside of Stripe.
postCreditNotesRequestBodyReason :: Maybe PostCreditNotesRequestBodyReason'
reason: Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
postCreditNotesRequestBodyRefund :: Maybe Text
refund: ID of an existing refund to link this credit note to.
postCreditNotesRequestBodyRefundAmount :: Maybe Integer
refund_amount: The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.

Instances

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

data PostCreditNotesRequestBodyLines' Source #

Defines the data type for the schema postCreditNotesRequestBodyLines'

Constructors

PostCreditNotesRequestBodyLines'

Fields

postCreditNotesRequestBodyLines'Amount :: Maybe Integer
amount
postCreditNotesRequestBodyLines'Description :: Maybe Text
description
Constraints:
- Maximum length of 5000
postCreditNotesRequestBodyLines'InvoiceLineItem :: Maybe Text
invoice_line_item
Constraints:
- Maximum length of 5000
postCreditNotesRequestBodyLines'Quantity :: Maybe Integer
quantity
postCreditNotesRequestBodyLines'TaxRates :: Maybe PostCreditNotesRequestBodyLines'TaxRates'Variants
tax_rates
postCreditNotesRequestBodyLines'Type :: PostCreditNotesRequestBodyLines'Type'
type
postCreditNotesRequestBodyLines'UnitAmount :: Maybe Integer
unit_amount
postCreditNotesRequestBodyLines'UnitAmountDecimal :: Maybe Text
unit_amount_decimal

Instances

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

data PostCreditNotesRequestBodyLines'TaxRates'OneOf1 Source #

Defines the enum schema postCreditNotesRequestBodyLines'Tax_rates'OneOf1

Constructors

PostCreditNotesRequestBodyLines'TaxRates'OneOf1EnumOther Value
PostCreditNotesRequestBodyLines'TaxRates'OneOf1EnumTyped Text
PostCreditNotesRequestBodyLines'TaxRates'OneOf1EnumString_

Instances

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

data PostCreditNotesRequestBodyLines'TaxRates'Variants Source #

Define the one-of schema postCreditNotesRequestBodyLines'Tax_rates'

Constructors

PostCreditNotesRequestBodyLines'TaxRates'PostCreditNotesRequestBodyLines'TaxRates'OneOf1 PostCreditNotesRequestBodyLines'TaxRates'OneOf1
PostCreditNotesRequestBodyLines'TaxRates'ListText ([] Text)

Instances

Eq PostCreditNotesRequestBodyLines'TaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCreditNotes Methods (==) :: PostCreditNotesRequestBodyLines'TaxRates'Variants -> PostCreditNotesRequestBodyLines'TaxRates'Variants -> Bool # (/=) :: PostCreditNotesRequestBodyLines'TaxRates'Variants -> PostCreditNotesRequestBodyLines'TaxRates'Variants -> Bool #
Show PostCreditNotesRequestBodyLines'TaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCreditNotes Methods showsPrec :: Int -> PostCreditNotesRequestBodyLines'TaxRates'Variants -> ShowS # show :: PostCreditNotesRequestBodyLines'TaxRates'Variants -> String # showList :: [PostCreditNotesRequestBodyLines'TaxRates'Variants] -> ShowS #
Generic PostCreditNotesRequestBodyLines'TaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCreditNotes Associated Types type Rep PostCreditNotesRequestBodyLines'TaxRates'Variants :: Type -> Type # Methods from :: PostCreditNotesRequestBodyLines'TaxRates'Variants -> Rep PostCreditNotesRequestBodyLines'TaxRates'Variants x # to :: Rep PostCreditNotesRequestBodyLines'TaxRates'Variants x -> PostCreditNotesRequestBodyLines'TaxRates'Variants #
ToJSON PostCreditNotesRequestBodyLines'TaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCreditNotes Methods toJSON :: PostCreditNotesRequestBodyLines'TaxRates'Variants -> Value # toEncoding :: PostCreditNotesRequestBodyLines'TaxRates'Variants -> Encoding # toJSONList :: [PostCreditNotesRequestBodyLines'TaxRates'Variants] -> Value # toEncodingList :: [PostCreditNotesRequestBodyLines'TaxRates'Variants] -> Encoding #
FromJSON PostCreditNotesRequestBodyLines'TaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCreditNotes Methods parseJSON :: Value -> Parser PostCreditNotesRequestBodyLines'TaxRates'Variants # parseJSONList :: Value -> Parser [PostCreditNotesRequestBodyLines'TaxRates'Variants] #
type Rep PostCreditNotesRequestBodyLines'TaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCreditNotes type Rep PostCreditNotesRequestBodyLines'TaxRates'Variants = D1 (MetaData "PostCreditNotesRequestBodyLines'TaxRates'Variants" "StripeAPI.Operations.PostCreditNotes" "stripeapi-0.1.0.2-D0ebvtj6l9B4TLqRwmHKaP" False) (C1 (MetaCons "PostCreditNotesRequestBodyLines'TaxRates'PostCreditNotesRequestBodyLines'TaxRates'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostCreditNotesRequestBodyLines'TaxRates'OneOf1)) :+: C1 (MetaCons "PostCreditNotesRequestBodyLines'TaxRates'ListText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

data PostCreditNotesRequestBodyLines'Type' Source #

Defines the enum schema postCreditNotesRequestBodyLines'Type'

Constructors

PostCreditNotesRequestBodyLines'Type'EnumOther Value
PostCreditNotesRequestBodyLines'Type'EnumTyped Text
PostCreditNotesRequestBodyLines'Type'EnumStringCustomLineItem
PostCreditNotesRequestBodyLines'Type'EnumStringInvoiceLineItem

Instances

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

data PostCreditNotesRequestBodyMetadata' Source #

Defines the data type for the schema postCreditNotesRequestBodyMetadata'

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

PostCreditNotesRequestBodyMetadata'

Instances

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

data PostCreditNotesRequestBodyReason' Source #

Defines the enum schema postCreditNotesRequestBodyReason'

Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`

Constructors

PostCreditNotesRequestBodyReason'EnumOther Value
PostCreditNotesRequestBodyReason'EnumTyped Text
PostCreditNotesRequestBodyReason'EnumStringDuplicate
PostCreditNotesRequestBodyReason'EnumStringFraudulent
PostCreditNotesRequestBodyReason'EnumStringOrderChange
PostCreditNotesRequestBodyReason'EnumStringProductUnsatisfactory

Instances

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

data PostCreditNotesResponse Source #

Represents a response of the operation postCreditNotes.

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

Constructors

PostCreditNotesResponseError String	Means either no matching case available or a parse error
PostCreditNotesResponse200 CreditNote	Successful response.
PostCreditNotesResponseDefault Error	Error response.

Instances

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