NetBird REST API — Invoice

naftiko: 1.0.0-alpha2
info:
  label: NetBird REST API — Invoice
  description: 'NetBird REST API — Invoice. 3 operations. Lead operation: Get account''s paid invoices. Self-contained Naftiko
    capability covering one Netbird business surface.'
  tags:
  - Netbird
  - Invoice
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBIRD_API_KEY: NETBIRD_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbird-invoice
    baseUri: https://api.netbird.io
    description: NetBird REST API — Invoice business capability. Self-contained, no shared references.
    resources:
    - name: api-integrations-billing-invoices
      path: /api/integrations/billing/invoices
      operations:
      - name: get
        method: GET
        description: Get account's paid invoices
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-integrations-billing-invoices-id-csv
      path: /api/integrations/billing/invoices/{id}/csv
      operations:
      - name: get
        method: GET
        description: Get account invoice CSV.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the invoice
          required: true
    - name: api-integrations-billing-invoices-id-pdf
      path: /api/integrations/billing/invoices/{id}/pdf
      operations:
      - name: get
        method: GET
        description: Get account invoice URL to Stripe.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the invoice
          required: true
    authentication:
      type: bearer
      token: '{{env.NETBIRD_API_KEY}}'
  exposes:
  - type: rest
    namespace: netbird-invoice-rest
    port: 8080
    description: REST adapter for NetBird REST API — Invoice. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/integrations/billing/invoices
      name: api-integrations-billing-invoices
      description: REST surface for api-integrations-billing-invoices.
      operations:
      - method: GET
        name: get
        description: Get account's paid invoices
        call: netbird-invoice.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/integrations/billing/invoices/{id}/csv
      name: api-integrations-billing-invoices-id-csv
      description: REST surface for api-integrations-billing-invoices-id-csv.
      operations:
      - method: GET
        name: get
        description: Get account invoice CSV.
        call: netbird-invoice.get
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/integrations/billing/invoices/{id}/pdf
      name: api-integrations-billing-invoices-id-pdf
      description: REST surface for api-integrations-billing-invoices-id-pdf.
      operations:
      - method: GET
        name: get
        description: Get account invoice URL to Stripe.
        call: netbird-invoice.get
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netbird-invoice-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetBird REST API — Invoice. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-account-s-paid-invoices
      description: Get account's paid invoices
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-invoice.get
      outputParameters:
      - type: object
        mapping: $.
    - name: get-account-invoice-csv
      description: Get account invoice CSV.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-invoice.get
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-account-invoice-url-stripe
      description: Get account invoice URL to Stripe.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-invoice.get
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.