Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Plans API

3 actions 3 updates phrasing extends openapi/clerk-com-plans-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/billing/plans'].get

$.paths['/v1/billing/plans/{planIdOrSlug}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Frontend Plans API
  version: 1.0.0
extends: openapi/clerk-com-plans-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/billing/plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List public billing plans
      effect: read
      questions:
      - Which plans can users subscribe to on my pricing page?
      - Can I show only organization plans on the pricing table?
      instructions:
      - text: List the publicly visible billing plans.
      - text: List public plans for payer type {payer_type}.
        slots:
          payer_type: query.payer_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing/plans/{planIdOrSlug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a public billing plan by ID or slug
      effect: read
      questions:
      - How do I load one plan's details for a pricing page using its slug?
      - What features and prices does a given public plan include?
      instructions:
      - text: Get billing plan {planIdOrSlug}.
        slots:
          planIdOrSlug: path.planIdOrSlug
      - text: Show public plan {planIdOrSlug} details.
        slots:
          planIdOrSlug: path.planIdOrSlug
      method: generated
      generated: '2026-09-26'