Customers

Create customer

Use when onboarding a new billing customer (e.g. sign-up or CRM sync). Ideal for linking via external_customer_id to your app's user id.

post/customers

Request body

address_citystring

address_city is the city name with maximum 100 characters

address_countrystring

address_country is the two-letter ISO 3166-1 alpha-2 country code

address_line1string

address_line1 is the primary address line with maximum 255 characters

address_line2string

address_line2 is the secondary address line with maximum 255 characters

address_postal_codestring

address_postal_code is the ZIP code or postal code with maximum 20 characters

address_statestring

address_state is the state, province, or region name with maximum 100 characters

emailstring

email is the customer's email address and must be a valid email format if provided

external_idstring required

external_id is the unique identifier from your system to reference this customer (required)

metadataobject

metadata contains additional key-value pairs for storing extra information

namestring

name is the full name or company name of the customer

parent_customer_external_idstring

parent_customer_external_id is the external ID of the parent customer from your system Exactly one of parent_customer_id or parent_customer_external_id may be provided

parent_customer_idstring

parent_customer_id is the internal FlexPrice ID of the parent customer

skip_onboarding_workflowboolean

skip_onboarding_workflow when true, prevents the customer onboarding workflow from being triggered This is used internally when a customer is created via a workflow to prevent infinite loops Default: false

Response

Created

address_citystring

AddressCity is the city of the customer's address

address_countrystring

AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)

address_line1string

AddressLine1 is the first line of the customer's address

address_line2string

AddressLine2 is the second line of the customer's address

address_postal_codestring

AddressPostalCode is the postal code of the customer's address

address_statestring

AddressState is the state of the customer's address

created_atstring
created_bystring
emailstring

Email is the email of the customer

environment_idstring

EnvironmentID is the environment identifier for the customer

external_idstring

ExternalID is the external identifier for the customer

idstring

ID is the unique identifier for the customer

metadataobject

Metadata

namestring

Name is the name of the customer

parent_customer_idstring

ParentCustomerID is the parent customer identifier for the customer

status'published' | 'deleted' | 'archived'
tenant_idstring
updated_atstring
updated_bystring

Changes