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.
Request body
address_city is the city name with maximum 100 characters
address_country is the two-letter ISO 3166-1 alpha-2 country code
address_line1 is the primary address line with maximum 255 characters
address_line2 is the secondary address line with maximum 255 characters
address_postal_code is the ZIP code or postal code with maximum 20 characters
address_state is the state, province, or region name with maximum 100 characters
email is the customer's email address and must be a valid email format if provided
external_id is the unique identifier from your system to reference this customer (required)
metadata contains additional key-value pairs for storing extra information
name is the full name or company name of the customer
Deprecated: See ParentCustomerID. 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.
Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy. This field is accepted for backward compatibility but no hierarchy validations are enforced. parent_customer_id is the internal FlexPrice ID of the parent customer.
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
AddressCity is the city of the customer's address
AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)
AddressLine1 is the first line of the customer's address
AddressLine2 is the second line of the customer's address
AddressPostalCode is the postal code of the customer's address
AddressState is the state of the customer's address
Email is the email of the customer
EnvironmentID is the environment identifier for the customer
ExternalID is the external identifier for the customer
ID is the unique identifier for the customer
Metadata
Name is the name of the customer
Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy. Retained for backward compatibility; no hierarchy rules are enforced at the service layer. ParentCustomerID is the parent customer identifier for the customer.