Skip to main content
POST
Create a schedule

Authorizations

Authorization
string
header
required

API key (pk_test_* or pk_live_), JWT session, agent token (agent_), Ed25519 session (sess_), or portal token (portal_).

Body

application/json
fromAccountId
string<uuid>
required
amount
number
required
frequency
enum<string>
required
Available options:
daily,
weekly,
biweekly,
monthly,
custom
startDate
string<date-time>
required
toAccountId
string<uuid>
toPaymentMethodId
string<uuid>
currency
string
default:USDC
intervalValue
integer
default:1
dayOfMonth
integer
Required range: 1 <= x <= 31
dayOfWeek
integer
Required range: 0 <= x <= 6
cronExpression
string
timezone
string
default:UTC
endDate
string<date-time>
maxOccurrences
integer
retryEnabled
boolean
default:true
maxRetryAttempts
integer
default:3
Required range: 0 <= x <= 10
retryWindowDays
integer
default:14
Required range: 1 <= x <= 60
description
string
Maximum string length: 500

Response

Schedule created

data
object
required