Customers

Use when updating customer details (e.g. name, email, or metadata). Identify by id or external_customer_id.

put/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

Query parameters

idstring

Customer ID

external_customer_idstring

Customer External ID

Request body

address_citystring

address_city is the updated city name with maximum 100 characters

address_countrystring

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

address_line1string

address_line1 is the updated primary address line with maximum 255 characters

address_line2string

address_line2 is the updated secondary address line with maximum 255 characters

address_postal_codestring

address_postal_code is the updated postal code with maximum 20 characters

address_statestring

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

billing_currencystring

billing_currency updates the invoicing currency; send "" to clear it back to the charge currency

contactstring

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

emailstring

email is the updated email address and must be a valid email format if provided

external_idstring

external_id is the updated external identifier for the customer

metadataobject

metadata contains updated key-value pairs that will replace existing metadata

namestring

name is the updated name or company name for the customer

tax_treatment'taxable' | 'exempt'
timezonestring

timezone is the updated IANA timezone name for the customer (e.g. "Asia/Kolkata", "America/New_York")

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

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status