スケジュールの削除

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

既存のスケジュールを削除して、将来のすべての実行を停止します。これにより、スケジュールに関連する繰り返し課金または送金が永久にキャンセルされます。過去の実行は影響を受けず、記録に残ります。

---

リクエストパラメータ

必須 - 1項目パスパラメータ

▼

`id`STRING(required)

削除するスケジュールID。スケジュールIDはschd_で始まり、テストモードの場合はtest_が続きます。

Example:"schd_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

スケジュール削除完了

ステータスが"deleted"に更新された削除済みスケジュールオブジェクトを返します。将来のすべての実行がキャンセルされます。

レスポンスに含まれる項目:

• id - スケジュール識別子（schd_*）
• status - "deleted"に更新
• deleted - trueに設定
• deleted_at - 削除のタイムスタンプ
• occurrences - 過去の実行リスト（保持されます）

重要な注意事項:

• 削除は永久的で元に戻せません
• 過去の課金/送金は影響を受けず、取り消されません
• 本日予定されている保留中の実行は実行される可能性があります

400

不正なリクエスト

リクエストの検証に失敗しました。スケジュールが既に削除されているか、無効な状態の可能性があります。

一般的な原因:

• スケジュールが既に削除されている
• スケジュールが削除できない状態にある
• 無効なスケジュールID形式

401

認証エラー

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

一般的な原因:

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

404

見つかりません

スケジュールが見つからないか存在しません。

一般的な原因:

• 無効なスケジュールID
• 別のアカウントのスケジュールID
• テストモードと本番モードのキーの混同
• スケジュールが既に削除されている

5xx

サーバーエラー

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

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービス障害を確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/schedules/schd_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -X DELETE

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedule = Omise::Schedule.retrieve('schd_test_5xuy4w91xqz7d1w9u0t')
schedule.destroy

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedule = omise.Schedule.retrieve('schd_test_5xuy4w91xqz7d1w9u0t')
schedule.destroy()

Node.js

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

const schedule = await omise.schedules.destroy('schd_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$schedule = OmiseSchedule::retrieve('schd_test_5xuy4w91xqz7d1w9u0t');
$schedule->destroy();

Java

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

Schedule schedule = client.schedules().destroy("schd_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedule = await client.Schedules.Destroy("schd_test_5xuy4w91xqz7d1w9u0t");

Go

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

schedule, _ := client.DestroySchedule("schd_test_5xuy4w91xqz7d1w9u0t")

---

エラーコードと結果コード

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認
not_found	スケジュールが見つからない	スケジュールIDと正しいモード（test/live）を確認
invalid_schedule	スケジュールを削除できない	スケジュールが既に削除されていないか確認

削除後のスケジュールステータス

フィールド	値
status	deleted
deleted	true
deleted_at	削除のタイムスタンプ

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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