ลบลูกค้า

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

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

---

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

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

▼

`id`STRING(required)

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

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องเป็น customer ID ที่ถูกต้อง

---

การตอบกลับ

200

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

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

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

• โปรไฟล์ลูกค้าถูกลบอย่างถาวร
• บัตรที่เกี่ยวข้องทั้งหมดถูกลบ
• Metadata ของลูกค้าถูกลบอย่างถาวร
• การชำระเงินในอดีตยังคงอยู่ในบันทึกแต่ฟิลด์ลูกค้าจะเป็น 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 ไม่มีอยู่
• ลูกค้าถูกลบไปแล้ว

5xx

ข้อผิดพลาดเซิร์ฟเวอร์

เกิดข้อผิดพลาดฝั่งเซิร์ฟเวอร์ ซึ่งเกิดขึ้นไม่บ่อยแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

• ลองส่งคำขอใหม่ด้วย exponential backoff
• ตรวจสอบเหตุการณ์บริการที่ status.omise.co
• ดูการจัดการข้อผิดพลาดสำหรับคำแนะนำโดยละเอียด

---

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

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")

---

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

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

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	รูปแบบ customer ID ไม่ถูกต้อง	ตรวจสอบรูปแบบ ID
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
not_found	ไม่พบลูกค้า	ตรวจสอบว่า customer ID มีอยู่
conflict	ลูกค้ามี subscription ที่ active	ยกเลิก subscription ก่อนลบ

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

ฟิลด์	คำอธิบาย
object	ประเภท object (เป็น "customer" เสมอ)
id	ID ของลูกค้าที่ลบ
deleted	Boolean flag (เป็น true เสมอสำหรับการลบที่สำเร็จ)
livemode	ว่านี่เป็นลูกค้า live mode หรือไม่

---

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

▼

ลองใช้งาน

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

▼

id(จำเป็น)

IP ของคุณ: ...กำลังโหลด...