Update customer

Update an existing customer.

For an in-depth explanation of each parameter, refer to the Create customer endpoint.

๐Ÿ”‘

Access with

API keyAdvanced access token with customers.writeOAuth access with customers.write
Path Params
string
required
^cst_.+$

Provide the ID of the related customer.

Body Params
string | null

The full name of the customer.

string | null

The email address of the customer.

If the domain contains non-ASCII characters, encode it as Punycode per RFC 3492.

string | null

Preconfigure the language to be used in the hosted payment pages shown to the customer. Should only be provided if absolutely necessary. If not provided, the browser language will be used which is typically highly accurate.

Possible values: ca_ES cs_CZ da_DK de_AT de_CH de_DE de_LU en_GB en_US es_ES fi_FI fr_BE fr_FR fr_LU hu_HU is_IS it_IT lt_LT lv_LV nb_NO nl_BE nl_NL pl_PL pt_PT sk_SK sv_SE null

Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.

boolean

Whether the entity was created in test mode or live mode. This field does not update the mode of the entity.

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Responses

Language
Credentials
LoadingLoadingโ€ฆ
Response
Choose an example:
application/hal+json