顧客を削除

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

顧客とすべての関連カードをアカウントから完全に削除します。このアクションは取り消すことができないため、慎重に使用してください。

---

リクエストパラメータ

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

▼

`id`STRING(required)

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

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効な顧客IDである必要があります

---

レスポンス

200

顧客が正常に削除されました

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

削除の影響:

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

400

不正なリクエスト

無効な顧客ID形式です。

一般的な原因:

• 顧客ID形式が無効
• IDがcust_で始まっていない

401

認証エラー

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

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• HTTP Basic Auth形式の誤り

404

見つかりません

顧客が見つかりません。

一般的な原因:

• 顧客IDが存在しない
• 顧客がすでに削除済み

5xx

サーバーエラー

サーバー側でエラーが発生しました。稀ですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストを再試行
• 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	無効な顧客ID形式	ID形式を確認
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
not_found	顧客が見つからない	顧客IDが存在するか確認
conflict	顧客にアクティブなサブスクリプションがある	削除前にサブスクリプションをキャンセル

削除レスポンス

フィールド	説明
object	オブジェクトタイプ（常に"customer"）
id	削除された顧客のID
deleted	ブールフラグ（成功した削除の場合は常にtrue）
livemode	本番モードの顧客かどうか

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

あなたのIP: ...読み込み中...