Create a customer
curl --request POST \
--url https://api.salesbricks.com/api/v2/customers \
--header 'Content-Type: application/json' \
--header 'X-SALESBRICKS-KEY: <api-key>' \
--data '
{
"name": "<string>",
"legal_name": "<string>",
"external_id": "<string>",
"stripe_customer_id": "<string>",
"tax_id": "<string>"
}
'import requests
url = "https://api.salesbricks.com/api/v2/customers"
payload = {
"name": "<string>",
"legal_name": "<string>",
"external_id": "<string>",
"stripe_customer_id": "<string>",
"tax_id": "<string>"
}
headers = {
"X-SALESBRICKS-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SALESBRICKS-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
legal_name: '<string>',
external_id: '<string>',
stripe_customer_id: '<string>',
tax_id: '<string>'
})
};
fetch('https://api.salesbricks.com/api/v2/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.salesbricks.com/api/v2/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>',
'legal_name' => '<string>',
'external_id' => '<string>',
'stripe_customer_id' => '<string>',
'tax_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SALESBRICKS-KEY: <api-key>"
],
]);
$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.salesbricks.com/api/v2/customers"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"stripe_customer_id\": \"<string>\",\n \"tax_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SALESBRICKS-KEY", "<api-key>")
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.salesbricks.com/api/v2/customers")
.header("X-SALESBRICKS-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"stripe_customer_id\": \"<string>\",\n \"tax_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesbricks.com/api/v2/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SALESBRICKS-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"stripe_customer_id\": \"<string>\",\n \"tax_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"legal_name": "<string>",
"subscriptions": [
{
"subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"starts_at": "2023-12-25",
"ends_at": "2023-12-25"
}
],
"external_id": "<string>",
"address": {
"line_1": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>",
"line_2": "<string>",
"region": "<string>"
},
"stripe_customer_id": "<string>",
"tax_id": "<string>"
}{
"error": {
"code": "ERR_BAD_REQUEST",
"message": "Bad request — the input payload is malformed, missing required fields, or contains invalid data."
}
}Customers
Create a customer
Creates a new customer.
POST
/
customers
Create a customer
curl --request POST \
--url https://api.salesbricks.com/api/v2/customers \
--header 'Content-Type: application/json' \
--header 'X-SALESBRICKS-KEY: <api-key>' \
--data '
{
"name": "<string>",
"legal_name": "<string>",
"external_id": "<string>",
"stripe_customer_id": "<string>",
"tax_id": "<string>"
}
'import requests
url = "https://api.salesbricks.com/api/v2/customers"
payload = {
"name": "<string>",
"legal_name": "<string>",
"external_id": "<string>",
"stripe_customer_id": "<string>",
"tax_id": "<string>"
}
headers = {
"X-SALESBRICKS-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SALESBRICKS-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
legal_name: '<string>',
external_id: '<string>',
stripe_customer_id: '<string>',
tax_id: '<string>'
})
};
fetch('https://api.salesbricks.com/api/v2/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.salesbricks.com/api/v2/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>',
'legal_name' => '<string>',
'external_id' => '<string>',
'stripe_customer_id' => '<string>',
'tax_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SALESBRICKS-KEY: <api-key>"
],
]);
$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.salesbricks.com/api/v2/customers"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"stripe_customer_id\": \"<string>\",\n \"tax_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SALESBRICKS-KEY", "<api-key>")
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.salesbricks.com/api/v2/customers")
.header("X-SALESBRICKS-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"stripe_customer_id\": \"<string>\",\n \"tax_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesbricks.com/api/v2/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SALESBRICKS-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"stripe_customer_id\": \"<string>\",\n \"tax_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"legal_name": "<string>",
"subscriptions": [
{
"subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"starts_at": "2023-12-25",
"ends_at": "2023-12-25"
}
],
"external_id": "<string>",
"address": {
"line_1": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>",
"line_2": "<string>",
"region": "<string>"
},
"stripe_customer_id": "<string>",
"tax_id": "<string>"
}{
"error": {
"code": "ERR_BAD_REQUEST",
"message": "Bad request — the input payload is malformed, missing required fields, or contains invalid data."
}
}Authorizations
API key for authentication
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Customer post input serializer for creating a new customer.
The name of the customer
Optional legal name of the customer, used as the buyer name on invoices
Optional external id of the customer
The address of the customer
Show child attributes
Show child attributes
Optional Stripe customer ID to associate with this customer
Tax identification number (e.g., EIN, VAT number)
Response
Customer output serializer; we can represent the customer model differently depending on the request so we need a custom serializer for the output.
List of subscriptions associated with this customer
Show child attributes
Show child attributes
Maximum string length:
255The address of the customer
Show child attributes
Show child attributes
The companies stripe customer_id
Maximum string length:
255Tax identification number (e.g., EIN, VAT number)
⌘I