Mayson Monorepo Documentation
    Preparing search index...

    Interface CreditNoteListPreviewLineItemsParams

    interface CreditNoteListPreviewLineItemsParams {
        invoice: string;
        amount?: number;
        credit_amount?: number;
        effective_at?: number;
        email_type?: Stripe.CreditNoteListPreviewLineItemsParams.EmailType;
        expand?: string[];
        lines?: Stripe.CreditNoteListPreviewLineItemsParams.Line[];
        memo?: string;
        metadata?: MetadataParam;
        out_of_band_amount?: number;
        reason?: Stripe.CreditNoteListPreviewLineItemsParams.Reason;
        refund_amount?: number;
        refunds?: Stripe.CreditNoteListPreviewLineItemsParams.Refund[];
        shipping_cost?: Stripe.CreditNoteListPreviewLineItemsParams.ShippingCost;
        ending_before?: string;
        limit?: number;
        starting_after?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    invoice: string

    ID of the invoice.

    amount?: number

    The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of amount, lines, or shipping_cost must be provided.

    credit_amount?: number

    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.

    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.

    Type of email to send to the customer, one of credit_note or none and the default is credit_note.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    Line items that make up the credit note. One of amount, lines, or shipping_cost must be provided.

    memo?: string

    The credit note's memo appears on the credit note PDF.

    metadata?: MetadataParam

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    out_of_band_amount?: number

    The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.

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

    refund_amount?: number

    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.

    Refunds to link to this credit note.

    When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of amount, lines, or shipping_cost must be provided.

    ending_before?: string

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

    limit?: number

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    starting_after?: string

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.