redeemBenefit( )

Developer Preview

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

Redeems a specified benefit.

Calling this method records redemption of the benefit and adjusts the pool's associated balance. You still need to handle providing the beneficiary with the item.

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

ID of the pool that contains the benefit to redeem.

optionsRedeemBenefitOptions
Returns
Return Type:Promise<RedeemBenefitResponse>
Errors
404Not Found

There are 2 errors with this status code.

409Already Exists

There is 1 error with this status code.

428Failed Precondition

There are 3 errors with this status code.

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

Did this help?