---
title: "Retrieve a payment schedule"
method: GET
path: "/object-query/payment-schedules/{key}"
tags: ["Object Queries"]
---

# Retrieve a payment schedule

`GET /object-query/payment-schedules/{key}`

Retrieve the details of a specific Payment Schedule object.

## Path parameters

- `key` string, required

## Query parameters

- `pageSize` integer
- `cursor` string
- `sort[]` string[]
- `expand[]` string[]
- `filter[]` string[]
- `fields[]` string[]
- `includeNullFields` boolean

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- ExpandedPaymentSchedule
  - `id` string — The unique identifier of the payment schedule.
  - `createdById` string — The unique identifier of the user who created the payment schedule.
  - `createdDate` string, date-time — The time that the payment schedule gets created in the system, in the `YYYY-MM-DD HH:MM:SS` format.
  - `updatedById` string — The unique identifier of the user who last updated the payment schedule.
  - `updatedDate` string, date-time — The time that the payment schedule gets updated in the system, in the `YYYY-MM-DD HH:MM:SS` format.
  - `number` string — Number of the payment schedule.
  - `accountId` string — ID of the account that owns the payment schedule.
  - `invoiceId` string — The unique identifier of the invoice to which the payment is applied.
  - `debitmemoId` string — The unique identifier of the debit memo to which the payment is applied.
  - `paymentOptionId` string — The unique identifier of the payment option that is used to process the payment schedule.
  - `startDate` string, date — The date when the first payment of this payment schedule is proccessed.
  - `runHour` integer — At which hour in the day in the tenant’s timezone the recurring payment schedule items will be collected. Return `0` for custom payment schedules.
  - `period` 'Monthly' | 'Weekly' | 'BiWeekly' | 'null', nullable — For recurring payment schedule only. The period of payment generation. Returns `null` for custom payment schedules.
  - `prepayment` boolean — Indicates whether the payments created by the payment schedule are used as a reserved payment. This field is available only if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) for more information.
  - `occurrences` integer — The number of payment schedule items that are created by this payment schedule.
  - `status` 'Active' | 'Canceled' | 'Completed' — The status of the payment schedule. - Active: There is still payment schedule item to process. - Canceled: After a payment schedule is canceled by the user, the schedule is marked as `canceled`. - Completed: After all payment schedule items are processed, the schedule is marked as `Completed`.
  - `description` string — The description of the payment schedule.
  - `nextPaymentDate` string, date — The date the next payment will be processed.
  - `recentPaymentDate` string, date — The date the last payment was processed.
  - `totalPaymentsProcessed` integer — The number of processed payments.
  - `totalPaymentsErrored` integer — The number of errored payments.
  - `totalAmount` number — The total amount that will be collected by the payment schedule.

## Other responses

- `500` — Internal server error
- `4XX` — Invalid input

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)