PUT
/
customers
/
{id}
curl --request PUT \
  --url https://api.cloud.flexprice.io/v1/customers/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "address_city": "<string>",
  "address_country": "<string>",
  "address_line1": "<string>",
  "address_line2": "<string>",
  "address_postal_code": "<string>",
  "address_state": "<string>",
  "email": "<string>",
  "external_id": "<string>",
  "metadata": {},
  "name": "<string>"
}'
{
  "address_city": "<string>",
  "address_country": "<string>",
  "address_line1": "<string>",
  "address_line2": "<string>",
  "address_postal_code": "<string>",
  "address_state": "<string>",
  "created_at": "<string>",
  "created_by": "<string>",
  "email": "<string>",
  "environment_id": "<string>",
  "external_id": "<string>",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "status": "published",
  "tenant_id": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

​
id
string
required

Customer ID

Body

application/json
Customer
​
address_city
string
Maximum length: 100
​
address_country
string
​
address_line1
string
Maximum length: 255
​
address_line2
string
Maximum length: 255
​
address_postal_code
string
Maximum length: 20
​
address_state
string
Maximum length: 100
​
email
string
​
external_id
string
​
metadata
object
​
name
string

Response

200
application/json
OK
​
address_city
string

AddressCity is the city of the customer's address

​
address_country
string

AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)

​
address_line1
string

AddressLine1 is the first line of the customer's address

​
address_line2
string

AddressLine2 is the second line of the customer's address

​
address_postal_code
string

AddressPostalCode is the postal code of the customer's address

​
address_state
string

AddressState is the state of the customer's address

​
created_at
string
​
created_by
string
​
email
string

Email is the email of the customer

​
environment_id
string

EnvironmentID is the environment identifier for the customer

​
external_id
string

ExternalID is the external identifier for the customer

​
id
string

ID is the unique identifier for the customer

​
metadata
object

Metadata

​
name
string

Name is the name of the customer

​
status
enum<string>
Available options:
published,
deleted,
archived
​
tenant_id
string
​
updated_at
string
​
updated_by
string