Python SDK

from metrifox_sdk import MetrifoxClient

client = MetrifoxClient(api_key="your_api_key")

# Simple usage
customer_data = {
    "customer_key": "your_customer_unique_id",
    "primary_email": "customer_email@example.com",
    "customer_type": "BUSINESS",
    "legal_name": "Your Company LLC",
    "display_name": "Your Company",
    "billing_email": "billing@yourcompany.com"
    # ...other_fields
}

# Create a customer
response = client.customers.create(customer_data)

{
  "message": "Customer Created",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "primary_email": "contact@acme.com",
    "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": "billing@acme.com",
    "timezone": "America/New_York",
    "language": "en",
    "currency": "USD",
    "tax_status": "TAXABLE",
    "address_line1": "123 Business St",
    "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": "contact@acme.com",
        "is_primary": true
      }
    ],
    "billing_configuration": {},
    "tax_identifications": [],
    "contact_people": [],
    "payment_terms": [],
    "metadata": {},
    "date_of_birth": null,
    "documents": {}
  },
  "status": "created"
}

Customers

Creates a customer

Creates a new customer with the provided information. The endpoint supports both JSON and multipart form data. For multipart requests, the customer data should be sent as a JSON string in the ‘customer’ field.

Important Note: Customer keys are immutable once created and cannot be changed through updates. Choose your customer key carefully during creation.

Customer Types:

BUSINESS: For business customers with business details and contact people
INDIVIDUAL: For individual customers with personal details

Required Fields:

customer_type: Must be either “BUSINESS” or “INDIVIDUAL”
customer_key: Unique identifier in your system (immutable once created)
primary_email: Primary email address for the customer

POST

api

customers

Python SDK

from metrifox_sdk import MetrifoxClient

client = MetrifoxClient(api_key="your_api_key")

# Simple usage
customer_data = {
    "customer_key": "your_customer_unique_id",
    "primary_email": "customer_email@example.com",
    "customer_type": "BUSINESS",
    "legal_name": "Your Company LLC",
    "display_name": "Your Company",
    "billing_email": "billing@yourcompany.com"
    # ...other_fields
}

# Create a customer
response = client.customers.create(customer_data)

{
  "message": "Customer Created",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "primary_email": "contact@acme.com",
    "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": "billing@acme.com",
    "timezone": "America/New_York",
    "language": "en",
    "currency": "USD",
    "tax_status": "TAXABLE",
    "address_line1": "123 Business St",
    "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": "contact@acme.com",
        "is_primary": true
      }
    ],
    "billing_configuration": {},
    "tax_identifications": [],
    "contact_people": [],
    "payment_terms": [],
    "metadata": {},
    "date_of_birth": null,
    "documents": {}
  },
  "status": "created"
}

Authorizations

x-api-key

string

header

required

Body

application/json

customer_type

enum<string>

required

Type of customer

Available options:

BUSINESS,

INDIVIDUAL

customer_key

string

required

Unique identifier of the customer in your application

primary_email

string<email>

required

Primary email address for the customer

primary_phone

string

Primary phone number for the customer

legal_name

string

Legal business name

display_name

string

Display name for the business

legal_number

string

Legal registration number

tax_identification_number

string

Tax identification number

logo_url

string<uri>

URL to company logo

website_url

string<uri>

Company website URL

account_manager

string

Assigned account manager

first_name

string

First name

middle_name

string

Middle name

last_name

string

Last name

date_of_birth

string<date>

Date of birth (for individuals)

billing_email

string<email>

Email address for billing communications

timezone

string

Preferred timezone

language

string

Preferred language for communications

currency

string

Preferred currency for billing

tax_status

enum<string>

Tax status of the customer

Available options:

TAXABLE,

TAX_EXEMPT,

REVERSE_CHARGE

address_line1

string

First line of address

address_line2

string

Second line of address

city

string

City name

state

string

State or province

country

string

Country name

zip_code

string

ZIP or postal code

shipping_address_line1

string

First line of shipping address

shipping_address_line2

string

Second line of shipping address

shipping_city

string

Shipping city name

shipping_state

string

Shipping state or province

shipping_country

string

Shipping country name

shipping_zip_code

string

Shipping ZIP or postal code

billing_configuration

object

Show child attributes

tax_identifications

object[]

Array of tax identification numbers

Show child attributes

contact_people

object[]

List of contact persons for the business

Show child attributes

payment_terms

object[]

Payment terms configuration

Show child attributes

metadata

object

Custom metadata

email_addresses

object[]

List of additional email addresses

Show child attributes

phone_numbers

object[]

List of additional phone numbers

Show child attributes

documents

object

Optional documents to attach to the customer

Response

Customer created successfully

message

string

Example:

"Customer Created"

data

object

Show child attributes

status

string

Example:

"created"

Retrieves customers Retrieves a single customer

API Documentation

Customers

Subscriptions

Usage

Finance

Checkout

Webhooks

Webhooks

Customers

Subscriptions

Usage

Checkout

Creates a customer

Authorizations

Body

Response