Create a customer
Create a new customer within a business. Returns the created customer in the same format as the get customer endpoint.
Documentation Index
Fetch the complete documentation index at: https://docs.thredfi.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>
Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.
Path Parameters
Business UUID provided by Thred (unique identifier for the business)
Body
Serializer for creating new customers
Your unique identifier for this customer (used for idempotency)
Customer reference number for invoices and statements
Individual/contact person name (required if company_name not provided)
Registered company name (required if individual_name not provided)
Primary email address for the customer
Mobile phone number
Office/landline phone number
Street address line 1
Street address line 2 (building, suite, etc.)
City or town
State, county, or region
Postal/ZIP code
ISO 3166-1 alpha-2 country code
VAT registration number (for UK: GB followed by 9 digits)
Whether customer is exempt from tax/VAT
active- Activearchived- Archivedsuspended- Suspended
active, archived, suspended Array of tags for categorization and filtering
Internal notes about the customer
Custom JSON metadata for partner-specific data
Number of days for payment terms (e.g., 30 for Net 30)
Maximum credit limit in cents (e.g., 100000 for £1,000)
x >= 0Optional document upload
Response
Main customer serializer for customer API endpoints Returns customer information with comprehensive details Used for both list and detail responses
Type identifier (always 'CustomerData')
Unique identifier for the customer
Your unique identifier for this customer (used for idempotency)
Customer reference number for invoices and statements
Individual/contact person name (required if company_name not provided)
Registered company name (required if individual_name not provided)
Display name for the customer (auto-generated from company_name or individual_name)
Primary email address for the customer
Mobile phone number
Office/landline phone number
Street address line 1
Street address line 2 (building, suite, etc.)
City or town
State, county, or region
Postal/ZIP code
ISO 3166-1 alpha-2 country code
Complete formatted address with all fields
Single-line formatted address
VAT registration number (for UK: GB followed by 9 digits)
Whether customer is exempt from tax/VAT
Customer status (ACTIVE or ARCHIVED)
Whether the customer is active (read-only)
Whether the customer is archived (read-only)
Array of tags for categorization and filtering
Internal notes about the customer
Custom JSON metadata for partner-specific data
Number of days for payment terms (e.g., 30 for Net 30)
Maximum credit limit in cents (e.g., 100000 for £1,000)
Maximum credit limit in cents (e.g., 100000 for £1,000)
Current outstanding balance in cents (read-only, computed)
All documents linked to this customer with presigned URLs (retrieve only, not in list)
Date and time when the customer was created
Date and time when the customer was last updated
Date and time when the customer was archived (null if active)