Sign in
Customers

Create customer

Changed on
post/v1/customers

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/customers
  • Auth: HTTP bearer

Request body

external_idstring required
display_namestring required
emailstring
additional_emailsstring[]

Response

Customer created

idstring
external_idstring
display_namestring
emailstring
additional_emailsstring[]

CC'd on billing documents and billing-state emails (invoice, receipt, dunning, payment failed, credit note) — never on credential-bearing emails (setup links, resets, invites). Normalized to lowercase bare addresses, deduped, capped at 10, never equal to the primary email. Stored encrypted at rest.

status'active' | 'archived'
created_atstring date-time
test_clock_idstring

Test clock this customer is pinned to (test mode only). When set, the customer — and any invoices/subscriptions created for it — run on the clock's simulated time. Empty for live customers. The dashboard reads it to show the "test clock" badge + simulated-time banner on the customer and its invoices.

Example response

{
  "id": "vlx_cus_42014438d82ddf33"
}

Changes

  • 4b3946637019Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 2946bdff84c9Revision changes
    • info

      added the optional property to the response with the status