Struct CreditNote 

pub struct CreditNote {

    pub amount: i64,
    pub amount_shipping: i64,
    pub created: i64,
    pub currency: String,
    pub customer: Value,
    pub customer_balance_transaction: Option<Value>,
    pub discount_amount: i64,
    pub discount_amounts: Vec<DiscountsResourceDiscountAmount>,
    pub effective_at: Option<i64>,
    pub id: String,
    pub invoice: Value,
    pub lines: CreditNoteLinesList,
    pub livemode: bool,
    pub memo: Option<String>,
    pub metadata: Option<Value>,
    pub number: String,
    pub object: String,
    pub out_of_band_amount: Option<i64>,
    pub pdf: String,
    pub reason: Option<String>,
    pub refund: Option<Value>,
    pub shipping_cost: Option<Value>,
    pub status: String,
    pub subtotal: i64,
    pub subtotal_excluding_tax: Option<i64>,
    pub tax_amounts: Vec<CreditNoteTaxAmount>,
    pub total: i64,
    pub total_excluding_tax: Option<i64>,
    pub type_: String,
    pub voided_at: Option<i64>,
}

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

Related guide: Credit notes

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

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

currency: String

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

customer: Value

ID of the customer.

customer_balance_transaction: Option<Value>

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

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

Unique identifier for the object.

invoice: Value

ID of the invoice.

lines: CreditNoteLinesList

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

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.

object: String

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

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.

reason: Option<String>

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

refund: Option<Value>

Refund related to this credit note.

shipping_cost: Option<Value>

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

status: String

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.

tax_amounts: Vec<CreditNoteTaxAmount>

The aggregate amounts calculated per tax rate for all line items.

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.

type_: String

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

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 Default for CreditNote

fn default() -> CreditNote

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreditNote

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CreditNote

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

Formats the value using the given formatter.

impl Serialize for CreditNote

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.