Sign in
Customers

Create a customer.

post/v2/customers

Headers

Idempotency-Keystring

Non-empty idempotency key for deduplicating write requests on the same route.

Example:6f31c20e-725c-4be8-96f4-835042f67602

Optional. Duplicate keys within the same company namespace and route return 409.

Request body

namestring required

Customer name. Maximum 256 Unicode scalar values.

external_idstring nullable

Optional caller-supplied external identifier. Maximum 256 Unicode scalar values.

stripe_customer_idstring nullable

Optional Stripe customer identifier. Maximum 256 Unicode scalar values.

quickbooks_customer_idstring uuid nullable

Optional QuickBooks customer UUID.

Example request

{
  "name": "Acme",
  "external_id": "crm_acme_001",
  "stripe_customer_id": "cus_NffrFeUfNV2Hib",
  "quickbooks_customer_id": "018f5f0c-1111-7abc-8def-123456789abc"
}

Response

Created.

idstring uuid required

Customer UUID.

namestring required

Customer name.

external_idstring nullable required

Optional caller-supplied external identifier.

stripe_customer_idstring nullable required

Optional Stripe customer identifier.

quickbooks_customer_idstring uuid nullable required

Optional QuickBooks customer UUID.

created_atinteger required

Unix timestamp in seconds.

updated_atinteger required

Unix timestamp in seconds.

Example response

{
  "id": "018f5f0c-1111-7abc-8def-123456789abc",
  "name": "Acme",
  "external_id": "crm_acme_001",
  "stripe_customer_id": "cus_NffrFeUfNV2Hib",
  "quickbooks_customer_id": "018f5f0c-1111-7abc-8def-123456789abc",
  "created_at": 1767225600,
  "updated_at": 1767225600
}

Changes