スケジュールの取得

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

特定のスケジュールの詳細（ステータス、頻度、次回実行日、実行履歴を含む）を取得します。このエンドポイントを使用して、サブスクリプションのステータス確認、支払い履歴の確認、今後の課金の監視ができます。

---

リクエストパラメータ

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

▼

`id`STRING(required)

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

Example:"schd_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

取得成功

設定、ステータス、実行履歴を含む完全な詳細を持つスケジュールオブジェクトを返します。

スケジュールオブジェクトに含まれる項目:

• id - スケジュール識別子（schd_*）
• livemode - 本番モードまたはテストモード
• location - オブジェクトへのAPIパス
• status - active、expiring、expired、deleted、paused、suspended
• active - スケジュールが現在実行中かどうか
• every - 頻度乗数（1、2、3など）
• period - 時間単位（day、week、month）
• on - 特定のタイミング設定（days_of_month、weekday_of_month、weekdays）
• in_words - スケジュールの人間が読める説明
• start_on - スケジュール開始日
• end_on - スケジュール終了日
• ended_at - 実際の完了タイムスタンプ
• next_occurrences_on - 最大30件の今後の実行日の配列
• occurrences - 実行オブジェクトのリスト
• chargeまたはtransfer - 操作パラメータ
• created_at - スケジュール作成タイムスタンプ（ISO 8601）
• deleted - スケジュールが削除されたかどうか

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:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

$schedule = OmiseSchedule::retrieve('schd_test_5xuy4w91xqz7d1w9u0t');

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

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

一般的なエラーコード

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

スケジュールステータス値

ステータス	説明
active	スケジュールは正常に実行中
expired	スケジュールは終了日を過ぎた
suspended	スケジュールは一時停止中（失敗、カード期限切れ）
deleted	スケジュールはキャンセルされた
paused	スケジュールは手動で一時停止された

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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