Docs
API 1.39
Status
Objects

Credits

The Credits object of the Kaabist API.

FieldTypeRequiredDescription
balancenumberyes
reservednumberyes
availablenumberyes
poolsobjectyes
pools[].type"promo", "allowance", "purchased", "overage"yes
pools[].amountnumberyes
pools[].expires_atstring or null (date-time)yes
auto_rechargeobject or nullyes
auto_recharge.thresholdnumberyes
auto_recharge.amountnumberyes

#Example

{
  "balance": 1200,
  "reserved": 40,
  "available": 1160,
  "pools": [
    {
      "type": "allowance",
      "amount": 1000,
      "expires_at": "2026-10-01T00:00:00Z"
    },
    {
      "type": "purchased",
      "amount": 200,
      "expires_at": null
    }
  ],
  "auto_recharge": {
    "threshold": 200,
    "amount": 1000
  }
}

Was this page helpful?