Paid · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the Paid API (v2)

4 actions 4 updates update extends ../openapi/paid-v2.json

Generated by API Evangelist Written by API Evangelist tooling for Paid's API. It is a proposal applied on top of the contract, not a document Paid publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-providerx-homepagex-documentationx-getting-startedx-lifecycle-stagex-api-version-channelx-api-catalogx-companion-version

Targets 3

$.info

$.components.securitySchemes.bearerAuth

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for the Paid API (v2)
  version: 1.0.0
extends: ../openapi/paid-v2.json
x-generated: '2026-07-20'
x-method: generated
x-source: API Evangelist enrichment pipeline
actions:
- target: $.info
  description: Annotate contact, docs, and lifecycle metadata harvested during enrichment.
  update:
    x-provider: Paid
    x-homepage: https://paid.ai/
    x-documentation: https://docs.paid.ai/
    x-getting-started: https://docs.paid.ai/documentation/getting-started/quickstart
    x-lifecycle-stage: current
    x-api-version-channel: v2
- target: $
  description: Record the production API catalog and companion v1 description.
  update:
    x-api-catalog: https://docs.paid.ai/.well-known/api-catalog
    x-companion-version: ../openapi/paid-v1.json
- target: $.components.securitySchemes.bearerAuth
  description: Clarify that the bearer token is a Paid API key.
  update:
    x-key-prefix: paid_
    x-issued-at: https://app.paid.ai/settings/api-keys
- target: $
  description: Note the webhook event surface that complements the REST API.
  update:
    x-webhooks-catalog: ../asyncapi/paid-webhooks.yml
    x-webhook-signature-header: x-webhook-signature