CreditBalanceGrant
One grant in a pool.
- availableType: numberrequired
Credits left to use; 0 while the grant is
pending. Rounded to 6 decimal places. - expiresType: string | nullFormat: date-time
At requiredWhen unused credits are lost. A plan allowance ends with its allocation period; null for a grant that never expires.
- idType: stringrequired
The grant's ID.
- isType: boolean
In Rollover Window requiredWhether the grant holds credits carried over from an earlier period, usable until
rolloverEndDate. - originType: stringenumrequired
Where the credits came from:
plan_benefit, an allocation of a charge's credit benefit;one_time, a one-time pack;rollover, unused credits carried over from an earlier period;manual_grant, a grant made by hand.valuesplan_benefitone_timerollovermanual_grant - periodType: string | nullFormat: date-time
End requiredWhen its period ends, the same as
expiresAt; null for a grant that never expires. - periodType: stringFormat: date-time
Start requiredWhen its credits became available: the start of the allocation period for a plan allowance,
startsAtfor a grant made by hand. - rolloverType: number | null
Amount requiredFor credits carried over from an earlier period, how many were carried over; null for any other grant.
- rolloverType: string | nullFormat: date-time
End Date requiredFor carried-over credits, when they expire; null for any other grant.
- statusType: "active" or "pending"enumrequired
active: the credits can be used.pending: they're granted once the invoice that bills the charge for their period (or its one-time fee) is posted or paid (the benefit'screditGrantTiming), and usage taken from them is held until then. - totalType: numberrequired
Credits granted.
- usedType: numberrequired
Credits taken from it, including usage held against it while it's
pending.