Get user credit balance

GET /api/v1/user/balance

Free (0 credits) Permission: user:read

Returns the authenticated user's ID and current credit balance.

Authorization

bearerAuth: optional HTTP

apiKeyAuth: optional API key in header

Returns

200

Current user balance

JSON

user_id: required string
credit_balance: required integer

401

Missing or invalid API key or OAuth access token

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

404

Requested user or resource not found

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

429

Rate limit or daily request quota exceeded

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

500

Internal server error

JSON

error: required string

Human-readable error message
error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction

Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.

Get user credit balance

curl --request GET \
  --url https://api.threadapi.dev/api/v1/user/balance \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.threadapi.dev/api/v1/user/balance';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "user_id": "usr_12345",
  "credit_balance": 100
}

{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}

{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}

{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}

{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}