Central Fox Tecnologia LTDA Plans API

The plans API from Central Fox Tecnologia LTDA — 4 operation(s) for plans.

GitHub OpenAPI

Operations 4

GET /api/v1/plans/current Plan current #
GET /api/v1/plans/usage Plan usage #
POST /api/v1/plans/upgrade Plan upgrade #
POST /api/v1/plans/expire Plan expireToFree #

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/foxnfe-com-br:foxnfe-com-br-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. See our Privacy Policy and Terms.

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

OpenAPI Specification

foxnfe-com-br-plans-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: FOX NF-e Plans API
  version: '1.20260923'
  description: Contrato derivado das rotas, regras Laravel e respostas estáticas. Condições de validação são descritas nos campos. x-source identifica a evidência. Valores dinâmicos sem tipo comprovado não recebem tipos inventados.
servers:
- url: https://www.foxnfe.com.br
tags:
- name: Plans
paths:
  /api/v1/plans/current:
    get:
      operationId: get_api_v1_plans_current
      tags:
      - Plans
      summary: Plan current
      x-source: app/app/Http/Controllers/Api/V1/PlanController.php:29
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    type: object
                    properties:
                      code:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:37
                      name:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:38
                      price_brl_cents:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:39
                      monthly_note_quota:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:40
                      max_cnpjs:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:41
                      max_users:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:42
                      features:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:43
                  usage:
                    type: object
                    properties:
                      nfes_current_month:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:46
                      nfes_quota_month:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:47
                      period:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:48
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    plan:
                      code: null
                      name: null
                      price_brl_cents: null
                      monthly_note_quota: null
                    usage:
                      nfes_current_month: null
                      nfes_quota_month: null
                      period: null
          x-source:
          - app/app/Http/Controllers/Api/V1/PlanController.php:35
      security:
      - bearerAuth: []
  /api/v1/plans/usage:
    get:
      operationId: get_api_v1_plans_usage
      tags:
      - Plans
      summary: Plan usage
      x-source: app/app/Http/Controllers/Api/V1/PlanController.php:54
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  current_month:
                    type: object
                    properties:
                      nfes_issued:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:63
                      quota:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:59
                      remaining:
                        anyOf:
                        - type: 'null'
                        - description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                          x-source: app/app/Http/Controllers/Api/V1/PlanController.php:65
                      quota_exceeded:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:66
                      period:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/PlanController.php:67
                  plan:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/PlanController.php:69
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    current_month:
                      nfes_issued: null
                      quota: null
                      remaining: null
                      quota_exceeded: null
                    plan: null
          x-source:
          - app/app/Http/Controllers/Api/V1/PlanController.php:61
      security:
      - bearerAuth: []
  /api/v1/plans/upgrade:
    post:
      operationId: post_api_v1_plans_upgrade
      tags:
      - Plans
      summary: Plan upgrade
      x-source: app/app/Http/Controllers/Api/V1/PlanController.php:80
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      responses:
        '422':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: downgrade_not_allowed
                  message:
                    type: string
                    example: Current month usage exceeds new plan quota.
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    error: downgrade_not_allowed
                    message: Current month usage exceeds new plan quota.
          x-source:
          - app/app/Http/Controllers/Api/V1/PlanController.php:114
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Plan updated successfully.
                  plan:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/PlanController.php:146
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    message: Plan updated successfully.
                    plan: null
          x-source:
          - app/app/Http/Controllers/Api/V1/PlanController.php:144
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_plans_upgradeRequest'
            examples:
              estrutura_ficticia:
                summary: Exemplo estrutural fictício; não é recibo de execução.
                description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                value:
                  plan_code: free
  /api/v1/plans/expire:
    post:
      operationId: post_api_v1_plans_expire
      tags:
      - Plans
      summary: Plan expireToFree
      x-source: app/app/Http/Controllers/Api/V1/PlanController.php:151
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Subscription expired, downgraded to free.
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    message: Subscription expired, downgraded to free.
          x-source:
          - app/app/Http/Controllers/Api/V1/PlanController.php:194
      security:
      - bearerAuth: []
components:
  schemas:
    post_api_v1_plans_upgradeRequest:
      type: object
      properties:
        plan_code:
          x-laravel-rules:
          - required
          - string
          - in:free,starter,growth,pro,scale,enterprise
          type: string
          enum:
          - free
          - starter
          - growth
          - pro
          - scale
          - enterprise
      required:
      - plan_code
      x-source:
      - app/app/Http/Controllers/Api/V1/PlanController.php:86
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer