Skip to main content

Surcharge

Surcharge​

@vendure/coresurcharge.entity.ts

A Surcharge represents an arbitrary extra item on an Order which is not a ProductVariant. It can be used to e.g. represent payment-related surcharges.

Signature
class Surcharge extends VendureEntity {
    constructor(input?: DeepPartial<Surcharge>)
    @Column()
    description: string;
    @Money()
    listPrice: number;
    @Column()
    listPriceIncludesTax: boolean;
    @Column()
    sku: string;
    @Column('simple-json')
    taxLines: TaxLine[];
    @Index()
    @ManyToOne(type => Order, order => order.surcharges, { onDelete: 'CASCADE' })
    order: Order;
    @Index()
    @ManyToOne(type => OrderModification, orderModification => orderModification.surcharges)
    orderModification: OrderModification;
    price: number
    priceWithTax: number
    taxRate: number
}

constructor​

method
(input?: DeepPartial<Surcharge>) => Surcharge

description​

property
string

listPrice​

property
number

listPriceIncludesTax​

property
boolean

sku​

property
string

taxLines​

property
TaxLine[]

order​

property
Order

orderModification​

property
OrderModification

price​

property
number

priceWithTax​

property
number

taxRate​

property
number