List payment schedules.
Returns the payment schedules belonging to the institution your API key is issued for, in the list
envelope (object: "list", has_more, next_cursor, previous_cursor,
data). Page forward by passing the returned next_cursor as starting_after;
the last page has next_cursor: null. limit defaults to 25 and is capped at 100.
Results are ordered by payment-schedule id ascending; sort by payment_date to get the
order payment_schedule_ids expects. Filter with ?award_cycle_id= to list only the
schedules configured on that award cycle; an award cycle the institution does not have returns
404 award_cycle_not_found.
Assistant capability: springiq_list_payment_schedules.
Authentication
Query parameters
Only the schedules configured on this award cycle (?award_cycle_id=), by its stored ID. An
award cycle the institution does not have returns 404 award_cycle_not_found. Example:
"4MZ8QW2TC".
Page size. Defaults to 25. Values outside 1–100 are clamped rather than rejected.
Opaque cursor. Pass the next_cursor from the previous page to page forward. Mutually exclusive with ending_before; if both are supplied, starting_after wins.
Opaque cursor. Pass the previous_cursor from the current page to page backward.
Optional extras to add to the response, comma-separated. total_count is the only supported value: it adds total_count, the number of records that match this request across all pages. The count is taken fresh at the moment of each request, so it can change while you page; ask for it on the first page. Without it, total_count is left out of the response. Asking or not never invalidates a cursor. Any other value returns 400 validation_failed.
Response
Discriminator constant. Always "list", mirroring Stripe’s list objects.
The request path this collection was served from (e.g. /api/v1/scholarships).
Opaque cursor for the next page (pass as starting_after). Null when there is none.
Opaque cursor for the previous page (pass as ending_before). Null when there is none.
The number of records that match the request across all pages, counted fresh on each
request. Present only when the request includes include=total_count; otherwise the
key is omitted.