1. classes
ScuolaSemplice Web API
  • v2
    • Payments
      • registerInstallmentPayment
    • Orders
      • fetchUserOrders
    • Aggregator
      • Update timetable
      • Booking lesson
      • Cancel booking
      • Set attendances
    • Custom fields
      • Read all custom fields
      • Fetch ustom field
    • Workflows
      • Returns list of all workflows
      • Start a new workflow instance
    • StudyPlans
      • Returns list of all study plans
    • Subscriptions
      • fetchSubscriptions
      • Subscribe a student to a class
      • Alter subscriprion of a student to a class
    • Classes
      • Retuns list of class models
      • Creates a class model / catalogue
      • Updates a class model / catalogue
      • Creates a class from a model
      • Reads all list of classes from archive
      • Reads all classes added or updated after timestamp
    • Students
      • Reads paginated list of students
      • Fetch student
      • Creates new student and return the id
      • Updates an existing student and return the id
      • Reads all list of students from archive
      • Reads all students added or updated after timestamp
    • Catalogues
      • Returns list of system branches
      • Returns list of classes custom fields
      • Returns list of all locations
  • v3
    • Classes
      • classes
      • classes/{id}
    • Exams
      • exams
      • exams/{id}
    • Lessons
      • lessons
      • lessons/{id}
    • Orders
      • orders
      • orders/{id}
      • Order creation
    • PackageOffers
      • packageoffers
      • packageoffers/{id}
    • ProfileCustomSelectValues
      • profilecustomselectvalues
    • Payments
      • payments
      • payments/{id}
    • QrReadings
      • qrreadings
      • qrreadings/{id}
      • qrreadings
    • Students
      • students
      • students/{id}
      • create
      • update
      • update by externid
      • create student comment
    • Teachers
      • teachers/{id}
      • teachers
      • create
      • update
      • update by externid
    • CustomerCompanies
      • customercompanies
      • customercompanies/{id}
    • Subscriptions
      • classes
        • subscriptions/classes
          GET
        • subscriptions/classes/{id}
          GET
        • create subscription class
          POST
      • exams
        • subscriptions/exams
        • subscriptions/exams/{id}
        • create subscription exam
      • studyplans
        • subscriptions/studyplans
        • subscriptions/studyplans/{id}
    • Tutors
      • tutors
      • tutors/{id}
    • Transactions
      • Create
      • Delete
    • TeacherPayments
      • List teacher payments
      • Get a teacher payment by id
    • subscriptions
      GET
  • Schemas
    • Schemas
      • Generic key value parameters
      • Generic parameters array
      • CustomFieldValue
      • user
      • inline_response_200
      • parameters_1
      • parameters_2
      • parameters_3
      • inline_response_200_1
      • parameters_4
      • parameters_5
      • parameters_6
    • Aggregator
      • Lesson
      • Course timetable
      • Attendance
    • ErrorBadRequest
    • StudyPlan
    • TeacherPaymentLine
    • TeacherPayment
    • PaginationLinks
    • PaginationMeta
    • TeacherPaymentCollection
  1. classes

subscriptions/classes/{id}

GET
/api/v3/subscriptions/classes/{id}
Last modified:2026-01-23 09:39:36

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 *****************
or
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://prod.your-api-server.com/api/v3/subscriptions/classes/13733' \
--header 'Authorization: Basic <encoded-value>'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
{
    "data": {
        "id": 13733,
        "studentid": 14780,
        "classid": 64422,
        "subscription": "2024-01-11",
        "subjectid": null,
        "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,
        "class": {
            "id": 64422,
            "className": "MST Cinese - 2024",
            "code": "4",
            "classTeacher": 14792,
            "subjectid": 702,
            "startDate": "2024-01-11",
            "endDate": null,
            "duration": 120,
            "one2one": 0
        },
        "student": {
            "id": 14780,
            "username": null,
            "email": "nicolev@mail.com",
            "adminemail": null,
            "ssoemail": null,
            "name": "Nicole",
            "surname": "Verdi",
            "alias": null,
            "fullName": "Verdi Nicole",
            "taxcode": "VRDNCL98X01O159L",
            "taxcodevalid": 0,
            "vatnumber": null,
            "vatcodevalid": 0,
            "passport": null,
            "role": "student",
            "studentRollId": null,
            "birthday": 0,
            "gender": "",
            "address": "Corso Garibaldi 22",
            "cap": "115566",
            "city": "Provia",
            "province": "PR",
            "mobileNo": "+3965898524965146541",
            "phoneNo": "",
            "isLeaderBoard": null,
            "defLang": 0,
            "appinvite": null,
            "appconnected": 0,
            "billingmethod": "none",
            "adminteacher": null,
            "admintype": 0,
            "subscriptionyear": "A.A. 2023/2024",
            "subscription": null,
            "shownclassrooms": null,
            "privacyok": 1,
            "CV": null,
            "teacheronline": 1,
            "datebirth": "1998-02-01",
            "age": 27,
            "pec": null,
            "profession": null,
            "maritalstatus": null,
            "qualification": null,
            "notes": null,
            "webregistration": 0,
            "pensioner": 0,
            "netaccessid": null,
            "tokenaccessid": null,
            "roleid": 0,
            "birthplace": null,
            "birthprovince": null,
            "supportchat": 0,
            "rate": null,
            "classrate": null,
            "lastversion": null,
            "gcal": 0,
            "lastnotify": null,
            "disableupdate": 0,
            "companyid": null,
            "externid": null,
            "haslocations": null,
            "studlocation": -1,
            "disabled": 0,
            "country": "IT",
            "invoicedataid": null,
            "passportinvoice": 0,
            "differentinvoicedata": null,
            "color": null,
            "hideincalendar": 0,
            "locksession": null,
            "teacherlessons": 0,
            "customercompanyid": null,
            "enableweb": 1,
            "disablelogin": 0,
            "lastwebaccess": "2024-03-19T15:29:36.000000Z",
            "leadstatus": null,
            "assignedto": 0,
            "updatedat": "2025-04-01T14:21:19.000000Z",
            "createdat": "2021-04-07T06:55:27.000000Z",
            "iban": null,
            "bic": null,
            "codicedestinatario": null,
            "branchid": null,
            "branchadmin": 0,
            "hasiol": 0,
            "hasmoodle": 0,
            "sharecontacts": 0,
            "priorityclass": null,
            "systemnewsletter": null,
            "limiteddidactic": 0,
            "hidestudentpay": 0,
            "nopersonalcalendar": 0,
            "expectedvalue": null,
            "expectedclose": null,
            "citizenship": "IT",
            "externuuid": null,
            "virtualibanid": null,
            "acquisition": null,
            "birthcountry": "",
            "gasecret": null,
            "isexamstaff": 0,
            "campdirector": 0
        }
    }
}
Modified at 2026-01-23 09:39:36
Previous
subscriptions/classes
Next
create subscription class
Built with