NUDG3 Admin - Subscriptions API

The Admin - Subscriptions API from NUDG3 — 8 operation(s) for admin - subscriptions.

GitHub OpenAPI

Operations 8

GET /admin/subscriptions/workspace/{workspace_id} Get workspace subscriptions #
GET /admin/workspaces/trial-status Get workspaces by trial status #
POST /admin/workspaces/{workspace_id}/extend-trial Extend workspace trial #
POST /admin/subscriptions/{subscription_id}/apply-credit Apply credit to subscription #
POST /admin/subscriptions/{subscription_id}/force-activate Force activate subscription #
POST /admin/subscriptions/{subscription_id}/force-suspend Force suspend subscription #
GET /admin/subscriptions/{subscription_id}/details Get subscription details (admin view) #
GET /admin/subscriptions/{subscription_id}/changes Get subscription change history #

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-subscriptions-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-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Admin - Subscriptions 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 - Subscriptions
paths:
  /admin/subscriptions/workspace/{workspace_id}:
    get:
      tags:
      - Admin - Subscriptions
      summary: Get workspace subscriptions
      description: Get all subscriptions for a specific workspace (admin only)
      operationId: get_workspace_subscriptions_admin_subscriptions_workspace__workspace_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkspaceSubscriptionResponse'
                title: Response Get Workspace Subscriptions Admin Subscriptions Workspace  Workspace Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/workspaces/trial-status:
    get:
      tags:
      - Admin - Subscriptions
      summary: Get workspaces by trial status
      description: Get analytics of workspaces filtered by trial status (admin only)
      operationId: get_workspaces_by_trial_status_admin_workspaces_trial_status_get
      security:
      - HTTPBearer: []
      parameters:
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Filter by status: ''active'' (on trial), ''expired'' (trial expired), ''converted'' (trial converted to paid)'
          title: Status
        description: 'Filter by status: ''active'' (on trial), ''expired'' (trial expired), ''converted'' (trial converted to paid)'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkspaceTrialStatusResponse'
                title: Response Get Workspaces By Trial Status Admin Workspaces Trial Status Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/workspaces/{workspace_id}/extend-trial:
    post:
      tags:
      - Admin - Subscriptions
      summary: Extend workspace trial
      description: Extend trial period for a workspace (emergency admin function)
      operationId: extend_workspace_trial_admin_workspaces__workspace_id__extend_trial_post
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: days
        in: query
        required: true
        schema:
          type: integer
          maximum: 90
          minimum: 1
          description: Number of days to extend trial
          title: Days
        description: Number of days to extend trial
      - name: X-CSRF-Token
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Csrf-Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtendTrialResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/subscriptions/{subscription_id}/apply-credit:
    post:
      tags:
      - Admin - Subscriptions
      summary: Apply credit to subscription
      description: Apply credit to subscription, extending the next billing date (customer support)
      operationId: admin_apply_credit_admin_subscriptions__subscription_id__apply_credit_post
      security:
      - HTTPBearer: []
      parameters:
      - name: subscription_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Subscription Id
      - name: X-CSRF-Token
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Csrf-Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplyCreditRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyCreditResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/subscriptions/{subscription_id}/force-activate:
    post:
      tags:
      - Admin - Subscriptions
      summary: Force activate subscription
      description: Manually activate subscription (bypass payment)
      operationId: admin_force_activate_admin_subscriptions__subscription_id__force_activate_post
      security:
      - HTTPBearer: []
      parameters:
      - name: subscription_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Subscription Id
      - name: X-CSRF-Token
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Csrf-Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForceActivateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForceActivateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/subscriptions/{subscription_id}/force-suspend:
    post:
      tags:
      - Admin - Subscriptions
      summary: Force suspend subscription
      description: Manually suspend subscription
      operationId: admin_force_suspend_admin_subscriptions__subscription_id__force_suspend_post
      security:
      - HTTPBearer: []
      parameters:
      - name: subscription_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Subscription Id
      - name: X-CSRF-Token
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Csrf-Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForceSuspendRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForceSuspendResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/subscriptions/{subscription_id}/details:
    get:
      tags:
      - Admin - Subscriptions
      summary: Get subscription details (admin view)
      description: Get complete subscription details for admin dashboard
      operationId: admin_get_subscription_admin_subscriptions__subscription_id__details_get
      security:
      - HTTPBearer: []
      parameters:
      - name: subscription_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Subscription Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionDetailResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/subscriptions/{subscription_id}/changes:
    get:
      tags:
      - Admin - Subscriptions
      summary: Get subscription change history
      description: Get complete audit trail for subscription (admin only)
      operationId: get_subscription_changes_admin_subscriptions__subscription_id__changes_get
      security:
      - HTTPBearer: []
      parameters:
      - name: subscription_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Subscription Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SubscriptionChangeResponse'
                title: Response Get Subscription Changes Admin Subscriptions  Subscription Id  Changes Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ApplyCreditResponse:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
          description: Subscription ID
        credit_amount:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Credit Amount
          description: Credit amount applied
        days_extended:
          type: integer
          title: Days Extended
          description: Number of days extended
        new_billing_date:
          type: string
          title: New Billing Date
          description: New billing date
        message:
          type: string
          title: Message
          description: Success message
      type: object
      required:
      - subscription_id
      - credit_amount
      - days_extended
      - new_billing_date
      - message
      title: ApplyCreditResponse
      description: Response for credit application.
    SubscriptionDetailResponse:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        workspace_id:
          type: string
          title: Workspace Id
        workspace_name:
          type: string
          title: Workspace Name
        company_id:
          type: string
          title: Company Id
        company_name:
          type: string
          title: Company Name
        plan_id:
          type: string
          title: Plan Id
        plan_name:
          type: string
          title: Plan Name
        plan_slug:
          type: string
          title: Plan Slug
        monthly_price:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Monthly Price
        status:
          type: string
          title: Status
        created_at:
          type: string
          title: Created At
        cancelled_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Cancelled At
        suspended_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Suspended At
        next_billing_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Billing Date
        failed_payment_count:
          type: integer
          title: Failed Payment Count
        grace_period_ends:
          anyOf:
          - type: string
          - type: 'null'
          title: Grace Period Ends
        payfast_subscription_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Payfast Subscription Token
      type: object
      required:
      - subscription_id
      - workspace_id
      - workspace_name
      - company_id
      - company_name
      - plan_id
      - plan_name
      - plan_slug
      - monthly_price
      - status
      - created_at
      - failed_payment_count
      title: SubscriptionDetailResponse
      description: Detailed subscription information for admin view.
    SubscriptionChangeResponse:
      properties:
        id:
          type: string
          title: Id
          description: Change record ID
        change_type:
          type: string
          title: Change Type
          description: Type of change
        old_status:
          anyOf:
          - type: string
          - type: 'null'
          title: Old Status
          description: Previous status
        new_status:
          anyOf:
          - type: string
          - type: 'null'
          title: New Status
          description: New status
        old_plan_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Old Plan Id
          description: Previous plan ID
        new_plan_id:
          anyOf:
          - type: string
          - type: 'null'
          title: New Plan Id
          description: New plan ID
        old_plan_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Old Plan Name
          description: Previous plan name
        new_plan_name:
          anyOf:
          - type: string
          - type: 'null'
          title: New Plan Name
          description: New plan name
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
          description: Predefined reason code
        feedback:
          anyOf:
          - type: string
          - type: 'null'
          title: Feedback
          description: User feedback
        changed_by_user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Changed By User Id
          description: User ID who made the change
        changed_by_user_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Changed By User Name
          description: User name who made the change
        changed_by_user_email:
          anyOf:
          - type: string
          - type: 'null'
          title: Changed By User Email
          description: User email who made the change
        change_metadata:
          additionalProperties: true
          type: object
          title: Change Metadata
          description: Additional metadata
        created_at:
          type: string
          title: Created At
          description: When the change was made
      type: object
      required:
      - id
      - change_type
      - created_at
      title: SubscriptionChangeResponse
      description: Response schema for subscription change audit trail.
    WorkspaceTrialStatusResponse:
      properties:
        workspace_id:
          type: string
          title: Workspace Id
          description: Workspace ID
        workspace_name:
          type: string
          title: Workspace Name
          description: Workspace name
        company_id:
          type: string
          title: Company Id
          description: Company ID
        company_name:
          type: string
          title: Company Name
          description: Company name
        trial_started_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Trial Started At
          description: Trial start date
        trial_end_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Trial End Date
          description: Trial end date
        trial_converted_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Trial Converted At
          description: Trial conversion date
        days_remaining:
          anyOf:
          - type: integer
          - type: 'null'
          title: Days Remaining
          description: Days remaining in trial
        is_trial:
          type: boolean
          title: Is Trial
          description: Whether workspace is on trial
        is_expired:
          type: boolean
          title: Is Expired
          description: Whether trial is expired
        has_subscription:
          type: boolean
          title: Has Subscription
          description: Whether workspace has active subscription
        subscription_plan:
          anyOf:
          - type: string
          - type: 'null'
          title: Subscription Plan
          description: Current subscription plan name
      type: object
      required:
      - workspace_id
      - workspace_name
      - company_id
      - company_name
      - is_trial
      - is_expired
      - has_subscription
      title: WorkspaceTrialStatusResponse
      description: Response schema for workspace trial status analytics.
    ForceActivateResponse:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
          description: Subscription ID
        status:
          type: string
          title: Status
          description: New subscription status
        message:
          type: string
          title: Message
          description: Success message
      type: object
      required:
      - subscription_id
      - status
      - message
      title: ForceActivateResponse
      description: Response for force activation.
    WorkspaceSubscriptionResponse:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
          description: Subscription ID
        workspace_id:
          type: string
          title: Workspace Id
          description: Workspace ID
        workspace_name:
          type: string
          title: Workspace Name
          description: Workspace name
        plan_name:
          type: string
          title: Plan Name
          description: Subscription plan name
        plan_slug:
          type: string
          title: Plan Slug
          description: Plan slug
        status:
          type: string
          title: Status
          description: Subscription status
        created_at:
          type: string
          title: Created At
          description: Subscription creation date
        cancelled_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Cancelled At
          description: Cancellation date
        next_billing_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Billing Date
          description: Next billing date
      type: object
      required:
      - subscription_id
      - workspace_id
      - workspace_name
      - plan_name
      - plan_slug
      - status
      - created_at
      title: WorkspaceSubscriptionResponse
      description: Response schema for workspace subscription details.
    ForceActivateRequest:
      properties:
        reason:
          type: string
          minLength: 10
          title: Reason
          description: Reason for activation
        skip_payment:
          type: boolean
          title: Skip Payment
          description: Skip payment validation
          default: false
      type: object
      required:
      - reason
      title: ForceActivateRequest
      description: Request to force activate subscription.
    ExtendTrialResponse:
      properties:
        workspace_id:
          type: string
          title: Workspace Id
          description: Workspace ID
        old_trial_end_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Old Trial End Date
          description: Previous trial end date
        new_trial_end_date:
          type: string
          title: New Trial End Date
          description: New trial end date
        days_extended:
          type: integer
          title: Days Extended
          description: Number of days extended
        reactivated:
          type: boolean
          title: Reactivated
          description: Whether the workspace was reactivated from inactive state
          default: false
        quotas_reprovisioned:
          type: boolean
          title: Quotas Reprovisioned
          description: Whether trial quotas were freshly provisioned (vs extended)
          default: false
        message:
          type: string
          title: Message
          description: Success message
      type: object
      required:
      - workspace_id
      - new_trial_end_date
      - days_extended
      - message
      title: ExtendTrialResponse
      description: Response schema for trial extension.
    ForceSuspendResponse:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
          description: Subscription ID
        status:
          type: string
          title: Status
          description: New subscription status
        message:
          type: string
          title: Message
          description: Success message
      type: object
      required:
      - subscription_id
      - status
      - message
      title: ForceSuspendResponse
      description: Response for force suspension.
    ForceSuspendRequest:
      properties:
        reason:
          type: string
          minLength: 10
          title: Reason
          description: Reason for suspension
      type: object
      required:
      - reason
      title: ForceSuspendRequest
      description: Request to force suspend subscription.
    ApplyCreditRequest:
      properties:
        amount:
          anyOf:
          - type: number
            exclusiveMinimum: 0.0
          - type: string
            pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Amount
          description: Credit amount to apply
        reason:
          type: string
          minLength: 10
          title: Reason
          description: Reason for applying credit
      type: object
      required:
      - amount
      - reason
      title: ApplyCreditRequest
      description: Request to apply credit to subscription.
    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