Interface DiscountAmount

An aggregate discount amount for the Checkout Session.

Checkout Session Private Preview

interface DiscountAmount {
    amount: string;
    minorUnitsAmount: number;
    displayName: string;
    promotionCode?: string;
    percentOff?: number;
}

Hierarchy (View Summary)

Amount
- DiscountAmount

Index

Properties

amount minorUnitsAmount displayName promotionCode? percentOff?

Properties

amount

amount: string

Localized display value, for example $10.00.

minorUnitsAmount

minorUnitsAmount: number

Value in the currency's smallest unit.

displayName

displayName: string

Customer-facing discount name.

`Optional`promotionCode

promotionCode?: string

The applied promotion code, when the discount came from one.

`Optional`percentOff

percentOff?: number

The percentage discounted, when applicable.