POST

Check Benefit Eligibility By Filter


Checks benefit eligibility across the beneficiary's pools that contain a benefit for the given item.

Pools are matched by itemReference within namespace and must belong to beneficiary, which defaults to the calling identity. poolSelector narrows the matched pools further.

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

Each benefit is checked independently. For example, if there is a benefit with a price of 3 credits and a benefit with a price of 4 credits, and there are 5 available credits, both benefits would be returned as eligible, but they can't both be redeemed.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permission Scopes
Manage benefit programs
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/benefit-programs/v1/pools/check-benefit-eligibility-by-filter

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?