Skip to main content
POST
/
customers
Create customer
curl --request POST \
  --url https://api.example.com/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-environment: <x-environment>' \
  --data '
{
  "name": "<string>",
  "companyName": "<string>",
  "handle": "<string>",
  "email": "<string>",
  "currency": "<string>",
  "billingAddress": {
    "street1": "<string>",
    "street2": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "county": "<string>",
    "country": "<string>",
    "state": "<string>"
  },
  "paymentTerm": "<string>"
}
'
import requests

url = "https://api.example.com/customers"

payload = {
    "name": "<string>",
    "companyName": "<string>",
    "handle": "<string>",
    "email": "<string>",
    "currency": "<string>",
    "billingAddress": {
        "street1": "<string>",
        "street2": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "county": "<string>",
        "country": "<string>",
        "state": "<string>"
    },
    "paymentTerm": "<string>"
}
headers = {
    "x-environment": "<x-environment>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-environment': '<x-environment>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    companyName: '<string>',
    handle: '<string>',
    email: '<string>',
    currency: '<string>',
    billingAddress: {
      street1: '<string>',
      street2: '<string>',
      postalCode: '<string>',
      city: '<string>',
      county: '<string>',
      country: '<string>',
      state: '<string>'
    },
    paymentTerm: '<string>'
  })
};

fetch('https://api.example.com/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'companyName' => '<string>',
    'handle' => '<string>',
    'email' => '<string>',
    'currency' => '<string>',
    'billingAddress' => [
        'street1' => '<string>',
        'street2' => '<string>',
        'postalCode' => '<string>',
        'city' => '<string>',
        'county' => '<string>',
        'country' => '<string>',
        'state' => '<string>'
    ],
    'paymentTerm' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-environment: <x-environment>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/customers"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"companyName\": \"<string>\",\n  \"handle\": \"<string>\",\n  \"email\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"billingAddress\": {\n    \"street1\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"county\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"paymentTerm\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-environment", "<x-environment>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/customers")
  .header("x-environment", "<x-environment>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"companyName\": \"<string>\",\n  \"handle\": \"<string>\",\n  \"email\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"billingAddress\": {\n    \"street1\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"county\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"paymentTerm\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-environment"] = '<x-environment>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"companyName\": \"<string>\",\n  \"handle\": \"<string>\",\n  \"email\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"billingAddress\": {\n    \"street1\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"county\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"paymentTerm\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "handle": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "billingAddress": {
    "street1": "<string>",
    "street2": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "county": "<string>",
    "country": "<string>",
    "state": "<string>"
  },
  "paymentTerm": "<string>",
  "email": "<string>",
  "currency": "<string>"
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

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