Skip to main content
POST
Cancel a bill's scheduled payment

Authorizations

Authorization
string
header
required

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

Path Parameters

billId
string
required

ID of the bill whose scheduled payment to cancel

Response

Successful operation

id
string
amountDueInCents
integer<int64> | null
totalAmountInCents
integer<int64> | null
vendorId
string | null
vendorName
string | null
dueDate
string | null
reference
string | null
status
string | null
documents
string[]
scheduledWithdrawalDate
string | null

Day (YYYY-MM-DD, US Eastern) a pending scheduled payment will debit your payment method, or null when the bill has no pending scheduled payment. Scheduling does not change the bill's status or amountDueInCents — the bill stays Open (or PartiallyPaid) until the payment executes. Bills synced from QuickBooks are the exception: QuickBooks applies the payment at scheduling time, so they can report Paid while this field is non-null — treat non-null as scheduled, not settled. If the scheduled payment is cancelled or fails, this field returns to null.