Skip to main content

Update Customer

Introduction

Update a customer

Interface

PUT /v1/customers/:customer_id

Request Params

FieldNameTypeRangeExampleDefaultOptionalRemarkRule
referenceReferencestring[1, 64]2022123optionalRefer to merchant side's customer ID, see Unique Reference Mode
first_nameFirst Namestring[1,64]DavidoptionalFirst name(and middle name if exists) of customer
last_nameLast Namestring[1,64]SmithoptionalLast name of customer
companyCompanystring[1,64]company nameoptionalCustomer's company
descriptionDescriptionstringcompany descriptionoptionalyyyy-mm-dd
birth_dateBirth DatestringoptionalCustomer's birth date
emailEmailstringoptionalEmail of customerE.164
phonePhonestringoptionalPhone of customer
countryCountrystringoptionalCustomer's countryISO 3166 alpha-2

Response Params

Response Example

200 success:

{
"id": "cst_un9WL8ervLWDqTGW",
"object": "customer",
"account": "acct_yz50aD",
"time_created": "2022-07-15T14:00:46+08:00",
"livemode": true,
"reference": "2022000000000",
"first_name": "David",
"last_name": "Smith",
"company": "comany name",
"country": null,
"description": "company description",
"birth_date": "2020-01-01",
"email": "test@company.com",
"phone": "+8613000000000",
"address": {
"country": "US",
"state": "Washington DC",
"city": "Washington",
"line1": "detail address 1",
"line2": "detail address 2",
"postal_code": "200000",
"time_created": "2022-07-15T14:00:46+08:00"
},
"deleted": false
}

400 error:

{
"error": {
"type": "invalid_request_error",
"message": "reference duplicated: 2022050500002",
"code": "request_param_error"
}
}