---
title: "Get Bill Schedule"
method: GET
path: "/bill-schedules/{schedule_id}"
tags: ["Bill Pay"]
---

# Get Bill Schedule

`GET /bill-schedules/{schedule_id}`

## Request

- Base URL: `https://api.meow.com/v1`
- URL: `https://api.meow.com/v1/bill-schedules/{schedule_id}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/meow/apis/meow-api/docs/bill-schedules/:schedule_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a single recurring bill schedule by ID.

## Path parameters

- `schedule_id` string, uuid, required: The bill schedule ID.

## Headers

- `x-entity-id` string, uuid

## Response `200`

Successful Response

- BillScheduleResponse
  - `id` string, uuid, required: Identifier for the schedule.
  - `status` 'DRAFT' | 'PENDING' | 'ACTIVE' | 'CANCELED' | 'COMPLETED' | 'REJECTED', required
  - `rrule` string, required: The recurrence rule the schedule repeats on.
  - `occurrences` DateString[]: Every date this schedule pays on, past occurrences included. For an open-ended schedule this is the dates already generated plus the next five.
  - `bills` ScheduledBillSummary[]: The bills this schedule has generated so far.
    - `bill_id` string, uuid, required: The bill this occurrence produced.
    - `status` 'CANCELED' | 'DRAFT_PROCESSING' | 'DRAFT' | 'PAYMENT_INFO_NEEDED' | 'PENDING' | 'APPROVED' | 'REJECTED' | 'SCHEDULED' | 'PAYMENT_INITIATED' | 'PAYMENT_DELIVERED' | 'PAYMENT_FAILED' | 'PAYMENT_CANCELED', required
    - `scheduled_payment_date` string, date: ISO 8601 full-date in the format `YYYY-MM-DD` (per [IETF RFC 3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)).
    - `total` string, nullable: The bill's total, in the schedule's currency.
  - `created_at` string, date-time, required: ISO 8601 date-time in the format `YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]` (per [IETF RFC 3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)).

## Other responses

- `400`: The request could not be processed.
- `401`: Authentication failed.
- `403`: The API key is not authorized for this operation, or the user of a global API key is an admin or controller without approved KYC. The KYC case returns the message `KYC is required for controllers and admins.` until that user completes KYC in the Meow dashboard.
- `429`: Too many requests.

---

[API](https://skmtc.dev/meow/apis/meow-api.md) - [All operations](https://skmtc.dev/meow/apis/meow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/meow/apis/meow-api/revisions/ea2d7e25b63b?raw)