Mayson Monorepo Documentation
    Preparing search index...

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

    Related guide: Credit notes

    interface CreditNote {
        id: string;
        object: "credit_note";
        amount: number;
        amount_shipping: number;
        created: number;
        currency: string;
        customer: string | Stripe.Customer | DeletedCustomer;
        customer_account: string;
        customer_balance_transaction: string | Stripe.CustomerBalanceTransaction;
        discount_amount: number;
        discount_amounts: Stripe.CreditNote.DiscountAmount[];
        effective_at: number;
        invoice: string | Stripe.Invoice;
        lines: ApiList<Stripe.CreditNoteLineItem>;
        livemode: boolean;
        memo: string;
        metadata: Metadata;
        number: string;
        out_of_band_amount: number;
        pdf: string;
        post_payment_amount: number;
        pre_payment_amount: number;
        pretax_credit_amounts: Stripe.CreditNote.PretaxCreditAmount[];
        reason: Stripe.CreditNote.Reason;
        refunds: Stripe.CreditNote.Refund[];
        shipping_cost: Stripe.CreditNote.ShippingCost;
        status: Stripe.CreditNote.Status;
        subtotal: number;
        subtotal_excluding_tax: number;
        total: number;
        total_excluding_tax: number;
        total_taxes: Stripe.CreditNote.TotalTax[];
        type: Stripe.CreditNote.Type;
        voided_at: number;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "credit_note"

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

    amount: number

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

    amount_shipping: number

    This is the sum of all the shipping amounts.

    created: number

    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: string | Stripe.Customer | DeletedCustomer

    ID of the customer.

    customer_account: string

    ID of the account representing the customer.

    customer_balance_transaction: string | Stripe.CustomerBalanceTransaction

    Customer balance transaction related to this credit note.

    discount_amount: number

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

    discount_amounts: Stripe.CreditNote.DiscountAmount[]

    The aggregate amounts calculated per discount for all line items.

    effective_at: number

    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.

    invoice: string | Stripe.Invoice

    ID of the invoice.

    Line items that make up the credit note

    livemode: boolean

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

    memo: string

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

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

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

    Amount that was credited outside of Stripe.

    pdf: string

    The link to download the PDF of the credit note.

    post_payment_amount

    post_payment_amount: number

    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.

    pre_payment_amount: number

    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.

    pretax_credit_amounts: Stripe.CreditNote.PretaxCreditAmount[]

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

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

    Refunds related to this credit note.

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

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

    subtotal: number

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

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

    total: number

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

    total_excluding_tax: number

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

    total_taxes: Stripe.CreditNote.TotalTax[]

    The aggregate tax information for all line items.

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

    The time that the credit note was voided.