Create Payment Schedule

Create a payment schedule

Generates one item per period from the lease params. The generated rows are
the source of truth from here on — edit them individually (partial
first/last month, waived periods, rent changes).

Send an optional Idempotency-Key header (X-Idempotency-Key is also
accepted) to make retries safe: repeating the same key with the same body
within 24 hours returns the schedule created the first time instead of a
second one. The same key with a different body, or while the first request
is still being processed, returns 409.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create AND preview share this shape: plan params in, periods out.

string
required
string
required
length between 1 and 500
string
length between 3 and 3
Defaults to EUR
string
enum
Defaults to monthly
Allowed:
date
required
date
required
required
≤ 999999999.99
1 to 28

Day of month each period falls due. Required for the monthly cadence and ignored by the others, which repeat the start date.

integer
0 to 23
Defaults to 9
integer
0 to 59
Defaults to 0
string
length between 1 and 64
Defaults to Europe/Madrid
integer
0 to 60
Defaults to 0

Send the payment link this many days before the period is due

Headers
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json