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

# Retrieve a payment schedule item

`GET /object-query/payment-schedule-items/{key}`

Retrieve the details of a specific Payment Schedule Item 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

- ExpandedPaymentScheduleItem
  - `id` string — The unique identifier of the payment schedule item.
  - `createdById` string — The unique identifier of the user who created the payment schedule item.
  - `createdDate` string, date-time — The time that the payment schedule item 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 item.
  - `updatedDate` string, date-time — The time that the payment schedule item gets updated in the system, in the `YYYY-MM-DD HH:MM:SS` format.
  - `number` string — Number of the payment schedule item.
  - `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 item.
  - `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.
  - `scheduledDate` string, date — The scheduled date when the payment is processed.
  - `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.
  - `paymentMethodId` string — ID of the payment method that will pay the billing documents.
  - `paymentGatewayId` string, nullable — ID of the payment gateway that processes the payment.
  - `amount` number — The total amount of the payment schedule item.
  - `balance` number — The remaining balance of payment schedule item.
  - `currency` string — The currency in which the payment is made. Note: If this field was not specified, the default value is the currency set for the account.
  - `status` 'Pending' | 'Processed' | 'Error' | 'Canceled' — ID of the payment method of the payment schedule item. - `Pending`: Waiting for processing. - `Processed`: The payment has been collected. - `Error`: Failed to collect the payment. - `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.
  - `errorMessage` string — The error message indicating if the error is related to the configuration or the payment collection.
  - `paymentId` string — ID of the payment that is created by the payment schedule item, or linked to the payment schedule item. This field is only available if the request doesn’t specify `Zuora-Version`, or `Zuora-Version` is set to a value equal to or smaller than\_`336.0`.
  - `description` string — The description of the payment schedule item.
  - `cancellationReason` string — The reason for the cancellation of payment schedule item.
  - `paymentScheduleId` string — ID of the payment schedule to which the payment schedule item belongs.

## 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)