NUDG3 Admin - Subscription Plans API

The Admin - Subscription Plans API from NUDG3 — 2 operation(s) for admin - subscription plans.

GitHub OpenAPI

Operations 5

GET /admin/plans List subscription plans #
POST /admin/plans Create subscription plan #
GET /admin/plans/{plan_id} Get subscription plan with quotas #
PUT /admin/plans/{plan_id} Update subscription plan #
DELETE /admin/plans/{plan_id} Delete subscription plan #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nudg3-ai:nudg3-ai-admin-subscription-plans-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nudg3-ai-admin-subscription-plans-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Admin - Subscription Plans API
  description: '# Nudg3 Brand Intelligence API


    The Nudg3 API provides programmatic access to brand visibility analytics across AI providers.


    ## Public API v1


    The Public API (`/api/v1/`) is designed for third-party integrations and provides:


    ### Analytics Endpoints (Tier 1 - Basic)

    - Brand visibility scores and trends

    - Sentiment analysis across AI responses

    - Source citation tracking

    - Prompt performance metrics

    - Google AI Overview (AIO) coverage


    ### Export Endpoints (Tier 2 - Premium)

    - Full response data exports (CSV/TSV)

    - Source citations bulk download

    - Dashboard time-series data

    - Prompt-mention pair exports


    ## Authentication


    ### API Key (Public API v1)

    ```bash

    curl -H "Authorization: Bearer nudg3_live_ak_xxx..." \

    https://api.nudg3.com/api/v1/dashboard

    ```


    ### JWT (Dashboard API)

    ```bash

    curl -H "Authorization: Bearer eyJ..." \

    https://api.nudg3.com/analytics/dashboard

    ```


    ## Rate Limits


    | Tier | Per Minute | Per Hour | Monthly Quota |

    |------|------------|----------|---------------|

    | Basic | 60 | 600 | 5,000 |

    | Premium | 300 | 3,000 | 50,000 |


    ## Response Format


    All responses follow a standard envelope:

    ```json

    {

    "success": true,

    "data": { ... },

    "message": "Success"

    }

    ```


    ## Support


    - Documentation: https://docs.nudg3.com

    - API Status: https://status.nudg3.com

    - Support: support@nudg3.com'
  version: 1.1.0
  termsOfService: https://nudg3.com/terms
  contact:
    name: Nudg3 API Support
    url: https://nudg3.com/support
    email: support@nudg3.com
  license:
    name: Proprietary
    url: https://nudg3.com/license
servers:
- url: https://api.nudg3.com
  description: Production API
- url: https://api-staging.nudg3.com
  description: Staging API (for testing)
- url: http://localhost:8000
  description: Local Development
