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

# Subscribe the current organization to a rating program

> Immediately subscribes the authenticated human member’s current organization across all published and future versions. Requires raters:manage and usable run or download permission; readonly, service and delegated credentials are denied. No body or organization override is accepted. An existing staff entitlement remains authoritative for rights, expiry and revocation; subscriptions cannot expand it. At least one version must be published. Repeating an active subscription preserves its actor and timestamp and returns current subscription state and caller access. No serving release or tenant deployment changes.



## OpenAPI

````yaml /openapi.json put /insurance/rating-programs/{id}/subscription
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.effectiveai.app/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /insurance/rating-programs/{id}/subscription:
    put:
      tags:
        - Rating programs
      summary: Subscribe the current organization to a rating program
      description: >-
        Immediately subscribes the authenticated human member’s current
        organization across all published and future versions. Requires
        raters:manage and usable run or download permission; readonly, service
        and delegated credentials are denied. No body or organization override
        is accepted. An existing staff entitlement remains authoritative for
        rights, expiry and revocation; subscriptions cannot expand it. At least
        one version must be published. Repeating an active subscription
        preserves its actor and timestamp and returns current subscription state
        and caller access. No serving release or tenant deployment changes.
      operationId: subscribeRatingProgram
      parameters:
        - schema:
            type: string
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
          required: true
          name: id
          in: path
      responses:
        '200':
          description: Current organization subscription and effective caller access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2RatingProgramSubscription'
        '400':
          description: Invalid request or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Program entitlement and user permission are required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Program, version or package not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: Stored bundle identity differs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: Input exceeds the size limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '422':
          description: Invalid inputs or business refusal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Rating capacity unavailable; honor Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2RatingProgramSubscription:
      type: object
      properties:
        subscription:
          type: object
          properties:
            subscribed:
              type: boolean
            subscribedAt:
              type: string
              nullable: true
              format: date-time
            subscribedBy:
              type: string
              nullable: true
            canSubscribe:
              type: boolean
            canUnsubscribe:
              type: boolean
          required:
            - subscribed
            - subscribedAt
            - subscribedBy
            - canSubscribe
            - canUnsubscribe
          additionalProperties: false
        access:
          type: object
          properties:
            canRun:
              type: boolean
            canDownload:
              type: boolean
            expiresAt:
              type: string
              nullable: true
              format: date-time
          required:
            - canRun
            - canDownload
            - expiresAt
          additionalProperties: false
      required:
        - subscription
        - access
      additionalProperties: false
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
              description: Dataset needed for dataset_not_enabled.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

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