PUT
/
clients
/
{id}
/

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Object ID (UUID)

Body

application/json

Record of a single customer of your business. Create one for each of your clients; you will be able to issue invoices/subscriptions for them later easily using /billing_templates/ API.

Each BillingTemplateClient (there can be many attached to a single BillingTemplate) will bind a single Client to a BillingTemplate.

email
string
required

Email address

Maximum length: 254
bank_account
string

Bank account number (e.g. IBAN)

Maximum length: 34
bank_code
string

SWIFT/BIC code of the bank

Maximum length: 11
phone
string

Phone number in the <country_code> <number> format

Maximum length: 32
full_name
string

Name and surname of client

Maximum length: 128
personal_code
string

Personal identification code of client

Maximum length: 32
street_address
string

Street house number and flat address where applicable

Maximum length: 128
country
string

Country code in the ISO 3166-1 alpha-2 format (e.g. 'GB')

Maximum length: 2
city
string

City name

Maximum length: 128
zip_code
string

ZIP or postal code

Maximum length: 32
state
string

State code

Maximum length: 128
shipping_street_address
string

Street house number and flat address where applicable

Maximum length: 128
shipping_country
string

Country code in the ISO 3166-1 alpha-2 format (e.g. 'GB')

Maximum length: 2
shipping_city
string

City name

Maximum length: 128
shipping_zip_code
string

ZIP or postal code

Maximum length: 32
shipping_state
string

State code

Maximum length: 128
cc
string[]

Email addresses to receive a carbon copy of all notification emails

bcc
string[]

Email addresses to receive a blind carbon copy of all notification emails

legal_name
string

Legal name of company

Maximum length: 128
brand_name
string

Company brand name

Maximum length: 128
registration_number
string

Registration number of company

Maximum length: 32
tax_number
string

Tax payer registration number

Maximum length: 32

Response

200 - application/json

Record of a single customer of your business. Create one for each of your clients; you will be able to issue invoices/subscriptions for them later easily using /billing_templates/ API.

Each BillingTemplateClient (there can be many attached to a single BillingTemplate) will bind a single Client to a BillingTemplate.

email
string
required

Email address

Maximum length: 254
type
string

Object type identifier

id
string
created_on
integer

Object creation time

updated_on
integer

Object last modification time

bank_account
string

Bank account number (e.g. IBAN)

Maximum length: 34
bank_code
string

SWIFT/BIC code of the bank

Maximum length: 11
phone
string

Phone number in the <country_code> <number> format

Maximum length: 32
full_name
string

Name and surname of client

Maximum length: 128
personal_code
string

Personal identification code of client

Maximum length: 32
street_address
string

Street house number and flat address where applicable

Maximum length: 128
country
string

Country code in the ISO 3166-1 alpha-2 format (e.g. 'GB')

Maximum length: 2
city
string

City name

Maximum length: 128
zip_code
string

ZIP or postal code

Maximum length: 32
state
string

State code

Maximum length: 128
shipping_street_address
string

Street house number and flat address where applicable

Maximum length: 128
shipping_country
string

Country code in the ISO 3166-1 alpha-2 format (e.g. 'GB')

Maximum length: 2
shipping_city
string

City name

Maximum length: 128
shipping_zip_code
string

ZIP or postal code

Maximum length: 32
shipping_state
string

State code

Maximum length: 128
cc
string[]

Email addresses to receive a carbon copy of all notification emails

bcc
string[]

Email addresses to receive a blind carbon copy of all notification emails

legal_name
string

Legal name of company

Maximum length: 128
brand_name
string

Company brand name

Maximum length: 128
registration_number
string

Registration number of company

Maximum length: 32
tax_number
string

Tax payer registration number

Maximum length: 32
Retrieve a clientPartially update a client