Skip to main content

CreditsInfo

Breakdown of a caller's credit wallet. Three buckets fund one balance: plan is granted by the subscription for the current period and is burned at the rollover, while referral and bonus never expire. Render available — the other five fields are the breakdown behind it.

totalinteger<int32>required

Sum of the three bucket balances exactly as stored (plan + referral + bonus), with neither expiry nor the subscription gate applied. Diagnostic: it can exceed available.

Possible values: >= 0

planinteger<int32>required

Balance granted by the subscription for the current period. Whatever is left of it is burned at the period rollover, never carried over.

Possible values: >= 0

referralinteger<int32>required

Balance granted for referrals. Never expires.

Possible values: >= 0

bonusinteger<int32>required

Balance granted manually (support, promotions). Never expires.

Possible values: >= 0

availableinteger<int32>required

What the caller can actually spend right now: plan counted only while the current period window is still open, plus referral and bonus — and zero whenever the subscription is not active, since referral and bonus credits are not spendable without one. This is the field a client should render.

Possible values: >= 0

usedinteger<int32>required

Spends in the CURRENT period, across all three buckets. It resets at the period rollover; it is not a lifetime total.

Possible values: >= 0

CreditsInfo
{
"total": 0,
"plan": 0,
"referral": 0,
"bonus": 0,
"available": 0,
"used": 0
}