Customers

Deactivate a customer

Changed on May 3, 2026

Soft-delete a customer by setting them as inactive. Customer data is preserved.

delete/v1/customers/{customerId}

Request

Base URL
https://api.yuvexpay.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/yuvexpay/apis/yuvexpay-api/docs/v1/customers/:customerId/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

customerIdstring required

The customer's prefixed identifier (e.g., cus_ab12cd34ef). This is the merchant-facing slug, not the internal UUID.

Response

Customer deactivated.

messagestring

Changes

May 3, 2026a382df24e843 Revision changes
- info
  for the path request parameter customerId, the format was generalized from uuid to no format
Apr 14, 2026c75657100757 Revision changes
- info
  endpoint added

Operation history