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
  • 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
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?