Delete customer

DELETE

/v2/customers/{customer_id}

Deletes a customer profile from a business.

This operation also unlinks any associated cards on file.

As a best practice, include the version field in the request to enable optimistic concurrency control. If included, the value must be set to the current version of the customer profile.

To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.

Permissions:CUSTOMERS_WRITE

Guide

Delete a customer profile

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

customer_id

string

Required

The ID of the customer to delete.

Link to section

Query parameters

Link to section

version

integer(64-bit)

The current version of the customer profile.

As a best practice, you should include this parameter to enable optimistic concurrency control. For more information, see Delete a customer profile.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.