> ## Documentation Index
> Fetch the complete documentation index at: https://developers.primulamanagement.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a sibling discount entry

> The student UUID identifies the entry. Requires schools assigned to the session. Collection filters do not apply. A student outside the session schools returns 403; no applicable entry returns 404.



## OpenAPI

````yaml /openapi.yaml get /sibling_discounts/{student_id}
openapi: 3.1.0
info:
  title: Primula Tracker API V3
  version: 3.0.0
  description: >-
    Reference for the 66 operations registered under `/primula/api/v3` in the V3
    release baseline.


    ## Authentication

    Create a session with `POST /sessions`, then send `Authorization: Bearer
    <access_token>` on protected operations. Tokens must remain associated with
    a valid server-side session. The returned refresh token has no refresh
    endpoint in V3. Session company and school restrictions are documented per
    operation; company_id is not inferred from the token.


    ## Responses and errors

    Collections generally return bare JSON arrays and items return bare JSON
    objects. Report objects, nested maps, and update summaries are explicitly
    described below. List metadata travels in response headers rather than an
    envelope. Empty lists written by collection helpers are `[]`; fields backed
    by nullable values may be `null`, and omitted properties are distinguished
    from null properties in schemas. Handlers generally return `{ "error":
    "message" }`; authentication middleware and activity proxy errors use plain
    text. Unsupported methods on a registered path return 405 with Allow after
    any applicable authentication checks.


    ## Pagination and projections

    Only operations documenting page/per_page support pagination. Defaults are
    page=1 and per_page=100. Values exceeding the documented effective cap are
    clamped, not rejected. X-Total-Count describes the full matching set. Link
    contains applicable navigation links and is omitted for a single page.
    Aggregates use limit (default 50, effective cap 200) instead of pagination
    and send X-Truncated only when rows were omitted. The fields parameter,
    where available, selects the exact response properties; unsupported fields
    return 400.


    ## Query encoding

    Multi-value parameters documented as arrays accept repeated keys or
    comma-separated values. Prefer repeated keys for long UUID lists. Except for
    the two activity proxy operations, query parsing drops the entire query
    string above 8192 bytes and truncates each decoded query value to 128 bytes.
    Parameter combinations and interpretation differ by resource and
    representation; consult each operation. Unknown parameters are rejected only
    where explicitly documented.


    ## Dates and writes

    Calendar dates use YYYY-MM-DD, monthly periods use YYYY-MM, and timestamp
    formats are described in the corresponding schema. Defaults such as today
    depend on the server clock. PATCH operations change only the documented
    properties and reject unknown body properties. Clearing values,
    authorization, and partial-write behavior vary by resource and are described
    per operation.


    Examples use synthetic identifiers and placeholder tokens. Replace the
    server host before using an interactive API client.
servers:
  - url: https://{host}/primula/api/v3
    description: V3 API deployment. Replace the placeholder hostname.
    variables:
      host:
        default: api.example.com
security:
  - bearerAuth: []
tags:
  - name: sessions
    description: Sessions.
  - name: schools
    description: Schools.
  - name: companies
    description: Companies.
  - name: rooms
    description: Rooms.
  - name: users
    description: Users.
  - name: gusto_companies
    description: Gusto companies.
  - name: gusto_employees
    description: Gusto employees.
  - name: gusto_contractors
    description: Gusto contractors.
  - name: gusto_payrolls
    description: Gusto payrolls.
  - name: procare_staff
    description: Procare staff.
  - name: efficiency_ratios
    description: Efficiency ratios.
  - name: enrollment_tracker
    description: Enrollment tracker.
  - name: classroom_attendance
    description: Classroom attendance.
  - name: absences
    description: Absences.
  - name: billing_attendance_audits
    description: Billing attendance audits.
  - name: data_refresh
    description: Data refresh.
  - name: waitlist
    description: Waitlist.
  - name: sibling_discounts
    description: Sibling discounts.
  - name: new_start_tracker
    description: New start tracker.
  - name: withdrawal_tracker
    description: Withdrawal tracker.
  - name: transition_tracker
    description: Transition tracker.
  - name: enrollments
    description: Enrollments.
  - name: pre_registration_fallout
    description: Pre registration fallout.
  - name: procare_messages
    description: Procare messages.
  - name: activities_summary
    description: Activities summary.
  - name: activity_details
    description: Activity details.
  - name: leads
    description: Leads.
  - name: students
    description: Students.
  - name: payments
    description: Payments.
  - name: family_balances
    description: Family balances.
  - name: attendances
    description: Attendances.
  - name: billing_plans
    description: Billing plans.
  - name: spaces
    description: Spaces.
