getOrderRefundability( )

Retrieves refund information about an order's payments, line items, shipping, and additional fees.

Returns detailed refundability status for each payment:

  • refundable: Automatic refund is available.
  • manuallyRefundable: Refund is expected to be processed externally. Can be manually marked as refunded.
  • nonRefundable: Refund cannot be performed.

Use this method before processing refunds to understand what can be refunded and through which method (automatic vs manual).

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.

Returns
Return Type:Promise<GetOrderRefundabilityResponse>
Errors

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

Did this help?