Billing API

The Billing API provides access to your organization's subscription status, usage metrics, and invoice history. Use it to monitor API consumption and billing.

Get Subscription Details

{
  "plan": "professional",
  "status": "active",
  "billing_period": "monthly",
  "current_period_start": "2024-02-01T00:00:00Z",
  "current_period_end": "2024-03-01T00:00:00Z",
  "seats": 5,
  "seats_used": 3,
  "features": {
    "api_access": true,
    "custom_branding": true,
    "sso": false,
    "advanced_analytics": true
  }
}

Get Usage Metrics

{
  "period": {
    "start": "2024-02-01T00:00:00Z",
    "end": "2024-03-01T00:00:00Z"
  },
  "usage": {
    "exams_sent": 234,
    "exams_completed": 187,
    "api_requests": 15672,
    "storage_gb": 12.4
  },
  "limits": {
    "exams_included": 500,
    "exams_remaining": 266,
    "api_requests_included": 50000,
    "api_requests_remaining": 34328
  },
  "overage_charges": {
    "exams": 0,
    "api_requests": 0,
    "total": 0
  }
}

List Invoices

{
  "data": [
    {
      "id": "inv_abc123",
      "invoice_number": "TS-2024-02-001",
      "amount": 29900,
      "currency": "usd",
      "status": "paid",
      "issued_at": "2024-02-01T00:00:00Z",
      "paid_at": "2024-02-01T10:23:15Z",
      "pdf_url": "https://invoices.talentscreens.org/..."
    }
  ],
  "pagination": { "total": 14, "limit": 20, "has_more": false }
}

Get Invoice Details