---
updatedAt: 2025-06-05T12:50:44.000Z
agentTools:
  projectIndex: https://docs.payplus.co.il/llms.txt
---

# Valid

This endpoint sets the validity of a recurring payment.
If the recurring payment isn't valid, it will not be charged.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "PayPlus - API Documentation - Production",
    "version": "1.0"
  },
  "tags": [
    {
      "name": "Recurring Payments"
    }
  ],
  "servers": [
    {
      "url": "https://restapi.payplus.co.il/api/v1.0/",
      "description": "Production"
    },
    {
      "url": "https://restapidev.payplus.co.il/api/v1.0/",
      "description": "Staging"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/RecurringPayments/{uid}/Valid": {
      "post": {
        "tags": [
          "Recurring Payments"
        ],
        "summary": "Valid",
        "description": "This endpoint sets the validity of a recurring payment.\nIf the recurring payment isn't valid, it will not be charged.",
        "parameters": [
          {
            "name": "uid",
            "in": "path",
            "description": "Recurring Payment unique identifier",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "api-key",
            "in": "header",
            "description": "API Key",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "secret-key",
            "in": "header",
            "description": "Secret Key",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "terminal_uid",
                  "valid"
                ],
                "properties": {
                  "terminal_uid": {
                    "type": "string",
                    "description": "Terminal unique identifier"
                  },
                  "valid": {
                    "type": "boolean",
                    "description": "Set if the recurring payment is active or not.",
                    "default": true
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\"result\": {\n\"status\": \"success\",\n\"code\": 0,\n\"description\": \"operation has been success\"\n},\n\"data\": {\n\"recurring_payment_uid\": \"d70334d6-62c4-4a6a-a9e3-b49e3495a451\",\n}\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```