tags:
- name: Admin - Subscription Plans
paths:
  /admin/plans:
    get:
      tags:
      - Admin - Subscription Plans
      summary: List subscription plans
      description: List all subscription plans (admin only)
      operationId: list_plans_admin_plans_get
      security:
      - HTTPBearer: []
      parameters:
      - name: include_inactive
        in: query
        required: false
        schema:
          type: boolean
          description: Include inactive plans
          default: false
          title: Include Inactive
        description: Include inactive plans
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/api__admin__plans__SubscriptionPlanResponse'
                title: Response List Plans Admin Plans Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Admin - Subscription Plans
      summary: Create subscription plan
      description: Create a new subscription plan (admin only)
      operationId: create_plan_admin_plans_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionPlanRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api__admin__plans__SubscriptionPlanResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/plans/{plan_id}:
    get:
      tags:
      - Admin - Subscription Plans
      summary: Get subscription plan with quotas
      description: Get a single subscription plan with its quota configurations (admin only)
      operationId: get_plan_admin_plans__plan_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: plan_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Plan Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionPlanWithQuotasResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Admin - Subscription Plans
      summary: Update subscription plan
      description: Update an existing subscription plan (admin only)
      operationId: update_plan_admin_plans__plan_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: plan_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Plan Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriptionPlanRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api__admin__plans__SubscriptionPlanResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Admin - Subscription Plans
      summary: Delete subscription plan
      description: Soft-delete a subscription plan by marking it inactive (admin only)
      operationId: delete_plan_admin_plans__plan_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: plan_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Plan Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CreateSubscriptionPlanRequest:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
        slug:
          anyOf:
          - type: string
            maxLength: 100
            pattern: ^[a-z0-9-]+$
          - type: 'null'
          title: Slug
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        price_monthly:
          type: number
          minimum: 0.0
          title: Price Monthly
        price_yearly:
          anyOf:
          - type: number
            minimum: 0.0
          - type: 'null'
          title: Price Yearly
        currency:
          type: string
          maxLength: 3
          title: Currency
          default: ZAR
        billing_period:
          type: string
          pattern: ^(monthly|yearly)$
          title: Billing Period
          default: monthly
        trial_days:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Trial Days
        features:
          anyOf:
          - items: {}
            type: array
          - type: 'null'
          title: Features
        is_active:
          type: boolean
          title: Is Active
          default: true
        is_default:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Default
        sort_order:
          anyOf:
          - type: integer
          - type: 'null'
          title: Sort Order
      type: object
      required:
      - name
      - price_monthly
      title: CreateSubscriptionPlanRequest
      description: Request to create a new subscription plan.
    PlanQuotaResponseItem:
      properties:
        id:
          type: string
          title: Id
        plan_id:
          type: string
          title: Plan Id
        plan_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Plan Name
        plan_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Plan Slug
        quota_type:
          type: string
          title: Quota Type
        resource_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Id
        resource_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Name
        allocation:
          type: integer
          title: Allocation
        reset_period:
          type: string
          title: Reset Period
          default: monthly
        is_active:
          type: boolean
          title: Is Active
          default: true
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - plan_id
      - quota_type
      - allocation
      - created_at
      - updated_at
      title: PlanQuotaResponseItem
      description: Response schema for a plan quota within a plan.
    SubscriptionPlanWithQuotasResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        slug:
          type: string
          title: Slug
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        price_monthly:
          type: number
          title: Price Monthly
        price_yearly:
          anyOf:
          - type: number
          - type: 'null'
          title: Price Yearly
        currency:
          type: string
          title: Currency
          default: ZAR
        billing_period:
          type: string
          title: Billing Period
          default: monthly
        trial_days:
          type: integer
          title: Trial Days
          default: 0
        features:
          items: {}
          type: array
          title: Features
        is_active:
          type: boolean
          title: Is Active
          default: true
        is_default:
          type: boolean
          title: Is Default
          default: false
        sort_order:
          type: integer
          title: Sort Order
          default: 0
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
        quotas:
          items:
            $ref: '#/components/schemas/PlanQuotaResponseItem'
          type: array
          title: Quotas
      type: object
      required:
      - id
      - name
      - slug
      - price_monthly
      - created_at
      - updated_at
      title: SubscriptionPlanWithQuotasResponse
      description: Response schema for a subscription plan with its quotas.
    UpdateSubscriptionPlanRequest:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 100
            minLength: 1
          - type: 'null'
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        price_monthly:
          anyOf:
          - type: number
            minimum: 0.0
          - type: 'null'
          title: Price Monthly
        price_yearly:
          anyOf:
          - type: number
            minimum: 0.0
          - type: 'null'
          title: Price Yearly
        currency:
          anyOf:
          - type: string
            maxLength: 3
          - type: 'null'
          title: Currency
        billing_period:
          anyOf:
          - type: string
            pattern: ^(monthly|yearly)$
          - type: 'null'
          title: Billing Period
        trial_days:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Trial Days
        features:
          anyOf:
          - items: {}
            type: array
          - type: 'null'
          title: Features
        is_active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Active
        is_default:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Default
        sort_order:
          anyOf:
          - type: integer
          - type: 'null'
          title: Sort Order
      type: object
      title: UpdateSubscriptionPlanRequest
      description: Request to update a subscription plan.
    api__admin__plans__SubscriptionPlanResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        slug:
          type: string
          title: Slug
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        price_monthly:
          type: number
          title: Price Monthly
        price_yearly:
          anyOf:
          - type: number
          - type: 'null'
          title: Price Yearly
        currency:
          type: string
          title: Currency
          default: ZAR
        billing_period:
          type: string
          title: Billing Period
          default: monthly
        trial_days:
          type: integer
          title: Trial Days
          default: 0
        features:
          items: {}
          type: array
          title: Features
        is_active:
          type: boolean
          title: Is Active
          default: true
        is_default:
          type: boolean
          title: Is Default
          default: false
        sort_order:
          type: integer
          title: Sort Order
          default: 0
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - name
      - slug
      - price_monthly
      - created_at
      - updated_at
      title: SubscriptionPlanResponse
      description: Response schema for a subscription plan.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: '

        API Key authentication for Public API v1 endpoints.


        **Format:** `nudg3_live_ak_xxx...` or `nudg3_test_ak_xxx...`


        **Usage:**

        ```

        Authorization: Bearer nudg3_live_ak_your_key_here

        ```


        Or use the header:

        ```

        X-API-Key: nudg3_live_ak_your_key_here

        ```


        **Obtain API Keys:**

        Generate API keys from your Nudg3 dashboard under Settings > API Keys.


        **Tiers:**

        - **Basic:** `read:analytics` scope - Analytics endpoints only

        - **Premium:** `read:analytics` + `export:data` scopes - Analytics + Exports

        '
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: '

        JWT authentication for internal dashboard endpoints.


        Obtain tokens via `/auth/login` endpoint.

        '
externalDocs:
  description: Nudg3 API Documentation
  url: https://docs.nudg3.com/api