calculateRefund( )

Calculates the total refund amount and breakdown for specified line items, shipping, and additional fees.

Returns detailed calculations including:

  • Total refund amount with tax, discount, and subtotal breakdowns
  • Individual item calculations with pricing details
  • Validation of whether the requested refund items are available

Use this method to preview refund amounts before calling Refund Payments.

Method Declaration
Copy
Method Parameters
orderIdstringRequired

Order ID to calculate refund for.

optionsCalculateRefundOptions
Returns
Return Type:Promise<CalculateRefundResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?