Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Statements API

5 actions 5 updates phrasing extends openapi/clerk-com-statements-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 5

$.info

$.paths['/v1/me/billing/statements'].get

$.paths['/v1/me/billing/statements/{statementID}'].get

$.paths['/v1/organizations/{organizationID}/billing/statements'].get

$.paths['/v1/organizations/{organizationID}/billing/statements/{statementID}'].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 Statements API
  version: 1.0.0
extends: openapi/clerk-com-statements-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: 4
- target: $.paths['/v1/me/billing/statements'].get
  update:
    x-apievangelist-phrasing:
      intent: List my billing statements
      effect: read
      questions:
      - Where can I see my own past billing statements?
      - How do I page through my personal statements?
      instructions:
      - text: List my billing statements.
      - text: Show my last {limit} billing statements.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/billing/statements/{statementID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my billing statements
      effect: read
      questions:
      - How do I open a specific statement from my own billing history?
      - What charges are on one of my statements?
      instructions:
      - text: Show my billing statement {statementID}.
        slots:
          statementID: path.statementID
      - text: Open my statement {statementID}.
        slots:
          statementID: path.statementID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationID}/billing/statements'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's billing statements
      effect: read
      questions:
      - Where can I see my organization's billing statements as a member?
      - How do I list every statement for an organization from the frontend?
      instructions:
      - text: List billing statements for organization {organizationID}.
        slots:
          organizationID: path.organizationID
      - text: Show my organization {organizationID}'s statements.
        slots:
          organizationID: path.organizationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationID}/billing/statements/{statementID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization billing statement
      effect: read
      questions:
      - How do I view a single statement for my organization?
      - What is on a particular organization statement?
      instructions:
      - text: Show statement {statementID} for organization {organizationID}.
        slots:
          statementID: path.statementID
          organizationID: path.organizationID
      - text: Open organization {organizationID} statement {statementID}.
        slots:
          organizationID: path.organizationID
          statementID: path.statementID
      method: generated
      generated: '2026-09-26'