---
title: "Skip a payment schedule item"
method: PUT
path: "/v1/payment-schedule-items/{item-id}/skip"
tags: ["Payment Schedules"]
---

# Skip a payment schedule item

`PUT /v1/payment-schedule-items/{item-id}/skip`

## Request

- Base URL: `https://rest.test.zuora.com`
- URL: `https://rest.test.zuora.com/v1/payment-schedule-items/{item-id}/skip`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/zuora/apis/zuora/docs/v1/payment-schedule-items/:item-id/skip/put.ts> (a function with typed inputs; its response is checked against the schema)

Skips a payment schedule item by ID. The skipped payment schedule item will turn to the `canceled` status, and a new item will be scheduled on the next recurring date after the last existing scheduled date.

**Note:**
- Only payment schedule items in recurring payment schedules can be skipped, and the item must be in the `pending` status.
- The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. 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.

## Path parameters

- `item-id` string, required

## Headers

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

## Response `200`

OK

- PUTSkipPaymentScheduleItemResponse: Container for custom fields of a Payment Schedule Item object.
  - `amount` number: The amount of the payment.
  - `billingDocument` object, nullable
    - `id` string: ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.
    - `number` string: The number of the billing docuemnt, for example, `INV00002345`.
    - `type` string: Indicates whether the associated billing document is a debit memo or a invoice.
  - `cancellationReason` string: The reason for the cancellation of payment schedule item.
  - `createdById` string: The ID of the user who created the payment schedule item.
  - `createdDate` string, date: The date and time when the payment schedule item was created.
  - `currency` string: The currency of the payment.
  - `description` string: The description of the payment schedule item.
  - `errorMessage` string, nullable: The error message indicating if the error is related to the configuration or the payment collection.
  - `id` string: ID of the newly-created payment schedule item. For example, `412880e749b72b310149b7343ef81346`.
  - `number` string: Number of the newly-created payment schedule item.
  - `paymentGatewayId` string, nullable: ID of the payment gateway of the payment schedule item.
  - `paymentMethodId` string: 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: At which hour in the day in the tenant’s timezone this payment will be collected.
  - `scheduledDate` string, date: The scheduled date when the payment is processed.
  - `standalone` boolean: Indicates if the payment created by the payment schedule item is a standalone payment.
  - `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`.
  - `success` boolean: Returns `true` if the request was processed successfully.
  - `updatedById` string: The ID of the user who updated the payment schedule item.
  - `updatedDate` string, date: The date and time when the payment schedule item was last updated.

## Other responses

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

---

[API](https://skmtc.dev/zuora/apis/zuora.md) - [All operations](https://skmtc.dev/zuora/apis/zuora/llms.txt) - [OpenAPI document](https://skmtc.dev/zuora/apis/zuora/revisions/3740c9728ad5?raw)