v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB

Customers

Create a customer

This API let’s you to create customers and corresponding accounts.

post/customers

Request body

idstring required

Customer identifier

namestring required

Name of the Customer

primaryEmailstring required

Primary email of the customer

Example request

{
  "id": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
  "name": "ACME Enterprise",
  "primaryEmail": "admin@example.com",
  "account": {
    "id": "ACC00001",
    "name": "Primary Account",
    "primaryEmail": "admin@example.com",
    "netTermDays": 45
  }
}

Response

Response for Create customer request

idstring required

Identifier of customer

togaiCustomerIdstring required

Unique identifier of customer

namestring required

Name of the Customer

primaryEmailstring required

Primary email of the customer

billingAddressstring

Example response

{
  "account": {
    "invoiceCurrency": "USD",
    "primaryEmail": "admin@example.com",
    "status": "ACTIVE"
  }
}