Skip to main content
GET
Get customer by ID

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

customer_id
string<uuid>
required

Response

Successfully retrieved customer

Create Customer Response Schema

id
string<uuid>
required

Customer ID

external_id
string | null
required

External Customer Id

customer_name
string
required

Customer name

custom_data
Custom Data · object | null
required

Customer Custom Data

address
AddressResponse · object | null
required

Customer address

ship_to_address
AddressResponse · object | null

Customer Ship To address

tax_info
TaxId · object[] | null

Customer Tax Ids

phone_number
string | null

Customer Phone Number

email
string | null

Customer primary email address

contacts
ContactResponseSchema · object[] | null

List of associated contacts

custom_attributes
Custom Attributes · object | null

Customer Tags

communications_enabled
boolean | null
default:true

To enable/disable communications

auto_charge_enabled
boolean | null
default:true

To enable/disable auto-charge

invoice_details
InvoiceDetailsObject · object | null

Invoice Details Object

created_at
string<date-time> | null

Created At

updated_at
string<date-time> | null

Updated At

default_payment_method
CustomerPaymentMethodsResponseSchema · object | null

default_payment_method

business_entity_id
string<uuid> | null

Business Entity Id

business_entity
BusinessEntityResponseSchema · object | null

Business Entity