Customers

Get customer by external ID

Changed on

Use when resolving a customer by your app's id (e.g. from your user table). Ideal for integrations that key by external id.

get/customers/external/{external_id}

Request

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

Path parameters

external_idstring required

Customer External ID

Response

OK

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