Skip to content
roasOS API
Esc
navigateopen⌘Jpreview

Get account info and credit balance

GET/v1/account
Responses
200Workspace info, confirmed credit balance, and subscription status
dataobjectrequired
Show properties
workspaceobjectrequired
Show properties
idstring<uuid>required
namestringrequired
min length 1 · max length 255
created_atstring<date-time>required
creditsobjectrequired
Show properties
balanceintegerrequired
min 0
availableintegerrequired
min 0
reservedintegerrequired
min 0
pending_refundsintegerrequired
min 0
uncertain_debitsintegerrequired
min 0
uncertain_creditsintegerrequired
min 0
statusstringrequired
Allowed:confirmed
subscriptionobject | nullrequired
Show properties
planstring | nullrequired
min length 1 · max length 128
statusstringrequired
min length 1 · max length 128
Request
curl -X GET "https://api.roasos.com/v1/account"
Response
{
  "data": {
    "workspace": {
      "id": "<uuid>",
      "name": "string",
      "created_at": "2024-01-01T00:00:00Z"
    },
    "credits": {
      "balance": 0,
      "available": 0,
      "reserved": 0,
      "pending_refunds": 0,
      "uncertain_debits": 0,
      "uncertain_credits": 0,
      "status": "confirmed"
    },
    "subscription": {
      "plan": "string",
      "status": "string"
    }
  }
}