> 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: Balances

# Type: Balance Object

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

## Description: A balance is the number of available credits in a pool.

## Schema:

```json
 Type: Balance Object | type: Balance
 Description: A balance is the number of available credits in a pool.
       - name: id  | type: string | description: Balance ID. This is the same as the associated pool's ID.
       - name: revision  | type: string | description: Revision number, which increments by 1 each time the balance is updated. To prevent conflicting changes, the current revision must be passed when updating the balance.
           - name: value  | type: string | description: 
       - name: createdDate  | type: string | description: Date and time the balance was created.
           - name: seconds  | type: string | description: 
           - name: nanos  | type: number | description: 
       - name: updatedDate  | type: string | description: Date and time the balance was updated.
       - name: beneficiary  | type: IdentificationData | description: Beneficiary of the associated pool.
       - name: amount  | type: BalanceAmount | description: Available credits.
           - name: available  | type: string | description: number of available credits.
           - name: reserved  | type: string | description: number of reserved credits.
       - name: poolInfo  | type: PoolInfo | description: Associated pool information.
           - name: id  | type: string | description: Pool ID.
           - name: poolDefinitionId  | type: string | description: ID of the pool definition the pool was created from.
               - name: value  | type: string | description: 
           - name: programDefinitionId  | type: string | description: ID of the program definition the pool was created from.
           - name: programId  | type: string | description: ID of the program that contains the pool.
           - name: creditAmount  | type: string | description: Available credits.
           - 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: externalProgramDefinitionId  | type: string | description: External ID of the program definition the pool was created from.
           - name: externalProgramId  | type: string | description: External ID of the program that contains the pool.
           - name: creditRolloverConfiguration  | type: RolloverConfigurationInfo | description: Credit rollover configuration information for the pool.
               - name: enabled  | type: boolean | description: Whether unused credits roll over to a new cycle when a program renews.
               - name: balanceCap  | type: string | description: Maximum number of credits that can roll over to the next cycle when a program renews.
           - name: status  | type: string | description: Pool status
               enum: ACTIVE, PAUSED, ENDED, PROVISIONING, RENEWING, PENDING
       - name: extendedFields  | type: ExtendedFields | description: Custom field data for the balance 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: lastTransactionId  | type: string | description: ID of the transaction associated with the most recent change to the balance.

```