Skip to main content
POST
List active+paused recurring schedules

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Headers

Idempotency-Key
string

Client-chosen key; replaying the same key + body returns the original response, a different body returns 409.

Body

application/json

Create a recurring payment schedule. companyId is the token's tenant, never the body.

name
string
required

Schedule name (1-100 chars).

frequency
enum<string>
required

How often the schedule runs.

Available options:
weekly,
biweekly,
monthly
recipients
object[]
required
Minimum array length: 1
dayOfWeek
integer

0 (Sunday) through 6 (Saturday); used for weekly/biweekly. Defaults to 5 (Friday) when omitted.

Required range: 0 <= x <= 6
dayOfMonth
integer

1 through 28; used for monthly. Defaults to 1 when omitted.

Required range: 1 <= x <= 28
requiresApproval
boolean

Require an approval before each run. Coerced: only the literal boolean true enables it.

Response

The created recurring schedule.

data
object
required