Customer Aliases
Get customer by alias
Retrieve the details of one of your customers using one of their aliases.
GET
/
customers
/
by-alias
/
{alias}
Headers
Authorization
string
requiredYour API credentials. Eg. Basic {credentials}
.
Sequence-Version
enum<string>
Use this header to select an API version
Available options:
2024-07-30
Path Parameters
alias
string
requiredCustomer alias
Response
200 - application/json
id
string
requiredUnique ID
createdAt
string
requiredCreated at
legalName
string
requiredLegal name
contactName
string
Contact Name
address
object
requiredAddress
email
string
requiredMain contact email address
telephone
string
Telephone
url
string
URL
label
string
Label
integrationIds
object[]
requiredExternal services which are linked to this customer
archivedAt
string
Date and time the Customer was archived
billingEmails
string[]
requiredBilling email addresses
taxStatus
enum<string>
requiredTax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.
Available options:
TAXED
, TAX_EXEMPT
, REVERSE_CHARGED