CreditTransaction
- amountType: stringrequired
The credits, as an exact decimal string with at most 6 decimal places: positive for grants, negative for spends.
- createdType: stringFormat: date-time
At requiredWhen it happened: the signal's time for a spend by a signal, the grant's start for a grant, or the grant's last instant (just before its
expiresAt) for an expiration. - Properties: 2creditType:
Currency required - Properties: 2customerType:required
- eventType: string | null
Name requiredFor a spend by a signal, the signal's event name.
- idType: stringrequired
The transaction's ID.
- orderType: string | null
Id requiredThe order whose charge granted the credits or priced the spend; null for grants and adjustments made by hand.
- originType: stringenum
Code requiredGrants:
plan_benefit, an allocation of a charge's credit benefit;one_time, a one-time pack;rollover, unused credits carried into a new period;manual_grant, a grant made by hand. Spends:usage, credits a signal took from a grant;held, credits a signal took from a pending grant, waiting for it to be granted;overage, what the customer's credits didn't cover, billed at the overage price;expiration, credits left on a grant when it expired;manual_grant, an adjustment made by hand.valuesplan_benefitone_timerollovermanual_grantusageheldoverageexpiration - productType: object | nullrequiredProperties: 3
For a spend by a signal, the signal's product; null otherwise.
- signalType: string | null
Id requiredFor a spend by a signal, the signal that used the credits.
- typeType: "grant" or "spend" or "pendingGrant"enumrequired
grant: credits added.spend: credits used, expired, or taken away by an adjustment.pendingGrant: credits granted once the invoice that bills them is posted or paid, not available yet.