Interface OneTimePriceItem

A one-time-price item the customer is purchasing.

Checkout Session Private Preview

interface OneTimePriceItem {
    key: string;
    displayName: string;
    images: string[];
    unitAmount: Amount;
    unitAmountDecimal?: Amount;
    unitLabel?: string;
    quantity: number;
    adjustableQuantity?: AdjustableQuantity;
}

Properties

key displayName images unitAmount unitAmountDecimal? unitLabel? quantity adjustableQuantity?

Properties

key

key: string

A stable key for this item.

displayName

displayName: string

The customer-facing item name.

images

images: string[]

URLs for images representing this item.

unitAmount

unitAmount: Amount

The price for one unit.

OptionalunitAmountDecimal

unitAmountDecimal?: Amount

The unit price with sub-minor-unit precision, when available.

OptionalunitLabel

unitLabel?: string

A customer-facing label for one unit, such as seat.

quantity

quantity: number

The quantity being purchased.

OptionaladjustableQuantity

adjustableQuantity?: AdjustableQuantity

Limits for customer-adjustable quantity, when enabled.

Settings

Member Visibility

On This Page

Properties