Credits

GET /v1/credits — wallet balance, held amount, and what is spendable.

GEThttps://iranrouter.com/v1/credits

The wallet balance of the account this key belongs to. In an organization, a key made by someone without billing access (a plain member, or an admin while the owner has not shared billing with admins) gets 403 insufficient_org_role: the owner's balance is not theirs to read.

JSON

{
  "object": "credits",
  "balance_rial": 4500000,
  "held_rial": 120000,
  "available_rial": 4380000,
  "lifetime_deposit_rial": 20000000,
  "currency": "IRR"
}

Field	Meaning
`balance_rial`	Total balance.
`held_rial`	Held for in-flight requests. Temporary; released at settlement.
`available_rial`	What is actually spendable — branch on this one.
`lifetime_deposit_rial`	Everything this account has ever deposited.

How hold and settle work →