Skip to main content
POST
Cancel Bill Schedule

Authorizations

x-api-key
string
header
required

Your Meow API key, sent in the x-api-key header for authentication.

Headers

x-entity-id
string<uuid>

Optional entity_id to scope requests to a specific entity.

Path Parameters

schedule_id
string<uuid>
required

The bill schedule ID.

Response

Successful Response

id
string<uuid>
required

Identifier for the schedule.

status
enum<string>
required

DRAFT when the schedule is created here, since a schedule created through the API has not been submitted for approval yet. It becomes PENDING once submitted on the dashboard, then ACTIVE while it generates bills. CANCELED, COMPLETED and REJECTED are terminal — none of them generates anything further.

Available options:
DRAFT,
PENDING,
ACTIVE,
CANCELED,
COMPLETED,
REJECTED
rrule
string
required

The recurrence rule the schedule repeats on.

Required string length: 1 - 120
created_at
string<date-time>
required

When the schedule was created.

occurrences
string<date>[]

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

ISO 8601 full-date in the format YYYY-MM-DD (per IETF RFC 3339).

bills
ScheduledBillSummary · object[]

The bills this schedule has generated so far.