Delete a schedule

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

Delete an existing schedule to stop all future occurrences. This permanently cancels the recurring charges or transfers associated with the schedule. Past occurrences are not affected and remain in your records.

---

Request Parameters

Required - 1 fieldPath Parameters

▼

`id`STRING(required)

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

Example:"schd_test_5xuy4w91xqz7d1w9u0t"

---

Responses

200

Schedule deleted

Returns the deleted schedule object with status updated to "deleted". All future occurrences are cancelled.

Response includes:

• id - Schedule identifier (schd_*)
• status - Updated to "deleted"
• deleted - Set to true
• deleted_at - Timestamp of deletion
• occurrences - List of past occurrences (preserved)

Important notes:

• Deletion is permanent and cannot be undone
• Past charges/transfers are not affected or reversed
• Any pending occurrences scheduled for today may still execute

400

Bad request

Request validation failed. The schedule may already be deleted or in an invalid state.

Common causes:

• Schedule is already deleted
• Schedule is in a state that cannot be deleted
• Invalid schedule ID format

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 was already deleted

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/schedules/schd_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -X DELETE

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

$schedule = OmiseSchedule::retrieve('schd_test_5xuy4w91xqz7d1w9u0t');
$schedule->destroy();

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

schedule, _ := client.DestroySchedule("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)
invalid_schedule	Schedule cannot be deleted	Check if schedule is already deleted

Schedule Status After Deletion

Field	Value
status	deleted
deleted	true
deleted_at	Timestamp of deletion

---

🔑API Credentials

▼

Try it out

Required - 1 fields

▼

id(Required)

Your IP: ...Loading...