Skip to main content
POST
Create customer

Headers

x-environment
string<uuid>
required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Body

application/json

Properties to create.

name
string | null
required

The customer's full name.

companyName
string | null

An optional business name.

handle
string | null

A unique identifier for the customer. If no identifier is provided, one will be generated automatically.

email
string | null

The customer's email address.

currency
string | null

Three-letter ISO currency code, in lowercase. Must be a supported currency (https://go.plude.io/h11101).

billingAddress
object
paymentTerm
string | null

Response

OK

id
string<uuid>

Unique id of the customer.

name
string | null

Name of the customer.

handle
string | null

Unique handle of the customer.

createdAt
string<date-time>

Date and time when the product was created.

updatedAt
string<date-time> | null

/// Date and time when the product was last updated.

billingAddress
object
paymentTerm
string | null

Preferred payment term of customer. See https://docs.plude.io/invoicing/payment-terms.

email
string | null

Email of the customer.

currency
string | null

Optional sets the preferred currency of this customer.

collectionMode
enum<string>
Available options:
automatic,
send_invoice,
draft_invoice