CreditBalance

A customer's pool of one credit currency for one recipient.

  • Credits left to use in the active grants, less, for an organization pool, any overage since they began; negative when usage went beyond them. Rounded to 6 decimal places.

  • The pool's grants that have started and haven't expired, soonest expiry first (grants that never expire last).

    Properties: 12
  • Credits in pending grants, granted once their invoice is posted or paid. Rounded to 6 decimal places.

  • The soonest expiresAt of the pool's grants; null when none of them expires.

  • The earliest periodStart of the pool's grants; now, for a pool at zero.

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

  • When carried-over credits in the pool expire; null when none are carried over.

  • Credits granted across the pool's active grants (pending ones are in pending).

  • Credits used from the active grants, plus that overage.

  • For a seat pool, the seat's ID. Not present on organization pools.

  • For a seat pool, your ID for the user holding the seat (the data.external_user_id their signals carry); null while the seat is unassigned. Not present on organization pools.