Skip to content

docs(pos): document Discount.amount read behavior from 2026-10 #4621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vctrchu wants to merge 1 commit into
base: 2026-10-rc
Choose a base branch
from
Open

docs(pos): document Discount.amount read behavior from 2026-10 #4621

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,9 @@ export interface SellingPlan {
*/
export interface Discount {
/**
* The discount value to apply. For `'Percentage'` type, this represents the percentage value (For example, "10" for 10% off). For `'FixedAmount'` type, this represents the fixed monetary amount to deduct from the line item price. Commonly used for discount calculations and displaying the discount value to merchants.
* The discount value to apply. For `'Percentage'` type, this represents the percentage value (For example, "10" for 10% off). For `'FixedAmount'` type, this represents the fixed monetary amount to deduct from the line item price.
*
* From API version 2026-10, reading a manual discount from the cart returns the same value that was applied, so discounts can be passed back to `bulkCartUpdate` unchanged. This also requires a POS app version with the corresponding fix; on older POS app versions, reads return the calculated monetary total of the discount instead (the behavior of all API versions before 2026-10).
*/
amount: number;
/**
Expand Down
Loading