Customers - Delete

DELETE /customers/{customer_id}

Deletes a customer and associated resources.

cURL
curl --request DELETE \
  --url https://sandbox.hyperswitch.io/customers/{customer_id} \
  --header 'api-key: <api-key>'

Response (200 — application/json)

Customer was Deleted

{
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "customer_deleted": false,
  "address_deleted": false,
  "payment_methods_deleted": false
}

Authorizations

  • api-key (string, header, required)

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Path Parameters

  • customer_id (string, required) The unique identifier for the Customer

Response Schema

  • customer_id (string, required) The identifier for the customer object Maximum string length: 255 Example: "cus_y3oqhf46pyzuxjbcn2giaqnb44"

  • customer_deleted (boolean, required) Whether customer was deleted or not Example: false

  • address_deleted (boolean, required) Whether address was deleted or not Example: false

  • payment_methods_deleted (boolean, required) Whether payment methods deleted or not Example: false

Was this page helpful? Yes / No

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/customers/customers--delete.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/customers/customers--delete

Related:

  • Customers - Update: https://api-reference.hyperswitch.io/v1/customers/customers--update

  • Customers - List: https://api-reference.hyperswitch.io/v1/customers/customers--list

PreviouscustomersNextorganization