Skip to main content

Developer portal Plans

Configure your Plans​

  • plans: An array of plan objects.
    • Description: Defines the different plans available for API usage.
    • Type: Array of Plan objects
    • Example:
      dev-portal.json
      "plans": [
        {
          "id": "default",
          "name": "default",
          "default": true,
          "description": "The default apikey plan",
          "throttling": 100,
          "daily": 10000,
          "monthly": 10000
        }
      ]
Plan Object​

  • id: "default"

    • Description: The unique identifier for the plan.
    • Type: String
    • Example: "id": "default"

  • name: "default"

    • Description: The name of the plan.
    • Type: String
    • Example: "name": "default"

  • default: true

    • Description: Indicates if this is the default plan for new users.
    • Type: Boolean
    • Default: false
    • Example: "default": true

  • description: "The default apikey plan"

    • Description: A brief description of the plan.
    • Type: String
    • Example: "description": "The default apikey plan"

  • throttling: 100

    • Description: The throttling limit, possibly requests per second or minute.
    • Type: Integer
    • Example: "throttling": 100

  • daily: "10000"

    • Description: The maximum number of requests allowed per day.
    • Type: Integer
    • Example: "daily": 10000

  • monthly: "10000"

    • Description: The maximum number of requests allowed per month.
    • Type: Integer
    • Example: "monthly": 10000