Skip to main content
POST
/
admin
/
customers
Create Customer
curl --request POST \
  --url https://api.example.com/admin/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_name": "<string>",
  "contact_email": "<string>",
  "tier": "<string>",
  "contract_start": "<string>",
  "contract_end": "<string>",
  "metadata": {}
}
'
{
  "customer": {
    "customer_id": "550e8400-e29b-41d4-a716-446655440000",
    "company_name": "Acme Financial",
    "contact_email": "compliance@acmefinancial.com",
    "tier": "growth",
    "status": "active",
    "api_key_id": "abc123xyz",
    "annual_commitment": 250000,
    "annual_validation_limit": 10000000,
    "created_at": "2026-01-19T10:30:00Z"
  },
  "api_key": "aBcDeFgHiJkLmNoPqRsTuVwXyZ123456",
  "tier_details": {
    "name": "Growth",
    "annual_price": 250000,
    "annual_limit": 10000000,
    "rate_limit": 100,
    "burst_limit": 200
  },
  "warning": "Save the API key now - it will not be shown again"
}
Create a new customer account with the specified tier and generate their API key.
The API key is only shown once in the response. Ensure it is securely saved.

Request Body

company_name
string
required
Client’s company name
contact_email
string
required
Primary contact email address
tier
string
required
Pricing tier: starter, growth, scale, enterprise, or custom
contract_start
string
Contract start date (ISO 8601 format)
contract_end
string
Contract end date (ISO 8601 format)
metadata
object
Additional metadata (JSON object)

Response

customer
object
Customer details
api_key
string
The generated API key (only shown once)
tier_details
object
Details about the assigned tier
warning
string
Reminder to save the API key
{
  "customer": {
    "customer_id": "550e8400-e29b-41d4-a716-446655440000",
    "company_name": "Acme Financial",
    "contact_email": "compliance@acmefinancial.com",
    "tier": "growth",
    "status": "active",
    "api_key_id": "abc123xyz",
    "annual_commitment": 250000,
    "annual_validation_limit": 10000000,
    "created_at": "2026-01-19T10:30:00Z"
  },
  "api_key": "aBcDeFgHiJkLmNoPqRsTuVwXyZ123456",
  "tier_details": {
    "name": "Growth",
    "annual_price": 250000,
    "annual_limit": 10000000,
    "rate_limit": 100,
    "burst_limit": 200
  },
  "warning": "Save the API key now - it will not be shown again"
}

Example

curl -X POST "https://{admin-api-url}/admin/customers" \
  -H "x-api-key: ADMIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Financial",
    "contact_email": "compliance@acmefinancial.com",
    "tier": "growth",
    "contract_start": "2026-01-01",
    "contract_end": "2026-12-31"
  }'