CreditNote class final

CreditNote

Issue a credit note to adjust an invoice's amount after the invoice is finalized. Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)

Implemented types

Constructors

CreditNote({required int amount, required int amountShipping, required DateTime created, required String currency, required BankAccountCustomerOrId customer, CustomerBalanceTransactionOrId? customerBalanceTransaction, required int discountAmount, required List<DiscountsResourceDiscountAmount> discountAmounts, DateTime? effectiveAt, required String id, required InvoiceOrId invoice, required CreditNoteLines lines, required bool livemode, String? memo, Map<String, String>? metadata, required String number, int? outOfBandAmount, required String pdf, CreditNoteReason? reason, RefundOrId? refund, CheckoutSessionShippingCost? shippingCost, required CreditNoteStatus status, required int subtotal, int? subtotalExcludingTax, required List<CreditNoteTaxAmount> taxAmounts, required int total, int? totalExcludingTax, required CreditNoteType type, DateTime? voidedAt})
CreditNote
const
CreditNote.fromJson(Object? json)
factory

Properties

amount → int
final
amountShipping → int
final
created → DateTime
final
currency → String
final
customer → BankAccountCustomerOrId
final
customerBalanceTransaction → CustomerBalanceTransactionOrId?
final
discountAmount → int
final
discountAmounts → List<DiscountsResourceDiscountAmount>
final
effectiveAt → DateTime?
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
The ID of the CreditNote.
final
invoice → InvoiceOrId
final
lines → CreditNoteLines
CreditNoteLinesList
final
livemode → bool
final
memo → String?
final
metadata → Map<String, String>?
final
number → String
final
object → String
The resource's type.
final
outOfBandAmount → int?
final
pdf → String
final
reason → CreditNoteReason?
final
refund → RefundOrId?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shippingCost → CheckoutSessionShippingCost?
final
status → CreditNoteStatus
final
subtotal → int
final
subtotalExcludingTax → int?
final
taxAmounts → List<CreditNoteTaxAmount>
final
total → int
final
totalExcludingTax → int?
final
type → CreditNoteType
final
voidedAt → DateTime?
final

Methods

encodeWith<V>(Encoder<V> encoder) → V
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

encode<V>(CreditNote instance, Encoder<V> encoder) → V
override