Sign in

v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB
Customers API

Create customer

Creates a simple minimal representation of a customer. Payments, recurring mandates, and subscriptions can be linked to this customer object, which simplifies management of recurring payments.

Once registered, customers will also appear in your Mollie dashboard.

🔑 Access with

API key

Advanced access token with customers.write

OAuth access with customers.write

post/customers

Request body

resourcestring

Indicates the response contains a customer object. Will always contain the string customer for this endpoint.

idstring

The identifier uniquely referring to this customer. Example: cst_vsKJpSsabw.

modestring

Whether this entity was created in live mode or in test mode.

Possible values: live test

namestring nullable

The full name of the customer.

emailstring nullable

The email address of the customer.

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

localestring nullable

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

createdAtstring

The entity's date and time of creation, in ISO 8601 format.

testmodeboolean nullable

Whether to create the entity in test mode or live mode.

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.

Example request

{
  "id": "cst_5B8cwPMGnU",
  "mode": "live",
  "name": "John Doe",
  "email": "example@email.com",
  "locale": "en_US",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "dashboard": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "payments": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "mandates": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "subscriptions": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Response

The newly created customer object.