---
title: "POST /skip_auto_pay"
method: POST
path: "/skip_auto_pay"
tags: ["Autopay Schedules"]
---

# POST /skip_auto_pay

`POST /skip_auto_pay`

Use either the <code>pnm_order_identifier</code> or the <code>site_order_identifier</code> to skip the next scheduled payment in an autopay schedule.

## Request body

- union — Skip the next scheduled payment in an autopay schedule.
  - object
    - `site_identifier` string, required — Identifies your client site.
    - `timestamp` string, required — The Unix Epoch time of the call
    - `version` string, required — The version of the API. This version must match the version associated with your API key pair.
    - `signature` string, required — The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.
    - `return_minimal_info` string — Set to <code>true</code> to only return payment method data and not the full order.
    - `pnm_order_identifier` string, required — The unique, PayNearMe-defined identifier for this order
  - object
    - `site_identifier` string, required — Identifies your client site.
    - `timestamp` string, required — The Unix Epoch time of the call
    - `version` string, required — The version of the API. This version must match the version associated with your API key pair.
    - `signature` string, required — The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.
    - `return_minimal_info` string — Set to <code>true</code> to only return payment method data and not the full order.
    - `site_order_identifier` string, required — An arbitrary string that the client uses to refer to an order

## Response `201`

Next Payment Skipped

- SkipPayment — Provides the results of a skip autopay payment request.
  - `pnm_scheduled_payment_identifier` string — Displays the scheduled payment identifier that was skipped.
  - `scheduled_payment_date` string — Displays the date when the payment was originally scheduled in YYYY-MM-DD format.
  - `scheduled_payment_amount` string — The amount of the scheduled payment.
  - `scheduled_payment_currency` string — USD
  - `scheduled_payment_status` string — Indicates whether the autopay schedule is `active`, `user_suspended`, `pending`, `disabled`, or `complete`.
  - `scheduled_payment_pricing_schedule_name` string — Specifies the name of the pricing schedule (e.g.,<code>agent_recurring</code> or <code>consumer_recurring</code>). Supported values can include site-configured pricing schedules.
  - `scheduled_payment_payment_method` string — A description and the last 4 digits of the account number of the payment method used in this auotpay schedule.
  - `scheduled_payment_service_fee` string — The service fee that is assessed for each payment in this autopay schedule.
  - `scheduled_payment_origin` string — Indicates whether the schedule was created in the Consumer Portal, Agent Interface, or API.
  - `scheduled_payment_created_by` string — Indicates whether the schedule was created by the `Consumer`, `Agent`, or `API`.

## Other responses

- `400` — Payment Cannot be Skipped

---

[API](https://skmtc.net/paynearme/apis/paynearme-api-v3-0.md) · [All operations](https://skmtc.net/paynearme/apis/paynearme-api-v3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paynearme/paynearme-api-v3-0/revisions/44cba4f8b80f/schema)