Skip to main content

Documentation Index

Fetch the complete documentation index at: https://virtualsms.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

GET /api/v1/customer/profile Returns metadata about the authenticated account.
curl https://virtualsms.io/api/v1/customer/profile \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "you@example.com",
  "telegram_linked": true,
  "telegram_username": "yourhandle",
  "balance_usd": 25.50,
  "total_spent_usd": 142.30,
  "total_credits_usd": 0,
  "total_orders": 87,
  "active_api_keys": 2,
  "created_at": "2024-12-01T10:30:00Z"
}

Notes

  • telegram_linked indicates whether the user has connected their Telegram account
  • total_orders is the lifetime order count (including cancelled and expired)
  • active_api_keys is the number of un-revoked API keys on the account