Skip to main content

Reseller API - Data Models

Data schemas for Reseller API.

Customer Object​

{
  "id": 123,
  "name": "Acme Corporation",
  "email": "admin@acme.com",
  "plan": "gold",
  "status": "active",
  "quota_minutes": 10000,
  "usage": {
    "transcription_minutes": 450,
    "quota_minutes": 10000,
    "usage_percent": 4.5
  },
  "metadata": {
    "industry": "healthcare",
    "account_manager": "john@reseller.com"
  },
  "created_at": "2025-01-17T10:00:00Z",
  "updated_at": "2025-01-17T15:30:00Z"
}

Usage Object​

{
  "customer_id": 123,
  "period": {
    "start": "2025-01-01",
    "end": "2025-01-31"
  },
  "usage": {
    "transcription_minutes": 450,
    "quota_minutes": 10000,
    "usage_percent": 4.5,
    "custom_models": 2,
    "documents_created": 45,
    "api_calls": 1200
  },
  "breakdown": {
    "batch_transcription": 400,
    "realtime_transcription": 50
  }
}

Plan Types​

  • bronze - 500 min/month
  • silver - 2,000 min/month
  • gold - 10,000 min/month
  • enterprise - Custom

Customer Status​

  • active - Active subscription
  • suspended - Temporarily suspended
  • cancelled - Subscription cancelled