mammoth-io Self-Serve Subscription Plans API

openapi: 3.2.0
info:
  title: Mammoth Io Self-Serve Subscription Plans API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Self-Serve Subscription Plans across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Self-Serve Subscription Plans
paths:
  /subscription/self-serve-plans:
    get:
      tags:
      - Self-Serve Subscription Plans
      summary: List all subscription plans for self-serve
      operationId: ListSelfServePlans
      parameters: []
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanListResponseSchema'
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    ConnectorProfileSchema:
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          oneOf:
          - type: string
          - type: 'null'
        created_at:
          oneOf:
          - type: string
          - type: 'null'
        updated_at:
          oneOf:
          - type: string
          - type: 'null'
        connectors:
          oneOf:
          - items:
              $ref: '#/components/schemas/ConnectorSchema'
            type: array
            default: []
          - type: 'null'
          default: []
        connectors_count:
          oneOf:
          - type: integer
            default: 0
          - type: 'null'
          default: 0
        used_in_plans:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        plan_count:
          oneOf:
          - type: integer
          - type: 'null'
      type: object
      required:
      - id
      - name
      title: ConnectorProfileSchema
    PlanStorageOptionSchema:
      properties:
        id:
          oneOf:
          - type: integer
          - type: 'null'
          description: The stored option this entry came from; null on the plan's included storage, which is composed rather than stored.
        storage_gb:
          type: integer
        monthly_price:
          type: number
        annual_price:
          type: number
        is_base:
          type: boolean
        status:
          oneOf:
          - type: string
          - type: 'null'
          description: Status of the stored option; null on the base.
      type: object
      required:
      - annual_price
      - is_base
      - monthly_price
      - storage_gb
      title: PlanStorageOptionSchema
    ConnectorSchema:
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          oneOf:
          - type: string
          - type: 'null'
        price_per_month:
          oneOf:
          - type: number
          - type: 'null'
        enabled:
          type: boolean
        bucket:
          oneOf:
          - type: string
          - type: 'null'
          description: 'file | database | app | custom — the access model (admin-v2.1 D6): a plan''s connectorAccess level reaches connectors by bucket'
        created_at:
          oneOf:
          - type: string
          - type: 'null'
        updated_at:
          oneOf:
          - type: string
          - type: 'null'
        used_in_profiles:
          oneOf:
          - items:
              type: string
            type: array
            default: []
          - type: 'null'
          default: []
        profile_count:
          oneOf:
          - type: integer
            default: 0
          - type: 'null'
          default: 0
      type: object
      required:
      - enabled
      - id
      - name
      title: ConnectorSchema
    subscriptions_schema_FeatureSchema:
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          oneOf:
          - type: string
          - type: 'null'
        enabled:
          type: boolean
        kind:
          oneOf:
          - type: string
          - type: 'null'
          description: capacity | meter | enum | switch
        unit:
          oneOf:
          - type: string
          - type: 'null'
          description: Display unit (GB, /mo, days)
        group_name:
          oneOf:
          - type: string
          - type: 'null'
          description: Scale | Access | Brand | Governance | Service. NULL means the key is NEVER GATED — granted on every plan, listed apart from the registry
        enforcement:
          oneOf:
          - type: string
          - type: 'null'
          description: enforced | unenforced | unbuilt | unconfirmed | split | commitment
        note:
          oneOf:
          - type: string
          - type: 'null'
          description: What the product actually does today
        created_at:
          oneOf:
          - type: string
          - type: 'null'
        updated_at:
          oneOf:
          - type: string
          - type: 'null'
        used_in_profiles:
          oneOf:
          - items:
              type: string
            type: array
            default: []
          - type: 'null'
          default: []
        values:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        value:
          oneOf:
          - type: string
          - type: 'null'
        profile_count:
          oneOf:
          - type: integer
            default: 0
          - type: 'null'
          default: 0
        number_of_values:
          oneOf:
          - type: integer
            default: 0
          - type: 'null'
          default: 0
      type: object
      required:
      - enabled
      - id
      - name
      title: FeatureSchema
    FeatureProfileSchema:
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          oneOf:
          - type: string
          - type: 'null'
        created_at:
          oneOf:
          - type: string
          - type: 'null'
        updated_at:
          oneOf:
          - type: string
          - type: 'null'
        features:
          oneOf:
          - items:
              $ref: '#/components/schemas/subscriptions_schema_FeatureSchema'
            type: array
            default: []
          - type: 'null'
          default: []
        features_count:
          oneOf:
          - type: integer
            default: 0
          - type: 'null'
          default: 0
        used_in_plans:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        plan_count:
          oneOf:
          - type: integer
          - type: 'null'
      type: object
      required:
      - id
      - name
      title: FeatureProfileSchema
    PlanSchema:
      properties:
        id:
          type: integer
        name:
          type: string
        display_name:
          oneOf:
          - type: string
          - type: 'null'
        description:
          oneOf:
          - type: string
          - type: 'null'
        currency:
          type: string
        monthly_price:
          oneOf:
          - type: number
          - type: 'null'
        annual_only:
          type: boolean
          description: Indicates if the plan is annual-only.
          default: false
        annual_price:
          oneOf:
          - type: number
          - type: 'null'
        storage_amount:
          type: integer
        storage_block_size:
          oneOf:
          - type: integer
          - type: 'null'
          description: Block size for storage increments.
        trial_days:
          oneOf:
          - type: integer
          - type: 'null'
        is_self_serve:
          type: boolean
        is_purchasable:
          type: boolean
          description: False = displayed in the catalog so it matches the pricing page, but never sold from it (it resolves to a Deal).
          default: true
        lifecycle:
          type: string
          description: 'current | legacy | system. Only CURRENT rows are editable: the legacy estate is read-only until its migration terms are decided.'
          default: current
        max_storage:
          oneOf:
          - type: integer
          - type: 'null'
        max_users:
          oneOf:
          - type: integer
          - type: 'null'
        no_of_users:
          oneOf:
          - type: integer
          - type: 'null'
        seat_price:
          oneOf:
          - type: integer
          - type: 'null'
        number_of_tiers:
          type: integer
        tiers:
          oneOf:
          - items:
              $ref: '#/components/schemas/schema_StorageTierSchema'
            type: array
          - type: 'null'
        uses_inline_pricing:
          type: boolean
          default: false
        storage_options:
          oneOf:
          - items:
              $ref: '#/components/schemas/PlanStorageOptionSchema'
            type: array
          - type: 'null'
          description: Selectable storage sizes, base first, for inline-pricing plans; null on legacy plans, which price storage through addons.
        connector_profile_id:
          oneOf:
          - type: integer
          - type: 'null'
        feature_profile_id:
          oneOf:
          - type: integer
          - type: 'null'
        stripe_product_id:
          oneOf:
          - type: string
          - type: 'null'
        stripe_monthly_price_id:
          oneOf:
          - type: string
          - type: 'null'
        stripe_annual_price_id:
          oneOf:
          - type: string
          - type: 'null'
        status:
          type: string
        created_at:
          oneOf:
          - type: string
          - type: 'null'
        updated_at:
          oneOf:
          - type: string
          - type: 'null'
        subscription_count:
          oneOf:
          - type: integer
            default: 0
          - type: 'null'
          default: 0
        connector_profile:
          oneOf:
          - $ref: '#/components/schemas/ConnectorProfileSchema'
          - type: 'null'
        feature_profile:
          oneOf:
          - $ref: '#/components/schemas/FeatureProfileSchema'
          - type: 'null'
        connector_access:
          oneOf:
          - type: string
          - type: 'null'
          description: The plan's connectorAccess level as the resolver reads it (no level reads all). Set on the self-serve catalog.
        access_connectors:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The connector names that level reaches. The connector profile decides no access (decision 2026-10-06).
      type: object
      required:
      - currency
      - id
      - is_self_serve
      - name
      - number_of_tiers
      - status
      - storage_amount
      title: PlanSchema
    PlanListResponseSchema:
      properties:
        plans:
          items:
            $ref: '#/components/schemas/PlanSchema'
          type: array
      type: object
      required:
      - plans
      title: PlanListResponseSchema
    schema_StorageTierSchema:
      properties:
        gb:
          type: integer
        price_per_gb:
          type: number
      type: object
      required:
      - gb
      - price_per_gb
      title: StorageTierSchema
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json