checkBenefitEligibility( )


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.

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
SCOPE.BENEFIT_PROGRAMS.MANAGE
Learn more about app permissions.
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?