Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.CreditNoteLineItem

Contains the types generated from the schema CreditNoteLineItem

2 types
1 value

Packagestripeapi-3.0.0.0
Exports3
LanguageHaskell2010
LicenceMIT
SourceCreditNoteLineItem.hs

datadata CreditNoteLineItem

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

Constructors

CreditNoteLineItem
- creditNoteLineItemAmount :: Int
  amount: The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
- creditNoteLineItemAmountExcludingTax :: Maybe (Nullable Int)
  amount_excluding_tax: The integer amount in %s representing the amount being credited for this line item, excluding all tax and discounts.
- creditNoteLineItemDescription :: Maybe (Nullable Text)
  description: Description of the item being credited.
  Constraints:
  - Maximum length of 5000
- creditNoteLineItemDiscountAmount :: Int
  discount_amount: The integer amount in %s representing the discount being credited for this line item.
- creditNoteLineItemDiscountAmounts :: [DiscountsResourceDiscountAmount]
  discount_amounts: The amount of discount calculated per discount 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.
- creditNoteLineItemQuantity :: Maybe (Nullable Int)
  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 (Nullable Int)
  unit_amount: The cost of each unit of product being credited.
- creditNoteLineItemUnitAmountDecimal :: Maybe (Nullable Text)
  unit_amount_decimal: Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
- creditNoteLineItemUnitAmountExcludingTax :: Maybe (Nullable Text)
  unit_amount_excluding_tax: The amount in %s representing the unit amount being credited for this line item, excluding all tax and discounts.

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteLineItemDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNoteLineItem
Show CreditNoteLineItemDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNoteLineItem
FromJSON CreditNoteLineItemDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNoteLineItem
ToJSON CreditNoteLineItemDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNoteLineItem

valuemkCreditNoteLineItem

:: Int
creditNoteLineItemAmount
-> Int
creditNoteLineItemDiscountAmount
-> [DiscountsResourceDiscountAmount]
creditNoteLineItemDiscountAmounts
-> Text
creditNoteLineItemId
-> Bool
creditNoteLineItemLivemode
-> [CreditNoteTaxAmount]
creditNoteLineItemTaxAmounts
-> [TaxRate]
creditNoteLineItemTaxRates
-> CreditNoteLineItemType'
creditNoteLineItemType
-> CreditNoteLineItem

Create a new CreditNoteLineItem with all required fields.

datadata CreditNoteLineItemType'

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

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'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CreditNoteLineItemType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
CreditNoteLineItemType'EnumCustomLineItem
Represents the JSON value "custom_line_item"
CreditNoteLineItemType'EnumInvoiceLineItem
Represents the JSON value "invoice_line_item"

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteLineItemType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNoteLineItem
Show CreditNoteLineItemType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNoteLineItem
FromJSON CreditNoteLineItemType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNoteLineItem
ToJSON CreditNoteLineItemType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNoteLineItem