robosystems-ai Subscriptions API

openapi: 3.2.0
info:
  title: RoboSystems Subscriptions API
  description: 'The REST and GraphQL API for RoboSystems — an open-source, AI-native platform for accounting, financial reporting and investment management. It powers RoboLedger and RoboInvestor.


    ## Two surfaces


    **Platform** — `/v1/…` — graphs, queries, schema, documents, search, memory, connections, billing and access. Reads are REST `GET`s; every write is a named operation at `/operations/{name}` returning an `OperationEnvelope`, accepting an `Idempotency-Key`, and streaming progress at `/v1/operations/{id}/stream`.

    → API reference


    **Extensions** — `/extensions/…` — RoboLedger and RoboInvestor, scoped by `graph_id` in the URL. Reads are GraphQL at `POST /extensions/{graph_id}/graphql` and change nothing; writes are named operations at `/extensions/{domain}/{graph_id}/operations/{name}`; analytical views read the materialized graph.

    → Extensions reference · every GraphQL query


    ## Authenticating


    `X-API-Key: rfs…` on REST, GraphQL and per-graph MCP. Browser sessions use JWTs from `POST /v1/auth/login`. The graph-agnostic MCP endpoint `/v1/mcp` takes OAuth 2.1 bearer tokens only.


    ## Connecting an AI client


    Every graph is an MCP server at `POST /v1/graphs/{graph_id}/mcp`, and `POST /v1/mcp` serves OAuth clients that pick their graph at consent.

    → MCP guide


    ## Clients


    `robosystems-client` for Python, `@robosystems/client` for TypeScript.

    → Guides · Technical docs'
  version: 1.20.6
tags:
- name: Subscriptions
  description: 💳 Subscriptions - Shared repository subscription management
