スケジュール一覧の取得

GEThttps://api.omise.co/schedules

アカウント内のすべてのスケジュールを一覧表示します。スケジュールにより、繰り返し課金、送金、自動操作が可能になります。このエンドポイントを使用して、アクティブなサブスクリプションの確認、スケジュールされた操作の監視、定期支払いのステータス追跡ができます。

---

リクエストパラメータ

任意 - 3項目ページネーションパラメータ

▼

`limit`INTEGER(optional)

1ページあたりに返すスケジュール数。

Example:20

Constraints:最小値: 1, 最大値: 100, デフォルト: 20

Default:20

`offset`INTEGER(optional)

ページネーションでスキップするスケジュール数。limitと組み合わせて大きな結果セットをページネートします。

Example:0

Default:0

`order`STRING(optional)

結果のソート順。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

任意 - 2項目フィルターパラメータ

▼

---

レスポンス

200

取得成功

スケジュールオブジェクトのページネーションされたリストを返します。各スケジュールには頻度、ステータス、操作の詳細が含まれます。

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

• data - スケジュールオブジェクトの配列
• limit - 1ページあたりの結果数
• offset - スキップされた結果数
• total - スケジュールの総数
• order - 適用されたソート順

スケジュールオブジェクトのフィールド:

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

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因:

• 無効な日付形式（ISO 8601である必要があります）
• limitが最大値（100）を超過
• 無効なorderパラメータ

401

認証エラー

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

一般的な原因:

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

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/schedules \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d limit=20 \
  -d offset=0

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedules = Omise::Schedule.list({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedules = omise.Schedule.list(
    limit=20,
    offset=0
)

Node.js

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

const schedules = await omise.schedules.list({
  limit: 20,
  offset: 0
});

PHP

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

$schedules = OmiseSchedule::retrieve(array(
    'limit' => 20,
    'offset' => 0
));

Java

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

ScopedList<Schedule> schedules = client.schedules().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedules = await client.Schedules.GetList(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

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

schedules, _ := client.ListSchedules(&operations.ListSchedules{
    List: operations.List{
        Limit:  20,
        Offset: 0,
    },
})

---

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

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認
bad_request	無効なパラメータ	日付形式とパラメータ値を確認
invalid_date_format	日付がISO 8601形式でない	形式を使用：YYYY-MM-DDTHH:MM:SSZ

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

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

---

🔑API認証情報

▼

試してみる

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