About the Pools API

The Pools API allows you to manage your app or site's pools. Use this API together with other Wix Benefit Programs APIs.

With the Pools API, you can:

• Retrieve, create, update, and delete pools.
• Check which benefits a beneficiary can redeem.
• Redeem benefits.

Pools in benefit programs

A pool is a list of benefits that its beneficiary can redeem. It also contains settings that determine how renewing a pool affects its associated balance.

You create pools when you provision programs. Pools are created from pool definitions.

Visitors can redeem benefits from pools in programs they are enrolled in.

Learn more about benefit programs components and lifecycle.

Before you begin

It's important to note the following points before starting to code:

• Sites using this API must install the Pricing Plans app.