すべてのScheduleを一覧表示

GEThttps://api.omise.co/schedules

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

---

🔑API認証情報

▼

---

リクエストパラメータ

オプション - 3項目ページネーションパラメータ

▼

`limit`INTEGER(optional)

ページごとに返すScheduleの数。

Example:20

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

Default:20

`offset`INTEGER(optional)

ページネーションのためにスキップするScheduleの数。limitと併用して大きな結果セットをページネーションします。

Example:0

Default:0

`order`STRING(optional)

結果のソート順。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

オプション - 2項目フィルターパラメータ

▼

---

レスポンスs

200

取得成功

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

レスポンスに含まれるもの:

• data - Scheduleオブジェクトの配列
• limit - ページごとの結果数
• offset - スキップされた結果の数
• total - Scheduleの総数
• order - 適用されたソート順

Scheduleオブジェクトのフィールド:

• status - active、expired、suspended、deleted、paused
• period - day、week、またはmonth
• every - 期間の頻度乗数
• next_occurrences_on - 最大30件の今後のoccurrence日付の配列
• chargeまたはtransfer - 操作パラメータ

400

不正なリクエスト

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

一般的な原因:

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

401

認証されていません

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

一般的な原因:

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

---

コードサンプル

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

Scheduleステータス値

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

---

試してみる