Crear un cliente | Documentación API de Recurrente

Crea un nuevo cliente. Si ya existe un usuario con el email proporcionado, el cliente se asocia a ese usuario. Si el email es nuevo, se crean tanto el usuario como el cliente.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Tu clave secreta de API. Una llave de cuenta (`sk_live_...`, `sk_test_...`) opera sobre su propia cuenta y, con `X-ACCOUNT-ID`, sobre sus cuentas conectadas. Una llave de organización (`sk_org_live_...`, `sk_org_test_...`) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con `X-ACCOUNT-ID`; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde `403` con `code: organization_key_unsupported`.

Request

This endpoint expects an object.

emailstringRequiredformat: "email"

Email del cliente (se usa para buscar o crear el usuario)

full_namestringOptional

Nombre completo

namestringOptional

Nombre para mostrar

phonestringOptional

(Opcional) Número de teléfono

addressstringOptional

(Opcional) Dirección

nitstringOptional

(Opcional) Número de identificación tributaria

metadatamap from strings to stringsOptional

(Opcional) Metadata personalizada

test_clock_idstringOptional

ID de un Test Clock del mismo Sandbox. No está disponible en LIVE.

Response

Cliente creado o encontrado

idstringOptional

ID único del cliente

user_idstringOptional

ID del usuario asociado

emailstringOptionalformat: "email"

Email del cliente

namestringOptional

Nombre del cliente

phonestring or nullOptional

Número de teléfono

addressstring or nullOptional

Dirección

nitstring or nullOptional

Número de identificación tributaria

metadatamap from strings to any or nullOptional

Metadata personalizada

test_clock_idstring or nullOptional

ID del test clock asignado al Customer. Solo puede usarse con una llave de un Sandbox nombrado.

Errors

400

Bad Request Error

$	curl -X POST https://app.recurrente.com/api/customers \
>	-H "X-SECRET-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"email": "nuevo@ejemplo.com"
>	}'

1	{
2	"id": "cus_abc123",
3	"user_id": "usr_xyz789",
4	"email": "cliente@ejemplo.com",
5	"name": "Maria Garcia",
6	"phone": "string",
7	"address": "string",
8	"nit": "string",
9	"metadata": {},
10	"test_clock_id": "clock_abc123"
11	}