Customers

Create customer

Changed on

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

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/customers
  • Auth
    API key in header x-api-key

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

billing_currencystring

billing_currency is the fiat currency invoices are issued in; empty means the charge currency is used as-is

contactstring

contact is an optional contact number for the customer (e.g. phone)

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 required

name is the full name or company name of the customer

onboarding_workflow_namestring

onboarding_workflow_name is given if a custom onboarding workflow is to be triggered for this 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

tax_treatment'taxable' | 'exempt'
timezonestring

timezone is the customer's IANA timezone name (e.g. "Asia/Kolkata", "America/New_York") Defaults to "UTC" if not provided

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

billing_currencystring

BillingCurrency is the fiat currency invoices are issued in; nil means charge currency is used as-is.

contactstring

Contact is an optional contact number for the customer (e.g. phone)

created_atstring date-time
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

status'published' | 'deleted' | 'archived'
tax_treatment'taxable' | 'exempt'
tenant_idstring
timezonestring

Timezone is the customer's IANA timezone name (e.g. "Asia/Kolkata"). Defaults to "UTC". Inherited by subscriptions at creation time.

updated_atstring date-time
updated_bystring

Changes

  • 80eb0267435cRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • de915dc839feRevision changes
    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status