> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hookie.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Current plan, subscription and display prices



## OpenAPI

````yaml /openapi.json get /admin/api/billing/status
openapi: 3.1.0
info:
  title: Hookie API
  version: 1.0.0
  summary: Capture, route and deliver webhooks.
  description: >-
    Hookie exposes three HTTP surfaces.


    **Ingest + streaming** is the public plane. A path-form endpoint URL
    authenticates by its own high-entropy slug — there is no key, token or
    cookie — and an `ik_live_…` ingest key authenticates the `/v1/*` routes.
    Whenever the URL names a dataset the payload is stored whole into it;
    project mapping rules are evaluated on exactly one shape, `POST
    /v1/ingest/{ingest_key}` with no dataset segment.


    **The customer portal API** is a separate, token-authed surface for your end
    customers, scoped to one portal and one customer.


    **The admin API** drives the console. It accepts either a browser session or
    an OAuth bearer token from a connected coding agent — the same routes, the
    same validation, the same audit trail. An agent's authority is its user's
    workspace role narrowed to the scopes granted in the console.


    This document is generated from the request handlers and adversarially
    verified against them.
  contact:
    name: Hookie
    url: https://hookie.ai
  license:
    name: Proprietary
    url: https://hookie.ai/legal/terms
servers:
  - url: https://app.hookie.ai
    description: Production
  - url: https://app.preview.hookie.ai
    description: Preview
security: []
tags:
  - name: Ingest
    description: Send events to Hookie.
  - name: Streaming
    description: Tail events in real time over SSE or WebSocket.
  - name: Portal
    description: Token-authed surface for your end customers.
  - name: Projects
    description: Projects and their settings.
  - name: Routing
    description: Rules, endpoints, datasets and records.
  - name: Delivery
    description: Destinations, deliveries and replay.
  - name: Workflows
    description: Multi-step workflows, triggers and AI agents.
  - name: Observability
    description: Search, correlation, stats and the audit log.
  - name: Workspace
    description: Members, connected agents, SSO and billing.
paths:
  /admin/api/billing/status:
    get:
      tags:
        - Billing
      summary: Current plan, subscription and display prices
      operationId: getBillingStatus
      responses:
        '200':
          description: >-
            Readable by ANY workspace member — the owner-only gate starts after
            this branch.
          content:
            application/json:
              schema:
                type: object
                required:
                  - plan
                  - subscription
                  - prices
                  - trial
                  - portal_url
                properties:
                  plan:
                    type: string
                    enum:
                      - free
                      - standard
                      - team
                    description: '''standard'' is the internal id of the Pro plan.'
                  subscription:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: string
                        description: Stripe subscription id.
                      status:
                        type: string
                        description: >-
                          Stripe subscription status as last seen by the
                          webhook, e.g. active, past_due, unpaid, incomplete,
                          paused, canceled.
                      plan:
                        type: string
                        enum:
                          - standard
                          - team
                      quantity:
                        type: integer
                        description: Seat count (Team is per seat).
                      current_period_end:
                        type:
                          - string
                          - 'null'
                      cancel_at_period_end:
                        type: integer
                        enum:
                          - 0
                          - 1
                  prices:
                    type: object
                    required:
                      - pro
                      - team
                    properties:
                      pro:
                        type: string
                        example: '9.99'
                      team:
                        type: string
                        example: '19.99'
                    description: >-
                      Display only, overridable from platform_settings. What
                      Stripe charges is fixed by the price ids.
                  trial:
                    type:
                      - object
                      - 'null'
                    properties:
                      ends_at:
                        type: string
                  portal_url:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Stripe's hosted Customer Portal link. Non-null only on the
                      standard/team plans and only when STRIPE_PORTAL_URL is
                      configured. Cancel/update-payment-method happen there, not
                      in this API.
        '401':
          description: Not signed in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Not permitted — the caller's email domain is not allowed, the role
            lacks this capability, or an agent bearer token carries no Hookie
            scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: '`Internal error`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - session: []
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable reason.
        retry_after:
          type: integer
          description: Seconds to wait. Present on 429.
        upgrade_url:
          type: string
          format: uri
          description: Present only on a monthly-quota 429.
  securitySchemes:
    session:
      type: apiKey
      in: cookie
      name: hookie_session
      description: >-
        The console's sealed session cookie, set by WorkOS AuthKit. Mutating
        requests also require the `X-Requested-With` CSRF header.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        An OAuth 2.1 access token from a connected agent, audienced at the
        `/mcp` resource URI. The agent acts as its user, with that user's role
        narrowed to the granted `hookie:*` scopes. No CSRF header is required —
        a bearer token is not ambient credentials.

````