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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

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?