> 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.

# Create a recurring payment plan

POST https://ssuccessv2.com/app/api/v2/payment/create/recurring/payment-plan
Content-Type: multipart/form-data

Creates a SchoolSet recurring payment plan from aligned payment dates, amounts, grace periods, and the selected contract payment method.

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

## Authentication

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

## Request

### Body (multipart/form-data)

This endpoint expects a multipart form.

- `contract_id` (integer, required)
- `payment_type_id` (integer, required)
- `payment_recurring_period_id` (integer, required)
- `payment_total_amount` (double, required)
- `payment_amounts` (list of double, required)
- `payment_dates` (list of datetime, required)
- `grace_period` (list of integer, required)
- `payment_data` (map from string to any, optional)
- `wallet_id` (integer, optional)
- `secondary_wallet_id` (integer, optional)
- `merchant_account_id` (integer, optional)
- `fees_priority` (list of integer, optional)
- `note` (string, optional)

## Response

### 200

Recurring plan created

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

## Errors

### 400 Bad Request Error

Dates

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 401 Unauthorized Error

Authentication is required

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 403 Forbidden Error

SchoolSet create-payments permission was denied

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 404 Not Found Error

Contract

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 422 Unprocessable Entity Error

Recurring plan validation failed

- `message` (string, required)
- `errors` (map from string to list of string, required)

## Examples

**Request**

```json
{
  "contract_id": 1204,
  "payment_type_id": 10,
  "payment_recurring_period_id": 1,
  "payment_total_amount": 4250,
  "payment_amounts": [
    425,
    425,
    425,
    425,
    425,
    425,
    425,
    425,
    425,
    425
  ],
  "payment_dates": [
    "2024-01-15T09:30:00Z",
    "2024-01-15T09:30:00Z"
  ],
  "grace_period": [
    0,
    0
  ]
}
```

**Response**

```json
{
  "status": "success",
  "message": "Payment plan saved",
  "data": {}
}
```

**SDK Code**

```python
import requests

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

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract_id\"\r\n\r\n1204\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type_id\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_recurring_period_id\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_total_amount\"\r\n\r\n4250\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_amounts\"\r\n\r\n[\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_dates\"\r\n\r\n[\n  \"2024-01-15T09:30:00Z\",\n  \"2024-01-15T09:30:00Z\"\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grace_period\"\r\n\r\n[\n  0,\n  0\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=\"fees_priority\"\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/create/recurring/payment-plan';
const form = new FormData();
form.append('contract_id', '1204');
form.append('payment_type_id', '10');
form.append('payment_recurring_period_id', '1');
form.append('payment_total_amount', '4250');
form.append('payment_amounts', '[
  425,
  425,
  425,
  425,
  425,
  425,
  425,
  425,
  425,
  425
]');
form.append('payment_dates', '[
  "2024-01-15T09:30:00Z",
  "2024-01-15T09:30:00Z"
]');
form.append('grace_period', '[
  0,
  0
]');
form.append('payment_data', '');
form.append('wallet_id', '');
form.append('secondary_wallet_id', '');
form.append('merchant_account_id', '');
form.append('fees_priority', '');
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/create/recurring/payment-plan"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract_id\"\r\n\r\n1204\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type_id\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_recurring_period_id\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_total_amount\"\r\n\r\n4250\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_amounts\"\r\n\r\n[\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_dates\"\r\n\r\n[\n  \"2024-01-15T09:30:00Z\",\n  \"2024-01-15T09:30:00Z\"\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grace_period\"\r\n\r\n[\n  0,\n  0\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=\"fees_priority\"\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/create/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=\"contract_id\"\r\n\r\n1204\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type_id\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_recurring_period_id\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_total_amount\"\r\n\r\n4250\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_amounts\"\r\n\r\n[\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_dates\"\r\n\r\n[\n  \"2024-01-15T09:30:00Z\",\n  \"2024-01-15T09:30:00Z\"\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grace_period\"\r\n\r\n[\n  0,\n  0\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=\"fees_priority\"\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/create/recurring/payment-plan")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract_id\"\r\n\r\n1204\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type_id\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_recurring_period_id\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_total_amount\"\r\n\r\n4250\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_amounts\"\r\n\r\n[\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_dates\"\r\n\r\n[\n  \"2024-01-15T09:30:00Z\",\n  \"2024-01-15T09:30:00Z\"\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grace_period\"\r\n\r\n[\n  0,\n  0\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=\"fees_priority\"\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/create/recurring/payment-plan', [
  'multipart' => [
    [
        'name' => 'contract_id',
        'contents' => '1204'
    ],
    [
        'name' => 'payment_type_id',
        'contents' => '10'
    ],
    [
        'name' => 'payment_recurring_period_id',
        'contents' => '1'
    ],
    [
        'name' => 'payment_total_amount',
        'contents' => '4250'
    ],
    [
        'name' => 'payment_amounts',
        'contents' => '[
  425,
  425,
  425,
  425,
  425,
  425,
  425,
  425,
  425,
  425
]'
    ],
    [
        'name' => 'payment_dates',
        'contents' => '[
  "2024-01-15T09:30:00Z",
  "2024-01-15T09:30:00Z"
]'
    ],
    [
        'name' => 'grace_period',
        'contents' => '[
  0,
  0
]'
    ]
  ]
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v2/payment/create/recurring/payment-plan");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract_id\"\r\n\r\n1204\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type_id\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_recurring_period_id\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_total_amount\"\r\n\r\n4250\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_amounts\"\r\n\r\n[\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425,\n  425\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_dates\"\r\n\r\n[\n  \"2024-01-15T09:30:00Z\",\n  \"2024-01-15T09:30:00Z\"\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grace_period\"\r\n\r\n[\n  0,\n  0\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=\"fees_priority\"\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": "contract_id",
    "value": "1204"
  ],
  [
    "name": "payment_type_id",
    "value": "10"
  ],
  [
    "name": "payment_recurring_period_id",
    "value": "1"
  ],
  [
    "name": "payment_total_amount",
    "value": "4250"
  ],
  [
    "name": "payment_amounts",
    "value": "[
  425,
  425,
  425,
  425,
  425,
  425,
  425,
  425,
  425,
  425
]"
  ],
  [
    "name": "payment_dates",
    "value": "[
  \"2024-01-15T09:30:00Z\",
  \"2024-01-15T09:30:00Z\"
]"
  ],
  [
    "name": "grace_period",
    "value": "[
  0,
  0
]"
  ],
  [
    "name": "payment_data",
    "value": 
  ],
  [
    "name": "wallet_id",
    "value": 
  ],
  [
    "name": "secondary_wallet_id",
    "value": 
  ],
  [
    "name": "merchant_account_id",
    "value": 
  ],
  [
    "name": "fees_priority",
    "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/create/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()
```