v1

latestOpenAPI 3.1.02026-07-2665164286.3 KB
User

Get Current User

Returns the authenticated user's profile, remaining credits or balance, and billing details.

get/v3/users/me

Response

Successful response

Example response

{
  "data": {
    "username": "user_abc123",
    "email": "user@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "wallet": {
      "remaining_balance": 125.5,
      "auto_reload": {
        "enabled": true,
        "threshold_usd": 10,
        "amount_usd": 50
      }
    },
    "subscription": {
      "credits": {
        "premium_credits": {
          "remaining": 500,
          "resets_at": "2024-05-01T00:00:00Z"
        },
        "add_on_credits": {
          "remaining": 500,
          "resets_at": "2024-05-01T00:00:00Z"
        }
      }
    },
    "usage_based": {
      "spending_current_usd": 42.5,
      "spending_cap_usd": 100,
      "included_credits": 4444,
      "remaining_credits": 4426.9
    }
  }
}