comecerodocs
Account

Update your account

POST
/accounts/{account_id}

Changes your company and contact details or your alias. Only the fields you send change. live and closed are set by Comecero and are ignored here. Fires the account:modified event.

This needs a live token: a test token gets 400 with the code token_type_mismatch. Live secret and trusted tokens may call this with the accounts update permission.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

account_id*string

Your account ID, or me for the account of the token you call with.

Query Parameters

expand?string

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

Request Body

application/json
  1. body

The account fields to change. Fields you leave out keep their value. An empty string clears most text fields, but not email or website.

company_name?string

The legal name of your company.

Lengthlength <= 75
dba?string

The name you trade under.

Lengthlength <= 75
name?string

The full name of the main contact, at least 4 characters.

Length4 <= length <= 75
email?string

The main contact's email address.

Formatemail
Lengthlength <= 75
website?string

Your website. https:// is added when you leave out the protocol.

Lengthlength <= 75
phone?string

Your phone number.

Lengthlength <= 25
tax_number?string

Your VAT or tax registration number.

Lengthlength <= 50
registration_number?string

Your company registration number.

Lengthlength <= 50
logo_url?string

A public https URL of your logo. Comecero fetches it to print invoices, so it must be reachable from the internet (400 otherwise).

Formaturi
Lengthlength <= 500
address_1?string

The first line of your address.

Lengthlength <= 75
address_2?string

The second line of your address.

Lengthlength <= 75
city?string

Your city.

Lengthlength <= 75
state_prov?string

Your state or province. For the US and Canada it must be the standard two-letter code (400 otherwise).

Lengthlength <= 75
postal_code?string

Your postal code.

Lengthlength <= 75
country?string

Your country, as an ISO 3166-1 alpha-2 code.

support_email?string

The email address shoppers see for help. Send an empty string to show none.

Formatemail
Lengthlength <= 75
support_website?string

The support page shoppers see.

Lengthlength <= 75
alias?string

A new alias: 5 to 25 characters, not in the account ID format, not a reserved word, without comecero, and not used by another account (400).

Length5 <= length <= 25

Response Body

The updated account.

application/json
  1. response

Your Comecero account: your company details, the contact details shoppers see, and whether the account may take live payments. One account holds both your test and your live data.

object?"account"

The object type. Always account.

Value in"account"
url?string

The URL of this account.

Formaturi
account_id?string

The account ID, two letters and four digits.

alias?|

A short name for the account that users may sign in with instead of the account ID. It is also the start of your sign-in page address.

date_created?string

When the account was created.

Formatdate-time
date_modified?string

When the account was last changed.

Formatdate-time
company_name?|

The legal name of your company.

Lengthlength <= 75
dba?|

The name you trade under, if it differs from company_name.

Lengthlength <= 75
name?|

The full name of the main contact.

Lengthlength <= 75
email?|

The main contact's email address.

Formatemail
Lengthlength <= 75
website?|

Your website. https:// is added when you leave out the protocol.

Lengthlength <= 75
phone?|

Your phone number.

Lengthlength <= 25
tax_number?|

Your VAT or tax registration number, printed on invoices. In the EU an invoice needs it.

Lengthlength <= 50
registration_number?|

Your company registration number.

Lengthlength <= 50
logo_url?|

A public https URL of your logo, used on invoices and emails. Up to 500 characters.

Formaturi
Lengthlength <= 500
address_1?|

The first line of your address.

Lengthlength <= 75
address_2?|

The second line of your address.

Lengthlength <= 75
city?|

Your city.

Lengthlength <= 75
state_prov?|

Your state or province. For the US and Canada, the standard two-letter code.

Lengthlength <= 75
postal_code?|

Your postal code.

Lengthlength <= 75
country?|

Your country, as an ISO 3166-1 alpha-2 code.

support_email?|

The email address shoppers see for help. Null when you want none shown on your shop.

Formatemail
Lengthlength <= 75
support_website?|

The support page shoppers see. When it is empty, website is used.

Lengthlength <= 75
live?boolean

True when the account may take live payments. New accounts start with false and Comecero sets it once the account is approved.

closed?boolean

True when the account has been closed.

date_closed?|

When the account was closed. Null for an open account.

Formatdate-time
account_meta?|

The account's meta details, as a URL, or the object when you send expand=account_meta.

token?string

A live trusted token for the account owner, so they are signed in at once. Only in the response to POST /accounts.

formatted?

Display text for dates and the country. Only present when you send formatted=true.

curl -X POST 'https://api.comecero.com/api/v1/accounts/me' \  -H 'Content-Type: application/json' \  -d '{  "support_email": "help@example.com",  "tax_number": "GB123456789"}'
Example Response
{  "object": "account",  "url": "https://api.comecero.com/api/v1/accounts/AB1234",  "account_id": "AB1234",  "alias": "example-shop",  "date_created": "2026-03-01T14:36:52Z",  "date_modified": "2026-10-01T09:20:11Z",  "company_name": "Example Software Ltd",  "dba": "Example Software",  "name": "John Doe",  "email": "john@example.com",  "website": "https://www.example.com",  "phone": "+1 555 0100",  "tax_number": null,  "registration_number": null,  "logo_url": "https://www.example.com/logo.png",  "address_1": "100 Main Street",  "address_2": null,  "city": "Springfield",  "state_prov": "IL",  "postal_code": "62701",  "country": "US",  "support_email": "support@example.com",  "support_website": "https://www.example.com/support",  "live": true,  "closed": false,  "date_closed": null,  "account_meta": "https://api.comecero.com/api/v1/accounts/AB1234/account_meta"}

Get your account GET

Gets your account. Use `me` so you do not need to know the account ID. You can only read the account your token belongs to (`403` for any other). The account is not split by mode, so this needs a live token. A test token gets `400` with the code `token_type_mismatch`. Live secret and trusted tokens may call this with the `accounts` read permission.

Overview

Next Page