Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.CreditNote

Description

Contains the types generated from the schema CreditNote

Synopsis

data CreditNote = CreditNote {
}
mkCreditNote :: Int -> Int -> Text -> CreditNoteCustomer'Variants -> Int -> [DiscountsResourceDiscountAmount] -> Text -> CreditNoteInvoice'Variants -> CreditNoteLines' -> Bool -> Text -> Text -> CreditNoteStatus' -> Int -> [CreditNoteTaxAmount] -> Int -> CreditNoteType' -> CreditNote
data CreditNoteCustomer'Variants
data CreditNoteCustomerBalanceTransaction'Variants
- = CreditNoteCustomerBalanceTransaction'Text Text
- | CreditNoteCustomerBalanceTransaction'CustomerBalanceTransaction CustomerBalanceTransaction
data CreditNoteInvoice'Variants
- = CreditNoteInvoice'Text Text
- | CreditNoteInvoice'Invoice Invoice
data CreditNoteLines' = CreditNoteLines' {
- creditNoteLines'Data :: [CreditNoteLineItem]
- creditNoteLines'HasMore :: Bool
- creditNoteLines'Url :: Text
}
mkCreditNoteLines' :: [CreditNoteLineItem] -> Bool -> Text -> CreditNoteLines'
data CreditNoteReason'
data CreditNoteRefund'Variants
- = CreditNoteRefund'Text Text
- | CreditNoteRefund'Refund Refund
data CreditNoteStatus'
data CreditNoteType'

Documentation

data CreditNote Source #

Defines the object schema located at components.schemas.credit_note in the specification.

Issue a credit note to adjust an invoice's amount after the invoice is finalized.

Related guide: Credit Notes.

Constructors

CreditNote

Fields

creditNoteAmount :: Int
amount: The integer amount in %s representing the total amount of the credit note, including tax.
creditNoteCreated :: Int
created: Time at which the object was created. Measured in seconds since the Unix epoch.
creditNoteCurrency :: Text
currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
creditNoteCustomer :: CreditNoteCustomer'Variants
customer: ID of the customer.
creditNoteCustomerBalanceTransaction :: Maybe CreditNoteCustomerBalanceTransaction'Variants
customer_balance_transaction: Customer balance transaction related to this credit note.
creditNoteDiscountAmount :: Int
discount_amount: The integer amount in %s representing the total amount of discount that was credited.
creditNoteDiscountAmounts :: [DiscountsResourceDiscountAmount]
discount_amounts: The aggregate amounts calculated per discount for all line items.
creditNoteId :: Text
id: Unique identifier for the object.
Constraints:
- Maximum length of 5000
creditNoteInvoice :: CreditNoteInvoice'Variants
invoice: ID of the invoice.
creditNoteLines :: CreditNoteLines'
lines: Line items that make up the credit note
creditNoteLivemode :: Bool
livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
creditNoteMemo :: Maybe Text
memo: Customer-facing text that appears on the credit note PDF.
Constraints:
- Maximum length of 5000
creditNoteMetadata :: Maybe Object
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.
creditNoteNumber :: Text
number: A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
Constraints:
- Maximum length of 5000
creditNoteOutOfBandAmount :: Maybe Int
out_of_band_amount: Amount that was credited outside of Stripe.
creditNotePdf :: Text
pdf: The link to download the PDF of the credit note.
Constraints:
- Maximum length of 5000
creditNoteReason :: Maybe CreditNoteReason'
reason: Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
creditNoteRefund :: Maybe CreditNoteRefund'Variants
refund: Refund related to this credit note.
creditNoteStatus :: CreditNoteStatus'
status: Status of this credit note, one of `issued` or `void`. Learn more about voiding credit notes.
creditNoteSubtotal :: Int
subtotal: The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts.
creditNoteTaxAmounts :: [CreditNoteTaxAmount]
tax_amounts: The aggregate amounts calculated per tax rate for all line items.
creditNoteTotal :: Int
total: The integer amount in %s representing the total amount of the credit note, including tax and all discount.
creditNoteType :: CreditNoteType'
type: Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.
creditNoteVoidedAt :: Maybe Int
voided_at: The time that the credit note was voided.

