Retrieve a schedule

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

Retrieve details of a specific schedule including status, frequency, next execution dates, and occurrence history. Use this endpoint to check subscription status, view payment history, and monitor upcoming charges.

---

🔑API Credentials

▼

---

Request Parameters

Required - 1 fieldPath Parameters

▼

`id`STRING(required)

The schedule ID to retrieve. Schedule IDs start with schd_ followed by test_ for test mode.

Example:"schd_test_5xuy4w91xqz7d1w9u0t"

---

Responses

200

Successful retrieval

Returns the schedule object with complete details including configuration, status, and occurrence history.

Schedule object includes:

• id - Schedule identifier (schd_*)
• status - active, expired, suspended, deleted, or paused
• every - Frequency multiplier (1, 2, 3, etc.)
• period - Time unit (day, week, month)
• on - Specific timing configuration (days_of_month, weekday_of_month)
• next_occurrences_on - Array of upcoming execution dates
• charge or transfer - Operation parameters
• start_date and end_date - Schedule duration

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

Schedule not found or does not exist.

Common causes:

• Invalid schedule ID
• Schedule ID from different account
• Mixing test and live mode keys
• Schedule has been deleted

---

Code samples

cURL

curl https://api.omise.co/schedules/schd_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedule = Omise::Schedule.retrieve('schd_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedule = omise.Schedule.retrieve('schd_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const schedule = await omise.schedules.retrieve('schd_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$schedule = OmiseSchedule::retrieve('schd_test_5xuy4w91xqz7d1w9u0t');

Java

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

Schedule schedule = client.schedules().get("schd_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedule = await client.Schedules.Get("schd_test_5xuy4w91xqz7d1w9u0t");

Go

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

schedule, _ := client.GetSchedule("schd_test_5xuy4w91xqz7d1w9u0t")

---

Error and result codes

Common Error Codes

Code	Description	Resolution
authentication_failure	Invalid API key	Verify your secret key is correct
not_found	Schedule not found	Check schedule ID and ensure correct mode (test/live)

Schedule Status Values

Status	Description
active	Schedule is running normally
expired	Schedule has passed end date
suspended	Schedule is paused (failures, card expiry)
deleted	Schedule has been cancelled
paused	Schedule manually paused

---

Try it out

Required - 1 fields

▼

id(Required)