---
title: "Retry failed payment schedule items"
method: POST
path: "/v1/payment-schedule-items/retry-payment"
tags: ["Payment Schedules"]
---

# Retry failed payment schedule items

`POST /v1/payment-schedule-items/retry-payment`

Retries failed payment schedule items. The payment method and payment gateway of the failed payment can be updated to new values before the retry.

Note that you can retry a payment schedule item only when the payment schedule item is either in the `Error` or `Pending` status.

**Note:**
- To manage and access this feature through the self-service interface, see [Manage Features](https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings) in the Knowledge Center.
- This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled.

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

## Request body

- POSTRetryPaymentScheduleItemRequest
  - `items` POSTRetryPaymentScheduleItemInfo[] — The maximum number of items allowable to pass is 10.
    - `id` string — Specifies the ID of the payment schedule item to be retried.
    - `paymentGatewayId` string — Specifies the ID of a payment gateway that will be used in the retry.
    - `paymentMethodId` string — Specifies the ID of a payment method that will be used in the retry.

## Response `200`

OK

- POSTRetryPaymentScheduleItemResponse
  - `items` PaymentScheduleItemCommonResponse[]
    - `accountId` string — ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`.
    - `amount` number, nullable — The total amount of the payment schedule.
    - `balance` number — The remaining balance of payment schedule item.
    - `billingDocument` object, nullable
      - `id` string — ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.
      - `number` string — Number of the billing docuemnt, for example, `INV00002345`.
      - `type` string — Indicates whether the associated billing document is a debit memo or a invoice.
    - `createdById` string, nullable — The ID of the user who created the payment schedule item.
    - `createdDate` string, date, nullable — The date and time when the payment schedule item was created.
    - `currency` string, nullable — The currency of the payment.
    - `description` string, nullable — The description of the payment schedule item.
    - `errorMessage` string, nullable — The error message indicating if the error is related to configuration or payment collection.
    - `id` string — ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`.
    - `number` string — Number of the payment schedule item.
    - `paymentGatewayId` string, nullable — ID of the payment gateway of the payment schedule item.
    - `paymentMethodId` string, nullable — ID of the payment method of the payment schedule item.
    - `paymentOption` PaymentSchedulePaymentOptionFields[] — Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported. `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.
      - `detail` object — The field used to pass the transactional payment data to the gateway side in the key-value format.
        - `key` string — The name of the field.
        - `value` string — The value of the field.
      - `type` string — The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway.
    - `paymentScheduleId` string — ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`.
    - `paymentScheduleNumber` string — Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`.
    - `psiPayments` LinkedPaymentID[] — Container for payments linked to the payment schedule item.
      - `paymentId` string — ID of the payment.
    - `runHour` integer, nullable — At which hour in the day in the tenant’s timezone this payment will be collected.
    - `scheduledDate` string, date, nullable — The scheduled date when the payment is processed.
    - `standalone` boolean — Indicates if the payment created by the payment schedule item is a standalone payment or not.
    - `status` 'Pending' | 'Processed' | 'Error' | 'Canceled', nullable — ID of the payment method of the payment schedule item. - `Pending`: Payment schedule item is 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`.
    - `updatedById` string, nullable — The ID of the user who updated the payment schedule item.
    - `updatedDate` string, date, nullable — The date and time when the payment schedule item was last updated.
  - `success` boolean — Returns `true` if the request was processed successfully.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

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