pricklymails-com Config API

openapi: 3.2.0
info:
  title: Pricklymails Com Config API
  version: 0.9.0
  contact:
    email: support@pricklymails.com
  license:
    name: Proprietary
  description: 'Operations tagged config across 2 of this provider''s published API definitions: pricklymails-com-openapi.json, pricklymails-com-openapi.yaml. Each path carries the servers of the definition it was published in.'
tags:
- name: Config
  description: Public, unauthenticated pricing and plan configuration.
paths:
  /api/config:
    get:
      tags:
      - Config
      summary: Public, unauthenticated endpoint returning the plan grid, top-up pricing, and…
      operationId: get_config
      responses:
        '200':
          description: Public pricing and plan configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResponse'
components:
  schemas:
    CheckCostsResponse:
      type: object
      description: Public per-check token cost. Field names are the check names.
      required:
      - syntax
      - mx
      - smtp
      - disposable
      - role
      - free
      - catchall
      properties:
        catchall:
          type: integer
          format: int32
          description: Token cost of the `catchall` check.
          minimum: 0
        disposable:
          type: integer
          format: int32
          description: Token cost of the `disposable` check.
          minimum: 0
        free:
          type: integer
          format: int32
          description: Token cost of the `free` check.
          minimum: 0
        mx:
          type: integer
          format: int32
          description: Token cost of the `mx` check.
          minimum: 0
        role:
          type: integer
          format: int32
          description: Token cost of the `role` check.
          minimum: 0
        smtp:
          type: integer
          format: int32
          description: Token cost of the `smtp` check.
          minimum: 0
        syntax:
          type: integer
          format: int32
          description: Token cost of the `syntax` check.
          minimum: 0
    ConfigResponse:
      type: object
      description: JSON response body for `GET /api/config`.
      required:
      - plans
      - topup
      - checks
      - batch_min
      properties:
        batch_min:
          type: integer
          format: int64
          description: The fewest distinct valid addresses a batch may hold; fewer go through single verification.
          minimum: 0
        checks:
          $ref: '#/components/schemas/CheckCostsResponse'
          description: Per-check token cost, keyed by check name.
        plans:
          type: array
          items:
            $ref: '#/components/schemas/PlanConfigResponse'
          description: One entry per real plan, in tier order (Free through Enterprise).
        topup:
          $ref: '#/components/schemas/TopupConfigResponse'
          description: Token top-up pricing.
    TopupConfigResponse:
      type: object
      description: Token top-up pricing.
      required:
      - tokens_per_euro
      - min_tokens
      - step_tokens
      - max_tokens
      properties:
        max_tokens:
          type: integer
          format: int32
          description: Maximum token quantity purchasable in a single top-up.
          minimum: 0
        min_tokens:
          type: integer
          format: int32
          description: Minimum token quantity purchasable in a single top-up.
          minimum: 0
        step_tokens:
          type: integer
          format: int32
          description: 'Required quantity increment; a top-up quantity must be a multiple of this value (identical to `tokens_per_euro`,

            so every charge is a whole number of cents).'
          minimum: 0
        tokens_per_euro:
          type: integer
          format: int32
          description: Number of tokens that map to one euro (e.g. `1000` = 0.001 EUR/token).
          minimum: 0
    PlanConfigResponse:
      type: object
      description: Plan pricing and limits for one plan tier.
      required:
      - code
      - monthly_tokens
      - monthly_price_cents
      - yearly_price_cents
      - rate_limit_per_minute
      - max_api_keys
      - batch_max
      - max_agents
      - max_webhooks
      - allowed_checks
      - allowed_agent_scopes
      properties:
        allowed_agent_scopes:
          type: array
          items:
            type: string
          description: 'The scopes an agent (a non-human principal) under this plan may be granted, as scope strings such as

            `"results:read"`.'
        allowed_checks:
          type: array
          items:
            type: string
          description: 'The verification checks an API key or agent credential under this plan may enable, as check names such as

            `"smtp"`.'
        batch_max:
          type: integer
          format: int32
          description: Maximum batch size for a single bulk-verification submission.
          minimum: 0
        code:
          type: string
          description: Plan code (e.g. `"free"`, `"starter"`, `"pro"`, `"business"`, `"enterprise"`).
        max_agents:
          type: integer
          format: int32
          description: Maximum number of active agents (non-human principals authenticating through a scoped credential).
          minimum: 0
        max_api_keys:
          type: integer
          format: int32
          description: Maximum number of active API keys.
          minimum: 0
        max_webhooks:
          type: integer
          format: int32
          description: Maximum number of webhook endpoints, whatever their status (paused and disabled endpoints count too); 0 on Free.
          minimum: 0
        monthly_price_cents:
          type: integer
          format: int64
          description: Monthly price in cents.
          minimum: 0
        monthly_tokens:
          type: integer
          format: int32
          description: Monthly token grant credited to the account's token balance on each billing cycle.
          minimum: 0
        rate_limit_per_minute:
          type: integer
          format: int32
          description: API rate limit in requests per minute.
          minimum: 0
        yearly_price_cents:
          type: integer
          format: int64
          description: Yearly price in cents (11 months for 12).
          minimum: 0
  securitySchemes:
    bearer_api_key:
      type: http
      scheme: bearer
      description: A `pm_live_*` or `pm_test_*` API key.
    jwt:
      type: http
      scheme: bearer
      description: A short-lived token from `/api/auth/login`, or `/oauth/token` for an agent.
x-refined-from:
- pricklymails-com-openapi.json
- pricklymails-com-openapi.yaml