> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.schoolset.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server.

# Update a recurring payment plan

POST https://ssuccessv2.com/app/api/v2/payment/update/{payment_recurring_id}/recurring/payment-plan
Content-Type: multipart/form-data

Rebuilds scheduled payments and updates the active recurring plan's type, period, totals, wallets, and dates.

Reference: https://docs.schoolset.io/api-reference/school-set-api/payments/update-payment-plan-recurring-plan-payment

## Authentication

- `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend.

## Request

### Path parameters

- `payment_recurring_id` (integer, required)

### Body (multipart/form-data)

This endpoint expects a multipart form.

- `payment_type_id` (double, required)
- `payment_recurring_period_id` (double, required)
- `contract_fees_type_id` (double, optional)
- `payment_total_amount` (double, required)
- `old_payment_ids` (list of integer, optional)
- `old_payment_amounts` (list of double, optional)
- `old_payment_dates` (list of datetime, optional)
- `old_grace_period` (list of integer, optional)
- `new_payment_amounts` (list of double, optional)
- `new_payment_dates` (list of datetime, optional)
- `new_grace_period` (list of integer, optional)
- `payment_data` (map from string to any, optional)
- `wallet_id` (double, optional)
- `secondary_wallet_id` (double, optional)
- `merchant_account_id` (double, optional)
- `is_credit` (boolean, optional)
- `note` (string, optional)

## Response

### 200

Recurring plan saved.

- `status` (string, optional)
- `message` (string, optional)
- `data` (map from string to any, optional)

## Errors

### 400 Bad Request Error

- `any`

### 401 Unauthorized Error

- `any`

### 403 Forbidden Error

- `any`

### 422 Unprocessable Entity Error

- `any`

## Examples

**Request**

```json
{
  "payment_type_id": 5,
  "payment_recurring_period_id": 2,
  "payment_total_amount": 5000
}
```

**Response**

```json
{
  "status": "success",
  "message": "Saved",
  "data": {}
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v2/payment/update/99/recurring/payment-plan"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type_id\"\r\n\r\n5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_recurring_period_id\"\r\n\r\n2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract_fees_type_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_total_amount\"\r\n\r\n5000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_ids\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_amounts\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_dates\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_grace_period\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_payment_amounts\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_payment_dates\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_grace_period\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_data\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"wallet_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"secondary_wallet_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"merchant_account_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_credit\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"note\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "multipart/form-data; boundary=---011000010111000001101001"
}

response = requests.post(url, data=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v2/payment/update/99/recurring/payment-plan';
const form = new FormData();
form.append('payment_type_id', '5');
form.append('payment_recurring_period_id', '2');
form.append('contract_fees_type_id', '');
form.append('payment_total_amount', '5000');
form.append('old_payment_ids', '');
form.append('old_payment_amounts', '');
form.append('old_payment_dates', '');
form.append('old_grace_period', '');
form.append('new_payment_amounts', '');
form.append('new_payment_dates', '');
form.append('new_grace_period', '');
form.append('payment_data', '');
form.append('wallet_id', '');
form.append('secondary_wallet_id', '');
form.append('merchant_account_id', '');
form.append('is_credit', '');
form.append('note', '');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v2/payment/update/99/recurring/payment-plan"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type_id\"\r\n\r\n5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_recurring_period_id\"\r\n\r\n2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract_fees_type_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_total_amount\"\r\n\r\n5000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_ids\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_amounts\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_dates\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_grace_period\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_payment_amounts\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_payment_dates\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_grace_period\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_data\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"wallet_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"secondary_wallet_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"merchant_account_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_credit\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"note\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v2/payment/update/99/recurring/payment-plan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type_id\"\r\n\r\n5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_recurring_period_id\"\r\n\r\n2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract_fees_type_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_total_amount\"\r\n\r\n5000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_ids\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_amounts\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_dates\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_grace_period\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_payment_amounts\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_payment_dates\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_grace_period\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_data\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"wallet_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"secondary_wallet_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"merchant_account_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_credit\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"note\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://ssuccessv2.com/app/api/v2/payment/update/99/recurring/payment-plan")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type_id\"\r\n\r\n5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_recurring_period_id\"\r\n\r\n2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract_fees_type_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_total_amount\"\r\n\r\n5000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_ids\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_amounts\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_dates\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_grace_period\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_payment_amounts\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_payment_dates\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_grace_period\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_data\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"wallet_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"secondary_wallet_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"merchant_account_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_credit\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"note\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v2/payment/update/99/recurring/payment-plan', [
  'multipart' => [
    [
        'name' => 'payment_type_id',
        'contents' => '5'
    ],
    [
        'name' => 'payment_recurring_period_id',
        'contents' => '2'
    ],
    [
        'name' => 'payment_total_amount',
        'contents' => '5000'
    ]
  ]
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v2/payment/update/99/recurring/payment-plan");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type_id\"\r\n\r\n5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_recurring_period_id\"\r\n\r\n2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract_fees_type_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_total_amount\"\r\n\r\n5000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_ids\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_amounts\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_payment_dates\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"old_grace_period\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_payment_amounts\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_payment_dates\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"new_grace_period\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_data\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"wallet_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"secondary_wallet_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"merchant_account_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_credit\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"note\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]
let parameters = [
  [
    "name": "payment_type_id",
    "value": "5"
  ],
  [
    "name": "payment_recurring_period_id",
    "value": "2"
  ],
  [
    "name": "contract_fees_type_id",
    "value": 
  ],
  [
    "name": "payment_total_amount",
    "value": "5000"
  ],
  [
    "name": "old_payment_ids",
    "value": 
  ],
  [
    "name": "old_payment_amounts",
    "value": 
  ],
  [
    "name": "old_payment_dates",
    "value": 
  ],
  [
    "name": "old_grace_period",
    "value": 
  ],
  [
    "name": "new_payment_amounts",
    "value": 
  ],
  [
    "name": "new_payment_dates",
    "value": 
  ],
  [
    "name": "new_grace_period",
    "value": 
  ],
  [
    "name": "payment_data",
    "value": 
  ],
  [
    "name": "wallet_id",
    "value": 
  ],
  [
    "name": "secondary_wallet_id",
    "value": 
  ],
  [
    "name": "merchant_account_id",
    "value": 
  ],
  [
    "name": "is_credit",
    "value": 
  ],
  [
    "name": "note",
    "value": 
  ]
]

let boundary = "---011000010111000001101001"

var body = ""
var error: NSError? = nil
for param in parameters {
  let paramName = param["name"]!
  body += "--\(boundary)\r\n"
  body += "Content-Disposition:form-data; name=\"\(paramName)\""
  if let filename = param["fileName"] {
    let contentType = param["content-type"]!
    let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
    if (error != nil) {
      print(error as Any)
    }
    body += "; filename=\"\(filename)\"\r\n"
    body += "Content-Type: \(contentType)\r\n\r\n"
    body += fileContent
  } else if let paramValue = param["value"] {
    body += "\r\n\r\n\(paramValue)"
  }
}

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v2/payment/update/99/recurring/payment-plan")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```