Admin - Schools

Create School Contract

Changed on
post/admin/schools/{school_id}/contracts

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/admin/schools/{school_id}/contracts
  • Auth: OAuth 2 (password, token URL api/login)

Path parameters

school_idstring required

The ID of the school

Request body

contract_type'pilot' | 'paid' required
start_datestring date-time required
end_datestring date-time nullable
billed_studentsinteger nullable
expected_teachers_countinteger nullable
price_per_student_monthly_eurnumber nullable
free_monthsnumber nullable
launch_guaranteeboolean nullable
launch_guarantee_end_datestring date-time nullable
owner_admin_idstring nullable
referent_namestring nullable
referent_emailstring nullable
referent_rolestring nullable
signed_document_datestring date-time nullable
signed_document_urlstring nullable
pennylane_urlstring nullable
notesstring nullable
levelsstring[]
billing_rhythm'quarterly' | 'annual'

Response

Successful Response

idstring required
school_idstring required
contract_type'pilot' | 'paid' required
start_datestring date-time required
end_datestring date-time nullable
billed_studentsinteger nullable
expected_teachers_countinteger nullable
price_per_student_monthly_eurnumber nullable
free_monthsnumber nullable
launch_guaranteeboolean
launch_guarantee_end_datestring date-time nullable
owner_admin_idstring nullable
owner_namestring nullable
referent_namestring nullable
referent_emailstring nullable
referent_rolestring nullable
signed_document_datestring date-time nullable
signed_document_urlstring nullable
pennylane_urlstring nullable
notesstring nullable
created_atstring date-time required
updated_atstring date-time required
status'active' | 'upcoming' | 'ended' required
levelsstring[]
billing_rhythm'quarterly' | 'annual'

Changes

  • 271be6884523Revision changes
    • breaking

      request property list-of-types was narrowed by removing types integer from media type application/json

    • breaking

      response property free_months list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      the / response's property type changed from integer to number for status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the / request property type was generalized from integer to number

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 59dba414f8aeRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status