チャージスケジュール一覧

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

アカウントのすべてのチャージスケジュールを一覧表示します。作成日でソートされたチャージスケジュールをフィルタリングおよびページネーション機能付きで返します。

---

リクエストパラメータ

推奨 - 3項目推奨パラメータ

▼

`limit`INTEGER(optional)

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

Example:20

Constraints:最小値: 1, 最大値: 100

Default:20

`offset`INTEGER(optional)

ページネーションのためにスキップするチャージスケジュールの数。limitと組み合わせてページを移動します。

Example:0

Default:0

`order`STRING(optional)

作成日によるソート順。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

追加 - 2項目追加パラメータ

▼

---

レスポンス

200

一覧取得成功

チャージスケジュールデータ配列とページネーションメタデータを含むリストオブジェクトを返します。

レスポンス内容:

• data - チャージスケジュールオブジェクトの配列
• total - フィルタに一致するチャージスケジュールの総数
• limit - 1ページあたりの項目数
• offset - 現在のページネーションオフセット
• order - 適用されたソート順
• from / to - 適用された日付範囲

400

不正なリクエスト

無効なパラメータが指定されました。

一般的な原因:

• 無効な日付形式（ISO 8601である必要があります）
• limitが範囲外（1-100である必要があります）
• 無効なoffset値

401

認証エラー

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

一般的な原因:

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

404

見つかりません

リソースが見つかりません。

一般的な原因:

• 無効なエンドポイントパス
• アカウントで機能が有効化されていない

5xx

サーバーエラー

サーバー側でエラーが発生しました。まれですが、適切に処理してください。

対処方法:

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

---

コードサンプル

cURL

curl "https://api.omise.co/charges/schedules?limit=20&offset=0" \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedules = Omise::Charge.schedules(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedules = omise.Charge.schedules(limit=20, offset=0)

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedules = await client.Charges.ListSchedules(new ListOptions {
    Limit = 20,
    Offset = 0
});

Go

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

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

---

エラーと結果コード

一般的な使用パターン

パターン	説明	例
基本的なページネーション	ページを順次取得	limit=20&offset=0、次にoffset=20など
日付範囲フィルタ	作成日でフィルタ	from=2025-01-01T00:00:00Z&to=2025-01-31T23:59:59Z
新しい順	最新のスケジュールを先に	order=reverse_chronological

ページネーション計算

フィールド	計算	用途
次のページ	offset + limit	次の結果セットを取得
前のページ	offset - limit（最小0）	前のページに戻る
さらにあるか	offset + limit < total	さらにページがあるか確認
ページ番号	(offset / limit) + 1	現在のページ番号

---

🔑API認証情報

▼

試してみる

推奨 - 3項目

▼

追加 - 2項目

▼

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