Update your name and billing profile
curl --request PUT \
--url https://my.server.express/api/v1/client/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"postcode": "<string>",
"phoneNumber": "<string>",
"companyName": "<string>",
"country": "<string>",
"region": "<string>",
"vatNumber": "<string>"
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
addressLine1: '<string>',
addressLine2: '<string>',
city: '<string>',
postcode: '<string>',
phoneNumber: '<string>',
companyName: '<string>',
country: '<string>',
region: '<string>',
vatNumber: '<string>'
})
};
fetch('https://my.server.express/api/v1/client/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.server.express/api/v1/client/settings"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"postcode": "<string>",
"phoneNumber": "<string>",
"companyName": "<string>",
"country": "<string>",
"region": "<string>",
"vatNumber": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"success": true,
"data": {
"message": "Settings updated"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Account
Update your name and billing profile
Partial update; only allow-listed fields are read and anything else is ignored. Text fields are trimmed and capped at 255
characters; null or "" clears them. A new vatNumber is checked against VIES and vatValid is set from the result — it
can’t be sent. A body that sets country to US, CA or AU must include region. Writes an UPDATE_SETTINGS audit log entry
listing the changed field names.
PUT
/
v1
/
client
/
settings
Update your name and billing profile
curl --request PUT \
--url https://my.server.express/api/v1/client/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"postcode": "<string>",
"phoneNumber": "<string>",
"companyName": "<string>",
"country": "<string>",
"region": "<string>",
"vatNumber": "<string>"
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
addressLine1: '<string>',
addressLine2: '<string>',
city: '<string>',
postcode: '<string>',
phoneNumber: '<string>',
companyName: '<string>',
country: '<string>',
region: '<string>',
vatNumber: '<string>'
})
};
fetch('https://my.server.express/api/v1/client/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.server.express/api/v1/client/settings"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"postcode": "<string>",
"phoneNumber": "<string>",
"companyName": "<string>",
"country": "<string>",
"region": "<string>",
"vatNumber": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"success": true,
"data": {
"message": "Settings updated"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Authorizations
Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh. A session satisfies every API scope.
Body
application/json
Blank is ignored.
Maximum string length:
100Blank is ignored.
Maximum string length:
100Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
2552-letter ISO code, uppercased. Blank clears it.
Pattern:
^[A-Za-z]{2}$State, province or county. Required with a US, CA or AU country.
Maximum string length:
64Available options:
INDIVIDUAL, BUSINESS Case-insensitive. Null or "" follows the default (GBP).
Available options:
GBP, USD, EUR, null Maximum string length:
64