You are viewing an old version of the API

All Versions

Delete customer

DELETE /v2/customers/{customer_id}

Deletes a customer profile from a business, including any linked cards on file.

As a best practice, you should include the version field in the request to enable optimistic concurrency control. 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

Path Parameters

Example code

Name	Description
`customer_id string` Required	The ID of the customer to delete.

Query Parameters

Name	Description
`version integer (64-bit)` Beta	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.

Response Fields

Name	Description
`errors Error [ ]`	Any errors that occurred during the request.

Examples