Archive a customer

Mark a customer as archived. Archiving an archived customer returns it unchanged.

post/v2/customers/{customerId}/archive

Request

The archived customer.

idstring required

Customer id with the le_cus_ prefix.

namestring required

The name invoices are addressed to.

emailstring required

Where invoices and reminders are sent.

phonestring

status'active' | 'archived' required

archived marks a customer you no longer bill. Archived customers can still be invoiced and are listed unless you filter by status.

createdAtstring date-time required

{
  "id": "le_cus_2rj4l7hmrrrcv",
  "name": "Acme Robotics",
  "email": "ap@acme.example",
  "phone": "+14155550123"
}