StripeAPI.Types.CreditNoteLineItem

Contains the types generated from the schema CreditNoteLineItem

Documentation

data CreditNoteLineItem

Defines the data type for the schema credit_note_line_item

Constructors

CreditNoteLineItem

Fields

• creditNoteLineItemAmount :: Integer

  amount: The integer amount in **%s** representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.

• creditNoteLineItemDescription :: Maybe Text

  description: Description of the item being credited.

  Constraints:

  • Maximum length of 5000
• creditNoteLineItemDiscountAmount :: Integer

  discount_amount: The integer amount in **%s** representing the discount being credited for this line item.

• creditNoteLineItemId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• creditNoteLineItemInvoiceLineItem :: Maybe Text

  invoice_line_item: ID of the invoice line item being credited

  Constraints:

  • Maximum length of 5000
• creditNoteLineItemLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• creditNoteLineItemObject :: CreditNoteLineItemObject'

  object: String representing the object's type. Objects of the same type share the same value.

• creditNoteLineItemQuantity :: Maybe Integer

  quantity: The number of units of product being credited.

• creditNoteLineItemTaxAmounts :: [] CreditNoteTaxAmount

  tax_amounts: The amount of tax calculated per tax rate for this line item

• creditNoteLineItemTaxRates :: [] TaxRate

  tax_rates: The tax rates which apply to the line item.

• creditNoteLineItemType :: CreditNoteLineItemType'

  type: The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.

• creditNoteLineItemUnitAmount :: Maybe Integer

  unit_amount: The cost of each unit of product being credited.

• creditNoteLineItemUnitAmountDecimal :: Maybe Text

  unit_amount_decimal: Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.

Instances

Eq CreditNoteLineItem

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

(==) :: CreditNoteLineItem -> CreditNoteLineItem -> Bool

(/=) :: CreditNoteLineItem -> CreditNoteLineItem -> Bool

Show CreditNoteLineItem

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

showsPrec :: Int -> CreditNoteLineItem -> ShowS

show :: CreditNoteLineItem -> String

showList :: [CreditNoteLineItem] -> ShowS

ToJSON CreditNoteLineItem

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

toJSON :: CreditNoteLineItem -> Value

toEncoding :: CreditNoteLineItem -> Encoding

toJSONList :: [CreditNoteLineItem] -> Value

toEncodingList :: [CreditNoteLineItem] -> Encoding

FromJSON CreditNoteLineItem

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

parseJSON :: Value -> Parser CreditNoteLineItem

parseJSONList :: Value -> Parser [CreditNoteLineItem]

data CreditNoteLineItemObject'

Defines the enum schema credit_note_line_itemObject'

String representing the object's type. Objects of the same type share the same value.

Constructors

CreditNoteLineItemObject'EnumOther Value

CreditNoteLineItemObject'EnumTyped Text

CreditNoteLineItemObject'EnumStringCreditNoteLineItem

Instances

Eq CreditNoteLineItemObject'

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

(==) :: CreditNoteLineItemObject' -> CreditNoteLineItemObject' -> Bool

(/=) :: CreditNoteLineItemObject' -> CreditNoteLineItemObject' -> Bool

Show CreditNoteLineItemObject'

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

showsPrec :: Int -> CreditNoteLineItemObject' -> ShowS

show :: CreditNoteLineItemObject' -> String

showList :: [CreditNoteLineItemObject'] -> ShowS

ToJSON CreditNoteLineItemObject'

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

toJSON :: CreditNoteLineItemObject' -> Value

toEncoding :: CreditNoteLineItemObject' -> Encoding

toJSONList :: [CreditNoteLineItemObject'] -> Value

toEncodingList :: [CreditNoteLineItemObject'] -> Encoding

FromJSON CreditNoteLineItemObject'

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

parseJSON :: Value -> Parser CreditNoteLineItemObject'

parseJSONList :: Value -> Parser [CreditNoteLineItemObject']

data CreditNoteLineItemType'

Defines the enum schema credit_note_line_itemType'

The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.

Constructors

CreditNoteLineItemType'EnumOther Value

CreditNoteLineItemType'EnumTyped Text

CreditNoteLineItemType'EnumStringCustomLineItem

CreditNoteLineItemType'EnumStringInvoiceLineItem

Instances

Eq CreditNoteLineItemType'

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

(==) :: CreditNoteLineItemType' -> CreditNoteLineItemType' -> Bool

(/=) :: CreditNoteLineItemType' -> CreditNoteLineItemType' -> Bool

Show CreditNoteLineItemType'

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

showsPrec :: Int -> CreditNoteLineItemType' -> ShowS

show :: CreditNoteLineItemType' -> String

showList :: [CreditNoteLineItemType'] -> ShowS

ToJSON CreditNoteLineItemType'

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

toJSON :: CreditNoteLineItemType' -> Value

toEncoding :: CreditNoteLineItemType' -> Encoding

toJSONList :: [CreditNoteLineItemType'] -> Value

toEncodingList :: [CreditNoteLineItemType'] -> Encoding

FromJSON CreditNoteLineItemType'

Defined in StripeAPI.Types.CreditNoteLineItem

Methods

parseJSON :: Value -> Parser CreditNoteLineItemType'

parseJSONList :: Value -> Parser [CreditNoteLineItemType']