Customers API

Get customer

Retrieve a single customer by its ID.

🔑 Access with

API key

Advanced access token with customers.read

OAuth access with customers.read

get/customers/{customerId}

Request

Base URL
https://api.mollie.com/v2
URL
https://api.mollie.com/v2/customers/{customerId}
Auth
- HTTP bearer
- or HTTP bearer
- or OAuth 2
  Authorization code: https://my.mollie.com/oauth2/authorize
  Token URL: https://api.mollie.com/oauth2/tokens scopes: customers.read

Query parameters

testmodeboolean

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

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

The customer object.

resourcestring required

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

idstring required

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

modestring required

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

Possible values: live test

namestring nullable required

The full name of the customer.

emailstring nullable required

The email address of the customer.

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

localestring nullable required

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 el_GR en_BE en_GB en_NL 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 sl_SI sv_SE tr_TR

createdAtstring required

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 response

{
  "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"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.