Skip to main content

priceExplain

Explain the price calculation process with detailed breakdown.

Returns a step-by-step explanation of how the final price was calculated, including all applied discounts, markups, taxes, and business rules. Useful for debugging pricing issues and understanding complex pricing logic.

Possible errors:

  • PRICE_CALCULATION_ERROR: Failed to calculate the price
  • PRODUCT_NOT_FOUND_ERROR: Specified product does not exist
  • PRICESHEET_NOT_FOUND_ERROR: No applicable pricing found for the customer context
  • CUSTOMER_NOT_FOUND_ERROR: Specified customer does not exist
  • UNAUTHENTICATED: Invalid or missing authentication
  • FORBIDDEN: Insufficient permissions to access pricing

AUTH: Role=[pricing.OWNER,pricing.EDITOR,pricing.VIEWER]

priceExplain(
  input: PriceCalculateInput!
): [ProductPrice!]!

Arguments​

priceExplain.input ● PriceCalculateInput! non-null input​

Price calculation parameters for detailed explanation.

Same parameters as price calculation but returns detailed breakdown of all pricing components and business rules applied.

Type​

ProductPrice object​

Calculated product price with comprehensive pricing information and business rules applied.

Contains the final calculated price for a product including base pricing, discounts, tax calculations, and all applicable business rules. Used for displaying prices to customers and processing orders.

IMPORTANT - tax semantics: in the Propeller API gross is the amount EXCLUDING tax and net is the amount INCLUDING tax (net = gross + tax). This is the REVERSE of common accounting usage, where gross means tax-inclusive. Do not map gross to a tax-inclusive field.