CreditBalanceGrant

One grant in a pool.

  • Credits left to use; 0 while the grant is pending. Rounded to 6 decimal places.

  • When unused credits are lost. A plan allowance ends with its allocation period; null for a grant that never expires.

  • The grant's ID.

  • Whether the grant holds credits carried over from an earlier period, usable until rolloverEndDate.

  • 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.

    values
    plan_benefitone_timerollovermanual_grant
  • When its period ends, the same as expiresAt; null for a grant that never expires.

  • When its credits became available: the start of the allocation period for a plan allowance, startsAt for a grant made by hand.

  • For credits carried over from an earlier period, how many were carried over; null for any other grant.

  • For carried-over credits, when they expire; null for any other grant.

  • 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's creditGrantTiming), and usage taken from them is held until then.

  • Credits granted.

  • Credits taken from it, including usage held against it while it's pending.