Skip to main content
PATCH
Update a payment schedule

Authorizations

Authorization
string
header
required

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

Path Parameters

payment_schedule_id
string<uuid>
required

Payment schedule ID

Body

application/json

payment schedule to update

Patch request for payment schedule

status
enum<string>

Target payment schedule status

Available options:
CANCELLED

Response

Updated payment schedule

Payment schedule

creation_time
string<date-time>
required
last_updated_time
string<date-time>
required
tenant
string
required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

description
string
required

User provided description for the payment schedule

payment_instruction
object
required
schedule
object
required

Payment schedule recurrence configuration

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,
CANCELLED,
ERRORED,
EXPIRED