Update customer

Customers API v2
PATCHhttps://api.mollie.com/v2/customers/*id*

Update an existing customer.

Parameters

Replace id in the endpoint URL by the customer’s ID, for example cst_8wmqcHMN4U.

name

string
optional
The full name of the customer.

email

string
optional
The email address of the customer.

locale

string
optional

Allows you to preset the language to be used in the hosted payment pages shown to the consumer. When this parameter is not provided, the browser language will be used instead in the payment flow (which is usually more accurate).

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

metadata

mixed
optional
Provide any data you like, and we will save the data alongside the customer. Whenever you fetch the customer with our API, we’ll also include the metadata. You can use up to 1kB of JSON.

Access token parameters

If you are using organization access tokens or are creating an OAuth app, the testmode parameter is also available.

testmode

boolean
optional
Set this to true to update a test mode customer.

Response

200 application/hal+json

A customer object is returned, as described in Get customer.

Example

cURLPHPPythonRubyNode.js
1
2
3
4
curl -X PATCH https://api.mollie.com/v2/customers/cst_8wmqcHMN4U \
   -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" \
   -d "name=Updated Customer A" \
   -d "email=updated-customer@example.org"
1
2
3
4
5
6
7
8
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setApiKey("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");

$customer = $mollie->customers->get("cst_8wmqcHMN4U");
$customer->name = "Updated Customer A";
$customer->email = "updated-customer@example.org";
$customer->update();
1
2
3
4
We don't have a Python code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation
1
2
3
4
We don't have a Ruby code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation
1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "resource": "customer",
    "id": "cst_8wmqcHMN4U",
    "mode": "test",
    "name": "Updated Customer A",
    "email": "updated-customer@example.org",
    "locale": "nl_NL",
    "metadata": null,
    "createdAt": "2018-04-06T13:23:21.0Z",
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/customers-api/get-customer",
            "type": "text/html"
        }
    }
}