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

# Send a payment link

POST https://ssuccessv2.com/app/api/v1/family/pay/create/payment/pay
Content-Type: application/json

Sends a payment-link notification for a contract, selected contract fees, or a fundraising donor's pledges. A contract payment link requires `contract_id`; a pledge link requires both `pledge_ids` and a donor identifier.

Reference: https://docs.schoolset.io/api-reference/school-set-api/family-payments/create-family-payment-link

## Authentication

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

## Request

### Body (application/json)

This endpoint expects an object.

- `email` (string, required)
- `contract_id` (integer, optional, nullable)
- `to_parent_student_id` (integer, optional, nullable)
- `include_previous_years_balance` (boolean, optional, nullable)
- `previous_years_balance_type` (enum, optional, nullable)
  - Allowed values: `due_amount`, `full_amount`
- `user_message` (string, optional, nullable)
- `contract_fee_ids` (list of integer, optional, nullable)
- `pledge_ids` (list of integer, optional, nullable)
- `fundraising_donor_id` (integer, optional, nullable)
- `donor_id` (integer, optional, nullable)

## Response

### 200

Payment-link notification created and queued.

- `status` (string, optional)
- `message` (string, optional)
- `data` (list of any, optional)

## Errors

### 401 Unauthorized Error

Authentication required.

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

### 403 Forbidden Error

The user lacks permission to create payment links.

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

Validation failed or a selected fee/pledge does not belong to the contract/donor.

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

## Examples

**Request**

```json
{
  "email": "rachel.cohen@example.com",
  "contract_id": 9017,
  "to_parent_student_id": 734,
  "include_previous_years_balance": true,
  "previous_years_balance_type": "due_amount",
  "user_message": "Please review the remaining tuition balance.",
  "contract_fee_ids": [
    4201,
    4202
  ]
}
```

**Response**

```json
{
  "status": "success",
  "message": "Notification created.",
  "data": []
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v1/family/pay/create/payment/pay"

payload = {
    "email": "rachel.cohen@example.com",
    "contract_id": 9017,
    "to_parent_student_id": 734,
    "include_previous_years_balance": True,
    "previous_years_balance_type": "due_amount",
    "user_message": "Please review the remaining tuition balance.",
    "contract_fee_ids": [4201, 4202]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v1/family/pay/create/payment/pay';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"email":"rachel.cohen@example.com","contract_id":9017,"to_parent_student_id":734,"include_previous_years_balance":true,"previous_years_balance_type":"due_amount","user_message":"Please review the remaining tuition balance.","contract_fee_ids":[4201,4202]}'
};

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/v1/family/pay/create/payment/pay"

	payload := strings.NewReader("{\n  \"email\": \"rachel.cohen@example.com\",\n  \"contract_id\": 9017,\n  \"to_parent_student_id\": 734,\n  \"include_previous_years_balance\": true,\n  \"previous_years_balance_type\": \"due_amount\",\n  \"user_message\": \"Please review the remaining tuition balance.\",\n  \"contract_fee_ids\": [\n    4201,\n    4202\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/v1/family/pay/create/payment/pay")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"rachel.cohen@example.com\",\n  \"contract_id\": 9017,\n  \"to_parent_student_id\": 734,\n  \"include_previous_years_balance\": true,\n  \"previous_years_balance_type\": \"due_amount\",\n  \"user_message\": \"Please review the remaining tuition balance.\",\n  \"contract_fee_ids\": [\n    4201,\n    4202\n  ]\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/v1/family/pay/create/payment/pay")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"rachel.cohen@example.com\",\n  \"contract_id\": 9017,\n  \"to_parent_student_id\": 734,\n  \"include_previous_years_balance\": true,\n  \"previous_years_balance_type\": \"due_amount\",\n  \"user_message\": \"Please review the remaining tuition balance.\",\n  \"contract_fee_ids\": [\n    4201,\n    4202\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/family/pay/create/payment/pay', [
  'body' => '{
  "email": "rachel.cohen@example.com",
  "contract_id": 9017,
  "to_parent_student_id": 734,
  "include_previous_years_balance": true,
  "previous_years_balance_type": "due_amount",
  "user_message": "Please review the remaining tuition balance.",
  "contract_fee_ids": [
    4201,
    4202
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/family/pay/create/payment/pay");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"email\": \"rachel.cohen@example.com\",\n  \"contract_id\": 9017,\n  \"to_parent_student_id\": 734,\n  \"include_previous_years_balance\": true,\n  \"previous_years_balance_type\": \"due_amount\",\n  \"user_message\": \"Please review the remaining tuition balance.\",\n  \"contract_fee_ids\": [\n    4201,\n    4202\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "email": "rachel.cohen@example.com",
  "contract_id": 9017,
  "to_parent_student_id": 734,
  "include_previous_years_balance": true,
  "previous_years_balance_type": "due_amount",
  "user_message": "Please review the remaining tuition balance.",
  "contract_fee_ids": [4201, 4202]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/family/pay/create/payment/pay")! 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()
```