paths:
  /sibling_discounts/{student_id}:
    get:
      tags:
        - sibling_discounts
      summary: Get a sibling discount entry
      description: >-
        The student UUID identifies the entry. Requires schools assigned to the
        session. Collection filters do not apply. A student outside the session
        schools returns 403; no applicable entry returns 404.
      operationId: GetSiblingDiscountsStudentIdV3
      parameters:
        - name: student_id
          in: path
          required: true
          description: UUID identifying this student.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/CompanyId'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiblingDiscount'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '500':
          $ref: '#/components/responses/500'
components:
  parameters:
    CompanyId:
      name: company_id
      in: query
      required: true
      description: >-
        Company UUID. Must equal the authenticated session company when that
        session has a company assigned; the equality check is skipped for
        sessions without one.
      schema:
        type: string
        format: uuid
      example: 11111111-1111-4111-8111-111111111111
  schemas:
    SiblingDiscount:
      type: object
      properties:
        school_id:
          type: string
          description: School id.
        school_name:
          type: string
        student_id:
          type: string
          description: Student id.
        student_first_name:
          type: string
        student_last_name:
          type: string
        student_name:
          type: string
        family_id:
          type: string
          description: Family id.
        status:
          type: string
        dob:
          type: string
        start_date:
          type: string
        withdrawal_date:
          type: string
        graduation_date:
          type: string
        room:
          type: string
        room_id:
          type: string
          description: Room id.
        ems_student_status:
          type: string
        program:
          type: string
        tuition_plan:
          type: string
        billing_cycle:
          type: string
        tuition_amount:
          type: number
          format: double
        net_invoice:
          type: number
          format: double
        plan_status:
          type: string
        sibling_discount:
          type: string
        sibling_discount_amount:
          type: number
          format: double
        sibling_discount_pct:
          type: string
        days_to_start_date:
          type: integer
          format: int64
        parent1_name:
          type: string
        siblings:
          type: string
        twins:
          type: string
        sibling_order:
          type: integer
        sibling_twin:
          type: string
        active_siblings_in_family:
          type: integer
        staff_child:
          type: string
        school_color_hex:
          type: string
        school_short_name:
          type: string
        has_birth_date_alert:
          type: boolean
        has_sibling_discount_pct_alert:
          type: boolean
        has_missing_sibling_discount_alert:
          type: boolean
        has_unexpected_sibling_discount_alert:
          type: boolean
        has_not_sibling_with_discount_alert:
          type: boolean
      required:
        - school_id
        - school_name
        - student_id
        - student_first_name
        - student_last_name
        - student_name
        - family_id
        - status
        - dob
        - start_date
        - withdrawal_date
        - graduation_date
        - room
        - room_id
        - ems_student_status
        - program
        - tuition_plan
        - billing_cycle
        - tuition_amount
        - net_invoice
        - plan_status
        - sibling_discount
        - sibling_discount_amount
        - sibling_discount_pct
        - days_to_start_date
        - parent1_name
        - siblings
        - twins
        - sibling_order
        - sibling_twin
        - active_siblings_in_family
        - staff_child
        - school_color_hex
        - school_short_name
        - has_birth_date_alert
        - has_sibling_discount_pct_alert
        - has_missing_sibling_discount_alert
        - has_unexpected_sibling_discount_alert
        - has_not_sibling_with_discount_alert
      description: Sibling Discount.
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
      required:
        - error
      description: Error.
  responses:
    '400':
      description: Invalid or missing parameters or request body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid or missing parameters or request body.
    '401':
      description: >-
        Missing or invalid Bearer token, or an absent, invalid or expired
        server-side session. The authentication middleware returns plain text
        with a trailing newline.
      content:
        text/plain:
          schema:
            type: string
          examples:
            missing:
              value: |
                missing authorization header
            invalid:
              value: |
                Unauthorized
            expired:
              value: |
                Session expired
    '403':
      description: The authenticated session is not allowed to perform this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: >-
              The authenticated session is not allowed to perform this
              operation.
    '404':
      description: The requested resource was not found in the requested scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: The requested resource was not found in the requested scope.
    '405':
      description: The path exists but does not support this HTTP method.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: The path exists but does not support this HTTP method.
      headers:
        Allow:
          description: Comma-separated HTTP methods accepted by this path.
          schema:
            type: string
    '500':
      description: The operation could not be completed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: The operation could not be completed.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token issued by POST /sessions and associated with a valid
        server-side session.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.