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

# Export recurring payment plans

POST https://ssuccessv2.com/app/api/v1/fundraising/campaign/{id}/recurring/payment-plans/export
Content-Type: application/json

Applies the same page filters and sorting as the recurring-plan table and downloads the matching rows as an XLSX file. If no rows match, the backend returns a 422 JSON error instead of a file.

Reference: https://docs.schoolset.io/api-reference/school-set-api/fundraising/export-fundraising-recurring-payment-plans

## Authentication

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

## Request

### Path parameters

- `id` (integer, required)

### Body (application/json)

This endpoint expects a map from string to any.

- `map from string to any`

## Response

### 200

XLSX export.

- File download.

## Errors

### 401 Unauthorized Error

Unauthenticated

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

### 403 Forbidden Error

User lacks view-donation permission

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

### 404 Not Found Error

Campaign does not exist only if enforced by page query

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

### 422 Unprocessable Entity Error

No matching plans or invalid request fields

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

## Examples

**Request**

```json
{
  "filter": {
    "status": [
      "Active"
    ],
    "frequency": [
      "Monthly"
    ]
  },
  "sort": "-start_date"
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v1/fundraising/campaign/17/recurring/payment-plans/export"

payload = {
    "filter": {
        "status": ["Active"],
        "frequency": ["Monthly"]
    },
    "sort": "-start_date"
}
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/fundraising/campaign/17/recurring/payment-plans/export';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"filter":{"status":["Active"],"frequency":["Monthly"]},"sort":"-start_date"}'
};

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/fundraising/campaign/17/recurring/payment-plans/export"

	payload := strings.NewReader("{\n  \"filter\": {\n    \"status\": [\n      \"Active\"\n    ],\n    \"frequency\": [\n      \"Monthly\"\n    ]\n  },\n  \"sort\": \"-start_date\"\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/fundraising/campaign/17/recurring/payment-plans/export")

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  \"filter\": {\n    \"status\": [\n      \"Active\"\n    ],\n    \"frequency\": [\n      \"Monthly\"\n    ]\n  },\n  \"sort\": \"-start_date\"\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/fundraising/campaign/17/recurring/payment-plans/export")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filter\": {\n    \"status\": [\n      \"Active\"\n    ],\n    \"frequency\": [\n      \"Monthly\"\n    ]\n  },\n  \"sort\": \"-start_date\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/fundraising/campaign/17/recurring/payment-plans/export', [
  'body' => '{
  "filter": {
    "status": [
      "Active"
    ],
    "frequency": [
      "Monthly"
    ]
  },
  "sort": "-start_date"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/fundraising/campaign/17/recurring/payment-plans/export");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"filter\": {\n    \"status\": [\n      \"Active\"\n    ],\n    \"frequency\": [\n      \"Monthly\"\n    ]\n  },\n  \"sort\": \"-start_date\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "filter": [
    "status": ["Active"],
    "frequency": ["Monthly"]
  ],
  "sort": "-start_date"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/fundraising/campaign/17/recurring/payment-plans/export")! 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()
```