Create a customer

POST https://api.tamio.com/v2/customers/create

Creates a new customer with optional billing and shipping addresses. The customer email must be unique within your account.

Body Parameters

name string*

Customer's first name

email string*

Customer's email address

country string*

Two-letter ISO country code

last_name string

Customer's last name

company string

Company name (if applicable)

phone string

Customer's phone number

locale string

Preferred language/locale code

timezone_offset string

Timezone offset from UTC

same_shipping_address boolean

Use billing address as shipping address

teammate_id string

UUID of the teammate to assign

billing_information object

Billing address and contact information for the customer

JSON

{ "billing_information": { "name": "John", "last_name": "Doe", "country": "de", "address": "Friedrichstraße 123", "city": "Berlin", "company": "Acme GmbH", "postcode": "10117", "state": "BE", "email": "[email protected]", "phone": "+49 30 1234567", "vat": "DE123456789", "locale": "de", "is_company": true, "representative": "Hans Müller", "shipping_address": false } }

name string*

Billing contact first name

last_name string

Billing contact last name

country string*

Two-letter ISO country code for the billing address

address string*

Billing street address

city string*

Billing address city

company string

Company name for billing

postcode string

Billing address postal/zip code

state string

Billing address state or province

email string

Billing contact email address

phone string

Billing contact phone number

vat string

VAT identification number for tax purposes

locale string

Preferred language/locale for billing communications

is_company boolean

Whether the billing entity is a company

representative string

Authorized representative name (for company billing)

shipping_address boolean

Whether this billing address should also be used as the shipping address

shipping_information object

Shipping address and delivery information for the customer

JSON

{ "shipping_information": { "name": "John", "last_name": "Doe", "country": "de", "address": "Alexanderplatz 1", "city": "Berlin", "company": "Acme GmbH", "message": "Leave at reception desk", "postcode": "10178", "state": "BE", "email": "[email protected]", "phone": "+49 30 9876543", "locale": "de", "shipping_address": false } }

name string*

Shipping recipient first name

last_name string

Shipping recipient last name

country string*

Two-letter ISO country code for the shipping address

address string*

Shipping street address

city string*

Shipping address city

company string

Company name for shipping label

message string

Special delivery instructions or notes

postcode string

Shipping address postal/zip code

state string

Shipping address state or province

email string*

Shipping contact email address

phone string

Shipping contact phone number

locale string

Preferred language/locale for shipping communications

shipping_address boolean

Marks this as a valid shipping address

Example

{
  "name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "country": "de",
  "locale": "en",
  "billing_information": {
    "name": "John",
    "last_name": "Doe",
    "country": "de",
    "address": "123 Main St",
    "city": "Berlin",
    "postcode": "10115",
    "email": "[email protected]"
  }
}

Responses

200 Customer created successfully

Customer created successfully

status integer

customer Customer

400 Validation or business-logic error.

Validation or business-logic error.

Code	Description
`10142`	A customer with this email already exists in your account

status integer

error string

error_code integer

401 Unauthorized – invalid or missing Bearer token

List all customers

Update a customer

/customers/create

1 const response = await fetch("https://api.tamio.com/v2/customers/create", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     "name": "John",
9     "last_name": "Doe",
10     "email": "[email protected]",
11     "country": "de",
12     "locale": "en",
13     "billing_information": {
14       "name": "John",
15       "last_name": "Doe",
16       "country": "de",
17       "address": "123 Main St",
18       "city": "Berlin",
19       "postcode": "10115",
20       "email": "[email protected]"
21     }
22   })
23 });
24 const data = await response.json();

