Balance Object


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

Properties
idstringRead-onlyformat GUIDimmutable

Balance ID. This is the same as the associated pool's ID.


revisionstringRead-onlyformat int64

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.


createdDatestringRead-onlyformat date-time

Date and time the balance was created.


updatedDatestringRead-onlyformat date-time

Date and time the balance was updated.


beneficiaryBeneficiaryRead-onlyimmutable

Beneficiary of the associated pool.


amountAmountRead-only

Available credits.


poolInfoPoolInfoRead-only

Associated pool information.


extendedFieldsExtendedFields

Custom field data for the balance object. Extended fields must be configured in the app dashboard before they can be accessed with API calls.


lastTransactionIdstringRead-onlyformat GUID

ID of the transaction associated with the most recent change to the balance.

Did this help?