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.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Orders
Learn more about app permissions.
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?