Clientes

Métodos

Customer

Así se ve el objeto que devuelven los métodos de este módulo.

Crear un cliente

landapay.customers.create(params, options?)

Si ya existe un cliente con ese email o externalId recibes un InvalidRequestError con código email_taken o external_id_taken y el id existente en error.details.existingId.

Parámetros

Devuelve

Promise<Customer>

1const customer = await landapay.customers.create({2  name: "María Gómez",3  email: "[email protected]",4  document: { type: "CC", number: "1020304050" },5  externalId: "user_42",6});

Obtener un cliente

landapay.customers.retrieve(id, options?)

Parámetros

Devuelve

Promise<Customer>

const customer = await landapay.customers.retrieve("cus_ABCDEFGHJKLMNPQR");

Actualizar un cliente

landapay.customers.update(id, params, options?)

Acepta los campos de create, todos opcionales; null borra los opcionales. Los datos de facturación quedan bloqueados mientras el cliente tenga suscripciones activas.

Parámetros

Devuelve

Promise<Customer>

1await landapay.customers.update("cus_ABCDEFGHJKLMNPQR", {2  phone: "3001234567",3  metadata: { segment: "pyme" },4});

Obtener o crear un cliente

landapay.customers.getOrCreateId(params, options?)

Crea el cliente y devuelve su id, o devuelve el id del que ya tiene ese email o externalId. Es lo que usa subscriptions.create con un cliente en línea.

Parámetros

Devuelve

Promise<string>

1const customerId = await landapay.customers.getOrCreateId({2  name: "María Gómez",3  email: "[email protected]",4});