Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetCreditNotesPreview

Description

Contains the different functions to run the operation getCreditNotesPreview

Synopsis

getCreditNotesPreview :: forall m. MonadHTTP m => GetCreditNotesPreviewParameters -> ClientT m (Response GetCreditNotesPreviewResponse)
data GetCreditNotesPreviewParameters = GetCreditNotesPreviewParameters {
}
mkGetCreditNotesPreviewParameters :: Text -> GetCreditNotesPreviewParameters
data GetCreditNotesPreviewParametersQueryLines' = GetCreditNotesPreviewParametersQueryLines' {
}
mkGetCreditNotesPreviewParametersQueryLines' :: GetCreditNotesPreviewParametersQueryLines'Type' -> GetCreditNotesPreviewParametersQueryLines'
data GetCreditNotesPreviewParametersQueryLines'TaxRates'Variants
- = GetCreditNotesPreviewParametersQueryLines'TaxRates'EmptyString
- | GetCreditNotesPreviewParametersQueryLines'TaxRates'ListTText [Text]
data GetCreditNotesPreviewParametersQueryLines'Type'
data GetCreditNotesPreviewParametersQueryReason'
data GetCreditNotesPreviewResponse

Documentation

getCreditNotesPreview Source #

Arguments

:: forall m. MonadHTTP m
=> GetCreditNotesPreviewParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetCreditNotesPreviewResponse)	Monadic computation which returns the result of the operation

GET /v1/credit_notes/preview

<p>Get a preview of a credit note without creating it.</p>

data GetCreditNotesPreviewParameters Source #

Defines the object schema located at paths./v1/credit_notes/preview.GET.parameters in the specification.

Constructors

GetCreditNotesPreviewParameters

Fields

getCreditNotesPreviewParametersQueryAmount :: Maybe Int
queryAmount: Represents the parameter named 'amount'
The integer amount in %s representing the total amount of the credit note.
getCreditNotesPreviewParametersQueryCreditAmount :: Maybe Int
queryCredit_amount: Represents the parameter named '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.
getCreditNotesPreviewParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getCreditNotesPreviewParametersQueryInvoice :: Text
queryInvoice: Represents the parameter named 'invoice'
ID of the invoice.
Constraints:
- Maximum length of 5000
getCreditNotesPreviewParametersQueryLines :: Maybe [GetCreditNotesPreviewParametersQueryLines']
queryLines: Represents the parameter named 'lines'
Line items that make up the credit note.
getCreditNotesPreviewParametersQueryMemo :: Maybe Text
queryMemo: Represents the parameter named 'memo'
The credit note's memo appears on the credit note PDF.
Constraints:
- Maximum length of 5000
getCreditNotesPreviewParametersQueryMetadata :: Maybe Object
queryMetadata: Represents the parameter named '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`.
getCreditNotesPreviewParametersQueryOutOfBandAmount :: Maybe Int
queryOut_of_band_amount: Represents the parameter named 'out_of_band_amount'
The integer amount in %s representing the amount that is credited outside of Stripe.
getCreditNotesPreviewParametersQueryReason :: Maybe GetCreditNotesPreviewParametersQueryReason'
queryReason: Represents the parameter named 'reason'
Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
getCreditNotesPreviewParametersQueryRefund :: Maybe Text
queryRefund: Represents the parameter named 'refund'
ID of an existing refund to link this credit note to.
getCreditNotesPreviewParametersQueryRefundAmount :: Maybe Int
queryRefund_amount: Represents the parameter named '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

Instances details

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

mkGetCreditNotesPreviewParameters Source #

Arguments

:: Text	`getCreditNotesPreviewParametersQueryInvoice`
-> GetCreditNotesPreviewParameters

Create a new GetCreditNotesPreviewParameters with all required fields.

data GetCreditNotesPreviewParametersQueryLines' Source #

Defines the object schema located at paths./v1/credit_notes/preview.GET.parameters.properties.queryLines.items in the specification.

Constructors

GetCreditNotesPreviewParametersQueryLines'

Fields

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

Instances

Instances details

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

mkGetCreditNotesPreviewParametersQueryLines' Source #

Arguments

:: GetCreditNotesPreviewParametersQueryLines'Type'	`getCreditNotesPreviewParametersQueryLines'Type`
-> GetCreditNotesPreviewParametersQueryLines'

Create a new GetCreditNotesPreviewParametersQueryLines' with all required fields.

data GetCreditNotesPreviewParametersQueryLines'TaxRates'Variants Source #

Defines the oneOf schema located at paths./v1/credit_notes/preview.GET.parameters.properties.queryLines.items.properties.tax_rates.anyOf in the specification.

Constructors

GetCreditNotesPreviewParametersQueryLines'TaxRates'EmptyString	Represents the JSON value `""`
GetCreditNotesPreviewParametersQueryLines'TaxRates'ListTText [Text]

Instances

Instances details

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

data GetCreditNotesPreviewParametersQueryLines'Type' Source #

Defines the enum schema located at paths./v1/credit_notes/preview.GET.parameters.properties.queryLines.items.properties.type in the specification.

Constructors

GetCreditNotesPreviewParametersQueryLines'Type'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetCreditNotesPreviewParametersQueryLines'Type'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
GetCreditNotesPreviewParametersQueryLines'Type'EnumCustomLineItem	Represents the JSON value `"custom_line_item"`
GetCreditNotesPreviewParametersQueryLines'Type'EnumInvoiceLineItem	Represents the JSON value `"invoice_line_item"`

Instances

Instances details

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

data GetCreditNotesPreviewParametersQueryReason' Source #

Defines the enum schema located at paths./v1/credit_notes/preview.GET.parameters.properties.queryReason in the specification.

Represents the parameter named 'reason'

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

Constructors

GetCreditNotesPreviewParametersQueryReason'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetCreditNotesPreviewParametersQueryReason'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
GetCreditNotesPreviewParametersQueryReason'EnumDuplicate	Represents the JSON value `"duplicate"`
GetCreditNotesPreviewParametersQueryReason'EnumFraudulent	Represents the JSON value `"fraudulent"`
GetCreditNotesPreviewParametersQueryReason'EnumOrderChange	Represents the JSON value `"order_change"`
GetCreditNotesPreviewParametersQueryReason'EnumProductUnsatisfactory	Represents the JSON value `"product_unsatisfactory"`

Instances

Instances details

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

data GetCreditNotesPreviewResponse Source #

Represents a response of the operation getCreditNotesPreview.

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

Constructors

GetCreditNotesPreviewResponseError String	Means either no matching case available or a parse error
GetCreditNotesPreviewResponse200 CreditNote	Successful response.
GetCreditNotesPreviewResponseDefault Error	Error response.

Instances

Instances details

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