Create a customer

A request to create a quote is submitted as followed.

POST /customers
{
  "name": "Acme Corp",
  "external_id": "EXT-ACME-001",
  "legal_name": "Acme Corporation LLC",
  "business_registration_number": "BRN-123456789",
  "website": "https://www.acmecorp.example.com",
  "interconnected": true,
  "preferred_currency": "EUR",
  "monthly_availability_request_limit": 100,
  "internal_notes": "Priority customer; SLA 24/7 support",
  "agent_id": "agent_42",
  "network_name_override": "Hidden network",
  "customer_region": "Asia-Pacific",
  "financial_details": {
    "name": "Jane Doe",
    "email": "[email protected]",
    "street": "Main Street",
    "house_number": "123",
    "house_number_addition": "A",
    "postal_code": "10001",
    "city": "Metropolis",
    "region": "Central",
    "country_code": "NL",
    "vat_number": "NL999888777B01",
    "bank_account_number": "NL12BANK0123456789",
    "apply_vat": true,
    "payment_term_days": 30
  }
}

All of these values, apart from name , are optional.

Response
{
    "data": {
        "id": "687108914e0bed9042072fb7",
        "price_plan": {
            "id": "687108914e0bed9042072fb6",
            "name": "Default price plan",
            "_document_type": "price_plan"
        },
        "account_manager": {
            "id": "687108914e0bed9042072fb5",
            "first_name": "John",
            "last_name": "Doe",
            "_document_type": "user"
        },
        "interconnected": true,
        "preferred_currency": "EUR",
        "monthly_availability_requests_upper_limit": 375,
        "monthly_availability_request_limit": 10,
        "monthly_availability_request_checks": 0,
        "apply_vat": true,
        "internal_notes": "Priority customer; SLA 24/7 support",
        "abbreviated_name": "ACM",
        "network_name_override": false,
        "customer_region": "Europe",
        "auto_number": "CUS-1234",
        "name": "Acme Corp",
        "external_id": "EXT-ACME-001",
        "legal_name": "Acme Corporation LLC",
        "business_registration_number": "BRN-123456789",
        "website": "https://www.acmecorp.example.com",
        "financial_contact_name": "Jane Doe",
        "financial_contact_email": "[email protected]",
        "street": "Main street",
        "house_number": "123",
        "house_number_addition": "A",
        "postal_code": "10001",
        "city": "Metropolis",
        "region": "Central",
        "country_code": "NL",
        "vat_number": "NL999888777B01",
        "bank_account_number": "NL12BANK0123456789",
        "billing_details": {
            "payment_term_days": 30
        },
        "_document_type": "customer"
    },
    "message": "The customer was successfully created."
}

Last updated

Was this helpful?