Create a customer

1 min

POST

https://app.amberflo.io/customers

Creates a new customer record in your account with the provided details. Use this endpoint to onboard new customers before tracking their usage or billing them.

The customer will be assigned the default lifecycle stage from your account settings unless specified otherwise. You can optionally create the customer in Stripe by using the autoCreateCustomerInStripe query parameter.

Use this endpoint to:

Register new customers before tracking usage
Set up customer metadata and traits
Configure tax addresses for billing
Integrate with external payment providers

Important Note: The customerId must be unique within your account. If the customer already exists, this request will fail.

autoCreateCustomerInStripestringIndicates whether to create the customer in your Stripe account or not. Its Stripe id is saved as the <code>stripeId</code> trait after it is created there. When set to <code>if_payment_provider</code>, then it will only be created in Stripe if the <code>paymentProviderName</code> trait is set to <code>STRIPE</code>

bodyobjectCustomer information required to create or update a customer in the system.

200Successfully created new customer record with generated timestamps and metadata

400Invalid customer data, missing required fields, or customer ID already exists

401Authentication required or API key is invalid

403Insufficient permissions to create customer records

500Internal server error occurred while creating customer

curl --request POST \
     --url https://app.amberflo.io/customers \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "customerId": "",
     "customerName": "",
     "address": {
     "line1": "",
     "city": "",
     "country": ""
     }
     }'