Delete Customer

API Explorer
https://api.ipospays.tech/invoice-service/v1/customers/{customer_id}
DELETE

Deletes the customer. Not allowed for merchant-billing customers or while one of the customer's invoices has an active payment link.

Path Parameters

customer_id*string

Public customer id returned by Create Customer

Header Parameters

token*string

Authentication token generated using the API Key and Secret Key of the Merchant credentials. Required for all API requests.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com" \  -H "token: your-access-token-here"
{
  "data": {
    "customer_id": "14EMLX12D0QQY2J"
  },
  "message": "Customer deleted successfully",
  "response_code": "SUCCESS",
  "status_code": 200,
  "request_id": "TEST-20261008183440-ZD8VT6",
  "timestamp": "2026-10-08T13:04:40.549Z"
}

{
  "data": null,
  "message": "The request contains invalid input parameters.",
  "response_code": "BAD_REQUEST",
  "status_code": 400,
  "request_id": "TEST-20261008183441-XICV1I",
  "timestamp": "2026-10-08T13:04:41.769Z",
  "errors": [
    {
      "field": "customer_id",
      "messages": [
        "customer_id must be a valid customer id"
      ]
    }
  ]
}

{
  "data": null,
  "message": "Missing authentication token. Please include a valid API token in your request.",
  "response_code": "TOKEN_MISSING",
  "status_code": 401,
  "request_id": "TEST-20261022075139-CNA4TE",
  "timestamp": "2026-10-22T07:51:39.703Z"
}

{
  "data": null,
  "message": "Customer not found",
  "response_code": "NOT_FOUND",
  "status_code": 404,
  "request_id": "TEST-20261008183441-AEKDXT",
  "timestamp": "2026-10-08T13:04:41.281Z"
}

{
  "data": null,
  "message": "Customer has an invoice with an active payment link and cannot be deleted. Cancel the link in the portal first",
  "response_code": "PRECONDITION_FAILED",
  "status_code": 409,
  "request_id": "TEST-20261008183444-XJREU9",
  "timestamp": "2026-10-08T13:04:44.439Z"
}

{
  "data": null,
  "message": "Too many requests, please try again in a minute",
  "response_code": "RATE_LIMITED",
  "status_code": 429,
  "timestamp": "<ISO 8601 time>"
}

{
  "data": null,
  "message": "An error occurred while processing your request. Please try again later.",
  "response_code": "INTERNAL_ERROR",
  "status_code": 500,
  "request_id": "<generated per request>",
  "timestamp": "<ISO 8601 time>"
}