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

# POST /skip_auto_pay

`POST /skip_auto_pay`

## Request

- Base URL: `https://api.paynearme-sandbox.com/json-api`
- URL: `https://api.paynearme-sandbox.com/json-api/skip_auto_pay`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://login.paynearme.com/oauth/token`
  - API key in query parameter `signature`

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: 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. **NOTE:** This field is required when authenticating with the HMAC signature method; it is not required when authenticating with OAuth 2.0.
    - `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: 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. **NOTE:** This field is required when authenticating with the HMAC signature method; it is not required when authenticating with OAuth 2.0.
    - `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 `200`

Next Payment Skipped

- union
  - object
    - `status` 'ok', required
    - `skip_payment` 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`.
  - ErrorEnvelope: Returned with HTTP 200 for every failure except a rejected OAuth 2.0 access token, which returns HTTP 401 with the same shape. Every response carries a status; on failure it is "error" and the errors array describes what went wrong.
    - `status` 'error', required
    - `errors` ErrorDetail[], required: One entry per failure.
      - `description` string, required: Human-readable description of the failure.
      - `message` string: Parameter-validation detail (APPS-17178).
      - `receipt` string: Receipt text, where the failure relates to a payment.
      - `format` string: Expected format, for parameter-validation failures.
      - `example` string: Example of a well-formed value.
      - `details` object: Processor response details (APPS-18223).

## Other responses

- `401`: OAuth 2.0 requests only. The `Authorization` header has no Bearer token, the access token is invalid, expired, or issued for a different site, or the `site_identifier` does not match any site. The response does not say which. If the request is rejected before it reaches PayNearMe, the body may not be JSON, so detect this error by the HTTP status. HMAC-signed requests never receive this status.

## Changes

- **2026-11-03** `907541f733a3`: 1 breaking, 7 info
  - removed the success response with the status `201`
  - api operation id `skip_auto_pay` was added
  - the request property `site_identifier` with a default value became required
  - the request property `timestamp` with a default value became required
  - …4 more

[Operation history](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/changes/skip_auto_pay/post.md)

---

[API](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0.md) - [All operations](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/llms.txt) - [OpenAPI document](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/revisions/907541f733a3?raw)
