MEmeow
Bill Pay

Cancel Bill Schedule

Stops a recurring schedule from drafting any more bills. Bills it has already generated keep their own status, so this moves no money and reverses no approval.

post/bill-schedules/{schedule_id}/cancel

Request

Path parameters

schedule_idstring uuid required

The bill schedule ID.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

idstring uuid required

Identifier for the schedule.

status'DRAFT' | 'PENDING' | 'ACTIVE' | 'CANCELED' | 'COMPLETED' | 'REJECTED' required
rrulestring required

The recurrence rule the schedule repeats on.

occurrencesDateString[]

Every date this schedule pays on, past occurrences included. For an open-ended schedule this is the dates already generated plus the next five.

created_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

Changes

No recorded changes to this operation across all 1 revision of this API.