ค้นหา Charge Schedules

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

ค้นหา charge schedules เพื่อค้นหา schedules ตามลูกค้า, สถานะ, จำนวนเงิน และเกณฑ์อื่นๆ Search API มีความสามารถในการค้นหาข้อความแบบเต็มที่มีประสิทธิภาพในทุก charge schedules

---

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

แนะนำ - 2 ฟิลด์พารามิเตอร์แนะนำ

▼

`query`STRING(optional)

สตริงคำค้นหา ค้นหาในคำอธิบาย schedule, metadata, ข้อมูลลูกค้า และฟิลด์อื่นๆ รองรับหลายคำ (AND logic) และการจับคู่บางส่วน

Example:"monthly subscription"

`filters`OBJECT(optional)

เกณฑ์การกรองเพื่อจำกัดผลการค้นหา ตัวกรองทั่วไปรวมถึงสถานะ, สกุลเงิน, จำนวนเงิน และช่วงวันที่สร้าง

Example:{"status":"active","currency":"thb"}

เพิ่มเติม - 3 ฟิลด์พารามิเตอร์เพิ่มเติม

▼

---

การตอบกลับ

200

ค้นหาสำเร็จ

การค้นหาเสร็จสมบูรณ์ ส่งคืนออบเจ็กต์ผลการค้นหาพร้อม charge schedules ที่ตรงกันใน data array

เนื้อหาการตอบกลับ:

• data - Array ของออบเจ็กต์ charge schedule ที่ตรงกับเกณฑ์การค้นหา
• total - จำนวนผลลัพธ์ทั้งหมดที่ตรงกับการค้นหา
• total_pages - จำนวนหน้าที่มี
• page - หมายเลขหน้าปัจจุบัน
• per_page - จำนวนผลลัพธ์ต่อหน้า
• order - ลำดับการเรียงที่ใช้ (chronological หรือ reverse_chronological)

400

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

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

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

• หมายเลขหน้าไม่ถูกต้อง (ต่ำกว่า 1)
• ค่า per_page ไม่ถูกต้อง (มากกว่า 100 หรือต่ำกว่า 1)
• ออบเจ็กต์ filters ไม่ถูกรูปแบบ

401

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

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

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

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

404

ไม่พบ

ไม่พบทรัพยากร

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

• เส้นทาง endpoint ไม่ถูกต้อง
• ฟีเจอร์ไม่ได้เปิดใช้งานสำหรับบัญชี

5xx

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

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

วิธีจัดการ:

• ลองส่งคำขอใหม่ด้วย exponential backoff
• ตรวจสอบ status.omise.co สำหรับเหตุการณ์บริการ
• ดู การจัดการข้อผิดพลาด สำหรับคำแนะนำโดยละเอียด

---

ตัวอย่างโค้ด

cURL

curl "https://api.omise.co/charges/schedules/search" \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=monthly subscription" \
  -d "filters[status]=active" \
  -d "filters[currency]=thb"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Charge.search_schedules({
  query: 'monthly subscription',
  filters: {
    status: 'active',
    currency: 'thb'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Charge.search_schedules(
    query='monthly subscription',
    filters={
        'status': 'active',
        'currency': 'thb'
    }
)

Node.js

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

const results = await omise.charges.searchSchedules({
  query: 'monthly subscription',
  filters: {
    status: 'active',
    currency: 'thb'
  }
});

PHP

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

$results = OmiseCharge::searchSchedules([
    'query' => 'monthly subscription',
    'filters' => [
        'status' => 'active',
        'currency' => 'thb'
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("status", "active");
filters.put("currency", "thb");

SearchResult<Schedule> results = client.charges()
    .searchSchedules()
    .query("monthly subscription")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Charges.SearchSchedules(new SearchRequest
{
    Query = "monthly subscription",
    Filters = new Dictionary<string, object>
    {
        { "status", "active" },
        { "currency", "thb" }
    }
});

Go

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

results, _ := client.SearchChargeSchedules(&operations.SearchChargeSchedules{
    Query: "monthly subscription",
    Filters: map[string]interface{}{
        "status":   "active",
        "currency": "thb",
    },
})

---

รหัสข้อผิดพลาดและผลลัพธ์

รหัสข้อผิดพลาดทั่วไป

รหัส	คำอธิบาย	การแก้ไข
bad_request	พารามิเตอร์ขาดหายหรือไม่ถูกต้อง	ตรวจสอบว่าพารามิเตอร์ถูกต้อง
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง

ตัวเลือกตัวกรองการค้นหา

ตัวกรอง	ประเภท	คำอธิบาย
status	string	สถานะ schedule (active, paused, deleted, expiring)
currency	string	รหัสสกุลเงิน (thb, jpy, sgd, myr, usd ฯลฯ)
amount	integer	จำนวนเงินที่แน่นอนในหน่วยสกุลเงินที่เล็กที่สุด
customer	string	Customer ID ที่เกี่ยวข้องกับ schedule
created	object	ตัวกรองช่วงวันที่ (เช่น {gte: '2025-01-01', lte: '2025-01-31'})

---

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

▼

ลองใช้งาน

แนะนำ - 2 ฟิลด์

▼

เพิ่มเติม - 3 ฟิลด์

▼

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