Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.CreditNote

Contains the types generated from the schema CreditNote

9 types
2 values

Packagestripeapi-3.0.0.0
Exports11
LanguageHaskell2010
LicenceMIT
SourceCreditNote.hs

datadata CreditNote

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
- 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 (Nullable CreditNoteCustomerBalanceTransaction'NonNullableVariants)
  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 (Nullable Text)
  memo: Customer-facing text that appears on the credit note PDF.
  Constraints:
  - Maximum length of 5000
- creditNoteMetadata :: Maybe (Nullable 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 (Nullable 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 (Nullable CreditNoteReason'NonNullable)
  reason: Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
- creditNoteRefund :: Maybe (Nullable CreditNoteRefund'NonNullableVariants)
  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 exclusive tax and invoice level discounts.
- creditNoteSubtotalExcludingTax :: Maybe (Nullable Int)
  subtotal_excluding_tax: The integer amount in %s representing the amount of the credit note, excluding all 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.
- creditNoteTotalExcludingTax :: Maybe (Nullable Int)
  total_excluding_tax: The integer amount in %s representing the total amount of the credit note, excluding tax, but including discounts.
- 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 (Nullable Int)
  voided_at: The time that the credit note was voided.

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
Show CreditNoteDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
FromJSON CreditNoteDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
ToJSON CreditNoteDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote

valuemkCreditNote

:: 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.

datadata CreditNoteCustomer'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
Show CreditNoteCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
FromJSON CreditNoteCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
ToJSON CreditNoteCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote

datadata CreditNoteCustomerBalanceTransaction'NonNullableVariants

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'NonNullableText Text
CreditNoteCustomerBalanceTransaction'NonNullableCustomerBalanceTransaction CustomerBalanceTransaction

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteCustomerBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
Show CreditNoteCustomerBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
FromJSON CreditNoteCustomerBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
ToJSON CreditNoteCustomerBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote

datadata CreditNoteInvoice'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteInvoice'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
Show CreditNoteInvoice'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
FromJSON CreditNoteInvoice'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
ToJSON CreditNoteInvoice'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote

datadata CreditNoteLines'

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'
- 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

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteLines'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
Show CreditNoteLines'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
FromJSON CreditNoteLines'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
ToJSON CreditNoteLines'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote

valuemkCreditNoteLines'

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

Create a new CreditNoteLines' with all required fields.

datadata CreditNoteReason'NonNullable

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'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CreditNoteReason'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
CreditNoteReason'NonNullableEnumDuplicate
Represents the JSON value "duplicate"
CreditNoteReason'NonNullableEnumFraudulent
Represents the JSON value "fraudulent"
CreditNoteReason'NonNullableEnumOrderChange
Represents the JSON value "order_change"
CreditNoteReason'NonNullableEnumProductUnsatisfactory
Represents the JSON value "product_unsatisfactory"

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
Show CreditNoteReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
FromJSON CreditNoteReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
ToJSON CreditNoteReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote

datadata CreditNoteRefund'NonNullableVariants

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

Refund related to this credit note.

Constructors

CreditNoteRefund'NonNullableText Text
CreditNoteRefund'NonNullableRefund Refund

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
Show CreditNoteRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
FromJSON CreditNoteRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
ToJSON CreditNoteRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote

datadata CreditNoteStatus'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
Show CreditNoteStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
FromJSON CreditNoteStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
ToJSON CreditNoteStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote

datadata CreditNoteType'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq CreditNoteType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
Show CreditNoteType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
FromJSON CreditNoteType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote
ToJSON CreditNoteType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CreditNote