API ReferenceScheduled Transactions

Delete Scheduled Transaction

<Badge>Available by Request</Badge> Cancel a scheduled transaction, preventing it from being automatically processed. This is useful when recurring charges need to be stopped or one-time scheduled payments are no longer needed. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

scheduledTransactionIdstringRequired
The id of the scheduled transaction

Response

Expected response to a valid request
amountdouble
codestring
typeenum
Allowed values:
createdAtdatetime or null
customerobject or null
deletedAtdatetime or null
descriptionstring or null
endDatestring or nullformat: "date"
householdobject or null
householdIdstring or nullformat: "uuid"
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
leaseobject or null
leaseIdstring or nullformat: "uuid"
ledgerenum or nullDefaults to OPERATING
Allowed values:
notesstring or null
organizationIdstring or nullformat: "uuid"
propertyobject or null
propertyIdstring or nullformat: "uuid"
startDatestring or nullformat: "date"
subledgerenum or nullDefaults to RESIDENT
Allowed values:
updatedAtdatetime or null