顧客のスケジュール一覧

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

特定の顧客に関連するすべてのスケジュールを一覧表示します。このエンドポイントは、顧客にリンクされた定期課金、サブスクリプション、自動支払いスケジュールを取得します。

---

リクエストパラメータ

必須 - 1 フィールドパスパラメータ

▼

`id`STRING(required)

スケジュールを取得する顧客ID（cust_で始まる必要があります）。

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効な顧客IDである必要があります

オプション - 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

取得成功

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

レスポンスに含まれる情報:

• object - オブジェクトタイプ（常に"list"）
• data - スケジュールオブジェクトの配列
• limit - 1ページあたりの結果数
• offset - スキップされた結果数
• total - この顧客のスケジュールの総数
• order - 適用されたソート順

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

• id - スケジュールID (schd_*)
• status - active、expired、suspended、deleted、paused
• period - day、week、またはmonth
• every - 期間の頻度乗数
• next_occurrences_on - 最大30件の今後の発生日の配列
• chargeまたはtransfer - 操作パラメータ

400

不正なリクエスト

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

一般的な原因:

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

401

認証エラー

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

一般的な原因:

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

404

見つかりません

顧客IDが見つかりません。

一般的な原因:

• 顧客IDが存在しない
• 顧客が削除済み
• 顧客ID形式が正しくない

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = Omise::Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')
schedules = customer.schedules({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = omise.Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')
schedules = customer.schedules(
    limit=20,
    offset=0
)

Node.js

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

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

PHP

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

$customer = OmiseCustomer::retrieve('cust_test_5xuy4w91xqz7d1w9u0t');
$schedules = $customer->schedules(array(
    'limit' => 20,
    'offset' => 0
));

Java

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

ScopedList<Schedule> schedules = client.customers()
    .get("cust_test_5xuy4w91xqz7d1w9u0t")
    .schedules()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedules = await client.Customers.ListSchedules("cust_test_5xuy4w91xqz7d1w9u0t", new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

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

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

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決策
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
not_found	顧客が見つからない	顧客IDが存在するか確認
bad_request	無効なパラメータ	日付形式とパラメータ値を確認
invalid_date_format	日付がISO 8601形式でない	形式: YYYY-MM-DDTHH:MM:SSZ を使用

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

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

リストレスポンスフィールド

フィールド	説明
object	オブジェクトタイプ（常に"list"）
data	スケジュールオブジェクトの配列
limit	1ページあたりのアイテム数
offset	スキップされたアイテム数
total	この顧客のスケジュールの総数
order	適用されたソート順
from	開始日フィルタ（適用された場合）
to	終了日フィルタ（適用された場合）

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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