comecerodocs

Get your account

GET
/accounts/{account_id}

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.

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.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse
show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

timezone?string

An IANA time zone name, such as America/New_York or UTC. It sets how date_start and date_end are read and the time zone of every date in the response. The default is the account's time zone (Settings, Technical), or UTC when it has none. A name that is not known is a 400.

Response Body

The 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.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/accounts/me'
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"}