Skip to main content
POST
Create a payment schedule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

payment schedule to create

Payment schedule

description
string
required

User provided description for the payment schedule

payment_instruction
object
required
schedule
object
required

Payment schedule recurrence configuration

metadata
object

User provided JSON format data

tenant
string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

Response

Created payment schedule

Payment schedule

description
string
required

User provided description for the payment schedule

payment_instruction
object
required
schedule
object
required

Payment schedule recurrence configuration

tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

creation_time
string<date-time>
required
last_updated_time
string<date-time>
required
id
string<uuid>
read-only

Payment schedule ID

metadata
object

User provided JSON format data

next_payment_date
object
read-only
status
enum<string>
read-only

Status of the payment schedule.

Available options:
ACTIVE,
EXPIRED,
CANCELLED,
ERRORED