ลบลูกค้า

DELETEhttps://api.omise.co/customers/:id

ลบลูกค้าและบัตรที่เกี่ยวข้องทั้งหมดออกจากบัญชีของคุณอย่างถาวร การดำเนินการนี้ไม่สามารถย้อนกลับได้ กรุณาใช้อย่างระมัดระวัง

---

🔑ข้อมูลยืนยันตัวตน API

▼

---

พารามิเตอร์คำขอ

จำเป็น - 1 ฟิลด์พารามิเตอร์ที่จำเป็น

▼

`id`STRING(required)

Customer ID ที่ต้องการลบ (ต้องเป็น Customer ID ที่ถูกต้องซึ่งขึ้นต้นด้วย cust_)

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid customer ID

---

การตอบกลับ

200

ลบลูกค้าสำเร็จ

ลบลูกค้าและบัตรที่เกี่ยวข้องทั้งหมดเรียบร้อยแล้ว

ผลกระทบจากการลบ:

• โปรไฟล์ลูกค้าถูกลบอย่างถาวร
• บัตรที่เกี่ยวข้องทั้งหมดถูกลบ
• ข้อมูล metadata ของลูกค้าถูกลบอย่างถาวร
• บันทึกการเรียกเก็บเงินในอดีตยังคงอยู่ แต่ฟิลด์ customer จะเป็น null
• การลบไม่สามารถย้อนกลับได้

400

คำขอไม่ถูกต้อง

รูปแบบ Customer ID ไม่ถูกต้อง

สาเหตุทั่วไป:

• รูปแบบ Customer ID ไม่ถูกต้อง
• ID ไม่ได้ขึ้นต้นด้วย cust_

401

ไม่ได้รับการยืนยันตัวตน

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือไม่มี

สาเหตุทั่วไป:

• ไม่มี Authorization header
• secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบข้อมูล

ไม่พบลูกค้า

สาเหตุทั่วไป:

• Customer ID ไม่มีอยู่จริง
• ลูกค้าถูกลบไปแล้ว

---

ตัวอย่างโค้ด

cURL

curl https://api.omise.co/customers/cust_test_5xuy4w91xqz7d1w9u0t \
  -X DELETE \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = Omise::Customer.destroy('cust_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = omise.Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')
customer.destroy()

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const customer = await omise.customers.destroy('cust_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$customer = OmiseCustomer::retrieve('cust_test_5xuy4w91xqz7d1w9u0t');
$customer->destroy();

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Customer customer = client.customers().destroy("cust_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var customer = await client.Customers.Destroy("cust_test_5xuy4w91xqz7d1w9u0t");

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

deleted, _ := client.Customers().Destroy("cust_test_5xuy4w91xqz7d1w9u0t")

---

รหัสข้อผิดพลาดและผลลัพธ์

รหัสข้อผิดพลาดทั่วไป

Code	Description	Resolution
bad_request	รูปแบบ Customer ID ไม่ถูกต้อง	ตรวจสอบรูปแบบ ID
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
not_found	ไม่พบลูกค้า	ตรวจสอบว่า Customer ID มีอยู่จริง
conflict	ลูกค้ามีการสมัครสมาชิกที่ใช้งานอยู่	ยกเลิกการสมัครสมาชิกก่อนลบ

การตอบกลับการลบ

Field	Description
object	ประเภทออบเจ็กต์ (จะเป็น "customer" เสมอ)
id	ID ของลูกค้าที่ถูกลบ
deleted	ค่า Boolean (จะเป็น true เสมอเมื่อลบสำเร็จ)
livemode	แสดงว่าเป็นลูกค้าในโหมดจริงหรือไม่

---

ลองใช้งาน

จำเป็น - 1 ฟิลด์

▼

id(จำเป็น)