subscriptions

GET

/api/v3/subscriptions

Last modified:2026-02-12 10:55:41

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://prod.your-api-server.com/api/v3/subscriptions?pagesize=1&page=3' \
--header 'Authorization: Basic <encoded-value>'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "data": {
        "classes": [
            {
                "id": 13733,
                "studentid": 14780,
                "classid": 64422,
                "subscription": "2024-01-11",
                "subjectid": 702,
                "norenewal": null,
                "unsuscribed": 0,
                "creditexpired": null,
                "cancellation": null,
                "monthrate": null,
                "comments": null,
                "pending": 0,
                "credit": null,
                "refund": 0,
                "fullpaid": 0,
                "packageid": null,
                "permissions": null,
                "nomaterial": 0,
                "order": null,
                "replacedsubscriptionid": null,
                "allowedmove": null,
                "passed": null,
                "remainingmove": 0,
                "autorenew": 0,
                "certificateid": null,
                "lessonspacketid": null,
                "customercompanyid": null,
                "isextraactivity": 0,
                "frequencytype": "hybrid",
                "absencealert": 0,
                "absencealertdate": null,
                "externalbookingid": null,
                "cancellationcredits": 0,
                "hideattachments": 0,
                "createdat": null,
                "updatedat": null
            }
        ],
        "studyplans": [
            {
                "id": 1,
                "retired": null,
                "transferredto": null,
                "subscriptiondate": "2025-07-31",
                "studyplan": "Pianerottolo",
                "studyplanid": 1,
                "studyplancode": "PNTRL",
                "teachingyear": "A.A. 2024/2025",
                "teachingyearid": 16,
                "studyplaninstancename": "Pianerottolo",
                "studyplaninstanceid": 1,
                "studyplanyear": 1,
                "subjects": []
            }
        ],
        "exams": [
            {
                "id": 14,
                "examid": 4,
                "name": "Esame di lingua Inglese",
                "description": null,
                "examdate": "2025-05-30",
                "examtime": "12:00:00",
                "createdat": "2025-05-15T08:21:16.000000Z",
                "subjectname": "Inglese",
                "subjectcode": null
            }
        ]
    }
}

Modified at 2026-02-12 10:55:41

Get a teacher payment by id

Generic key value parameters