Surcharge

@vendure/core Source

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}

Extends: VendureEntity

constructor

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

description

propertystring

listPrice

propertynumber

listPriceIncludesTax

propertyboolean

sku

propertystring

taxLines

propertyTaxLine[]

order

propertyOrder

orderModification

propertyOrderModification

price

propertynumber

priceWithTax

propertynumber

taxRate

propertynumber