CreditBalance
A customer's pool of one credit currency for one recipient.
- availableType: numberrequired
Credits left to use in the active grants, less, for an
organizationpool, any overage since they began; negative when usage went beyond them. Rounded to 6 decimal places. - creditsType: string
Currency Id required - currencyType: string
Key required - currencyType: string
Name required - grantsType:requiredProperties: 12
The pool's grants that have started and haven't expired, soonest expiry first (grants that never expire last).
- pendingType: numberrequired
Credits in pending grants, granted once their invoice is posted or paid. Rounded to 6 decimal places.
- periodType: string | nullFormat: date-time
End requiredThe soonest
expiresAtof the pool's grants; null when none of them expires. - periodType: stringFormat: date-time
Start requiredThe earliest
periodStartof the pool's grants; now, for a pool at zero. - recipientType: "organization" or "seat"enumrequired
Who the pool belongs to:
organization, the customer as a whole;seat, one seat on a seat-based charge, whose user's signals spend these credits before the customer's. - rolloverType: string | nullFormat: date-time
End Date requiredWhen carried-over credits in the pool expire; null when none are carried over.
- totalType: numberrequired
Credits granted across the pool's active grants (pending ones are in
pending). - usedType: numberrequired
Credits used from the active grants, plus that overage.
- seatType: string
Id For a
seatpool, the seat's ID. Not present onorganizationpools. - userType: string | null
External Id For a
seatpool, your ID for the user holding the seat (thedata.external_user_idtheir signals carry); null while the seat is unassigned. Not present onorganizationpools.