แสดงรายการกำหนดการของลูกค้า

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

แสดงรายการกำหนดการทั้งหมดที่เชื่อมโยงกับลูกค้าเฉพาะ Endpoint นี้ดึงการเรียกเก็บเงินซ้ำ, subscription และกำหนดการชำระเงินอัตโนมัติที่เชื่อมโยงกับลูกค้า

---

พารามิเตอร์คำขอ

จำเป็น - 1 ฟิลด์พารามิเตอร์ Path

▼

`id`STRING(required)

Customer ID ที่ต้องการดึงกำหนดการ (ต้องขึ้นต้นด้วย cust_)

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องเป็น customer ID ที่ถูกต้อง

เพิ่มเติม - 3 ฟิลด์พารามิเตอร์การแบ่งหน้า

▼

`limit`INTEGER(optional)

จำนวนกำหนดการที่ส่งคืนต่อหน้า

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

ดึงข้อมูลสำเร็จ

ส่งคืนรายการ schedule objects แบบแบ่งหน้าที่เชื่อมโยงกับลูกค้า แต่ละกำหนดการมีความถี่, สถานะ และรายละเอียดการดำเนินการ

การตอบกลับประกอบด้วย:

• object - ประเภท object (เป็น "list" เสมอ)
• data - Array ของ schedule objects
• limit - จำนวนผลลัพธ์ต่อหน้า
• offset - จำนวนผลลัพธ์ที่ข้าม
• total - จำนวนกำหนดการทั้งหมดสำหรับลูกค้านี้
• order - ลำดับการเรียงที่ใช้

ฟิลด์ Schedule object:

• id - Schedule ID (schd_*)
• status - active, expired, suspended, deleted, paused
• period - day, week หรือ month
• every - ตัวคูณความถี่สำหรับ period
• next_occurrences_on - Array ของวันที่เกิดขึ้นถัดไปสูงสุด 30 รายการ
• charge หรือ transfer - พารามิเตอร์การดำเนินการ

400

คำขอไม่ถูกต้อง

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความข้อผิดพลาดสำหรับรายละเอียด

สาเหตุทั่วไป:

• รูปแบบวันที่ไม่ถูกต้อง (ต้องเป็น ISO 8601)
• Limit เกินสูงสุด (100)
• พารามิเตอร์ order ไม่ถูกต้อง
• ค่า offset เป็นลบ

401

ไม่ได้รับอนุญาต

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือไม่มี

สาเหตุทั่วไป:

• ไม่มี Authorization header
• Secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบ Customer ID

สาเหตุทั่วไป:

• Customer ID ไม่มีอยู่
• ลูกค้าถูกลบไปแล้ว
• รูปแบบ customer ID ไม่ถูกต้อง

5xx

ข้อผิดพลาดเซิร์ฟเวอร์

เกิดข้อผิดพลาดฝั่งเซิร์ฟเวอร์ ซึ่งเกิดขึ้นไม่บ่อยแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

• ลองส่งคำขอใหม่ด้วย exponential backoff
• ตรวจสอบเหตุการณ์บริการที่ 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 key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
not_found	ไม่พบลูกค้า	ตรวจสอบว่า customer ID มีอยู่
bad_request	พารามิเตอร์ไม่ถูกต้อง	ตรวจสอบรูปแบบวันที่และค่าพารามิเตอร์
invalid_date_format	วันที่ไม่อยู่ในรูปแบบ ISO 8601	ใช้รูปแบบ: YYYY-MM-DDTHH:MM:SSZ

ค่าสถานะกำหนดการ

สถานะ	คำอธิบาย
active	กำหนดการทำงานปกติ
expired	กำหนดการผ่านวันสิ้นสุดแล้ว
suspended	กำหนดการถูกหยุด (ล้มเหลว, บัตรหมดอายุ)
deleted	กำหนดการถูกยกเลิก
paused	กำหนดการถูกหยุดด้วยตนเอง

ฟิลด์การตอบกลับ List

ฟิลด์	คำอธิบาย
object	ประเภท object (เป็น "list" เสมอ)
data	Array ของ schedule objects
limit	จำนวนรายการต่อหน้า
offset	จำนวนรายการที่ข้าม
total	จำนวนกำหนดการทั้งหมดสำหรับลูกค้านี้
order	ลำดับการเรียงที่ใช้
from	ตัวกรองวันเริ่มต้น (ถ้าใช้)
to	ตัวกรองวันสิ้นสุด (ถ้าใช้)

---

🔑ข้อมูลยืนยันตัวตน API

▼

ลองใช้งาน

จำเป็น - 1 ฟิลด์

▼

id(จำเป็น)

IP ของคุณ: ...กำลังโหลด...