Create customer

Customers API v2

POSThttps://api.mollie.com/v2/customers

Authentication:API keysOAuth access tokens

Creates a simple minimal representation of a customer in the Mollie API to use for the Mollie Checkout and Recurring features. These customers will appear in your Dashboard where you can manage their details, and also see their payments and subscriptions.

Parameters

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 payment screens 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 object optional	Provide any data you like in JSON notation, 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.

Mollie Connect/OAuth parameters

If you’re creating an app with Mollie Connect/OAuth, the testmode parameter is also available.

testmode boolean optional

Set this to true to create a test mode customer.

Response

201 application/hal+json; charset=utf-8

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

Example

Request

curl -X POST https://api.mollie.com/v2/customers \
    -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" \
    -d "name=Customer A" \
    -d "email=customer@example.org"

Response

HTTP/1.1 201 Created
Content-Type: application/hal+json; charset=utf-8

{
    "resource": "customer",
    "id": "cst_8wmqcHMN4U",
    "mode": "test",
    "name": "Customer A",
    "email": "customer@example.org",
    "locale": null,
    "metadata": null,
    "createdAt": "2018-04-06T13:10:19.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/create-customer",
            "type": "text/html"
        }
    }
}