paths:
  /v1/graphs/{graph_id}/subscriptions:
    get:
      tags:
      - Subscriptions
      summary: Get Graph Subscription
      description: 'Detects resource type automatically: user graphs (kg*) return the graph''s subscription; shared repositories return the user''s personal subscription to that repo.'
      operationId: getGraphSubscription
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(kg[a-f0-9]{16,}(?:_[a-zA-Z0-9]{1,20})?|sec(?:_[a-zA-Z0-9]{1,20})?|library)$
          description: Graph ID or repository name
          title: Graph Id
        description: Graph ID or repository name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphSubscriptionResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Subscriptions
      summary: Create Repository Subscription
      description: For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning. Subscribes the caller by default; org owners and admins may subscribe another member of their organization by passing `user_id`. Billing is charged to the organization either way — repository access is per-user, so the subscriber determines who receives access.
      operationId: createRepositorySubscription
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(kg[a-f0-9]{16,}(?:_[a-zA-Z0-9]{1,20})?|sec(?:_[a-zA-Z0-9]{1,20})?|library)$
          description: Repository name (e.g., 'sec', 'industry')
          title: Graph Id
        description: Repository name (e.g., 'sec', 'industry')
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRepositorySubscriptionRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphSubscriptionResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment required — add a payment method first
        '409':
          description: Already subscribed to this repository
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Subscriptions
      summary: Change Subscription Plan
      description: 'For repositories: synchronous tier change. For user graphs: use `POST /v1/graphs/{graph_id}/operations/change-tier` instead — this endpoint rejects graph tier changes. Requires org owner role.'
      operationId: changeSubscriptionPlan
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(kg[a-f0-9]{16,}(?:_[a-zA-Z0-9]{1,20})?|sec(?:_[a-zA-Z0-9]{1,20})?|library)$
          description: Graph ID or repository name
          title: Graph Id
        description: Graph ID or repository name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpgradeSubscriptionRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphSubscriptionResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/graphs/{graph_id}/subscriptions/cancel:
    post:
      tags:
      - Subscriptions
      summary: Cancel Repository Subscription
      description: 'Cancel a shared repository subscription. Two modes via the `immediate` flag: omit it (default `false`) to cancel at period end (access stays until the period closes); pass `true` with `confirm=` to stop access right away. Members cancel their own subscription; org owners and admins can cancel any member''s by passing `user_id`. For user graphs, use `POST /v1/graphs/{graph_id}/operations/delete-graph` — this endpoint rejects user graphs.'
      operationId: cancelRepositorySubscription
      security:
      - APIKeyHeader: []
      - BearerAuth: []
      parameters:
      - name: graph_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(kg[a-f0-9]{16,}(?:_[a-zA-Z0-9]{1,20})?|sec(?:_[a-zA-Z0-9]{1,20})?|library)$
          description: Repository name (e.g., 'sec', 'industry')
          title: Graph Id
        description: Repository name (e.g., 'sec', 'industry')
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelSubscriptionRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphSubscriptionResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CancelSubscriptionRequest:
      properties:
        immediate:
          type: boolean
          title: Immediate
          description: If true, cancel immediately and trigger fast-path deprovisioning of the underlying resource (within ~10 minutes). If false (default), cancel at the end of the current billing period.
          default: false
        confirm:
          anyOf:
          - type: string
          - type: 'null'
          title: Confirm
          description: Required when immediate=True. Must equal the subscription's resource_id (e.g. graph_id) to confirm intent.
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Organization member whose subscription to cancel. Defaults to the caller; canceling another member's requires org owner or admin.
      additionalProperties: false
      type: object
      title: CancelSubscriptionRequest
      description: 'Request to cancel a subscription.


        Default behavior cancels at period end (soft cancel). Pass `immediate=True`

        to terminate the subscription right away — this requires `confirm` to equal

        the subscription''s `resource_id` (e.g. the graph_id) as a guard against

        accidental destructive calls.'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CreateRepositorySubscriptionRequest:
      properties:
        plan_name:
          type: string
          title: Plan Name
          description: Plan name for the repository subscription
          examples:
          - sec-starter
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Subscribe this user instead of yourself. Org owners and admins only, and the target must belong to the same organization. Omit to subscribe yourself. Repository access is per-user while billing is org-level, so the subscriber is what determines who gets access.
          examples:
          - user_01ABC123
      type: object
      required:
      - plan_name
      title: CreateRepositorySubscriptionRequest
      description: Request to create a repository subscription.
    GraphSubscriptionResponse:
      properties:
        id:
          type: string
          title: Id
          description: Subscription ID
        resource_type:
          type: string
          title: Resource Type
          description: Resource type (graph or repository)
        resource_id:
          type: string
          title: Resource Id
          description: Resource identifier
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Organization member the subscription belongs to. Set for repository subscriptions, which are billed to the org but granted per user.
        plan_name:
          type: string
          title: Plan Name
          description: Current plan name
        plan_display_name:
          type: string
          title: Plan Display Name
          description: Human-readable plan name for UI display
        billing_interval:
          type: string
          title: Billing Interval
          description: Billing interval
        status:
          type: string
          title: Status
          description: Subscription status
        base_price_cents:
          type: integer
          title: Base Price Cents
          description: Base price in cents
        current_period_start:
          anyOf:
          - type: string
          - type: 'null'
          title: Current Period Start
          description: Current billing period start
        current_period_end:
          anyOf:
          - type: string
          - type: 'null'
          title: Current Period End
          description: Current billing period end
        started_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Started At
          description: Subscription start date
        canceled_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Canceled At
          description: Cancellation date
        ends_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Ends At
          description: Subscription end date (when access will be revoked, especially relevant for cancelled subscriptions)
        created_at:
          type: string
          title: Created At
          description: Creation timestamp
        operation_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Operation Id
          description: Operation ID for tracking async tier changes via SSE
      type: object
      required:
      - id
      - resource_type
      - resource_id
      - plan_name
      - plan_display_name
      - billing_interval
      - status
      - base_price_cents
      - created_at
      title: GraphSubscriptionResponse
      description: Response for graph or repository subscription details.
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable error message explaining what went wrong
          examples:
          - Insufficient credits for operation
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: Machine-readable error code for programmatic handling
          examples:
          - INSUFFICIENT_CREDITS
        request_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Request Id
          description: Unique request ID for tracking and debugging
          examples:
          - req_1234567890abcdef
        timestamp:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Timestamp
          description: Timestamp when the error occurred
          examples:
          - '2024-01-01T00:00:00Z'
      type: object
      required:
      - detail
      title: ErrorResponse
      description: Error body returned by every endpoint.
      example:
        code: RESOURCE_NOT_FOUND
        detail: Resource not found
        request_id: req_1234567890abcdef
        timestamp: '2024-01-01T00:00:00Z'
    UpgradeSubscriptionRequest:
      properties:
        new_plan_name:
          type: string
          title: New Plan Name
          description: New plan name to change to
          examples:
          - advanced
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Organization member whose subscription to change. Defaults to the caller; targeting another member requires org owner or admin.
      type: object
      required:
      - new_plan_name
      title: UpgradeSubscriptionRequest
      description: Request to upgrade a subscription.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT bearer token