Search charge schedules

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

Search charge schedules to find schedules by customer, status, amount, and other criteria. The Search API provides powerful full-text search capabilities across all charge schedules.

---

Request Parameters

Recommended - 2 fieldsRecommended Parameters

▼

`query`STRING(optional)

Search query string. Searches across schedule description, metadata, customer information, and other fields. Supports multiple words (AND logic) and partial matches.

Example:"monthly subscription"

`filters`OBJECT(optional)

Filter criteria to narrow search results. Common filters include status, currency, amount, and created date ranges.

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

Additional - 3 fieldsAdditional Parameters

▼

---

Responses

200

Successful search

Search completed successfully. Returns a search result object with matching charge schedules in the data array.

Response includes:

• data - Array of charge schedule objects matching the search criteria
• total - Total number of results matching the search
• total_pages - Number of pages available
• page - Current page number
• per_page - Number of results per page
• order - Sort order applied (chronological or reverse_chronological)

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid page number (below 1)
• Invalid per_page value (above 100 or below 1)
• Malformed filters object

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

Resource not found.

Common causes:

• Invalid endpoint path
• Feature not enabled for the account

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

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",
    },
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Missing or invalid parameters	Check that parameters are valid
authentication_failure	Invalid API key	Verify your secret key is correct

Search Filter Options

Filter	Type	Description
status	string	Schedule status (active, paused, deleted, expiring)
currency	string	Currency code (thb, jpy, sgd, myr, usd, etc.)
amount	integer	Exact amount in smallest currency unit
customer	string	Customer ID associated with the schedule
created	object	Date range filter (e.g., {gte: '2025-01-01', lte: '2025-01-31'})

---

🔑API Credentials

▼

Try it out

Recommended - 2 fields

▼

Additional - 3 fields

▼

Your IP: ...Loading...