VayuDocumentationIntegrationsAPI ReferenceChange Log
SupportGet started now
GuidesCustomers

Managing Customers

Create, update, and delete customer records through the UI and API

Overview

Vayu provides multiple ways to manage customer records, including creating new customers, updating existing profiles, organizing parent-child relationships, searching and filtering customer records, exporting customer data, and removing customer data when needed.

Creating customers

Through the UI

To create a new customer:

Add Customer

  1. Navigate to Customers.
  2. Click + Customer in the control bar.
  3. Fill in the customer details:
    • Name and legal name
    • Contact information
    • Billing address
    • Tax ID
    • Currency
    • Payment terms, such as due days
    • Custom fields
  4. Save the customer profile.

Through the API

Use the POST /customers endpoint to create customers programmatically:

{
  "name": "Acme Corporation",
  "legalName": "Acme Corp Inc.",
  "contacts": [
    {
      "name": "John Smith",
      "email": "jsmith@example.com",
      "title": "CFO",
      "receiveInvoiceEmail": true
    }
  ],
  "address": {
    "country": "United States",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "addressText": "123 Main Street"
  },
  "currency": "USD",
  "dueDays": "NET_30"
}

Updating customers

Through the UI

Update customer settings

To update an existing customer:

  1. Navigate to Customers.
  2. Select the customer from the table.
  3. Go to the Settings tab.
  4. Modify the fields you need to update.
  5. Save your changes.

Through the API

Use the PUT /customers/{customerId} endpoint to update customer records:

{
  "name": "Updated Company Name",
  "dueDays": "NET_45"
}

Deleting customers

Through the API

Use the DELETE /customers/{customerId} endpoint to remove a customer:

DELETE /customers/{customerId}

Important considerations

When deleting a customer:

  • The deletion is permanent and cannot be undone
  • All associated data, such as contracts, invoices, and usage, will be affected
  • Consider the impact on historical reporting and audit trails
  • Ensure compliance with data retention policies

Customer hierarchy

Vayu supports hierarchical relationships between customers, allowing you to organize accounts into parent and child entities. This structure helps manage billing, usage, and reporting across complex organizational structures.

Managing hierarchy

To assign a parent-child relationship:

  1. Navigate to the Customers page.
  2. Select the child customer you wish to link.
  3. Open the Settings tab.
  4. Locate the Parent Customer field and select the appropriate parent entity from the dropdown.
  5. Save your changes.

Searching and filtering

The Customers page provides search and filter capabilities.

Use the search field to find customers by:

  • Customer name
  • Email address
  • Other indexed fields
  • Parent or child entity name

Results update automatically as you type.

Advanced filtering

Click Filters to build complex queries using:

  • Status: Active, Inactive, Churned, or Trial
  • Parent or child hierarchy: Filter by parent-child relationships and customer hierarchy
  • Address fields: Country, State, City, or Postal Code
  • Subsidiary: Filter by subsidiary assignment
  • Manual Review: Filter by manual review status

Multiple conditions can be combined to narrow results.

Exporting customer data

To export customer information:

Export customer data

  1. Apply any desired filters.
  2. Click the Export / Download button next to the + Create Customer button.
  3. Download the file.

API reference

For complete API documentation, see:

On this page