Scheduleを取得

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

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

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

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

Example:"schd_test_5xuy4w91xqz7d1w9u0t"

---

レスポンスs

200

取得成功

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

Scheduleオブジェクトに含まれるもの:

• id - Schedule識別子（schd_*）
• status - active、expired、suspended、deleted、またはpaused
• every - 頻度乗数（1、2、3など）
• period - 時間単位（day、week、month）
• on - 特定のタイミング設定（days_of_month、weekday_of_month）
• next_occurrences_on - 今後の実行日の配列
• chargeまたはtransfer - 操作パラメータ
• start_dateおよびend_date - Scheduleの期間

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーが欠落している
• 無効なシークレットキー
• シークレットキーの代わりに公開キーを使用している
• HTTP Basic Auth形式が正しくない

404

見つかりません

Scheduleが見つからないか、存在しません。

一般的な原因:

• 無効なSchedule ID
• 別のアカウントのSchedule ID
• テストモードと本番モードのキーが混在している
• Scheduleが削除されている

---

コードサンプル

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	Scheduleが見つかりません	Schedule IDを確認し、正しいモード（テスト/本番）であることを確認してください

Scheduleステータス値

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

---

試してみる

必須 - 1項目

▼

id(必須)