Get One Customer

Javascript SDK

import { init } from "metrifox-js";

const metrifoxClient = init({
  apiKey: process.env.METRIFOX_API_KEY
});

// Get a customer by key
const customerKey = "acme-corp-001";
const response = await metrifoxClient.customers.get(customerKey);

{
  "message": "Customer fetched",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "primary_email": "[email protected]",
    "primary_phone": "+1234567890",
    "legal_name": "Acme Corporation",
    "display_name": "Acme Corp",
    "legal_number": null,
    "tax_identification_number": null,
    "logo_url": null,
    "website_url": null,
    "account_manager": null,
    "first_name": null,
    "middle_name": null,
    "last_name": null,
    "full_name": "Acme Corporation",
    "billing_email": "[email protected]",
    "timezone": "America/New_York",
    "language": "en",
    "currency": "USD",
    "tax_status": "TAXABLE",
    "address_line1": "123 Business Ave",
    "address_line2": null,
    "city": "New York",
    "state": "NY",
    "country": "United States",
    "zip_code": "10001",
    "shipping_address_line1": null,
    "shipping_address_line2": null,
    "shipping_city": null,
    "shipping_state": null,
    "shipping_country": null,
    "shipping_zip_code": null,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "customer_type": "BUSINESS",
    "customer_key": "acme-corp-001",
    "phone_numbers": [],
    "email_addresses": [
      {
        "email": "[email protected]",
        "is_primary": true
      }
    ],
    "billing_configuration": {},
    "tax_identifications": [],
    "contact_people": [],
    "payment_terms": [],
    "metadata": {},
    "date_of_birth": null,
    "documents": {},
    "mid_cycle_invoice_consolidation": false
  }
}

GET

api

customers

{customer_key}

Javascript SDK

import { init } from "metrifox-js";

const metrifoxClient = init({
  apiKey: process.env.METRIFOX_API_KEY
});

// Get a customer by key
const customerKey = "acme-corp-001";
const response = await metrifoxClient.customers.get(customerKey);

{
  "message": "Customer fetched",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "primary_email": "[email protected]",
    "primary_phone": "+1234567890",
    "legal_name": "Acme Corporation",
    "display_name": "Acme Corp",
    "legal_number": null,
    "tax_identification_number": null,
    "logo_url": null,
    "website_url": null,
    "account_manager": null,
    "first_name": null,
    "middle_name": null,
    "last_name": null,
    "full_name": "Acme Corporation",
    "billing_email": "[email protected]",
    "timezone": "America/New_York",
    "language": "en",
    "currency": "USD",
    "tax_status": "TAXABLE",
    "address_line1": "123 Business Ave",
    "address_line2": null,
    "city": "New York",
    "state": "NY",
    "country": "United States",
    "zip_code": "10001",
    "shipping_address_line1": null,
    "shipping_address_line2": null,
    "shipping_city": null,
    "shipping_state": null,
    "shipping_country": null,
    "shipping_zip_code": null,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "customer_type": "BUSINESS",
    "customer_key": "acme-corp-001",
    "phone_numbers": [],
    "email_addresses": [
      {
        "email": "[email protected]",
        "is_primary": true
      }
    ],
    "billing_configuration": {},
    "tax_identifications": [],
    "contact_people": [],
    "payment_terms": [],
    "metadata": {},
    "date_of_birth": null,
    "documents": {},
    "mid_cycle_invoice_consolidation": false
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

customer_key

string

required

Unique identifier of the customer in your application to retrieve

Response

Customer fetched

message

string

Example:

"Customer fetched"

data

object

Show child attributes

data.id

string<uuid>

Unique customer identifier in the Metrifox system

data.primary_email

string<email>

Primary email address

data.primary_phone

string

Primary phone number

data.legal_name

string

Legal business name

data.display_name

string

Display name for the business

data.legal_number

string

Legal registration number

data.tax_identification_number

string

Tax identification number

data.logo_url

string<uri>

URL to company logo

data.website_url

string<uri>

Company website URL

data.account_manager

string

Assigned account manager

data.first_name

string

First name

data.middle_name

string

Middle name

data.last_name

string

Last name

data.full_name

string

Full name

data.billing_email

string<email>

Email address for billing communications

data.timezone

string

Preferred timezone

data.language

string

Preferred language for communications

data.currency

string

Preferred currency for billing

data.tax_status

enum<string>

Tax status of the customer

Available options:

TAXABLE,

TAX_EXEMPT,

REVERSE_CHARGE

data.address_line1

string

First line of address

data.address_line2

string

Second line of address

data.city

string

City name

data.state

string

State or province

data.country

string

Country name

data.zip_code

string

ZIP or postal code

data.shipping_address_line1

string

First line of shipping address

data.shipping_address_line2

string

Second line of shipping address

data.shipping_city

string

Shipping city name

data.shipping_state

string

Shipping state or province

data.shipping_country

string

Shipping country name

data.shipping_zip_code

string

Shipping ZIP or postal code

data.created_at

string<date-time>

Creation timestamp

data.updated_at

string<date-time>

Last update timestamp

data.customer_type

enum<string>

Type of customer

Available options:

BUSINESS,

INDIVIDUAL

data.customer_key

string

Customer key if available

data.phone_numbers

object[]

List of phone numbers

data.email_addresses

object[]

List of email addresses

data.billing_configuration

object

Show child attributes

data.billing_configuration.preferred_payment_gateway

string

Preferred payment gateway

data.billing_configuration.preferred_payment_method

string

Preferred payment method

data.billing_configuration.billing_email

string<email>

Email address for billing communications

data.billing_configuration.billing_address

string

Billing address

data.billing_configuration.payment_reminder_days

integer

Number of days before payment reminder

data.tax_identifications

object[]

Array of tax identification numbers

Show child attributes

data.tax_identifications.type

string

required

Type of tax identification (e.g., EIN, VAT, GST)

data.tax_identifications.number

string

required

Tax identification number

data.tax_identifications.country

string

required

Country where tax ID is registered

data.contact_people

object[]

List of contact persons for the business

Show child attributes

data.contact_people.first_name

string

required

First name of contact person

data.contact_people.last_name

string

required

Last name of contact person

data.contact_people.email_address

string<email>

required

Email address of contact person

data.contact_people.designation

string

Job title or designation

data.contact_people.department

string

Department name

data.contact_people.is_primary

boolean

default:false

Whether this is the primary contact person

data.contact_people.phone_number

string

Phone number for this contact person

data.payment_terms

object[]

Payment terms configuration

Show child attributes

data.payment_terms.type

string

required

Type of payment term (e.g., Net 30, Net 15)

data.payment_terms.value

string

required

Payment term value

data.metadata

object

Custom metadata

data.date_of_birth

string<date>

Date of birth (for individuals)

data.documents

object

Attached documents

data.mid_cycle_invoice_consolidation

boolean

Whether to consolidate invoices mid-cycle

Create Customer Update Customer

⌘I

API Documentation

Customers

Usage

Finance

Checkout

Authorizations

Path Parameters

Response