checkBenefitEligibility( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Checks if a benefit can currently be redeemed.

To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.

Method Declaration
Copy
Method Parameters
poolIdstringRequired

ID of the pool that the benefit to check belongs to.


optionsCheckBenefitEligibilityOptions
Returns
Return Type:Promise<CheckBenefitEligibilityResponse>
Errors

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

Did this help?