POST
Create or update a customer

Authorizations

x-hub-signature
string
header
required

HMAC-SHA256 hex digest keyed with the shared secret: over the raw request body for POST requests, or over the query string (the characters after "?") for GET requests. The signed query string is the one the WHATWG URL parser serializes, so a query built with URLSearchParams and appended unchanged verifies, while a hand-assembled query must be percent-encoded the same way.

Body

application/json

Customer details

Who is paying. Creates the customer on first use and updates its details on later checkouts.

externalId
string
required

The customer's ID in the merchant's system. Checkouts with the same externalId share one customer.

Minimum string length: 1
Example:

"user_8f2c1a"

email
string<email>
required
Example:

"ana.perez@example.com"

name
string
Required string length: 1 - 256
Example:

"Ana Pérez"

Response

The customer as stored

id
string<uuid>
required
Example:

"7d4f1c2e-3b5a-4e8f-9a1d-2c6b8e0f4a13"

externalId
string
required
Example:

"user_8f2c1a"

email
string<email>
required
Example:

"ana.perez@example.com"

name
string | null
required
Example:

"Ana Pérez"

createdAt
string<date-time>
required
Example:

"2026-10-01T16:45:18.000Z"

updatedAt
string<date-time>
required
Example:

"2026-10-01T16:45:18.000Z"