Customerの削除

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

アカウントからCustomerと関連するすべてのカードを完全に削除します。この操作は元に戻せないため、慎重に使用してください。

---

🔑API認証情報

▼

---

リクエストパラメータ

必須 - 1フィールド必須パラメータ

▼

`id`STRING(required)

削除するCustomer ID（cust_で始まる有効なCustomer IDである必要があります）。

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid customer ID

---

レスポンス

200

Customerが正常に削除されました

Customerと関連するすべてのカードが完全に削除されました。

削除の影響:

• Customerプロファイルが完全に削除されます
• 関連するすべてのカードが削除されます
• Customerのmetadataが完全に削除されます
• 過去の課金記録は残りますが、customerフィールドがnullになります
• 削除は元に戻せません

400

不正なリクエスト

無効なCustomer ID形式です。

一般的な原因:

• Customer IDの形式が無効です
• IDがcust_で始まっていません

401

認証されていません

認証に失敗しました。API keyが無効または不足しています。

一般的な原因:

• Authorizationヘッダーが不足しています
• 無効なsecret key
• secret keyではなくpublic keyを使用しています
• HTTP Basic Auth形式が正しくありません

404

見つかりません

Customerが見つかりません。

一般的な原因:

• Customer IDが存在しません
• Customerはすでに削除されています

---

コードサンプル

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が見つかりません	Customer IDが存在することを確認してください
conflict	Customerにアクティブなサブスクリプションがあります	削除前にサブスクリプションをキャンセルしてください

削除レスポンス

Field	Description
object	オブジェクトタイプ（常に"customer"）
id	削除されたCustomerのID
deleted	ブール値フラグ（削除成功時は常にtrue）
livemode	これがライブモードのCustomerであったかどうか

---

お試しください

必須 - 1項目

▼

id(必須)