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

# List payment credit types

GET https://ssuccessv2.com/app/api/v2/payment/credit-types

Returns the active or inactive credit types configured for the current SchoolSet school.

Reference: https://docs.schoolset.io/api-reference/school-set-api/payment-credit-types/list-payment-credit-types

## Authentication

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

## Request

### Query parameters

- `is_active` (boolean, optional) — Restricts the result to credit types with this active flag.

## Response

### 200

Credit types returned successfully.

- `status` (string, required)
- `message` (string, required)
- `data` (list of ApiV2PaymentCreditTypesGetResponsesContentApplicationJsonSchemaDataItems, required)

## Errors

### 401 Unauthorized Error

Authentication is required.

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

### 403 Forbidden Error

Viewing payment or settings data is not permitted.

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

## Types

### ApiV2PaymentCreditTypesGetResponsesContentApplicationJsonSchemaDataItems

- `id` (integer, optional)
- `name` (string, optional)
- `description` (string, optional, nullable)
- `is_active` (boolean, optional)
- `default_fund_id` (integer, optional, nullable)
- `default_campaign_id` (integer, optional, nullable)
- `created_at` (datetime, optional)
- `updated_at` (datetime, optional)

## Examples

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 7,
      "name": "Tuition credit",
      "description": "Credit applied to tuition fees.",
      "is_active": true,
      "default_fund_id": null,
      "default_campaign_id": null,
      "created_at": {},
      "updated_at": {}
    }
  ]
}
```

**SDK Code**

```python Payment credit types_listPaymentCreditTypes_example
import requests

url = "https://ssuccessv2.com/app/api/v2/payment/credit-types"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Payment credit types_listPaymentCreditTypes_example
const url = 'https://ssuccessv2.com/app/api/v2/payment/credit-types';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

```go Payment credit types_listPaymentCreditTypes_example
package main

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

func main() {

	url := "https://ssuccessv2.com/app/api/v2/payment/credit-types"

	req, _ := http.NewRequest("GET", url, nil)

	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 Payment credit types_listPaymentCreditTypes_example
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v2/payment/credit-types")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java Payment credit types_listPaymentCreditTypes_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://ssuccessv2.com/app/api/v2/payment/credit-types")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://ssuccessv2.com/app/api/v2/payment/credit-types', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp Payment credit types_listPaymentCreditTypes_example
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v2/payment/credit-types");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Payment credit types_listPaymentCreditTypes_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v2/payment/credit-types")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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