---
updatedAt: 2025-06-04T21:36:34.000Z
agentTools:
  projectIndex: https://documentation.paysimple.com/llms.txt
---

# Pause Schedule

Stop a recurring payment from generating payments until a specified date.

To confirm that a schedule has been paused, retrieve the recurring payment object  and check the `ScheduleStatus` field. Paused schedules will have a `ScheduleStatus` of `Suspended` and the `PauseUntilDate` field will reflect the date entered in your request.

A paused schedule can be manually resumed at any time by calling [Resume Schedule](https://documentation.paysimple.com/reference/resume) , and can also be suspended indefinitely by calling [Suspend](https://documentation.paysimple.com/reference/suspend).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "paysimple-api-40-do-not-delete",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://api.paysimple.com/v4"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/recurringpayment/{ScheduleId}/pause?enddate={EndDate}": {
      "put": {
        "summary": "Pause Schedule",
        "description": "Stop a recurring payment from generating payments until a specified date.",
        "operationId": "pause",
        "parameters": [
          {
            "name": "EndDate",
            "in": "query",
            "description": "Date the schedule will resume. (Date format YYYY-MM-DD)",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"Meta\": {\n        \"Errors\": null,\n        \"HttpStatus\": \"NoContent\",\n        \"HttpStatusCode\": 204,\n        \"PagingDetails\": null\n    },\n    \"Response\": null\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "Meta": {
                      "type": "object",
                      "properties": {
                        "Errors": {},
                        "HttpStatus": {
                          "type": "string",
                          "example": "NoContent"
                        },
                        "HttpStatusCode": {
                          "type": "integer",
                          "example": 204,
                          "default": 0
                        },
                        "PagingDetails": {}
                      }
                    },
                    "Response": {}
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"Meta\": {\n        \"Errors\": {\n            \"ErrorCode\": \"InvalidInput\",\n            \"ErrorMessages\": [\n                {\n                    \"Field\": \"\",\n                    \"Message\": \"Specified schedule does not exist\"\n                }\n            ]\n        },\n        \"HttpStatus\": \"BadRequest\",\n        \"HttpStatusCode\": 400,\n        \"PagingDetails\": null\n    },\n    \"Response\": null\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "Meta": {
                      "type": "object",
                      "properties": {
                        "Errors": {
                          "type": "object",
                          "properties": {
                            "ErrorCode": {
                              "type": "string",
                              "example": "InvalidInput"
                            },
                            "ErrorMessages": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "Field": {
                                    "type": "string",
                                    "example": ""
                                  },
                                  "Message": {
                                    "type": "string",
                                    "example": "Specified schedule does not exist"
                                  }
                                }
                              }
                            }
                          }
                        },
                        "HttpStatus": {
                          "type": "string",
                          "example": "BadRequest"
                        },
                        "HttpStatusCode": {
                          "type": "integer",
                          "example": 400,
                          "default": 0
                        },
                        "PagingDetails": {}
                      }
                    },
                    "Response": {}
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": [],
        "x-readme": {
          "code-samples": [
            {
              "language": "text",
              "code": "PUT /v4/recurringpayment/1433611/pause?enddate=2018-08-01",
              "name": "Sample Request"
            }
          ],
          "samples-languages": [
            "text"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```