An assignment of a catalog item to a benefit in a pool definition.
Pricing and display information for the associated benefit, including credit price, name, and description. Only populated when BENEFIT is included in the fields request parameter.
Unique identifier for the benefit associated with this item.
Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
Date and time the item was created.
External item ID assigned by the provider of the items.
For example, if the benefit items are products, this ID corresponds to the specific product ID in the provider's system.
Benefit item ID. Deterministically generated from pool_definition_id and item_id — if you know both, you can compute the ID without querying.
Item ID.
Display name for the catalog item. Only populated when ITEM is included in the fields request parameter.
Pre-computed search key for the item reference, built by concatenating provider_app_id, category, and external_id separated by /. Use this field for efficient single-field filtering instead of composing three separate conditions.
Internal grouping identifier for this benefit's item set. Use pool_definition_id together with benefit_key to identify a benefit — item_set_id is an implementation detail.
Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
Pool definition details including display name, description, and credit settings. Only populated when POOL_DEFINITION is included in the fields request parameter.
ID of the pool definition - the configuration that defines a set of benefits and which items are accessible within each benefit.
Program definitions that include this item as an accessible benefit. Only id and external_id are returned by default; request PROGRAM_DEFINITION to include display_name and description.
ID of the application providing the benefit items. Each item's external_id is unique within its provider application.
Revision number, which increments by 1 each time the benefit item is updated.
Date and time the item was updated.