API Reference
  1. UrbanPay
  2. Payment Schedules

Create Payment Schedule

post
https://api-sandbox.urbanpayx.com/api/v1/payment-schedules

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).

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
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

Responses

Updated about 3 hours ago

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

Updated about 3 hours ago

Did this page help you?