1 require "uri"
2 require "net/http"
3 require "json"
4 
5 url = URI("https://api.tamio.com/v2/customers/create")
6 
7 https = Net::HTTP.new(url.host, url.port)
8 https.use_ssl = true
9 
10 request = Net::HTTP::Post.new(url)
11 request["Accept"] = "application/json"
12 request["Authorization"] = "Bearer YOUR_API_KEY"
13 request["Content-Type"] = "application/json"
14 request.body = {
15   name: "John",
16   last_name: "Doe",
17   email: "[email protected]",
18   country: "de",
19   locale: "en",
20   billing_information: {
21     name: "John",
22     last_name: "Doe",
23     country: "de",
24     address: "123 Main St",
25     city: "Berlin",
26     postcode: "10115",
27     email: "[email protected]"
28   }
29 }.to_json
30 
31 response = https.request(request)
32 puts response.read_body

Responses

{
  "status": 200,
  "customer": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "object": "customer",
    "email": "[email protected]",
    "name": "John",
    "last_name": "Doe",
    "country": "de",
    "locale": "en",
    "timezone_offset": "+00:00",
    "phone": "+49123456789",
    "stripe_customer_id": "cus_P2BjgLkL",
    "teammate_id": "cc6e91ea-0275-408a-8106-25f0e3fcbd83",
    "affiliate_partner_id": "bb6e91ea-0275-408a-8106-25f0e3fcbd82",
    "has_notes": false,
    "created_at": 1700000000,
    "billing_addresses": [
      {
        "id": "0380f2d4-1a26-4074-8b6b-87b64f3d1b6e",
        "object": "address",
        "name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "address": "123 Main St",
        "city": "New York",
        "postcode": "10001",
        "state": "NY",
        "country": "us",
        "locale": "en",
        "phone": "+441234567890",
        "company": "Tamio Inc",
        "message": "Leave at front door",
        "shipping_address": false,
        "is_company": true,
        "vat": "US12345678",
        "verified_vat": true,
        "custom_billing_fields": {}
      }
    ],
    "shipping_addresses": [
      {
        "id": "0380f2d4-1a26-4074-8b6b-87b64f3d1b6e",
        "object": "address",
        "name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "address": "123 Main St",
        "city": "New York",
        "postcode": "10001",
        "state": "NY",
        "country": "us",
        "locale": "en",
        "phone": "+441234567890",
        "company": "Tamio Inc",
        "message": "Leave at front door",
        "shipping_address": false,
        "is_company": true,
        "vat": "US12345678",
        "verified_vat": true,
        "custom_billing_fields": {}
      }
    ],
    "direct_debits": [
      {
        "currency": "EUR",
        "provider": "gocardless"
      }
    ],
    "client_id": "aa6e91ea-0275-408a-8106-25f0e3fcbd81",
    "category": "VIP"
  }
}

1	const response = await fetch("https://api.tamio.com/v2/customers/create", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	"name": "John",
9	"last_name": "Doe",
10	"email": "[email protected]",
11	"country": "de",
12	"locale": "en",
13	"billing_information": {
14	"name": "John",
15	"last_name": "Doe",
16	"country": "de",
17	"address": "123 Main St",
18	"city": "Berlin",
19	"postcode": "10115",
20	"email": "[email protected]"
21	}
22	})
23	});
24	const data = await response.json();

1	require "uri"
2	require "net/http"
3	require "json"
4
5	url = URI("https://api.tamio.com/v2/customers/create")
6
7	https = Net::HTTP.new(url.host, url.port)
8	https.use_ssl = true
9
10	request = Net::HTTP::Post.new(url)
11	request["Accept"] = "application/json"
12	request["Authorization"] = "Bearer YOUR_API_KEY"
13	request["Content-Type"] = "application/json"
14	request.body = {
15	name: "John",
16	last_name: "Doe",
17	email: "[email protected]",
18	country: "de",
19	locale: "en",
20	billing_information: {
21	name: "John",
22	last_name: "Doe",
23	country: "de",
24	address: "123 Main St",
25	city: "Berlin",
26	postcode: "10115",
27	email: "[email protected]"
28	}
29	}.to_json
30
31	response = https.request(request)
32	puts response.read_body