getEligibleBenefits( )


Retrieves benefits that can be redeemed for a specific benefit item.

Each benefit item can only be linked to 1 benefit in 1 pool definition. However, each pool created from that pool definition contains the same benefits. This method checks each pool containing a benefit with this benefit item, and returns the benefits that can be redeemed.

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.READ
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
itemReferenceItemReferenceRequired

Item reference.


optionsGetEligibleBenefitsOptions
Returns
Return Type:Promise<GetEligibleBenefitsResponse>
Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?