Struct CreditNote

pub struct CreditNote {

    pub amount: i64,
    pub amount_shipping: i64,
    pub created: Timestamp,
    pub currency: Currency,
    pub customer: Expandable<Customer>,
    pub customer_balance_transaction: Option<Expandable<CustomerBalanceTransaction>>,
    pub discount_amount: i64,
    pub discount_amounts: Vec<DiscountsResourceDiscountAmount>,
    pub effective_at: Option<Timestamp>,
    pub id: CreditNoteId,
    pub invoice: Expandable<Invoice>,
    pub lines: List<CreditNoteLineItem>,
    pub livemode: bool,
    pub memo: Option<String>,
    pub metadata: Option<HashMap<String, String>>,
    pub number: String,
    pub out_of_band_amount: Option<i64>,
    pub pdf: String,
    pub pretax_credit_amounts: Vec<CreditNotesPretaxCreditAmount>,
    pub reason: Option<CreditNoteReason>,
    pub refunds: Vec<CreditNoteRefund>,
    pub shipping_cost: Option<InvoicesResourceShippingCost>,
    pub status: CreditNoteStatus,
    pub subtotal: i64,
    pub subtotal_excluding_tax: Option<i64>,
    pub total: i64,
    pub total_excluding_tax: Option<i64>,
    pub total_taxes: Option<Vec<BillingBillResourceInvoicingTaxesTax>>,
    pub type_: CreditNoteType,
    pub voided_at: Option<Timestamp>,
}

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

Related guide: Credit notes

For more details see <https://stripe.com/docs/api/credit_notes/object>.

Fields

amount: i64

The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.

amount_shipping: i64

This is the sum of all the shipping amounts.

created: Timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

currency: Currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer: Expandable<Customer>

ID of the customer.

customer_balance_transaction: Option<Expandable<CustomerBalanceTransaction>>

Customer balance transaction related to this credit note.

discount_amount: i64

The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.

discount_amounts: Vec<DiscountsResourceDiscountAmount>

The aggregate amounts calculated per discount for all line items.

effective_at: Option<Timestamp>

The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated ‘Date of issue’ printed on the credit note PDF.

id: CreditNoteId

Unique identifier for the object.

invoice: Expandable<Invoice>

ID of the invoice.

lines: List<CreditNoteLineItem>

Line items that make up the credit note

livemode: bool

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

memo: Option<String>

Customer-facing text that appears on the credit note PDF.

metadata: Option<HashMap<String, String>>

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.

number: String

A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.

out_of_band_amount: Option<i64>

Amount that was credited outside of Stripe.

pdf: String

The link to download the PDF of the credit note.

pretax_credit_amounts: Vec<CreditNotesPretaxCreditAmount>

The pretax credit amounts (ex: discount, credit grants, etc) for all line items.

reason: Option<CreditNoteReason>

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

refunds: Vec<CreditNoteRefund>

Refunds related to this credit note.

shipping_cost: Option<InvoicesResourceShippingCost>

The details of the cost of shipping, including the ShippingRate applied to the invoice.

status: CreditNoteStatus

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

subtotal: i64

The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.

subtotal_excluding_tax: Option<i64>

The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.

total: i64

The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.

total_excluding_tax: Option<i64>

The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.

total_taxes: Option<Vec<BillingBillResourceInvoicingTaxesTax>>

The aggregate tax information for all line items.

type_: CreditNoteType

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.

voided_at: Option<Timestamp>

The time that the credit note was voided.

Trait Implementations

impl Clone for CreditNote

fn clone(&self) -> CreditNote

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreditNote

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize for CreditNote

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for CreditNote

fn from_value(v: Value) -> Option<Self>

impl Object for CreditNote

type Id = CreditNoteId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for CreditNote

type Builder = CreditNoteBuilder