Skip to main content
POST
Create a customer

Authorizations

X-API-Key
string
header
required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

X-Idempotency-Key
string
required

Unique caller-generated key for one create request. Once an authenticated, schema-valid request reaches the operation, the key is permanently consumed for that operation and legal entity whether the operation succeeds or fails. Reusing it in that scope returns 409 and never replays a response, unlike API v1, which replays the original response for a matching key.

Required string length: 1 - 255

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Body

application/json
name
string
required

The name invoices are addressed to.

Required string length: 1 - 255
email
string<email>
required

Where invoices and reminders are sent.

phone
string
Required string length: 1 - 50
address
Address · object

Response

The created customer.

Someone you invoice. An invoice copies the customer's name, email and address into its billedTo when it's created, so editing a customer doesn't change invoices already issued.

id
string
required

Customer id with the le_cus_ prefix.

Example:

"le_cus_2rj4l7hmrrrcv"

name
string
required

The name invoices are addressed to.

Example:

"Acme Robotics"

email
string
required

Where invoices and reminders are sent.

Example:

"ap@acme.example"

status
enum<string>
required

archived marks a customer you no longer bill. Archived customers can still be invoiced and are listed unless you filter by status.

Available options:
active,
archived
createdAt
string<date-time>
required
phone
string
Example:

"+14155550123"

address
Address · object