Sign in
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.

post/v2/customers

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Request body

resourcestring

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

idstring
mode'live' | 'test'

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

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.

locale'ca_ES' | 'cs_CZ' | 'da_DK' | 'de_AT' | 'de_CH' | 'de_DE' | 'de_LU' | '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' | 'sv_SE' | 'null' nullable

Sets the language for customer-facing content and communications.

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

{
  "resource": "customer",
  "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.

Changes

Changed in 6 of the 79 revisions of this API.1711

  • 86a9cd830b0622See the full diff
    • ●

      added the new en_BE enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new en_NL enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the new en_BE enum value to the request property

      request-property-enum-value-added

    • ○

      added the new en_NL enum value to the request property

      request-property-enum-value-added

  • 64c0511a62bc112See the full diff
    • ▲

      removed the enum value null of the request property

      request-property-enum-value-removed

    • ●

      added the new undefined enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the new undefined enum value to the request property

      request-property-enum-value-added

    • ○

      removed the null enum value from the //// response property for the response status

      response-property-enum-value-removed

  • 4d4ab81fb2d522See the full diff
    • ●

      added the new cs_CZ enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sk_SK enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the new cs_CZ enum value to the request property

      request-property-enum-value-added

    • ○

      added the new sk_SK enum value to the request property

      request-property-enum-value-added

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f3d6346a141222See the full diff
    • ●

      added the new de_LU enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new fr_LU enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the new de_LU enum value to the request property

      request-property-enum-value-added

    • ○

      added the new fr_LU enum value to the request property

      request-property-enum-value-added

Of the 79 revisions, 9 have no diff computed.