> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Resource: Pools

# Type: Pool Object

# Link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/pools/pool-object.md

## Description: A pool contains benefits that can be redeemed by the pool's beneficiary.

## Schema:

```json
 Type: Pool Object | type: Pool
 Description: A pool contains benefits that can be redeemed by the pool's beneficiary.
       - name: id  | type: string | description: Pool ID.
           - name: value  | type: string | description: 
       - name: revision  | type: string | description: Revision number, which increments by 1 each time the pool is updated. To prevent conflicting changes, the current revision must be passed when updating the pool.  Ignored when creating a pool.
           - name: value  | type: string | description: 
       - name: createdDate  | type: string | description: Date and time the pool was created.
           - name: seconds  | type: string | description: 
           - name: nanos  | type: number | description: 
       - name: updatedDate  | type: string | description: Date and time the pool was updated.
       - name: poolDefinitionId  | type: string | description: ID of the associated pool definition.
       - name: programDefinitionId  | type: string | description: ID of the associated program definition.
       - name: programId  | type: string | description: ID of the program that contains this pool.
       - name: status  | type: string | description: Pool status.
           enum: ACTIVE, PAUSED, ENDED, PROVISIONING, RENEWING, PENDING
       - name: beneficiary  | type: IdentificationData | description: Pool beneficiary.
       - name: details  | type: Details | description: Pool benefits and settings.
           - name: benefits  | type: Array<Benefit> | description: List of benefits.
               - name: benefitKey  | type: string | description: Unique identifier for this benefit.  This key is consistent across the pool definition and all associated pools that contain this benefit.
               - name: itemSetId  | type: string | description: ID that is used to associated items with this benefit.
               - name: price  | type: string | description: Price of the benefit in credits. The price is the same for all of this benefit's items.
               - name: additionalData  | type: Struct | description: Additional information for this benefit.
               - name: providerAppId  | type: string | description: ID of the app providing the benefit items.
               - name: displayName  | type: string | description: Benefit name.
               - name: description  | type: string | description: Benefit description.
           - name: creditConfiguration  | type: CreditConfiguration | description: Credit settings.  If this object is empty, you can't set a price for the benefit.
               - name: amount  | type: string | description: Initial available amount for associated balances.
               - name: rolloverConfiguration  | type: RolloverConfiguration | description: Rollover settings.
               - name: unitDisplayName  | type: string | description: Credit unit display name.
           - name: additionalData  | type: Struct | description: Additional information relating to this object.
               - name: fields  | type: object | description: 
       - name: displayName  | type: string | description: Pool name.  You may want to use the same name that's used in the associated pool definition.
       - name: namespace  | type: string | description: 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.
       - name: extendedFields  | type: ExtendedFields | description: Custom field data for the pool object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls.
           - name: namespaces  | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).
       - name: programDefinition  | type: ProgramDefinitionInfo | description: Associated program definition information.
           - name: id  | type: string | description: Program definition ID.
           - name: externalId  | type: string | description: Program definition external ID.
           - name: displayName  | type: string | description: Display name of the program definition.
           - name: description  | type: string | description: Description of the program definition.
       - name: program  | type: ProgramInfo | description: Information about the program containing the pool.
           - name: id  | type: string | description: Program ID.
           - name: externalId  | type: string | description: Program external ID.
           - name: displayName  | type: string | description: Display name of the program.
       - name: poolDefinitionRevision  | type: string | description: Version of the pool definition that this pool was created from.
       - name: renewalCount  | type: number | description: Number of times this pool has been renewed.
           - name: value  | type: number | description: 

```