Terminology

The Benefit Programs APIs provide functionality to create and manage benefit programs.

This article contains a comprehensive list of the various terms and concepts used in Benefit Programs and its APIs.

Balance

A balance is amount of available credits in a pool.

Beneficiary

A beneficiary is the visitor enrolled in a program who's entitled to redeem benefits in the program's pools. The beneficiary is enrolled in the program's pools.

Benefit

A benefit is a configuration of items and an associated price in credits.

Cascade

Parameter that determines when changes to a program definition or pool definition are applied to associated programs and pools. For example, if a pool definition is added to a program definition, the time at which associated pools will be created in the associated programs.

Credit

Credits is the currency used in benefit programs. Credits can be given a display name, such as Tokens.

Item set

An item set is a list of items contained by a specific benefit.

Item

An item is a reference to a reward, product, or service provided by another app. Each benefit item is contained by 1 benefit.

Pool definition

A pool definition is a configuration of benefits and credit settings that acts as a template for future pools.

Pool

A pool is a configuration of benefits and credit settings assigned to a beneficiary. The beneficiary can redeem benefits in the pool if there are enough available credits in the pool's associated balance.

Program definition

A program definition is a list of pool definitions that acts as a template for future programs.

Program

A program is a list of pools assigned to a beneficiary.

Provisioning

Creating a program and assigning a beneficiary to it.

Learn more about provision programs.

Redeeming a benefit

Exchanging credits for rewards, products, or services.

Transaction

A transaction is a record of a change to a balance.

Did this help?