Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetCreditNotesPreviewLines

Description

Contains the different functions to run the operation getCreditNotesPreviewLines

Synopsis

getCreditNotesPreviewLines :: forall m. MonadHTTP m => GetCreditNotesPreviewLinesParameters -> ClientT m (Response GetCreditNotesPreviewLinesResponse)
data GetCreditNotesPreviewLinesParameters = GetCreditNotesPreviewLinesParameters {
}
mkGetCreditNotesPreviewLinesParameters :: Text -> GetCreditNotesPreviewLinesParameters
data GetCreditNotesPreviewLinesParametersQueryLines' = GetCreditNotesPreviewLinesParametersQueryLines' {
}
mkGetCreditNotesPreviewLinesParametersQueryLines' :: GetCreditNotesPreviewLinesParametersQueryLines'Type' -> GetCreditNotesPreviewLinesParametersQueryLines'
data GetCreditNotesPreviewLinesParametersQueryLines'TaxRates'Variants
- = GetCreditNotesPreviewLinesParametersQueryLines'TaxRates'EmptyString
- | GetCreditNotesPreviewLinesParametersQueryLines'TaxRates'ListTText [Text]
data GetCreditNotesPreviewLinesParametersQueryLines'Type'
data GetCreditNotesPreviewLinesParametersQueryReason'
data GetCreditNotesPreviewLinesResponse
data GetCreditNotesPreviewLinesResponseBody200 = GetCreditNotesPreviewLinesResponseBody200 {
}
mkGetCreditNotesPreviewLinesResponseBody200 :: [CreditNoteLineItem] -> Bool -> Text -> GetCreditNotesPreviewLinesResponseBody200

Documentation

getCreditNotesPreviewLines Source #

Arguments

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

GET /v1/credit_notes/preview/lines

<p>When retrieving a credit note preview, you’ll get a <strong>lines</strong> property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.</p>

data GetCreditNotesPreviewLinesParameters Source #

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

Constructors

GetCreditNotesPreviewLinesParameters

Fields

getCreditNotesPreviewLinesParametersQueryAmount :: Maybe Int
queryAmount: Represents the parameter named 'amount'
The integer amount in %s representing the total amount of the credit note.
getCreditNotesPreviewLinesParametersQueryCreditAmount :: 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.
getCreditNotesPreviewLinesParametersQueryEndingBefore :: Maybe Text
queryEnding_before: Represents the parameter named 'ending_before'
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
Constraints:
- Maximum length of 5000
getCreditNotesPreviewLinesParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getCreditNotesPreviewLinesParametersQueryInvoice :: Text
queryInvoice: Represents the parameter named 'invoice'
ID of the invoice.
Constraints:
- Maximum length of 5000
getCreditNotesPreviewLinesParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
getCreditNotesPreviewLinesParametersQueryLines :: Maybe [GetCreditNotesPreviewLinesParametersQueryLines']
queryLines: Represents the parameter named 'lines'
Line items that make up the credit note.
getCreditNotesPreviewLinesParametersQueryMemo :: Maybe Text
queryMemo: Represents the parameter named 'memo'
The credit note's memo appears on the credit note PDF.
Constraints:
- Maximum length of 5000
getCreditNotesPreviewLinesParametersQueryMetadata :: 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`.
getCreditNotesPreviewLinesParametersQueryOutOfBandAmount :: 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.
getCreditNotesPreviewLinesParametersQueryReason :: Maybe GetCreditNotesPreviewLinesParametersQueryReason'
queryReason: Represents the parameter named 'reason'
Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
getCreditNotesPreviewLinesParametersQueryRefund :: Maybe Text
queryRefund: Represents the parameter named 'refund'
ID of an existing refund to link this credit note to.
getCreditNotesPreviewLinesParametersQueryRefundAmount :: 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.
getCreditNotesPreviewLinesParametersQueryStartingAfter :: Maybe Text
queryStarting_after: Represents the parameter named 'starting_after'
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
Constraints:
- Maximum length of 5000

Instances

Instances details

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

mkGetCreditNotesPreviewLinesParameters Source #

Arguments

:: Text	`getCreditNotesPreviewLinesParametersQueryInvoice`
-> GetCreditNotesPreviewLinesParameters

Create a new GetCreditNotesPreviewLinesParameters with all required fields.

data GetCreditNotesPreviewLinesParametersQueryLines' Source #

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

Constructors

GetCreditNotesPreviewLinesParametersQueryLines'

Fields

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

Instances

Instances details

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

mkGetCreditNotesPreviewLinesParametersQueryLines' Source #

Arguments

:: GetCreditNotesPreviewLinesParametersQueryLines'Type'	`getCreditNotesPreviewLinesParametersQueryLines'Type`
-> GetCreditNotesPreviewLinesParametersQueryLines'

Create a new GetCreditNotesPreviewLinesParametersQueryLines' with all required fields.

data GetCreditNotesPreviewLinesParametersQueryLines'TaxRates'Variants Source #

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

Constructors

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

Instances

Instances details

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

data GetCreditNotesPreviewLinesParametersQueryLines'Type' Source #

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

Constructors

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

Instances

Instances details

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

data GetCreditNotesPreviewLinesParametersQueryReason' Source #

Defines the enum schema located at paths./v1/credit_notes/preview/lines.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

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

Instances

Instances details

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

data GetCreditNotesPreviewLinesResponse Source #

Represents a response of the operation getCreditNotesPreviewLines.

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

Constructors

GetCreditNotesPreviewLinesResponseError String	Means either no matching case available or a parse error
GetCreditNotesPreviewLinesResponse200 GetCreditNotesPreviewLinesResponseBody200	Successful response.
GetCreditNotesPreviewLinesResponseDefault Error	Error response.

Instances

Instances details

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

data GetCreditNotesPreviewLinesResponseBody200 Source #

Defines the object schema located at paths./v1/credit_notes/preview/lines.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetCreditNotesPreviewLinesResponseBody200
Fields getCreditNotesPreviewLinesResponseBody200Data :: [CreditNoteLineItem] data: Details about each object. getCreditNotesPreviewLinesResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getCreditNotesPreviewLinesResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000

Instances

Instances details

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

mkGetCreditNotesPreviewLinesResponseBody200 Source #

Arguments

:: [CreditNoteLineItem]	`getCreditNotesPreviewLinesResponseBody200Data`
-> Bool	`getCreditNotesPreviewLinesResponseBody200HasMore`
-> Text	`getCreditNotesPreviewLinesResponseBody200Url`
-> GetCreditNotesPreviewLinesResponseBody200

Create a new GetCreditNotesPreviewLinesResponseBody200 with all required fields.