Instances

Instances details

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

mkCreditNote Source #

Arguments

:: Int	`creditNoteAmount`
-> Int	`creditNoteCreated`
-> Text	`creditNoteCurrency`
-> CreditNoteCustomer'Variants	`creditNoteCustomer`
-> Int	`creditNoteDiscountAmount`
-> [DiscountsResourceDiscountAmount]	`creditNoteDiscountAmounts`
-> Text	`creditNoteId`
-> CreditNoteInvoice'Variants	`creditNoteInvoice`
-> CreditNoteLines'	`creditNoteLines`
-> Bool	`creditNoteLivemode`
-> Text	`creditNoteNumber`
-> Text	`creditNotePdf`
-> CreditNoteStatus'	`creditNoteStatus`
-> Int	`creditNoteSubtotal`
-> [CreditNoteTaxAmount]	`creditNoteTaxAmounts`
-> Int	`creditNoteTotal`
-> CreditNoteType'	`creditNoteType`
-> CreditNote

Create a new CreditNote with all required fields.

data CreditNoteCustomer'Variants Source #

Defines the oneOf schema located at components.schemas.credit_note.properties.customer.anyOf in the specification.

ID of the customer.

Constructors

CreditNoteCustomer'Text Text
CreditNoteCustomer'Customer Customer
CreditNoteCustomer'DeletedCustomer DeletedCustomer

Instances

Instances details

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

data CreditNoteCustomerBalanceTransaction'Variants Source #

Defines the oneOf schema located at components.schemas.credit_note.properties.customer_balance_transaction.anyOf in the specification.

Customer balance transaction related to this credit note.

Constructors

CreditNoteCustomerBalanceTransaction'Text Text
CreditNoteCustomerBalanceTransaction'CustomerBalanceTransaction CustomerBalanceTransaction

Instances

Instances details

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

data CreditNoteInvoice'Variants Source #

Defines the oneOf schema located at components.schemas.credit_note.properties.invoice.anyOf in the specification.

ID of the invoice.

Constructors

CreditNoteInvoice'Text Text
CreditNoteInvoice'Invoice Invoice

Instances

Instances details

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

data CreditNoteLines' Source #

Defines the object schema located at components.schemas.credit_note.properties.lines in the specification.

Line items that make up the credit note

Constructors

CreditNoteLines'
Fields creditNoteLines'Data :: [CreditNoteLineItem] data: Details about each object. creditNoteLines'HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. creditNoteLines'Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000

Instances

Instances details

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

mkCreditNoteLines' Source #

Arguments

:: [CreditNoteLineItem]	`creditNoteLines'Data`
-> Bool	`creditNoteLines'HasMore`
-> Text	`creditNoteLines'Url`
-> CreditNoteLines'

Create a new CreditNoteLines' with all required fields.

data CreditNoteReason' Source #

Defines the enum schema located at components.schemas.credit_note.properties.reason in the specification.

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

Constructors

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

Instances

Instances details

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

data CreditNoteRefund'Variants Source #

Defines the oneOf schema located at components.schemas.credit_note.properties.refund.anyOf in the specification.

Refund related to this credit note.

Constructors

CreditNoteRefund'Text Text
CreditNoteRefund'Refund Refund

Instances

Instances details

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

data CreditNoteStatus' Source #

Defines the enum schema located at components.schemas.credit_note.properties.status in the specification.

Status of this credit note, one of `issued` or `void`. Learn more about voiding credit notes.

Constructors

CreditNoteStatus'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CreditNoteStatus'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
CreditNoteStatus'EnumIssued	Represents the JSON value `"issued"`
CreditNoteStatus'EnumVoid	Represents the JSON value `"void"`

Instances

Instances details

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

data CreditNoteType' Source #

Defines the enum schema located at components.schemas.credit_note.properties.type in the specification.

Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.

Constructors

CreditNoteType'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CreditNoteType'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
CreditNoteType'EnumPostPayment	Represents the JSON value `"post_payment"`
CreditNoteType'EnumPrePayment	Represents the JSON value `"pre_payment"`

Instances

Instances details

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